1 .\" Copyright (c) 2014 Gavin Atkinson
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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.
35 .Nd "USB Apple iPhone/iPad tethered Ethernet driver"
37 To load the driver as a module at boot time, place the
40 .Bd -literal -offset indent
44 Alternatively, to compile this driver into the kernel, place the
45 following lines in your kernel configuration file:
46 .Bd -ragged -offset indent
57 driver provides support for network access through Apple
58 iPhone and iPad devices, often referred to as USB tethering.
61 should work with any Apple iPhone or iPad device.
62 In most cases this must be explicitly enabled on the device first.
64 For more information on configuring this device, see
66 The device does not support different media types or options.
68 The following devices are supported by the
74 Apple iPhone tethering (all models)
76 Apple iPad tethering (all models)
80 .It Sy Example 1\&: No Manual Configuration
82 The following example shows how to manually configure network access on a
83 device that is not automatically recognized.
85 First, load the driver and find out the unit and the address of the USB
88 .Bd -literal -offset 2n
89 .Li # Ic kldload ipheth
90 .Li # Ic usbconfig | grep Apple
91 ugen0.2: <Apple Inc. iPhone> at usbus0, cfg=0 md=HOST spd=HIGH (480Mbps) pwr=ON (500mA)
94 In this example, the unit and the address of the device is 0.2
96 and its configuration index is 0
99 Secondly, check what other configurations are available for the device:
100 .Bd -literal -offset 2n
101 .Li # Ic usbconfig 0.2 dump_all_config_desc | awk '/^ Conf/{print} /iConf/{print}'
102 Configuration index 0
103 iConfiguration = 0x0005 <PTP>
104 Configuration index 1
105 iConfiguration = 0x0006 <iPod USB Interface>
106 Configuration index 2
107 iConfiguration = 0x0007 <PTP + Apple Mobile Device>
108 Configuration index 3
109 iConfiguration = 0x0008 <PTP + Apple Mobile Device + Apple USB Ethernet>
112 In this example, there are 4 different configurations available.
113 The configuration with index 3 seems to be related to Ethernet.
114 It is time to configure the device:
115 .Bd -literal -offset 2n
116 .Li # Ic usbconfig 0.2 set_config 3
117 .Li # Ic usbconfig | grep 'Apple.*cfg=3'
118 ugen0.2: <Apple Inc. iPhone> at usbus0, cfg=3 md=HOST spd=HIGH (480Mbps) pwr=ON (500mA)
121 At this point the Apple device should ask whether the
123 machine can be trusted
130 USB Ethernet interface should become available:
131 .Bd -literal -offset 2n
132 .Li # Ic dmesg | grep 'ue[0-9]'
133 ue0: <USB Ethernet> on ipheth0
135 ue0: Ethernet address: 4e:7c:5f:2c:5f:7a
138 At this point it might be necessary to run
145 .Bd -literal -offset 2n
146 .Li # Ic usbmuxd --enable-exit --foreground --user root --verbose
149 Now it is time to configure the network interface:
150 .Bd -literal -offset 2n
151 .Li # Ic sysrc ifconfig_ue0="SYNCDHCP"
152 ifconfig_ue0: -> SYNCDHCP
153 .Li # Ic service netif restart ue0
157 The machine should now be connected to the network via USB tethering.
172 device driver first appeared in
178 driver was written by
179 .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .
181 Some devices are not recognized automatically and may need to be manually
182 configured to use an alternative configuration with the