get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

GET /api/patches/40881/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 40881,
    "url": "https://patches.dpdk.org/api/patches/40881/?format=api",
    "web_url": "https://patches.dpdk.org/project/dpdk/patch/20180608165920.12228-5-stephen@networkplumber.org/",
    "project": {
        "id": 1,
        "url": "https://patches.dpdk.org/api/projects/1/?format=api",
        "name": "DPDK",
        "link_name": "dpdk",
        "list_id": "dev.dpdk.org",
        "list_email": "dev@dpdk.org",
        "web_url": "http://core.dpdk.org",
        "scm_url": "git://dpdk.org/dpdk",
        "webscm_url": "http://git.dpdk.org/dpdk",
        "list_archive_url": "https://inbox.dpdk.org/dev",
        "list_archive_url_format": "https://inbox.dpdk.org/dev/{}",
        "commit_url_format": ""
    },
    "msgid": "<20180608165920.12228-5-stephen@networkplumber.org>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20180608165920.12228-5-stephen@networkplumber.org",
    "date": "2018-06-08T16:59:19",
    "name": "[dpdk-dev,v10,4/5] net/netvsc: add documentation",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "048dcf78873fc9bd27cc5da0fc13a07a4602899a",
    "submitter": {
        "id": 27,
        "url": "https://patches.dpdk.org/api/people/27/?format=api",
        "name": "Stephen Hemminger",
        "email": "stephen@networkplumber.org"
    },
    "delegate": {
        "id": 1,
        "url": "https://patches.dpdk.org/api/users/1/?format=api",
        "username": "tmonjalo",
        "first_name": "Thomas",
        "last_name": "Monjalon",
        "email": "thomas@monjalon.net"
    },
    "mbox": "https://patches.dpdk.org/project/dpdk/patch/20180608165920.12228-5-stephen@networkplumber.org/mbox/",
    "series": [
        {
            "id": 59,
            "url": "https://patches.dpdk.org/api/series/59/?format=api",
            "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=59",
            "date": "2018-06-08T16:59:15",
            "name": "Hyper-V/Azure netvsc PMD and bus support",
            "version": 10,
            "mbox": "https://patches.dpdk.org/series/59/mbox/"
        }
    ],
    "comments": "https://patches.dpdk.org/api/patches/40881/comments/",
    "check": "fail",
    "checks": "https://patches.dpdk.org/api/patches/40881/checks/",
    "tags": {},
    "related": [],
    "headers": {
        "Return-Path": "<dev-bounces@dpdk.org>",
        "X-Original-To": "patchwork@dpdk.org",
        "Delivered-To": "patchwork@dpdk.org",
        "Received": [
            "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 9AA0A695D;\n\tFri,  8 Jun 2018 18:59:34 +0200 (CEST)",
            "from mail-pf0-f193.google.com (mail-pf0-f193.google.com\n\t[209.85.192.193]) by dpdk.org (Postfix) with ESMTP id 1A8B25B1C\n\tfor <dev@dpdk.org>; Fri,  8 Jun 2018 18:59:31 +0200 (CEST)",
            "by mail-pf0-f193.google.com with SMTP id j20-v6so6922171pff.10\n\tfor <dev@dpdk.org>; Fri, 08 Jun 2018 09:59:31 -0700 (PDT)",
            "from xeon-e3.lan (204-195-35-107.wavecable.com. [204.195.35.107])\n\tby smtp.gmail.com with ESMTPSA id\n\tk9-v6sm21921750pgs.49.2018.06.08.09.59.28\n\t(version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\n\tFri, 08 Jun 2018 09:59:28 -0700 (PDT)"
        ],
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=networkplumber-org.20150623.gappssmtp.com; s=20150623;\n\th=from:to:cc:subject:date:message-id:in-reply-to:references;\n\tbh=qh5YbDOOVsOaAnZFWU33XaxhANR5NZ8fjWKoE9a+aKY=;\n\tb=GgOqxTZG6Uf/TOL1SzKMYFDg9R/AzDX1cfty0sbve6oGKBj1xgkRvlsb6Dp8itzKJY\n\t0VT8SRYgW9ES0xotVZxs21SiM0jiyQBPALhKPsCKbZfU5MIc2QRoNAnEWG2pmYGlLVU7\n\tqB/rSmH2svg+j6Gg3aGC6hOLBzaIKj1PhTSWbBrR5jTSwTgu9EU/oggbqlFGYOV+xLwO\n\tokebAF3jlwG5T4MQkyyxIzPm6a+Tf2pZz+DNCxwNw9kGHOpI+def7JYn9tUSJhBlQneB\n\tYSLg4VYj3x5C40XK/CnRM+fEdmOUKLxoV4dx3Ju/kq8VVozqmZ7PukHFnmgIvUF1BAl3\n\tLPLQ==",
        "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\n\t:references;\n\tbh=qh5YbDOOVsOaAnZFWU33XaxhANR5NZ8fjWKoE9a+aKY=;\n\tb=L2HOvv7MaQlnLbU+uh5SB2uR7qo1ORpellu7iphOz/MzDBDlWPdGINbjJYY4OvwnMW\n\tlplANx2rwoLLrdjpJm1/Kf1Yzbk+SnHaI3fgo2btjGI86VE5XvJzM02KK6w12pwqHyqf\n\txToyWjb8TMolIrRSirWm0B56hf22K+MCWJuOwrUoLnt8mHs4PmvwzoePnCgdrXoZquN8\n\tZSm7jhuiKt1qhjmvnUbfK27FoevAQx9/O8FfQQm9jTBUvpzX/sFFXG9rEwVuzgft9LIE\n\tM+xHnEfRBPMhWaQCMAk3VhPhF8zUnWYeimt4lMZS+uKtVZ2uoBzy9lSVc8zdjcrEKahU\n\tOZSw==",
        "X-Gm-Message-State": "APt69E2p4UA9BXiv6EQxaaH6hfHFHvtwqwUh29nFjb7Y/rG6aqXUGce6\n\t7Zwv8aLiTySlLtaQDVfXNUejxtFbuOw=",
        "X-Google-Smtp-Source": "ADUXVKKAvoBh9OMdnGuKTCZdgxvmZZmlei+Pkfk13GSt6rUwL8O6gcoYyWBlEMxjqePB9migdBr9wQ==",
        "X-Received": "by 2002:a62:4c04:: with SMTP id\n\tz4-v6mr6839108pfa.205.1528477169698; \n\tFri, 08 Jun 2018 09:59:29 -0700 (PDT)",
        "From": "Stephen Hemminger <stephen@networkplumber.org>",
        "To": "dev@dpdk.org",
        "Cc": "Stephen Hemminger <sthemmin@microsoft.com>",
        "Date": "Fri,  8 Jun 2018 09:59:19 -0700",
        "Message-Id": "<20180608165920.12228-5-stephen@networkplumber.org>",
        "X-Mailer": "git-send-email 2.17.1",
        "In-Reply-To": "<20180608165920.12228-1-stephen@networkplumber.org>",
        "References": "<20180608165920.12228-1-stephen@networkplumber.org>",
        "Subject": "[dpdk-dev] [PATCH v10 4/5] net/netvsc: add documentation",
        "X-BeenThere": "dev@dpdk.org",
        "X-Mailman-Version": "2.1.15",
        "Precedence": "list",
        "List-Id": "DPDK patches and discussions <dev.dpdk.org>",
        "List-Unsubscribe": "<https://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>",
        "List-Archive": "<http://dpdk.org/ml/archives/dev/>",
        "List-Post": "<mailto:dev@dpdk.org>",
        "List-Help": "<mailto:dev-request@dpdk.org?subject=help>",
        "List-Subscribe": "<https://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>",
        "Errors-To": "dev-bounces@dpdk.org",
        "Sender": "\"dev\" <dev-bounces@dpdk.org>"
    },
    "content": "From: Stephen Hemminger <sthemmin@microsoft.com>\n\nMatching documentation for new netvsc device.\nIncludes a brief note about the restart issue.\n\nSigned-off-by: Stephen Hemminger <sthemmin@microsoft.com>\n---\n doc/guides/nics/features/netvsc.ini    |  23 ++++++\n doc/guides/nics/index.rst              |   1 +\n doc/guides/nics/netvsc.rst             | 101 +++++++++++++++++++++++++\n doc/guides/rel_notes/known_issues.rst  |  22 ++++++\n doc/guides/rel_notes/release_18_08.rst |   6 ++\n 5 files changed, 153 insertions(+)\n create mode 100644 doc/guides/nics/features/netvsc.ini\n create mode 100644 doc/guides/nics/netvsc.rst",
    "diff": "diff --git a/doc/guides/nics/features/netvsc.ini b/doc/guides/nics/features/netvsc.ini\nnew file mode 100644\nindex 000000000000..2ff6042bf47b\n--- /dev/null\n+++ b/doc/guides/nics/features/netvsc.ini\n@@ -0,0 +1,23 @@\n+;\n+; Supported features of the 'netvsc' network poll mode driver.\n+;\n+; Refer to default.ini for the full list of available PMD features.\n+;\n+[Features]\n+Speed capabilities   = P\n+Link status          = Y\n+Queue start/stop     = Y\n+Scattered Rx         = Y\n+Promiscuous mode     = Y\n+Allmulticast mode    = Y\n+Basic stats          = Y\n+Stats per queue      = Y\n+Extended stats       = Y\n+Multiprocess aware   = Y\n+Other kdrv           = Y\n+ARMv7                = Y\n+ARMv8                = Y\n+x86-32               = Y\n+x86-64               = Y\n+Usage doc            = Y\n+MTU update           = Y\ndiff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst\nindex ddb9eb7a922e..d4eae2b8f046 100644\n--- a/doc/guides/nics/index.rst\n+++ b/doc/guides/nics/index.rst\n@@ -33,6 +33,7 @@ Network Interface Controller Drivers\n     mlx4\n     mlx5\n     mvpp2\n+    netvsc\n     nfp\n     octeontx\n     qede\ndiff --git a/doc/guides/nics/netvsc.rst b/doc/guides/nics/netvsc.rst\nnew file mode 100644\nindex 000000000000..0f033e3a3d63\n--- /dev/null\n+++ b/doc/guides/nics/netvsc.rst\n@@ -0,0 +1,101 @@\n+..  SPDX-License-Identifier: BSD-3-Clause\n+    Copyright(c) Microsoft Corporation.\n+\n+Netvsc poll mode driver\n+=======================\n+\n+The Netvsc Poll Mode driver (PMD) provides support for the paravirtualized\n+network device for Microsoft Hyper-V. It can be used with\n+Window Server 2008/2012/2016, Windows 10 and Azure cloud.\n+The device offers multi-queue support (if kernel and host support it),\n+checksum and segmentation offloads.\n+\n+\n+Features and Limitations of Hyper-V PMD\n+---------------------------------------\n+\n+In this release, the hyper PMD driver provides the basic functionality of packet reception and transmission.\n+\n+*   It supports merge-able buffers per packet when receiving packets and scattered buffer per packet\n+    when transmitting packets. The packet size supported is from 64 to 65536.\n+\n+*   The PMD supports multicast packets and promiscuous mode subject to restrictions on the host.\n+    In order to this to work, the guest network configuration on Hyper-V must be configured to allow MAC address\n+    spoofing. This option is not available on Azure.\n+\n+*   The device has only a single MAC address.\n+    Hyper-V driver does not support MAC or VLAN filtering because the Hyper-V host does not support it.\n+\n+*   VLAN tags are always stripped and presented in mbuf tci field.\n+\n+*   The Hyper-V driver does not use or support Link State or Rx interrupt.\n+\n+*   The maximum number of queues is limited by the host (currently 64).\n+    When used with 4.16 kernel only a single queue is available.\n+\n+*   This driver is intended for use with synthetic path only.\n+    Accelerated Networking (SR-IOV) acceleration is not supported yet.\n+    Use the VDEV_NETVSC device for accelerated networking instead.\n+\n+\n+Installation\n+------------\n+\n+The Netvsc PMD is a standalone driver, similar to virtio and vmxnet3.\n+Using Netvsc PMD requires that the associated VMBUS device be bound to the userspace\n+I/O device driver for Hyper-V (uio_hv_generic). By default, all netvsc devices\n+will be bound to the Linux kernel driver; in order to use netvsc PMD the\n+device must first be overridden.\n+\n+The first step is to identify the network device to override.\n+VMBUS uses Universal Unique Identifiers\n+(`UUID`_) to identify devices on the bus similar to how PCI uses Domain:Bus:Function.\n+The UUID associated with a Linux kernel network device can be determined\n+by looking at the sysfs information. To find the UUID for eth1 and\n+store it in a shell variable:\n+\n+    .. code-block:: console\n+\n+\tDEV_UUID=$(basename $(readlink /sys/class/net/eth1/device))\n+\n+\n+.. _`UUID`: https://en.wikipedia.org/wiki/Universally_unique_identifier\n+\n+There are several possible ways to assign the uio device driver for a device.\n+The easiest way (but only on 4.18 or later)\n+is to use the `driverctl Device Driver control utility`_ to override\n+the normal kernel device.\n+\n+    .. code-block:: console\n+\n+\tdriverctl -b vmbus set-override $DEV_UUID uio_hv_generic\n+\n+.. _`driverctl Device Driver control utility`: https://gitlab.com/driverctl/driverctl\n+\n+Any settings done with driverctl are by default persistent and will be reapplied\n+on reboot.\n+\n+On older kernels, the same effect can be had by manual sysfs bind and unbind\n+operations:\n+\n+    .. code-block:: console\n+\n+\tNET_UUID=\"f8615163-df3e-46c5-913f-f2d2f965ed0e\"\n+\tmodprobe uio_hv_generic\n+\techo $NET_UUID > /sys/bus/vmbus/drivers/uio_hv_generic/new_id\n+\techo $DEV_UUID > /sys/bus/vmbus/drivers/hv_netvsc/unbind\n+\techo $DEV_UUID > /sys/bus/vmbus/drivers/uio_hv_generic/bind\n+\n+.. Note::\n+\n+   The dpkd-devbind.py script should not be used. It only handles PCI devices.\n+\n+\n+Prerequisites\n+-------------\n+\n+The following prerequisites apply:\n+\n+*   Linux kernel support for UIO on vmbus is done with the uio_hv_generic driver.\n+    Full support of multiple queues requires the 4.17 kernel. It is possible\n+    to use the netvsc PMD with 4.16 kernel but it is limited to a single queue.\ndiff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst\nindex 716bd7360949..17bb713e05c6 100644\n--- a/doc/guides/rel_notes/known_issues.rst\n+++ b/doc/guides/rel_notes/known_issues.rst\n@@ -739,3 +739,25 @@ Linux kernel 4.10.0 iommu attribute read error\n \n **Driver/Module**:\n    ``vfio-pci`` module.\n+\n+Netvsc driver and application restart\n+-------------------------------------\n+\n+**Description**:\n+   The Linux kernel uio_hv_generic driver does not completely shutdown and clean up\n+   resources properly if application using Netvsc PMD exits.\n+\n+**Implication**:\n+   When application using Netvsc PMD is restarted it can not complete initialization\n+   handshake sequence with the host.\n+\n+**Resolution/Workaround**:\n+   Either reboot the guest or remove and reinsert the hv_uio_generic module.\n+\n+**Affected Environment/Platform**:\n+   Linux Hyper-V.\n+\n+**Driver/Module**:\n+   ``uio_hv_generic`` module.\n+\n+   \ndiff --git a/doc/guides/rel_notes/release_18_08.rst b/doc/guides/rel_notes/release_18_08.rst\nindex 5bc23c537371..49d56194e9c0 100644\n--- a/doc/guides/rel_notes/release_18_08.rst\n+++ b/doc/guides/rel_notes/release_18_08.rst\n@@ -41,7 +41,13 @@ New Features\n      Also, make sure to start the actual text at the margin.\n      =========================================================\n \n+* **Added support for Hyper-V netvsc PMD.**\n \n+  The new ``netvsc`` poll mode driver provides native support for\n+  networking on Hyper-V. See the :doc:`../nics/netvsc` NIC driver guide\n+  for more details on this new driver.\n+\n+     \n API Changes\n -----------\n \n",
    "prefixes": [
        "dpdk-dev",
        "v10",
        "4/5"
    ]
}