share/man/man4/rue.4

   1 .\"
   2 .\" Copyright (c) 2001-2003, Shunsuke Akiyama <akiyama@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: src/share/man/man4/rue.4,v 1.11 2005/10/07 02:32:15 trhodes Exp $
  27 .\" $DragonFly: src/share/man/man4/rue.4,v 1.1 2005/10/09 13:29:50 swildner Exp $
  28 .\"
  29 .Dd July 16, 2005
  30 .Dt RUE 4
  31 .Os
  32 .Sh NAME
  33 .Nm rue
  34 .Nd "RealTek RTL8150 USB to Fast Ethernet controller driver"
  35 .Sh SYNOPSIS
  36 To compile this driver into the kernel,
  37 place the following lines in your
  38 kernel configuration file:
  39 .Bd -ragged -offset indent
  40 .Cd "device uhci"
  41 .Cd "device ohci"
  42 .Cd "device usb"
  43 .Cd "device miibus"
  44 .Cd "device rue"
  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_rue_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver provides support for USB Ethernet adapters based on the RealTek
  57 RTL8150 USB to Fast Ethernet controller chip.
  58 .Pp
  59 The RTL8150 contains an integrated Fast Ethernet MAC, which supports
  60 both 10 and 100Mbps speeds in either full or half duplex.
  61 Although designed to interface with
  62 100Mbps peripheral, the existing USB standard specifies a maximum
  63 transfer speed of 12Mbps.
  64 Users should therefore not expect to actually
  65 achieve 100Mbps speeds with this device.
  66 .Pp
  67 The
  68 .Nm
  69 driver supports the following media types:
  70 .Bl -tag -width ".Cm 10baseT/UTP"
  71 .It Cm autoselect
  72 Enable auto selection of the media type and options.
  73 The user can manually override
  74 the auto selected mode by adding media options to the
  75 .Pa /etc/rc.conf
  76 file.
  77 .It Cm 10baseT/UTP
  78 Set 10Mbps operation.
  79 The
  80 .Cm mediaopt
  81 option can also be used to select either
  82 .Cm full-duplex
  83 or
  84 .Cm half-duplex
  85 modes.
  86 .It Cm 100baseTX
  87 Set 100Mbps (Fast Ethernet) operation.
  88 The
  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 .El
  96 .Pp
  97 The
  98 .Nm
  99 driver supports the following media options:
 100 .Bl -tag -width ".Cm 10baseT/UTP"
 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 HARDWARE
 110 The
 111 .Nm
 112 driver supports RealTek RTL8150 based USB Ethernet
 113 adapters including:
 114 .Pp
 115 .Bl -bullet -compact
 116 .It
 117 Buffalo (Melco Inc.) LUA-KTX
 118 .It
 119 Green House GH-USB100B
 120 .It
 121 LinkSys USB100M
 122 .It
 123 Billionton 10/100 FastEthernet USBKR2
 124 .El
 125 .Sh DIAGNOSTICS
 126 .Bl -diag
 127 .It "rue%d: watchdog timeout"
 128 A packet was queued for transmission and a transmit command was
 129 issued, however the device failed to acknowledge the transmission
 130 before a timeout expired.
 131 .It "rue%d: rx list init failed"
 132 The driver failed to allocate an mbuf for the transmitter ring.
 133 .It "rue%d: no memory for rx list"
 134 The driver failed to allocate an mbuf for the receiver ring.
 135 .El
 136 .Sh SEE ALSO
 137 .Xr arp 4 ,
 138 .Xr miibus 4 ,
 139 .Xr netintro 4 ,
 140 .Xr ng_ether 4 ,
 141 .Xr ifconfig 8
 142 .Rs
 143 .%T "ReakTek RTL8150 data sheet"
 144 .%O ftp://ftp.realtek.com.tw/lancard/data_sheet/8150/
 145 .Re
 146 .Sh HISTORY
 147 The
 148 .Nm
 149 device driver first appeared in
 150 .Fx 5.1 .
 151 .Sh AUTHORS
 152 The
 153 .Nm
 154 driver was written by
 155 .An Shunsuke Akiyama Aq akiyama@FreeBSD.org .