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$
  27 .\"
  28 .Dd July 16, 2005
  29 .Dt CS 4 i386
  30 .Os
  31 .Sh NAME
  32 .Nm cs
  33 .Nd "Ethernet device driver"
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following line in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device cs"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 if_cs_load="YES"
  47 .Ed
  48 .Pp
  49 In
  50 .Pa /boot/device.hints :
  51 .Cd hint.cs.0.at="isa"
  52 .Cd hint.cs.0.port="0x300"
  53 .Cd hint.cs.0.irq="10"
  54 .Cd hint.cs.0.maddr="0xd000"
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 driver provides support for ISA Ethernet adapters based on the
  59 .Tn Crystal Semiconductor CS8900
  60 and
  61 .Tn CS8920
  62 NICs.
  63 These devices are used on the
  64 .Tn IBM EtherJet ISA
  65 adapters and in many embedded applications where the high integration, small
  66 size and low cost of the CS89x0 family compensate for their drawbacks.
  67 .Pp
  68 The
  69 .Nm
  70 driver will obtain configuration parameters either from
  71 .Pa /boot/device.hints
  72 or from the card.
  73 At least the I/O port number must be specified.
  74 Other parameters specified in
  75 .Pa /boot/device.hints
  76 will be used if present;
  77 the card may be soft-configured so these may be any valid
  78 value.
  79 Adapters based on the CS8920 normally offer PnP configuration and the driver
  80 will detect the
  81 .Tn IBM EtherJet
  82 and the
  83 .Tn CSC6040
  84 adapters automatically.
  85 .Pp
  86 Note that the CS8900 is limited to 4 IRQ values; these are normally implemented
  87 as 5, 10, 11 and 12.
  88 The CS8920 has no such limitation.
  89 .Pp
  90 Memory-mapped and DMA operation are not supported at this time.
  91 .Pp
  92 In addition to the ISA devices, the PC Card devices based on the CS889x0
  93 family are also supported.
  94 The IBM EtherJet PCMCIA Card is the only known device based on this
  95 chip.
  96 The PC Card support does not need the above specific ISA hints to work.
  97 The PC Card support may not work for 10base2 (thinnet) connections and may
  98 bogusly claim to support 10base5 (there are no known cards that have an
  99 AUI necessary for 10base5 support on their dongles).
 100 .Sh DIAGNOSTICS
 101 .Bl -diag
 102 .It "cs%d: full/half duplex negotiation timeout"
 103 The attempt to negotiate duplex settings with the hub timed out.
 104 This may
 105 indicate a cabling problem or a faulty or incompatible hub.
 106 .It "cs%d: failed to enable <media>"
 107 The CS89x0 failed to select the nominated media, either because it is not
 108 present or not operating correctly.
 109 .It "cs%d: No EEPROM, assuming defaults"
 110 The CS89x0 does not have an EEPROM, or the EEPROM is hopelessly damaged.
 111 Operation
 112 will only be successful if the configuration entry lists suitable values for
 113 the adapter.
 114 .It "cs%d: Invalid irq"
 115 The IRQ specified in the configuration entry is not valid for the adapter.
 116 .It "cs%d: Could not allocate memory for NIC"
 117 There is a critical memory shortage.
 118 The adapter will not function.
 119 .It "cs%d: Adapter has no media"
 120 The adapter is not configured for a specific media type.
 121 The media type will have
 122 to be manually set.
 123 .It "This is a %s, but LDN %d is disabled"
 124 The PnP probe code found a recognised adapter, but the adapter is disabled.
 125 .It "failed to read pnp parms"
 126 A PnP adapter was found, but configuration parameters for it could not be read.
 127 .It "failed to pnp card parameters"
 128 The parameters obtained via PnP were not accepted by the driver.
 129 The adapter
 130 may not function.
 131 .El
 132 .Sh CAVEATS
 133 The CS89x0 family of adapters have a very small RAM buffer (4K).
 134 This may
 135 cause problems with extremely high network loads or bursty network traffic.
 136 In particular, NFS operations should be limited to 1k read/write transactions
 137 in order to avoid overruns.
 138 .Sh SEE ALSO
 139 .Xr arp 4 ,
 140 .Xr netintro 4 ,
 141 .Xr ng_ether 4 ,
 142 .Xr ifconfig 8
 143 .Sh AUTHORS
 144 .An -nosplit
 145 The
 146 .Nm
 147 device driver was written by
 148 .An Maxim Bolotin
 149 and
 150 .An Oleg Sharoiko .
 151 This manpage was written by
 152 .An Michael Smith .