Use the Er macro for error numbers.
[dragonfly.git] / share / man / man4 / pcn.4
1 .\" Copyright (c) Berkeley Software Design, Inc.
2 .\" Copyright (c) 1997, 1998, 1999, 2000
3 .\"     Bill Paul <wpaul@osd.bsdi.com>. All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. All advertising materials mentioning features or use of this software
14 .\"    must display the following acknowledgement:
15 .\"     This product includes software developed by Bill Paul.
16 .\" 4. Neither the name of the author nor the names of any co-contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"   without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 .\" THE POSSIBILITY OF SUCH DAMAGE.
31 .\"
32 .\" $FreeBSD: src/share/man/man4/pcn.4,v 1.3.2.5 2003/02/17 21:20:39 trhodes Exp $
33 .\" $DragonFly: src/share/man/man4/pcn.4,v 1.3 2004/03/11 12:28:55 hmp Exp $
34 .\"
35 .Dd September 18, 2000
36 .Dt PCN 4
37 .Os
38 .Sh NAME
39 .Nm pcn
40 .Nd "AMD PCnet/PCI fast ethernet device driver"
41 .Sh SYNOPSIS
42 .Cd "device miibus"
43 .Cd "device pcn"
44 .Sh DESCRIPTION
45 The
46 .Nm
47 driver provides support for PCI ethernet adapters and embedded
48 controllers based on the AMD PCnet/FAST, PCnet/FAST+, PCnet/FAST III,
49 PCnet/PRO and PCnet/Home ethernet controller chips.
50 .Pp
51 The PCnet/PCI chips include a 100Mbps ethernet MAC and support
52 both a serial and MII-compliant transceiver interface.
53 They use a bus master DMA and a scatter/gather descriptor scheme.
54 The AMD chips provide a mechanism for zero-copy receive,
55 providing good performance in server environments.
56 Receive address filtering is provided using a single perfect filter entry
57 for the station address and a 64-bit multicast hash table.
58 .Pp
59 The
60 .Nm
61 driver supports the following media types:
62 .Pp
63 .Bl -tag -width 10baseTXUTP
64 .It autoselect
65 Enable autoselection of the media type and options.
66 The user can manually override
67 the autoselected mode by adding media options to
68 .Xr rc.conf 5 .
69 .It 10baseT/UTP
70 Set 10Mbps operation.
71 The
72 .Xr ifconfig 8
73 .Cm mediaopt
74 option can also be used to select either
75 .Sq full-duplex
76 or
77 .Sq half-duplex
78 modes.
79 .It 100baseTX
80 Set 100Mbps (fast ethernet) operation.
81 The
82 .Xr ifconfig 8
83 .Cm mediaopt
84 option can also be used to select either
85 .Sq full-duplex
86 or
87 .Sq half-duplex
88 modes.
89 .El
90 .Pp
91 The
92 .Nm
93 driver supports the following media options:
94 .Pp
95 .Bl -tag -width full-duplex
96 .It full-duplex
97 Force full duplex operation
98 .It half-duplex
99 Force half duplex operation.
100 .El
101 .Pp
102 For more information on configuring this device, see
103 .Xr ifconfig 8 .
104 .Sh DIAGNOSTICS
105 .Bl -diag
106 .It "pcn%d: couldn't map ports/memory"
107 A fatal initialization error has occurred.
108 .It "pcn%d: couldn't map interrupt"
109 A fatal initialization error has occurred.
110 .It "pcn%d: watchdog timeout"
111 The device has stopped responding to the network, or there is a problem with
112 the network connection (e.g. a cable fault).
113 .It "pcn%d: no memory for rx list"
114 The driver failed to allocate an mbuf for the receiver ring.
115 .It "pcn%d: no memory for tx list"
116 The driver failed to allocate an mbuf for the transmitter ring when
117 allocating a pad buffer or collapsing an mbuf chain into a clusisr.
118 .It "pcn%d: chip is in D3 power state -- setting to D0"
119 This message applies only to adapters which support power
120 management.
121 Some operating systems place the controller in low power
122 mode when shutting down, and some PCI BIOSes fail to bring the chip
123 out of this state before configuring it.
124 The controller loses all of
125 its PCI configuration in the D3 state, so if the BIOS does not set
126 it back to full power mode in time, it will not be able to configure it
127 correctly.
128 The driver tries to detect this condition and bring
129 the adapter back to the D0 (full power) state, but this may not be
130 enough to return the driver to a fully operational condition.
131 If
132 you see this message at boot time and the driver fails to attach
133 the device as a network interface, you will have to perform a
134 warm boot to have the device properly configured.
135 .Pp
136 Note that this condition only occurs when warm booting from another
137 operating system.
138 If you power down your system prior to booting
139 .Dx ,
140 the card should be configured correctly.
141 .El
142 .Sh SEE ALSO
143 .Xr arp 4 ,
144 .Xr miibus 4 ,
145 .Xr netintro 4 ,
146 .Xr ng_ether 4 ,
147 .Xr ifconfig 8
148 .Rs
149 .%T AMD PCnet/FAST, PCnet/FAST+ and PCnet/Home datasheets
150 .%O http://www.amd.com
151 .Re
152 .Sh HISTORY
153 The
154 .Nm
155 device driver first appeared in
156 .Fx 4.3 .
157 .Sh AUTHORS
158 The
159 .Nm
160 driver was written by
161 .An Bill Paul Aq wpaul@osd.bsdi.com .