Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/982045/?format=api
{ "id": 982045, "url": "http://patchwork.ozlabs.org/api/patches/982045/?format=api", "web_url": "http://patchwork.ozlabs.org/project/intel-wired-lan/patch/20181010191613.2770-5-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": "<20181010191613.2770-5-jeffrey.t.kirsher@intel.com>", "list_archive_url": null, "date": "2018-10-10T19:16:05", "name": "[v2,04/12] Documentation: igb: Prepare documentation for RST conversion", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "f2aa57baff8076d360d734dd7760861448426d74", "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/20181010191613.2770-5-jeffrey.t.kirsher@intel.com/mbox/", "series": [ { "id": 70094, "url": "http://patchwork.ozlabs.org/api/series/70094/?format=api", "web_url": "http://patchwork.ozlabs.org/project/intel-wired-lan/list/?series=70094", "date": "2018-10-10T19:16:01", "name": "Intel Wired LAN Documentation Updates", "version": 2, "mbox": "http://patchwork.ozlabs.org/series/70094/mbox/" } ], "comments": "http://patchwork.ozlabs.org/api/patches/982045/comments/", "check": "pending", "checks": "http://patchwork.ozlabs.org/api/patches/982045/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.137; helo=fraxinus.osuosl.org;\n\tenvelope-from=intel-wired-lan-bounces@osuosl.org;\n\treceiver=<UNKNOWN>)", "ozlabs.org;\n\tdmarc=fail (p=none dis=none) header.from=intel.com" ], "Received": [ "from fraxinus.osuosl.org (smtp4.osuosl.org [140.211.166.137])\n\t(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256\n\tbits)) (No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 42VkNW0Pt4z9s9J\n\tfor <incoming@patchwork.ozlabs.org>;\n\tThu, 11 Oct 2018 06:16:26 +1100 (AEDT)", "from localhost (localhost [127.0.0.1])\n\tby fraxinus.osuosl.org (Postfix) with ESMTP id 6ECE986B0E;\n\tWed, 10 Oct 2018 19:16:25 +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 D6NatBSkgmIc; Wed, 10 Oct 2018 19:16:24 +0000 (UTC)", "from ash.osuosl.org (ash.osuosl.org [140.211.166.34])\n\tby fraxinus.osuosl.org (Postfix) with ESMTP id D1D6A86B1F;\n\tWed, 10 Oct 2018 19:16:23 +0000 (UTC)", "from fraxinus.osuosl.org (smtp4.osuosl.org [140.211.166.137])\n\tby ash.osuosl.org (Postfix) with ESMTP id 3EBF41BF429\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tWed, 10 Oct 2018 19:16:21 +0000 (UTC)", "from localhost (localhost [127.0.0.1])\n\tby fraxinus.osuosl.org (Postfix) with ESMTP id 3BB0085359\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tWed, 10 Oct 2018 19:16:21 +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 br7CfVYLb00W for <intel-wired-lan@lists.osuosl.org>;\n\tWed, 10 Oct 2018 19:16:18 +0000 (UTC)", "from mga06.intel.com (mga06.intel.com [134.134.136.31])\n\tby fraxinus.osuosl.org (Postfix) with ESMTPS id 51DED8698C\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tWed, 10 Oct 2018 19:16:18 +0000 (UTC)", "from orsmga003.jf.intel.com ([10.7.209.27])\n\tby orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t10 Oct 2018 12:16:16 -0700", "from jtkirshe-desk1.jf.intel.com ([134.134.177.96])\n\tby orsmga003.jf.intel.com with ESMTP; 10 Oct 2018 12:16:16 -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.54,365,1534834800\"; d=\"scan'208\";a=\"90918123\"", "From": "Jeff Kirsher <jeffrey.t.kirsher@intel.com>", "To": "intel-wired-lan@lists.osuosl.org", "Date": "Wed, 10 Oct 2018 12:16:05 -0700", "Message-Id": "<20181010191613.2770-5-jeffrey.t.kirsher@intel.com>", "X-Mailer": "git-send-email 2.17.1", "In-Reply-To": "<20181010191613.2770-1-jeffrey.t.kirsher@intel.com>", "References": "<20181010191613.2770-1-jeffrey.t.kirsher@intel.com>", "Subject": "[Intel-wired-lan] [PATCH v2 04/12] Documentation: igb: Prepare\n\tdocumentation for RST conversion", "X-BeenThere": "intel-wired-lan@osuosl.org", "X-Mailman-Version": "2.1.29", "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": "Before making the conversion to the rst (reStructured Text) format, there\nare changes needed to the documentation so that there are no build errors.\n\nAlso fixed old/broken URLs to the correct or updated URL.\n\nSigned-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>\n---\n Documentation/networking/igb.txt | 214 ++++++++++++++++++++-----------\n 1 file changed, 139 insertions(+), 75 deletions(-)", "diff": "diff --git a/Documentation/networking/igb.txt b/Documentation/networking/igb.txt\nindex f90643ef39c9..ba16b86d5593 100644\n--- a/Documentation/networking/igb.txt\n+++ b/Documentation/networking/igb.txt\n@@ -1,129 +1,193 @@\n+.. SPDX-License-Identifier: GPL-2.0+\n+\n Linux* Base Driver for Intel(R) Ethernet Network Connection\n ===========================================================\n \n Intel Gigabit Linux driver.\n-Copyright(c) 1999 - 2013 Intel Corporation.\n+Copyright(c) 1999-2018 Intel Corporation.\n \n Contents\n ========\n \n - Identifying Your Adapter\n+- Command Line Parameters\n - Additional Configurations\n - Support\n \n+\n Identifying Your Adapter\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-This driver supports all 82575, 82576 and 82580-based Intel (R) gigabit network\n-connections.\n \n-For specific information on how to identify your adapter, go to the Adapter &\n-Driver ID Guide at:\n+Command Line Parameters\n+========================\n+If the driver is built as a module, the following optional parameters are used\n+by entering them on the command line with the modprobe command using this\n+syntax::\n \n- http://support.intel.com/support/go/network/adapter/idguide.htm\n+ modprobe igb [<option>=<VAL1>,<VAL2>,...]\n \n-Command Line Parameters\n-=======================\n+There needs to be a <VAL#> for each network port in the system supported by\n+this driver. The values will be applied to each instance, in function order.\n+For example::\n+\n+ modprobe igb max_vfs=2,4\n+\n+In this case, there are two network ports supported by igb in the system.\n \n-The default value for each parameter is generally the recommended setting,\n-unless otherwise noted.\n+NOTE: A descriptor describes a data buffer and attributes related to the data\n+buffer. This information is accessed by the hardware.\n \n max_vfs\n -------\n-Valid Range: 0-7\n-Default Value: 0\n+:Valid Range: 0-7\n \n-This parameter adds support for SR-IOV. It causes the driver to spawn up to\n-max_vfs worth of virtual function.\n+This parameter adds support for SR-IOV. It causes the driver to spawn up to\n+max_vfs worth of virtual functions. If the value is greater than 0 it will\n+also force the VMDq parameter to be 1 or more.\n \n-Additional Configurations\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- Jumbo Frames\n- ------------\n- Jumbo Frames support is enabled by changing the MTU to a value larger than\n- the default of 1500. Use the ip command to increase the MTU size.\n- For example:\n+ modprobe igb max_vfs=4\n \n- ip link set dev eth<x> mtu 9000\n+This will spawn 4 VFs on the first port.\n \n- This setting is not saved across reboots.\n+::\n \n- Notes:\n+ modprobe igb max_vfs=2,4\n \n- - The maximum MTU setting for Jumbo Frames is 9216. This value coincides\n- with the maximum Jumbo Frames size of 9234 bytes.\n+This will spawn 2 VFs on the first port and 4 VFs on the second port.\n \n- - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in\n- poor performance or loss of link.\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- ethtool\n- -------\n- The driver utilizes the ethtool interface for driver configuration and\n- diagnostics, as well as displaying statistical information. The latest\n- version of ethtool can be found at:\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- https://www.kernel.org/pub/software/network/ethtool/\n+NOTE: When either SR-IOV mode or VMDq mode is enabled, hardware VLAN filtering\n+and VLAN tag stripping/insertion will remain enabled. Please remove the old\n+VLAN filter before the new VLAN filter is added. For example::\n \n- Enabling Wake on LAN* (WoL)\n- ---------------------------\n- WoL is configured through the ethtool* utility.\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- For instructions on enabling WoL with ethtool, refer to the ethtool man page.\n+Debug\n+-----\n+:Valid Range: 0-16 (0=none,...,16=all)\n+:Default Value: 0\n \n- WoL will be enabled on the system during the next shut down or reboot.\n- For this driver version, in order to enable WoL, the igb driver must be\n- loaded when shutting down or rebooting the system.\n+This parameter adjusts the level debug messages displayed in the system logs.\n \n- Wake On LAN is only supported on port A of multi-port adapters.\n \n- Wake On LAN is not supported for the Intel(R) Gigabit VT Quad Port Server\n- Adapter.\n+Additional Features and Configurations\n+======================================\n \n- Multiqueue\n- ----------\n- In this mode, a separate MSI-X vector is allocated for each queue and one\n- for \"other\" interrupts such as link status change and errors. All\n- interrupts are throttled via interrupt moderation. Interrupt moderation\n- must be used to avoid interrupt storms while the driver is processing one\n- interrupt. The moderation value should be at least as large as the expected\n- time for the driver to process an interrupt. Multiqueue is off by default.\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- REQUIREMENTS: MSI-X support is required for Multiqueue. If MSI-X is not\n- found, the system will fallback to MSI or to Legacy interrupts.\n+Use the ifconfig command to increase the MTU size. For example, enter the\n+following where <x> is the interface number::\n \n- MAC and VLAN anti-spoofing feature\n- ----------------------------------\n- When a malicious driver attempts to send a spoofed packet, it is dropped by\n- the hardware and not transmitted. An interrupt is sent to the PF driver\n- notifying it of the spoof attempt.\n+ ifconfig eth<x> mtu 9000 up\n \n- When a spoofed packet is detected the PF driver will send the following\n- message to the system log (displayed by the \"dmesg\" command):\n+Alternatively, you can use the ip command as follows::\n \n- Spoof event(s) detected on VF(n)\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+\n+- For RHEL: /etc/sysconfig/network-scripts/ifcfg-eth<x>\n+- For SLES: /etc/sysconfig/network/<config_file>\n+\n+NOTE: The maximum MTU setting for Jumbo Frames is 9216. This value coincides\n+with the maximum Jumbo Frames size of 9234 bytes.\n+\n+NOTE: Using Jumbo frames at 10 or 100 Mbps is not supported and may result in\n+poor performance or loss of link.\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 \n- Where n=the VF that attempted to do the spoofing.\n+https://www.kernel.org/pub/software/network/ethtool/\n \n- Setting MAC Address, VLAN and Rate Limit Using IProute2 Tool\n- ------------------------------------------------------------\n- You can set a MAC address of a Virtual Function (VF), a default VLAN and the\n- rate limit using the IProute2 tool. Download the latest version of the\n- iproute2 tool from Sourceforge if your version does not have all the\n- features you require.\n+\n+Enabling Wake on LAN* (WoL)\n+---------------------------\n+WoL is configured through the ethtool* utility.\n+\n+WoL will be enabled on the system during the next shut down or reboot. For\n+this driver version, in order to enable WoL, the igb driver must be loaded\n+prior to shutting down or suspending the system.\n+\n+NOTE: Wake on LAN is only supported on port A of multi-port devices. Also\n+Wake On LAN is not supported for the following device:\n+- Intel(R) Gigabit VT Quad Port Server Adapter\n+\n+\n+Multiqueue\n+----------\n+In this mode, a separate MSI-X vector is allocated for each queue and one for\n+\"other\" interrupts such as link status change and errors. All interrupts are\n+throttled via interrupt moderation. Interrupt moderation must be used to avoid\n+interrupt storms while the driver is processing one interrupt. The moderation\n+value should be at least as large as the expected time for the driver to\n+process an interrupt. Multiqueue is off by default.\n+\n+REQUIREMENTS: MSI-X support is required for Multiqueue. If MSI-X is not found,\n+the system will fallback to MSI or to Legacy interrupts. This driver supports\n+receive multiqueue on all kernels that support MSI-X.\n+\n+NOTE: On some kernels a reboot is required to switch between single queue mode\n+and multiqueue mode or vice-versa.\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+Spoof event(s) detected on VF(n), where n = the VF that attempted to do the\n+spoofing\n+\n+\n+Setting MAC Address, VLAN and Rate Limit Using IProute2 Tool\n+------------------------------------------------------------\n+You can set a MAC address of a Virtual Function (VF), a default VLAN and the\n+rate limit using the IProute2 tool. Download the latest version of the\n+IProute2 tool from Sourceforge if your version does not have all the features\n+you require.\n \n \n Support\n =======\n-\n For general information, go to the Intel support website at:\n \n- www.intel.com/support/\n+https://www.intel.com/support/\n \n or the Intel Wired Networking project hosted by Sourceforge at:\n \n- http://sourceforge.net/projects/e1000\n+https://sourceforge.net/projects/e1000\n \n-If an issue is identified with the released source code on the supported\n-kernel with a supported adapter, email the specific information related\n-to the issue to e1000-devel@lists.sf.net\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", "04/12" ] }