/*
  USB Driver for Sierra Wireless

  Copyright (C) 2006, 2007, 2008  Kevin Lloyd <klloyd@sierrawireless.com>,

  Copyright (C) 2008 - 2016  Elina Pasheva, Matthew Safar, Rory Filer
			<linux@sierrawireless.com>

  IMPORTANT DISCLAIMER: This driver is not commercially supported by
  Sierra Wireless. Use at your own risk.

  This driver is free software; you can redistribute it and/or modify
  it under the terms of Version 2 of the GNU General Public License as
  published by the Free Software Foundation.

  Portions based on the option driver by Matthias Urlichs <smurf@smurf.noris.de>
  Whom based his on the Keyspan driver by Hugh Blemings <hugh@blemings.org>
*/
/* Uncomment to log function calls */
/* #define DEBUG 
/* Uncomment to force power level set to auto when attaching a device */
/* #define POWER_LEVEL_AUTO*/

/* Sierra driver for kernel 2.6.35 to kernel-3.0 */
/* Note: This is 'combined' usb serial driver developed specifically for Android
 * platform. This driver handles the usb serial interfaces of QMI/Gobi3K devices
 * in addition to the devices handled by the 'traditional' sierra driver.
 * When this driver is used GobiSerial driver must be removed to avoid
 * duplication!
 */
#define DRIVER_VERSION "v.1.7.47_android_generic_2"
#define DRIVER_AUTHOR "Kevin Lloyd, Elina Pasheva, Matthew Safar, Rory Filer"
#define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"


#include <linux/version.h>
#include <linux/kernel.h>
#include <linux/jiffies.h>
#include <linux/errno.h>
#include <linux/tty.h>
#include <linux/slab.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
#include <linux/usb.h>
#include <linux/usb/serial.h>
#include <asm/unaligned.h>

#define SWIMS_USB_REQUEST_SetPower	0x00
#define SWIMS_USB_REQUEST_GetFwAttr	0x06
#define SWIMS_USB_REQUEST_SetNmea	0x07
#define USB_REQUEST_TYPE_CLASS		0xA1
#define USB_REQUEST_IFACE		0x20

#define N_IN_URB_HM	8
#define N_OUT_URB_HM	64
#define N_IN_URB	4
#define N_OUT_URB	4
#define IN_BUFLEN	4096

#define MAX_TRANSFER		(PAGE_SIZE - 512)
/* MAX_TRANSFER is chosen so that the VM is not stressed by
   allocations > PAGE_SIZE and the number of packets in a page
   is an integer 512 is the largest possible packet on EHCI */

#define SWI_FW_ATTR_PM_MASK		0x02
/* PORTION_LEN defines the length of device attribute buffer */
#define PORTION_LEN			4096
static bool debug;
static bool nmea;

/* sysfs attributes */
static int sierra_create_sysfs_attrs(struct usb_serial_port *port);
static int sierra_remove_sysfs_attrs(struct usb_serial_port *port);
/* Used in interface blacklisting */
struct sierra_iface_info {
	const u32 infolen;	/* number of interface numbers on blacklist */
	const u8  *ifaceinfo;	/* pointer to the array holding the numbers */
};

/* per interface statistics */
struct sierra_intf_stats {
	atomic_t	rx_bytes;		/* received bytes */
	atomic_t	indat_cb_cnt;		/* indat callback count */
	atomic_t	indat_cb_fail;		/* indat cb with error */
	atomic_t	tx_bytes;		/* transmitted bytes */
	atomic_t	write_cnt;		/* no. of writes */
	atomic_t	write_err;		/* no. of failed writes */
	atomic_t	delayed_writes;		/* no. of delayed writes */
	atomic_t	delayed_write_err;	/* no. of delayed write errs */
	atomic_t	outdat_cb_cnt;		/* outdat callback count */
	atomic_t	outdat_cb_fail;		/* outdat cb with error */
};
struct sierra_intf_private {
	spinlock_t susp_lock;
	unsigned int suspended:1;
	int in_flight;
	struct sierra_intf_stats stats;
};

/* Determine if we are in a particular kernel series */
#define KERNEL_SERIES(x, y) \
	((LINUX_VERSION_CODE >> 8) == (KERNEL_VERSION( x,y,0 ) >> 8))

#if ((KERNEL_SERIES( 3,4 ) && LINUX_VERSION_CODE >= KERNEL_VERSION( 3,4,34 )) || \
     (KERNEL_SERIES( 3,2 ) && LINUX_VERSION_CODE >= KERNEL_VERSION( 3,2,0 )) || \
     (KERNEL_SERIES( 3,5 ) && LINUX_VERSION_CODE >= KERNEL_VERSION( 3,5,0 )) || \
     (KERNEL_SERIES( 3,7 ) && LINUX_VERSION_CODE >= KERNEL_VERSION( 3,7,10 )) || \
     (KERNEL_SERIES( 3,8 ) && LINUX_VERSION_CODE >= KERNEL_VERSION( 3,8,1) ) || \
     (LINUX_VERSION_CODE >= KERNEL_VERSION( 3,8,1) ))
    /* workaround for upstream commit b2ca699076573c94fee9a73cb0d8645383b602a0 */
    #warning "Assuming disc_mutex is locked external to the module"
    static inline void sierra_lock_disc_mutex(struct usb_serial *serial) {
        if (LINUX_VERSION_CODE < KERNEL_VERSION( 3,12,0) )
        {
            WARN_ON(!mutex_is_locked(&serial->disc_mutex));
        }
    }
    static inline void sierra_unlock_disc_mutex(struct usb_serial *serial) {}
    
#else
    /* use the legacy method of locking disc_mutex in this driver */
    #warning "Using legacy method of locking disc_mutex"
    static inline void sierra_lock_disc_mutex(struct usb_serial *serial) {
       mutex_lock(&serial->disc_mutex);
    }
    
    static inline void sierra_unlock_disc_mutex(struct usb_serial *serial) {
       mutex_unlock(&serial->disc_mutex);
    }
#endif

static int is_qmi_gobi_device(struct usb_device *udev)
{
	switch (udev->descriptor.idProduct)
	{
        case 0x9091: /* EM/MC75xx APP*/
        case 0x90b1:
        case 0x90c1:
        case 0x9090: /* EM/MC75xx boot */
        case 0x90b0:
        case 0x90c0:
        case 0x9070: /* EM/MC74xx boot */
        case 0x9071: /* EM/MC74xx app */
        case 0x9040: /* Gobi 5K QDL */
	    case 0x9041: /* Gobi 5K */
	    case 0x68C0: /* Gobi 5K */
	  	case 0x920c: /* Gobi 3000 QDL */
		case 0x920d: /* Gobi 3000 Composite */
		case 0x68A2:
		case 0x9010:
		case 0x9011:
		case 0x9012:
		case 0x9013:
		case 0x9014:
		case 0x9015:
		case 0x9018:
		case 0x9019:
		case 0x361D:
		case 0x371D:
			return 1;
			break;
		default:
			return 0;
			break;
	}
	return 0;
}
static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
{
	int result;
	dev_dbg(&udev->dev, "%s\n", __func__);
	result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
			SWIMS_USB_REQUEST_SetPower,	/* __u8 request      */
			USB_TYPE_VENDOR,		/* __u8 request type */
			swiState,			/* __u16 value       */
			0,				/* __u16 index       */
			NULL,				/* void *data        */
			0,				/* __u16 size 	     */
			USB_CTRL_SET_TIMEOUT);		/* int timeout 	     */
	return result;
}

