2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
5 * Copyright (c) 2009 Diego Giagio. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * Thanks to Diego Giagio for figuring out the programming details for
31 * the Apple iPhone Ethernet driver.
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/stdint.h>
38 #include <sys/stddef.h>
39 #include <sys/param.h>
40 #include <sys/queue.h>
41 #include <sys/types.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
45 #include <sys/module.h>
47 #include <sys/mutex.h>
48 #include <sys/condvar.h>
49 #include <sys/socket.h>
50 #include <sys/sysctl.h>
52 #include <sys/unistd.h>
53 #include <sys/callout.h>
54 #include <sys/malloc.h>
58 #include <net/if_var.h>
60 #include <dev/usb/usb.h>
61 #include <dev/usb/usbdi.h>
62 #include <dev/usb/usbdi_util.h>
65 #define USB_DEBUG_VAR ipheth_debug
66 #include <dev/usb/usb_debug.h>
67 #include <dev/usb/usb_process.h>
69 #include <dev/usb/net/usb_ethernet.h>
70 #include <dev/usb/net/if_iphethvar.h>
72 static device_probe_t ipheth_probe;
73 static device_attach_t ipheth_attach;
74 static device_detach_t ipheth_detach;
76 static usb_callback_t ipheth_bulk_write_callback;
77 static usb_callback_t ipheth_bulk_read_callback;
79 static uether_fn_t ipheth_attach_post;
80 static uether_fn_t ipheth_tick;
81 static uether_fn_t ipheth_init;
82 static uether_fn_t ipheth_stop;
83 static uether_fn_t ipheth_start;
84 static uether_fn_t ipheth_setmulti;
85 static uether_fn_t ipheth_setpromisc;
88 static int ipheth_debug = 0;
90 static SYSCTL_NODE(_hw_usb, OID_AUTO, ipheth, CTLFLAG_RW, 0, "USB iPhone ethernet");
91 SYSCTL_INT(_hw_usb_ipheth, OID_AUTO, debug, CTLFLAG_RWTUN, &ipheth_debug, 0, "Debug level");
94 static const struct usb_config ipheth_config[IPHETH_N_TRANSFER] = {
98 .endpoint = UE_ADDR_ANY,
99 .direction = UE_DIR_RX,
100 .frames = IPHETH_RX_FRAMES_MAX,
101 .bufsize = (IPHETH_RX_FRAMES_MAX * MCLBYTES),
102 .flags = {.short_frames_ok = 1,.short_xfer_ok = 1,.ext_buffer = 1,},
103 .callback = ipheth_bulk_read_callback,
104 .timeout = 0, /* no timeout */
109 .endpoint = UE_ADDR_ANY,
110 .direction = UE_DIR_TX,
111 .frames = IPHETH_TX_FRAMES_MAX,
112 .bufsize = (IPHETH_TX_FRAMES_MAX * IPHETH_BUF_SIZE),
113 .flags = {.force_short_xfer = 1,},
114 .callback = ipheth_bulk_write_callback,
115 .timeout = IPHETH_TX_TIMEOUT,
119 static device_method_t ipheth_methods[] = {
120 /* Device interface */
121 DEVMETHOD(device_probe, ipheth_probe),
122 DEVMETHOD(device_attach, ipheth_attach),
123 DEVMETHOD(device_detach, ipheth_detach),
128 static driver_t ipheth_driver = {
130 .methods = ipheth_methods,
131 .size = sizeof(struct ipheth_softc),
134 static devclass_t ipheth_devclass;
136 static const STRUCT_USB_HOST_ID ipheth_devs[] = {
138 {IPHETH_ID(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_IPHONE,
139 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
140 IPHETH_USBINTF_PROTO)},
141 {IPHETH_ID(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_IPHONE_3G,
142 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
143 IPHETH_USBINTF_PROTO)},
144 {IPHETH_ID(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_IPHONE_3GS,
145 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
146 IPHETH_USBINTF_PROTO)},
147 {IPHETH_ID(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_IPHONE_4,
148 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
149 IPHETH_USBINTF_PROTO)},
150 {IPHETH_ID(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_IPHONE_4S,
151 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
152 IPHETH_USBINTF_PROTO)},
153 {IPHETH_ID(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_IPHONE_5,
154 IPHETH_USBINTF_CLASS, IPHETH_USBINTF_SUBCLASS,
155 IPHETH_USBINTF_PROTO)},
157 /* product agnostic interface match */
158 {USB_VENDOR(USB_VENDOR_APPLE),
159 USB_IFACE_CLASS(IPHETH_USBINTF_CLASS),
160 USB_IFACE_SUBCLASS(IPHETH_USBINTF_SUBCLASS),
161 USB_IFACE_PROTOCOL(IPHETH_USBINTF_PROTO)},
165 DRIVER_MODULE(ipheth, uhub, ipheth_driver, ipheth_devclass, NULL, 0);
166 MODULE_VERSION(ipheth, 1);
167 MODULE_DEPEND(ipheth, uether, 1, 1, 1);
168 MODULE_DEPEND(ipheth, usb, 1, 1, 1);
169 MODULE_DEPEND(ipheth, ether, 1, 1, 1);
170 USB_PNP_HOST_INFO(ipheth_devs);
172 static const struct usb_ether_methods ipheth_ue_methods = {
173 .ue_attach_post = ipheth_attach_post,
174 .ue_start = ipheth_start,
175 .ue_init = ipheth_init,
176 .ue_tick = ipheth_tick,
177 .ue_stop = ipheth_stop,
178 .ue_setmulti = ipheth_setmulti,
179 .ue_setpromisc = ipheth_setpromisc,
182 #define IPHETH_ID(v,p,c,sc,pt) \
183 USB_VENDOR(v), USB_PRODUCT(p), \
184 USB_IFACE_CLASS(c), USB_IFACE_SUBCLASS(sc), \
185 USB_IFACE_PROTOCOL(pt)
188 ipheth_get_mac_addr(struct ipheth_softc *sc)
190 struct usb_device_request req;
193 req.bmRequestType = UT_READ_VENDOR_DEVICE;
194 req.bRequest = IPHETH_CMD_GET_MACADDR;
197 req.wIndex[0] = sc->sc_iface_no;
199 req.wLength[0] = ETHER_ADDR_LEN;
202 error = usbd_do_request(sc->sc_ue.ue_udev, NULL, &req, sc->sc_data);
207 memcpy(sc->sc_ue.ue_eaddr, sc->sc_data, ETHER_ADDR_LEN);
213 ipheth_probe(device_t dev)
215 struct usb_attach_arg *uaa = device_get_ivars(dev);
217 if (uaa->usb_mode != USB_MODE_HOST)
220 return (usbd_lookup_id_by_uaa(ipheth_devs, sizeof(ipheth_devs), uaa));
224 ipheth_attach(device_t dev)
226 struct ipheth_softc *sc = device_get_softc(dev);
227 struct usb_ether *ue = &sc->sc_ue;
228 struct usb_attach_arg *uaa = device_get_ivars(dev);
231 sc->sc_iface_no = uaa->info.bIfaceIndex;
233 device_set_usb_desc(dev);
235 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
237 error = usbd_set_alt_interface_index(uaa->device,
238 uaa->info.bIfaceIndex, IPHETH_ALT_INTFNUM);
240 device_printf(dev, "Cannot set alternate setting\n");
243 error = usbd_transfer_setup(uaa->device, &sc->sc_iface_no,
244 sc->sc_xfer, ipheth_config, IPHETH_N_TRANSFER, sc, &sc->sc_mtx);
246 device_printf(dev, "Cannot setup USB transfers\n");
251 ue->ue_udev = uaa->device;
252 ue->ue_mtx = &sc->sc_mtx;
253 ue->ue_methods = &ipheth_ue_methods;
255 error = ipheth_get_mac_addr(sc);
257 device_printf(dev, "Cannot get MAC address\n");
261 error = uether_ifattach(ue);
263 device_printf(dev, "could not attach interface\n");
266 return (0); /* success */
270 return (ENXIO); /* failure */
274 ipheth_detach(device_t dev)
276 struct ipheth_softc *sc = device_get_softc(dev);
277 struct usb_ether *ue = &sc->sc_ue;
279 /* stop all USB transfers first */
280 usbd_transfer_unsetup(sc->sc_xfer, IPHETH_N_TRANSFER);
284 mtx_destroy(&sc->sc_mtx);
290 ipheth_start(struct usb_ether *ue)
292 struct ipheth_softc *sc = uether_getsc(ue);
295 * Start the USB transfers, if not already started:
297 usbd_transfer_start(sc->sc_xfer[IPHETH_BULK_TX]);
298 usbd_transfer_start(sc->sc_xfer[IPHETH_BULK_RX]);
302 ipheth_stop(struct usb_ether *ue)
304 struct ipheth_softc *sc = uether_getsc(ue);
307 * Stop the USB transfers, if not already stopped:
309 usbd_transfer_stop(sc->sc_xfer[IPHETH_BULK_TX]);
310 usbd_transfer_stop(sc->sc_xfer[IPHETH_BULK_RX]);
314 ipheth_tick(struct usb_ether *ue)
316 struct ipheth_softc *sc = uether_getsc(ue);
317 struct usb_device_request req;
320 req.bmRequestType = UT_READ_VENDOR_DEVICE;
321 req.bRequest = IPHETH_CMD_CARRIER_CHECK;
324 req.wIndex[0] = sc->sc_iface_no;
326 req.wLength[0] = IPHETH_CTRL_BUF_SIZE;
329 error = uether_do_request(ue, &req, sc->sc_data, IPHETH_CTRL_TIMEOUT);
335 (sc->sc_data[0] == IPHETH_CARRIER_ON);
339 ipheth_attach_post(struct usb_ether *ue)
345 ipheth_init(struct usb_ether *ue)
347 struct ipheth_softc *sc = uether_getsc(ue);
348 struct ifnet *ifp = uether_getifp(ue);
350 IPHETH_LOCK_ASSERT(sc, MA_OWNED);
352 ifp->if_drv_flags |= IFF_DRV_RUNNING;
354 /* stall data write direction, which depends on USB mode */
355 usbd_xfer_set_stall(sc->sc_xfer[IPHETH_BULK_TX]);
357 /* start data transfers */
362 ipheth_setmulti(struct usb_ether *ue)
368 ipheth_setpromisc(struct usb_ether *ue)
374 ipheth_free_queue(struct mbuf **ppm, uint8_t n)
378 for (x = 0; x != n; x++) {
379 if (ppm[x] != NULL) {
387 ipheth_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
389 struct ipheth_softc *sc = usbd_xfer_softc(xfer);
390 struct ifnet *ifp = uether_getifp(&sc->sc_ue);
391 struct usb_page_cache *pc;
397 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
401 switch (USB_GET_STATE(xfer)) {
402 case USB_ST_TRANSFERRED:
403 DPRINTFN(11, "transfer complete: %u bytes in %u frames\n",
406 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
408 /* free all previous TX buffers */
409 ipheth_free_queue(sc->sc_tx_buf, IPHETH_TX_FRAMES_MAX);
414 for (x = 0; x != IPHETH_TX_FRAMES_MAX; x++) {
416 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
421 usbd_xfer_set_frame_offset(xfer,
422 x * IPHETH_BUF_SIZE, x);
424 pc = usbd_xfer_get_frame(xfer, x);
426 sc->sc_tx_buf[x] = m;
428 if (m->m_pkthdr.len > IPHETH_BUF_SIZE)
429 m->m_pkthdr.len = IPHETH_BUF_SIZE;
431 usbd_m_copy_in(pc, 0, m, 0, m->m_pkthdr.len);
433 usbd_xfer_set_frame_len(xfer, x, IPHETH_BUF_SIZE);
435 if (IPHETH_BUF_SIZE != m->m_pkthdr.len) {
436 usbd_frame_zero(pc, m->m_pkthdr.len,
437 IPHETH_BUF_SIZE - m->m_pkthdr.len);
441 * If there's a BPF listener, bounce a copy of
447 usbd_xfer_set_frames(xfer, x);
449 usbd_transfer_submit(xfer);
454 DPRINTFN(11, "transfer error, %s\n",
457 /* free all previous TX buffers */
458 ipheth_free_queue(sc->sc_tx_buf, IPHETH_TX_FRAMES_MAX);
460 /* count output errors */
461 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
463 if (error != USB_ERR_CANCELLED) {
464 /* try to clear stall first */
465 usbd_xfer_set_stall(xfer);
473 ipheth_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
475 struct ipheth_softc *sc = usbd_xfer_softc(xfer);
482 usbd_xfer_status(xfer, &actlen, NULL, &aframes, NULL);
484 switch (USB_GET_STATE(xfer)) {
485 case USB_ST_TRANSFERRED:
487 DPRINTF("received %u bytes in %u frames\n", actlen, aframes);
489 for (x = 0; x != aframes; x++) {
491 m = sc->sc_rx_buf[x];
492 sc->sc_rx_buf[x] = NULL;
493 len = usbd_xfer_frame_len(xfer, x);
495 if (len < (int)(sizeof(struct ether_header) +
501 m_adj(m, IPHETH_RX_ADJ);
504 uether_rxmbuf(&sc->sc_ue, m, len - IPHETH_RX_ADJ);
510 for (x = 0; x != IPHETH_RX_FRAMES_MAX; x++) {
511 if (sc->sc_rx_buf[x] == NULL) {
516 /* cancel alignment for ethernet */
517 m_adj(m, ETHER_ALIGN);
519 sc->sc_rx_buf[x] = m;
521 m = sc->sc_rx_buf[x];
524 usbd_xfer_set_frame_data(xfer, x, m->m_data, m->m_len);
526 /* set number of frames and start hardware */
527 usbd_xfer_set_frames(xfer, x);
528 usbd_transfer_submit(xfer);
529 /* flush any received frames */
530 uether_rxflush(&sc->sc_ue);
534 DPRINTF("error = %s\n", usbd_errstr(error));
536 if (error != USB_ERR_CANCELLED) {
538 /* try to clear stall first */
539 usbd_xfer_set_stall(xfer);
540 usbd_xfer_set_frames(xfer, 0);
541 usbd_transfer_submit(xfer);
544 /* need to free the RX-mbufs when we are cancelled */
545 ipheth_free_queue(sc->sc_rx_buf, IPHETH_RX_FRAMES_MAX);