/share/man/man4/sk.4

https://bitbucket.org/freebsd/freebsd-head/ · Forth · 241 lines · 241 code · 0 blank · 0 comment · 13 complexity · 165759a6b120f66f90c5d01945decda5 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 August 29, 2012
  34. .Dt SK 4
  35. .Os
  36. .Sh NAME
  37. .Nm sk
  38. .Nd "SysKonnect SK-984x and SK-982x PCI Gigabit Ethernet adapter driver"
  39. .Sh SYNOPSIS
  40. To compile this driver into the kernel,
  41. place the following lines in your
  42. kernel configuration file:
  43. .Bd -ragged -offset indent
  44. .Cd "device miibus"
  45. .Cd "device sk"
  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_sk_load="YES"
  53. .Ed
  54. .Sh DESCRIPTION
  55. The
  56. .Nm
  57. driver provides support for the SysKonnect SK-984x and SK-982x series PCI
  58. Gigabit Ethernet adapters.
  59. .Pp
  60. The SysKonnect adapters consist of two main components: the XaQti Corp.
  61. XMAC II gigabit MAC and the SysKonnect GEnesis controller ASIC.
  62. The
  63. XMAC provides the gigabit MAC and PHY support while the GEnesis
  64. provides an interface to the PCI bus, DMA support, packet buffering
  65. and arbitration.
  66. The GEnesis can control up to two XMACs simultaneously,
  67. allowing dual-port NIC configurations.
  68. .Pp
  69. The SK-982x 1000baseT adapters also include a Broadcom BCM5400 1000baseTX
  70. PHY which is used in place of the XMAC's internal PHY.
  71. The Broadcom PHY is connected to the XMAC via its GMII port.
  72. .Pp
  73. The
  74. .Nm
  75. driver configures dual port SysKonnect adapters such that each XMAC
  76. is treated as a separate logical network interface.
  77. Both ports can
  78. operate independently of each other and can be connected to separate
  79. networks.
  80. The SysKonnect driver software currently only uses the
  81. second port on dual port adapters for failover purposes: if the link
  82. on the primary port fails, the SysKonnect driver will automatically
  83. switch traffic onto the second port.
  84. .Pp
  85. Also supported is the Marvell Semiconductor 88E100* gigabit PHY.
  86. .Pp
  87. The XaQti XMAC II supports full and half duplex operation with
  88. autonegotiation.
  89. The XMAC also supports unlimited frame sizes.
  90. Support for jumbo frames is provided via the interface MTU setting.
  91. Selecting an MTU larger than 1500 bytes with the
  92. .Xr ifconfig 8
  93. utility configures the adapter to receive and transmit jumbo frames.
  94. Using jumbo frames can greatly improve performance for certain tasks,
  95. such as file transfers and data streaming.
  96. .Pp
  97. The
  98. .Nm
  99. driver supports the following media types:
  100. .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  101. .It autoselect
  102. Enable autoselection of the media type and options.
  103. The user can manually override
  104. the autoselected mode by adding media options to the
  105. .Pa /etc/rc.conf
  106. file.
  107. .It 1000baseTX
  108. Set 1000baseTX operation over twisted pair.
  109. This is only available
  110. for SK-982x series adapters with 1000baseT ports.
  111. Both
  112. .Ar full-duplex
  113. and
  114. .Ar half-duplex
  115. modes are supported.
  116. .It 1000baseSX
  117. Set 1000Mbps (Gigabit Ethernet) operation.
  118. Both
  119. .Ar full-duplex
  120. and
  121. .Ar half-duplex
  122. modes are supported.
  123. .El
  124. .Pp
  125. The
  126. .Nm
  127. driver supports the following media options:
  128. .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  129. .It full-duplex
  130. Force full duplex operation.
  131. .It half-duplex
  132. Force half duplex operation.
  133. .El
  134. .Pp
  135. For more information on configuring this device, see
  136. .Xr ifconfig 8 .
  137. .Sh HARDWARE
  138. Adapters supported by the
  139. .Nm
  140. driver include:
  141. .Pp
  142. .Bl -bullet -compact
  143. .It
  144. 3Com 3C940 single port, 1000baseT adapter
  145. .It
  146. 3Com 3C2000-T single port, 1000baseT adapter
  147. .It
  148. Belkin F5D5005 single port, 1000baseT adapter
  149. .It
  150. D-Link DGE-530T single port, 1000baseT adapter
  151. .It
  152. Linksys (revision 2) single port, 1000baseT adapter
  153. .It
  154. SK-9521 SK-NET GE-T single port, 1000baseT adapter
  155. .It
  156. SK-9821 SK-NET GE-T single port, 1000baseT adapter
  157. .It
  158. SK-9822 SK-NET GE-T dual port, 1000baseT adapter
  159. .It
  160. SK-9841 SK-NET GE-LX single port, single mode fiber adapter
  161. .It
  162. SK-9842 SK-NET GE-LX dual port, single mode fiber adapter
  163. .It
  164. SK-9843 SK-NET GE-SX single port, multimode fiber adapter
  165. .It
  166. SK-9844 SK-NET GE-SX dual port, multimode fiber adapter
  167. .It
  168. SMC 9452TX single port, 1000baseT adapter
  169. .El
  170. .Sh LOADER TUNABLES
  171. Tunables can be set at the
  172. .Xr loader 8
  173. prompt before booting the kernel or stored in
  174. .Xr loader.conf 5 .
  175. .Bl -tag -width xxxxxx
  176. .It Va hw.skc.jumbo_disable
  177. Disable jumbo frame support.
  178. Systems with less memory can set it to a non-zero value to save memory.
  179. The default value is 0.
  180. .El
  181. .Sh SYSCTL VARIABLES
  182. The following variable is available as both
  183. .Xr sysctl 8
  184. variable and
  185. .Xr loader 8
  186. tunable:
  187. .Bl -tag -width xxxxxx
  188. .It Va dev.skc.%d.int_mod
  189. This variable controls interrupt moderation.
  190. The accepted range is 10 to 10000.
  191. The default value is 100 microseconds.
  192. The interface has to be brought down and up again before a change takes effect.
  193. .El
  194. .Sh DIAGNOSTICS
  195. .Bl -diag
  196. .It "sk%d: couldn't map memory"
  197. A fatal initialization error has occurred.
  198. .It "sk%d: couldn't map ports"
  199. A fatal initialization error has occurred.
  200. .It "sk%d: couldn't map interrupt"
  201. A fatal initialization error has occurred.
  202. .It "sk%d: no memory for softc struct!"
  203. The driver failed to allocate memory for per-device instance information
  204. during initialization.
  205. .It "sk%d: failed to enable memory mapping!"
  206. The driver failed to initialize PCI shared memory mapping.
  207. This might
  208. happen if the card is not in a bus-master slot.
  209. .It "sk%d: no memory for jumbo buffers!"
  210. The driver failed to allocate memory for jumbo frames during
  211. initialization.
  212. .It "sk%d: watchdog timeout"
  213. The device has stopped responding to the network, or there is a problem with
  214. the network connection (cable).
  215. .El
  216. .Sh SEE ALSO
  217. .Xr altq 4 ,
  218. .Xr arp 4 ,
  219. .Xr miibus 4 ,
  220. .Xr netintro 4 ,
  221. .Xr ng_ether 4 ,
  222. .Xr vlan 4 ,
  223. .Xr ifconfig 8
  224. .Rs
  225. .%T XaQti XMAC II datasheet
  226. .%U http://people.freebsd.org/~wpaul/SysKonnect/xmacii_datasheet_rev_c_9-29.pdf
  227. .Re
  228. .Rs
  229. .%T SysKonnect GEnesis programming manual
  230. .%U http://www.syskonnect.com
  231. .Re
  232. .Sh HISTORY
  233. The
  234. .Nm
  235. device driver first appeared in
  236. .Fx 3.0 .
  237. .Sh AUTHORS
  238. The
  239. .Nm
  240. driver was written by
  241. .An Bill Paul Aq wpaul@ctr.columbia.edu .