2 * phonet.c -- USB CDC Phonet host driver
4 * Copyright (C) 2008-2009 Nokia Corporation. All rights reserved.
6 * Author: Rémi Denis-Courmont
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
23 #include <linux/kernel.h>
25 #include <linux/module.h>
26 #include <linux/gfp.h>
27 #include <linux/usb.h>
28 #include <linux/usb/cdc.h>
29 #include <linux/netdevice.h>
30 #include <linux/if_arp.h>
31 #include <linux/if_phonet.h>
32 #include <linux/phonet.h>
34 #define PN_MEDIA_USB 0x1B
36 static const unsigned rxq_size = 17;
39 struct net_device *dev;
41 struct usb_interface *intf, *data_intf;
42 struct usb_device *usb;
43 unsigned int tx_pipe, rx_pipe;
51 struct sk_buff *rx_skb;
55 static void tx_complete(struct urb *req);
56 static void rx_complete(struct urb *req);
59 * Network device callbacks
61 static netdev_tx_t usbpn_xmit(struct sk_buff *skb, struct net_device *dev)
63 struct usbpn_dev *pnd = netdev_priv(dev);
64 struct urb *req = NULL;
68 if (skb->protocol != htons(ETH_P_PHONET))
71 req = usb_alloc_urb(0, GFP_ATOMIC);
74 usb_fill_bulk_urb(req, pnd->usb, pnd->tx_pipe, skb->data, skb->len,
76 req->transfer_flags = URB_ZERO_PACKET;
77 err = usb_submit_urb(req, GFP_ATOMIC);
83 spin_lock_irqsave(&pnd->tx_lock, flags);
85 if (pnd->tx_queue >= dev->tx_queue_len)
86 netif_stop_queue(dev);
87 spin_unlock_irqrestore(&pnd->tx_lock, flags);
92 dev->stats.tx_dropped++;
96 static void tx_complete(struct urb *req)
98 struct sk_buff *skb = req->context;
99 struct net_device *dev = skb->dev;
100 struct usbpn_dev *pnd = netdev_priv(dev);
101 int status = req->status;
106 dev->stats.tx_bytes += skb->len;
112 dev->stats.tx_aborted_errors++;
115 dev->stats.tx_errors++;
116 dev_dbg(&dev->dev, "TX error (%d)\n", status);
118 dev->stats.tx_packets++;
120 spin_lock_irqsave(&pnd->tx_lock, flags);
122 netif_wake_queue(dev);
123 spin_unlock_irqrestore(&pnd->tx_lock, flags);
125 dev_kfree_skb_any(skb);
129 static int rx_submit(struct usbpn_dev *pnd, struct urb *req, gfp_t gfp_flags)
131 struct net_device *dev = pnd->dev;
135 page = __dev_alloc_page(gfp_flags | __GFP_NOMEMALLOC);
139 usb_fill_bulk_urb(req, pnd->usb, pnd->rx_pipe, page_address(page),
140 PAGE_SIZE, rx_complete, dev);
141 req->transfer_flags = 0;
142 err = usb_submit_urb(req, gfp_flags);
144 dev_dbg(&dev->dev, "RX submit error (%d)\n", err);
150 static void rx_complete(struct urb *req)
152 struct net_device *dev = req->context;
153 struct usbpn_dev *pnd = netdev_priv(dev);
154 struct page *page = virt_to_page(req->transfer_buffer);
157 int status = req->status;
161 spin_lock_irqsave(&pnd->rx_lock, flags);
164 skb = pnd->rx_skb = netdev_alloc_skb(dev, 12);
166 /* Can't use pskb_pull() on page in IRQ */
167 skb_put_data(skb, page_address(page), 1);
168 skb_add_rx_frag(skb, skb_shinfo(skb)->nr_frags,
169 page, 1, req->actual_length,
174 skb_add_rx_frag(skb, skb_shinfo(skb)->nr_frags,
175 page, 0, req->actual_length,
179 if (req->actual_length < PAGE_SIZE)
180 pnd->rx_skb = NULL; /* Last fragment */
183 spin_unlock_irqrestore(&pnd->rx_lock, flags);
185 skb->protocol = htons(ETH_P_PHONET);
186 skb_reset_mac_header(skb);
189 dev->stats.rx_packets++;
190 dev->stats.rx_bytes += skb->len;
203 dev->stats.rx_over_errors++;
204 dev_dbg(&dev->dev, "RX overflow\n");
208 dev->stats.rx_crc_errors++;
212 dev->stats.rx_errors++;
217 rx_submit(pnd, req, GFP_ATOMIC);
220 static int usbpn_close(struct net_device *dev);
222 static int usbpn_open(struct net_device *dev)
224 struct usbpn_dev *pnd = netdev_priv(dev);
227 unsigned num = pnd->data_intf->cur_altsetting->desc.bInterfaceNumber;
229 err = usb_set_interface(pnd->usb, num, pnd->active_setting);
233 for (i = 0; i < rxq_size; i++) {
234 struct urb *req = usb_alloc_urb(0, GFP_KERNEL);
236 if (!req || rx_submit(pnd, req, GFP_KERNEL)) {
244 netif_wake_queue(dev);
248 static int usbpn_close(struct net_device *dev)
250 struct usbpn_dev *pnd = netdev_priv(dev);
252 unsigned num = pnd->data_intf->cur_altsetting->desc.bInterfaceNumber;
254 netif_stop_queue(dev);
256 for (i = 0; i < rxq_size; i++) {
257 struct urb *req = pnd->urbs[i];
266 return usb_set_interface(pnd->usb, num, !pnd->active_setting);
269 static int usbpn_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
271 struct if_phonet_req *req = (struct if_phonet_req *)ifr;
274 case SIOCPNGAUTOCONF:
275 req->ifr_phonet_autoconf.device = PN_DEV_PC;
281 static const struct net_device_ops usbpn_ops = {
282 .ndo_open = usbpn_open,
283 .ndo_stop = usbpn_close,
284 .ndo_start_xmit = usbpn_xmit,
285 .ndo_do_ioctl = usbpn_ioctl,
288 static void usbpn_setup(struct net_device *dev)
291 dev->netdev_ops = &usbpn_ops,
292 dev->header_ops = &phonet_header_ops;
293 dev->type = ARPHRD_PHONET;
294 dev->flags = IFF_POINTOPOINT | IFF_NOARP;
295 dev->mtu = PHONET_MAX_MTU;
296 dev->min_mtu = PHONET_MIN_MTU;
297 dev->max_mtu = PHONET_MAX_MTU;
298 dev->hard_header_len = 1;
299 dev->dev_addr[0] = PN_MEDIA_USB;
301 dev->tx_queue_len = 3;
303 dev->needs_free_netdev = true;
307 * USB driver callbacks
309 static const struct usb_device_id usbpn_ids[] = {
311 .match_flags = USB_DEVICE_ID_MATCH_VENDOR
312 | USB_DEVICE_ID_MATCH_INT_CLASS
313 | USB_DEVICE_ID_MATCH_INT_SUBCLASS,
314 .idVendor = 0x0421, /* Nokia */
315 .bInterfaceClass = USB_CLASS_COMM,
316 .bInterfaceSubClass = 0xFE,
321 MODULE_DEVICE_TABLE(usb, usbpn_ids);
323 static struct usb_driver usbpn_driver;
325 static int usbpn_probe(struct usb_interface *intf, const struct usb_device_id *id)
327 static const char ifname[] = "usbpn%d";
328 const struct usb_cdc_union_desc *union_header = NULL;
329 const struct usb_host_interface *data_desc;
330 struct usb_interface *data_intf;
331 struct usb_device *usbdev = interface_to_usbdev(intf);
332 struct net_device *dev;
333 struct usbpn_dev *pnd;
337 struct usb_cdc_parsed_header hdr;
339 data = intf->altsetting->extra;
340 len = intf->altsetting->extralen;
341 cdc_parse_cdc_header(&hdr, intf, data, len);
342 union_header = hdr.usb_cdc_union_desc;
343 phonet = hdr.phonet_magic_present;
345 if (!union_header || !phonet)
348 data_intf = usb_ifnum_to_if(usbdev, union_header->bSlaveInterface0);
349 if (data_intf == NULL)
351 /* Data interface has one inactive and one active setting */
352 if (data_intf->num_altsetting != 2)
354 if (data_intf->altsetting[0].desc.bNumEndpoints == 0 &&
355 data_intf->altsetting[1].desc.bNumEndpoints == 2)
356 data_desc = data_intf->altsetting + 1;
358 if (data_intf->altsetting[0].desc.bNumEndpoints == 2 &&
359 data_intf->altsetting[1].desc.bNumEndpoints == 0)
360 data_desc = data_intf->altsetting;
364 dev = alloc_netdev(sizeof(*pnd) + sizeof(pnd->urbs[0]) * rxq_size,
365 ifname, NET_NAME_UNKNOWN, usbpn_setup);
369 pnd = netdev_priv(dev);
370 SET_NETDEV_DEV(dev, &intf->dev);
375 pnd->data_intf = data_intf;
376 spin_lock_init(&pnd->tx_lock);
377 spin_lock_init(&pnd->rx_lock);
379 if (usb_pipein(data_desc->endpoint[0].desc.bEndpointAddress)) {
380 pnd->rx_pipe = usb_rcvbulkpipe(usbdev,
381 data_desc->endpoint[0].desc.bEndpointAddress);
382 pnd->tx_pipe = usb_sndbulkpipe(usbdev,
383 data_desc->endpoint[1].desc.bEndpointAddress);
385 pnd->rx_pipe = usb_rcvbulkpipe(usbdev,
386 data_desc->endpoint[1].desc.bEndpointAddress);
387 pnd->tx_pipe = usb_sndbulkpipe(usbdev,
388 data_desc->endpoint[0].desc.bEndpointAddress);
390 pnd->active_setting = data_desc - data_intf->altsetting;
392 err = usb_driver_claim_interface(&usbpn_driver, data_intf, pnd);
396 /* Force inactive mode until the network device is brought UP */
397 usb_set_interface(usbdev, union_header->bSlaveInterface0,
398 !pnd->active_setting);
399 usb_set_intfdata(intf, pnd);
401 err = register_netdev(dev);
403 /* Set disconnected flag so that disconnect() returns early. */
404 pnd->disconnected = 1;
405 usb_driver_release_interface(&usbpn_driver, data_intf);
409 dev_dbg(&dev->dev, "USB CDC Phonet device found\n");
413 usb_set_intfdata(intf, NULL);
418 static void usbpn_disconnect(struct usb_interface *intf)
420 struct usbpn_dev *pnd = usb_get_intfdata(intf);
422 if (pnd->disconnected)
425 pnd->disconnected = 1;
426 usb_driver_release_interface(&usbpn_driver,
427 (pnd->intf == intf) ? pnd->data_intf : pnd->intf);
428 unregister_netdev(pnd->dev);
431 static struct usb_driver usbpn_driver = {
432 .name = "cdc_phonet",
433 .probe = usbpn_probe,
434 .disconnect = usbpn_disconnect,
435 .id_table = usbpn_ids,
436 .disable_hub_initiated_lpm = 1,
439 module_usb_driver(usbpn_driver);
441 MODULE_AUTHOR("Remi Denis-Courmont");
442 MODULE_DESCRIPTION("USB CDC Phonet host interface");
443 MODULE_LICENSE("GPL");