Initial import from FreeBSD RELENG_4:
[dragonfly.git] / 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: src/share/man/man4/sf.4,v 1.9.2.6 2003/02/17 21:20:39 trhodes Exp $
32 .\"
33 .Dd July 22, 1999
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 .Cd "device miibus"
43 .Cd "device sf"
44 .Sh DESCRIPTION
45 The
46 .Nm
47 driver provides support for Adaptec Duralink fast ethernet adapters
48 based on the Adaptec AIC-6915 "Starfire" chipset.
49 This includes the
50 following:
51 .Pp
52 .Bl -bullet -compact -offset indent
53 .It
54 ANA-62011 64-bit single port 10/100baseTX adapter
55 .It
56 ANA-62022 64-bit dual port 10/100baseTX adapter
57 .It
58 ANA-62044 64-bit quad port 10/100baseTX adapter
59 .It
60 ANA-69011 32-bit single port 10/100baseTX adapter
61 .It
62 ANA-62020 64-bit single port 100baseFX adapter
63 .El
64 .Pp
65 The AIC-6915 is a bus master controller with an MII interface.
66 It
67 supports high and low priority transmit and receive queues, TCP/IP
68 checksum offload, multiple DMA descriptor formats and both polling
69 and producer/consumer DMA models.
70 The AIC-6915 receive filtering
71 options include a 16 entry perfect filter, a 512-bit hash table
72 for multicast addresses, a 512-bit hash table for priority address
73 matching and VLAN filtering.
74 An external MII-compliant transceiver
75 is required for media interfacing.
76 .Pp
77 Multiport adapters consist of several AIC-6915 controllers connected
78 via a PCI to PCI bridge.
79 Each controller is treated as a separate
80 interface by the
81 .Nm
82 driver.
83 .Pp
84 The
85 .Nm
86 driver supports the following media types:
87 .Pp
88 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
89 .It autoselect
90 Enable autoselection of the media type and options.
91 The user can manually override
92 the autoselected mode by adding media options to the
93 .Pa /etc/rc.conf
94 file.
95 .It 10baseT/UTP
96 Set 10Mbps operation.
97 The
98 .Ar mediaopt
99 option can also be used to select either
100 .Ar full-duplex
101 or
102 .Ar half-duplex
103 modes.
104 .It 100baseTX
105 Set 100Mbps (fast ethernet) operation.
106 The
107 .Ar mediaopt
108 option can also be used to select either
109 .Ar full-duplex
110 or
111 .Ar half-duplex
112 modes.
113 .El
114 .Pp
115 The
116 .Nm
117 driver supports the following media options:
118 .Pp
119 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
120 .It full-duplex
121 Force full duplex operation
122 .It half-duplex
123 Force half duplex operation.
124 .El
125 .Pp
126 For more information on configuring this device, see
127 .Xr ifconfig 8 .
128 .Sh DIAGNOSTICS
129 .Bl -diag
130 .It "sf%d: couldn't map memory"
131 A fatal initialization error has occurred.
132 This may
133 happen if the PCI BIOS not configured the device, which may be because
134 the BIOS has been configured for a "Plug and Play" operating system.
135 The "Plug and Play OS" setting int he BIOS should be set to "no" or
136 "off" in order for PCI devices to work properly with
137 .Fx .
138 .It "sf%d: couldn't map ports"
139 A fatal initialization error has occurred.
140 This may
141 happen if the PCI BIOS not configured the device, which may be because
142 the BIOS has been configured for a "Plug and Play" operating system.
143 The "Plug and Play OS" setting int he BIOS should be set to "no" or
144 "off" in order for PCI devices to work properly with
145 .Fx .
146 .It "sf%d: couldn't map interrupt"
147 A fatal initialization error has occurred.
148 .It "sf%d: no memory for softc struct!"
149 The driver failed to allocate memory for per-device instance information
150 during initialization.
151 .It "sf%d: failed to enable I/O ports/memory mapping!"
152 The driver failed to initialize PCI I/O port or shared memory access.
153 This might happen if the card is not in a bus-master slot.
154 .It "sf%d: watchdog timeout"
155 The device has stopped responding to the network, or there is a problem with
156 the network connection (cable).
157 .El
158 .Sh SEE ALSO
159 .Xr arp 4 ,
160 .Xr miibus 4 ,
161 .Xr netintro 4 ,
162 .Xr ng_ether 4 ,
163 .Xr ifconfig 8
164 .Rs
165 .%T The Adaptec AIC-6915 Programmer's Manual
166 .%O ftp://ftp.adaptec.com/pub/BBS/userguides/aic6915_pg.pdf
167 .Re
168 .Sh HISTORY
169 The
170 .Nm
171 device driver first appeared in
172 .Fx 3.0 .
173 .Sh AUTHORS
174 The
175 .Nm
176 driver was written by
177 .An Bill Paul Aq wpaul@ctr.columbia.edu .