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$
  27 .\"
  28 .Dd July 16, 2005
  29 .Dt RUE 4
  30 .Os
  31 .Sh NAME
  32 .Nm rue
  33 .Nd "RealTek RTL8150 USB to Fast 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 rue"
  44 .Ed
  45 .Pp
  46 Alternatively, to load the driver as a
  47 module at boot time, place the following line in
  48 .Xr loader.conf 5 :
  49 .Bd -literal -offset indent
  50 if_rue_load="YES"
  51 .Ed
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 driver provides support for USB Ethernet adapters based on the RealTek
  56 RTL8150 USB to Fast Ethernet controller chip.
  57 .Pp
  58 The RTL8150 contains an integrated Fast Ethernet MAC, which supports
  59 both 10 and 100Mbps speeds in either full or half duplex.
  60 Although designed to interface with
  61 100Mbps peripheral, the existing USB standard specifies a maximum
  62 transfer speed of 12Mbps.
  63 Users should therefore not expect to actually
  64 achieve 100Mbps speeds with this device.
  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 auto selection of the media type and options.
  72 The user can manually override
  73 the auto selected mode by adding media options to the
  74 .Pa /etc/rc.conf
  75 file.
  76 .It Cm 10baseT/UTP
  77 Set 10Mbps operation.
  78 The
  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 .Cm mediaopt
  89 option can also be used to select either
  90 .Cm full-duplex
  91 or
  92 .Cm half-duplex
  93 modes.
  94 .El
  95 .Pp
  96 The
  97 .Nm
  98 driver supports the following media options:
  99 .Bl -tag -width ".Cm 10baseT/UTP"
 100 .It Cm full-duplex
 101 Force full duplex operation.
 102 .It Cm half-duplex
 103 Force half duplex operation.
 104 .El
 105 .Pp
 106 For more information on configuring this device, see
 107 .Xr ifconfig 8 .
 108 .Sh HARDWARE
 109 The
 110 .Nm
 111 driver supports RealTek RTL8150 based USB Ethernet
 112 adapters including:
 113 .Pp
 114 .Bl -bullet -compact
 115 .It
 116 Buffalo (Melco Inc.) LUA-KTX
 117 .It
 118 Green House GH-USB100B
 119 .It
 120 LinkSys USB100M
 121 .It
 122 Billionton 10/100 FastEthernet USBKR2
 123 .El
 124 .Sh DIAGNOSTICS
 125 .Bl -diag
 126 .It "rue%d: watchdog timeout"
 127 A packet was queued for transmission and a transmit command was
 128 issued, however the device failed to acknowledge the transmission
 129 before a timeout expired.
 130 .It "rue%d: rx list init failed"
 131 The driver failed to allocate an mbuf for the transmitter ring.
 132 .It "rue%d: no memory for rx list"
 133 The driver failed to allocate an mbuf for the receiver ring.
 134 .El
 135 .Sh SEE ALSO
 136 .Xr arp 4 ,
 137 .Xr miibus 4 ,
 138 .Xr netintro 4 ,
 139 .Xr ng_ether 4 ,
 140 .Xr ifconfig 8
 141 .Rs
 142 .%T "ReakTek RTL8150 data sheet"
 143 .%O ftp://ftp.realtek.com.tw/lancard/data_sheet/8150/
 144 .Re
 145 .Sh HISTORY
 146 The
 147 .Nm
 148 device driver first appeared in
 149 .Fx 5.1 .
 150 .Sh AUTHORS
 151 The
 152 .Nm
 153 driver was written by
 154 .An Shunsuke Akiyama Aq akiyama@FreeBSD.org .