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 May 3, 2003
  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 .Cd "device uhci"
  36 .Cd "device ohci"
  37 .Cd "device usb"
  38 .Cd "device miibus"
  39 .Cd "device rue"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver provides support for USB Ethernet adapters based on the RealTek
  44 RTL8150 USB to Fast Ethernet controller chip.
  45 This includes the Melco Inc. LUA-KTX, the GREEN HOUSE GH-USB100B,
  46 and the Billionton 10/100 FastEthernet USBKR2 "thumb" adaptor.
  47 .Pp
  48 The RTL8150 contains an integrated Fast Ethernet MAC, which supports
  49 both 10 and 100Mbps speeds in either full or half duplex.
  50 Although designed to interface with
  51 100Mbps peripheral, the existing USB standard specifies a maximum
  52 transfer speed of 12Mbps.
  53 Users should therefore not expect to actually
  54 achieve 100Mbps speeds with this device.
  55 .Pp
  56 The
  57 .Nm
  58 driver supports the following media types:
  59 .Bl -tag -width ".Cm 10baseT/UTP"
  60 .It Cm autoselect
  61 Enable auto selection of the media type and options.
  62 The user can manually override
  63 the auto selected mode by adding media options to the
  64 .Pa /etc/rc.conf
  65 file.
  66 .It Cm 10baseT/UTP
  67 Set 10Mbps operation.
  68 The
  69 .Cm mediaopt
  70 option can also be used to select either
  71 .Cm full-duplex
  72 or
  73 .Cm half-duplex
  74 modes.
  75 .It Cm 100baseTX
  76 Set 100Mbps (Fast Ethernet) operation.
  77 The
  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 .El
  85 .Pp
  86 The
  87 .Nm
  88 driver supports the following media options:
  89 .Bl -tag -width ".Cm 10baseT/UTP"
  90 .It Cm full-duplex
  91 Force full duplex operation.
  92 .It Cm half-duplex
  93 Force half duplex operation.
  94 .El
  95 .Pp
  96 For more information on configuring this device, see
  97 .Xr ifconfig 8 .
  98 .Sh DIAGNOSTICS
  99 .Bl -diag
 100 .It "rue%d: watchdog timeout"
 101 A packet was queued for transmission and a transmit command was
 102 issued, however the device failed to acknowledge the transmission
 103 before a timeout expired.
 104 .It "rue%d: rx list init failed"
 105 The driver failed to allocate an mbuf for the transmitter ring.
 106 .It "rue%d: no memory for rx list"
 107 The driver failed to allocate an mbuf for the receiver ring.
 108 .El
 109 .Sh SEE ALSO
 110 .Xr arp 4 ,
 111 .Xr miibus 4 ,
 112 .Xr netintro 4 ,
 113 .Xr ng_ether 4 ,
 114 .Xr ifconfig 8
 115 .Rs
 116 .%T "ReakTek RTL8150 data sheet"
 117 .%O ftp://ftp.realtek.com.tw/lancard/data_sheet/8150/
 118 .Re
 119 .Sh HISTORY
 120 The
 121 .Nm
 122 device driver first appeared in
 123 .Fx 5.1 .
 124 .Sh AUTHORS
 125 The
 126 .Nm
 127 driver was written by
 128 .An Shunsuke Akiyama Aq akiyama@FreeBSD.org .