Initial import from FreeBSD RELENG_4:
[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 .\"
34 .Dd September 18, 2000
35 .Dt PCN 4
36 .Os
37 .Sh NAME
38 .Nm pcn
39 .Nd "AMD PCnet/PCI fast ethernet device driver"
40 .Sh SYNOPSIS
41 .Cd "device miibus"
42 .Cd "device pcn"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides support for PCI ethernet adapters and embedded
47 controllers based on the AMD PCnet/FAST, PCnet/FAST+, PCnet/FAST III,
48 PCnet/PRO and PCnet/Home ethernet controller chips.
49 .Pp
50 The PCnet/PCI chips include a 100Mbps ethernet MAC and support
51 both a serial and MII-compliant transceiver interface.
52 They use a bus master DMA and a scatter/gather descriptor scheme.
53 The AMD chips provide a mechanism for zero-copy receive,
54 providing good performance in server environments.
55 Receive address filtering is provided using a single perfect filter entry
56 for the station address and a 64-bit multicast hash table.
57 .Pp
58 The
59 .Nm
60 driver supports the following media types:
61 .Pp
62 .Bl -tag -width 10baseTXUTP
63 .It autoselect
64 Enable autoselection of the media type and options.
65 The user can manually override
66 the autoselected mode by adding media options to
67 .Xr rc.conf 5 .
68 .It 10baseT/UTP
69 Set 10Mbps operation.
70 The
71 .Xr ifconfig 8
72 .Cm mediaopt
73 option can also be used to select either
74 .Sq full-duplex
75 or
76 .Sq half-duplex
77 modes.
78 .It 100baseTX
79 Set 100Mbps (fast ethernet) operation.
80 The
81 .Xr ifconfig 8
82 .Cm mediaopt
83 option can also be used to select either
84 .Sq full-duplex
85 or
86 .Sq half-duplex
87 modes.
88 .El
89 .Pp
90 The
91 .Nm
92 driver supports the following media options:
93 .Pp
94 .Bl -tag -width full-duplex
95 .It full-duplex
96 Force full duplex operation
97 .It half-duplex
98 Force half duplex operation.
99 .El
100 .Pp
101 For more information on configuring this device, see
102 .Xr ifconfig 8 .
103 .Sh DIAGNOSTICS
104 .Bl -diag
105 .It "pcn%d: couldn't map ports/memory"
106 A fatal initialization error has occurred.
107 .It "pcn%d: couldn't map interrupt"
108 A fatal initialization error has occurred.
109 .It "pcn%d: watchdog timeout"
110 The device has stopped responding to the network, or there is a problem with
111 the network connection (e.g. a cable fault).
112 .It "pcn%d: no memory for rx list"
113 The driver failed to allocate an mbuf for the receiver ring.
114 .It "pcn%d: no memory for tx list"
115 The driver failed to allocate an mbuf for the transmitter ring when
116 allocating a pad buffer or collapsing an mbuf chain into a clusisr.
117 .It "pcn%d: chip is in D3 power state -- setting to D0"
118 This message applies only to adapters which support power
119 management.
120 Some operating systems place the controller in low power
121 mode when shutting down, and some PCI BIOSes fail to bring the chip
122 out of this state before configuring it.
123 The controller loses all of
124 its PCI configuration in the D3 state, so if the BIOS does not set
125 it back to full power mode in time, it will not be able to configure it
126 correctly.
127 The driver tries to detect this condition and bring
128 the adapter back to the D0 (full power) state, but this may not be
129 enough to return the driver to a fully operational condition.
130 If
131 you see this message at boot time and the driver fails to attach
132 the device as a network interface, you will have to perform a
133 warm boot to have the device properly configured.
134 .Pp
135 Note that this condition only occurs when warm booting from another
136 operating system.
137 If you power down your system prior to booting
138 .Fx ,
139 the card should be configured correctly.
140 .El
141 .Sh SEE ALSO
142 .Xr arp 4 ,
143 .Xr miibus 4 ,
144 .Xr netintro 4 ,
145 .Xr ng_ether 4 ,
146 .Xr ifconfig 8
147 .Rs
148 .%T AMD PCnet/FAST, PCnet/FAST+ and PCnet/Home datasheets
149 .%O http://www.amd.com
150 .Re
151 .Sh HISTORY
152 The
153 .Nm
154 device driver first appeared in
155 .Fx 4.3 .
156 .Sh AUTHORS
157 The
158 .Nm
159 driver was written by
160 .An Bill Paul Aq wpaul@osd.bsdi.com .