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