static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
{
	int result = 0; /* assume successful return */
	dev_dbg(&udev->dev, "%s\n", __func__);
	/* exclude QMI and Gobi devices */
	switch (udev->descriptor.idProduct)
	{
        case 0x9091: /* EM/MC75xx APP*/
        case 0x90b1:
        case 0x90c1:
        case 0x9090: /* EM/MC75xx boot */        
        case 0x90b0:
        case 0x90c0:
        case 0x9070: /* EM/MC74xx boot */
        case 0x9071: /* EM/MC74xx app */
        case 0x9040: /* Gobi 5K QDL */
	    case 0x9041: /* Gobi 5K */
	    case 0x68C0: /* Gobi 5K */
		case 0x920c: /* Gobi 3000 QDL */
		case 0x920d: /* Gobi 3000 Composite */
		case 0x68A2:
		case 0x9010:
		case 0x9011:
		case 0x9012:
		case 0x9013:
		case 0x9014:
		case 0x9015:
		case 0x9018:
		case 0x9019:
		case 0x361D:
		case 0x371D:
			/* For these GPS will be enabled with different command 
		 	 * during port open
		 	 */
			break;
		default:
			/* Send vendor specific command to enable NMEA */
			result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
			SWIMS_USB_REQUEST_SetNmea,	/* __u8 request      */
			USB_TYPE_VENDOR,		/* __u8 request type */
			enable,				/* __u16 value       */
			0x0000,				/* __u16 index       */
			NULL,				/* void *data        */
			0,				/* __u16 size 	     */
			USB_CTRL_SET_TIMEOUT);		/* int timeout       */
			break;
	}
	return result;
}
static int sierra_get_fw_attr(struct usb_device *udev, u16 *data)
{
	int result;
	u16 *attrdata;
	dev_dbg(&udev->dev, "%s\n", __func__);
	attrdata = kmalloc(sizeof(*attrdata), GFP_KERNEL);
	if (!attrdata)
		return -ENOMEM;
	result = usb_control_msg(udev,
				usb_rcvctrlpipe(udev, 0),
				SWIMS_USB_REQUEST_GetFwAttr,	/* __u8 request*/
				USB_TYPE_VENDOR | USB_DIR_IN,	/* request type*/
				0x0000,			/* __u16 value       */
				0x0000,			/* __u16 index       */
				attrdata,		/* void *data        */
				sizeof(*attrdata),	/* _u16 size         */
				USB_CTRL_SET_TIMEOUT);	/* in timeout        */
	if (result < 0) {
		kfree(attrdata);
		return -EIO;
	}
	*data = *attrdata;
	kfree(attrdata);
	return result;
}

static int sierra_calc_num_ports(struct usb_serial *serial)
{
	int num_ports = 0;
	u8 ifnum, numendpoints;

	dev_dbg(&serial->dev->dev, "%s\n", __func__);
	ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
	numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;

	/* Dummy interface present on some SKUs should be ignored */
	if (ifnum == 0x99)
		num_ports = 0;
	else if (numendpoints <= 3)
		num_ports = 1;
	else
		num_ports = (numendpoints-1)/2;
	return num_ports;
}

static int is_blacklisted(const u8 ifnum,
				const struct sierra_iface_info *blacklist)
{
	const u8  *info;
	int i;

	if (blacklist) {
		info = blacklist->ifaceinfo;

		for (i = 0; i < blacklist->infolen; i++) {
			if (info[i] == ifnum)
				return 1;
		}
	}
	return 0;
}

static int is_himemory(const u8 ifnum,
				const struct sierra_iface_info *himemorylist)
{
	const u8  *info;
	int i;

	if (himemorylist) {
		info = himemorylist->ifaceinfo;

		for (i=0; i < himemorylist->infolen; i++) {
			if (info[i] == ifnum)
				return 1;
		}
	}
	return 0;
}

static int sierra_calc_interface(struct usb_serial *serial)
{
	int interface;
	struct usb_interface *p_interface;
	struct usb_host_interface *p_host_interface;

	/* Get the interface structure pointer from the serial struct */
	p_interface = serial->interface;

	/* Get a pointer to the host interface structure */
	p_host_interface = p_interface->cur_altsetting;

	/* read the interface descriptor for this active altsetting
	 * to find out the interface number we are on */
	interface = p_host_interface->desc.bInterfaceNumber;

	return interface;
}

static int is_gps_port_qmi_gobi(struct usb_serial_port *   pPort )
{
    switch (cpu_to_le16(pPort->serial->dev->descriptor.idProduct))
	{
	        case 0x9071: /* EM/MC74xx app */
	        case 0x9041:  /* Gobi 5K */
	        case 0x68C0:  /* Gobi 5K */
			case 0x68A2:  /* Sierra Wireless QMI */
				if (pPort->serial->interface->cur_altsetting->desc.bInterfaceNumber == 2)
					return 1;
				break;
	        case 0x9091: /* EM/MC75xx APP*/
	        case 0x90B1: /* EM/MC75xx APP*/
	        case 0x90C1: /* EM/MC75xx APP*/
                {
                    struct usb_host_config  *usb_cfg = NULL;
                    bool bDiag_0_ifc = 0;
                    u8 i;
                    usb_cfg = pPort->serial->dev->actconfig;
                    for (i = 0; i < usb_cfg->desc.bNumInterfaces; i++)
                    {
                        if (usb_cfg->interface[i]->cur_altsetting->desc.bInterfaceNumber == 0)
                        {
                            bDiag_0_ifc = 1;
                            break;
                        }
                    }
                    if (bDiag_0_ifc)
                    {
                        if (pPort->serial->interface->cur_altsetting->desc.bInterfaceNumber == 2)
                            return 1;
                    }
                    else
                    {
                        if (pPort->serial->interface->cur_altsetting->desc.bInterfaceNumber == 3)
                            return 1;
                    }
                }
                break;                
			/* Check PIDs indicating non-boot mode */
			case 0x9011:  /* Sierra Wireless G3K */
			case 0x9013:  /* Sierra Wireless G3K */
			case 0x9015:  /* Sierra Wireless G3K */
			case 0x9019:  /* Sierra Wireless G3K */
			case 0x371D:  /* G3K */
				if (pPort->serial->interface->cur_altsetting->desc.bInterfaceNumber == 3)
					return 1;
				break;
		default:
			return 0;
			break;
	}
	return 0;
}

static int is_gps_port_directip(struct usb_serial_port *   pPort )
{
    switch (pPort->serial->dev->descriptor.idProduct)
    {
    case 0x68A3:  
        if (pPort->serial->interface->cur_altsetting->desc.bInterfaceNumber == 2)
	        return 1;
	break;
    default:
        return 0;
	break;
    }
    return 0;
}

static int sierra_probe(struct usb_serial *serial,
			const struct usb_device_id *id)
{
	int result = 0;
	struct usb_device *udev;
	struct sierra_intf_private *intfdata;
	u8 ifnum;

	udev = serial->dev;
	dev_dbg(&udev->dev, "%s\n", __func__);

    if (serial->interface->cur_altsetting->desc.bInterfaceClass != USB_CLASS_VENDOR_SPEC )
    {
        dev_dbg(&serial->dev->dev,
            "Ignoring non-vendor specific interface class #%d\n", 
            serial->interface->cur_altsetting->desc.bInterfaceClass);
        return -ENODEV;
    }    
    
	ifnum = sierra_calc_interface(serial);
	/*
	 * If this interface supports more than 1 alternate
	 * select the 2nd one
	 */
	if (serial->interface->num_altsetting == 2) {
		dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
			ifnum);
		/* We know the alternate setting is for composite USB interface
		 * modems
		 */
		usb_set_interface(udev, ifnum, 1);
	}

	/* ifnum could have changed - by calling usb_set_interface */
	ifnum = sierra_calc_interface(serial);

	if (is_blacklisted(ifnum,
				(struct sierra_iface_info *)id->driver_info)) {
		dev_dbg(&serial->dev->dev,
			"Ignoring blacklisted interface #%d\n", ifnum);
		return -ENODEV;
	}

	intfdata = serial->private = kzalloc(sizeof(struct sierra_intf_private),
						GFP_KERNEL);
	if (!intfdata)
		return -ENOMEM;
	spin_lock_init(&intfdata->susp_lock);
	return result;
}

/* interfaces with higher memory requirements */
static const u8 hi_memory_typeA_ifaces[] = { 0 };
static const struct sierra_iface_info typeA_interface_list = {
	.infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
	.ifaceinfo = hi_memory_typeA_ifaces,
};

static const u8 hi_memory_typeB_ifaces[] = { 2, 3, 4, 5, 6 };
static const struct sierra_iface_info typeB_interface_list = {
	.infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
	.ifaceinfo = hi_memory_typeB_ifaces,
};

/* 'blacklist' of interfaces not served by this driver */
static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11 };
static const struct sierra_iface_info direct_ip_interface_blacklist = {
	.infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
	.ifaceinfo = direct_ip_non_serial_ifaces,
};


