get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

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

{
    "id": 724784,
    "url": "http://patchwork.ozlabs.org/api/patches/724784/?format=api",
    "web_url": "http://patchwork.ozlabs.org/project/intel-wired-lan/patch/20170206223852.31177-10-jacob.e.keller@intel.com/",
    "project": {
        "id": 46,
        "url": "http://patchwork.ozlabs.org/api/projects/46/?format=api",
        "name": "Intel Wired Ethernet development",
        "link_name": "intel-wired-lan",
        "list_id": "intel-wired-lan.osuosl.org",
        "list_email": "intel-wired-lan@osuosl.org",
        "web_url": "",
        "scm_url": "",
        "webscm_url": "",
        "list_archive_url": "",
        "list_archive_url_format": "",
        "commit_url_format": ""
    },
    "msgid": "<20170206223852.31177-10-jacob.e.keller@intel.com>",
    "list_archive_url": null,
    "date": "2017-02-06T22:38:52",
    "name": "[PART2,9/9] i40e: document drivers use of ntuple filters",
    "commit_ref": null,
    "pull_url": null,
    "state": "accepted",
    "archived": false,
    "hash": "db09662bfefc0828a3f27a5360ea2826aac4ac23",
    "submitter": {
        "id": 9784,
        "url": "http://patchwork.ozlabs.org/api/people/9784/?format=api",
        "name": "Jacob Keller",
        "email": "jacob.e.keller@intel.com"
    },
    "delegate": {
        "id": 68,
        "url": "http://patchwork.ozlabs.org/api/users/68/?format=api",
        "username": "jtkirshe",
        "first_name": "Jeff",
        "last_name": "Kirsher",
        "email": "jeffrey.t.kirsher@intel.com"
    },
    "mbox": "http://patchwork.ozlabs.org/project/intel-wired-lan/patch/20170206223852.31177-10-jacob.e.keller@intel.com/mbox/",
    "series": [],
    "comments": "http://patchwork.ozlabs.org/api/patches/724784/comments/",
    "check": "pending",
    "checks": "http://patchwork.ozlabs.org/api/patches/724784/checks/",
    "tags": {},
    "related": [],
    "headers": {
        "Return-Path": "<intel-wired-lan-bounces@lists.osuosl.org>",
        "X-Original-To": [
            "incoming@patchwork.ozlabs.org",
            "intel-wired-lan@lists.osuosl.org"
        ],
        "Delivered-To": [
            "patchwork-incoming@bilbo.ozlabs.org",
            "intel-wired-lan@lists.osuosl.org"
        ],
        "Received": [
            "from silver.osuosl.org (smtp3.osuosl.org [140.211.166.136])\n\t(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3vHMpP6Jwsz9s2P\n\tfor <incoming@patchwork.ozlabs.org>;\n\tTue,  7 Feb 2017 09:39:09 +1100 (AEDT)",
            "from localhost (localhost [127.0.0.1])\n\tby silver.osuosl.org (Postfix) with ESMTP id F313130A55;\n\tMon,  6 Feb 2017 22:39:07 +0000 (UTC)",
            "from silver.osuosl.org ([127.0.0.1])\n\tby localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024)\n\twith ESMTP id erjIYnHdNrT4; Mon,  6 Feb 2017 22:39:07 +0000 (UTC)",
            "from ash.osuosl.org (ash.osuosl.org [140.211.166.34])\n\tby silver.osuosl.org (Postfix) with ESMTP id 20D1430A5C;\n\tMon,  6 Feb 2017 22:39:01 +0000 (UTC)",
            "from hemlock.osuosl.org (smtp2.osuosl.org [140.211.166.133])\n\tby ash.osuosl.org (Postfix) with ESMTP id 386B81BFF07\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tMon,  6 Feb 2017 22:38:57 +0000 (UTC)",
            "from localhost (localhost [127.0.0.1])\n\tby hemlock.osuosl.org (Postfix) with ESMTP id 3336089F62\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tMon,  6 Feb 2017 22:38:57 +0000 (UTC)",
            "from hemlock.osuosl.org ([127.0.0.1])\n\tby localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024)\n\twith ESMTP id 7eRVefIBnRSC for <intel-wired-lan@lists.osuosl.org>;\n\tMon,  6 Feb 2017 22:38:55 +0000 (UTC)",
            "from mga11.intel.com (mga11.intel.com [192.55.52.93])\n\tby hemlock.osuosl.org (Postfix) with ESMTPS id DBA4B89EF6\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tMon,  6 Feb 2017 22:38:55 +0000 (UTC)",
            "from fmsmga005.fm.intel.com ([10.253.24.32])\n\tby fmsmga102.fm.intel.com with ESMTP; 06 Feb 2017 14:38:55 -0800",
            "from jekeller-desk.amr.corp.intel.com (HELO\n\tjekeller-desk.jekeller.internal) ([10.166.35.174])\n\tby fmsmga005.fm.intel.com with ESMTP; 06 Feb 2017 14:38:54 -0800"
        ],
        "X-Virus-Scanned": [
            "amavisd-new at osuosl.org",
            "amavisd-new at osuosl.org"
        ],
        "X-Greylist": "domain auto-whitelisted by SQLgrey-1.7.6",
        "X-ExtLoop1": "1",
        "X-IronPort-AV": "E=Sophos;i=\"5.33,342,1477983600\"; d=\"scan'208\";a=\"61907708\"",
        "From": "Jacob Keller <jacob.e.keller@intel.com>",
        "To": "Intel Wired LAN <intel-wired-lan@lists.osuosl.org>",
        "Date": "Mon,  6 Feb 2017 14:38:52 -0800",
        "Message-Id": "<20170206223852.31177-10-jacob.e.keller@intel.com>",
        "X-Mailer": "git-send-email 2.12.0.rc0.151.g8a5726c42288",
        "In-Reply-To": "<20170206223852.31177-1-jacob.e.keller@intel.com>",
        "References": "<20170206223852.31177-1-jacob.e.keller@intel.com>",
        "Subject": "[Intel-wired-lan] [PART2 PATCH 9/9] i40e: document drivers use of\n\tntuple filters",
        "X-BeenThere": "intel-wired-lan@lists.osuosl.org",
        "X-Mailman-Version": "2.1.18-1",
        "Precedence": "list",
        "List-Id": "Intel Wired Ethernet Linux Kernel Driver Development\n\t<intel-wired-lan.lists.osuosl.org>",
        "List-Unsubscribe": "<http://lists.osuosl.org/mailman/options/intel-wired-lan>, \n\t<mailto:intel-wired-lan-request@lists.osuosl.org?subject=unsubscribe>",
        "List-Archive": "<http://lists.osuosl.org/pipermail/intel-wired-lan/>",
        "List-Post": "<mailto:intel-wired-lan@lists.osuosl.org>",
        "List-Help": "<mailto:intel-wired-lan-request@lists.osuosl.org?subject=help>",
        "List-Subscribe": "<http://lists.osuosl.org/mailman/listinfo/intel-wired-lan>, \n\t<mailto:intel-wired-lan-request@lists.osuosl.org?subject=subscribe>",
        "MIME-Version": "1.0",
        "Content-Type": "text/plain; charset=\"us-ascii\"",
        "Content-Transfer-Encoding": "7bit",
        "Errors-To": "intel-wired-lan-bounces@lists.osuosl.org",
        "Sender": "\"Intel-wired-lan\" <intel-wired-lan-bounces@lists.osuosl.org>"
    },
    "content": "Add documentation describing the drivers use of ethtool ntuple filters,\nincluding the limitations that it has due to hardware, as well as how it\nreads and parses the user-def data block.\n\nSigned-off-by: Jacob Keller <jacob.e.keller@intel.com>\n---\n Documentation/networking/i40e.txt | 72 +++++++++++++++++++++++++++++++++++++++\n 1 file changed, 72 insertions(+)",
    "diff": "diff --git a/Documentation/networking/i40e.txt b/Documentation/networking/i40e.txt\nindex a251bf4fe9c9..57e616ed10b0 100644\n--- a/Documentation/networking/i40e.txt\n+++ b/Documentation/networking/i40e.txt\n@@ -63,6 +63,78 @@ Additional Configurations\n   The latest release of ethtool can be found from\n   https://www.kernel.org/pub/software/network/ethtool\n \n+\n+  Flow Director n-ntuple traffic filters (FDir)\n+  ---------------------------------------------\n+  The driver utilizes the ethtool interface for configuring ntuple filters,\n+  via \"ethtool -N <device> <filter>\".\n+\n+  The sctp4, ip4, udp4, and tcp4 flow types are supported with the standard\n+  fields including src-ip, dst-ip, src-port and dst-port. The driver only\n+  supports fully enabling or fully masking the fields, so use of the mask\n+  fields for partial matches is not supported.\n+\n+  Additionally, the driver supports using the action to specify filters for a\n+  Virtual Function. You can specify the action as a 64bit value, where the\n+  lower 32 bits represents the queue number, while the next 8 bits represent\n+  which VF. Note that 0 is the PF, so the VF identifier is offset by 1. For\n+  example:\n+\n+    ... action 0x800000002 ...\n+\n+  Would indicate to direct traffic for Virtual Function 7 (8 minus 1) on queue\n+  2 of that VF.\n+\n+  The driver also supports using the user-defined field to specify 2 bytes of\n+  arbitrary data to match within the packet payload in addition to the regular\n+  fields. The data is specified in the lower 32bits of the user-def field in\n+  the following way:\n+\n+  +----------------------------+---------------------------+\n+  | 31    28    24    20    16 | 15    12     8     4     0|\n+  +----------------------------+---------------------------+\n+  | offset into packet payload |  2 bytes of flexible data |\n+  +----------------------------+---------------------------+\n+\n+  As an example,\n+\n+    ... user-def 0x4FFFF ....\n+\n+  means to match the value 0xFFFF 4 bytes into the packet payload. Note that\n+  the offset is based on the beginning of the payload, and not the beginning\n+  of the packet. Thus\n+\n+    flow-type tcp4 ... user-def 0x8BEAF ....\n+\n+  would match TCP/IPv4 packets which have the value 0xBEAF 8bytes into the\n+  TCP/IPv4 payload.\n+\n+  For ICMP, the hardware parses the ICMP header as 4 bytes of header and 4\n+  bytes of payload, so if you want to match an ICMP frames payload you may need\n+  to add 4 to the offset in order to match the data.\n+\n+  Furthermore, the offset can only be up to a value of 64, as the hardware\n+  will only read up to 64 bytes of data from the payload. It must also be even\n+  as the flexible data is 2 bytes long and must be aligned to byte 0 of the\n+  packet payload.\n+\n+  When programming filters, the hardware is limited to using a single input\n+  set for each flow type. This means that it is an error to program two\n+  different filters with the same type that don't match on the same fields.\n+  Thus the second of the following two commands will fail:\n+\n+    ethtool -N <device> flow-type tcp4 src-ip 192.168.0.7 action 5\n+    ethtool -N <device> flow-type tcp4 dst-ip 192.168.15.18 action 1\n+\n+  This is because the first filter will be accepted and reprogram the input\n+  set for TCPv4 filters, but the second filter will be unable to reprogram the\n+  input set until all the conflicting TCPv4 filters are first removed.\n+\n+  Note that the user-defined flexible offset is also considered part of the\n+  input set and cannot be programmed separately for multiple filters of the\n+  same type. However, the flexible data is not part of the input set and\n+  multiple filters may use the same offset but match against different data.\n+\n   Data Center Bridging (DCB)\n   --------------------------\n   DCB configuration is not currently supported.\n",
    "prefixes": [
        "PART2",
        "9/9"
    ]
}