xref: /freebsd/share/man/man4/ipheth.4 (revision 86c9d9918f1db7cdd968b60f8902466887bcd9e9)
1.\" Copyright (c) 2014 Gavin Atkinson
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.\" $FreeBSD$
29.\"
30.Dd November 24, 2015
31.Dt IPHETH 4
32.Os
33.Sh NAME
34.Nm ipheth
35.Nd "USB Apple iPhone/iPad tethered Ethernet driver"
36.Sh SYNOPSIS
37To load the driver as a module at boot time, place the
38following line in
39.Xr loader.conf 5 :
40.Bd -literal -offset indent
41if_ipheth_load="YES"
42.Ed
43.Pp
44Alternatively, to compile this driver into the kernel, place the
45following lines in your kernel configuration file:
46.Bd -ragged -offset indent
47.Cd "device uhci"
48.Cd "device ohci"
49.Cd "device usb"
50.Cd "device miibus"
51.Cd "device uether"
52.Cd "device ipheth"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for network access through Apple
58iPhone and iPad devices, often referred to as USB tethering.
59.Pp
60.Nm
61should work with any Apple iPhone or iPad device.
62In most cases this must be explicitly enabled on the device first.
63.Pp
64For more information on configuring this device, see
65.Xr ifconfig 8 .
66The device does not support different media types or options.
67.Sh HARDWARE
68The following devices are supported by the
69.Nm
70driver:
71.Pp
72.Bl -bullet -compact
73.It
74Apple iPhone tethering (all models)
75.It
76Apple iPad tethering (all models)
77.El
78.Sh SEE ALSO
79.Xr arp 4 ,
80.Xr cdce 4 ,
81.Xr intro 4 ,
82.Xr netintro 4 ,
83.Xr urndis 4 ,
84.Xr usb 4 ,
85.Xr ifconfig 8 ,
86.Xr usbconfig 8
87.Sh HISTORY
88The
89.Nm
90device driver first appeared in
91.Fx 8.2 .
92.Sh AUTHORS
93.An -nosplit
94The
95.Nm
96driver was written by
97.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .
98.Sh BUGS
99Some devices may need to be manually configured to use an alternative
100configuration with the
101.Xr usbconfig 8
102utility.
103A command similar to
104.Dl usbconfig -u 1 -a 2 set_config 3
105may be required if the device is not recognised automatically by
106.Nm
107after it is connected.
108