xref: /dragonfly/share/man/man4/urndis.4 (revision 7ff0fc30)
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: head/share/man/man4/urndis.4 264731 2014-04-21 16:35:19Z gjb $
31.\"
32.Dd November 16, 2018
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 uether"
49.Cd "device urndis"
50.Ed
51.Pp
52Alternatively, to load the driver as a
53module at boot time, place the following line in
54.Xr loader.conf 5 :
55.Bd -literal -offset indent
56if_urndis_load="YES"
57.Ed
58.Sh DESCRIPTION
59The
60.Nm
61driver provides Ethernet access over Remote NDIS (RNDIS),
62allowing mobile devices such as phones and tablets to provide network access.
63It is often referred to as USB tethering,
64and in most cases must be explicitly enabled on the device.
65.Pp
66.Nm
67should work with any USB RNDIS devices,
68such as those commonly found on Android devices.
69It does not support different media types or options.
70For more information on configuring this device, see
71.Xr ifconfig 8 .
72.Sh SEE ALSO
73.Xr arp 4 ,
74.Xr cdce 4 ,
75.Xr ipheth 4 ,
76.Xr netintro 4 ,
77.Xr usb 4 ,
78.Xr ifconfig 8
79.Sh HISTORY
80The
81.Nm
82device driver first appeared in
83.Ox 4.7 .
84The first
85.Fx
86release to include it was
87.Fx 9.3 .
88.Sh AUTHORS
89.An -nosplit
90The
91.Nm
92driver was written by
93.An Jonathan Armani Aq Mt armani@openbsd.org ,
94.An Michael Knudsen Aq Mt mk@openbsd.org ,
95and
96.An Fabien Romano Aq Mt fabien@openbsd.org .
97It was ported to
98.Fx
99by
100.An Hans Petter Selasky Aq Mt hps@FreeBSD.org .
101