man4: use .Mt for emails (1/2)
[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 .Bl -tag -width 10baseTXUTP
62 .It autoselect
63 Enable autoselection of the media type and options.
64 The user can manually override
65 the autoselected mode by adding media options to
66 .Xr rc.conf 5 .
67 .It 10baseT/UTP
68 Set 10Mbps operation.
69 The
70 .Xr ifconfig 8
71 .Cm mediaopt
72 option can also be used to select either
73 .Sq full-duplex
74 or
75 .Sq half-duplex
76 modes.
77 .It 100baseTX
78 Set 100Mbps (fast ethernet) operation.
79 The
80 .Xr ifconfig 8
81 .Cm mediaopt
82 option can also be used to select either
83 .Sq full-duplex
84 or
85 .Sq half-duplex
86 modes.
87 .El
88 .Pp
89 The
90 .Nm
91 driver supports the following media options:
92 .Bl -tag -width full-duplex
93 .It full-duplex
94 Force full duplex operation
95 .It half-duplex
96 Force half duplex operation.
97 .El
98 .Pp
99 For more information on configuring this device, see
100 .Xr ifconfig 8 .
101 .Sh DIAGNOSTICS
102 .Bl -diag
103 .It "pcn%d: couldn't map ports/memory"
104 A fatal initialization error has occurred.
105 .It "pcn%d: couldn't map interrupt"
106 A fatal initialization error has occurred.
107 .It "pcn%d: watchdog timeout"
108 The device has stopped responding to the network, or there is a problem with
109 the network connection (e.g. a cable fault).
110 .It "pcn%d: no memory for rx list"
111 The driver failed to allocate an mbuf for the receiver ring.
112 .It "pcn%d: no memory for tx list"
113 The driver failed to allocate an mbuf for the transmitter ring when
114 allocating a pad buffer or collapsing an mbuf chain into a clusisr.
115 .It "pcn%d: chip is in D3 power state -- setting to D0"
116 This message applies only to adapters which support power
117 management.
118 Some operating systems place the controller in low power
119 mode when shutting down, and some PCI BIOSes fail to bring the chip
120 out of this state before configuring it.
121 The controller loses all of
122 its PCI configuration in the D3 state, so if the BIOS does not set
123 it back to full power mode in time, it will not be able to configure it
124 correctly.
125 The driver tries to detect this condition and bring
126 the adapter back to the D0 (full power) state, but this may not be
127 enough to return the driver to a fully operational condition.
128 If
129 you see this message at boot time and the driver fails to attach
130 the device as a network interface, you will have to perform a
131 warm boot to have the device properly configured.
132 .Pp
133 Note that this condition only occurs when warm booting from another
134 operating system.
135 If you power down your system prior to booting
136 .Dx ,
137 the card should be configured correctly.
138 .El
139 .Sh SEE ALSO
140 .Xr arp 4 ,
141 .Xr ifmedia 4 ,
142 .Xr miibus 4 ,
143 .Xr netintro 4 ,
144 .Xr ng_ether 4 ,
145 .Xr ifconfig 8
146 .Rs
147 .%T AMD PCnet/FAST, PCnet/FAST+ and PCnet/Home datasheets
148 .%O http://www.amd.com
149 .Re
150 .Sh HISTORY
151 The
152 .Nm
153 device driver first appeared in
154 .Fx 4.3 .
155 .Sh AUTHORS
156 The
157 .Nm
158 driver was written by
159 .An Bill Paul Aq Mt wpaul@osd.bsdi.com .