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