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