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 .\"
  30 .Dd October 17, 2001
  31 .Dt GX 4
  32 .Os
  33 .Sh NAME
  34 .Nm gx
  35 .Nd "Intel Pro/1000 gigabit ethernet driver"
  36 .Sh SYNOPSIS
  37 .Cd "device miibus"
  38 .Cd "device gx"
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 driver provides support for NICs based on the Intel 82542 and 82543
  43 gigabit ethernet controller chips.
  44 Both fiber and copper variants of
  45 the cards are supported.
  46 .Pp
  47 The 82542 supports TBI (ten bit interface), while the 82543 supports the
  48 GMII transceivers, which means it can be used with either copper or
  49 1000baseX fiber applications.
  50 Both boards support VLAN tagging/insertion and the 82543 additionally
  51 supports TCP/IP checksum offload.
  52 .Pp
  53 The 82543-T cards use the Marvell 10/100/1000 copper gigabit tranceiver
  54 chip, which supports autonegotiation of 10, 100 and 1000mbps modes in
  55 full or half duplex, however half duplex 1000mbps is not suppoorted.
  56 .Pp
  57 The driver also supports jumbo frames, which can be configured
  58 via the interface MTU setting.
  59 Selecting an MTU larger than 1500 bytes with the
  60 .Xr ifconfig 8
  61 utility configures the adapter to receive and transmit jumbo frames.
  62 Using jumbo frames can greatly improve performance for certain tasks,
  63 such as file transfers and data streaming.
  64 .Pp
  65 The
  66 .Nm
  67 driver supports the following media types:
  68 .Bl -tag -width ".Cm 10baseT/UTP"
  69 .It Cm autoselect
  70 Enable autoselection of the media type and options.
  71 User can manually override
  72 the autoselected mode by adding media options to
  73 .Xr rc.conf 5 .
  74 .It Cm 10baseT/UTP
  75 Set 10Mbps operation.
  76 The
  77 .Xr ifconfig 8 Ns 's
  78 .Cm mediaopt
  79 option can also be used to select either
  80 .Cm full-duplex
  81 or
  82 .Cm half-duplex
  83 modes.
  84 .It Cm 100baseTX
  85 Set 100Mbps (fast ethernet) operation.
  86 The
  87 .Xr ifconfig 8 Ns 's
  88 .Cm mediaopt
  89 option can also be used to select either
  90 .Cm full-duplex
  91 or
  92 .Cm half-duplex
  93 modes.
  94 .It Cm 1000baseTX
  95 Set 1000baseTX operation over twisted pair.
  96 Only
  97 .Cm full-duplex
  98 mode is supported.
  99 .El
 100 .Pp
 101 The
 102 .Nm
 103 driver supports the following media options:
 104 .Bl -tag -width ".Cm full-duplex"
 105 .It Cm full-duplex
 106 Force full duplex operation.
 107 .It Cm half-duplex
 108 Force half duplex operation.
 109 .El
 110 .Pp
 111 The
 112 .Nm
 113 driver also supports one special link option for 1000baseTX cards:
 114 .Bl -tag -width ".Cm link0"
 115 .It Cm link0
 116 With 1000baseTX cards, establishing a link between two ports requires
 117 that one port be configured as a master and the other a slave.
 118 With autonegotiation,
 119 the master/slave settings should be chosen automatically.
 120 Setting the
 121 .Cm link0
 122 flag with
 123 .Xr ifconfig 8
 124 will force the link up instead.
 125 .El
 126 .Pp
 127 For more information on configuring this device, see
 128 .Xr ifconfig 8 .
 129 .Sh DIAGNOSTICS
 130 .Bl -diag
 131 .It "gx%d: couldn't map memory"
 132 A fatal initialization error has occurred.
 133 .It "gx%d: couldn't map interrupt"
 134 A fatal initialization error has occurred.
 135 .It "gx%d: couldn't setup irq"
 136 A fatal initialization error has occurred.
 137 .It "gx%d: failed to read station address"
 138 A fatal initialization error has occurred.
 139 .It "gx%d: no memory for list buffers!"
 140 The driver failed to allocate memory for per-device instance information
 141 during initialization.
 142 .It "gx%d: failed to enable memory mapping!"
 143 The driver failed to initialize PCI shared memory mapping.
 144 This might happen if the card is not in a bus-master slot.
 145 .It "gx%d: GMII/MII, PHY not detected"
 146 The MII probe routines failed to detect the PHY.
 147 This might happen if miibus is not configured.
 148 .It "gx%d: watchdog timeout"
 149 The device has stopped responding to the network, or there is a problem with
 150 the network connection (cable).
 151 .It "gx%d: mbuf allocation failed -- packet dropped"
 152 The driver could not allocate a mbuf for the receive ring.
 153 .It "gx%d: cluster allocation failed -- packet dropped"
 154 The driver could not allocate a mbuf cluster for the receive ring.
 155 .It "gx%d: link down"
 156 The link status changed from up to down.
 157 .It "gx%d: link up"
 158 The link status changed from down to up.
 159 .El
 160 .Sh SEE ALSO
 161 .Xr arp 4 ,
 162 .Xr netintro 4 ,
 163 .Xr ng_ether 4 ,
 164 .Xr vlan 4 ,
 165 .Xr ifconfig 8
 166 .Sh HISTORY
 167 The
 168 .Nm
 169 device driver first appeared in
 170 .Fx 4.5 .
 171 .Sh AUTHORS
 172 The
 173 .Nm
 174 driver was written by
 175 .An Jonathan Lemon Aq jlemon@FreeBSD.org .