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 .\" $DragonFly: src/share/man/man4/man4.i386/cs.4,v 1.4 2007/02/25 12:03:07 swildner Exp $
  28 .\"
  29 .Dd July 20, 1998
  30 .Dt CS 4 i386
  31 .Os
  32 .Sh NAME
  33 .Nm cs
  34 .Nd Crystal Semiconductor CS8900 and CS8920 ethernet device driver
  35 .Sh SYNOPSIS
  36 .Cd "device cs0 at isa? port 0x300 irq ?"
  37 .Cd "device cs1 at isa? port 0x300 irq 10 iomem 0xd0000"
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver provides support for ISA ethernet adapters based on the
  42 .Tn Crystal Semiconductor CS8900
  43 and
  44 .Tn CS8920
  45 NICs.  These devices are used on the
  46 .Tn IBM EtherJet ISA
  47 adapters and in many embedded applications where the high integration, small
  48 size and low cost of the CS89x0 family compensate for their drawbacks.
  49 .Pp
  50 The
  51 .Nm
  52 driver will obtain configuration parameters either from the configuration entry
  53 or from the card.  Parameters specified in the configuration entry will be
  54 used if present; the card may be soft-configured so these may be any valid
  55 value.  Adapters based on the CS8920 normally offer PnP configuration and the driver
  56 will detect the
  57 .Tn IBM EtherJet
  58 and the
  59 .Tn CSC6040
  60 adapters automatically.
  61 .Pp
  62 Note that the CS8900 is limited to 4 IRQ values; these are normally implemented
  63 as 5, 10, 11 and 12.  The CS8920 has no such limitation.
  64 .Pp
  65 Memory-mapped and DMA operation are not supported at this time.
  66 .Sh DIAGNOSTICS
  67 .Bl -diag
  68 .It "cs%d: full/half duplex negotiation timeout"
  69 The attempt to negotiate duplex settings with the hub timed out.  This may
  70 indicate a cabling problem or a faulty or incompatible hub.
  71 .It "cs%d: failed to enable <media>"
  72 The CS89x0 failed to select the nominated media, either because it is not
  73 present or not operating correctly.
  74 .It "cs%d: No EEPROM, assuming defaults"
  75 The CS89x0 does not have an EEPROM, or the EEPROM is hopelessly damaged.  Operation
  76 will only be successful if the configuration entry lists suitable values for
  77 the adapter.
  78 .It "cs%d: Invalid irq"
  79 The IRQ specified in the configuration entry is not valid for the adapter.
  80 .It "cs%d: Could not allocate memory for NIC"
  81 There is a critical memory shortage.  The adapter will not function.
  82 .It "cs%d: Adapter has no media"
  83 The adapter is not configured for a specific media type.
  84 The media type will have
  85 to be manually set.
  86 .It "This is a %s, but LDN %d is disabled"
  87 The PnP probe code found a recognised adapter, but the adapter is disabled.
  88 .It "failed to read pnp parms"
  89 A PnP adapter was found, but configuration parameters for it could not be read.
  90 .It "failed to pnp card parametars"
  91 The parameters obtained via PnP were not accepted by the driver.  The adapter
  92 may not function.
  93 .El
  94 .Sh CAVEATS
  95 The CS89x0 family of adapters have a very small RAM buffer (4K).  This may
  96 cause problems with extremely high network loads or bursty network traffic.
  97 In particular, NFS operations should be limited to 1k read/write transactions
  98 in order to avoid overruns.
  99 .Sh SEE ALSO
 100 .Xr arp 4 ,
 101 .Xr ifmedia 4 ,
 102 .Xr netintro 4 ,
 103 .Xr ng_ether 4 ,
 104 .Xr ifconfig 8
 105 .Sh AUTHORS
 106 .An -nosplit
 107 The
 108 .Nm
 109 device driver was written by
 110 .An Maxim Bolotin
 111 and
 112 .An Oleg Sharoiko .
 113 This manpage was written by
 114 .An Michael Smith .