Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / bnx.4
blob19dc037140782f055e8c345394923af6798842b4
1 .\"     $NetBSD: bnx.4,v 1.1 2006/12/17 23:02:06 bouyer Exp $
2 .\"     $OpenBSD: bnx.4,v 1.13 2006/12/15 16:12:52 reyk Exp $
3 .\"
4 .\" Copyright (c) 2006 Broadcom Corporation
5 .\"  David Christensen <davidch@broadcom.com>.  All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\"
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. Neither the name of Broadcom Corporation nor the name of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written consent.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
21 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
24 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 .\"
30 .\"  $FreeBSD: /repoman/r/ncvs/src/share/man/man4/bce.4,v 1.2 2006/04/10 20:12:17 brueffer Exp $
31 .\"
32 .Dd December 17, 2006
33 .Dt BNX 4
34 .Os
35 .Sh NAME
36 .Nm bnx
37 .Nd Broadcom NetXtreme II 10/100/1000 Ethernet device
38 .Sh SYNOPSIS
39 .Cd "bnx* at pci?"
40 .Cd "brgphy* at mii?"
41 .Sh DESCRIPTION
42 The
43 .Nm
44 driver supports Broadcom's NetXtreme II product family, such as the
45 BCM5706 PCI-X and BCM5708 PCI Express Ethernet controllers, which
46 includes the following:
47 .Pp
48 .Bl -bullet -compact
49 .It
50 Dell PowerEdge 1950 integrated BCM5708 NIC (10/100/1000baseT)
51 .It
52 Dell PowerEdge 2950 integrated BCM5708 NIC (10/100/1000baseT)
53 .It
54 HP NC370F PCI-X Multifunction Gigabit server adapter (1000baseSX)
55 .It
56 HP NC370T PCI-X Multifunction Gigabit server adapter (10/100/1000baseT)
57 .It
58 HP NC373F PCI Express Multifunction Gigabit server adapter (1000baseSX)
59 .It
60 HP NC373i PCI Express Multifunction Gigabit embedded server adapter (10/100/1000baseT)
61 .It
62 HP NC380T PCI Express Dual Port Multifunction Gigabit server adapter (10/100/1000baseT)
63 .It
64 IBM xSeries 3550 integrated BCM5708 NIC (10/100/1000baseT)
65 .It
66 IBM xSeries 3650 integrated BCM5708 NIC (10/100/1000baseT)
67 .El
68 .Pp
69 The NetXtreme II product family is composed of various Converged NIC (or CNIC)
70 Ethernet controllers which support a TCP Offload Engine (TOE),
71 Remote DMA (RDMA), and iSCSI acceleration,
72 in addition to standard L2 Ethernet traffic,
73 all on the same controller.
74 The following features are supported in the
75 .Nm
76 driver under
77 .Nx :
78 .Bd -literal -offset indent
79 IPv4 receive IP/TCP/UDP checksum offload
80 Jumbo frames (up to 9022 bytes)
81 VLAN tag insertion
82 Interrupt coalescing
83 10/100/1000Mbps operation in full-duplex mode
84 10/100Mbps operation in half-duplex mode
85 .Ed
86 .Pp
87 The
88 .Nm
89 driver supports the following media types:
90 .Bl -tag -width ".Cm 10baseT/UTP"
91 .It Cm autoselect
92 Enable autoselection of the media type and options.
93 The user can manually override
94 the autoselected mode via
95 .Xr ifconfig 8 .
96 .It Cm 10baseT/UTP
97 Set 10Mbps operation.
98 The
99 .Xr ifconfig 8
100 .Ic mediaopt
101 option can also be used to select either
102 .Cm full-duplex
104 .Cm half-duplex
105 modes.
106 .It Cm 100baseTX
107 Set 100Mbps (Fast Ethernet) operation.
109 .Xr ifconfig 8
110 .Ic mediaopt
111 option can also be used to select either
112 .Cm full-duplex
114 .Cm half-duplex
115 modes.
116 .It Cm 1000baseTX
117 Set 1000baseTX operation over twisted pair.
118 Only
119 .Cm full-duplex
120 mode is supported.
125 driver supports the following media options:
126 .Bl -tag -width ".Cm full-duplex"
127 .It Cm full-duplex
128 Force full duplex operation.
129 .It Cm half-duplex
130 Force half duplex operation.
133 For more information on configuring this device, see
134 .Xr ifconfig 8 .
135 .Sh SEE ALSO
136 .Xr arp 4 ,
137 .Xr brgphy 4 ,
138 .Xr ifmedia 4 ,
139 .Xr intro 4 ,
140 .Xr mii 4 ,
141 .Xr netintro 4 ,
142 .Xr pci 4 ,
143 .Xr ifconfig 8
144 .Sh HISTORY
147 device driver first appeared in
148 .Nx 4.0 .