share/man/man4/bge.4

   1 .\"     $NetBSD: bge.4,v 1.11 2009/09/26 04:51:21 elad Exp $
   2 .\"
   3 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Matthias Scheler <tron@NetBSD.org>.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd September 26, 2009
  31 .Dt BGE 4
  32 .Os
  33 .Sh NAME
  34 .Nm bge
  35 .Nd Broadcom BCM570x family Gigabit Ethernet driver
  36 .Sh SYNOPSIS
  37 .Cd "bge* at pci? dev ? function ?"
  38 .Pp
  39 Configuration of PHYs may also be necessary.
  40 See
  41 .Xr mii 4 .
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 device driver supports Gigabit Ethernet interfaces based on the Broadcom
  46 BCM570x family of Gigabit Ethernet chips and the BCM5906 chip.
  47 The interfaces supported by the
  48 .Nm
  49 driver include:
  50 .Bl -bullet
  51 .It
  52 3Com 3c996-T (10BASE-T/100BASE-TX/1000BASE-T)
  53 .It
  54 Dell PowerEdge 2550 integrated BCM5700 NIC (10BASE-T/100BASE-TX/1000BASE-T)
  55 .It
  56 IBM x235 server integrated BCM5703x NIC (10BASE-T/100BASE-TX/1000BASE-T)
  57 .It
  58 Netgear GA302T (10BASE-T/100BASE-TX/1000BASE-T)
  59 .It
  60 SysKonnect SK-9D21 (10BASE-T/100BASE-TX/1000BASE-T)
  61 .It
  62 SysKonnect SK-9D41 (1000BASE-SX)
  63 .El
  64 .Pp
  65 The BCM570x family supports IPv4/TCP/UDP checksumming in hardware.
  66 The
  67 .Nm
  68 driver supports this feature of the chip.
  69 See
  70 .Xr ifconfig 8
  71 for information on how to enable this feature.
  72 .Pp
  73 The level of interrupt mitigation for received packets can be adjusted
  74 with the
  75 .Li hw.bge.rx_lvl
  76 .Xr sysctl 8
  77 control.
  78 A value of 1 yields a
  79 .Nm
  80 interrrupt for every two full-sized Ethernet frames.
  81 Each increment of the value will, roughly, halve receive interrupt rate,
  82 up to a maximum of 5, which interrupts about every 30 to 40 full-sized
  83 TCP segments.
  84 .Sh SEE ALSO
  85 .Xr arp 4 ,
  86 .Xr bce 4 ,
  87 .Xr ifmedia 4 ,
  88 .Xr mii 4 ,
  89 .Xr netintro 4 ,
  90 .Xr pci 4 ,
  91 .Xr ifconfig 8
  92 .Sh HISTORY
  93 The
  94 .Nm
  95 driver first appeared in
  96 .Nx 1.6.1 .
  97 .Sh AUTHORS
  98 .An -nosplit
  99 The
 100 .Nm
 101 driver was written by
 102 .An Bill Paul
 103 .Aq wpaul@windriver.com
 104 for
 105 .Fx
 106 and ported to
 107 .Nx
 108 by
 109 .An Frank van der Linden
 110 .Aq fvdl@wasabisystems.com ,
 111 .An Jason R. Thorpe
 112 .Aq thorpej@wasabisystems.com
 113 and
 114 .An Jonathan Stone
 115 .Aq jonathan@dsg.stanford.edu .