xref: /netbsd-src/share/man/man4/we.4 (revision 481fca6e59249d8ffcf24fef7cfbe7b131bfb080)
1.\"	$NetBSD: we.4,v 1.9 1999/12/15 22:07:35 abs 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.\" 3. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"        This product includes software developed by the NetBSD
21.\"        Foundation, Inc. and its contributors.
22.\" 4. Neither the name of The NetBSD Foundation nor the names of its
23.\"    contributors may be used to endorse or promote products derived
24.\"    from this software without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36.\" POSSIBILITY OF SUCH DAMAGE.
37.\"
38.Dd October 20, 1997
39.Dt WE 4
40.Os
41.Sh NAME
42.Nm we
43.Nd Western Digital/SMC WD80x3, SMC Elite Ultra,
44and SMC EtherEZ Ethernet cards device driver
45.Sh SYNOPSIS
46.Cd "we0 at isa? port 0x280 iomem 0xd0000 irq 9"
47.Cd "we1 at isa? port 0x300 iomem 0xcc000 irq 10"
48.Sh DESCRIPTION
49The
50.Nm
51device driver supports Western Digital/SMC WD80x3, SMC Elite Ultra, and
52SMC EtherEZ Ethernet cards.
53.Sh FLAG VALUES
54For some clone boards the driver is not able to recognize 16bit or 8bit
55interfaces correctly. Since this makes a huge difference (see diagnostic
56section below)
57you can override this by specifying flags values in the config file:
58.Pp
59.Cd "we2 at isa? port 0x300 iomem 0xe0000 irq 15 flags 4"
60.Pp
61The values to add together for flags are:
62.Pp
63.Bl -diag
64.It 2
65force adapter to be treated as 8bit, even if it probes
66as a 16bit interface. Improper use of this flag will make the
67driver fail or send invalid Ethernet packets.
68.It 4
69force adapter to be treated as 16bit, even if it probes
70as a 8bit interface. For example the COMPEX ENT/U boards
71identify as WD8003 compatibles, but are in fact 16bit cards.
72Using this flag on a board that realy is a 8bit board will
73result in bogus packets being sent.
74.It 8
75disable the use of double transmit buffers to save space in
76the on-board RAM for more receive buffers.
77.El
78.Sh MEDIA SELECTION
79The ability to select media from software is dependent on the particular
80model of WD/SMC card.  The following models support only manual configuration:
81WD8003S, WD8003E, and WD8013EBT.
82.Pp
83Other WD/SMC 80x3 interfaces support two types of media on a single card.
84All support the AUI media type.  The other media is either BNC or UTP
85beind a transciever.  Sofware cannot differentiate between BNC and UTP
86cards.  On some models, the AUI port is always active.
87.Pp
88The SMC Elite Ultra and SMC EtherEZ interfaces support three media
89a single card: AUI, BNC, and UTP.  If the transciever is active, the BNC
90media is selected.  Otherwise, the AUI and UTP ports are both active.
91.Pp
92To enable the AUI media, select the
93.Em 10base5
94or
95.Em aui
96media type with
97.Xr ifconfig 8 's
98.Sq media
99directive.  To select the other media (transciever), select the
100.Em 10base2
101or
102.Em bnc
103media type.
104.Sh DIAGNOSTICS
105.Bl -diag
106.It "we0: overriding IRQ <n> to <m>"
107The IRQ specified in the kernel configuration file is different from that
108found in the card's configuration registers.  The value in the kernel
109configuration file is being overridden by the one configured into the card.
110.It "we0: can't wildcard IRQ on a <model>"
111The IRQ was wildcarded in the kernel configuration file, and the card is
112a WD8003S, WD8003E, or WD8013EBT, which do not support software IRQ
113configuration.
114.It "we0: failed to clear shared memory at offset <off>"
115The memory test was unable to clear shared the interface's shared memory
116region.  This often indicates that the card is configured at a conflicting
117.Em iomem
118address.
119.It we0: warning - receiver ring buffer overrun
120The DP8390 Ethernet chip used by this board implements a shared-memory
121ring-buffer to store incoming packets.
122
123The 16bit boards (8013 series) have 16k of memory as well as
124fast memory access speed.  Typical memory access speed on these
125boards is about 4MB/second.  These boards generally have no
126problems keeping up with full Ethernet speed and the ring-buffer
127seldom overfills.
128
129However, the 8bit boards (8003) usually have only 8k bytes of shared
130memory.  This is only enough room for about 4 full-size (1500 byte)
131packets.  This can sometimes be a problem, especially on the original
132WD8003E, because these boards' shared-memory access speed is quite
133slow; typically only about 1MB/second.  The overhead of this slow
134memory access, and the fact that there is only room for 4 full-sized
135packets means that the ring-buffer will occassionally overrun.  When
136this happens, the board must be reset to avoid a lockup problem in
137early revision 8390's.  Resetting the board causes all of the data in
138the ring-buffer to be lost, requiring it to be retransmitted/received,
139congesting the board further.  Because of this, maximum throughput on
140these boards is only about 400-600k per second.
141.Pp
142This problem is exasperated by NFS because the 8bit boards lack
143sufficient memory to support the default 8k byte packets that NFS and
144other protocols use as their default.  If these cards must be used
145with NFS, use the NFS -r and -w options in /etc/fstab to limit NFS's
146packet size.  4096k byte packets generally work.
147.El
148.Sh SEE ALSO
149.Xr ifmedia 4 ,
150.Xr intro 4 ,
151.Xr isa 4 ,
152.Xr ifconfig 8
153