static const signed char qmi_non_serial_ifaces[]  = { 8 , 10, 11};
static const struct sierra_iface_info qmi_interface_blacklist = {
	.infolen = ARRAY_SIZE( qmi_non_serial_ifaces ),
	.ifaceinfo = qmi_non_serial_ifaces,
};

static const signed char qmi_9x15_non_serial_ifaces[]  = {1,4,5,8,10,11,19,20};
static const struct sierra_iface_info qmi_9x15_interface_blacklist = {
	.infolen = ARRAY_SIZE( qmi_9x15_non_serial_ifaces ),
	.ifaceinfo = qmi_9x15_non_serial_ifaces,
};

static const signed char qmi_9x30_non_serial_ifaces[]  = {1,4,5,6,8,10,11,12,13};
static const struct sierra_iface_info qmi_9x39_interface_blacklist = {
    .infolen = ARRAY_SIZE( qmi_9x30_non_serial_ifaces ),
    .ifaceinfo = qmi_9x30_non_serial_ifaces,
};

static const signed char qmi_9x50_non_serial_ifaces[]  = {1,5,6,8,10,11,12,13};
static const struct sierra_iface_info qmi_9x50_interface_blacklist = {
    .infolen = ARRAY_SIZE( qmi_9x50_non_serial_ifaces ),
    .ifaceinfo = qmi_9x50_non_serial_ifaces,
};


static const signed char gobi_non_serial_ifaces[] = { 0 };
static const struct sierra_iface_info gobi_interface_blacklist = {
	.infolen = ARRAY_SIZE( gobi_non_serial_ifaces ),
	.ifaceinfo = gobi_non_serial_ifaces,
};
static const struct usb_device_id id_table[] = {
	{ USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
	{ USB_DEVICE(0x03F0, 0x1B1D) },	/* HP ev2200 a.k.a MC5720 */
	{ USB_DEVICE(0x03F0, 0x1E1D) },	/* HP hs2300 a.k.a MC8775 */
	{ USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */

	{ USB_DEVICE(0x1199, 0x0017) },	/* Sierra Wireless EM5625 */
	{ USB_DEVICE(0x1199, 0x0018) },	/* Sierra Wireless MC5720 */
	{ USB_DEVICE(0x1199, 0x0218) },	/* Sierra Wireless MC5720 */
	{ USB_DEVICE(0x1199, 0x0020) },	/* Sierra Wireless MC5725 */
	{ USB_DEVICE(0x1199, 0x0220) },	/* Sierra Wireless MC5725 */
	{ USB_DEVICE(0x1199, 0x0022) },	/* Sierra Wireless EM5725 */
	{ USB_DEVICE(0x1199, 0x0024) },	/* Sierra Wireless MC5727 */
	{ USB_DEVICE(0x1199, 0x0224) },	/* Sierra Wireless MC5727 */
	{ USB_DEVICE(0x1199, 0x0019) },	/* Sierra Wireless AirCard 595 */
	{ USB_DEVICE(0x1199, 0x0021) },	/* Sierra Wireless AirCard 597E */
	{ USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
	{ USB_DEVICE(0x1199, 0x0120) },	/* Sierra Wireless USB Dongle 595U */
	{ USB_DEVICE(0x1199, 0x0301) },	/* Sierra Wireless USB Dongle 250U/3G */
	/* Sierra Wireless MC5728 */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0400, 0xFF, 0xFF, 0xFF) },
	/* Sierra Wireless C597 */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
	/* Sierra Wireless T598 */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
	{ USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
	{ USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
	{ USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
	{ USB_DEVICE(0x114F, 0x6000) }, /* Sierra Wireless Q26 Elite */

	{ USB_DEVICE(0x1199, 0x6802) },	/* Sierra Wireless MC8755 */
	{ USB_DEVICE(0x1199, 0x6803) },	/* Sierra Wireless MC8765 */
	{ USB_DEVICE(0x1199, 0x6804) },	/* Sierra Wireless MC8755 */
	{ USB_DEVICE(0x1199, 0x6805) },	/* Sierra Wireless MC8765 */
	{ USB_DEVICE(0x1199, 0x6808) },	/* Sierra Wireless MC8755 */
	{ USB_DEVICE(0x1199, 0x6809) },	/* Sierra Wireless MC8765 */
	{ USB_DEVICE(0x1199, 0x6812) },	/* Sierra Wireless MC8775 & AC 875U */
	{ USB_DEVICE(0x1199, 0x6813) },	/* Sierra Wireless MC8775 */
	{ USB_DEVICE(0x1199, 0x6815) },	/* Sierra Wireless MC8775 */
	{ USB_DEVICE(0x1199, 0x6816) },	/* Sierra Wireless MC8775 */
	{ USB_DEVICE(0x1199, 0x6820) },	/* Sierra Wireless AirCard 875 */
	{ USB_DEVICE(0x1199, 0x6821) },	/* Sierra Wireless AirCard 875U */
	{ USB_DEVICE(0x1199, 0x6822) },	/* Sierra Wireless AirCard 875E */
	{ USB_DEVICE(0x1199, 0x6832) },	/* Sierra Wireless MC8780 */
	{ USB_DEVICE(0x1199, 0x6833) },	/* Sierra Wireless MC8781 */
	{ USB_DEVICE(0x1199, 0x6834) },	/* Sierra Wireless MC8780 */
	{ USB_DEVICE(0x1199, 0x6835) },	/* Sierra Wireless MC8781 */
	{ USB_DEVICE(0x1199, 0x6838) },	/* Sierra Wireless MC8780 */
	{ USB_DEVICE(0x1199, 0x6839) },	/* Sierra Wireless MC8781 */
	{ USB_DEVICE(0x1199, 0x683A) },	/* Sierra Wireless MC8785 */
	{ USB_DEVICE(0x1199, 0x683B) },	/* Sierra Wireless MC8785 Composite */
	/* Sierra Wireless MC8790, MC8791, MC8792 Composite */
	{ USB_DEVICE(0x1199, 0x683C) },
	{ USB_DEVICE(0x1199, 0x683D) },	/* Sierra Wireless MC8791 Composite */
	/* Sierra Wireless MC8790, MC8791, MC8792 */
	{ USB_DEVICE(0x1199, 0x683E) },
	{ USB_DEVICE(0x1199, 0x6850) },	/* Sierra Wireless AirCard 880 */
	{ USB_DEVICE(0x1199, 0x6851) },	/* Sierra Wireless AirCard 881 */
	{ USB_DEVICE(0x1199, 0x6852) },	/* Sierra Wireless AirCard 880 E */
	{ USB_DEVICE(0x1199, 0x6853) },	/* Sierra Wireless AirCard 881 E */
	{ USB_DEVICE(0x1199, 0x6855) },	/* Sierra Wireless AirCard 880 U */
	{ USB_DEVICE(0x1199, 0x6856) },	/* Sierra Wireless AirCard 881 U */
	{ USB_DEVICE(0x1199, 0x6859) },	/* Sierra Wireless AirCard 885 E */
	{ USB_DEVICE(0x1199, 0x685A) },	/* Sierra Wireless AirCard 885 E */
	/* Sierra Wireless C885 */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
	/* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
	/* Sierra Wireless C22/C33 */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
	/* Sierra Wireless HSPA Non-Composite Device */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
	{ USB_DEVICE(0x1199, 0x6893) },	/* Sierra Wireless Device */
	/* Sierra Wireless Direct IP modems */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68A3, 0xFF, 0xFF, 0xFF),
	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist 
	},
	/* AT&T Direct IP modems */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68A3, 0xFF, 0xFF, 0xFF),
	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist 
	},
	/* Sierra Wireless Direct IP LTE modems */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68AA, 0xFF, 0xFF, 0xFF),
	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
	},
	/* AT&T Direct IP LTE modems */
	{ USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
	  .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
	},
	/* Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */
	{ USB_DEVICE(0x413C, 0x8133) },
	/* Combined with QMI/Gobi devices */
	{ USB_DEVICE(0x05c6, 0x920c) },   /* Gobi 3000 QDL */
	{ USB_DEVICE(0x05c6, 0x920d) },   /* Gobi 3000 Composite */
	/* Sierra Wireless QMI VID/PID */
	{ USB_DEVICE(0x1199, 0x68A2),
		.driver_info = (kernel_ulong_t)&qmi_interface_blacklist
	},
	/* Gobi 5K Boot VID/PID */
	{ USB_DEVICE(0x1199, 0x9040) },
	/* Gobi 5K Application VID/PID */
	{ USB_DEVICE(0x1199, 0x9041),
		.driver_info = (kernel_ulong_t)&qmi_interface_blacklist
	},
    
	{ USB_DEVICE(0x1199, 0x68C0), 
		.driver_info = (kernel_ulong_t)&qmi_9x15_interface_blacklist
	},		
	/* Sierra Wireless G3K Boot VID/PID */
	{ USB_DEVICE(0x1199, 0x9010) },
	/* Sierra Wireless G3K Device Application VID/PID */
	{ USB_DEVICE(0x1199, 0x9011),
		.driver_info = (kernel_ulong_t)&gobi_interface_blacklist
	},
	/* Sierra Wireless G3K Boot VID/PID */
	{ USB_DEVICE(0x1199, 0x9012) },
	/* Sierra Wireless G3K Application VID/PID */
	{ USB_DEVICE(0x1199, 0x9013),
		.driver_info = (kernel_ulong_t)&gobi_interface_blacklist
	},
	/* Sierra Wireless G3K Boot VID/PID */
	{ USB_DEVICE(0x1199, 0x9014) },
	/* Sierra Wireless G3K Application VID/PID */
	{ USB_DEVICE(0x1199, 0x9015),
		.driver_info = (kernel_ulong_t)&gobi_interface_blacklist
	},
	/* Sierra Wireless G3K Boot VID/PID */
	{ USB_DEVICE(0x1199, 0x9018) },
	/* Sierra Wireless G3K Application VID/PID */
	{ USB_DEVICE(0x1199, 0x9019),
		.driver_info = (kernel_ulong_t)&gobi_interface_blacklist
	},
	/* G3K Boot VID/PID */
	{ USB_DEVICE(0x03F0, 0x361D) },
	/* G3K Application VID/PID */
	{ USB_DEVICE(0x03F0, 0x371D),
		.driver_info = (kernel_ulong_t)&gobi_interface_blacklist
	},

    /* 9x30 Boot VID/PID */
    { USB_DEVICE(0x1199, 0x9070) },
    /* 9x30 App  VID/PID */
    { USB_DEVICE(0x1199, 0x9071),
        .driver_info = (kernel_ulong_t)&qmi_9x39_interface_blacklist
    },

    /* 9x50 Boot VID/PID */
    { USB_DEVICE(0x1199, 0x9090) },
    { USB_DEVICE(0x1199, 0x90B0) },
    { USB_DEVICE(0x1199, 0x90C0) },
    /* 9x50 App  VID/PID */
    { USB_DEVICE(0x1199, 0x9091),
        .driver_info = (kernel_ulong_t)&qmi_9x50_interface_blacklist
    },
    { USB_DEVICE(0x1199, 0x90B1),    
        .driver_info = (kernel_ulong_t)&qmi_9x50_interface_blacklist
    },
    { USB_DEVICE(0x1199, 0x90C1),
        .driver_info = (kernel_ulong_t)&qmi_9x50_interface_blacklist
    },

	{ }
};
MODULE_DEVICE_TABLE(usb, id_table);

