Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / iee.4
blobdf3a5c55a60402853d4f17a03890120ce03998da
1 .\"     $NetBSD: iee.4,v 1.4 2009/05/05 16:25:36 tsutsui Exp $
2 .\" Copyright (c) 2002 Jochen Kunz.
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 .\" 3. The name of Jochen Kunz may not be used to endorse or promote
14 .\"    products derived from this software without specific prior
15 .\"    written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY JOCHEN KUNZ
18 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL JOCHEN KUNZ
21 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 .\" POSSIBILITY OF SUCH DAMAGE.
28 .Dd May 5, 2009
29 .Dt IEE 4
30 .Os
31 .Sh NAME
32 .Nm iee
33 .Nd
34 .Tn Intel
35 .Tn i82596
36 10MBit/s
37 .Tn Ethernet
38 interface
39 .Sh SYNOPSIS
40 .Ss ews4800mips
41 .Cd iee* at sbdio?
42 .Ss hp700
43 .Cd iee* at gsc?
44 .Sh DESCRIPTION
45 The
46 .Nm
47 device provides access to the
48 .Tn Intel
49 .Tn i82596
50 10MBit/s
51 .Tn Ethernet
52 interface.
53 .Nm
54 supports IEEE 802.1Q Virtual LANs.
55 .Nm
56 operates the
57 .Tn i82596
58 in 32-Bit Linear Mode, opposed to
59 .Xr ie 4
60 that drives the
61 .Tn i82596
62 only in
63 .Tn i82586
64 compatibility mode.
65 .Sh HARDWARE
66 .Ss ews4800mips
67 The
68 .Nm
69 interface supports
70 .Tn Intel
71 .Tn i82596CA
72 based on-board Ethernet on EWS4800/350.
73 .Ss hp700
74 The
75 .Nm
76 interface supports
77 .Tn Intel
78 .Tn i82596DX
79 on ASP/ASP2 based machines and the
80 .Tn i82596CA
81 macrocell in LASI based machines.
82 GSC expansion cards may work, but are not tested.
83 Media selection on hp700 is done either manually via hardware
84 jumper or automatically depending on machine model.
85 .Sh DIAGNOSTICS
86 .Bl -diag
87 .It "iee%d: iee_intr: receive error %d, rfd_status=0x%.4x, rfd_count=0x%.4x."
88 An error during frame reception occurred.
89 The frame was dropped.
90 .It "iee%d: iee_intr: can't allocate mbuf."
91 .It "iee%d: iee_intr: can't alloc mbuf cluster."
92 A frame was received, but dropped due to lack of memory.
93 .It "iee%d: iee_intr: receive ring buffer overrun"
94 Many frames where received under high load and the receive ring buffer
95 was to small to store them all.
96 Frame reception was restarted from scratch.
97 Most likely there where frames lost.
98 .It "iee%d: iee_intr: scb_status=0x%x scb_cmd=0x%x faild command %d: cb_status[%d]=0x%.4x cb_cmd[%d]=0x%.4x"
99 A transmit or setup command was not executed successfully.
100 .It "iee%d: iee_intr: crc_err=%d"
101 Number of frames with a CRC error received.
102 .It "iee%d: iee_intr: align_err=%d"
103 Number of unaligned frames received.
104 .It "iee%d: iee_intr: resource_err=%d"
105 Number of good frames dropped because the receive ring buffer was full.
106 .It "iee%d: iee_intr: overrun_err=%d"
107 Number of frames lost because the system bus was not available for DMA.
108 .It "iee%d: iee_intr: rcvcdt_err=%d"
109 Number of collisions detected during frame reception.
110 .It "iee%d: iee_intr: short_fr_err=%d"
111 Number of frames received that where shorter then the minimum frame length.
112 .It "iee%d: iee_start: failed to load DMA map"
114 .Xr mbuf 9
115 chain with too many elements could not be setup for transmission.
117 .Xr mbuf 9
118 chain will be merged into a single
119 .Xr mbuf 9
120 cluster and retransmitted.
121 .It "iee%d: iee_start: can't allocate mbuf."
122 .It "iee%d: iee_start: can't load TX DMA map."
123 Said error occurred during merging the
124 .Xr mbuf 9
125 chain into a
126 .Xr mbuf 9
127 cluster.
128 The frame was dropped.
129 .It "iee%d: iee_init: can't create TX DMA map"
130 .It "iee%d: iee_init: can't allocate mbuf"
131 .It "iee%d: iee_init: can't allocate mbuf cluster"
132 .It "iee%d: iee_init: can't create RX DMA map"
133 .It "iee%d: iee_init: can't load RX DMA map"
134 There was no memory free to allocate resources when the operator
135 tried to bring the interface up.
136 The interface will not come up.
137 Try again later.
138 .It "iee%d: iee_watchdog: transmit timeout %d"
139 .It "iee%d: iee_watchdog: setup timeout %d"
140 The hardware didn't respond to a transmit or setup command within five seconds.
141 The interface will be reset and restarted.
142 .It "iee%d: iee_gsc_cmd: timeout n=%d"
143 Timeout at sending a channel attention command to the chip.
144 .It "iee%d: iee_gsc_reset timeout bussy=0x%x"
145 Timeout at resetting the chip.
146 Possible errors during
147 .Xr autoconf 4 .
148 .It "iee%d: iee_gsc_attach: can't map I/O space"
149 The driver failed to map the I/O ports of the chip.
150 The device will not be attached.
151 .It "iee%d: iee_gsc_attach: can't allocate %d bytes of DMA memory"
152 .It "iee%d: iee_gsc_attach: can't map DMA memory"
153 .It "iee%d: iee_gsc_attach: can't create DMA map"
154 .It "iee%d: iee_gsc_attach: can't load DMA map"
155 The driver failed to get the shared DMA memory for the chip.
156 The device will not be attached.
158 .Sh SEE ALSO
159 .Xr arp 4 ,
160 .Xr ifmedia 4 ,
161 .Xr inet 4 ,
162 .Xr intro 4 ,
163 .Xr vlan 4 ,
164 .Xr ifconfig 8
165 .Sh HISTORY
168 driver appeared in
169 .Nx 2.0 .
170 .Sh AUTHORS
171 .An Jochen Kunz
172 .Sh BUGS
173 None. ;-)