xref: /netbsd-src/share/man/man4/urndis.4 (revision 38cf7bdeec1fc33b59036d707244cc19b13218a4)
1.\" $NetBSD: urndis.4,v 1.11 2023/02/12 08:45:18 nia Exp $
2.\"
3.\" Copyright (c) 2010 Michael Knudsen <mk@openbsd.org>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\"
10.\"    - Redistributions of source code must retain the above copyright
11.\"      notice, this list of conditions and the following disclaimer.
12.\"    - Redistributions in binary form must reproduce the above
13.\"      copyright notice, this list of conditions and the following
14.\"      disclaimer in the documentation and/or other materials provided
15.\"      with the distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
27.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\" $OpenBSD: urndis.4,v 1.11 2011/07/20 13:12:16 jasper Exp $
31.\"
32.Dd February 12, 2023
33.Dt URNDIS 4
34.Os
35.Sh NAME
36.Nm urndis
37.Nd USB Remote NDIS Ethernet device
38.Sh SYNOPSIS
39.Cd "urndis*  at uhub?"
40.Sh DESCRIPTION
41The
42.Nm
43driver provides support for Ethernet access over Remote NDIS.
44The
45.Nm
46driver should work with all USB RNDIS devices, but the following devices are
47known to work:
48.Pp
49.Bl -bullet -compact -offset indent
50.It
51Geeksphone ONE
52.It
53Google Nexus One
54.It
55HTC Desire
56.It
57HTC Dream / T-Mobile G1 / ADP1
58.It
59HTC Hero
60.It
61HTC Magic
62.It
63HTC Tattoo
64.It
65HTC Wildfire
66.It
67LGE Nexus 5
68.It
69Motorola Moto X (2nd Gen.)
70.It
71OnePlus 5T
72.It
73Samsung Galaxy S / S2
74.It
75Samsung Galaxy S8 Active
76.It
77Sony Xperia XA2
78.El
79.Pp
80The
81.Nm
82driver does not support different media types or options.
83For more information on configuring this device, see
84.Xr ifconfig 8 .
85.Sh DIAGNOSTICS
86See
87.Xr usbnet 4
88for diagnostics.
89.Sh SEE ALSO
90.Xr arp 4 ,
91.Xr intro 4 ,
92.Xr netintro 4 ,
93.Xr usb 4 ,
94.Xr usbnet 4 ,
95.Xr ifconfig.if 5 ,
96.Xr ifconfig 8
97.Sh HISTORY
98The
99.Nm
100device driver first appeared in
101.Ox 4.7
102and in
103.Nx 6.0 .
104.Sh AUTHORS
105.An -nosplit
106The
107.Nm
108driver was written by
109.An Jonathan Armani Aq Mt armani@openbsd.org ,
110.An Michael Knudsen Aq Mt mk@openbsd.org ,
111and
112.An Fabien Romano Aq Mt fabien@openbsd.org .
113