/share/man/man4/sf.4

https://bitbucket.org/freebsd/freebsd-head/ · Forth · 209 lines · 209 code · 0 blank · 0 comment · 13 complexity · 9e748e1619c26d846199c5e4b88c0461 MD5 · raw file

  1. .\" Copyright (c) 1997, 1998, 1999
  2. .\" Bill Paul <wpaul@ctr.columbia.edu>. 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
  6. .\" are met:
  7. .\" 1. Redistributions of source code must retain the above copyright
  8. .\" notice, this list of conditions and the following disclaimer.
  9. .\" 2. Redistributions in binary form must reproduce the above copyright
  10. .\" notice, this list of conditions and the following disclaimer in the
  11. .\" documentation and/or other materials provided with the distribution.
  12. .\" 3. All advertising materials mentioning features or use of this software
  13. .\" must display the following acknowledgement:
  14. .\" This product includes software developed by Bill Paul.
  15. .\" 4. Neither the name of the author nor the names of any co-contributors
  16. .\" may be used to endorse or promote products derived from this software
  17. .\" without specific prior written permission.
  18. .\"
  19. .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  20. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22. .\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  23. .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24. .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25. .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26. .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27. .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28. .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29. .\" THE POSSIBILITY OF SUCH DAMAGE.
  30. .\"
  31. .\" $FreeBSD$
  32. .\"
  33. .Dd January 21, 2008
  34. .Dt SF 4
  35. .Os
  36. .Sh NAME
  37. .Nm sf
  38. .Nd "Adaptec AIC-6915"
  39. .Qq Starfire
  40. PCI Fast Ethernet adapter driver
  41. .Sh SYNOPSIS
  42. To compile this driver into the kernel,
  43. place the following lines in your
  44. kernel configuration file:
  45. .Bd -ragged -offset indent
  46. .Cd "device miibus"
  47. .Cd "device sf"
  48. .Ed
  49. .Pp
  50. Alternatively, to load the driver as a
  51. module at boot time, place the following line in
  52. .Xr loader.conf 5 :
  53. .Bd -literal -offset indent
  54. if_sf_load="YES"
  55. .Ed
  56. .Sh DESCRIPTION
  57. The
  58. .Nm
  59. driver provides support for Adaptec Duralink Fast Ethernet adapters
  60. based on the Adaptec AIC-6915 "Starfire" chipset.
  61. .Pp
  62. The AIC-6915 is a bus master controller with an MII interface.
  63. It
  64. supports high and low priority transmit and receive queues, TCP/IP
  65. checksum offload, multiple DMA descriptor formats and both polling
  66. and producer/consumer DMA models.
  67. The AIC-6915 receive filtering
  68. options include a 16 entry perfect filter, a 512-bit hash table
  69. for multicast addresses, a 512-bit hash table for priority address
  70. matching and VLAN filtering.
  71. An external MII-compliant transceiver
  72. is required for media interfacing.
  73. .Pp
  74. Multiport adapters consist of several AIC-6915 controllers connected
  75. via a PCI to PCI bridge.
  76. Each controller is treated as a separate
  77. interface by the
  78. .Nm
  79. driver.
  80. .Pp
  81. The
  82. .Nm
  83. driver supports the following media types:
  84. .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  85. .It autoselect
  86. Enable autoselection of the media type and options.
  87. The user can manually override
  88. the autoselected mode by adding media options to the
  89. .Pa /etc/rc.conf
  90. file.
  91. .It 10baseT/UTP
  92. Set 10Mbps operation.
  93. The
  94. .Ar mediaopt
  95. option can also be used to select either
  96. .Ar full-duplex
  97. or
  98. .Ar half-duplex
  99. modes.
  100. .It 100baseTX
  101. Set 100Mbps (Fast Ethernet) operation.
  102. The
  103. .Ar mediaopt
  104. option can also be used to select either
  105. .Ar full-duplex
  106. or
  107. .Ar half-duplex
  108. modes.
  109. .El
  110. .Pp
  111. The
  112. .Nm
  113. driver supports the following media options:
  114. .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  115. .It full-duplex
  116. Force full duplex operation
  117. .It half-duplex
  118. Force half duplex operation.
  119. .El
  120. .Pp
  121. For more information on configuring this device, see
  122. .Xr ifconfig 8 .
  123. .Sh HARDWARE
  124. Adapters supported by the
  125. .Nm
  126. driver include:
  127. .Pp
  128. .Bl -bullet -compact
  129. .It
  130. ANA-62011 64-bit single port 10/100baseTX adapter
  131. .It
  132. ANA-62022 64-bit dual port 10/100baseTX adapter
  133. .It
  134. ANA-62044 64-bit quad port 10/100baseTX adapter
  135. .It
  136. ANA-69011 32-bit single port 10/100baseTX adapter
  137. .It
  138. ANA-62020 64-bit single port 100baseFX adapter
  139. .El
  140. .Sh SYSCTL VARIABLES
  141. The following variables are available as both
  142. .Xr sysctl 8
  143. variables and
  144. .Xr loader 8
  145. tunables:
  146. .Bl -tag -width indent
  147. .It Va dev.sf.%d.int_mod
  148. Maximum amount of time to delay interrupt processing in units of
  149. 102.4us.
  150. The accepted range is 0 to 31, the default value is 1 (102.4us).
  151. Value 0 completely disables the interrupt moderation.
  152. The interface does not need to be brought down and up again before
  153. a change takes effect.
  154. .It Va dev.sf.%d.stats
  155. Display lots of useful MAC counters maintained in the driver.
  156. .El
  157. .Sh DIAGNOSTICS
  158. .Bl -diag
  159. .It "sf%d: couldn't map memory"
  160. A fatal initialization error has occurred.
  161. This may
  162. happen if the PCI BIOS not configured the device, which may be because
  163. the BIOS has been configured for a "Plug and Play" operating system.
  164. The "Plug and Play OS" setting in the BIOS should be set to "no" or
  165. "off" in order for PCI devices to work properly with
  166. .Fx .
  167. .It "sf%d: couldn't map ports"
  168. A fatal initialization error has occurred.
  169. This may
  170. happen if the PCI BIOS not configured the device, which may be because
  171. the BIOS has been configured for a "Plug and Play" operating system.
  172. The "Plug and Play OS" setting in the BIOS should be set to "no" or
  173. "off" in order for PCI devices to work properly with
  174. .Fx .
  175. .It "sf%d: couldn't map interrupt"
  176. A fatal initialization error has occurred.
  177. .It "sf%d: no memory for softc struct!"
  178. The driver failed to allocate memory for per-device instance information
  179. during initialization.
  180. .It "sf%d: failed to enable I/O ports/memory mapping!"
  181. The driver failed to initialize PCI I/O port or shared memory access.
  182. This might happen if the card is not in a bus-master slot.
  183. .It "sf%d: watchdog timeout"
  184. The device has stopped responding to the network, or there is a problem with
  185. the network connection (cable).
  186. .El
  187. .Sh SEE ALSO
  188. .Xr altq 4 ,
  189. .Xr arp 4 ,
  190. .Xr miibus 4 ,
  191. .Xr netintro 4 ,
  192. .Xr ng_ether 4 ,
  193. .Xr polling 4 ,
  194. .Xr vlan 4 ,
  195. .Xr ifconfig 8
  196. .Rs
  197. .%T The Adaptec AIC-6915 Programmer's Manual
  198. .%U http://download.adaptec.com/pdfs/user_guides/aic6915_pg.pdf
  199. .Re
  200. .Sh HISTORY
  201. The
  202. .Nm
  203. device driver first appeared in
  204. .Fx 3.0 .
  205. .Sh AUTHORS
  206. The
  207. .Nm
  208. driver was written by
  209. .An Bill Paul Aq wpaul@ctr.columbia.edu .