/* per port private data */
struct sierra_port_private {
	spinlock_t lock;	/* lock the structure */
	int outstanding_urbs;	/* number of out urbs in flight */
	struct usb_anchor active;
	struct usb_anchor delayed;

	int num_out_urbs;
	int num_in_urbs;
	/* Input endpoints and buffers for this port */
	struct urb *in_urbs[N_IN_URB_HM];

	/* Settings for the port */
	int rts_state;	/* Handshaking pins (outputs) */
	int dtr_state;
	int cts_state;	/* Handshaking pins (inputs) */
	int dsr_state;
	int dcd_state;
	int ri_state;
	unsigned int opened:1;
};

static int sierra_send_setup(struct usb_serial_port *port)
{
	struct usb_serial *serial = port->serial;
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
	__u16 interface = 0;
	int val = 0;
	int do_send = 0;
	int retval;

	dev_dbg(&port->dev, "%s\n", __func__);

	if (portdata->dtr_state)
		val |= 0x01;
	if (portdata->rts_state)
		val |= 0x02;

	/* If composite device then properly report interface */
	if (serial->num_ports == 1) {
		interface = sierra_calc_interface(serial);
		/* Control message is sent only to interfaces with
		 * interrupt_in endpoints
		 */
		if (port->interrupt_in_urb) {
			/* send control message */
			do_send = 1;
		}
	}

	/* Otherwise the need to do non-composite mapping */
	else {
		if (port->bulk_out_endpointAddress == 2)
			interface = 0;
		else if (port->bulk_out_endpointAddress == 4)
			interface = 1;
		else if (port->bulk_out_endpointAddress == 5)
			interface = 2;

		do_send = 1;
	}
	if (!do_send)
		return 0;

	usb_autopm_get_interface(serial->interface);

	retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
		0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
	usb_autopm_put_interface(serial->interface);

	return retval;
}

static void sierra_set_termios(struct tty_struct *tty,
		struct usb_serial_port *port, struct ktermios *old_termios)
{
    dev_dbg(&port->dev, "%s\n", __func__);
    #if (LINUX_VERSION_CODE >= KERNEL_VERSION( 3,7,0 ))
	tty_termios_copy_hw(&tty->termios, old_termios);
	#else
	tty_termios_copy_hw(tty->termios, old_termios);
	#endif
	sierra_send_setup(port);
}

#if (LINUX_VERSION_CODE >= KERNEL_VERSION( 2,6,39 ))
static int sierra_tiocmget(struct tty_struct *tty)
#else
static int sierra_tiocmget(struct tty_struct *tty, struct file *file)
#endif
{
	struct usb_serial_port *port = tty->driver_data;
	unsigned int value;
	struct sierra_port_private *portdata;

	dev_dbg(&port->dev, "%s\n", __func__);
	portdata = usb_get_serial_port_data(port);

	value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
		((portdata->dtr_state) ? TIOCM_DTR : 0) |
		((portdata->cts_state) ? TIOCM_CTS : 0) |
		((portdata->dsr_state) ? TIOCM_DSR : 0) |
		((portdata->dcd_state) ? TIOCM_CAR : 0) |
		((portdata->ri_state) ? TIOCM_RNG : 0);

	return value;
}

#if (LINUX_VERSION_CODE >= KERNEL_VERSION( 2,6,39 ))
static int sierra_tiocmset(struct tty_struct *tty,
			unsigned int set, unsigned int clear)
#else
static int sierra_tiocmset(struct tty_struct *tty, struct file *file,
			unsigned int set, unsigned int clear)
#endif
{
	struct usb_serial_port *port = tty->driver_data;
	struct sierra_port_private *portdata;

	portdata = usb_get_serial_port_data(port);

	if (set & TIOCM_RTS)
		portdata->rts_state = 1;
	if (set & TIOCM_DTR)
		portdata->dtr_state = 1;

	if (clear & TIOCM_RTS)
		portdata->rts_state = 0;
	if (clear & TIOCM_DTR)
		portdata->dtr_state = 0;
	return sierra_send_setup(port);
}

static void sierra_release_urb(struct urb *urb)
{
	struct usb_serial_port *port;
	if (urb) {
		port = urb->context;
		dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
		usb_free_urb(urb);
	}
}

