Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/904764/?format=api
{ "id": 904764, "url": "http://patchwork.ozlabs.org/api/patches/904764/?format=api", "web_url": "http://patchwork.ozlabs.org/project/intel-wired-lan/patch/20180425221536.5811-1-jeffrey.t.kirsher@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": "<20180425221536.5811-1-jeffrey.t.kirsher@intel.com>", "list_archive_url": null, "date": "2018-04-25T22:15:36", "name": "[v2] Documentation: fm10k: Add kernel documentation", "commit_ref": null, "pull_url": null, "state": "changes-requested", "archived": false, "hash": "36234112a77f5d1427a2772066cdf18e7ab08529", "submitter": { "id": 473, "url": "http://patchwork.ozlabs.org/api/people/473/?format=api", "name": "Kirsher, Jeffrey T", "email": "jeffrey.t.kirsher@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/20180425221536.5811-1-jeffrey.t.kirsher@intel.com/mbox/", "series": [ { "id": 40996, "url": "http://patchwork.ozlabs.org/api/series/40996/?format=api", "web_url": "http://patchwork.ozlabs.org/project/intel-wired-lan/list/?series=40996", "date": "2018-04-25T22:15:36", "name": "[v2] Documentation: fm10k: Add kernel documentation", "version": 2, "mbox": "http://patchwork.ozlabs.org/series/40996/mbox/" } ], "comments": "http://patchwork.ozlabs.org/api/patches/904764/comments/", "check": "pending", "checks": "http://patchwork.ozlabs.org/api/patches/904764/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<intel-wired-lan-bounces@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" ], "Authentication-Results": [ "ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=osuosl.org\n\t(client-ip=140.211.166.136; helo=silver.osuosl.org;\n\tenvelope-from=intel-wired-lan-bounces@osuosl.org;\n\treceiver=<UNKNOWN>)", "ozlabs.org;\n\tdmarc=none (p=none dis=none) header.from=intel.com" ], "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 40WZHx1YR3z9s0R\n\tfor <incoming@patchwork.ozlabs.org>;\n\tThu, 26 Apr 2018 08:14:52 +1000 (AEST)", "from localhost (localhost [127.0.0.1])\n\tby silver.osuosl.org (Postfix) with ESMTP id 2E3CC2FEFC;\n\tWed, 25 Apr 2018 22:14:51 +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 c2dwiU32oDgy; Wed, 25 Apr 2018 22:14:49 +0000 (UTC)", "from ash.osuosl.org (ash.osuosl.org [140.211.166.34])\n\tby silver.osuosl.org (Postfix) with ESMTP id 8B1D92EECD;\n\tWed, 25 Apr 2018 22:14:49 +0000 (UTC)", "from fraxinus.osuosl.org (smtp4.osuosl.org [140.211.166.137])\n\tby ash.osuosl.org (Postfix) with ESMTP id 44B691CF0E2\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tWed, 25 Apr 2018 22:14:48 +0000 (UTC)", "from localhost (localhost [127.0.0.1])\n\tby fraxinus.osuosl.org (Postfix) with ESMTP id 3E0A8836A8\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tWed, 25 Apr 2018 22:14:48 +0000 (UTC)", "from fraxinus.osuosl.org ([127.0.0.1])\n\tby localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024)\n\twith ESMTP id pcHWaBrybEQQ for <intel-wired-lan@lists.osuosl.org>;\n\tWed, 25 Apr 2018 22:14:47 +0000 (UTC)", "from mga17.intel.com (mga17.intel.com [192.55.52.151])\n\tby fraxinus.osuosl.org (Postfix) with ESMTPS id 0EA4C835D2\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tWed, 25 Apr 2018 22:14:47 +0000 (UTC)", "from fmsmga005.fm.intel.com ([10.253.24.32])\n\tby fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t25 Apr 2018 15:14:46 -0700", "from jtkirshe-nuc.jf.intel.com ([134.134.177.59])\n\tby fmsmga005.fm.intel.com with ESMTP; 25 Apr 2018 15:14:46 -0700" ], "X-Virus-Scanned": [ "amavisd-new at osuosl.org", "amavisd-new at osuosl.org" ], "X-Greylist": "domain auto-whitelisted by SQLgrey-1.7.6", "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.49,328,1520924400\"; d=\"scan'208\";a=\"223373561\"", "From": "Jeff Kirsher <jeffrey.t.kirsher@intel.com>", "To": "intel-wired-lan@lists.osuosl.org", "Date": "Wed, 25 Apr 2018 15:15:36 -0700", "Message-Id": "<20180425221536.5811-1-jeffrey.t.kirsher@intel.com>", "X-Mailer": "git-send-email 2.14.3", "Subject": "[Intel-wired-lan] [PATCH v2] Documentation: fm10k: Add kernel\n\tdocumentation", "X-BeenThere": "intel-wired-lan@osuosl.org", "X-Mailman-Version": "2.1.24", "Precedence": "list", "List-Id": "Intel Wired Ethernet Linux Kernel Driver Development\n\t<intel-wired-lan.osuosl.org>", "List-Unsubscribe": "<https://lists.osuosl.org/mailman/options/intel-wired-lan>, \n\t<mailto:intel-wired-lan-request@osuosl.org?subject=unsubscribe>", "List-Archive": "<http://lists.osuosl.org/pipermail/intel-wired-lan/>", "List-Post": "<mailto:intel-wired-lan@osuosl.org>", "List-Help": "<mailto:intel-wired-lan-request@osuosl.org?subject=help>", "List-Subscribe": "<https://lists.osuosl.org/mailman/listinfo/intel-wired-lan>, \n\t<mailto:intel-wired-lan-request@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@osuosl.org", "Sender": "\"Intel-wired-lan\" <intel-wired-lan-bounces@osuosl.org>" }, "content": "Added the fm10k.txt kernel documentation which apparently was missing.\n\nSigned-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>\n---\nv2: Fix documentation by removing module parameters that do not exist in\nthe kernel driver.\n\n Documentation/networking/fm10k.txt | 215 +++++++++++++++++++++++++++++++++++++\n 1 file changed, 215 insertions(+)\n create mode 100644 Documentation/networking/fm10k.txt", "diff": "diff --git a/Documentation/networking/fm10k.txt b/Documentation/networking/fm10k.txt\nnew file mode 100644\nindex 000000000000..00f5473d5cd0\n--- /dev/null\n+++ b/Documentation/networking/fm10k.txt\n@@ -0,0 +1,215 @@\n+README for Intel(R) Ethernet Multi-host Controller Driver\n+=========================================================\n+\n+February 23, 2017\n+Copyright(c) 2015-2017 Intel Corporation.\n+\n+Contents\n+========\n+- Identifying Your Adapter\n+- Additional Configurations\n+- Performance Tuning\n+- Known Issues\n+- Support\n+\n+Identifying Your Adapter\n+------------------------\n+The driver in this release is compatible with devices based on the Intel(R)\n+Ethernet Multi-host Controller.\n+\n+For information on how to identify your adapter, and for the latest Intel\n+network drivers, refer to the Intel Support website:\n+http://www.intel.com/support\n+\n+\n+Flow Control\n+------------\n+The Intel(R) Ethernet Switch Host Interface Driver does not support Flow\n+Control. It will not send pause frames. This may result in dropped frames.\n+\n+\n+Intel(R) Ethernet Flow Director\n+-------------------------------\n+The Intel Ethernet Flow Director performs the following tasks:\n+\n+- Directs receive packets according to their flows to different queues.\n+- Enables tight control on routing a flow in the platform.\n+- Matches flows and CPU cores for flow affinity.\n+- Supports multiple parameters for flexible flow classification and load\n+ balancing (in SFP mode only).\n+\n+NOTE: An included script (set_irq_affinity) automates setting the IRQ to CPU\n+affinity.\n+\n+ethtool commands:\n+\n+To enable or disable the Intel Ethernet Flow Director:\n+\n+ # ethtool -K ethX ntuple <on|off>\n+\n+When disabling ntuple filters, all the user programmed filters are flushed from\n+the driver cache and hardware. All needed filters must be re-added when ntuple\n+is re-enabled.\n+\n+To add a filter that directs packet to queue 2, use -U or -N switch:\n+\n+ # ethtool -N ethX flow-type tcp4 src-ip 192.168.10.1 dst-ip \\\n+ 192.168.10.2 src-port 2000 dst-port 2001 action 2 [loc 1]\n+\n+To see the list of filters currently present:\n+ # ethtool <-u|-n> ethX\n+\n+\n+max_vfs\n+-------\n+This parameter adds support for SR-IOV. It causes the driver to spawn up to\n+max_vfs worth of virtual functions.\n+Valid Range:0-64\n+\n+NOTE: This parameter is only used on kernel 3.7.x and below. On kernel 3.8.x\n+and above, use sysfs to enable VFs. Also, for Red Hat distributions, this\n+parameter is only used on version 6.6 and older. For version 6.7 and newer, use\n+sysfs. For example:\n+#echo $num_vf_enabled > /sys/class/net/$dev/device/sriov_numvfs\t//enable\n+VFs\n+#echo 0 > /sys/class/net/$dev/device/sriov_numvfs\t//disable VFs\n+\n+The parameters for the driver are referenced by position. Thus, if you have a\n+dual port adapter, or more than one adapter in your system, and want N virtual\n+functions per port, you must specify a number for each port with each parameter\n+separated by a comma. For example:\n+\n+ modprobe fm10k max_vfs=4\n+\n+This will spawn 4 VFs on the first port.\n+\n+ modprobe fm10k max_vfs=2,4\n+\n+This will spawn 2 VFs on the first port and 4 VFs on the second port.\n+\n+NOTE: Caution must be used in loading the driver with these parameters.\n+Depending on your system configuration, number of slots, etc., it is impossible\n+to predict in all cases where the positions would be on the command line.\n+\n+NOTE: Neither the device nor the driver control how VFs are mapped into config\n+space. Bus layout will vary by operating system. On operating systems that\n+support it, you can check sysfs to find the mapping.\n+\n+NOTE: When SR-IOV mode is enabled, hardware VLAN filtering and VLAN tag\n+stripping/insertion will remain enabled. Please remove the old VLAN filter\n+before the new VLAN filter is added. For example,\n+ip link set eth0 vf 0 vlan 100\t// set vlan 100 for VF 0\n+ip link set eth0 vf 0 vlan 0\t// Delete vlan 100\n+ip link set eth0 vf 0 vlan 200\t// set a new vlan 200 for VF 0\n+\n+\n+Additional Features and Configurations\n+-------------------------------------------\n+\n+Jumbo Frames\n+------------\n+Jumbo Frames support is enabled by changing the Maximum Transmission Unit (MTU)\n+to a value larger than the default value of 1500.\n+\n+Use the ifconfig command to increase the MTU size. For example, enter the\n+following where <x> is the interface number:\n+\n+ ifconfig eth<x> mtu 9000 up\n+Alternatively, you can use the ip command as follows:\n+ ip link set mtu 9000 dev eth<x>\n+ ip link set up dev eth<x>\n+\n+This setting is not saved across reboots. The setting change can be made\n+permanent by adding 'MTU=9000' to the file:\n+/etc/sysconfig/network-scripts/ifcfg-eth<x> for RHEL or to the file\n+/etc/sysconfig/network/<config_file> for SLES.\n+\n+NOTE: The maximum MTU setting for Jumbo Frames is 15342. This value coincides\n+with the maximum Jumbo Frames size of 15364 bytes.\n+\n+NOTE: This driver will attempt to use multiple page sized buffers to receive\n+each jumbo packet. This should help to avoid buffer starvation issues when\n+allocating receive packets.\n+\n+\n+Generic Receive Offload, aka GRO\n+--------------------------------\n+The driver supports the in-kernel software implementation of GRO. GRO has\n+shown that by coalescing Rx traffic into larger chunks of data, CPU\n+utilization can be significantly reduced when under large Rx load. GRO is an\n+evolution of the previously-used LRO interface. GRO is able to coalesce\n+other protocols besides TCP. It's also safe to use with configurations that\n+are problematic for LRO, namely bridging and iSCSI.\n+\n+\n+ethtool\n+-------\n+The driver utilizes the ethtool interface for driver configuration and\n+diagnostics, as well as displaying statistical information. The latest ethtool\n+version is required for this functionality. Download it at:\n+http://ftp.kernel.org/pub/software/network/ethtool/\n+\n+Supported ethtool Commands and Options for Filtering\n+----------------------------------------------------\n+-n --show-nfc\n+ Retrieves the receive network flow classification configurations.\n+\n+rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6\n+ Retrieves the hash options for the specified network traffic type.\n+\n+-N --config-nfc\n+ Configures the receive network flow classification.\n+\n+rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6\n+m|v|t|s|d|f|n|r...\n+ Configures the hash options for the specified network traffic type.\n+\n+ udp4 UDP over IPv4\n+ udp6 UDP over IPv6\n+\n+ f Hash on bytes 0 and 1 of the Layer 4 header of the rx packet.\n+ n Hash on bytes 2 and 3 of the Layer 4 header of the rx packet.\n+\n+\n+FCoE\n+----\n+The fm10k driver supports Fiber Channel over Ethernet (FCoE) and Data Center\n+Bridging (DCB). This code has no default effect on the regular driver\n+operation. Configuring DCB and FCoE is outside the scope of this README. Refer\n+to http://www.open-fcoe.org/ for FCoE project information and contact\n+fm10k-eedc@lists.sourceforge.net for DCB information.\n+\n+\n+MAC and VLAN anti-spoofing feature\n+----------------------------------\n+When a malicious driver attempts to send a spoofed packet, it is dropped by the\n+hardware and not transmitted.\n+\n+An interrupt is sent to the PF driver notifying it of the spoof attempt. When a\n+spoofed packet is detected, the PF driver will send the following message to\n+the system log (displayed by the \"dmesg\" command):\n+NOTE: This feature can be disabled for a specific Virtual Function (VF):\n+ip link set <pf dev> vf <vf id> spoofchk {off|on}\n+\n+\n+Known Issues/Troubleshooting\n+----------------------------\n+\n+Enabling SR-IOV in a 64-bit Microsoft* Windows Server* 2012/R2 guest OS under\n+Linux KVM\n+--------------------------------------------------------------------------------\n+KVM Hypervisor/VMM supports direct assignment of a PCIe device to a VM. This\n+includes traditional PCIe devices, as well as SR-IOV-capable devices based on\n+the Intel Ethernet Controller XL710.\n+\n+\n+Support\n+-------\n+For general information, go to the Intel support website at:\n+http://www.intel.com/support/\n+\n+or the Intel Wired Networking project hosted by Sourceforge at:\n+http://sourceforge.net/projects/e1000\n+If an issue is identified with the released source code on a supported kernel\n+with a supported adapter, email the specific information related to the issue\n+to e1000-devel@lists.sf.net.\n", "prefixes": [ "v2" ] }