share/man/man4/gx.4

   1 .\" Copyright (c) 2001
   2 .\"     Jonathan Lemon <jlemon@FreeBSD.org>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the author nor the names of any co-contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/share/man/man4/gx.4,v 1.1.2.2 2001/12/17 11:30:11 ru Exp $
  29 .\" $DragonFly: src/share/man/man4/Attic/gx.4,v 1.3 2004/01/13 01:48:59 drhodus Exp $
  30 .\"
  31 .Dd October 17, 2001
  32 .Dt GX 4
  33 .Os
  34 .Sh NAME
  35 .Nm gx
  36 .Nd "Intel Pro/1000 gigabit ethernet driver"
  37 .Sh SYNOPSIS
  38 .Cd "device miibus"
  39 .Cd "device gx"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver provides support for NICs based on the Intel 82542 and 82543
  44 gigabit ethernet controller chips.
  45 Both fiber and copper variants of
  46 the cards are supported.
  47 .Pp
  48 The 82542 supports TBI (ten bit interface), while the 82543 supports the
  49 GMII transceivers, which means it can be used with either copper or
  50 1000baseX fiber applications.
  51 Both boards support VLAN tagging/insertion and the 82543 additionally
  52 supports TCP/IP checksum offload.
  53 .Pp
  54 The 82543-T cards use the Marvell 10/100/1000 copper gigabit tranceiver
  55 chip, which supports autonegotiation of 10, 100 and 1000mbps modes in
  56 full or half duplex, however half duplex 1000mbps is not suppoorted.
  57 .Pp
  58 The driver also supports jumbo frames, which can be configured
  59 via the interface MTU setting.
  60 Selecting an MTU larger than 1500 bytes with the
  61 .Xr ifconfig 8
  62 utility configures the adapter to receive and transmit jumbo frames.
  63 Using jumbo frames can greatly improve performance for certain tasks,
  64 such as file transfers and data streaming.
  65 .Pp
  66 The
  67 .Nm
  68 driver supports the following media types:
  69 .Bl -tag -width ".Cm 10baseT/UTP"
  70 .It Cm autoselect
  71 Enable autoselection of the media type and options.
  72 User can manually override
  73 the autoselected mode by adding media options to
  74 .Xr rc.conf 5 .
  75 .It Cm 10baseT/UTP
  76 Set 10Mbps operation.
  77 The
  78 .Xr ifconfig 8 Ns 's
  79 .Cm mediaopt
  80 option can also be used to select either
  81 .Cm full-duplex
  82 or
  83 .Cm half-duplex
  84 modes.
  85 .It Cm 100baseTX
  86 Set 100Mbps (fast ethernet) operation.
  87 The
  88 .Xr ifconfig 8 Ns 's
  89 .Cm mediaopt
  90 option can also be used to select either
  91 .Cm full-duplex
  92 or
  93 .Cm half-duplex
  94 modes.
  95 .It Cm 1000baseTX
  96 Set 1000baseTX operation over twisted pair.
  97 Only
  98 .Cm full-duplex
  99 mode is supported.
 100 .El
 101 .Pp
 102 The
 103 .Nm
 104 driver supports the following media options:
 105 .Bl -tag -width ".Cm full-duplex"
 106 .It Cm full-duplex
 107 Force full duplex operation.
 108 .It Cm half-duplex
 109 Force half duplex operation.
 110 .El
 111 .Pp
 112 The
 113 .Nm
 114 driver also supports one special link option for 1000baseTX cards:
 115 .Bl -tag -width ".Cm link0"
 116 .It Cm link0
 117 With 1000baseTX cards, establishing a link between two ports requires
 118 that one port be configured as a master and the other a slave.
 119 With autonegotiation,
 120 the master/slave settings should be chosen automatically.
 121 Setting the
 122 .Cm link0
 123 flag with
 124 .Xr ifconfig 8
 125 will force the link up instead.
 126 .El
 127 .Pp
 128 For more information on configuring this device, see
 129 .Xr ifconfig 8 .
 130 .Sh DIAGNOSTICS
 131 .Bl -diag
 132 .It "gx%d: couldn't map memory"
 133 A fatal initialization error has occurred.
 134 .It "gx%d: couldn't map interrupt"
 135 A fatal initialization error has occurred.
 136 .It "gx%d: couldn't setup irq"
 137 A fatal initialization error has occurred.
 138 .It "gx%d: failed to read station address"
 139 A fatal initialization error has occurred.
 140 .It "gx%d: no memory for list buffers!"
 141 The driver failed to allocate memory for per-device instance information
 142 during initialization.
 143 .It "gx%d: failed to enable memory mapping!"
 144 The driver failed to initialize PCI shared memory mapping.
 145 This might happen if the card is not in a bus-master slot.
 146 .It "gx%d: GMII/MII, PHY not detected"
 147 The MII probe routines failed to detect the PHY.
 148 This might happen if miibus is not configured.
 149 .It "gx%d: watchdog timeout"
 150 The device has stopped responding to the network, or there is a problem with
 151 the network connection (cable).
 152 .It "gx%d: mbuf allocation failed -- packet dropped"
 153 The driver could not allocate a mbuf for the receive ring.
 154 .It "gx%d: cluster allocation failed -- packet dropped"
 155 The driver could not allocate a mbuf cluster for the receive ring.
 156 .It "gx%d: link down"
 157 The link status changed from up to down.
 158 .It "gx%d: link up"
 159 The link status changed from down to up.
 160 .El
 161 .Sh SEE ALSO
 162 .Xr arp 4 ,
 163 .Xr miibus 4 ,
 164 .Xr netintro 4 ,
 165 .Xr ng_ether 4 ,
 166 .Xr vlan 4 ,
 167 .Xr ifconfig 8
 168 .Sh HISTORY
 169 The
 170 .Nm
 171 device driver first appeared in
 172 .Fx 4.5 .
 173 .Sh AUTHORS
 174 The
 175 .Nm
 176 driver was written by
 177 .An Jonathan Lemon Aq jlemon@FreeBSD.org .