/* Sysfs Attributes */
static ssize_t show_suspend_status(struct device *dev,
	struct device_attribute *attr, char *buf)
{
	struct usb_serial_port *port;
	struct sierra_port_private *portdata;
	struct sierra_intf_private *intfdata;
	unsigned long flags;
	unsigned int flag_suspended = 0;
	port = to_usb_serial_port(dev);
	portdata = usb_get_serial_port_data(port);
	intfdata = port->serial->private;
	spin_lock_irqsave(&intfdata->susp_lock, flags);
	flag_suspended = intfdata->suspended;
	spin_unlock_irqrestore(&intfdata->susp_lock, flags);
	return snprintf(buf, PORTION_LEN, "%i\n", flag_suspended);
}
static ssize_t show_stats(struct device *dev,
	struct device_attribute *attr, char *buf)
{
	struct usb_serial_port *port;
	struct sierra_intf_private *intfdata;
	port = to_usb_serial_port(dev);
	intfdata = port->serial->private;
	return snprintf(buf, PORTION_LEN,
		"rx: %i B\tindat: %i\tindat err: %i\n"
		"tx: %i B\toutdat: %i\toutdat err: %i\n"
		"writes: %i\t\twrite err: %i\n"
		"delayed writes: %i\tdelayed write err: %i\n",
		atomic_read(&intfdata->stats.rx_bytes),	atomic_read(&intfdata->stats.indat_cb_cnt), atomic_read(&intfdata->stats.indat_cb_fail),
		atomic_read(&intfdata->stats.tx_bytes), atomic_read(&intfdata->stats.outdat_cb_cnt), atomic_read(&intfdata->stats.outdat_cb_fail),
		atomic_read(&intfdata->stats.write_cnt), atomic_read(&intfdata->stats.write_err),
		atomic_read(&intfdata->stats.delayed_writes), atomic_read(&intfdata->stats.delayed_write_err)
	);
}
/* Read only suspend status */
static DEVICE_ATTR(suspend_status, S_IRUGO, show_suspend_status,
							NULL);
/* Read only statistics */
static DEVICE_ATTR(stats, S_IRUGO, show_stats, NULL);
static int sierra_create_sysfs_attrs(struct usb_serial_port *port)
{
	int result = 0;
	result = device_create_file(&port->dev, &dev_attr_stats);
	if (unlikely (result < 0)) 
		return result;
	return device_create_file(&port->dev, &dev_attr_suspend_status);
}
static int sierra_remove_sysfs_attrs(struct usb_serial_port *port)
{
	int i;
	struct usb_serial_port *port_tmp;
	dev_dbg(&port->dev, "%s\n", __func__);

	device_remove_file(&port->dev, &dev_attr_stats);
	device_remove_file(&port->dev, &dev_attr_suspend_status);
    if (port->serial->num_ports > 0) {
		port_tmp = port->serial->port[0];
		if (port_tmp)
			/* Note: The entire piece of memory that was allocated
			 * in the startup routine can be released by passing
			 * a pointer to the beginning of the piece.
			 * This address corresponds to the address of the chunk
			 * that was given to port 0.
			 */
			printk("%s usb_get_serial_port_data(port_tmp) = 0x%x\n", __func__, (int)usb_get_serial_port_data(port_tmp));
			kfree(usb_get_serial_port_data(port_tmp));
			printk("kfree at %s\n", __func__);
	}
	for (i = 0; i < port->serial->num_ports; ++i) {
		port_tmp = port->serial->port[i];
		if (!port_tmp)
			continue;
		usb_set_serial_port_data(port_tmp, NULL);
	}    
	return 0;
}
static void sierra_outdat_callback(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
	struct sierra_intf_private *intfdata;
	int status = urb->status;

	//dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
	intfdata = port->serial->private;

	usb_autopm_put_interface_async(port->serial->interface);
	atomic_inc(&intfdata->stats.outdat_cb_cnt);
	if (status) {
		dev_dbg(&port->dev, "%s - nonzero write bulk status "
		    "received: %d\n", __func__, status);
		atomic_inc(&intfdata->stats.outdat_cb_fail);
	}

	spin_lock(&portdata->lock);
	--portdata->outstanding_urbs;
	spin_unlock(&portdata->lock);
	spin_lock(&intfdata->susp_lock);
	--intfdata->in_flight;
	spin_unlock(&intfdata->susp_lock);

	usb_serial_port_softint(port);
}

/* Write */
static int sierra_write(struct tty_struct *tty, 
			struct usb_serial_port *port,
					const unsigned char *buf, int count)
{
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
	struct sierra_intf_private *intfdata;
	struct usb_serial *serial = port->serial;
	unsigned long flags;
	unsigned char *buffer;
	struct urb *urb;
	size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
	int retval = 0;

	/* verify that we actually have some data to write */
	if (count == 0)
		return 0;

	dev_dbg(&port->dev, "%s: write (%zu bytes)\n", __func__, writesize);
	intfdata = serial->private;

	spin_lock_irqsave(&portdata->lock, flags);
	if (portdata->outstanding_urbs > portdata->num_out_urbs) {
		spin_unlock_irqrestore(&portdata->lock, flags);
		dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
		return 0;
	}
	portdata->outstanding_urbs++;
	spin_unlock_irqrestore(&portdata->lock, flags);

	retval = usb_autopm_get_interface_async(serial->interface);
	if (unlikely(retval < 0)) {
		spin_lock_irqsave(&portdata->lock, flags);
		portdata->outstanding_urbs--;
		spin_unlock_irqrestore(&portdata->lock, flags);
		return retval;
	}

	buffer = kmalloc(writesize, GFP_ATOMIC);
	if (!buffer) {
		dev_err(&port->dev, "out of memory\n");
		spin_lock_irqsave(&portdata->lock, flags);
		--portdata->outstanding_urbs;
		spin_unlock_irqrestore(&portdata->lock, flags);
		usb_autopm_put_interface_async(serial->interface);
		return -ENOMEM;
	}

	urb = usb_alloc_urb(0, GFP_ATOMIC);
	if (!urb) {
		dev_err(&port->dev, "no more free urbs\n");
		kfree(buffer);
		spin_lock_irqsave(&portdata->lock, flags);
		--portdata->outstanding_urbs;
		spin_unlock_irqrestore(&portdata->lock, flags);
		usb_autopm_put_interface_async(serial->interface);
		return -ENOMEM;
	}

	memcpy(buffer, buf, writesize);
    
    #if (LINUX_VERSION_CODE >= KERNEL_VERSION( 3,7,0 ))
	usb_serial_debug_data(&port->dev, __func__, writesize, buffer);
	#else
	usb_serial_debug_data(debug,&port->dev, __func__, writesize, buffer);
	#endif

	usb_fill_bulk_urb(urb, serial->dev,
			  usb_sndbulkpipe(serial->dev,
					  port->bulk_out_endpointAddress),
			  buffer, writesize, sierra_outdat_callback, port);

	/* Handle the need to send a zero length packet and release the
	 * transfer buffer
	 */
	urb->transfer_flags |= (URB_ZERO_PACKET | URB_FREE_BUFFER);

	spin_lock_irqsave(&intfdata->susp_lock, flags);

	if (intfdata->suspended) {
		usb_anchor_urb(urb, &portdata->delayed);
		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
		/* release our reference to this urb, the USB core will 
		 * eventually free it entirely */
		usb_free_urb(urb);
		return writesize;
	}
		usb_anchor_urb(urb, &portdata->active);
	
	/* send it down the pipe */
	retval = usb_submit_urb(urb, GFP_ATOMIC);
	if (retval) {
		usb_unanchor_urb(urb);
		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
		dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
			"with status = %d\n", __func__, retval);
		usb_free_urb(urb);
		spin_lock_irqsave(&portdata->lock, flags);
		--portdata->outstanding_urbs;
		spin_unlock_irqrestore(&portdata->lock, flags);
		usb_autopm_put_interface_async(serial->interface);
		atomic_inc(&intfdata->stats.write_err);
		return retval;
	} else {
		intfdata->in_flight++;
		spin_unlock_irqrestore(&intfdata->susp_lock, flags);
		atomic_inc(&intfdata->stats.write_cnt);
		atomic_add(writesize, &intfdata->stats.tx_bytes);
	}

	/* release our reference to this urb, the USB core will eventually
	 * free it entirely */
	usb_free_urb(urb);

	return writesize;
}


