xref: /netbsd-src/share/man/man4/we.4 (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1.\"	$NetBSD: we.4,v 1.11 2001/06/10 15:43:56 wiz 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.Cd "we* at mca? slot ?"
49.Sh DESCRIPTION
50The
51.Nm
52device driver supports Western Digital/SMC WD80x3, SMC Elite Ultra, and
53SMC EtherEZ Ethernet cards.
54.Sh FLAG VALUES
55For some clone boards the driver is not able to recognize 16bit or 8bit
56interfaces correctly. Since this makes a huge difference (see diagnostic
57section below)
58you can override this by specifying flags value in the config file:
59.Pp
60.Cd "we2 at isa? port 0x300 iomem 0xe0000 irq 15 flags 4"
61.Pp
62The values to add together for flags are:
63.Pp
64.Bl -diag
65.It 2
66force adapter to be treated as 8bit, even if it probes
67as a 16bit interface. Improper use of this flag will make the
68driver fail or send invalid Ethernet packets.
69.It 4
70force adapter to be treated as 16bit, even if it probes
71as a 8bit interface. For example the COMPEX ENT/U boards
72identify as WD8003 compatibles, but are in fact 16bit cards.
73Using this flag on a board that really is a 8bit board will
74result in bogus packets being sent.
75.It 8
76disable the use of double transmit buffers to save space in
77the on-board RAM for more receive buffers.
78.El
79.Pp
80Note that all supported MCA cards are 16bit.
81.Sh MEDIA SELECTION
82The ability to select media from software is dependent on the particular
83model of WD/SMC card.  The following models support only manual configuration:
84WD8003S, WD8003E, and WD8013EBT.
85.Pp
86Other WD/SMC 80x3 interfaces support two types of media on a single card.
87All support the AUI media type.  The other media is either BNC or UTP
88behind a transceiver.  Software cannot differentiate between BNC and UTP
89cards.  On some models, the AUI port is always active.
90.Pp
91The SMC Elite Ultra and SMC EtherEZ interfaces support three media
92a single card: AUI, BNC, and UTP.  If the transceiver is active, the BNC
93media is selected.  Otherwise, the AUI and UTP ports are both active.
94.Pp
95To enable the AUI media, select the
96.Em 10base5
97or
98.Em aui
99media type with
100.Xr ifconfig 8 's
101.Sq media
102directive.  To select the other media (transceiver), select the
103.Em 10base2
104or
105.Em bnc
106media type.
107.Sh DIAGNOSTICS
108.Bl -diag
109.It "we0: overriding IRQ <n> to <m>"
110The IRQ specified in the kernel configuration file is different from that
111found in the card's configuration registers.  The value in the kernel
112configuration file is being overridden by the one configured into the card.
113.It "we0: can't wildcard IRQ on a <model>"
114The IRQ was wildcarded in the kernel configuration file, and the card is
115a WD8003S, WD8003E, or WD8013EBT, which do not support software IRQ
116configuration.
117.It "we0: failed to clear shared memory at offset <off>"
118The memory test was unable to clear the interface's shared memory
119region.  This often indicates that the card is configured at a conflicting
120.Em iomem
121address.
122.It we0: warning - receiver ring buffer overrun
123The DP8390 Ethernet chip used by this board implements a shared-memory
124ring-buffer to store incoming packets.
125
126The 16bit boards (8013 series) have 16k of memory as well as
127fast memory access speed.  Typical memory access speed on these
128boards is about 4MB/second.  These boards generally have no
129problems keeping up with full Ethernet speed and the ring-buffer
130seldom overfills.
131
132However, the 8bit boards (8003) usually have only 8k bytes of shared
133memory.  This is only enough room for about 4 full-size (1500 byte)
134packets.  This can sometimes be a problem, especially on the original
135WD8003E, because these boards' shared-memory access speed is quite
136slow; typically only about 1MB/second.  The overhead of this slow
137memory access, and the fact that there is only room for 4 full-sized
138packets means that the ring-buffer will occasionally overrun.  When
139this happens, the board must be reset to avoid a lockup problem in
140early revision 8390's.  Resetting the board causes all of the data in
141the ring-buffer to be lost, requiring it to be retransmitted/received,
142congesting the board further.  Because of this, maximum throughput on
143these boards is only about 400-600k per second.
144.Pp
145This problem is exasperated by NFS because the 8bit boards lack
146sufficient memory to support the default 8k byte packets that NFS and
147other protocols use as their default.  If these cards must be used
148with NFS, use the NFS -r and -w options in /etc/fstab to limit NFS's
149packet size.  4096 byte packets generally work.
150.El
151.Sh SEE ALSO
152.Xr ifmedia 4 ,
153.Xr intro 4 ,
154.Xr isa 4 ,
155.Xr mca 4 ,
156.Xr ifconfig 8
157