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 October 24 2018
  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 DEPRECATION NOTICE
  56 The
  57 .Nm
  58 driver is not present in
  59 .Fx 13.0
  60 and later.
  61 See https://github.com/freebsd/fcp/blob/master/fcp-0101.md for more
  62 information.
  63 .Sh DESCRIPTION
  64 The
  65 .Nm
  66 driver provides support for ISA Ethernet adapters based on the
  67 .Tn Crystal Semiconductor CS8900
  68 and
  69 .Tn CS8920
  70 NICs.
  71 These devices are used on the
  72 .Tn IBM EtherJet ISA
  73 adapters and in many embedded applications where the high integration, small
  74 size and low cost of the CS89x0 family compensate for their drawbacks.
  75 .Pp
  76 The
  77 .Nm
  78 driver will obtain configuration parameters either from
  79 .Pa /boot/device.hints
  80 or from the card.
  81 At least the I/O port number must be specified.
  82 Other parameters specified in
  83 .Pa /boot/device.hints
  84 will be used if present;
  85 the card may be soft-configured so these may be any valid
  86 value.
  87 Adapters based on the CS8920 normally offer PnP configuration and the driver
  88 will detect the
  89 .Tn IBM EtherJet
  90 and the
  91 .Tn CSC6040
  92 adapters automatically.
  93 .Pp
  94 Note that the CS8900 is limited to 4 IRQ values; these are normally implemented
  95 as 5, 10, 11 and 12.
  96 The CS8920 has no such limitation.
  97 .Pp
  98 Memory-mapped and DMA operation are not supported at this time.
  99 .Pp
 100 In addition to the ISA devices, the PC Card devices based on the CS889x0
 101 family are also supported.
 102 The IBM EtherJet PCMCIA Card is the only known device based on this
 103 chip.
 104 The PC Card support does not need the above specific ISA hints to work.
 105 The PC Card support may not work for 10base2 (thinnet) connections and may
 106 bogusly claim to support 10base5 (there are no known cards that have an
 107 AUI necessary for 10base5 support on their dongles).
 108 .Sh DIAGNOSTICS
 109 .Bl -diag
 110 .It "cs%d: full/half duplex negotiation timeout"
 111 The attempt to negotiate duplex settings with the hub timed out.
 112 This may
 113 indicate a cabling problem or a faulty or incompatible hub.
 114 .It "cs%d: failed to enable <media>"
 115 The CS89x0 failed to select the nominated media, either because it is not
 116 present or not operating correctly.
 117 .It "cs%d: No EEPROM, assuming defaults"
 118 The CS89x0 does not have an EEPROM, or the EEPROM is hopelessly damaged.
 119 Operation
 120 will only be successful if the configuration entry lists suitable values for
 121 the adapter.
 122 .It "cs%d: Invalid irq"
 123 The IRQ specified in the configuration entry is not valid for the adapter.
 124 .It "cs%d: Could not allocate memory for NIC"
 125 There is a critical memory shortage.
 126 The adapter will not function.
 127 .It "cs%d: Adapter has no media"
 128 The adapter is not configured for a specific media type.
 129 The media type will have
 130 to be manually set.
 131 .It "This is a %s, but LDN %d is disabled"
 132 The PnP probe code found a recognised adapter, but the adapter is disabled.
 133 .It "failed to read pnp parms"
 134 A PnP adapter was found, but configuration parameters for it could not be read.
 135 .It "failed to pnp card parameters"
 136 The parameters obtained via PnP were not accepted by the driver.
 137 The adapter
 138 may not function.
 139 .El
 140 .Sh SEE ALSO
 141 .Xr arp 4 ,
 142 .Xr netintro 4 ,
 143 .Xr ng_ether 4 ,
 144 .Xr ifconfig 8
 145 .Sh AUTHORS
 146 .An -nosplit
 147 The
 148 .Nm
 149 device driver was written by
 150 .An Maxim Bolotin
 151 and
 152 .An Oleg Sharoiko .
 153 This manpage was written by
 154 .An Michael Smith .
 155 .Sh CAVEATS
 156 The CS89x0 family of adapters have a very small RAM buffer (4K).
 157 This may
 158 cause problems with extremely high network loads or bursty network traffic.
 159 In particular, NFS operations should be limited to 1k read/write transactions
 160 in order to avoid overruns.