static void sierra_indat_callback(struct urb *urb)
{
	int err;
	int endpoint;
	struct usb_serial_port *port = urb->context;
	struct sierra_intf_private *intfdata;
    unsigned char *data = urb->transfer_buffer;
	int status = urb->status;
	int last_chunk, count,i;
	#define DEBUG_PRINT_SIZE 50

	endpoint = usb_pipeendpoint(urb->pipe);
	dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
	intfdata = port->serial->private;
	atomic_inc(&intfdata->stats.indat_cb_cnt); /* indat calls */

	if (status) 
	{
		dev_dbg(&port->dev, "%s: nonzero status: %d on endpoint %02x\n", __func__, status, endpoint);
		atomic_inc(&intfdata->stats.indat_cb_fail); /* indat fails */
	} 
	else 
	{
		if (urb->actual_length) 
		{
			if(port->serial->interface->cur_altsetting->desc.bInterfaceNumber==3)
			{   /*filter out invalid AT port data*/
    			for(i=0; i < urb->actual_length; i++)
    			{
    			    if(*(data+i) == NULL)
    			        *(data+i) = ' ';
    			}
			}

		    #if (LINUX_VERSION_CODE >= KERNEL_VERSION( 3,9,0 )) 
			tty_insert_flip_string(&port->port, data,urb->actual_length);
			tty_flip_buffer_push(&port->port);
			#else
			struct tty_struct *tty;
			tty = tty_port_tty_get(&port->port);
			if (tty) 
			{
				tty_insert_flip_string(tty, data,urb->actual_length);
				tty_flip_buffer_push(tty);
				tty_kref_put(tty);
			}			
			#endif
			
			/* tty invalid after this point */
			/* rx'd bytes */
			atomic_add(urb->actual_length,&intfdata->stats.rx_bytes);
			#if (LINUX_VERSION_CODE >= KERNEL_VERSION( 3,7,0 ))
			
			/*print complete debug data */
			last_chunk = urb->actual_length%DEBUG_PRINT_SIZE;
			count = urb->actual_length/DEBUG_PRINT_SIZE;
			for(i=0; i < count; i++)
			    usb_serial_debug_data( &port->dev, __func__,DEBUG_PRINT_SIZE, data+i*DEBUG_PRINT_SIZE);
			usb_serial_debug_data( &port->dev, __func__,last_chunk, data+count*DEBUG_PRINT_SIZE);
			
			#else
			usb_serial_debug_data(debug,&port->dev, __func__,urb->actual_length, data);
			#endif
        } 
        else 
        {
			dev_dbg(&port->dev, "%s: empty read urb received\n", __func__);
		}
	}

	/* Resubmit urb so we continue receiving */
	if (status != -ESHUTDOWN && status != -ENOENT && status != -ENODEV) {
		usb_mark_last_busy(port->serial->dev);
		err = usb_submit_urb(urb, GFP_ATOMIC);
		if (err && err != -ENODEV)
			dev_err(&port->dev, "resubmit read urb failed."
				"(%d)\n", err);
	}
	return;
}

static void sierra_instat_callback(struct urb *urb)
{
	int err;
	int status = urb->status;
	struct usb_serial_port *port =  urb->context;
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
	struct usb_serial *serial = port->serial;

	dev_dbg(&port->dev, "%s: %p\n", __func__, urb);

	if (status == 0) {
		struct usb_ctrlrequest *req_pkt =
				(struct usb_ctrlrequest *)urb->transfer_buffer;

		const u16 *sigp = (u16 *)(req_pkt + 1);
		/* usb_ctrlrequest we parsed is followed by two bytes of data
		 * make sure we received that many bytes
		 */
		if (urb->actual_length >= sizeof(*req_pkt) + sizeof(*sigp) &&
			req_pkt->bRequestType == USB_REQUEST_TYPE_CLASS && 
			req_pkt->bRequest == USB_REQUEST_IFACE) 
		{
			int old_dcd_state;
			const u16 signals = get_unaligned_le16(sigp);
			struct tty_struct *tty;

			dev_dbg(&port->dev, "%s: signal 0x%x\n", __func__,
				signals);

			old_dcd_state = portdata->dcd_state;
			/* Note: CTS from modem is in reverse logic! */
			portdata->cts_state = ((signals & 0x100) ? 0 : 1);
			portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
			portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
			portdata->ri_state = ((signals & 0x08) ? 1 : 0);

			tty = tty_port_tty_get(&port->port);
			if (tty && !C_CLOCAL(tty) &&
					old_dcd_state && !portdata->dcd_state)
				tty_hangup(tty);
			tty_kref_put(tty);
		} 
		else 
		{
		    #if (LINUX_VERSION_CODE >= KERNEL_VERSION( 3,7,0 ))
			/* dump the data we don't understand to log */
			usb_serial_debug_data( &port->dev, __func__,
				urb->actual_length, urb->transfer_buffer);
		    #else
			usb_serial_debug_data(debug, &port->dev, __func__,
				urb->actual_length, urb->transfer_buffer);
		    #endif
		}
	} else
		dev_dbg(&port->dev, "%s: error %d\n", __func__, status);

	/* Resubmit urb so we continue receiving IRQ data */
	if (status != -ESHUTDOWN && status != -ENOENT && status != -ENODEV) {
		usb_mark_last_busy(serial->dev);
		urb->dev = serial->dev;
		err = usb_submit_urb(urb, GFP_ATOMIC);
		if (err && err != -ENODEV)
			dev_err(&port->dev, "%s: resubmit intr urb "
				"failed. (%d)\n", __func__, err);
	}
}

static int sierra_write_room(struct tty_struct *tty)
{
	struct usb_serial_port *port = tty->driver_data;
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);
	unsigned long flags;
	int retval;

	//dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
	/* try to give a good number back based on if we have any free urbs at
	 * this point in time */
	retval = MAX_TRANSFER;
	spin_lock_irqsave(&portdata->lock, flags);
	if (portdata->outstanding_urbs >= portdata->num_out_urbs) {
		retval = 0;
	}
	spin_unlock_irqrestore(&portdata->lock, flags);

	return retval;
}

static void sierra_stop_rx_urbs(struct usb_serial_port *port)
{
	int i;
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);

	for (i = 0; i < portdata->num_in_urbs; i++)
		usb_kill_urb(portdata->in_urbs[i]);

	usb_kill_urb(port->interrupt_in_urb);
}

static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
{
	int ok_cnt;
	int err = -EINVAL;
	int i;
	struct urb *urb;
	struct sierra_port_private *portdata = usb_get_serial_port_data(port);

	ok_cnt = 0;
	for (i = 0; i < portdata->num_in_urbs; i++) {
		urb = portdata->in_urbs[i];
		if (!urb)
			continue;
		urb->transfer_flags |= URB_FREE_BUFFER;
		err = usb_submit_urb(urb, mem_flags);
		if (err) {
			dev_err(&port->dev, "%s: submit urb failed: %d\n",
				__func__, err);
		} else {
			ok_cnt++;
		}
	}

	if (ok_cnt && port->interrupt_in_urb) {
		err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
		if (err) {
			dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
				__func__, err);
		}
	}

	if (ok_cnt > 0) /* at least one rx urb submitted */
		return 0;
	else
		return err;
}

static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
					int dir, void *ctx, int len,
					gfp_t mem_flags,
					usb_complete_t callback)
{
	struct urb	*urb;
	u8		*buf;

	if (endpoint == -1)
		return NULL;

	urb = usb_alloc_urb(0, mem_flags);
	if (urb == NULL) {
		dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
			__func__, endpoint);
		return NULL;
	}

	buf = kmalloc(len, mem_flags);
	if (buf) {
		/* Fill URB using supplied data */
		usb_fill_bulk_urb(urb, serial->dev,
			usb_sndbulkpipe(serial->dev, endpoint) | dir,
			buf, len, callback, ctx);

		/* debug */
		dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
				dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
	} else {
		dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
				dir == USB_DIR_IN ? 'i' : 'o', urb, buf);

		sierra_release_urb(urb);
		urb = NULL;
	}

	return urb;
}

