Blame view

Documentation/networking/igb.txt 4.09 KB
d7064f4c1   Jeff Kirsher   Documentation/net...
1
2
  Linux* Base Driver for Intel(R) Ethernet Network Connection
  ===========================================================
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
3
4
  
  Intel Gigabit Linux driver.
d7064f4c1   Jeff Kirsher   Documentation/net...
5
  Copyright(c) 1999 - 2013 Intel Corporation.
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
  
  Contents
  ========
  
  - Identifying Your Adapter
  - Additional Configurations
  - Support
  
  Identifying Your Adapter
  ========================
  
  This driver supports all 82575, 82576 and 82580-based Intel (R) gigabit network
  connections.
  
  For specific information on how to identify your adapter, go to the Adapter &
  Driver ID Guide at:
  
      http://support.intel.com/support/go/network/adapter/idguide.htm
  
  Command Line Parameters
  =======================
  
  The default value for each parameter is generally the recommended setting,
  unless otherwise noted.
  
  max_vfs
  -------
  Valid Range:   0-7
  Default Value: 0
  
  This parameter adds support for SR-IOV.  It causes the driver to spawn up to
  max_vfs worth of virtual function.
  
  Additional Configurations
  =========================
  
    Jumbo Frames
    ------------
    Jumbo Frames support is enabled by changing the MTU to a value larger than
c0a34ebd4   Stephen Hemminger   igb: doc don't re...
45
    the default of 1500.  Use the ip command to increase the MTU size.
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
46
    For example:
c0a34ebd4   Stephen Hemminger   igb: doc don't re...
47
         ip link set dev eth<x> mtu 9000
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
48
49
50
51
52
53
54
  
    This setting is not saved across reboots.
  
    Notes:
  
    - The maximum MTU setting for Jumbo Frames is 9216.  This value coincides
      with the maximum Jumbo Frames size of 9234 bytes.
d7064f4c1   Jeff Kirsher   Documentation/net...
55
56
    - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in
      poor performance or loss of link.
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
57

d7064f4c1   Jeff Kirsher   Documentation/net...
58
    ethtool
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
59
60
    -------
    The driver utilizes the ethtool interface for driver configuration and
1ffd72464   Jeff Kirsher   Documentation/net...
61
    diagnostics, as well as displaying statistical information. The latest
68f20d948   Jeff Kirsher   Documentation/net...
62
    version of ethtool can be found at:
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
63

1ffd72464   Jeff Kirsher   Documentation/net...
64
    http://ftp.kernel.org/pub/software/network/ethtool/
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
65
66
67
  
    Enabling Wake on LAN* (WoL)
    ---------------------------
68f20d948   Jeff Kirsher   Documentation/net...
68
    WoL is configured through the ethtool* utility.
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
69

68f20d948   Jeff Kirsher   Documentation/net...
70
    For instructions on enabling WoL with ethtool, refer to the ethtool man page.
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
  
    WoL will be enabled on the system during the next shut down or reboot.
    For this driver version, in order to enable WoL, the igb driver must be
    loaded when shutting down or rebooting the system.
  
    Wake On LAN is only supported on port A of multi-port adapters.
  
    Wake On LAN is not supported for the Intel(R) Gigabit VT Quad Port Server
    Adapter.
  
    Multiqueue
    ----------
    In this mode, a separate MSI-X vector is allocated for each queue and one
    for "other" interrupts such as link status change and errors.  All
    interrupts are throttled via interrupt moderation.  Interrupt moderation
    must be used to avoid interrupt storms while the driver is processing one
    interrupt.  The moderation value should be at least as large as the expected
    time for the driver to process an interrupt. Multiqueue is off by default.
  
    REQUIREMENTS: MSI-X support is required for Multiqueue. If MSI-X is not
    found, the system will fallback to MSI or to Legacy interrupts.
7c158399c   Greg Rose   igb: Add anti-spo...
92
93
94
95
96
97
98
99
100
101
102
103
    MAC and VLAN anti-spoofing feature
    ----------------------------------
    When a malicious driver attempts to send a spoofed packet, it is dropped by
    the hardware and not transmitted.  An interrupt is sent to the PF driver
    notifying it of the spoof attempt.
  
    When a spoofed packet is detected the PF driver will send the following
    message to the system log (displayed by  the "dmesg" command):
  
    Spoof event(s) detected on VF(n)
  
    Where n=the VF that attempted to do the spoofing.
d7064f4c1   Jeff Kirsher   Documentation/net...
104
105
106
107
108
109
    Setting MAC Address, VLAN and Rate Limit Using IProute2 Tool
    ------------------------------------------------------------
    You can set a MAC address of a Virtual Function (VF), a default VLAN and the
    rate limit using the IProute2 tool. Download the latest version of the
    iproute2 tool from Sourceforge if your version does not have all the
    features you require.
b55c52b19   Jeff Kirsher   igb.txt: Add igb ...
110
111
112
113
114
115
116
117
118
119
120
121
122
123
  Support
  =======
  
  For general information, go to the Intel support website at:
  
      www.intel.com/support/
  
  or the Intel Wired Networking project hosted by Sourceforge at:
  
      http://sourceforge.net/projects/e1000
  
  If an issue is identified with the released source code on the supported
  kernel with a supported adapter, email the specific information related
  to the issue to e1000-devel@lists.sf.net