Commit | Line | Data |
---|---|---|
d7064f4c JK |
1 | Linux* Base Driver for Intel(R) Ethernet Network Connection |
2 | =========================================================== | |
b55c52b1 JK |
3 | |
4 | Intel Gigabit Linux driver. | |
d7064f4c | 5 | Copyright(c) 1999 - 2013 Intel Corporation. |
b55c52b1 JK |
6 | |
7 | Contents | |
8 | ======== | |
9 | ||
10 | - Identifying Your Adapter | |
11 | - Additional Configurations | |
12 | - Support | |
13 | ||
14 | Identifying Your Adapter | |
15 | ======================== | |
16 | ||
17 | This driver supports all 82575, 82576 and 82580-based Intel (R) gigabit network | |
18 | connections. | |
19 | ||
20 | For specific information on how to identify your adapter, go to the Adapter & | |
21 | Driver ID Guide at: | |
22 | ||
23 | http://support.intel.com/support/go/network/adapter/idguide.htm | |
24 | ||
25 | Command Line Parameters | |
26 | ======================= | |
27 | ||
28 | The default value for each parameter is generally the recommended setting, | |
29 | unless otherwise noted. | |
30 | ||
31 | max_vfs | |
32 | ------- | |
33 | Valid Range: 0-7 | |
34 | Default Value: 0 | |
35 | ||
36 | This parameter adds support for SR-IOV. It causes the driver to spawn up to | |
37 | max_vfs worth of virtual function. | |
38 | ||
d7064f4c JK |
39 | QueuePairs |
40 | ---------- | |
41 | Valid Range: 0-1 | |
42 | Default Value: 1 (TX and RX will be paired onto one interrupt vector) | |
43 | ||
44 | If set to 0, when MSI-X is enabled, the TX and RX will attempt to occupy | |
45 | separate vectors. | |
46 | ||
47 | This option can be overridden to 1 if there are not sufficient interrupts | |
48 | available. This can occur if any combination of RSS, VMDQ, and max_vfs | |
49 | results in more than 4 queues being used. | |
50 | ||
51 | Node | |
52 | ---- | |
53 | Valid Range: 0-n | |
54 | Default Value: -1 (off) | |
55 | ||
56 | 0 - n: where n is the number of the NUMA node that should be used to | |
57 | allocate memory for this adapter port. | |
58 | -1: uses the driver default of allocating memory on whichever processor is | |
59 | running insmod/modprobe. | |
60 | ||
61 | The Node parameter will allow you to pick which NUMA node you want to have | |
62 | the adapter allocate memory from. All driver structures, in-memory queues, | |
63 | and receive buffers will be allocated on the node specified. This parameter | |
64 | is only useful when interrupt affinity is specified, otherwise some portion | |
65 | of the time the interrupt could run on a different core than the memory is | |
66 | allocated on, causing slower memory access and impacting throughput, CPU, or | |
67 | both. | |
68 | ||
69 | EEE | |
70 | --- | |
71 | Valid Range: 0-1 | |
72 | Default Value: 1 (enabled) | |
73 | ||
74 | A link between two EEE-compliant devices will result in periodic bursts of | |
75 | data followed by long periods where in the link is in an idle state. This Low | |
76 | Power Idle (LPI) state is supported in both 1Gbps and 100Mbps link speeds. | |
77 | NOTE: EEE support requires autonegotiation. | |
78 | ||
79 | DMAC | |
80 | ---- | |
81 | Valid Range: 0-1 | |
82 | Default Value: 1 (enabled) | |
83 | Enables or disables DMA Coalescing feature. | |
84 | ||
85 | ||
1ffd7246 | 86 | |
b55c52b1 JK |
87 | Additional Configurations |
88 | ========================= | |
89 | ||
90 | Jumbo Frames | |
91 | ------------ | |
92 | Jumbo Frames support is enabled by changing the MTU to a value larger than | |
93 | the default of 1500. Use the ifconfig command to increase the MTU size. | |
94 | For example: | |
95 | ||
96 | ifconfig eth<x> mtu 9000 up | |
97 | ||
98 | This setting is not saved across reboots. | |
99 | ||
100 | Notes: | |
101 | ||
102 | - The maximum MTU setting for Jumbo Frames is 9216. This value coincides | |
103 | with the maximum Jumbo Frames size of 9234 bytes. | |
104 | ||
d7064f4c JK |
105 | - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in |
106 | poor performance or loss of link. | |
b55c52b1 | 107 | |
d7064f4c | 108 | ethtool |
b55c52b1 JK |
109 | ------- |
110 | The driver utilizes the ethtool interface for driver configuration and | |
1ffd7246 | 111 | diagnostics, as well as displaying statistical information. The latest |
68f20d94 | 112 | version of ethtool can be found at: |
b55c52b1 | 113 | |
1ffd7246 | 114 | http://ftp.kernel.org/pub/software/network/ethtool/ |
b55c52b1 JK |
115 | |
116 | Enabling Wake on LAN* (WoL) | |
117 | --------------------------- | |
68f20d94 | 118 | WoL is configured through the ethtool* utility. |
b55c52b1 | 119 | |
68f20d94 | 120 | For instructions on enabling WoL with ethtool, refer to the ethtool man page. |
b55c52b1 JK |
121 | |
122 | WoL will be enabled on the system during the next shut down or reboot. | |
123 | For this driver version, in order to enable WoL, the igb driver must be | |
124 | loaded when shutting down or rebooting the system. | |
125 | ||
126 | Wake On LAN is only supported on port A of multi-port adapters. | |
127 | ||
128 | Wake On LAN is not supported for the Intel(R) Gigabit VT Quad Port Server | |
129 | Adapter. | |
130 | ||
131 | Multiqueue | |
132 | ---------- | |
133 | In this mode, a separate MSI-X vector is allocated for each queue and one | |
134 | for "other" interrupts such as link status change and errors. All | |
135 | interrupts are throttled via interrupt moderation. Interrupt moderation | |
136 | must be used to avoid interrupt storms while the driver is processing one | |
137 | interrupt. The moderation value should be at least as large as the expected | |
138 | time for the driver to process an interrupt. Multiqueue is off by default. | |
139 | ||
140 | REQUIREMENTS: MSI-X support is required for Multiqueue. If MSI-X is not | |
141 | found, the system will fallback to MSI or to Legacy interrupts. | |
142 | ||
7c158399 GR |
143 | MAC and VLAN anti-spoofing feature |
144 | ---------------------------------- | |
145 | When a malicious driver attempts to send a spoofed packet, it is dropped by | |
146 | the hardware and not transmitted. An interrupt is sent to the PF driver | |
147 | notifying it of the spoof attempt. | |
148 | ||
149 | When a spoofed packet is detected the PF driver will send the following | |
150 | message to the system log (displayed by the "dmesg" command): | |
151 | ||
152 | Spoof event(s) detected on VF(n) | |
153 | ||
154 | Where n=the VF that attempted to do the spoofing. | |
155 | ||
d7064f4c JK |
156 | Setting MAC Address, VLAN and Rate Limit Using IProute2 Tool |
157 | ------------------------------------------------------------ | |
158 | You can set a MAC address of a Virtual Function (VF), a default VLAN and the | |
159 | rate limit using the IProute2 tool. Download the latest version of the | |
160 | iproute2 tool from Sourceforge if your version does not have all the | |
161 | features you require. | |
162 | ||
163 | ||
b55c52b1 JK |
164 | Support |
165 | ======= | |
166 | ||
167 | For general information, go to the Intel support website at: | |
168 | ||
169 | www.intel.com/support/ | |
170 | ||
171 | or the Intel Wired Networking project hosted by Sourceforge at: | |
172 | ||
173 | http://sourceforge.net/projects/e1000 | |
174 | ||
175 | If an issue is identified with the released source code on the supported | |
176 | kernel with a supported adapter, email the specific information related | |
177 | to the issue to e1000-devel@lists.sf.net |