static void sierra_close(struct usb_serial_port *port)
{
	int i;
	struct urb	*urb;
	struct usb_serial *serial = port->serial;
	struct sierra_port_private *portdata;
	struct sierra_intf_private *intfdata = port->serial->private;
	const unsigned char stopMessage[] = "$GPS_STOP";
	unsigned char *buf = NULL;
	int iMessageLen = strlen(stopMessage);

	int nResult;
	int bytesWrote;

	dev_dbg(&port->dev, "%s\n", __func__);
	portdata = usb_get_serial_port_data(port);

	portdata->rts_state = 0;
	portdata->dtr_state = 0;

	usb_autopm_get_interface(serial->interface);

	if (serial->dev) {
		if ((is_gps_port_qmi_gobi(port) == 1))
		{
			buf = kmalloc(iMessageLen, GFP_NOIO);
			memcpy(buf,stopMessage,iMessageLen);
            
			usb_autopm_get_interface(serial->interface);
			/* Send stopMessage , 1s timeout */
			nResult = usb_bulk_msg( serial->dev,
							usb_sndbulkpipe( serial->dev,
							port->bulk_out_endpointAddress),
							buf,
							iMessageLen,
							&bytesWrote,
							1000 );
			usb_autopm_put_interface(serial->interface);
			kfree(buf);
			/* TBD analyze return value */
	}
       if (is_gps_port_directip(port))
       {
           usb_autopm_get_interface(serial->interface);
           sierra_vsc_set_nmea(serial->dev, 0);
           usb_autopm_put_interface(serial->interface);
       }
		mutex_lock(&serial->disc_mutex);
		if (!serial->disconnected)
			sierra_send_setup(port);
	mutex_unlock(&serial->disc_mutex);
	spin_lock_irq(&intfdata->susp_lock);
	portdata->opened = 0;
	spin_unlock_irq(&intfdata->susp_lock);

		/* Stop reading urbs */
	sierra_stop_rx_urbs(port);
		/* .. and release them */
	for (i = 0; i < portdata->num_in_urbs; i++) {
		sierra_release_urb(portdata->in_urbs[i]);
		portdata->in_urbs[i] = NULL;
	}
		while((urb = usb_get_from_anchor(&portdata->delayed))) {
			sierra_release_urb(urb);
			usb_autopm_put_interface(serial->interface);
		}
		/* wait for active to finish */
		usb_wait_anchor_empty_timeout(&portdata->active, 500);
		usb_kill_anchored_urbs(&portdata->active);
	}
}

static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
{
	struct sierra_port_private *portdata;
	struct usb_serial *serial = port->serial;
	struct sierra_intf_private *intfdata = serial->private;
	int i;
	int err;
	int endpoint;
	struct urb *urb;
	const unsigned char startMessage[] = "$GPS_START";
	unsigned char *buf = NULL;
	int iMessageLen = strlen(startMessage);

	int nResult;
	int bytesWrote;

	portdata = usb_get_serial_port_data(port);

	dev_dbg(&port->dev, "%s\n", __func__);
	/* Set some sane defaults */
	portdata->rts_state = 1;
	portdata->dtr_state = 1;

	if (is_gps_port_qmi_gobi(port))
	{
		buf = kmalloc(iMessageLen, GFP_NOIO);
		memcpy(buf,startMessage,iMessageLen);

		usb_autopm_get_interface(serial->interface);
		/* Send startMessage, 1s timeout */
		nResult = usb_bulk_msg( serial->dev,
						usb_sndbulkpipe( serial->dev,
						port->bulk_out_endpointAddress),
						buf,
						iMessageLen,//sizeof( startMessage ),
						&bytesWrote,
						1000 );
		usb_autopm_put_interface(serial->interface);
		/* TBD analyze return value */
		kfree(buf);
    }
    if (is_gps_port_directip(port))
    {	   
        usb_autopm_get_interface(serial->interface);
        sierra_vsc_set_nmea(serial->dev, 1);
        usb_autopm_put_interface(serial->interface);
    }

	endpoint = port->bulk_in_endpointAddress;
	for (i = 0; i < portdata->num_in_urbs; i++) {
		urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
					IN_BUFLEN, GFP_KERNEL,
					sierra_indat_callback);
		portdata->in_urbs[i] = urb;
	}
	/* clear halt condition */
	usb_clear_halt(serial->dev,
			usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);

	/* reset outstanding out urbs counter */
	spin_lock_irq(&portdata->lock);
	portdata->outstanding_urbs = 0;
	spin_unlock_irq(&portdata->lock);
	err = sierra_submit_rx_urbs(port, GFP_KERNEL);
	if (err) {
		/* do everything as in close() but do not call close() because
		 * usbserial calls sierra_open() with mutex taken;
		 * then if we call sierra_close() inside sierra_open() we
		 * violate 'no nested mutexes' kernel condition
		 */
		portdata->rts_state = 0;
		portdata->dtr_state = 0;
		usb_autopm_get_interface(serial->interface);
		/* Stop reading urbs */
		sierra_stop_rx_urbs(port);
		/* .. and release them */
		for (i = 0; i < portdata->num_in_urbs; i++) {
			sierra_release_urb(portdata->in_urbs[i]);
			portdata->in_urbs[i] = NULL;
		}
		while((urb = usb_get_from_anchor(&portdata->delayed))) {
			sierra_release_urb(urb);
			usb_autopm_put_interface(serial->interface);
		}
		/* wait for active to finish */
		usb_wait_anchor_empty_timeout(&portdata->active, 500);
		usb_kill_anchored_urbs(&portdata->active);
		/* restore balance for autopm */
			usb_autopm_put_interface(serial->interface);
		return err;
	}
	sierra_send_setup(port);

	spin_lock_irq(&intfdata->susp_lock);
	portdata->opened = 1;
	spin_unlock_irq(&intfdata->susp_lock);
	usb_autopm_put_interface(serial->interface);

	return 0;
}


static void sierra_dtr_rts(struct usb_serial_port *port, int on)
{
	struct usb_serial *serial = port->serial;
	struct sierra_port_private *portdata;

	portdata = usb_get_serial_port_data(port);
	portdata->rts_state = on;
	portdata->dtr_state = on;

	if (serial->dev) {
		sierra_lock_disc_mutex(serial);
		if (!serial->disconnected)
	sierra_send_setup(port);
		sierra_unlock_disc_mutex(serial);
	}
}


static int sierra_startup(struct usb_serial *serial)
{
	struct usb_serial_port *port = NULL;
	struct sierra_port_private *portdata = NULL;
	struct sierra_iface_info *himemoryp = NULL;
	int i;
	u8 ifnum;
	u16 fw_attr;
	int result;
	int autosuspend;

	dev_dbg(&serial->dev->dev, "%s\n", __func__);

	/* Exclude QMI and Gobi devices */
	if ( !is_qmi_gobi_device(serial->dev) ) 
		/* Set Device mode to D0 */
		sierra_set_power_state(serial->dev, 0x0000);

	/* Check NMEA and set */
	if (nmea)
		sierra_vsc_set_nmea(serial->dev, 1);

	if (serial->num_ports) {
		/* Note: One big piece of memory is allocated for all ports 
		 * private data in one shot. This memory is split into equal 
		 * pieces for each port. 
		 */
		portdata = (struct sierra_port_private *)kzalloc
			(sizeof(*portdata) * serial->num_ports, GFP_KERNEL);
		if (!portdata) {
			dev_dbg(&serial->dev->dev, "%s: No memory!\n", __func__);
			return -ENOMEM;
		}
	}

	/* Now setup per port private data */
	for (i = 0; i < serial->num_ports; i++, portdata++) {
		port = serial->port[i];
		/* Initialize selected members of private data because these
		 * may be referred to right away */
		spin_lock_init(&portdata->lock);
		init_usb_anchor(&portdata->active);
		init_usb_anchor(&portdata->delayed);

		portdata->cts_state = 1;

		ifnum = i;
		/* Assume low memory requirements */
		portdata->num_out_urbs = N_OUT_URB;
		portdata->num_in_urbs  = N_IN_URB;

		/* Determine actual memory requirements */
		if (serial->num_ports == 1) {
			/* Get interface number for composite device */
			ifnum = sierra_calc_interface(serial);
			himemoryp =
			    (struct sierra_iface_info *)&typeB_interface_list;
			if (is_himemory(ifnum, himemoryp)) {
				portdata->num_out_urbs = N_OUT_URB_HM;
				portdata->num_in_urbs  = N_IN_URB_HM;
			}
		}
		else {
			himemoryp =
			    (struct sierra_iface_info *)&typeA_interface_list;
			if (is_himemory(i, himemoryp)) {
				portdata->num_out_urbs = N_OUT_URB_HM;
				portdata->num_in_urbs  = N_IN_URB_HM;
			}
		}
		dev_dbg(&serial->dev->dev, 
			"Memory usage (urbs) interface #%d, in=%d, out=%d\n",
			ifnum,portdata->num_in_urbs, portdata->num_out_urbs );
		/* Set the port private data pointer */
		usb_set_serial_port_data(port, portdata);
	}
	serial->interface->needs_remote_wakeup = 1;

	if (is_qmi_gobi_device(serial->dev)) {
		/* QMI and Gobi devices always support auto-suspend*/
		autosuspend = 1;
	} else {
		result = sierra_get_fw_attr(serial->dev, &fw_attr);
		autosuspend = (result == sizeof(fw_attr) &&
							(fw_attr & SWI_FW_ATTR_PM_MASK) );
	}
		
	if (autosuspend) {
		dev_info(&serial->dev->dev,
			"APM supported, enabling autosuspend.\n");
/******************************************************************************* 
 * If you want the default /sys/bus/usb/devices/.../.../power/level to be forced
 * to auto, the following needs to be compiled in.
 */ 
#ifdef POWER_LEVEL_AUTO
		/* make power level default be 'auto' */
		usb_enable_autosuspend(serial->dev);
#endif
	} else {
		usb_disable_autosuspend(serial->dev);
	}

	return 0;
}






