/share/man/man4/em.4

https://bitbucket.org/freebsd/freebsd-head/ · Forth · 289 lines · 289 code · 0 blank · 0 comment · 11 complexity · e08bf0198cbbea3fb4d5ba9761cbc884 MD5 · raw file

  1. .\" Copyright (c) 2001-2003, Intel Corporation
  2. .\" All rights reserved.
  3. .\"
  4. .\" Redistribution and use in source and binary forms, with or without
  5. .\" modification, are permitted provided that the following conditions are met:
  6. .\"
  7. .\" 1. Redistributions of source code must retain the above copyright notice,
  8. .\" this list of conditions and the following disclaimer.
  9. .\"
  10. .\" 2. Redistributions in binary form must reproduce the above copyright
  11. .\" notice, this list of conditions and the following disclaimer in the
  12. .\" documentation and/or other materials provided with the distribution.
  13. .\"
  14. .\" 3. Neither the name of the Intel Corporation nor the names of its
  15. .\" contributors may be used to endorse or promote products derived from
  16. .\" this software without specific prior written permission.
  17. .\"
  18. .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19. .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21. .\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22. .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23. .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24. .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25. .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26. .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27. .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28. .\" POSSIBILITY OF SUCH DAMAGE.
  29. .\"
  30. .\" * Other names and brands may be claimed as the property of others.
  31. .\"
  32. .\" $FreeBSD$
  33. .\"
  34. .Dd October 11, 2011
  35. .Dt EM 4
  36. .Os
  37. .Sh NAME
  38. .Nm em
  39. .Nd "Intel(R) PRO/1000 Gigabit Ethernet adapter driver"
  40. .Sh SYNOPSIS
  41. To compile this driver into the kernel,
  42. place the following line in your
  43. kernel configuration file:
  44. .Bd -ragged -offset indent
  45. .Cd "device em"
  46. .Ed
  47. .Pp
  48. Alternatively, to load the driver as a
  49. module at boot time, place the following line in
  50. .Xr loader.conf 5 :
  51. .Bd -literal -offset indent
  52. if_em_load="YES"
  53. .Ed
  54. .Sh DESCRIPTION
  55. The
  56. .Nm
  57. driver provides support for PCI Gigabit Ethernet adapters based on
  58. the Intel 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546,
  59. 82546EB, 82546GB, 82547, 82571, 81572, 82573, and 82574 Ethernet
  60. controller chips.
  61. The driver supports Transmit/Receive checksum offload
  62. and Jumbo Frames on all but 82542-based adapters.
  63. Furthermore it supports TCP segmentation offload (TSO) on all adapters but
  64. those based on the 82543, 82544 and 82547 controller chips.
  65. The identification LEDs of the adapters supported by the
  66. .Nm
  67. driver can be controlled via the
  68. .Xr led 4
  69. API for localization purposes.
  70. For further hardware information, see the
  71. .Pa README
  72. included with the driver.
  73. .Pp
  74. For questions related to hardware requirements,
  75. refer to the documentation supplied with your Intel PRO/1000 adapter.
  76. All hardware requirements listed apply to use with
  77. .Fx .
  78. .Pp
  79. Support for Jumbo Frames is provided via the interface MTU setting.
  80. Selecting an MTU larger than 1500 bytes with the
  81. .Xr ifconfig 8
  82. utility configures the adapter to receive and transmit Jumbo Frames.
  83. The maximum MTU size for Jumbo Frames is 16114.
  84. .Pp
  85. This driver version supports VLANs.
  86. The
  87. .Nm
  88. driver supports the following media types:
  89. .Bl -tag -width ".Cm 10baseT/UTP"
  90. .It Cm autoselect
  91. Enables auto-negotiation for speed and duplex.
  92. .It Cm 10baseT/UTP
  93. Sets 10Mbps operation.
  94. Use the
  95. .Cm mediaopt
  96. option to select
  97. .Cm full-duplex
  98. mode.
  99. .It Cm 100baseTX
  100. Sets 100Mbps operation.
  101. Use the
  102. .Cm mediaopt
  103. option to select
  104. .Cm full-duplex
  105. mode.
  106. .It Cm 1000baseSX
  107. Sets 1000Mbps operation.
  108. Only
  109. .Cm full-duplex
  110. mode is supported at this speed.
  111. .It Cm 1000baseTX
  112. Sets 1000Mbps operation.
  113. Only
  114. .Cm full-duplex
  115. mode is supported at this speed.
  116. .El
  117. .Pp
  118. The
  119. .Nm
  120. driver supports the following media options:
  121. .Bl -tag -width ".Cm full-duplex"
  122. .It Cm full-duplex
  123. Forces full-duplex operation
  124. .It Cm half-duplex
  125. Forces half-duplex operation.
  126. .El
  127. .Pp
  128. Only use
  129. .Cm mediaopt
  130. to set the driver to
  131. .Cm full-duplex .
  132. If
  133. .Cm mediaopt
  134. is not specified, the driver defaults to
  135. .Cm half-duplex .
  136. .Pp
  137. For more information on configuring this device, see
  138. .Xr ifconfig 8 .
  139. .Sh HARDWARE
  140. The
  141. .Nm
  142. driver supports Gigabit Ethernet adapters based on the Intel
  143. 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB,
  144. 82546GB, 82547, 82571, 82572, 82573, and 82574 controller chips:
  145. .Pp
  146. .Bl -bullet -compact
  147. .It
  148. Intel PRO/1000 CT Network Connection (82547)
  149. .It
  150. Intel PRO/1000 F Server Adapter (82543)
  151. .It
  152. Intel PRO/1000 Gigabit Server Adapter (82542)
  153. .It
  154. Intel PRO/1000 GT Desktop Adapter (82541PI)
  155. .It
  156. Intel PRO/1000 MF Dual Port Server Adapter (82546)
  157. .It
  158. Intel PRO/1000 MF Server Adapter (82545)
  159. .It
  160. Intel PRO/1000 MF Server Adapter (LX) (82545)
  161. .It
  162. Intel PRO/1000 MT Desktop Adapter (82540)
  163. .It
  164. Intel PRO/1000 MT Desktop Adapter (82541)
  165. .It
  166. Intel PRO/1000 MT Dual Port Server Adapter (82546)
  167. .It
  168. Intel PRO/1000 MT Quad Port Server Adapter (82546EB)
  169. .It
  170. Intel PRO/1000 MT Server Adapter (82545)
  171. .It
  172. Intel PRO/1000 PF Dual Port Server Adapter (82571)
  173. .It
  174. Intel PRO/1000 PF Quad Port Server Adapter (82571)
  175. .It
  176. Intel PRO/1000 PF Server Adapter (82572)
  177. .It
  178. Intel PRO/1000 PT Desktop Adapter (82572)
  179. .It
  180. Intel PRO/1000 PT Dual Port Server Adapter (82571)
  181. .It
  182. Intel PRO/1000 PT Quad Port Server Adapter (82571)
  183. .It
  184. Intel PRO/1000 PT Server Adapter (82572)
  185. .It
  186. Intel PRO/1000 T Desktop Adapter (82544)
  187. .It
  188. Intel PRO/1000 T Server Adapter (82543)
  189. .It
  190. Intel PRO/1000 XF Server Adapter (82544)
  191. .It
  192. Intel PRO/1000 XT Server Adapter (82544)
  193. .El
  194. .Sh LOADER TUNABLES
  195. Tunables can be set at the
  196. .Xr loader 8
  197. prompt before booting the kernel or stored in
  198. .Xr loader.conf 5 .
  199. .Bl -tag -width indent
  200. .It Va hw.em.rxd
  201. Number of receive descriptors allocated by the driver.
  202. The default value is 1024 for adapters newer than 82547,
  203. and 256 for older ones.
  204. The 82542 and 82543-based adapters can handle up to 256 descriptors,
  205. while others can have up to 4096.
  206. .It Va hw.em.txd
  207. Number of transmit descriptors allocated by the driver.
  208. The default value is 1024 for adapters newer than 82547,
  209. and 256 for older ones.
  210. The 82542 and 82543-based adapters can handle up to 256 descriptors,
  211. while others can have up to 4096.
  212. .It Va hw.em.rx_int_delay
  213. This value delays the generation of receive interrupts in units of
  214. 1.024 microseconds.
  215. The default value is 0, since adapters may hang with this feature
  216. being enabled.
  217. .It Va hw.em.rx_abs_int_delay
  218. If
  219. .Va hw.em.rx_int_delay
  220. is non-zero, this tunable limits the maximum delay in which a receive
  221. interrupt is generated.
  222. .It Va hw.em.tx_int_delay
  223. This value delays the generation of transmit interrupts in units of
  224. 1.024 microseconds.
  225. The default value is 64.
  226. .It Va hw.em.tx_abs_int_delay
  227. If
  228. .Va hw.em.tx_int_delay
  229. is non-zero, this tunable limits the maximum delay in which a transmit
  230. interrupt is generated.
  231. .El
  232. .Sh FILES
  233. .Bl -tag -width /dev/led/em*
  234. .It Pa /dev/led/em*
  235. identification LED device nodes
  236. .El
  237. .Sh EXAMPLES
  238. Make the identification LED of em0 blink:
  239. .Pp
  240. .Dl "echo f2 > /dev/led/em0"
  241. .Pp
  242. Turn the identification LED of em0 off again:
  243. .Pp
  244. .Dl "echo 0 > /dev/led/em0"
  245. .Sh DIAGNOSTICS
  246. .Bl -diag
  247. .It "em%d: Unable to allocate bus resource: memory"
  248. A fatal initialization error has occurred.
  249. .It "em%d: Unable to allocate bus resource: interrupt"
  250. A fatal initialization error has occurred.
  251. .It "em%d: watchdog timeout -- resetting"
  252. The device has stopped responding to the network, or there is a problem with
  253. the network connection (cable).
  254. .El
  255. .Sh SUPPORT
  256. For general information and support,
  257. go to the Intel support website at:
  258. .Pa http://support.intel.com .
  259. .Pp
  260. If an issue is identified with the released source code on the supported kernel
  261. with a supported adapter, email the specific information related to the
  262. issue to
  263. .Aq freebsdnic@mailbox.intel.com .
  264. .Sh SEE ALSO
  265. .Xr altq 4 ,
  266. .Xr arp 4 ,
  267. .Xr igb 4 ,
  268. .Xr led 4 ,
  269. .Xr netintro 4 ,
  270. .Xr ng_ether 4 ,
  271. .Xr polling 4 ,
  272. .Xr vlan 4 ,
  273. .Xr ifconfig 8
  274. .Sh HISTORY
  275. The
  276. .Nm
  277. device driver first appeared in
  278. .Fx 4.4 .
  279. .Sh AUTHORS
  280. The
  281. .Nm
  282. driver was written by
  283. .An Intel Corporation Aq freebsdnic@mailbox.intel.com .
  284. .Sh BUGS
  285. Hardware-assisted VLAN processing is disabled by default.
  286. You can enable it on an
  287. .Nm
  288. interface using
  289. .Xr ifconfig 8 .