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