xref: /freebsd/share/man/man4/urndis.4 (revision c697fb7f)
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 November 24, 2015
33.Dt URNDIS 4
34.Os
35.Sh NAME
36.Nm urndis
37.Nd USB Remote NDIS Ethernet device
38.Sh SYNOPSIS
39To compile this driver into the kernel,
40place the following lines in your
41kernel 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 miibus"
49.Cd "device uether"
50.Cd "device urndis"
51.Ed
52.Pp
53Alternatively, to load the driver as a
54module at boot time, place the following line in
55.Xr loader.conf 5 :
56.Bd -literal -offset indent
57if_urndis_load="YES"
58.Ed
59.Sh DESCRIPTION
60The
61.Nm
62driver provides Ethernet access over Remote NDIS (RNDIS),
63allowing mobile devices such as phones and tablets to provide network access.
64It is often referred to as USB tethering,
65and in most cases must be explicitly enabled on the device.
66.Pp
67.Nm
68should work with any USB RNDIS devices,
69such as those commonly found on Android devices.
70It does not support different media types or options.
71For more information on configuring this device, see
72.Xr ifconfig 8 .
73.Sh HARDWARE
74The
75.Nm
76driver supports the
77.Qq tethering
78functionality of many Android devices.
79.Sh SEE ALSO
80.Xr arp 4 ,
81.Xr cdce 4 ,
82.Xr cdceem 4 ,
83.Xr ipheth 4 ,
84.Xr netintro 4 ,
85.Xr usb 4 ,
86.Xr ifconfig 8
87.Sh HISTORY
88The
89.Nm
90device driver first appeared in
91.Ox 4.7 .
92The first
93.Fx
94release to include it was
95.Fx 9.3 .
96.Sh AUTHORS
97.An -nosplit
98The
99.Nm
100driver was written by
101.An Jonathan Armani Aq Mt armani@openbsd.org ,
102.An Michael Knudsen Aq Mt mk@openbsd.org ,
103and
104.An Fabien Romano Aq Mt fabien@openbsd.org .
105It was ported to
106.Fx
107by
108.An Hans Petter Selasky Aq Mt hps@FreeBSD.org .
109