static void sierra_release(struct usb_serial *serial)
{
	int i;
	struct usb_serial_port *port;
	struct sierra_intf_private *intfdata = serial->private;

	dev_dbg(&serial->dev->dev, "%s\n", __func__);

	if (serial->num_ports > 0) {
		port = serial->port[0];
		if (port)
			/* Note: The entire piece of memory that was allocated 
			 * in the startup routine can be released by passing
			 * a pointer to the beginning of the piece.
			 * This address corresponds to the address of the chunk
			 * that was given to port 0.
		 	 */
			kfree(usb_get_serial_port_data(port));
	}
	for (i = 0; i < serial->num_ports; ++i) {
		port = serial->port[i];
		if (!port)
			continue;
		usb_set_serial_port_data(port, NULL);
	}
	kfree(intfdata);
}

#ifdef CONFIG_PM
static void stop_read_write_urbs(struct usb_serial *serial)
{
	int i;
	struct usb_serial_port *port;
	struct sierra_port_private *portdata;

	/* Stop reading/writing urbs */
	for (i = 0; i < serial->num_ports; ++i) {
		port = serial->port[i];
		portdata = usb_get_serial_port_data(port);
		sierra_stop_rx_urbs(port);
		usb_kill_anchored_urbs(&portdata->active);
	}
}

static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
{
	struct sierra_intf_private *intfdata;

	dev_dbg(&serial->dev->dev, "%s\n", __func__);
		intfdata = serial->private;
		spin_lock_irq(&intfdata->susp_lock);

	if (message.event & PM_EVENT_AUTO) {
		if (intfdata->in_flight) {
			spin_unlock_irq(&intfdata->susp_lock);
			return -EBUSY;
		}
	}
	intfdata->suspended = 1;
	spin_unlock_irq(&intfdata->susp_lock);
	stop_read_write_urbs(serial);

	return 0;
}

static int sierra_resume(struct usb_serial *serial)
{
	struct usb_serial_port *port;
	struct sierra_intf_private *intfdata = serial->private;
	struct sierra_port_private *portdata;
	struct urb *urb;
	int ec = 0;
	int i, err;
	int len;
	int failed_submits;

	dev_dbg(&serial->dev->dev, "%s\n", __func__);
	spin_lock_irq(&intfdata->susp_lock);
	for (i = 0; i < serial->num_ports; i++) {
		port = serial->port[i];
		portdata = usb_get_serial_port_data(port);
		failed_submits = 0;
		while ((urb = usb_get_from_anchor(&portdata->delayed))) {
			usb_anchor_urb(urb, &portdata->active);
			intfdata->in_flight++;
			len = urb->transfer_buffer_length;
			err = usb_submit_urb(urb, GFP_ATOMIC);
			if (err < 0) {
				intfdata->in_flight--;
				usb_unanchor_urb(urb);
				failed_submits++;
				atomic_inc(&intfdata->stats.delayed_write_err);
				/* fix pm_usage_cnt */
				usb_autopm_put_interface_async(
					port->serial->interface);
			} else {
				atomic_inc(&intfdata->stats.delayed_writes);
				atomic_add(len, &intfdata->stats.tx_bytes);
			}
			/* release urb - usb_get_from_anchor increased kref */
			usb_free_urb(urb);
		}

		if (portdata->opened) {
			err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
			if (err)
				ec++;
		}
		if (failed_submits) {
			/* fix outstanding_urbs counter */
			spin_lock(&portdata->lock); /* assuming irq disabled */
			portdata->outstanding_urbs -= failed_submits;
			spin_unlock(&portdata->lock);
			/* unblock a writer */
			usb_serial_port_softint(port);
		}
	}
	intfdata->suspended = 0;
	spin_unlock_irq(&intfdata->susp_lock);

	return ec ? -EIO : 0;
}

#else
#define sierra_suspend NULL
#define sierra_resume NULL
#endif

static int sierra_reset_resume(struct usb_interface *intf)
{
	struct usb_serial *serial = usb_get_intfdata(intf);
	dev_err(&serial->dev->dev, "%s\n", __func__);
	return usb_serial_resume(intf);
}
static struct usb_driver sierra_driver = {
	.name       = "sierra",
#if (LINUX_VERSION_CODE < KERNEL_VERSION( 3,5,0 ))
   .probe      = usb_serial_probe,
   .disconnect = usb_serial_disconnect,
#endif	
	.suspend    = usb_serial_suspend,
	.resume     = usb_serial_resume,
	.reset_resume = sierra_reset_resume,
	.id_table   = id_table,
	.no_dynamic_id        =	1,
	.supports_autosuspend = 1,
};
static struct usb_serial_driver sierra_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"sierra",
	},
	.description       = "Sierra USB modem",
	.id_table          = id_table,
	.usb_driver        = &sierra_driver,
	.calc_num_ports	   = sierra_calc_num_ports,
	.probe		   = sierra_probe,
	.open              = sierra_open,
	.close             = sierra_close,
	.dtr_rts	   = sierra_dtr_rts,
	.write             = sierra_write,
	.write_room        = sierra_write_room,
	.set_termios       = sierra_set_termios,
	.tiocmget          = sierra_tiocmget,
	.tiocmset          = sierra_tiocmset,
	.attach            = sierra_startup,
	.release           = sierra_release,
	.port_probe        = sierra_create_sysfs_attrs,
	.port_remove       = sierra_remove_sysfs_attrs,
	.suspend	   = sierra_suspend,
	.resume		   = sierra_resume,
	.read_int_callback = sierra_instat_callback,
};

#if (LINUX_VERSION_CODE >= KERNEL_VERSION( 3,4,0 ))
static struct usb_serial_driver * const serial_drivers[] = {
	&sierra_device, NULL
};
#endif

/* Functions used by new usb-serial code. */
static int __init sierra_init(void)
{
	int retval;
#if (LINUX_VERSION_CODE < KERNEL_VERSION( 3,4,0 ))
	retval = usb_serial_register(&sierra_device);
   if (retval != 0)
   {
      return retval;
   }
	retval = usb_register(&sierra_driver);
   if (retval != 0)
   {
      usb_serial_deregister( &sierra_device );
      return retval;
   }
#else
    #if (LINUX_VERSION_CODE > KERNEL_VERSION( 3,5,0 ))
        retval = usb_serial_register_drivers(serial_drivers, KBUILD_MODNAME, id_table);
    #else
        retval = usb_serial_register_drivers(&sierra_driver, serial_drivers);
    #endif
#endif
	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
	       DRIVER_DESC "\n");
	return 0;
}
static void __exit sierra_exit(void)
{
#if (LINUX_VERSION_CODE < KERNEL_VERSION( 3,4,0 ))
   usb_deregister( &sierra_driver );
   usb_serial_deregister( &sierra_device );
#else
    #if (LINUX_VERSION_CODE > KERNEL_VERSION( 3,5,0 ))
       usb_serial_deregister_drivers(serial_drivers);
    #else
       usb_serial_deregister_drivers(&sierra_driver, serial_drivers);
    #endif
#endif
}
module_init(sierra_init);
module_exit(sierra_exit);

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_VERSION(DRIVER_VERSION);
MODULE_LICENSE("GPL");

module_param(nmea, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(nmea, "NMEA streaming");
module_param(debug, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(debug, "Debug messages");
