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