share/man/man4/man4.i386/cs.4

   1 .\"
   2 .\" Copyright (c) 1998 Michael Smith
   3 .\" 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 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man4/man4.i386/cs.4,v 1.6.2.5 2001/08/17 13:08:45 ru Exp $
  27 .\"
  28 .Dd July 20, 1998
  29 .Dt CS 4 i386
  30 .Os
  31 .Sh NAME
  32 .Nm cs
  33 .Nd Crystal Semiconductor CS8900 and CS8920 ethernet device driver
  34 .Sh SYNOPSIS
  35 .Cd "device cs"
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 driver provides support for ethernet adapters based on the
  40 .Tn Crystal Semiconductor CS8900
  41 and
  42 .Tn CS8920
  43 NICs.  These devices are used on the
  44 .Tn IBM EtherJet PCMCIA
  45 adapters and in many embedded applications where the high integration, small
  46 size and low cost of the CS89x0 family compensate for their drawbacks.
  47 .Pp
  48 The
  49 .Nm
  50 driver will obtain configuration parameters from the card.
  51 Parameters specified in the configuration entry will be
  52 used if present; the card may be soft-configured so these may be any valid
  53 value.
  54 The driver will detect the
  55 .Tn IBM EtherJet
  56 adapters automatically.
  57 .Pp
  58 Memory-mapped and DMA operation are not supported at this time.
  59 .Sh DIAGNOSTICS
  60 .Bl -diag
  61 .It "cs%d: full/half duplex negotiation timeout"
  62 The attempt to negotiate duplex settings with the hub timed out.  This may
  63 indicate a cabling problem or a faulty or incompatible hub.
  64 .It "cs%d: failed to enable <media>"
  65 The CS89x0 failed to select the nominated media, either because it is not
  66 present or not operating correctly.
  67 .It "cs%d: No EEPROM, assuming defaults"
  68 The CS89x0 does not have an EEPROM, or the EEPROM is hopelessly damaged.  Operation
  69 will only be successful if the configuration entry lists suitable values for
  70 the adapter.
  71 .It "cs%d: Invalid irq"
  72 The IRQ specified in the configuration entry is not valid for the adapter.
  73 .It "cs%d: Could not allocate memory for NIC"
  74 There is a critical memory shortage.  The adapter will not function.
  75 .It "cs%d: Adapter has no media"
  76 The adapter is not configured for a specific media type.
  77 The media type will have
  78 to be manually set.
  79 .It "This is a %s, but LDN %d is disabled"
  80 The PnP probe code found a recognised adapter, but the adapter is disabled.
  81 .It "failed to read pnp parms"
  82 A PnP adapter was found, but configuration parameters for it could not be read.
  83 .It "failed to pnp card parametars"
  84 The parameters obtained via PnP were not accepted by the driver.  The adapter
  85 may not function.
  86 .El
  87 .Sh CAVEATS
  88 The CS89x0 family of adapters have a very small RAM buffer (4K).  This may
  89 cause problems with extremely high network loads or bursty network traffic.
  90 In particular, NFS operations should be limited to 1k read/write transactions
  91 in order to avoid overruns.
  92 .Sh SEE ALSO
  93 .Xr arp 4 ,
  94 .Xr ifmedia 4 ,
  95 .Xr netintro 4 ,
  96 .Xr ng_ether 4 ,
  97 .Xr ifconfig 8
  98 .Sh AUTHORS
  99 .An -nosplit
 100 The
 101 .Nm
 102 device driver was written by
 103 .An Maxim Bolotin
 104 and
 105 .An Oleg Sharoiko .
 106 This manpage was written by
 107 .An Michael Smith .