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