Various repairs, $Id$ tags added, etc.

1 files changed, 71 insertions, 54 deletions

diff --git a/share/man/man4/dc.4 b/share/man/man4/dc.4
index 2a9ddd180cc..a8d47505dee 100644
--- a/share/man/man4/dc.4
+++ b/share/man/man4/dc.4
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: dc.4,v 1.16 2000/11/16 06:08:30 aaron Exp $
+.\"	$OpenBSD: dc.4,v 1.17 2000/12/21 21:01:15 aaron Exp $
 .\"
 .\" Copyright (c) 1997, 1998, 1999
 .\"	Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
@@ -68,29 +68,31 @@ Xircom X3201-based CardBus
 .El
 .Pp
 All of these chips have the same general register layout, DMA
-descriptor format and method of operation. All of the clone chips
-are based on the 21143 design with various modifications. The
-21143 itself has support for 10baseT, BNC, AUI, MII and symbol
+descriptor format and method of operation.
+All of the clone chips are based on the 21143 design with
+various modifications.
+The 21143 itself has support for 10baseT, BNC, AUI, MII and symbol
 media attachments, 10 and 100Mbps speeds in full or half duplex,
-built in NWAY autonegotiation and wake on LAN. The 21143 also
-offers several receive filter programming options including
-perfect filtering, inverse perfect filtering and hash table
-filtering.
+built in NWAY autonegotiation and wake on LAN.
+The 21143 also offers several receive filter programming options including
+perfect filtering, inverse perfect filtering and hash table filtering.
 .Pp
 Some clone chips duplicate the 21143 fairly closely while others
-only maintain superficial simularities. Some support only MII
-media attachments. Others use different receiver filter programming
-mechanisms. At least one supports only chained DMA descriptors
+only maintain superficial simularities.
+Some support only MII media attachments.
+Others use different receiver filter programming mechanisms.
+At least one supports only chained DMA descriptors
 (most support both chained descriptors and contiguously allocated
-fixed size rings). Some chips (especially the PNIC) also have
-peculiar bugs. The
+fixed size rings).
+Some chips (especially the PNIC) also have peculiar bugs.
+The
 .Nm
 driver does its best to provide generalized support for all
 of these chipsets in order to keep special case code to a minimun.
 .Pp
 These chips are used by many vendors which makes it
-difficult provide a complete list of all supported cards. The
-following NICs are known to work with the
+difficult provide a complete list of all supported cards.
+The following NICs are known to work with the
 .Nm
 driver at this time:
 .Pp
@@ -134,7 +136,7 @@ CNet Pro110B (ASIX AX88140A)
 .It
 LinkSys LNE100TX v4.x (ADMtek AN983 Centaur-P)
 .It
-Xircom X3201-based CardBus PC Cards, including RealPort models (Xircom X3201)
+Xircom CardBus, including RealPort models (Xircom X3201)
 .It
 IBM EtherJet 10/100 CardBus (Intel 21143)
 .It
@@ -157,24 +159,29 @@ Note: the built-in NWAY autonegotiation on the original PNIC 82c168
 chip is horribly broken and is not supported by the
 .Nm
 driver at this time: the chip will operate in any speed or duplex
-mode, however these must be set manually. The original 82c168 appears
-on very early revisions of the LinkSys LNE100TX and Matrox FastNIC.
+mode, however these must be set manually.
+The original 82c168 appears on very early revisions of the LinkSys LNE100TX
+and Matrox FastNIC.
 .It 10baseT/UTP
-Set 10Mbps operation. The
+Set 10Mbps operation.
+The
 .Ar mediaopt
 option can also be used to enable
 .Ar full-duplex
-operation. Not specifying
+operation.
+Not specifying
 .Ar full duplex
 implies
 .Ar half-duplex
 mode.
 .It 100baseTX
-Set 100Mbps (Fast Ethernet) operation. The
+Set 100Mbps (Fast Ethernet) operation.
+The
 .Ar mediaopt
 option can also be used to enable
 .Ar full-duplex
-operation. Not specifying
+operation.
+Not specifying
 .Ar full duplex
 implies
 .Ar half-duplex
@@ -187,8 +194,9 @@ driver supports the following media options:
 .Pp
 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 .It full-duplex
-Force full duplex operation. The interface will operate in
-half duplex mode if this media option is not specified.
+Force full duplex operation.
+The interface will operate in half duplex mode if this media option
+is not specified.
 .El
 .Pp
 Note that the 100baseTX media type may not be available on certain
@@ -204,40 +212,43 @@ A fatal initialization error has occurred.
 .It "dc%d: watchdog timeout"
 A packet was queued for transmission and a transmit command was
 issued, however the device failed to acknowledge the transmission
-before a timeout expired. This can happen if the device is unable
-to deliver interrupts for some reason, or if there is a problem with
-the network connection (cable).
+before a timeout expired.
+This can happen if the device is unable to deliver interrupts for some
+reason, or if there is a problem with the network connection (cable).
 .It "dc%d: no memory for rx list"
 The driver failed to allocate an mbuf for the receiver ring.
 .It "dc%d: TX underrun -- increasing TX threshold"
 The device generated a transmit underrun error while attempting to
