bce (Broadcom 4401 10/100 ethernet driver) from NetBSD

Most work by nate@, ok deraadt@

1 files changed, 153 insertions, 0 deletions

diff --git a/share/man/man4/bce.4 b/share/man/man4/bce.4
new file mode 100644
index 00000000000..17ae8eb6131
--- /dev/null
+++ b/share/man/man4/bce.4
@@ -0,0 +1,153 @@
+.\" $OpenBSD: bce.4,v 1.1 2004/02/13 23:24:29 andreas Exp $
+.\" $NetBSD: bce.4,v 1.2 2003/10/05 11:58:36 wiz Exp $
+.\"
+.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Thomas Klausner.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd September 28, 2003
+.Dt BCE 4
+.Os
+.Sh NAME
+.Nm bce
+.Nd Broadcom BCM4401 Ethernet device driver
+.Sh SYNOPSIS
+.Cd "bce* at pci? dev ? function ?"
+.Sh DESCRIPTION
+The
+.Nm
+provides support for the Broadcom BCM4401 10/100 Ethernet card.
+Other cards from the 440x series may also be supported.
+.Pp
+The following media types and options (as given to
+.Xr ifconfig 8 )
+are supported:
+.Bl -tag -width xxx -offset indent
+.It Cm media No autoselect
+Enable autoselection of the media type and options (default).
+.It Cm media No 100baseTX Cm mediaopt No full-duplex
+Set 100Mbps (Fast Ethernet) operation and force full-duplex mode.
+.It Cm media No 100baseTX Cm mediaopt No half-duplex
+Set 100Mbps (Fast Ethernet) operation and force half-duplex mode.
+.It Cm media No 10baseT Cm mediaopt No full-duplex
+Set 10Mbps operation and force full-duplex.
+.It Cm media No 10baseT Cm mediaopt No half-duplex
+Set 10Mbps operation and force half-duplex.
+.El
+.Pp
+If no media options are present, the
+.Nm
+driver places the card into autoselect mode.
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "bce%d: failed to enable memory mapping!"
+A fatal initialization error has occurred.
+.It "bce%d: unable to find mem space"
+A fatal initialization error has occurred.
+.It "bce%d: unable to wake up from power state D%d"
+The card has lost its configuration data during power save mode.
+.It "bce%d: couldn't map interrupt"
+A fatal initialization error has occurred.
+.It "bce%d: couldn't establish interrupt"
+A fatal initialization error has occurred.
+.It "bce%d: unable to alloc space for ring descriptors, error = %d"
+A fatal initialization error has occurred.
+.It "bce%d: unable to map DMA buffers, error = %d"
+A fatal initialization error has occurred.
+.It "bce%d: unable to create ring DMA map, error = %d"
+A fatal initialization error has occurred.
+.It "bce%d: unable to create tx DMA map, error = %d"
+A fatal initialization error has occurred.
+.It "bce%d: unable to create rx DMA map, error = %d"
+A fatal initialization error has occurred.
+.It "bce%d: Tx packet consumes too many DMA segments, dropping..."
+An outgoing packet didn't fit in the allocated number of segments.
+.It "bce%d: unable to load Tx buffer, error = %d"
+Short on resources when transmitting a packet, it will be retried later.
+.It "bce%d: device timeout"
+The device has stopped responding to the network or there is a problem
+with the network connection (cable).
+.It "bce%d: transmit fifo underflow"
+An error occurred, the interface will be reinitialized.
+.It "bce%d: receive fifo overflow"
+An error occurred, the interface will be reinitialized.
+.It "bce%d: receive descriptor underflow"
+An error occurred, the interface will be reinitialized.
+.It "bce%d: descriptor protocol error"
+An error occurred, the interface will be reinitialized.
+.It "bce%d: data error"
+An error occurred, the interface will be reinitialized.
+.It "bce%d: descriptor error"
+An error occurred, the interface will be reinitialized.
+.It "bce%d: general purpose timeout"
+An error occurred, the interface will be reinitialized.
+.It "bce%d: unable to allocate or map rx(%d) mbuf, error = %d"
+Failed to initialize the interface.
+.It "bce%d: timed out writing pkt filter ctl"
+Failed to add MAC address.
+.It "bce%d: timed out disabling ethernet mac"
+A problem occurred when resetting the interface.
+.It "bce%d: receive dma did not go idle after error"
+A problem occurred when resetting the interface.
+.It "bce%d: timed out resetting ethernet mac"
+A problem occurred when resetting the interface.
+.It "bce%d: while resetting core, reject did not set"
+A problem occurred when resetting the interface.
+.It "bce%d: while resetting core, busy did not clear"
+A problem occurred when resetting the interface.
+.It "bce%d: PHY read timed out reading phy %d, reg %d, val = %x"
+An error occurred when reading a PHY register on the MII.
+.It "bce%d: PHY read timed out writing phy %d, reg %d, val = %x"
+An error occurred when writing a PHY register on the MII.
+.El
+.Sh SEE ALSO
+.Xr bge 4 ,
+.Xr mii 4 ,
+.Xr ukphy 4
+.Sh HISTORY
+The
+.Nm
+driver appeared in
+.Nx 1.6.2 .
+.Ox
+support was added in
+.Ox 3.5
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Cliff Wright Aq cliff@snipe444.org
+and ported to
+.Ox
+by
+.An Nathan L. Binkert Aq binkertn@umich.edu .