xref: /openbsd/share/man/man4/bce.4 (revision 404b540a)
1.\" $OpenBSD: bce.4,v 1.13 2009/02/17 21:26:08 kettenis Exp $
2.\" $NetBSD: bce.4,v 1.2 2003/10/05 11:58:36 wiz Exp $
3.\"
4.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
5.\" All rights reserved.
6.\"
7.\" This code is derived from software contributed to The NetBSD Foundation
8.\" by Thomas Klausner.
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 $Mdocdate: February 17 2009 $
32.Dt BCE 4
33.Os
34.Sh NAME
35.Nm bce
36.Nd Broadcom BCM4401 10/100 Ethernet device
37.Sh SYNOPSIS
38.Cd "bce* at pci?"
39.Cd "bmtphy* at mii?"
40.Sh DESCRIPTION
41The
42.Nm
43provides support for the Broadcom BCM4401 10/100 Ethernet card.
44.Pp
45The following media types and options (as given to
46.Xr ifconfig 8 )
47are supported:
48.Bl -tag -width xxx -offset indent
49.It Cm media No autoselect
50Enable autoselection of the media type and options (default).
51.It Cm media No 100baseTX Cm mediaopt No full-duplex
52Set 100Mbps (Fast Ethernet) operation and force full-duplex mode.
53.It Cm media No 100baseTX Cm mediaopt No half-duplex
54Set 100Mbps (Fast Ethernet) operation and force half-duplex mode.
55.It Cm media No 10baseT Cm mediaopt No full-duplex
56Set 10Mbps operation and force full-duplex.
57.It Cm media No 10baseT Cm mediaopt No half-duplex
58Set 10Mbps operation and force half-duplex.
59.El
60.Pp
61If no media options are present, the
62.Nm
63driver places the card into autoselect mode.
64.Sh DIAGNOSTICS
65.Bl -diag
66.It "bce%d: failed to enable memory mapping!"
67A fatal initialization error has occurred.
68.It "bce%d: unable to find mem space"
69A fatal initialization error has occurred.
70.It "bce%d: unable to wake up from power state D%d"
71The card has lost its configuration data during power save mode.
72.It "bce%d: couldn't map interrupt"
73A fatal initialization error has occurred.
74.It "bce%d: couldn't establish interrupt"
75A fatal initialization error has occurred.
76.It "bce%d: unable to alloc space for ring descriptors, error = %d"
77A fatal initialization error has occurred.
78.It "bce%d: unable to map DMA buffers, error = %d"
79A fatal initialization error has occurred.
80.It "bce%d: unable to create ring DMA map, error = %d"
81A fatal initialization error has occurred.
82.It "bce%d: unable to create tx DMA map, error = %d"
83A fatal initialization error has occurred.
84.It "bce%d: unable to create rx DMA map, error = %d"
85A fatal initialization error has occurred.
86.It "bce%d: Tx packet consumes too many DMA segments, dropping..."
87An outgoing packet didn't fit in the allocated number of segments.
88.It "bce%d: unable to load Tx buffer, error = %d"
89Short on resources when transmitting a packet, it will be retried later.
90.It "bce%d: device timeout"
91The device has stopped responding to the network or there is a problem
92with the network connection (cable).
93.It "bce%d: transmit fifo underflow"
94An error occurred, the interface will be reinitialized.
95.It "bce%d: receive fifo overflow"
96An error occurred, the interface will be reinitialized.
97.It "bce%d: receive descriptor underflow"
98An error occurred, the interface will be reinitialized.
99.It "bce%d: descriptor protocol error"
100An error occurred, the interface will be reinitialized.
101.It "bce%d: data error"
102An error occurred, the interface will be reinitialized.
103.It "bce%d: descriptor error"
104An error occurred, the interface will be reinitialized.
105.It "bce%d: general purpose timeout"
106An error occurred, the interface will be reinitialized.
107.It "bce%d: unable to allocate or map rx(%d) mbuf, error = %d"
108Failed to initialize the interface.
109.It "bce%d: timed out writing pkt filter ctl"
110Failed to add MAC address.
111.It "bce%d: timed out disabling ethernet mac"
112A problem occurred when resetting the interface.
113.It "bce%d: receive dma did not go idle after error"
114A problem occurred when resetting the interface.
115.It "bce%d: timed out resetting ethernet mac"
116A problem occurred when resetting the interface.
117.It "bce%d: while resetting core, reject did not set"
118A problem occurred when resetting the interface.
119.It "bce%d: while resetting core, busy did not clear"
120A problem occurred when resetting the interface.
121.It "bce%d: PHY read timed out reading phy %d, reg %d, val = %x"
122An error occurred when reading a PHY register on the MII.
123.It "bce%d: PHY read timed out writing phy %d, reg %d, val = %x"
124An error occurred when writing a PHY register on the MII.
125.El
126.Sh SEE ALSO
127.Xr arp 4 ,
128.Xr bmtphy 4 ,
129.Xr ifmedia 4 ,
130.Xr intro 4 ,
131.Xr mii 4 ,
132.Xr netintro 4 ,
133.Xr pci 4 ,
134.Xr hostname.if 5 ,
135.Xr ifconfig 8
136.Sh HISTORY
137The
138.Nm
139driver appeared in
140.Nx 1.6.2 .
141.Ox
142support was added in
143.Ox 3.5 .
144.Sh AUTHORS
145.An -nosplit
146The
147.Nm
148driver was written by
149.An Cliff Wright Aq cliff@snipe444.org
150and ported to
151.Ox
152by
153.An Nathan L. Binkert Aq binkertn@umich.edu .
154.Sh BUGS
155The BCM4401 hardware can not do DMA to addresses above 1GB.
156Since the
157.Nm
158driver makes no effort to circumvent this problem, it is likely that
159the device will not work properly on machines with more than 1GB of
160system memory.
161