share/man/man4/axge.4

   1 .\" Copyright (c) 1997, 1998, 1999, 2000-2003
   2 .\"     Bill Paul <wpaul@windriver.com>. 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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd November 24, 2015
  34 .Dt AXGE 4
  35 .Os
  36 .Sh NAME
  37 .Nm axge
  38 .Nd "ASIX Electronics AX88178A/AX88179 USB Gigabit Ethernet driver"
  39 .Sh SYNOPSIS
  40 To compile this driver into the kernel,
  41 place the following lines in your
  42 kernel configuration file:
  43 .Bd -ragged -offset indent
  44 .Cd "device xhci"
  45 .Cd "device ehci"
  46 .Cd "device uhci"
  47 .Cd "device ohci"
  48 .Cd "device usb"
  49 .Cd "device miibus"
  50 .Cd "device uether"
  51 .Cd "device axge"
  52 .Ed
  53 .Pp
  54 Alternatively, to load the driver as a
  55 module at boot time, place the following line in
  56 .Xr loader.conf 5 :
  57 .Bd -literal -offset indent
  58 if_axge_load="YES"
  59 .Ed
  60 .Sh DESCRIPTION
  61 The
  62 .Nm
  63 driver provides support for USB Gigabit Ethernet adapters based on the ASIX
  64 Electronics AX88179 USB 3.0 and AX88178A USB 2.0 chipsets.
  65 .Pp
  66 The AX88179 and AX88178A contain a 10/100/1000 Ethernet MAC with a GMII
  67 interface for interfacing with the Gigabit Ethernet PHY.
  68 .Pp
  69 These devices will operate with both USB 1.x and USB 2.0 controllers, and the
  70 AX88179 will operate with USB 3.0 controllers.
  71 Packets are received and transmitted over separate USB bulk transfer endpoints.
  72 .Pp
  73 The
  74 .Nm
  75 driver supports the following media types:
  76 .Bl -tag -width ".Cm 10baseT/UTP"
  77 .It Cm autoselect
  78 Enable autoselection of the media type and options.
  79 The user can manually override
  80 the autoselected mode by adding media options to
  81 .Xr rc.conf 5 .
  82 .It Cm 10baseT/UTP
  83 Set 10Mbps operation.
  84 The
  85 .Xr ifconfig 8
  86 .Cm mediaopt
  87 option can also be used to select either
  88 .Cm full-duplex
  89 or
  90 .Cm half-duplex
  91 modes.
  92 .It Cm 100baseTX
  93 Set 100Mbps (Fast Ethernet) operation.
  94 The
  95 .Xr ifconfig 8
  96 .Cm mediaopt
  97 option can also be used to select either
  98 .Cm full-duplex
  99 or
 100 .Cm half-duplex
 101 modes.
 102 .It Cm 1000baseT
 103 Set 1000Mbps (Gigabit Ethernet) operation (AX88178 only).
 104 The
 105 .Xr ifconfig 8
 106 .Cm mediaopt
 107 option can also be used to select either
 108 .Cm full-duplex
 109 or
 110 .Cm half-duplex
 111 modes.
 112 .El
 113 .Pp
 114 The
 115 .Nm
 116 driver supports the following media options:
 117 .Bl -tag -width ".Cm full-duplex"
 118 .It Cm full-duplex
 119 Force full duplex operation.
 120 .It Cm half-duplex
 121 Force half duplex operation.
 122 .El
 123 .Pp
 124 For more information on configuring this device, see
 125 .Xr ifconfig 8 .
 126 .Sh SEE ALSO
 127 .Xr altq 4 ,
 128 .Xr arp 4 ,
 129 .Xr miibus 4 ,
 130 .Xr netintro 4 ,
 131 .Xr ng_ether 4 ,
 132 .Xr rgephy 4 ,
 133 .Xr vlan 4 ,
 134 .Xr ifconfig 8
 135 .Sh HISTORY
 136 The
 137 .Nm
 138 device driver first appeared in
 139 .Fx 10.1 .
 140 .Sh AUTHORS
 141 The
 142 .Nm
 143 driver was written by
 144 .An Kevin Lo Aq kevlo@FreeBSD.org
 145 and
 146 .An Li-Wen Hsu Aq lwhsu@FreeBSD.org .
 147 This manual page was adapted by
 148 .An Mark Johnston Aq markj@FreeBSD.org
 149 from the
 150 .Xr axe 4
 151 manual page.