-DMA and transmit a packet. This happens if the host is not able to
-DMA the packet data into the NIC's FIFO fast enough. The driver
-will dynamically increase the transmit start threshold so that
+DMA and transmit a packet.
+This happens if the host is not able to DMA the packet data into the NIC's
+FIFO fast enough.
+The driver will dynamically increase the transmit start threshold so that
 more data must be DMAed into the FIFO before the NIC will start
 transmitting it onto the wire.
 .It "dc%d: TX underrun -- using store and forward mode"
 The device continued to generate transmit underruns even after all
 possible transmit start threshold settings had been tried, so the
-driver programmed the chip for store and forward mode. In this mode,
-the NIC will not begin transmission until the entire packet has been
-transferred into its FIFO memory.
+driver programmed the chip for store and forward mode.
+In this mode, the NIC will not begin transmission until the entire packet
+has been transferred into its FIFO memory.
 .It "dc%d: chip is in D3 power state -- setting to D0"
-This message applies only to adapters which support power
-management. Some operating systems place the controller in low power
+This message applies only to adapters which support power management.
+Some operating systems place the controller in low power
 mode when shutting down, and some PCI BIOSes fail to bring the chip
-out of this state before configuring it. The controller loses all of
-its PCI configuration in the D3 state, so if the BIOS does not set
-it back to full power mode in time, it won't be able to configure it
-correctly. The driver tries to detect this condition and bring
+out of this state before configuring it.
+The controller loses all of its PCI configuration in the D3 state,
+so if the BIOS does not set it back to full power mode in time,
+it won't be able to configure it correctly.
+The driver tries to detect this condition and bring
 the adapter back to the D0 (full power) state, but this may not be
-enough to return the driver to a fully operational condition. If
-you see this message at boot time and the driver fails to attach
+enough to return the driver to a fully operational condition.
+If you see this message at boot time and the driver fails to attach
 the device as a network interface, you will have to perform a second
 warm boot to have the device properly configured.
 .Pp
 Note that this condition only occurs when warm booting from another
-operating system. If you power down your system prior to booting
+operating system.
+If you power down your system prior to booting
 .Ox ,
 the card should be configured correctly.
 .El
@@ -286,14 +297,15 @@ by Aaron Campbell <aaron@openbsd.org>.
 .Sh BUGS
 The Macronix application notes claim that in order to put the
 chips in normal operation, the driver must write a certain magic
-number into the CSR16 register. The numbers are documented in
-the app notes, but the exact meaning of the bits is not.
+number into the CSR16 register.
+The numbers are documented in the app notes, but the exact meaning of the
+bits is not.
 .Pp
 The 98713A seems to have a problem with 10Mbps full duplex mode.
 The transmitter works but the receiver tends to produce many
-unexplained errors leading to very poor overall performance. The
-98715A does not exhibit this problem. All other modes on the
-98713A seem to work correctly.
+unexplained errors leading to very poor overall performance.
+The 98715A does not exhibit this problem.
+All other modes on the 98713A seem to work correctly.
 .Pp
 The original 82c168 PNIC chip has built in NWAY support which is
 used on certain early LinkSys LNE100TX and Matrox FastNIC cards,
@@ -307,24 +319,27 @@ autonegotiation and work correctly.)
 The
 .Nm
 driver programs 82c168 and 82c169 PNIC chips to use the store and
-forward setting for the transmit start threshold by default. This
-is to work around problems with some NIC/PCI bus combinations where
+forward setting for the transmit start threshold by default.
+This is to work around problems with some NIC/PCI bus combinations where
 the PNIC can transmit corrupt frames when operating at 100Mbps,
 probably due to PCI DMA burst transfer errors.
 .Pp
 The 82c168 and 82c169 PNIC chips also have a receiver bug that
 sometimes manifests during periods of heavy receive and transmit
 activity, where the chip will improperly DMA received frames to
-the host. The chips appear to upload several kilobytes of garbage
+the host.
+The chips appear to upload several kilobytes of garbage
 data along with the received frame data, dirtying several RX buffers
-instead of just the expected one. The
+instead of just the expected one.
+The
 .Nm
 driver detects this condition and will salvage the frame, however
 it incurs a serious performance penalty in the process.
 .Pp
 The PNIC chips also sometimes generate a transmit underrun error when
 the driver attempts to download the receiver filter setup frame, which
-can result in the receive filter being incorrectly programmed. The
+can result in the receive filter being incorrectly programmed.
+The
 .Nm
 driver will watch for this condition and requeue the setup frame until
 it is transferred successfully.
@@ -332,12 +347,14 @@ it is transferred successfully.
 The ADMtek AL981 chip (and possibly the AN983 as well) has been observed
 to sometimes wedge on transmit: this appears to happen when the driver
 queues a sequence of frames which cause it to wrap from the end of
-the transmit descriptor ring back to the beginning. The
+the transmit descriptor ring back to the beginning.
+The
 .Nm
 driver attempts to avoid this condition by not queing any frames past
 the end of the transmit ring during a single invocation of the
 .Fn dc_start
-routine. This workaround has a negligible impact on transmit performance.
+routine.
+This workaround has a negligible impact on transmit performance.
 .Pp
 The
 .Fn mii_tick