share/man/man4/ure.4

   1 .\"
   2 .\" Copyright (c) 2015-2016 Kevin Lo <kevlo@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd October 31, 2016
  29 .Dt URE 4
  30 .Os
  31 .Sh NAME
  32 .Nm ure
  33 .Nd "RealTek RTL8152/RTL8153 USB to Ethernet controller driver"
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device uhci"
  40 .Cd "device ohci"
  41 .Cd "device usb"
  42 .Cd "device miibus"
  43 .Cd "device uether"
  44 .Cd "device ure"
  45 .Ed
  46 .Pp
  47 Alternatively, to load the driver as a
  48 module at boot time, place the following line in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 if_ure_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver provides support for USB Ethernet adapters based on the RealTek
  57 RealTek RTL8152 and RTL8153 USB Ethernet controllers.
  58 .Pp
  59 NICs based on the RTL8152 are capable of 10 and 100Mbps speeds.
  60 NICs based on the RTL8153 are capable of 10, 100 and 1000Mbps operation.
  61 .Pp
  62 The
  63 .Nm
  64 driver supports the following media types:
  65 .Bl -tag -width ".Cm 10baseT/UTP"
  66 .It Cm autoselect
  67 Enable auto selection of the media type and options.
  68 The user can manually override
  69 the auto selected mode by adding media options to the
  70 .Pa /etc/rc.conf
  71 file.
  72 .It Cm 10baseT/UTP
  73 Set 10Mbps operation.
  74 The
  75 .Cm mediaopt
  76 option can also be used to select either
  77 .Cm full-duplex
  78 or
  79 .Cm half-duplex
  80 modes.
  81 .It Cm 100baseTX
  82 Set 100Mbps (Fast Ethernet) operation.
  83 The
  84 .Cm mediaopt
  85 option can also be used to select either
  86 .Cm full-duplex
  87 or
  88 .Cm half-duplex
  89 modes.
  90 .It Cm 1000baseTX
  91 Set 1000baseTX operation over twisted pair.
  92 The RealTek gigE chips support 1000Mbps in
  93 .Cm full-duplex
  94 mode only.
  95 .El
  96 .Pp
  97 The
  98 .Nm
  99 driver supports the following media options:
 100 .Bl -tag -width ".Cm full-duplex"
 101 .It Cm full-duplex
 102 Force full duplex operation.
 103 .It Cm half-duplex
 104 Force half duplex operation.
 105 .El
 106 .Pp
 107 For more information on configuring this device, see
 108 .Xr ifconfig 8 .
 109 .Sh DIAGNOSTICS
 110 .Bl -diag
 111 .It "ure%d: watchdog timeout"
 112 A packet was queued for transmission and a transmit command was
 113 issued, however the device failed to acknowledge the transmission
 114 before a timeout expired.
 115 .El
 116 .Sh SEE ALSO
 117 .Xr arp 4 ,
 118 .Xr miibus 4 ,
 119 .Xr netintro 4 ,
 120 .Xr ng_ether 4 ,
 121 .Xr ifconfig 8
 122 .Sh AUTHORS
 123 The
 124 .Nm
 125 driver was written by
 126 .An Kevin Lo Aq Mt kevlo@FreeBSD.org .