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 September 13, 2004
  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 Supported NIC's include the Allied Telesyn AT-2700 familly.
  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 HARDWARE
 105 The
 106 .Nm
 107 driver supports adapters and embedded controllers based on the AMD PCnet/FAST,
 108 PCnet/FAST+, PCnet/FAST III, PCnet/PRO and PCnet/Home Fast Ethernet chips:
 109 .Pp
 110 .Bl -bullet -compact
 111 .It
 112 AMD Am53C974/Am79C970/Am79C974 PCnet-PCI
 113 .It
 114 AMD Am79C970A PCnet-PCI II
 115 .It
 116 AMD Am79C971 PCnet-FAST
 117 .It
 118 AMD Am79C972 PCnet-FAST+
 119 .It
 120 AMD Am79C973/Am79C975 PCnet-FAST III
 121 .It
 122 AMD Am79C976 PCnet-PRO
 123 .It
 124 AMD PCnet/Home HomePNA
 125 .It
 126 Allied-Telesis LA-PCI
 127 .It
 128 Contec C-NET(98)S (PC-98)
 129 .It
 130 NEC SV-98/2-B05, B06
 131 .El
 132 .Sh DIAGNOSTICS
 133 .Bl -diag
 134 .It "pcn%d: couldn't map ports/memory"
 135 A fatal initialization error has occurred.
 136 .It "pcn%d: couldn't map interrupt"
 137 A fatal initialization error has occurred.
 138 .It "pcn%d: watchdog timeout"
 139 The device has stopped responding to the network, or there is a problem with
 140 the network connection (e.g.\& a cable fault).
 141 .It "pcn%d: no memory for rx list"
 142 The driver failed to allocate an mbuf for the receiver ring.
 143 .It "pcn%d: no memory for tx list"
 144 The driver failed to allocate an mbuf for the transmitter ring when
 145 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 146 .It "pcn%d: chip is in D3 power state -- setting to D0"
 147 This message applies only to adapters which support power
 148 management.
 149 Some operating systems place the controller in low power
 150 mode when shutting down, and some PCI BIOSes fail to bring the chip
 151 out of this state before configuring it.
 152 The controller loses all of
 153 its PCI configuration in the D3 state, so if the BIOS does not set
 154 it back to full power mode in time, it will not be able to configure it
 155 correctly.
 156 The driver tries to detect this condition and bring
 157 the adapter back to the D0 (full power) state, but this may not be
 158 enough to return the driver to a fully operational condition.
 159 If
 160 you see this message at boot time and the driver fails to attach
 161 the device as a network interface, you will have to perform a
 162 warm boot to have the device properly configured.
 163 .Pp
 164 Note that this condition only occurs when warm booting from another
 165 operating system.
 166 If you power down your system prior to booting
 167 .Fx ,
 168 the card should be configured correctly.
 169 .El
 170 .Sh SEE ALSO
 171 .Xr arp 4 ,
 172 .Xr miibus 4 ,
 173 .Xr netintro 4 ,
 174 .Xr ng_ether 4 ,
 175 .Xr ifconfig 8
 176 .Rs
 177 .%T AMD PCnet/FAST, PCnet/FAST+ and PCnet/Home datasheets
 178 .%O http://www.amd.com
 179 .Re
 180 .Sh HISTORY
 181 The
 182 .Nm
 183 device driver first appeared in
 184 .Fx 4.3 .
 185 .Sh AUTHORS
 186 The
 187 .Nm
 188 driver was written by
 189 .An Bill Paul Aq wpaul@osd.bsdi.com .