Add a section 4 manpage for the 'cs' driver.
This commit is contained in:
msmith
parent
bb5c239654
commit
6cb2ca9416
@ -1,7 +1,7 @@
|
||||
# $Id: Makefile,v 1.73 1998/03/09 10:56:20 jkh Exp $
|
||||
# $Id: Makefile,v 1.74 1998/05/21 03:20:38 wpaul Exp $
|
||||
|
||||
MAN4= aha.4 ahb.4 ahc.4 aic.4 alog.4 apm.4 ar.4 asc.4 bktr.4 bt.4 \
|
||||
cx.4 cy.4 de.4 \
|
||||
cs.4 cx.4 cy.4 de.4 \
|
||||
dgb.4 ed.4 eg.4 el.4 ep.4 ex.4 gsc.4 fdc.4 fe.4 fxp.4 ie.4 io.4 \
|
||||
joy.4 keyboard.4 labpc.4 le.4 lnc.4 lp.4 lpt.4 matcd.4 mcd.4 mem.4 \
|
||||
meteor.4 mouse.4 mse.4 mtio.4 nca.4 ncr.4 npx.4 \
|
||||
@ -20,6 +20,7 @@ MLINKS+= ar.4 ../ar.4
|
||||
MLINKS+= asc.4 ../asc.4
|
||||
MLINKS+= bktr.4 ../bktr.4
|
||||
MLINKS+= bt.4 ../bt.4
|
||||
MLINKS+= cs.4 ../cs.4
|
||||
MLINKS+= cx.4 ../cx.4
|
||||
MLINKS+= cy.4 ../cy.4
|
||||
MLINKS+= de.4 ../de.4
|
||||
|
||||
102
share/man/man4/man4.i386/cs.4
Normal file
102
share/man/man4/man4.i386/cs.4
Normal file
@ -0,0 +1,102 @@
|
||||
.\"
|
||||
.\" Copyright (c) 1998 Michael Smith
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $Id$
|
||||
.\"
|
||||
.Dd July 20, 1998
|
||||
.Dt CS 4 i386
|
||||
.Os FreeBSD
|
||||
.Sh NAME
|
||||
.Nm cs
|
||||
.Nd ethernet device driver
|
||||
.Sh SYNOPSIS
|
||||
.Cd "device cs0 at isa? port 0x300 net irq ? vector csintr"
|
||||
.Cd "device cs1 at isa? port 0x300 net irq 10 iomem 0xd0000 vector csintr"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
driver provides support for ISA ethernet adapters based on the
|
||||
.Nm Crystal Semiconductor CS8900 and CS8920
|
||||
NICs. These devices are used on the
|
||||
.Nm IBM EtherJet ISA
|
||||
adapters and in many embedded applications where the high integration, small
|
||||
size and low cost of the CS89x0 family compensate for their drawbacks.
|
||||
.Pp
|
||||
The
|
||||
.Nm
|
||||
driver will obtain configuration parameters either from the configuration entry
|
||||
or from the card. Parameters specified in the configuration entry will be
|
||||
used if present; the card may be soft-configured so these may be any valid
|
||||
value. Adapters based on the CS8920 normally offer PnP configuration and the driver
|
||||
will detect the
|
||||
.Nm IBM EtherJet
|
||||
and the
|
||||
.Nm CSC6040
|
||||
adapters automatically.
|
||||
.Pp
|
||||
Note that the CS8900 is limited to 4 IRQ values; these are normally implemented
|
||||
as 5, 10, 11 and 12. The CS8920 has no such limitation.
|
||||
.Pp
|
||||
Memory-mapped and DMA operation are not supported at this time.
|
||||
.Sh DIAGNOSTICS
|
||||
.Bl -diag
|
||||
.It "cs%d: full/half duplex negotiation timeout"
|
||||
The attempt to negotiate duplex settings with the hub timed out. This may
|
||||
indicate a cabling problem or a faulty or incompatible hub.
|
||||
.It "cs%d: failed to enable <media>"
|
||||
The CS89x0 failed to select the nominated media, either because it is not
|
||||
present or not operating correctly.
|
||||
.It "cs%d: No EEPROM, assuming defaults"
|
||||
The CS89x0 does not have an EEPROM, or the EEPROM is hopelessly damaged. Operation
|
||||
will only be successful if the configuration entry lists suitable values for
|
||||
the adapter.
|
||||
.It "cs%d: Invalid irq"
|
||||
The IRQ specified in the configuration entry is not valid for the adapter.
|
||||
.It "cs%d: Could not allocate memory for NIC"
|
||||
There is a critical memory shortage. The adapter will not function.
|
||||
.It "cs%d: Adapter has no media"
|
||||
The adapter is not configured for a specific media type. The media type will have
|
||||
to be manually set.
|
||||
.It "This is a %s, but LDN %d is disabled"
|
||||
The PnP probe code found a recognised adapter, but the adapter is disabled.
|
||||
.It "failed to read pnp parms"
|
||||
A PnP adapter was found, but configuration parameters for it could not be read.
|
||||
.It "failed to pnp card parametars"
|
||||
The parameters obtained via PnP were not accepted by the driver. The adapter
|
||||
may not function.
|
||||
.Sh CAVEATS
|
||||
The CS89x0 family of adapters have a very small RAM buffer (4K). This may
|
||||
cause problems with extremely high network loads or bursty network traffic.
|
||||
In particular, NFS operations should be limited to 1k read/write transactions
|
||||
in order to avoid overruns.
|
||||
.Sh AUTHORS
|
||||
The
|
||||
.Nm
|
||||
device driver was written by
|
||||
.An Maxim Bolotin
|
||||
and
|
||||
.An Oleg Sharoiko .
|
||||
This manpage was written by
|
||||
.An Michael Smith .
|
||||
Loading…
Reference in New Issue
Block a user