The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/drivers/usb/serial/sierra.c

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*
    2   USB Driver for Sierra Wireless
    3 
    4   Copyright (C) 2006, 2007, 2008  Kevin Lloyd <klloyd@sierrawireless.com>,
    5 
    6   Copyright (C) 2008, 2009  Elina Pasheva, Matthew Safar, Rory Filer
    7                         <linux@sierrawireless.com>
    8 
    9   IMPORTANT DISCLAIMER: This driver is not commercially supported by
   10   Sierra Wireless. Use at your own risk.
   11 
   12   This driver is free software; you can redistribute it and/or modify
   13   it under the terms of Version 2 of the GNU General Public License as
   14   published by the Free Software Foundation.
   15 
   16   Portions based on the option driver by Matthias Urlichs <smurf@smurf.noris.de>
   17   Whom based his on the Keyspan driver by Hugh Blemings <hugh@blemings.org>
   18 */
   19 /* Uncomment to log function calls */
   20 /* #define DEBUG */
   21 
   22 #define DRIVER_AUTHOR "Kevin Lloyd, Elina Pasheva, Matthew Safar, Rory Filer"
   23 #define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
   24 
   25 #include <linux/kernel.h>
   26 #include <linux/jiffies.h>
   27 #include <linux/errno.h>
   28 #include <linux/tty.h>
   29 #include <linux/slab.h>
   30 #include <linux/tty_flip.h>
   31 #include <linux/module.h>
   32 #include <linux/usb.h>
   33 #include <linux/usb/serial.h>
   34 
   35 #define SWIMS_USB_REQUEST_SetPower      0x00
   36 #define SWIMS_USB_REQUEST_SetNmea       0x07
   37 
   38 #define N_IN_URB_HM     8
   39 #define N_OUT_URB_HM    64
   40 #define N_IN_URB        4
   41 #define N_OUT_URB       4
   42 #define IN_BUFLEN       4096
   43 
   44 #define MAX_TRANSFER            (PAGE_SIZE - 512)
   45 /* MAX_TRANSFER is chosen so that the VM is not stressed by
   46    allocations > PAGE_SIZE and the number of packets in a page
   47    is an integer 512 is the largest possible packet on EHCI */
   48 
   49 static bool nmea;
   50 
   51 /* Used in interface blacklisting */
   52 struct sierra_iface_info {
   53         const u32 infolen;      /* number of interface numbers on blacklist */
   54         const u8  *ifaceinfo;   /* pointer to the array holding the numbers */
   55 };
   56 
   57 struct sierra_intf_private {
   58         spinlock_t susp_lock;
   59         unsigned int suspended:1;
   60         int in_flight;
   61 };
   62 
   63 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
   64 {
   65         return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
   66                         SWIMS_USB_REQUEST_SetPower,     /* __u8 request      */
   67                         USB_TYPE_VENDOR,                /* __u8 request type */
   68                         swiState,                       /* __u16 value       */
   69                         0,                              /* __u16 index       */
   70                         NULL,                           /* void *data        */
   71                         0,                              /* __u16 size        */
   72                         USB_CTRL_SET_TIMEOUT);          /* int timeout       */
   73 }
   74 
   75 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
   76 {
   77         return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
   78                         SWIMS_USB_REQUEST_SetNmea,      /* __u8 request      */
   79                         USB_TYPE_VENDOR,                /* __u8 request type */
   80                         enable,                         /* __u16 value       */
   81                         0x0000,                         /* __u16 index       */
   82                         NULL,                           /* void *data        */
   83                         0,                              /* __u16 size        */
   84                         USB_CTRL_SET_TIMEOUT);          /* int timeout       */
   85 }
   86 
   87 static int sierra_calc_num_ports(struct usb_serial *serial)
   88 {
   89         int num_ports = 0;
   90         u8 ifnum, numendpoints;
   91 
   92         ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
   93         numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
   94 
   95         /* Dummy interface present on some SKUs should be ignored */
   96         if (ifnum == 0x99)
   97                 num_ports = 0;
   98         else if (numendpoints <= 3)
   99                 num_ports = 1;
  100         else
  101                 num_ports = (numendpoints-1)/2;
  102         return num_ports;
  103 }
  104 
  105 static int is_blacklisted(const u8 ifnum,
  106                                 const struct sierra_iface_info *blacklist)
  107 {
  108         const u8  *info;
  109         int i;
  110 
  111         if (blacklist) {
  112                 info = blacklist->ifaceinfo;
  113 
  114                 for (i = 0; i < blacklist->infolen; i++) {
  115                         if (info[i] == ifnum)
  116                                 return 1;
  117                 }
  118         }
  119         return 0;
  120 }
  121 
  122 static int is_himemory(const u8 ifnum,
  123                                 const struct sierra_iface_info *himemorylist)
  124 {
  125         const u8  *info;
  126         int i;
  127 
  128         if (himemorylist) {
  129                 info = himemorylist->ifaceinfo;
  130 
  131                 for (i=0; i < himemorylist->infolen; i++) {
  132                         if (info[i] == ifnum)
  133                                 return 1;
  134                 }
  135         }
  136         return 0;
  137 }
  138 
  139 static int sierra_calc_interface(struct usb_serial *serial)
  140 {
  141         int interface;
  142         struct usb_interface *p_interface;
  143         struct usb_host_interface *p_host_interface;
  144 
  145         /* Get the interface structure pointer from the serial struct */
  146         p_interface = serial->interface;
  147 
  148         /* Get a pointer to the host interface structure */
  149         p_host_interface = p_interface->cur_altsetting;
  150 
  151         /* read the interface descriptor for this active altsetting
  152          * to find out the interface number we are on
  153         */
  154         interface = p_host_interface->desc.bInterfaceNumber;
  155 
  156         return interface;
  157 }
  158 
  159 static int sierra_probe(struct usb_serial *serial,
  160                         const struct usb_device_id *id)
  161 {
  162         int result = 0;
  163         struct usb_device *udev;
  164         u8 ifnum;
  165 
  166         udev = serial->dev;
  167         ifnum = sierra_calc_interface(serial);
  168 
  169         /*
  170          * If this interface supports more than 1 alternate
  171          * select the 2nd one
  172          */
  173         if (serial->interface->num_altsetting == 2) {
  174                 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
  175                         ifnum);
  176                 /* We know the alternate setting is 1 for the MC8785 */
  177                 usb_set_interface(udev, ifnum, 1);
  178         }
  179 
  180         /* ifnum could have changed - by calling usb_set_interface */
  181         ifnum = sierra_calc_interface(serial);
  182 
  183         if (is_blacklisted(ifnum,
  184                                 (struct sierra_iface_info *)id->driver_info)) {
  185                 dev_dbg(&serial->dev->dev,
  186                         "Ignoring blacklisted interface #%d\n", ifnum);
  187                 return -ENODEV;
  188         }
  189 
  190         return result;
  191 }
  192 
  193 /* interfaces with higher memory requirements */
  194 static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
  195 static const struct sierra_iface_info typeA_interface_list = {
  196         .infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
  197         .ifaceinfo = hi_memory_typeA_ifaces,
  198 };
  199 
  200 static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
  201 static const struct sierra_iface_info typeB_interface_list = {
  202         .infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
  203         .ifaceinfo = hi_memory_typeB_ifaces,
  204 };
  205 
  206 /* 'blacklist' of interfaces not served by this driver */
  207 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11, 19, 20 };
  208 static const struct sierra_iface_info direct_ip_interface_blacklist = {
  209         .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
  210         .ifaceinfo = direct_ip_non_serial_ifaces,
  211 };
  212 
  213 static const struct usb_device_id id_table[] = {
  214         { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
  215         { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
  216         { USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
  217         { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
  218 
  219         { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
  220         { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
  221         { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
  222         { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
  223         { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
  224         { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
  225         { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
  226         { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
  227         { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
  228         { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
  229         { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
  230         { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
  231         { USB_DEVICE(0x1199, 0x0301) }, /* Sierra Wireless USB Dongle 250U */
  232         /* Sierra Wireless C597 */
  233         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
  234         /* Sierra Wireless T598 */
  235         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
  236         { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
  237         { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
  238         { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
  239         { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
  240 
  241         { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
  242         { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
  243         { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
  244         { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
  245         { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
  246         { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
  247         { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
  248         { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
  249         { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
  250         { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
  251         { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
  252         { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
  253         { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
  254         { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
  255         { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
  256         { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
  257         { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
  258         { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
  259         { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
  260         { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
  261         { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
  262         /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
  263         { USB_DEVICE(0x1199, 0x683C) },
  264         { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
  265         /* Sierra Wireless MC8790, MC8791, MC8792 */
  266         { USB_DEVICE(0x1199, 0x683E) },
  267         { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
  268         { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
  269         { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
  270         { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
  271         { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
  272         { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
  273         { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
  274         { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
  275         /* Sierra Wireless C885 */
  276         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
  277         /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
  278         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
  279         /* Sierra Wireless C22/C33 */
  280         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
  281         /* Sierra Wireless HSPA Non-Composite Device */
  282         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
  283         { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
  284         { USB_DEVICE(0x1199, 0x68A3),   /* Sierra Wireless Direct IP modems */
  285           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
  286         },
  287         /* AT&T Direct IP LTE modems */
  288         { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
  289           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
  290         },
  291         { USB_DEVICE(0x0f3d, 0x68A3),   /* Airprime/Sierra Wireless Direct IP modems */
  292           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
  293         },
  294        { USB_DEVICE(0x413C, 0x08133) }, /* Dell Computer Corp. Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */
  295 
  296         { }
  297 };
  298 MODULE_DEVICE_TABLE(usb, id_table);
  299 
  300 
  301 struct sierra_port_private {
  302         spinlock_t lock;        /* lock the structure */
  303         int outstanding_urbs;   /* number of out urbs in flight */
  304         struct usb_anchor active;
  305         struct usb_anchor delayed;
  306 
  307         int num_out_urbs;
  308         int num_in_urbs;
  309         /* Input endpoints and buffers for this port */
  310         struct urb *in_urbs[N_IN_URB_HM];
  311 
  312         /* Settings for the port */
  313         int rts_state;  /* Handshaking pins (outputs) */
  314         int dtr_state;
  315         int cts_state;  /* Handshaking pins (inputs) */
  316         int dsr_state;
  317         int dcd_state;
  318         int ri_state;
  319         unsigned int opened:1;
  320 };
  321 
  322 static int sierra_send_setup(struct usb_serial_port *port)
  323 {
  324         struct usb_serial *serial = port->serial;
  325         struct sierra_port_private *portdata;
  326         __u16 interface = 0;
  327         int val = 0;
  328         int do_send = 0;
  329         int retval;
  330 
  331         portdata = usb_get_serial_port_data(port);
  332 
  333         if (portdata->dtr_state)
  334                 val |= 0x01;
  335         if (portdata->rts_state)
  336                 val |= 0x02;
  337 
  338         /* If composite device then properly report interface */
  339         if (serial->num_ports == 1) {
  340                 interface = sierra_calc_interface(serial);
  341                 /* Control message is sent only to interfaces with
  342                  * interrupt_in endpoints
  343                  */
  344                 if (port->interrupt_in_urb) {
  345                         /* send control message */
  346                         do_send = 1;
  347                 }
  348         }
  349 
  350         /* Otherwise the need to do non-composite mapping */
  351         else {
  352                 if (port->bulk_out_endpointAddress == 2)
  353                         interface = 0;
  354                 else if (port->bulk_out_endpointAddress == 4)
  355                         interface = 1;
  356                 else if (port->bulk_out_endpointAddress == 5)
  357                         interface = 2;
  358 
  359                 do_send = 1;
  360         }
  361         if (!do_send)
  362                 return 0;
  363 
  364         retval = usb_autopm_get_interface(serial->interface);
  365         if (retval < 0)
  366                 return retval;
  367 
  368         retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
  369                 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
  370         usb_autopm_put_interface(serial->interface);
  371 
  372         return retval;
  373 }
  374 
  375 static void sierra_set_termios(struct tty_struct *tty,
  376                 struct usb_serial_port *port, struct ktermios *old_termios)
  377 {
  378         tty_termios_copy_hw(&tty->termios, old_termios);
  379         sierra_send_setup(port);
  380 }
  381 
  382 static int sierra_tiocmget(struct tty_struct *tty)
  383 {
  384         struct usb_serial_port *port = tty->driver_data;
  385         unsigned int value;
  386         struct sierra_port_private *portdata;
  387 
  388         portdata = usb_get_serial_port_data(port);
  389 
  390         value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
  391                 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
  392                 ((portdata->cts_state) ? TIOCM_CTS : 0) |
  393                 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
  394                 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
  395                 ((portdata->ri_state) ? TIOCM_RNG : 0);
  396 
  397         return value;
  398 }
  399 
  400 static int sierra_tiocmset(struct tty_struct *tty,
  401                         unsigned int set, unsigned int clear)
  402 {
  403         struct usb_serial_port *port = tty->driver_data;
  404         struct sierra_port_private *portdata;
  405 
  406         portdata = usb_get_serial_port_data(port);
  407 
  408         if (set & TIOCM_RTS)
  409                 portdata->rts_state = 1;
  410         if (set & TIOCM_DTR)
  411                 portdata->dtr_state = 1;
  412 
  413         if (clear & TIOCM_RTS)
  414                 portdata->rts_state = 0;
  415         if (clear & TIOCM_DTR)
  416                 portdata->dtr_state = 0;
  417         return sierra_send_setup(port);
  418 }
  419 
  420 static void sierra_release_urb(struct urb *urb)
  421 {
  422         struct usb_serial_port *port;
  423         if (urb) {
  424                 port = urb->context;
  425                 kfree(urb->transfer_buffer);
  426                 usb_free_urb(urb);
  427         }
  428 }
  429 
  430 static void sierra_outdat_callback(struct urb *urb)
  431 {
  432         struct usb_serial_port *port = urb->context;
  433         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
  434         struct sierra_intf_private *intfdata;
  435         int status = urb->status;
  436 
  437         intfdata = port->serial->private;
  438 
  439         /* free up the transfer buffer, as usb_free_urb() does not do this */
  440         kfree(urb->transfer_buffer);
  441         usb_autopm_put_interface_async(port->serial->interface);
  442         if (status)
  443                 dev_dbg(&port->dev, "%s - nonzero write bulk status "
  444                     "received: %d\n", __func__, status);
  445 
  446         spin_lock(&portdata->lock);
  447         --portdata->outstanding_urbs;
  448         spin_unlock(&portdata->lock);
  449         spin_lock(&intfdata->susp_lock);
  450         --intfdata->in_flight;
  451         spin_unlock(&intfdata->susp_lock);
  452 
  453         usb_serial_port_softint(port);
  454 }
  455 
  456 /* Write */
  457 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
  458                                         const unsigned char *buf, int count)
  459 {
  460         struct sierra_port_private *portdata;
  461         struct sierra_intf_private *intfdata;
  462         struct usb_serial *serial = port->serial;
  463         unsigned long flags;
  464         unsigned char *buffer;
  465         struct urb *urb;
  466         size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
  467         int retval = 0;
  468 
  469         /* verify that we actually have some data to write */
  470         if (count == 0)
  471                 return 0;
  472 
  473         portdata = usb_get_serial_port_data(port);
  474         intfdata = serial->private;
  475 
  476         dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
  477         spin_lock_irqsave(&portdata->lock, flags);
  478         dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
  479                 portdata->outstanding_urbs);
  480         if (portdata->outstanding_urbs > portdata->num_out_urbs) {
  481                 spin_unlock_irqrestore(&portdata->lock, flags);
  482                 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
  483                 return 0;
  484         }
  485         portdata->outstanding_urbs++;
  486         dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
  487                 portdata->outstanding_urbs);
  488         spin_unlock_irqrestore(&portdata->lock, flags);
  489 
  490         retval = usb_autopm_get_interface_async(serial->interface);
  491         if (retval < 0) {
  492                 spin_lock_irqsave(&portdata->lock, flags);
  493                 portdata->outstanding_urbs--;
  494                 spin_unlock_irqrestore(&portdata->lock, flags);
  495                 goto error_simple;
  496         }
  497 
  498         buffer = kmalloc(writesize, GFP_ATOMIC);
  499         if (!buffer) {
  500                 dev_err(&port->dev, "out of memory\n");
  501                 retval = -ENOMEM;
  502                 goto error_no_buffer;
  503         }
  504 
  505         urb = usb_alloc_urb(0, GFP_ATOMIC);
  506         if (!urb) {
  507                 dev_err(&port->dev, "no more free urbs\n");
  508                 retval = -ENOMEM;
  509                 goto error_no_urb;
  510         }
  511 
  512         memcpy(buffer, buf, writesize);
  513 
  514         usb_serial_debug_data(&port->dev, __func__, writesize, buffer);
  515 
  516         usb_fill_bulk_urb(urb, serial->dev,
  517                           usb_sndbulkpipe(serial->dev,
  518                                           port->bulk_out_endpointAddress),
  519                           buffer, writesize, sierra_outdat_callback, port);
  520 
  521         /* Handle the need to send a zero length packet */
  522         urb->transfer_flags |= URB_ZERO_PACKET;
  523 
  524         spin_lock_irqsave(&intfdata->susp_lock, flags);
  525 
  526         if (intfdata->suspended) {
  527                 usb_anchor_urb(urb, &portdata->delayed);
  528                 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
  529                 goto skip_power;
  530         } else {
  531                 usb_anchor_urb(urb, &portdata->active);
  532         }
  533         /* send it down the pipe */
  534         retval = usb_submit_urb(urb, GFP_ATOMIC);
  535         if (retval) {
  536                 usb_unanchor_urb(urb);
  537                 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
  538                 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
  539                         "with status = %d\n", __func__, retval);
  540                 goto error;
  541         } else {
  542                 intfdata->in_flight++;
  543                 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
  544         }
  545 
  546 skip_power:
  547         /* we are done with this urb, so let the host driver
  548          * really free it when it is finished with it */
  549         usb_free_urb(urb);
  550 
  551         return writesize;
  552 error:
  553         usb_free_urb(urb);
  554 error_no_urb:
  555         kfree(buffer);
  556 error_no_buffer:
  557         spin_lock_irqsave(&portdata->lock, flags);
  558         --portdata->outstanding_urbs;
  559         dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
  560                 portdata->outstanding_urbs);
  561         spin_unlock_irqrestore(&portdata->lock, flags);
  562         usb_autopm_put_interface_async(serial->interface);
  563 error_simple:
  564         return retval;
  565 }
  566 
  567 static void sierra_indat_callback(struct urb *urb)
  568 {
  569         int err;
  570         int endpoint;
  571         struct usb_serial_port *port;
  572         struct tty_struct *tty;
  573         unsigned char *data = urb->transfer_buffer;
  574         int status = urb->status;
  575 
  576         endpoint = usb_pipeendpoint(urb->pipe);
  577         port = urb->context;
  578 
  579         if (status) {
  580                 dev_dbg(&port->dev, "%s: nonzero status: %d on"
  581                         " endpoint %02x\n", __func__, status, endpoint);
  582         } else {
  583                 if (urb->actual_length) {
  584                         tty = tty_port_tty_get(&port->port);
  585                         if (tty) {
  586                                 tty_insert_flip_string(tty, data,
  587                                         urb->actual_length);
  588                                 tty_flip_buffer_push(tty);
  589 
  590                                 tty_kref_put(tty);
  591                                 usb_serial_debug_data(&port->dev, __func__,
  592                                                       urb->actual_length, data);
  593                         }
  594                 } else {
  595                         dev_dbg(&port->dev, "%s: empty read urb"
  596                                 " received\n", __func__);
  597                 }
  598         }
  599 
  600         /* Resubmit urb so we continue receiving */
  601         if (status != -ESHUTDOWN && status != -EPERM) {
  602                 usb_mark_last_busy(port->serial->dev);
  603                 err = usb_submit_urb(urb, GFP_ATOMIC);
  604                 if (err && err != -EPERM)
  605                         dev_err(&port->dev, "resubmit read urb failed."
  606                                 "(%d)\n", err);
  607         }
  608 }
  609 
  610 static void sierra_instat_callback(struct urb *urb)
  611 {
  612         int err;
  613         int status = urb->status;
  614         struct usb_serial_port *port =  urb->context;
  615         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
  616         struct usb_serial *serial = port->serial;
  617 
  618         dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
  619                 urb, port, portdata);
  620 
  621         if (status == 0) {
  622                 struct usb_ctrlrequest *req_pkt =
  623                                 (struct usb_ctrlrequest *)urb->transfer_buffer;
  624 
  625                 if (!req_pkt) {
  626                         dev_dbg(&port->dev, "%s: NULL req_pkt\n",
  627                                 __func__);
  628                         return;
  629                 }
  630                 if ((req_pkt->bRequestType == 0xA1) &&
  631                                 (req_pkt->bRequest == 0x20)) {
  632                         int old_dcd_state;
  633                         unsigned char signals = *((unsigned char *)
  634                                         urb->transfer_buffer +
  635                                         sizeof(struct usb_ctrlrequest));
  636                         struct tty_struct *tty;
  637 
  638                         dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
  639                                 signals);
  640 
  641                         old_dcd_state = portdata->dcd_state;
  642                         portdata->cts_state = 1;
  643                         portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
  644                         portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
  645                         portdata->ri_state = ((signals & 0x08) ? 1 : 0);
  646 
  647                         tty = tty_port_tty_get(&port->port);
  648                         if (tty && !C_CLOCAL(tty) &&
  649                                         old_dcd_state && !portdata->dcd_state)
  650                                 tty_hangup(tty);
  651                         tty_kref_put(tty);
  652                 } else {
  653                         dev_dbg(&port->dev, "%s: type %x req %x\n",
  654                                 __func__, req_pkt->bRequestType,
  655                                 req_pkt->bRequest);
  656                 }
  657         } else
  658                 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
  659 
  660         /* Resubmit urb so we continue receiving IRQ data */
  661         if (status != -ESHUTDOWN && status != -ENOENT) {
  662                 usb_mark_last_busy(serial->dev);
  663                 err = usb_submit_urb(urb, GFP_ATOMIC);
  664                 if (err && err != -EPERM)
  665                         dev_err(&port->dev, "%s: resubmit intr urb "
  666                                 "failed. (%d)\n", __func__, err);
  667         }
  668 }
  669 
  670 static int sierra_write_room(struct tty_struct *tty)
  671 {
  672         struct usb_serial_port *port = tty->driver_data;
  673         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
  674         unsigned long flags;
  675 
  676         /* try to give a good number back based on if we have any free urbs at
  677          * this point in time */
  678         spin_lock_irqsave(&portdata->lock, flags);
  679         if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
  680                 spin_unlock_irqrestore(&portdata->lock, flags);
  681                 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
  682                 return 0;
  683         }
  684         spin_unlock_irqrestore(&portdata->lock, flags);
  685 
  686         return 2048;
  687 }
  688 
  689 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
  690 {
  691         int i;
  692         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
  693 
  694         for (i = 0; i < portdata->num_in_urbs; i++)
  695                 usb_kill_urb(portdata->in_urbs[i]);
  696 
  697         usb_kill_urb(port->interrupt_in_urb);
  698 }
  699 
  700 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
  701 {
  702         int ok_cnt;
  703         int err = -EINVAL;
  704         int i;
  705         struct urb *urb;
  706         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
  707 
  708         ok_cnt = 0;
  709         for (i = 0; i < portdata->num_in_urbs; i++) {
  710                 urb = portdata->in_urbs[i];
  711                 if (!urb)
  712                         continue;
  713                 err = usb_submit_urb(urb, mem_flags);
  714                 if (err) {
  715                         dev_err(&port->dev, "%s: submit urb failed: %d\n",
  716                                 __func__, err);
  717                 } else {
  718                         ok_cnt++;
  719                 }
  720         }
  721 
  722         if (ok_cnt && port->interrupt_in_urb) {
  723                 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
  724                 if (err) {
  725                         dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
  726                                 __func__, err);
  727                 }
  728         }
  729 
  730         if (ok_cnt > 0) /* at least one rx urb submitted */
  731                 return 0;
  732         else
  733                 return err;
  734 }
  735 
  736 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
  737                                         int dir, void *ctx, int len,
  738                                         gfp_t mem_flags,
  739                                         usb_complete_t callback)
  740 {
  741         struct urb      *urb;
  742         u8              *buf;
  743 
  744         if (endpoint == -1)
  745                 return NULL;
  746 
  747         urb = usb_alloc_urb(0, mem_flags);
  748         if (urb == NULL) {
  749                 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
  750                         __func__, endpoint);
  751                 return NULL;
  752         }
  753 
  754         buf = kmalloc(len, mem_flags);
  755         if (buf) {
  756                 /* Fill URB using supplied data */
  757                 usb_fill_bulk_urb(urb, serial->dev,
  758                         usb_sndbulkpipe(serial->dev, endpoint) | dir,
  759                         buf, len, callback, ctx);
  760 
  761                 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
  762                                 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
  763         } else {
  764                 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
  765                                 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
  766 
  767                 sierra_release_urb(urb);
  768                 urb = NULL;
  769         }
  770 
  771         return urb;
  772 }
  773 
  774 static void sierra_close(struct usb_serial_port *port)
  775 {
  776         int i;
  777         struct usb_serial *serial = port->serial;
  778         struct sierra_port_private *portdata;
  779         struct sierra_intf_private *intfdata = port->serial->private;
  780 
  781         portdata = usb_get_serial_port_data(port);
  782 
  783         portdata->rts_state = 0;
  784         portdata->dtr_state = 0;
  785 
  786         if (serial->dev) {
  787                 mutex_lock(&serial->disc_mutex);
  788                 if (!serial->disconnected) {
  789                         serial->interface->needs_remote_wakeup = 0;
  790                         /* odd error handling due to pm counters */
  791                         if (!usb_autopm_get_interface(serial->interface))
  792                                 sierra_send_setup(port);
  793                         else
  794                                 usb_autopm_get_interface_no_resume(serial->interface);
  795                                 
  796                 }
  797                 mutex_unlock(&serial->disc_mutex);
  798                 spin_lock_irq(&intfdata->susp_lock);
  799                 portdata->opened = 0;
  800                 spin_unlock_irq(&intfdata->susp_lock);
  801 
  802 
  803                 /* Stop reading urbs */
  804                 sierra_stop_rx_urbs(port);
  805                 /* .. and release them */
  806                 for (i = 0; i < portdata->num_in_urbs; i++) {
  807                         sierra_release_urb(portdata->in_urbs[i]);
  808                         portdata->in_urbs[i] = NULL;
  809                 }
  810         }
  811 }
  812 
  813 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
  814 {
  815         struct sierra_port_private *portdata;
  816         struct usb_serial *serial = port->serial;
  817         struct sierra_intf_private *intfdata = serial->private;
  818         int i;
  819         int err;
  820         int endpoint;
  821         struct urb *urb;
  822 
  823         portdata = usb_get_serial_port_data(port);
  824 
  825         /* Set some sane defaults */
  826         portdata->rts_state = 1;
  827         portdata->dtr_state = 1;
  828 
  829 
  830         endpoint = port->bulk_in_endpointAddress;
  831         for (i = 0; i < portdata->num_in_urbs; i++) {
  832                 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
  833                                         IN_BUFLEN, GFP_KERNEL,
  834                                         sierra_indat_callback);
  835                 portdata->in_urbs[i] = urb;
  836         }
  837         /* clear halt condition */
  838         usb_clear_halt(serial->dev,
  839                         usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
  840 
  841         err = sierra_submit_rx_urbs(port, GFP_KERNEL);
  842         if (err) {
  843                 /* get rid of everything as in close */
  844                 sierra_close(port);
  845                 /* restore balance for autopm */
  846                 if (!serial->disconnected)
  847                         usb_autopm_put_interface(serial->interface);
  848                 return err;
  849         }
  850         sierra_send_setup(port);
  851 
  852         serial->interface->needs_remote_wakeup = 1;
  853         spin_lock_irq(&intfdata->susp_lock);
  854         portdata->opened = 1;
  855         spin_unlock_irq(&intfdata->susp_lock);
  856         usb_autopm_put_interface(serial->interface);
  857 
  858         return 0;
  859 }
  860 
  861 
  862 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
  863 {
  864         struct usb_serial *serial = port->serial;
  865         struct sierra_port_private *portdata;
  866 
  867         portdata = usb_get_serial_port_data(port);
  868         portdata->rts_state = on;
  869         portdata->dtr_state = on;
  870 
  871         if (serial->dev) {
  872                 mutex_lock(&serial->disc_mutex);
  873                 if (!serial->disconnected)
  874                         sierra_send_setup(port);
  875                 mutex_unlock(&serial->disc_mutex);
  876         }
  877 }
  878 
  879 static int sierra_startup(struct usb_serial *serial)
  880 {
  881         struct sierra_intf_private *intfdata;
  882 
  883         intfdata = kzalloc(sizeof(*intfdata), GFP_KERNEL);
  884         if (!intfdata)
  885                 return -ENOMEM;
  886 
  887         spin_lock_init(&intfdata->susp_lock);
  888 
  889         usb_set_serial_data(serial, intfdata);
  890 
  891         /* Set Device mode to D0 */
  892         sierra_set_power_state(serial->dev, 0x0000);
  893 
  894         /* Check NMEA and set */
  895         if (nmea)
  896                 sierra_vsc_set_nmea(serial->dev, 1);
  897 
  898         return 0;
  899 }
  900 
  901 static void sierra_release(struct usb_serial *serial)
  902 {
  903         struct sierra_intf_private *intfdata;
  904 
  905         intfdata = usb_get_serial_data(serial);
  906         kfree(intfdata);
  907 }
  908 
  909 static int sierra_port_probe(struct usb_serial_port *port)
  910 {
  911         struct usb_serial *serial = port->serial;
  912         struct sierra_port_private *portdata;
  913         const struct sierra_iface_info *himemoryp;
  914         u8 ifnum;
  915 
  916         portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
  917         if (!portdata)
  918                 return -ENOMEM;
  919 
  920         spin_lock_init(&portdata->lock);
  921         init_usb_anchor(&portdata->active);
  922         init_usb_anchor(&portdata->delayed);
  923 
  924         /* Assume low memory requirements */
  925         portdata->num_out_urbs = N_OUT_URB;
  926         portdata->num_in_urbs  = N_IN_URB;
  927 
  928         /* Determine actual memory requirements */
  929         if (serial->num_ports == 1) {
  930                 /* Get interface number for composite device */
  931                 ifnum = sierra_calc_interface(serial);
  932                 himemoryp = &typeB_interface_list;
  933         } else {
  934                 /* This is really the usb-serial port number of the interface
  935                  * rather than the interface number.
  936                  */
  937                 ifnum = port->number - serial->minor;
  938                 himemoryp = &typeA_interface_list;
  939         }
  940 
  941         if (is_himemory(ifnum, himemoryp)) {
  942                 portdata->num_out_urbs = N_OUT_URB_HM;
  943                 portdata->num_in_urbs  = N_IN_URB_HM;
  944         }
  945 
  946         dev_dbg(&port->dev,
  947                         "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
  948                         ifnum, portdata->num_in_urbs, portdata->num_out_urbs);
  949 
  950         usb_set_serial_port_data(port, portdata);
  951 
  952         return 0;
  953 }
  954 
  955 static int sierra_port_remove(struct usb_serial_port *port)
  956 {
  957         struct sierra_port_private *portdata;
  958 
  959         portdata = usb_get_serial_port_data(port);
  960         kfree(portdata);
  961 
  962         return 0;
  963 }
  964 
  965 #ifdef CONFIG_PM
  966 static void stop_read_write_urbs(struct usb_serial *serial)
  967 {
  968         int i;
  969         struct usb_serial_port *port;
  970         struct sierra_port_private *portdata;
  971 
  972         /* Stop reading/writing urbs */
  973         for (i = 0; i < serial->num_ports; ++i) {
  974                 port = serial->port[i];
  975                 portdata = usb_get_serial_port_data(port);
  976                 sierra_stop_rx_urbs(port);
  977                 usb_kill_anchored_urbs(&portdata->active);
  978         }
  979 }
  980 
  981 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
  982 {
  983         struct sierra_intf_private *intfdata;
  984         int b;
  985 
  986         if (PMSG_IS_AUTO(message)) {
  987                 intfdata = serial->private;
  988                 spin_lock_irq(&intfdata->susp_lock);
  989                 b = intfdata->in_flight;
  990 
  991                 if (b) {
  992                         spin_unlock_irq(&intfdata->susp_lock);
  993                         return -EBUSY;
  994                 } else {
  995                         intfdata->suspended = 1;
  996                         spin_unlock_irq(&intfdata->susp_lock);
  997                 }
  998         }
  999         stop_read_write_urbs(serial);
 1000 
 1001         return 0;
 1002 }
 1003 
 1004 static int sierra_resume(struct usb_serial *serial)
 1005 {
 1006         struct usb_serial_port *port;
 1007         struct sierra_intf_private *intfdata = serial->private;
 1008         struct sierra_port_private *portdata;
 1009         struct urb *urb;
 1010         int ec = 0;
 1011         int i, err;
 1012 
 1013         spin_lock_irq(&intfdata->susp_lock);
 1014         for (i = 0; i < serial->num_ports; i++) {
 1015                 port = serial->port[i];
 1016                 portdata = usb_get_serial_port_data(port);
 1017 
 1018                 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
 1019                         usb_anchor_urb(urb, &portdata->active);
 1020                         intfdata->in_flight++;
 1021                         err = usb_submit_urb(urb, GFP_ATOMIC);
 1022                         if (err < 0) {
 1023                                 intfdata->in_flight--;
 1024                                 usb_unanchor_urb(urb);
 1025                                 usb_scuttle_anchored_urbs(&portdata->delayed);
 1026                                 break;
 1027                         }
 1028                 }
 1029 
 1030                 if (portdata->opened) {
 1031                         err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
 1032                         if (err)
 1033                                 ec++;
 1034                 }
 1035         }
 1036         intfdata->suspended = 0;
 1037         spin_unlock_irq(&intfdata->susp_lock);
 1038 
 1039         return ec ? -EIO : 0;
 1040 }
 1041 
 1042 #else
 1043 #define sierra_suspend NULL
 1044 #define sierra_resume NULL
 1045 #endif
 1046 
 1047 static struct usb_serial_driver sierra_device = {
 1048         .driver = {
 1049                 .owner =        THIS_MODULE,
 1050                 .name =         "sierra",
 1051         },
 1052         .description       = "Sierra USB modem",
 1053         .id_table          = id_table,
 1054         .calc_num_ports    = sierra_calc_num_ports,
 1055         .probe             = sierra_probe,
 1056         .open              = sierra_open,
 1057         .close             = sierra_close,
 1058         .dtr_rts           = sierra_dtr_rts,
 1059         .write             = sierra_write,
 1060         .write_room        = sierra_write_room,
 1061         .set_termios       = sierra_set_termios,
 1062         .tiocmget          = sierra_tiocmget,
 1063         .tiocmset          = sierra_tiocmset,
 1064         .attach            = sierra_startup,
 1065         .release           = sierra_release,
 1066         .port_probe        = sierra_port_probe,
 1067         .port_remove       = sierra_port_remove,
 1068         .suspend           = sierra_suspend,
 1069         .resume            = sierra_resume,
 1070         .read_int_callback = sierra_instat_callback,
 1071 };
 1072 
 1073 static struct usb_serial_driver * const serial_drivers[] = {
 1074         &sierra_device, NULL
 1075 };
 1076 
 1077 module_usb_serial_driver(serial_drivers, id_table);
 1078 
 1079 MODULE_AUTHOR(DRIVER_AUTHOR);
 1080 MODULE_DESCRIPTION(DRIVER_DESC);
 1081 MODULE_LICENSE("GPL");
 1082 
 1083 module_param(nmea, bool, S_IRUGO | S_IWUSR);
 1084 MODULE_PARM_DESC(nmea, "NMEA streaming");

Cache object: 79bd632b5a29f0cb78132e1f673cc73b


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.