share/man/man4/urndis.4

   1 .\" Copyright (c) 2010 Michael Knudsen <mk@openbsd.org>
   2 .\" 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 .\"
   8 .\"    - Redistributions of source code must retain the above copyright
   9 .\"      notice, this list of conditions and the following disclaimer.
  10 .\"    - Redistributions in binary form must reproduce the above
  11 .\"      copyright notice, this list of conditions and the following
  12 .\"      disclaimer in the documentation and/or other materials provided
  13 .\"      with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  18 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  19 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  21 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  23 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  25 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 .\" POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $OpenBSD: urndis.4,v 1.15 2013/07/16 16:05:49 schwarze Exp $
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd September 25, 2014
  33 .Dt URNDIS 4
  34 .Os
  35 .Sh NAME
  36 .Nm urndis
  37 .Nd USB Remote NDIS Ethernet device
  38 .Sh SYNOPSIS
  39 To compile this driver into the kernel,
  40 place the following lines in your
  41 kernel configuration file:
  42 .Bd -ragged -offset indent
  43 .Cd "device ehci"
  44 .Cd "device uhci"
  45 .Cd "device ohci"
  46 .Cd "device xhci"
  47 .Cd "device usb"
  48 .Cd "device urndis"
  49 .Ed
  50 .Pp
  51 Alternatively, to load the driver as a
  52 module at boot time, place the following line in
  53 .Xr loader.conf 5 :
  54 .Bd -literal -offset indent
  55 if_urndis_load="YES"
  56 .Ed
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 driver provides Ethernet access over Remote NDIS (RNDIS),
  61 allowing mobile devices such as phones and tablets to provide network access.
  62 It is often referred to as USB tethering,
  63 and in most cases must be explicitly enabled on the device.
  64 .Pp
  65 .Nm
  66 should work with any USB RNDIS devices,
  67 such as those commonly found on Android devices.
  68 It does not support different media types or options.
  69 For more information on configuring this device, see
  70 .Xr ifconfig 8 .
  71 .Sh SEE ALSO
  72 .Xr arp 4 ,
  73 .Xr cdce 4 ,
  74 .Xr ipheth 4 ,
  75 .Xr netintro 4 ,
  76 .Xr usb 4 ,
  77 .Xr ifconfig 8
  78 .Sh HISTORY
  79 The
  80 .Nm
  81 device driver first appeared in
  82 .Ox 4.7 .
  83 The first
  84 .Fx
  85 release to include it was
  86 .Fx 9.3 .
  87 .Sh AUTHORS
  88 .An -nosplit
  89 The
  90 .Nm
  91 driver was written by
  92 .An Jonathan Armani Aq Mt armani@openbsd.org ,
  93 .An Michael Knudsen Aq Mt mk@openbsd.org ,
  94 and
  95 .An Fabien Romano Aq Mt fabien@openbsd.org .
  96 It was ported to
  97 .Fx
  98 by
  99 .An Hans Petter Selasky Aq Mt hps@FreeBSD.org .