Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / ec.4
blobc347cabe0ebca2102ec14168198fca66d91b6d42
1 .\"     $NetBSD: ec.4,v 1.12 2004/12/08 18:33:32 peter Exp $
2 .\"
3 .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
8 .\" NASA Ames Research Center.
9 .\"
10 .\" Redistribution and use in source and binary forms, with or without
11 .\" modification, are permitted provided that the following conditions
12 .\" are met:
13 .\" 1. Redistributions of source code must retain the above copyright
14 .\"    notice, this list of conditions and the following disclaimer.
15 .\" 2. Redistributions in binary form must reproduce the above copyright
16 .\"    notice, this list of conditions and the following disclaimer in the
17 .\"    documentation and/or other materials provided with the distribution.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 .\" POSSIBILITY OF SUCH DAMAGE.
30 .\"
31 .Dd October 20, 1997
32 .Dt EC 4
33 .Os
34 .Sh NAME
35 .Nm ec
36 .Nd driver for 3Com EtherLink II (3c503)
37 .Tn ISA
38 bus
39 .Tn Ethernet
40 cards
41 .Sh SYNOPSIS
42 .Cd "ec0 at isa? port 0x250 iomem 0xd8000 irq 9"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 device driver supports 3Com EtherLink II (3c503)
47 .Tn Ethernet
48 cards for
49 .Tn ISA
50 bus which are based on the National Semiconductor DP8390/WD83C690
51 .Tn Ethernet
52 interface chips.
53 .Sh MEDIA SELECTION
54 The EtherLink II supports two media types on a single card.
55 All support the
56 .Tn AUI
57 media type.
58 The other media is either
59 .Tn BNC
61 .Tn UTP
62 behind a transceiver.
63 Software cannot differentiate between
64 .Tn BNC
65 and
66 .Tn UTP
67 cards.
68 .Pp
69 To enable the AUI media, select the
70 .Em 10base5
72 .Em aui
73 media type with
74 .Xr ifconfig 8 Ns 's
75 .Cm media
76 directive.
77 To select the other media
78 .Po
79 .Tn BNC
81 .Tn UTP
82 .Pc ,
83 select the
84 .Em 10base2
86 .Em bnc
87 media type.
88 .Sh DIAGNOSTICS
89 .Bl -diag
90 .It "ec0: wildcarded IRQ is not allowed"
91 .Pp
92 The
93 .Tn IRQ
94 was wildcarded in the kernel configuration file.
95 This is not supported.
96 .It "ec0: invalid IRQ \*[Lt]n\*[Gt], must be 3, 4, 5, or 9"
97 .Pp
99 .Tn IRQ
100 other than the above
101 .Tn IRQ
102 values was specified in the kernel configuration file.
103 The EtherLink II hardware only supports the above listed
104 .Tn IRQ
105 values.
106 .It "ec0: failed to clear shared memory at offset \*[Lt]off\*[Gt]"
108 The memory test was unable to clear shared the interface's shared memory
109 region.
110 This often indicates that the card is configured at a conflicting
111 .Em iomem
112 address.
113 .It "ec0: warning - receiver ring buffer overrun"
115 The DP8390
116 .Tn Ethernet
117 chip used by this board implements a shared-memory
118 ring-buffer to store incoming packets.
119 The 3c503 usually has only 8K bytes of shared memory.
120 This is only enough room for about 4 full-size (1500 byte) packets.
121 This can sometimes be a problem, especially on the original 3c503, because
122 these boards' shared-memory access speed is quite slow; typically only
123 about 1MB/second.
124 The overhead of this slow memory access, and the fact that there
125 is only room for 4 full-sized packets means that the ring-buffer
126 will occasionally overrun.
128 When an overrun occurs, the board must be reset to avoid a lockup
129 problem in early revision DP8390
130 .Tn Ethernet
131 chips.
132 Resetting the board causes all of the data in the ring-buffer to be
133 lost, requiring the data to be retransmitted/received, congesting the board
134 further.
135 Because of this, maximum throughput on these boards is only about
136 400-600K bytes per second.
138 This problem is exacerbated by
139 .Tn NFS
140 because the 8-bit boards lack sufficient packet buffer memory to
141 support the default 8K byte packets that
142 .Tn NFS
143 and other protocols use as their default.
144 If these cards must be used
145 with
146 .Tn NFS ,
147 use the
148 .Xr mount_nfs 8
149 .Fl \&r
151 .Fl \&w
152 options in
153 .Pa /etc/fstab
154 to limit NFS's packet size.
155 4K (4096) byte packets generally work.
157 .Sh SEE ALSO
158 .Xr ifmedia 4 ,
159 .Xr intro 4 ,
160 .Xr isa 4 ,
161 .Xr ifconfig 8 ,
162 .Xr mount_nfs 8