1$FreeBSD: head/sys/dev/em/README 119509 2003-08-27 21:52:37Z pdeuskar $
| 1$FreeBSD: head/sys/dev/em/README 146663 2005-05-26 23:33:24Z tackerman $
|
2FreeBSD* Driver for the Intel(R) PRO/1000 Family of Adapters
3============================================================
4
| 2FreeBSD* Driver for the Intel(R) PRO/1000 Family of Adapters
3============================================================
4
|
5July 24, 2003
| 5March 18, 2005
|
6
7
8Contents
9========
10
11- Overview
| 6
7
8Contents
9========
10
11- Overview
|
12- Supported Adapters
| 12- Identifying Your Adapter
|
13- Building and Installation
14- Speed and Duplex Configuration
15- Additional Configurations
16- Known Limitations
17- Support
18- License
19
20
21Overview
22========
23
| 13- Building and Installation
14- Speed and Duplex Configuration
15- Additional Configurations
16- Known Limitations
17- Support
18- License
19
20
21Overview
22========
23
|
24This file describes the FreeBSD* driver, version 1.7.x, for the Intel(R)
25PRO/1000 Family of Adapters. This driver has been developed for use with
26FreeBSD, version 4.7.
| 24This file describes the FreeBSD* driver, version 2.1.x, for the Intel(R)
25PRO/1000 Family of Adapters. This driver has been developed for use with
26FreeBSD, version 5.x.
|
27
| 27
|
28For questions related to hardware requirements, refer to the documentation
29supplied with your Intel PRO/1000 adapter. All hardware requirements listed
| 28For questions related to hardware requirements, refer to the documentation
29supplied with your Intel PRO/1000 adapter. All hardware requirements listed
|
30apply to use with FreeBSD.
31
32
| 30apply to use with FreeBSD.
31
32
|
33Supported Adapters
34==================
| 33Identifying Your Adapter
34========================
|
35
| 35
|
36The following Intel network adapters are compatible with the drivers in this
37release:
| 36For information on how to identify your adapter, go to the Adapter &
37Driver ID Guide at:
|
38
| 38
|
39 Controller Adapter Name Board IDs
40 ---------- ------------ ---------
| 39http://support.intel.com/support/network/adapter/pro100/21397.htm
|
41
| 40
|
42 82542 PRO/1000 Gigabit Server Adapter 700262-xxx, 717037-xxx
| |
43
| 41
|
44 82543 PRO/1000 F Server Adapter 738640-xxx, A38888-xxx,
45 A06512-xxx
| 42For the latest Intel network drivers for FreeBSD, see:
|
46
| 43
|
47 82543 PRO/1000 T Server Adapter A19845-xxx, A33948-xxx
| 44http://appsr.intel.com/scripts-df/support_intel.asp
|
48
| 45
|
49 82544 PRO/1000 XT Server Adapter A51580-xxx
| |
50
| 46
|
51 82544 PRO/1000 XF Server Adapter A50484-xxx
| 47NOTE: Mobile adapters are not fully supported.
|
52
| 48
|
53 82544 PRO/1000 T Desktop Adapter A62947-xxx
| |
54
| 49
|
55 82540 PRO/1000 MT Desktop Adapter A78408-xxx
56
57 82541 PRO/1000 MT Desktop Adapter C91016-xxx
58
59 82545 PRO/1000 MT Server Adapter A92165-xxx
60
61 82545 PRO/1000 MF Server Adapter A91622-xxx
62
63 82545 PRO/1000 MF Server Adapter(LX) A91624-xxx
64
65 82546 PRO/1000 MT Dual Port Server Adapter A92111-xxx
66
67 82546 PRO/1000 MF Dual Port Server Adapter A91620-xxx
68
69 82546EB PRO/1000 MT Quad Port Server Adapter C11227-xxx
70
71 82547 PRO/1000 CT Network Connection
72
73
74To verify your Intel adapter is supported, find the board ID number on the
75adapter. Look for a label that has a barcode and a number in the format of
76123456-001 (six digits hyphen three digits). Match this to the list of
77numbers above.
78
79For more information on how to identify your adapter, go to the Adapter &
80Driver ID Guide at:
81
82 http://support.intel.com/support/network/adapter/pro100/21397.htm
83
84For the latest Intel network drivers for FreeBSD, see:
85
86 http://appsr.intel.com/scripts-df/support_intel.asp
87
88
| |
89Building and Installation
90=========================
91
| 50Building and Installation
51=========================
52
|
92NOTE: The driver can be installed as a dynamic loadable kernel module or
93 compiled into the kernel. You must have kernel sources installed in
| 53NOTE: The driver can be installed as a dynamic loadable kernel module or
54 compiled into the kernel. You must have kernel sources installed in
|
94 order to compile the driver module.
95
| 55 order to compile the driver module.
56
|
96In the instructions below, x.x.x is the driver version as indicated in the
| 57In the instructions below, x.x.x is the driver version as indicated in the
|
97name of the driver tar file.
98
| 58name of the driver tar file.
59
|
991. Move the base driver tar file to the directory of your choice. For
| 601. Move the base driver tar file to the directory of your choice. For
|
100 example, use /home/username/em or /usr/local/src/em.
101
1022. Untar/unzip the archive:
103
104 tar xvfz em-x.x.x.tar.gz
105
106 This will create an em-x.x.x directory.
107
| 61 example, use /home/username/em or /usr/local/src/em.
62
632. Untar/unzip the archive:
64
65 tar xvfz em-x.x.x.tar.gz
66
67 This will create an em-x.x.x directory.
68
|
1083. To create a loadable module, perform the following steps.
| 693. To create a loadable module, perform the following steps.
|
109 NOTE: To compile the driver into the kernel, go directly to step 4.
110
| 70 NOTE: To compile the driver into the kernel, go directly to step 4.
71
|
111 a. To compile the module
| 72 a. To compile the module
|
112
| 73
|
113 cd em-x.x.x
114 make
| 74 cd em-x.x.x
75 make
|
115
| 76
|
116 b. To install the compiled module in system directory:
117
118 make install
119
120 c. If you want the driver to load automatically when the system is booted:
| 77 b. To install the compiled module in system directory:
|
121
| 78
|
122 1. Follow steps a, and b above to compile and install the module
123 2. Edit /boot/loader.conf, and add the following line:
| 79 make install
|
124
| 80
|
125 if_em_load="YES"
| 81 c. If you want the driver to load automatically when the system is booted:
|
126
| 82
|
| 83 1. Edit /boot/loader.conf, and add the following line:
84
85 if_em_load="YES"
86
|
1274. To compile the driver into the kernel:
128
129 cd em-x.x.x/src
130
131 cp if_em* /usr/src/sys/dev/em
132
133 cp Makefile.kernel /usr/src/sys/modules/em/Makefile
134
| 874. To compile the driver into the kernel:
88
89 cd em-x.x.x/src
90
91 cp if_em* /usr/src/sys/dev/em
92
93 cp Makefile.kernel /usr/src/sys/modules/em/Makefile
94
|
135 Edit the /usr/src/sys/conf/files.i386 file, and add the following lines:
| 95 Edit the /usr/src/sys/conf/files.i386 file, and add the following lines only if
96 they don't already exist:
|
136
137 dev/em/if_em.c optional em
138
| 97
98 dev/em/if_em.c optional em
99
|
139 dev/em/if_em_hw.c optional em
| 100 dev/em/if_em_hw.c optional em
|
140
| 101
|
141 Remove the following lines from the /usr/src/sys/conf/files.i386 file,
| 102 Remove the following lines from the /usr/src/sys/conf/files.i386 file,
|
142 if they exist:
143
144 dev/em/if_em_fxhw.c optional em
145 dev/em/if_em_phy.c optional em
146
| 103 if they exist:
104
105 dev/em/if_em_fxhw.c optional em
106 dev/em/if_em_phy.c optional em
107
|
147 Edit the kernel configuration file (i.e., GENERIC or MYKERNEL) in
| 108 Edit the kernel configuration file (i.e., GENERIC or MYKERNEL) in
|
148 /usr/src/sys/i386/conf, and ensure the following line is present:
149
150 device em
151
152 Compile and install the kernel. The system must be rebooted for the kernel
| 109 /usr/src/sys/i386/conf, and ensure the following line is present:
110
111 device em
112
113 Compile and install the kernel. The system must be rebooted for the kernel
|
153 updates to take effect. For additional information on compiling the
| 114 updates to take effect. For additional information on compiling the
|
154 kernel, consult the FreeBSD operating system documentation.
155
1565. To assign an IP address to the interface, enter the following:
157
158 ifconfig em<interface_num> <IP_address>
159
1606. Verify that the interface works. Enter the following, where <IP_address>
161 is the IP address for another machine on the same subnet as the interface
162 that is being tested:
163
164 ping <IP_address>
165
| 115 kernel, consult the FreeBSD operating system documentation.
116
1175. To assign an IP address to the interface, enter the following:
118
119 ifconfig em<interface_num> <IP_address>
120
1216. Verify that the interface works. Enter the following, where <IP_address>
122 is the IP address for another machine on the same subnet as the interface
123 that is being tested:
124
125 ping <IP_address>
126
|
1667. To configure the IP address to remain after reboot, edit /etc/rc.conf,
167 and create the appropriate ifconfig_em<interface_num>�entry:
| 1277. To configure the IP address to remain after reboot, edit /etc/rc.conf,
128 and create the appropriate ifconfig_ementry:
|
168
169 ifconfig_em<interface_num>="<ifconfig_settings>"
170
171 Example usage:
172
173 ifconfig_em0="inet 192.168.10.1 netmask 255.255.255.0"
174
175 NOTE: For assistance, see the ifconfig man page.
176
177
178Speed and Duplex Configuration
179==============================
180
| 129
130 ifconfig_em<interface_num>="<ifconfig_settings>"
131
132 Example usage:
133
134 ifconfig_em0="inet 192.168.10.1 netmask 255.255.255.0"
135
136 NOTE: For assistance, see the ifconfig man page.
137
138
139Speed and Duplex Configuration
140==============================
141
|
181By default, the adapter auto-negotiates the speed and duplex of the
182connection. If there is a specific need, the ifconfig utility can be used to
| 142By default, the adapter auto-negotiates the speed and duplex of the
143connection. If there is a specific need, the ifconfig utility can be used to
|
183configure the speed and duplex settings on the adapter. Example usage:
184
| 144configure the speed and duplex settings on the adapter. Example usage:
145
|
185 ifconfig em<interface_num> <IP_address> media 100baseTX mediaopt
| 146 ifconfig em media 100baseTX mediaopt
|
186 full-duplex
187
| 147 full-duplex
148
|
188 NOTE: Only use mediaopt to set the driver to full-duplex. If mediaopt is
189 not specified and you are not running at gigabit speed, the driver
| 149 NOTE: Only use mediaopt to set the driver to full-duplex. If mediaopt is
150 not specified and you are not running at gigabit speed, the driver
|
190 defaults to half-duplex.
191
192
193This driver supports the following media type options:
194
195 autoselect - Enables auto-negotiation for speed and duplex.
196
| 151 defaults to half-duplex.
152
153
154This driver supports the following media type options:
155
156 autoselect - Enables auto-negotiation for speed and duplex.
157
|
197 10baseT/UTP - Sets speed to 10 Mbps. Use the ifconfig mediaopt
| 158 10baseT/UTP - Sets speed to 10 Mbps. Use the ifconfig mediaopt
|
198 option to select full-duplex mode.
199
200 100baseTX - Sets speed to 100 Mbps. Use the ifconfig mediaopt
201 option to select full-duplex mode.
202
203 1000baseTX - Sets speed to 1000 Mbps. In this case, the driver
204 supports only full-duplex mode.
205
206 1000baseSX - Sets speed to 1000 Mbps. In this case, the driver
207 supports only full-duplex mode.
208
209For more information on the ifconfig utility, see the ifconfig man page.
210
211
212Additional Configurations
213=========================
214
| 159 option to select full-duplex mode.
160
161 100baseTX - Sets speed to 100 Mbps. Use the ifconfig mediaopt
162 option to select full-duplex mode.
163
164 1000baseTX - Sets speed to 1000 Mbps. In this case, the driver
165 supports only full-duplex mode.
166
167 1000baseSX - Sets speed to 1000 Mbps. In this case, the driver
168 supports only full-duplex mode.
169
170For more information on the ifconfig utility, see the ifconfig man page.
171
172
173Additional Configurations
174=========================
175
|
215The driver supports Transmit/Receive Checksum Offload and Jumbo Frames on
216all but the 82542-based adapters. For specific adapters, refer to the
217Supported Adapters section.
| 176The driver supports Transmit/Receive Checksum Offload and Jumbo Frames on
177all but the 82542-based adapters. For specific adapters, refer to the
178Identifying Your Adapter section.
|
218
219 Jumbo Frames
220 ------------
| 179
180 Jumbo Frames
181 ------------
|
221 To enable Jumbo Frames, use the ifconfig utility to increase the MTU
222 beyond 1500 bytes.
| 182 To enable Jumbo Frames, use the ifconfig utility to increase the MTU
183 beyond 1500 bytes.
|
223
| 184
|
224 NOTES: Only enable Jumbo Frames if your network infrastructure supports
| 185 NOTES: Only enable Jumbo Frames if your network infrastructure supports
|
225 them.
| 186 them.
|
226
227 The Jumbo Frames setting on the switch must be set to at least
228 22 bytes larger than that of the adapter.
| |
229
| 187
|
230 The Jumbo Frames MTU range for Intel Adapters is 1500 to 16114. The default
| 188 The Jumbo Frames setting on the switch must be set to at least
189 22 bytes larger than that of the MTU.
190
191 The Intel PRO/1000 PM Network Connection does not support jumbo
192 frames.
193
194
195 The Jumbo Frames MTU range for Intel Adapters is 1500 to 16114. The default
|
231 MTU range is 1500. To modify the setting, enter the following:
232
233 ifconfig em<interface_num> <hostname or IP address> mtu 9000
234
| 196 MTU range is 1500. To modify the setting, enter the following:
197
198 ifconfig em<interface_num> <hostname or IP address> mtu 9000
199
|
235 To confirm an interface's MTU value, use the ifconfig command. To confirm
236 the MTU used between two specific devices, use:
| 200 To confirm the MTU used between two specific devices, use:
|
237
238 route get <destination_IP_address>
239
240 VLANs
241 -----
| 201
202 route get <destination_IP_address>
203
204 VLANs
205 -----
|
242 To create a new VLAN pseudo-interface:
| 206 To create a new VLAN interface:
|
243
244 ifconfig <vlan_name> create
245
| 207
208 ifconfig <vlan_name> create
209
|
246 To associate the VLAN pseudo-interface with a physical interface and
| 210 To associate the VLAN interface with a physical interface and
|
247 assign a VLAN ID, IP address, and netmask:
248
| 211 assign a VLAN ID, IP address, and netmask:
212
|
249 ifconfig <vlan_name> <ip_address> netmask <subnet_mask> vlan
| 213 ifconfig netmask vlan
|
250 <vlan_id> vlandev <physical_interface>
251
252 Example:
253
254 ifconfig vlan10 10.0.0.1 netmask 255.255.255.0 vlan10 vlandev em0
255
| 214 <vlan_id> vlandev <physical_interface>
215
216 Example:
217
218 ifconfig vlan10 10.0.0.1 netmask 255.255.255.0 vlan10 vlandev em0
219
|
256 In this example, all packets will be marked on egress with 802.1Q VLAN
| 220 In this example, all packets will be marked on egress with 802.1Q VLAN
|
257 tags, specifying a VLAN ID of 10.
258
| 221 tags, specifying a VLAN ID of 10.
222
|
259 To remove a VLAN pseudo-interface:
| 223 To remove a VLAN interface:
|
260
261 ifconfig <vlan_name> destroy
262
263 Polling
264 -------
| 224
225 ifconfig <vlan_name> destroy
226
227 Polling
228 -------
|
265 To enable polling in the driver, add the following options to the kernel
| 229 NOTES: DEVICE POLLING is only valid for non-SMP kernels.
230
231 The driver has to be compiled into the kernel for DEVICE POLLING to be
232 enabled in the driver.
233
234 To enable polling in the driver, add the following options to the kernel
|
266 configuration, and then recompile the kernel:
267
268 options DEVICE_POLLING
269 options HZ=1000
270
| 235 configuration, and then recompile the kernel:
236
237 options DEVICE_POLLING
238 options HZ=1000
239
|
271 At runtime, use the following command to turn on polling mode. Similarly,
272 turn off polling mode by setting the variable to 0:
| 240 At runtime use:
241 sysctl kern.polling.enable=1 to turn polling on
242 Use:
243 sysctl ker.polling.enable=0 to turn polling off
|
273
| 244
|
274 sysctl kern.polling.enable=1
| 245 Checksum Offload
246 ----------------
247 Checksum offloading is not supported on 82542 Gigabit adapters.
|
275
| 248
|
| 249 Checksum offloading supports both TCP and UDP packets and is
250 supported for both transmit and receive.
|
276
| 251
|
277 NOTES: DEVICE POLLING is only valid for non-SMP kernels.
| 252 Checksum offloading can be enabled or disabled using ifconfig.
253 Both transmit and receive offloading will be either enabled or
254 disabled together. You cannot enable/disable one without the other.
|
278
| 255
|
279 The driver has to be built into the kernel for DEVICE POLLING to be
280 enabled in the driver.
| 256 To enable checksum offloading:
|
281
| 257
|
| 258 ifconfig <interface_num> rxcsum
|
282
| 259
|
283Known Limitations
284=================
285
286 There are known performance issues with this driver when running UDP traffic
287 with Jumbo Frames. Intel recommends not using Jumbo Frames for UDP traffic.
| 260 To disable checksum offloading:
|
288
| 261
|
| 262 ifconfig <interface_num> -rxcsum
|
289
| 263
|
290 82541/82547 can't link or is slow to link with some link partners
291 -----------------------------------------------------------------
| 264 To confirm the current setting:
|
292
| 265
|
293 There is a known compatibility issue with 82541/82547 and some switches
294 where link will not be established, or will be slow to establish. In
295 particular, these switches are known to be incompatible with 82541/82547:
| 266 ifconfig <interface_num>
|
296
| 267
|
| 268 Look for the presence or absence of the following line:
269
270 options=3 <RXCSUM,TXCSUM>
271
272 See the ifconfig man page for further information.
273
274Known Limitations
275=================
276
277 There are known performance issues with this driver when running UDP traffic
278 with Jumbo Frames.
279
280 There is a known compatibility issue where time to link is slow or link is not
281 established between 82541/82547 controllers and some switches. Known switches
282 include:
|
297 Planex FXG-08TE
298 I-O Data ETG-SH8
299
| 283 Planex FXG-08TE
284 I-O Data ETG-SH8
285
|
300 To workaround the issue, the driver can be compiled with an override of the
301 PHY's master/slave setting. Forcing master or forcing slave mode will
302 improve time-to-link.
| 286 The driver can be compiled with the following changes:
|
303
| 287
|
304 Edit ./em.x.x.x/src/if_em.h to remove the #define EM_MASTER_SLAVE
305 from within the comments.
| 288 Edit ./em.x.x.x/src/if_em.h to uncomment the #define EM_MASTER_SLAVE
289 from within the comments. For example, change from:
|
306
307 /* #define EM_MASTER_SLAVE 2 */
| 290
291 /* #define EM_MASTER_SLAVE 2 */
|
308 #define EM_MASTER_SLAVE 2
| 292 to:
293 #define EM_MASTER_SLAVE 2
|
309
| 294
|
310 Use one of the following options.
311 0 = Hardware default
| 295 Use one of the following options:
|
312 1 = Master mode
313 2 = Slave mode
314 3 = Auto master/slave
| 296 1 = Master mode
297 2 = Slave mode
298 3 = Auto master/slave
|
| 299 Setting 2 is recommended.
|
315
| 300
|
316 Recompile the module (refer to step 3 above)
317 a. To compile the module
| 301 Recompile the module:
302 a. To compile the module
303 cd em-x.x.x
304 make clean
305 make
|
318
| 306
|
319 cd em-x.x.x
320 make clean
321 make
322
| |
323 b. To install the compiled module in system directory:
| 307 b. To install the compiled module in system directory:
|
324
325 make install
| 308 make install
|
326
327
328Support
329=======
330
331For general information and support, go to the Intel support website at:
332
333 http://support.intel.com
334
| 309
310
311Support
312=======
313
314For general information and support, go to the Intel support website at:
315
316 http://support.intel.com
317
|
335If an issue is identified with the released source code on the supported
336kernel with a supported adapter, email the specific information related to
337the issue to freebsdnic@mailbox.intel.com.
| 318If an issue is identified, support is through email only at:
319freebsdnic@mailbox.intel.com
|
338
| 320
|
339
| |
340License
341=======
342
| 321License
322=======
323
|
343This software program is released under the terms of a license agreement
344between you ('Licensee') and Intel. Do not use or load this software or any
345associated materials (collectively, the 'Software') until you have carefully
346read the full terms and conditions of the LICENSE located in this software
347package. By loading or using the Software, you agree to the terms of this
348Agreement. If you do not agree with the terms of this Agreement, do not
| 324This software program is released under the terms of a license agreement
325between you ('Licensee') and Intel. Do not use or load this software or any
326associated materials (collectively, the 'Software') until you have carefully
327read the full terms and conditions of the LICENSE located in this software
328package. By loading or using the Software, you agree to the terms of this
329Agreement. If you do not agree with the terms of this Agreement, do not
|
349install or use the Software.
350
351* Other names and brands may be claimed as the property of others.
| 330install or use the Software.
331
332* Other names and brands may be claimed as the property of others.
|