share/man/man4/sf.4

   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 October 24, 2018
  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 DEPRECATION NOTICE
  57 The
  58 .Nm
  59 driver is not present in
  60 .Fx 13.0
  61 and later.
  62 See https://github.com/freebsd/fcp/blob/master/fcp-0101.md for more
  63 information.
  64 .Sh DESCRIPTION
  65 The
  66 .Nm
  67 driver provides support for Adaptec Duralink Fast Ethernet adapters
  68 based on the Adaptec AIC-6915 "Starfire" chipset.
  69 .Pp
  70 The AIC-6915 is a bus master controller with an MII interface.
  71 It
  72 supports high and low priority transmit and receive queues, TCP/IP
  73 checksum offload, multiple DMA descriptor formats and both polling
  74 and producer/consumer DMA models.
  75 The AIC-6915 receive filtering
  76 options include a 16 entry perfect filter, a 512-bit hash table
  77 for multicast addresses, a 512-bit hash table for priority address
  78 matching and VLAN filtering.
  79 An external MII-compliant transceiver
  80 is required for media interfacing.
  81 .Pp
  82 Multiport adapters consist of several AIC-6915 controllers connected
  83 via a PCI to PCI bridge.
  84 Each controller is treated as a separate
  85 interface by the
  86 .Nm
  87 driver.
  88 .Pp
  89 The
  90 .Nm
  91 driver supports the following media types:
  92 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  93 .It autoselect
  94 Enable autoselection of the media type and options.
  95 The user can manually override
  96 the autoselected mode by adding media options to the
  97 .Pa /etc/rc.conf
  98 file.
  99 .It 10baseT/UTP
 100 Set 10Mbps operation.
 101 The
 102 .Ar mediaopt
 103 option can also be used to select either
 104 .Ar full-duplex
 105 or
 106 .Ar half-duplex
 107 modes.
 108 .It 100baseTX
 109 Set 100Mbps (Fast Ethernet) operation.
 110 The
 111 .Ar mediaopt
 112 option can also be used to select either
 113 .Ar full-duplex
 114 or
 115 .Ar half-duplex
 116 modes.
 117 .El
 118 .Pp
 119 The
 120 .Nm
 121 driver supports the following media options:
 122 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 123 .It full-duplex
 124 Force full duplex operation
 125 .It half-duplex
 126 Force half duplex operation.
 127 .El
 128 .Pp
 129 For more information on configuring this device, see
 130 .Xr ifconfig 8 .
 131 .Sh HARDWARE
 132 Adapters supported by the
 133 .Nm
 134 driver include:
 135 .Pp
 136 .Bl -bullet -compact
 137 .It
 138 ANA-62011 64-bit single port 10/100baseTX adapter
 139 .It
 140 ANA-62022 64-bit dual port 10/100baseTX adapter
 141 .It
 142 ANA-62044 64-bit quad port 10/100baseTX adapter
 143 .It
 144 ANA-69011 32-bit single port 10/100baseTX adapter
 145 .It
 146 ANA-62020 64-bit single port 100baseFX adapter
 147 .El
 148 .Sh SYSCTL VARIABLES
 149 The following variables are available as both
 150 .Xr sysctl 8
 151 variables and
 152 .Xr loader 8
 153 tunables:
 154 .Bl -tag -width indent
 155 .It Va dev.sf.%d.int_mod
 156 Maximum amount of time to delay interrupt processing in units of
 157 102.4us.
 158 The accepted range is 0 to 31, the default value is 1 (102.4us).
 159 Value 0 completely disables the interrupt moderation.
 160 The interface does not need to be brought down and up again before
 161 a change takes effect.
 162 .It Va dev.sf.%d.stats
 163 Display lots of useful MAC counters maintained in the driver.
 164 .El
 165 .Sh DIAGNOSTICS
 166 .Bl -diag
 167 .It "sf%d: couldn't map memory"
 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 ports"
 176 A fatal initialization error has occurred.
 177 This may
 178 happen if the PCI BIOS not configured the device, which may be because
 179 the BIOS has been configured for a "Plug and Play" operating system.
 180 The "Plug and Play OS" setting in the BIOS should be set to "no" or
 181 "off" in order for PCI devices to work properly with
 182 .Fx .
 183 .It "sf%d: couldn't map interrupt"
 184 A fatal initialization error has occurred.
 185 .It "sf%d: no memory for softc struct!"
 186 The driver failed to allocate memory for per-device instance information
 187 during initialization.
 188 .It "sf%d: failed to enable I/O ports/memory mapping!"
 189 The driver failed to initialize PCI I/O port or shared memory access.
 190 This might happen if the card is not in a bus-master slot.
 191 .It "sf%d: watchdog timeout"
 192 The device has stopped responding to the network, or there is a problem with
 193 the network connection (cable).
 194 .El
 195 .Sh SEE ALSO
 196 .Xr altq 4 ,
 197 .Xr arp 4 ,
 198 .Xr miibus 4 ,
 199 .Xr netintro 4 ,
 200 .Xr ng_ether 4 ,
 201 .Xr polling 4 ,
 202 .Xr vlan 4 ,
 203 .Xr ifconfig 8
 204 .Rs
 205 .%T The Adaptec AIC-6915 Programmer's Manual
 206 .%U http://download.adaptec.com/pdfs/user_guides/aic6915_pg.pdf
 207 .Re
 208 .Sh HISTORY
 209 The
 210 .Nm
 211 device driver first appeared in
 212 .Fx 3.0 .
 213 .Sh AUTHORS
 214 The
 215 .Nm
 216 driver was written by
 217 .An Bill Paul Aq Mt wpaul@ctr.columbia.edu .