1 /******************************************************************************
3 * Driver for Option High Speed Mobile Devices.
5 * Copyright (C) 2008 Option International
6 * Filip Aben <f.aben@option.com>
7 * Denis Joseph Barrow <d.barow@option.com>
8 * Jan Dumon <j.dumon@option.com>
9 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
10 * <ajb@spheresystems.co.uk>
11 * Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de>
12 * Copyright (C) 2008 Novell, Inc.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
29 *****************************************************************************/
31 /******************************************************************************
33 * Description of the device:
35 * Interface 0: Contains the IP network interface on the bulk end points.
36 * The multiplexed serial ports are using the interrupt and
38 * Interrupt contains a bitmap telling which multiplexed
39 * serialport needs servicing.
41 * Interface 1: Diagnostics port, uses bulk only, do not submit urbs until the
42 * port is opened, as this have a huge impact on the network port
45 * Interface 2: Standard modem interface - circuit switched interface, this
46 * can be used to make a standard ppp connection however it
47 * should not be used in conjunction with the IP network interface
48 * enabled for USB performance reasons i.e. if using this set
49 * ideally disable_net=1.
51 *****************************************************************************/
53 #include <linux/sched.h>
54 #include <linux/slab.h>
55 #include <linux/init.h>
56 #include <linux/delay.h>
57 #include <linux/netdevice.h>
58 #include <linux/module.h>
59 #include <linux/ethtool.h>
60 #include <linux/usb.h>
61 #include <linux/timer.h>
62 #include <linux/tty.h>
63 #include <linux/tty_driver.h>
64 #include <linux/tty_flip.h>
65 #include <linux/kmod.h>
66 #include <linux/rfkill.h>
68 #include <linux/uaccess.h>
69 #include <linux/usb/cdc.h>
71 #include <asm/byteorder.h>
72 #include <linux/serial_core.h>
73 #include <linux/serial.h>
76 #define DRIVER_VERSION "1.2"
77 #define MOD_AUTHOR "Option Wireless"
78 #define MOD_DESCRIPTION "USB High Speed Option driver"
79 #define MOD_LICENSE "GPL"
81 #define HSO_MAX_NET_DEVICES 10
82 #define HSO__MAX_MTU 2048
83 #define DEFAULT_MTU 1500
84 #define DEFAULT_MRU 1500
86 #define CTRL_URB_RX_SIZE 1024
87 #define CTRL_URB_TX_SIZE 64
89 #define BULK_URB_RX_SIZE 4096
90 #define BULK_URB_TX_SIZE 8192
92 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
93 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
94 #define MUX_BULK_RX_BUF_COUNT 4
95 #define USB_TYPE_OPTION_VENDOR 0x20
97 /* These definitions are used with the struct hso_net flags element */
98 /* - use *_bit operations on it. (bit indices not values.) */
99 #define HSO_NET_RUNNING 0
101 #define HSO_NET_TX_TIMEOUT (HZ*10)
103 #define HSO_SERIAL_MAGIC 0x48534f31
105 /* Number of ttys to handle */
106 #define HSO_SERIAL_TTY_MINORS 256
108 #define MAX_RX_URBS 2
110 static inline struct hso_serial *get_serial_by_tty(struct tty_struct *tty)
113 return tty->driver_data;
117 /*****************************************************************************/
118 /* Debugging functions */
119 /*****************************************************************************/
120 #define D__(lvl_, fmt, arg...) \
122 printk(lvl_ "[%d:%s]: " fmt "\n", \
123 __LINE__, __func__, ## arg); \
126 #define D_(lvl, args...) \
129 D__(KERN_INFO, args); \
132 #define D1(args...) D_(0x01, ##args)
133 #define D2(args...) D_(0x02, ##args)
134 #define D3(args...) D_(0x04, ##args)
135 #define D4(args...) D_(0x08, ##args)
136 #define D5(args...) D_(0x10, ##args)
138 /*****************************************************************************/
140 /*****************************************************************************/
141 enum pkt_parse_state {
147 /*****************************************************************************/
149 /*****************************************************************************/
151 struct hso_shared_int {
152 struct usb_endpoint_descriptor *intr_endp;
153 void *shared_intr_buf;
154 struct urb *shared_intr_urb;
155 struct usb_device *usb;
158 struct mutex shared_int_lock;
162 struct hso_device *parent;
163 struct net_device *net;
164 struct rfkill *rfkill;
166 struct usb_endpoint_descriptor *in_endp;
167 struct usb_endpoint_descriptor *out_endp;
169 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
170 struct urb *mux_bulk_tx_urb;
171 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
172 void *mux_bulk_tx_buf;
174 struct sk_buff *skb_rx_buf;
175 struct sk_buff *skb_tx_buf;
177 enum pkt_parse_state rx_parse_state;
180 unsigned short rx_buf_size;
181 unsigned short rx_buf_missing;
182 struct iphdr rx_ip_hdr;
193 #define BM_REQUEST_TYPE (0xa1)
194 #define B_NOTIFICATION (0x20)
195 #define W_VALUE (0x0)
196 #define W_INDEX (0x2)
197 #define W_LENGTH (0x2)
199 #define B_OVERRUN (0x1<<6)
200 #define B_PARITY (0x1<<5)
201 #define B_FRAMING (0x1<<4)
202 #define B_RING_SIGNAL (0x1<<3)
203 #define B_BREAK (0x1<<2)
204 #define B_TX_CARRIER (0x1<<1)
205 #define B_RX_CARRIER (0x1<<0)
207 struct hso_serial_state_notification {
213 u16 UART_state_bitmap;
214 } __attribute__((packed));
216 struct hso_tiocmget {
218 wait_queue_head_t waitq;
220 struct usb_endpoint_descriptor *endp;
222 struct hso_serial_state_notification serial_state_notification;
223 u16 prev_UART_state_bitmap;
224 struct uart_icount icount;
229 struct hso_device *parent;
233 struct hso_shared_int *shared_int;
235 /* rx/tx urb could be either a bulk urb or a control urb depending
236 on which serial port it is used on. */
237 struct urb *rx_urb[MAX_RX_URBS];
239 u8 *rx_data[MAX_RX_URBS];
240 u16 rx_data_length; /* should contain allocated length */
245 u16 tx_data_length; /* should contain allocated length */
248 struct usb_ctrlrequest ctrl_req_tx;
249 struct usb_ctrlrequest ctrl_req_rx;
251 struct usb_endpoint_descriptor *in_endp;
252 struct usb_endpoint_descriptor *out_endp;
254 enum rx_ctrl_state rx_state;
257 unsigned tx_urb_used:1;
259 /* from usb_serial_port */
260 struct tty_struct *tty;
262 spinlock_t serial_lock;
264 int (*write_data) (struct hso_serial *serial);
265 struct hso_tiocmget *tiocmget;
266 /* Hacks required to get flow control
267 * working on the serial receive buffers
268 * so as not to drop characters on the floor.
271 u16 curr_rx_urb_offset;
272 u8 rx_urb_filled[MAX_RX_URBS];
273 struct tasklet_struct unthrottle_tasklet;
274 struct work_struct retry_unthrottle_workqueue;
279 struct hso_serial *dev_serial;
280 struct hso_net *dev_net;
287 struct work_struct async_get_intf;
288 struct work_struct async_put_intf;
290 struct usb_device *usb;
291 struct usb_interface *interface;
298 /* Type of interface */
299 #define HSO_INTF_MASK 0xFF00
300 #define HSO_INTF_MUX 0x0100
301 #define HSO_INTF_BULK 0x0200
304 #define HSO_PORT_MASK 0xFF
305 #define HSO_PORT_NO_PORT 0x0
306 #define HSO_PORT_CONTROL 0x1
307 #define HSO_PORT_APP 0x2
308 #define HSO_PORT_GPS 0x3
309 #define HSO_PORT_PCSC 0x4
310 #define HSO_PORT_APP2 0x5
311 #define HSO_PORT_GPS_CONTROL 0x6
312 #define HSO_PORT_MSD 0x7
313 #define HSO_PORT_VOICE 0x8
314 #define HSO_PORT_DIAG2 0x9
315 #define HSO_PORT_DIAG 0x10
316 #define HSO_PORT_MODEM 0x11
317 #define HSO_PORT_NETWORK 0x12
319 /* Additional device info */
320 #define HSO_INFO_MASK 0xFF000000
321 #define HSO_INFO_CRC_BUG 0x01000000
323 /*****************************************************************************/
325 /*****************************************************************************/
326 /* Serial driver functions */
327 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
328 unsigned int set, unsigned int clear);
329 static void ctrl_callback(struct urb *urb);
330 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
331 static void hso_kick_transmit(struct hso_serial *serial);
332 /* Helper functions */
333 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
334 struct usb_device *usb, gfp_t gfp);
335 static void log_usb_status(int status, const char *function);
336 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
338 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
339 static void hso_free_interface(struct usb_interface *intf);
340 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
341 static int hso_stop_serial_device(struct hso_device *hso_dev);
342 static int hso_start_net_device(struct hso_device *hso_dev);
343 static void hso_free_shared_int(struct hso_shared_int *shared_int);
344 static int hso_stop_net_device(struct hso_device *hso_dev);
345 static void hso_serial_ref_free(struct kref *ref);
346 static void hso_std_serial_read_bulk_callback(struct urb *urb);
347 static int hso_mux_serial_read(struct hso_serial *serial);
348 static void async_get_intf(struct work_struct *data);
349 static void async_put_intf(struct work_struct *data);
350 static int hso_put_activity(struct hso_device *hso_dev);
351 static int hso_get_activity(struct hso_device *hso_dev);
352 static void tiocmget_intr_callback(struct urb *urb);
353 /*****************************************************************************/
354 /* Helping functions */
355 /*****************************************************************************/
359 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
361 return hso_dev->port_data.dev_net;
364 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
366 return hso_dev->port_data.dev_serial;
369 /* Debugging functions */
371 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
374 static char name[255];
376 sprintf(name, "hso[%d:%s]", line_count, func_name);
377 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
380 #define DUMP(buf_, len_) \
381 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
383 #define DUMP1(buf_, len_) \
389 #define DUMP(buf_, len_)
390 #define DUMP1(buf_, len_)
393 /* module parameters */
395 static int tty_major;
396 static int disable_net;
399 static const char driver_name[] = "hso";
400 static const char tty_filename[] = "ttyHS";
401 static const char *version = __FILE__ ": " DRIVER_VERSION " " MOD_AUTHOR;
402 /* the usb driver itself (registered in hso_init) */
403 static struct usb_driver hso_driver;
404 /* serial structures */
405 static struct tty_driver *tty_drv;
406 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
407 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
408 static spinlock_t serial_table_lock;
410 static const s32 default_port_spec[] = {
411 HSO_INTF_MUX | HSO_PORT_NETWORK,
412 HSO_INTF_BULK | HSO_PORT_DIAG,
413 HSO_INTF_BULK | HSO_PORT_MODEM,
417 static const s32 icon321_port_spec[] = {
418 HSO_INTF_MUX | HSO_PORT_NETWORK,
419 HSO_INTF_BULK | HSO_PORT_DIAG2,
420 HSO_INTF_BULK | HSO_PORT_MODEM,
421 HSO_INTF_BULK | HSO_PORT_DIAG,
425 #define default_port_device(vendor, product) \
426 USB_DEVICE(vendor, product), \
427 .driver_info = (kernel_ulong_t)default_port_spec
429 #define icon321_port_device(vendor, product) \
430 USB_DEVICE(vendor, product), \
431 .driver_info = (kernel_ulong_t)icon321_port_spec
433 /* list of devices we support */
434 static const struct usb_device_id hso_ids[] = {
435 {default_port_device(0x0af0, 0x6711)},
436 {default_port_device(0x0af0, 0x6731)},
437 {default_port_device(0x0af0, 0x6751)},
438 {default_port_device(0x0af0, 0x6771)},
439 {default_port_device(0x0af0, 0x6791)},
440 {default_port_device(0x0af0, 0x6811)},
441 {default_port_device(0x0af0, 0x6911)},
442 {default_port_device(0x0af0, 0x6951)},
443 {default_port_device(0x0af0, 0x6971)},
444 {default_port_device(0x0af0, 0x7011)},
445 {default_port_device(0x0af0, 0x7031)},
446 {default_port_device(0x0af0, 0x7051)},
447 {default_port_device(0x0af0, 0x7071)},
448 {default_port_device(0x0af0, 0x7111)},
449 {default_port_device(0x0af0, 0x7211)},
450 {default_port_device(0x0af0, 0x7251)},
451 {default_port_device(0x0af0, 0x7271)},
452 {default_port_device(0x0af0, 0x7311)},
453 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
454 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
455 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
456 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
457 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
458 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
459 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
460 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
461 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
462 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
463 {USB_DEVICE(0x0af0, 0x7701)},
464 {USB_DEVICE(0x0af0, 0x7801)},
465 {USB_DEVICE(0x0af0, 0x7901)},
466 {USB_DEVICE(0x0af0, 0x8200)},
467 {USB_DEVICE(0x0af0, 0x8201)},
468 {USB_DEVICE(0x0af0, 0xd035)},
469 {USB_DEVICE(0x0af0, 0xd055)},
470 {USB_DEVICE(0x0af0, 0xd155)},
471 {USB_DEVICE(0x0af0, 0xd255)},
472 {USB_DEVICE(0x0af0, 0xd057)},
473 {USB_DEVICE(0x0af0, 0xd157)},
474 {USB_DEVICE(0x0af0, 0xd257)},
475 {USB_DEVICE(0x0af0, 0xd357)},
478 MODULE_DEVICE_TABLE(usb, hso_ids);
480 /* Sysfs attribute */
481 static ssize_t hso_sysfs_show_porttype(struct device *dev,
482 struct device_attribute *attr,
485 struct hso_device *hso_dev = dev_get_drvdata(dev);
491 switch (hso_dev->port_spec & HSO_PORT_MASK) {
492 case HSO_PORT_CONTROL:
493 port_name = "Control";
496 port_name = "Application";
499 port_name = "Application2";
504 case HSO_PORT_GPS_CONTROL:
505 port_name = "GPS Control";
511 port_name = "Diagnostic";
514 port_name = "Diagnostic2";
519 case HSO_PORT_NETWORK:
520 port_name = "Network";
523 port_name = "Unknown";
527 return sprintf(buf, "%s\n", port_name);
529 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
531 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
535 for (idx = 0; idx < serial->num_rx_urbs; idx++)
536 if (serial->rx_urb[idx] == urb)
538 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
542 /* converts mux value to a port spec value */
543 static u32 hso_mux_to_port(int mux)
549 result = HSO_PORT_CONTROL;
552 result = HSO_PORT_APP;
555 result = HSO_PORT_PCSC;
558 result = HSO_PORT_GPS;
561 result = HSO_PORT_APP2;
564 result = HSO_PORT_NO_PORT;
569 /* converts port spec value to a mux value */
570 static u32 hso_port_to_mux(int port)
574 switch (port & HSO_PORT_MASK) {
575 case HSO_PORT_CONTROL:
596 static struct hso_serial *get_serial_by_shared_int_and_type(
597 struct hso_shared_int *shared_int,
602 port = hso_mux_to_port(mux);
604 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
606 && (dev2ser(serial_table[i])->shared_int == shared_int)
607 && ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
608 return dev2ser(serial_table[i]);
615 static struct hso_serial *get_serial_by_index(unsigned index)
617 struct hso_serial *serial = NULL;
620 spin_lock_irqsave(&serial_table_lock, flags);
621 if (serial_table[index])
622 serial = dev2ser(serial_table[index]);
623 spin_unlock_irqrestore(&serial_table_lock, flags);
628 static int get_free_serial_index(void)
633 spin_lock_irqsave(&serial_table_lock, flags);
634 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
635 if (serial_table[index] == NULL) {
636 spin_unlock_irqrestore(&serial_table_lock, flags);
640 spin_unlock_irqrestore(&serial_table_lock, flags);
642 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
646 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
650 spin_lock_irqsave(&serial_table_lock, flags);
652 serial_table[index] = serial->parent;
654 serial_table[index] = NULL;
655 spin_unlock_irqrestore(&serial_table_lock, flags);
658 /* log a meaningful explanation of an USB status */
659 static void log_usb_status(int status, const char *function)
665 explanation = "no device";
668 explanation = "endpoint not enabled";
671 explanation = "endpoint stalled";
674 explanation = "not enough bandwidth";
677 explanation = "device disabled";
680 explanation = "device suspended";
686 explanation = "internal error";
689 explanation = "unknown status";
692 D1("%s: received USB status - %s (%d)", function, explanation, status);
695 /* Network interface functions */
697 /* called when net interface is brought up by ifconfig */
698 static int hso_net_open(struct net_device *net)
700 struct hso_net *odev = netdev_priv(net);
701 unsigned long flags = 0;
704 dev_err(&net->dev, "No net device !\n");
708 odev->skb_tx_buf = NULL;
710 /* setup environment */
711 spin_lock_irqsave(&odev->net_lock, flags);
712 odev->rx_parse_state = WAIT_IP;
713 odev->rx_buf_size = 0;
714 odev->rx_buf_missing = sizeof(struct iphdr);
715 spin_unlock_irqrestore(&odev->net_lock, flags);
717 /* We are up and running. */
718 set_bit(HSO_NET_RUNNING, &odev->flags);
719 hso_start_net_device(odev->parent);
721 /* Tell the kernel we are ready to start receiving from it */
722 netif_start_queue(net);
727 /* called when interface is brought down by ifconfig */
728 static int hso_net_close(struct net_device *net)
730 struct hso_net *odev = netdev_priv(net);
732 /* we don't need the queue anymore */
733 netif_stop_queue(net);
734 /* no longer running */
735 clear_bit(HSO_NET_RUNNING, &odev->flags);
737 hso_stop_net_device(odev->parent);
743 /* USB tells is xmit done, we should start the netqueue again */
744 static void write_bulk_callback(struct urb *urb)
746 struct hso_net *odev = urb->context;
747 int status = urb->status;
750 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
751 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
755 /* Do we still have a valid kernel network device? */
756 if (!netif_device_present(odev->net)) {
757 dev_err(&urb->dev->dev, "%s: net device not present\n",
762 /* log status, but don't act on it, we don't need to resubmit anything
765 log_usb_status(status, __func__);
767 hso_put_activity(odev->parent);
769 /* Tell the network interface we are ready for another frame */
770 netif_wake_queue(odev->net);
773 /* called by kernel when we need to transmit a packet */
774 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
775 struct net_device *net)
777 struct hso_net *odev = netdev_priv(net);
780 /* Tell the kernel, "No more frames 'til we are done with this one." */
781 netif_stop_queue(net);
782 if (hso_get_activity(odev->parent) == -EAGAIN) {
783 odev->skb_tx_buf = skb;
788 DUMP1(skb->data, skb->len);
789 /* Copy it from kernel memory to OUR memory */
790 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
791 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
793 /* Fill in the URB for shipping it out. */
794 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
796 usb_sndbulkpipe(odev->parent->usb,
798 bEndpointAddress & 0x7F),
799 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
802 /* Deal with the Zero Length packet problem, I hope */
803 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
805 /* Send the URB on its merry way. */
806 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
808 dev_warn(&odev->parent->interface->dev,
809 "failed mux_bulk_tx_urb %d", result);
810 net->stats.tx_errors++;
811 netif_start_queue(net);
813 net->stats.tx_packets++;
814 net->stats.tx_bytes += skb->len;
815 /* And tell the kernel when the last transmit started. */
816 net->trans_start = jiffies;
823 static void hso_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
825 struct hso_net *odev = netdev_priv(net);
827 strncpy(info->driver, driver_name, ETHTOOL_BUSINFO_LEN);
828 strncpy(info->version, DRIVER_VERSION, ETHTOOL_BUSINFO_LEN);
829 usb_make_path(odev->parent->usb, info->bus_info, sizeof info->bus_info);
832 static const struct ethtool_ops ops = {
833 .get_drvinfo = hso_get_drvinfo,
834 .get_link = ethtool_op_get_link
837 /* called when a packet did not ack after watchdogtimeout */
838 static void hso_net_tx_timeout(struct net_device *net)
840 struct hso_net *odev = netdev_priv(net);
845 /* Tell syslog we are hosed. */
846 dev_warn(&net->dev, "Tx timed out.\n");
848 /* Tear the waiting frame off the list */
849 if (odev->mux_bulk_tx_urb
850 && (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
851 usb_unlink_urb(odev->mux_bulk_tx_urb);
853 /* Update statistics */
854 net->stats.tx_errors++;
857 /* make a real packet from the received USB buffer */
858 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
859 unsigned int count, unsigned char is_eop)
861 unsigned short temp_bytes;
862 unsigned short buffer_offset = 0;
863 unsigned short frame_len;
864 unsigned char *tmp_rx_buf;
867 D1("Rx %d bytes", count);
868 DUMP(ip_pkt, min(128, (int)count));
871 switch (odev->rx_parse_state) {
873 /* waiting for IP header. */
874 /* wanted bytes - size of ip header */
877 odev->rx_buf_missing) ? count : odev->
880 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
881 odev->rx_buf_size, ip_pkt + buffer_offset,
884 odev->rx_buf_size += temp_bytes;
885 buffer_offset += temp_bytes;
886 odev->rx_buf_missing -= temp_bytes;
889 if (!odev->rx_buf_missing) {
890 /* header is complete allocate an sk_buffer and
891 * continue to WAIT_DATA */
892 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
894 if ((frame_len > DEFAULT_MRU) ||
895 (frame_len < sizeof(struct iphdr))) {
896 dev_err(&odev->net->dev,
897 "Invalid frame (%d) length\n",
899 odev->rx_parse_state = WAIT_SYNC;
902 /* Allocate an sk_buff */
903 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
905 if (!odev->skb_rx_buf) {
906 /* We got no receive buffer. */
907 D1("could not allocate memory");
908 odev->rx_parse_state = WAIT_SYNC;
912 /* Copy what we got so far. make room for iphdr
915 skb_put(odev->skb_rx_buf,
916 sizeof(struct iphdr));
917 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
918 sizeof(struct iphdr));
921 odev->rx_buf_size = sizeof(struct iphdr);
923 /* Filip actually use .tot_len */
924 odev->rx_buf_missing =
925 frame_len - sizeof(struct iphdr);
926 odev->rx_parse_state = WAIT_DATA;
931 temp_bytes = (count < odev->rx_buf_missing)
932 ? count : odev->rx_buf_missing;
934 /* Copy the rest of the bytes that are left in the
935 * buffer into the waiting sk_buf. */
936 /* Make room for temp_bytes after tail. */
937 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
938 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
940 odev->rx_buf_missing -= temp_bytes;
942 buffer_offset += temp_bytes;
943 odev->rx_buf_size += temp_bytes;
944 if (!odev->rx_buf_missing) {
945 /* Packet is complete. Inject into stack. */
946 /* We have IP packet here */
947 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
949 odev->skb_rx_buf->ip_summed =
950 CHECKSUM_UNNECESSARY;
952 skb_reset_mac_header(odev->skb_rx_buf);
954 /* Ship it off to the kernel */
955 netif_rx(odev->skb_rx_buf);
956 /* No longer our buffer. */
957 odev->skb_rx_buf = NULL;
959 /* update out statistics */
960 odev->net->stats.rx_packets++;
962 odev->net->stats.rx_bytes += odev->rx_buf_size;
964 odev->rx_buf_size = 0;
965 odev->rx_buf_missing = sizeof(struct iphdr);
966 odev->rx_parse_state = WAIT_IP;
981 /* Recovery mechanism for WAIT_SYNC state. */
983 if (odev->rx_parse_state == WAIT_SYNC) {
984 odev->rx_parse_state = WAIT_IP;
985 odev->rx_buf_size = 0;
986 odev->rx_buf_missing = sizeof(struct iphdr);
991 /* Moving data from usb to kernel (in interrupt state) */
992 static void read_bulk_callback(struct urb *urb)
994 struct hso_net *odev = urb->context;
995 struct net_device *net;
997 int status = urb->status;
999 /* is al ok? (Filip: Who's Al ?) */
1001 log_usb_status(status, __func__);
1006 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1007 D1("BULK IN callback but driver is not active!");
1010 usb_mark_last_busy(urb->dev);
1014 if (!netif_device_present(net)) {
1015 /* Somebody killed our network interface... */
1019 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
1021 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1022 rest = urb->actual_length % odev->in_endp->wMaxPacketSize;
1023 if (((rest == 5) || (rest == 6))
1024 && !memcmp(((u8 *) urb->transfer_buffer) +
1025 urb->actual_length - 4, crc_check, 4)) {
1026 urb->actual_length -= 4;
1030 /* do we even have a packet? */
1031 if (urb->actual_length) {
1032 /* Handle the IP stream, add header and push it onto network
1033 * stack if the packet is complete. */
1034 spin_lock(&odev->net_lock);
1035 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1036 (urb->transfer_buffer_length >
1037 urb->actual_length) ? 1 : 0);
1038 spin_unlock(&odev->net_lock);
1041 /* We are done with this URB, resubmit it. Prep the USB to wait for
1042 * another frame. Reuse same as received. */
1043 usb_fill_bulk_urb(urb,
1045 usb_rcvbulkpipe(odev->parent->usb,
1047 bEndpointAddress & 0x7F),
1048 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1049 read_bulk_callback, odev);
1051 /* Give this to the USB subsystem so it can tell us when more data
1053 result = usb_submit_urb(urb, GFP_ATOMIC);
1055 dev_warn(&odev->parent->interface->dev,
1056 "%s failed submit mux_bulk_rx_urb %d", __func__,
1060 /* Serial driver functions */
1062 static void hso_init_termios(struct ktermios *termios)
1065 * The default requirements for this device are:
1068 ~(IGNBRK /* disable ignore break */
1069 | BRKINT /* disable break causes interrupt */
1070 | PARMRK /* disable mark parity errors */
1071 | ISTRIP /* disable clear high bit of input characters */
1072 | INLCR /* disable translate NL to CR */
1073 | IGNCR /* disable ignore CR */
1074 | ICRNL /* disable translate CR to NL */
1075 | IXON); /* disable enable XON/XOFF flow control */
1077 /* disable postprocess output characters */
1078 termios->c_oflag &= ~OPOST;
1081 ~(ECHO /* disable echo input characters */
1082 | ECHONL /* disable echo new line */
1083 | ICANON /* disable erase, kill, werase, and rprnt
1084 special characters */
1085 | ISIG /* disable interrupt, quit, and suspend special
1087 | IEXTEN); /* disable non-POSIX special characters */
1090 ~(CSIZE /* no size */
1091 | PARENB /* disable parity bit */
1092 | CBAUD /* clear current baud rate */
1093 | CBAUDEX); /* clear current buad rate */
1095 termios->c_cflag |= CS8; /* character size 8 bits */
1097 /* baud rate 115200 */
1098 tty_termios_encode_baud_rate(termios, 115200, 115200);
1101 static void _hso_serial_set_termios(struct tty_struct *tty,
1102 struct ktermios *old)
1104 struct hso_serial *serial = get_serial_by_tty(tty);
1105 struct ktermios *termios;
1108 printk(KERN_ERR "%s: no tty structures", __func__);
1112 D4("port %d", serial->minor);
1115 * Fix up unsupported bits
1117 termios = tty->termios;
1118 termios->c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1121 ~(CSIZE /* no size */
1122 | PARENB /* disable parity bit */
1123 | CBAUD /* clear current baud rate */
1124 | CBAUDEX); /* clear current buad rate */
1126 termios->c_cflag |= CS8; /* character size 8 bits */
1128 /* baud rate 115200 */
1129 tty_encode_baud_rate(tty, 115200, 115200);
1132 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1135 #ifdef CONFIG_HSO_AUTOPM
1136 usb_mark_last_busy(urb->dev);
1138 /* We are done with this URB, resubmit it. Prep the USB to wait for
1140 usb_fill_bulk_urb(urb, serial->parent->usb,
1141 usb_rcvbulkpipe(serial->parent->usb,
1143 bEndpointAddress & 0x7F),
1144 urb->transfer_buffer, serial->rx_data_length,
1145 hso_std_serial_read_bulk_callback, serial);
1146 /* Give this to the USB subsystem so it can tell us when more data
1148 result = usb_submit_urb(urb, GFP_ATOMIC);
1150 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1158 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1161 struct urb *curr_urb;
1163 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1164 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1165 count = put_rxbuf_data(curr_urb, serial);
1169 serial->curr_rx_urb_idx++;
1170 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1171 serial->curr_rx_urb_idx = 0;
1172 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1177 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1182 urb = serial->rx_urb[0];
1183 if (serial->open_count > 0) {
1184 count = put_rxbuf_data(urb, serial);
1188 /* Re issue a read as long as we receive data. */
1190 if (count == 0 && ((urb->actual_length != 0) ||
1191 (serial->rx_state == RX_PENDING))) {
1192 serial->rx_state = RX_SENT;
1193 hso_mux_serial_read(serial);
1195 serial->rx_state = RX_IDLE;
1199 /* read callback for Diag and CS port */
1200 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1202 struct hso_serial *serial = urb->context;
1203 int status = urb->status;
1207 D1("serial == NULL");
1209 } else if (status) {
1210 log_usb_status(status, __func__);
1214 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1215 D1("Actual length = %d\n", urb->actual_length);
1216 DUMP1(urb->transfer_buffer, urb->actual_length);
1218 /* Anyone listening? */
1219 if (serial->open_count == 0)
1223 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1225 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1227 urb->actual_length %
1228 serial->in_endp->wMaxPacketSize;
1229 if (((rest == 5) || (rest == 6))
1230 && !memcmp(((u8 *) urb->transfer_buffer) +
1231 urb->actual_length - 4, crc_check, 4)) {
1232 urb->actual_length -= 4;
1235 /* Valid data, handle RX data */
1236 spin_lock(&serial->serial_lock);
1237 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1238 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1239 spin_unlock(&serial->serial_lock);
1240 } else if (status == -ENOENT || status == -ECONNRESET) {
1241 /* Unlinked - check for throttled port. */
1242 D2("Port %d, successfully unlinked urb", serial->minor);
1243 spin_lock(&serial->serial_lock);
1244 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1245 hso_resubmit_rx_bulk_urb(serial, urb);
1246 spin_unlock(&serial->serial_lock);
1248 D2("Port %d, status = %d for read urb", serial->minor, status);
1254 * This needs to be a tasklet otherwise we will
1255 * end up recursively calling this function.
1257 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1259 unsigned long flags;
1261 spin_lock_irqsave(&serial->serial_lock, flags);
1262 if ((serial->parent->port_spec & HSO_INTF_MUX))
1263 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1265 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1266 spin_unlock_irqrestore(&serial->serial_lock, flags);
1269 static void hso_unthrottle(struct tty_struct *tty)
1271 struct hso_serial *serial = get_serial_by_tty(tty);
1273 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1276 static void hso_unthrottle_workfunc(struct work_struct *work)
1278 struct hso_serial *serial =
1279 container_of(work, struct hso_serial,
1280 retry_unthrottle_workqueue);
1281 hso_unthrottle_tasklet(serial);
1284 /* open the requested serial port */
1285 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1287 struct hso_serial *serial = get_serial_by_index(tty->index);
1291 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1293 tty->driver_data = NULL;
1294 D1("Failed to open port");
1298 mutex_lock(&serial->parent->mutex);
1299 result = usb_autopm_get_interface(serial->parent->interface);
1303 D1("Opening %d", serial->minor);
1304 kref_get(&serial->parent->ref);
1307 spin_lock_irq(&serial->serial_lock);
1308 tty->driver_data = serial;
1309 tty_kref_put(serial->tty);
1310 serial->tty = tty_kref_get(tty);
1311 spin_unlock_irq(&serial->serial_lock);
1313 /* check for port already opened, if not set the termios */
1314 serial->open_count++;
1315 if (serial->open_count == 1) {
1316 tty->low_latency = 1;
1317 serial->rx_state = RX_IDLE;
1318 /* Force default termio settings */
1319 _hso_serial_set_termios(tty, NULL);
1320 tasklet_init(&serial->unthrottle_tasklet,
1321 (void (*)(unsigned long))hso_unthrottle_tasklet,
1322 (unsigned long)serial);
1323 INIT_WORK(&serial->retry_unthrottle_workqueue,
1324 hso_unthrottle_workfunc);
1325 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1327 hso_stop_serial_device(serial->parent);
1328 serial->open_count--;
1329 kref_put(&serial->parent->ref, hso_serial_ref_free);
1332 D1("Port was already open");
1335 usb_autopm_put_interface(serial->parent->interface);
1339 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1341 mutex_unlock(&serial->parent->mutex);
1345 /* close the requested serial port */
1346 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1348 struct hso_serial *serial = tty->driver_data;
1351 D1("Closing serial port");
1353 /* Open failed, no close cleanup required */
1357 mutex_lock(&serial->parent->mutex);
1358 usb_gone = serial->parent->usb_gone;
1361 usb_autopm_get_interface(serial->parent->interface);
1363 /* reset the rts and dtr */
1364 /* do the actual close */
1365 serial->open_count--;
1367 if (serial->open_count <= 0) {
1368 serial->open_count = 0;
1369 spin_lock_irq(&serial->serial_lock);
1370 if (serial->tty == tty) {
1371 serial->tty->driver_data = NULL;
1375 spin_unlock_irq(&serial->serial_lock);
1377 hso_stop_serial_device(serial->parent);
1378 tasklet_kill(&serial->unthrottle_tasklet);
1379 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1383 usb_autopm_put_interface(serial->parent->interface);
1385 mutex_unlock(&serial->parent->mutex);
1387 kref_put(&serial->parent->ref, hso_serial_ref_free);
1390 /* close the requested serial port */
1391 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1394 struct hso_serial *serial = get_serial_by_tty(tty);
1395 int space, tx_bytes;
1396 unsigned long flags;
1399 if (serial == NULL) {
1400 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1404 spin_lock_irqsave(&serial->serial_lock, flags);
1406 space = serial->tx_data_length - serial->tx_buffer_count;
1407 tx_bytes = (count < space) ? count : space;
1412 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1413 serial->tx_buffer_count += tx_bytes;
1416 spin_unlock_irqrestore(&serial->serial_lock, flags);
1418 hso_kick_transmit(serial);
1423 /* how much room is there for writing */
1424 static int hso_serial_write_room(struct tty_struct *tty)
1426 struct hso_serial *serial = get_serial_by_tty(tty);
1428 unsigned long flags;
1430 spin_lock_irqsave(&serial->serial_lock, flags);
1431 room = serial->tx_data_length - serial->tx_buffer_count;
1432 spin_unlock_irqrestore(&serial->serial_lock, flags);
1434 /* return free room */
1438 /* setup the term */
1439 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1441 struct hso_serial *serial = get_serial_by_tty(tty);
1442 unsigned long flags;
1445 D5("Termios called with: cflags new[%d] - old[%d]",
1446 tty->termios->c_cflag, old->c_cflag);
1448 /* the actual setup */
1449 spin_lock_irqsave(&serial->serial_lock, flags);
1450 if (serial->open_count)
1451 _hso_serial_set_termios(tty, old);
1454 spin_unlock_irqrestore(&serial->serial_lock, flags);
1460 /* how many characters in the buffer */
1461 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1463 struct hso_serial *serial = get_serial_by_tty(tty);
1465 unsigned long flags;
1471 spin_lock_irqsave(&serial->serial_lock, flags);
1472 chars = serial->tx_buffer_count;
1473 spin_unlock_irqrestore(&serial->serial_lock, flags);
1477 static int tiocmget_submit_urb(struct hso_serial *serial,
1478 struct hso_tiocmget *tiocmget,
1479 struct usb_device *usb)
1483 if (serial->parent->usb_gone)
1485 usb_fill_int_urb(tiocmget->urb, usb,
1488 bEndpointAddress & 0x7F),
1489 &tiocmget->serial_state_notification,
1490 sizeof(struct hso_serial_state_notification),
1491 tiocmget_intr_callback, serial,
1492 tiocmget->endp->bInterval);
1493 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1495 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1502 static void tiocmget_intr_callback(struct urb *urb)
1504 struct hso_serial *serial = urb->context;
1505 struct hso_tiocmget *tiocmget;
1506 int status = urb->status;
1507 u16 UART_state_bitmap, prev_UART_state_bitmap;
1508 struct uart_icount *icount;
1509 struct hso_serial_state_notification *serial_state_notification;
1510 struct usb_device *usb;
1516 log_usb_status(status, __func__);
1519 tiocmget = serial->tiocmget;
1522 usb = serial->parent->usb;
1523 serial_state_notification = &tiocmget->serial_state_notification;
1524 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1525 serial_state_notification->bNotification != B_NOTIFICATION ||
1526 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1527 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1528 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1530 "hso received invalid serial state notification\n");
1531 DUMP(serial_state_notification,
1532 sizeof(struct hso_serial_state_notification));
1535 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1537 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1538 icount = &tiocmget->icount;
1539 spin_lock(&serial->serial_lock);
1540 if ((UART_state_bitmap & B_OVERRUN) !=
1541 (prev_UART_state_bitmap & B_OVERRUN))
1543 if ((UART_state_bitmap & B_PARITY) !=
1544 (prev_UART_state_bitmap & B_PARITY))
1546 if ((UART_state_bitmap & B_FRAMING) !=
1547 (prev_UART_state_bitmap & B_FRAMING))
1549 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1550 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1552 if ((UART_state_bitmap & B_BREAK) !=
1553 (prev_UART_state_bitmap & B_BREAK))
1555 if ((UART_state_bitmap & B_TX_CARRIER) !=
1556 (prev_UART_state_bitmap & B_TX_CARRIER))
1558 if ((UART_state_bitmap & B_RX_CARRIER) !=
1559 (prev_UART_state_bitmap & B_RX_CARRIER))
1561 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1562 spin_unlock(&serial->serial_lock);
1563 tiocmget->intr_completed = 1;
1564 wake_up_interruptible(&tiocmget->waitq);
1566 memset(serial_state_notification, 0,
1567 sizeof(struct hso_serial_state_notification));
1568 tiocmget_submit_urb(serial,
1570 serial->parent->usb);
1574 * next few functions largely stolen from drivers/serial/serial_core.c
1576 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1577 * - mask passed in arg for lines of interest
1578 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1579 * Caller should use TIOCGICOUNT to see which one it was
1582 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1584 DECLARE_WAITQUEUE(wait, current);
1585 struct uart_icount cprev, cnow;
1586 struct hso_tiocmget *tiocmget;
1589 tiocmget = serial->tiocmget;
1593 * note the counters on entry
1595 spin_lock_irq(&serial->serial_lock);
1596 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1597 spin_unlock_irq(&serial->serial_lock);
1598 add_wait_queue(&tiocmget->waitq, &wait);
1600 spin_lock_irq(&serial->serial_lock);
1601 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1602 spin_unlock_irq(&serial->serial_lock);
1603 set_current_state(TASK_INTERRUPTIBLE);
1604 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1605 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1606 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1611 /* see if a signal did it */
1612 if (signal_pending(current)) {
1618 current->state = TASK_RUNNING;
1619 remove_wait_queue(&tiocmget->waitq, &wait);
1625 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1626 * Return: write counters to the user passed counter struct
1627 * NB: both 1->0 and 0->1 transitions are counted except for
1628 * RI where only 0->1 is counted.
1630 static int hso_get_count(struct hso_serial *serial,
1631 struct serial_icounter_struct __user *icnt)
1633 struct serial_icounter_struct icount;
1634 struct uart_icount cnow;
1635 struct hso_tiocmget *tiocmget = serial->tiocmget;
1639 spin_lock_irq(&serial->serial_lock);
1640 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1641 spin_unlock_irq(&serial->serial_lock);
1643 icount.cts = cnow.cts;
1644 icount.dsr = cnow.dsr;
1645 icount.rng = cnow.rng;
1646 icount.dcd = cnow.dcd;
1647 icount.rx = cnow.rx;
1648 icount.tx = cnow.tx;
1649 icount.frame = cnow.frame;
1650 icount.overrun = cnow.overrun;
1651 icount.parity = cnow.parity;
1652 icount.brk = cnow.brk;
1653 icount.buf_overrun = cnow.buf_overrun;
1655 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1659 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1662 struct hso_serial *serial = get_serial_by_tty(tty);
1663 struct hso_tiocmget *tiocmget;
1664 u16 UART_state_bitmap;
1668 D1("no tty structures");
1671 spin_lock_irq(&serial->serial_lock);
1672 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1673 ((serial->dtr_state) ? TIOCM_DTR : 0);
1674 tiocmget = serial->tiocmget;
1677 UART_state_bitmap = le16_to_cpu(
1678 tiocmget->prev_UART_state_bitmap);
1679 if (UART_state_bitmap & B_RING_SIGNAL)
1680 retval |= TIOCM_RNG;
1681 if (UART_state_bitmap & B_RX_CARRIER)
1683 if (UART_state_bitmap & B_TX_CARRIER)
1684 retval |= TIOCM_DSR;
1686 spin_unlock_irq(&serial->serial_lock);
1690 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1691 unsigned int set, unsigned int clear)
1694 unsigned long flags;
1696 struct hso_serial *serial = get_serial_by_tty(tty);
1700 D1("no tty structures");
1703 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1705 spin_lock_irqsave(&serial->serial_lock, flags);
1706 if (set & TIOCM_RTS)
1707 serial->rts_state = 1;
1708 if (set & TIOCM_DTR)
1709 serial->dtr_state = 1;
1711 if (clear & TIOCM_RTS)
1712 serial->rts_state = 0;
1713 if (clear & TIOCM_DTR)
1714 serial->dtr_state = 0;
1716 if (serial->dtr_state)
1718 if (serial->rts_state)
1721 spin_unlock_irqrestore(&serial->serial_lock, flags);
1723 return usb_control_msg(serial->parent->usb,
1724 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1725 0x21, val, if_num, NULL, 0,
1726 USB_CTRL_SET_TIMEOUT);
1729 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1730 unsigned int cmd, unsigned long arg)
1732 struct hso_serial *serial = get_serial_by_tty(tty);
1733 void __user *uarg = (void __user *)arg;
1735 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1741 ret = hso_wait_modem_status(serial, arg);
1745 ret = hso_get_count(serial, uarg);
1755 /* starts a transmit */
1756 static void hso_kick_transmit(struct hso_serial *serial)
1759 unsigned long flags;
1762 spin_lock_irqsave(&serial->serial_lock, flags);
1763 if (!serial->tx_buffer_count)
1766 if (serial->tx_urb_used)
1769 /* Wakeup USB interface if necessary */
1770 if (hso_get_activity(serial->parent) == -EAGAIN)
1773 /* Switch pointers around to avoid memcpy */
1774 temp = serial->tx_buffer;
1775 serial->tx_buffer = serial->tx_data;
1776 serial->tx_data = temp;
1777 serial->tx_data_count = serial->tx_buffer_count;
1778 serial->tx_buffer_count = 0;
1780 /* If temp is set, it means we switched buffers */
1781 if (temp && serial->write_data) {
1782 res = serial->write_data(serial);
1784 serial->tx_urb_used = 1;
1787 spin_unlock_irqrestore(&serial->serial_lock, flags);
1790 /* make a request (for reading and writing data to muxed serial port) */
1791 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1792 struct urb *ctrl_urb,
1793 struct usb_ctrlrequest *ctrl_req,
1794 u8 *ctrl_urb_data, u32 size)
1800 if (!serial || !ctrl_urb || !ctrl_req) {
1801 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1806 ctrl_req->wValue = 0;
1807 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1808 ctrl_req->wLength = cpu_to_le16(size);
1810 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1811 /* Reading command */
1812 ctrl_req->bRequestType = USB_DIR_IN |
1813 USB_TYPE_OPTION_VENDOR |
1814 USB_RECIP_INTERFACE;
1815 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1816 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1818 /* Writing command */
1819 ctrl_req->bRequestType = USB_DIR_OUT |
1820 USB_TYPE_OPTION_VENDOR |
1821 USB_RECIP_INTERFACE;
1822 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1823 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1826 D2("%s command (%02x) len: %d, port: %d",
1827 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1828 ctrl_req->bRequestType, ctrl_req->wLength, port);
1831 ctrl_urb->transfer_flags = 0;
1832 usb_fill_control_urb(ctrl_urb,
1833 serial->parent->usb,
1836 ctrl_urb_data, size, ctrl_callback, serial);
1837 /* Send it on merry way */
1838 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1840 dev_err(&ctrl_urb->dev->dev,
1841 "%s failed submit ctrl_urb %d type %d", __func__,
1850 /* called by intr_callback when read occurs */
1851 static int hso_mux_serial_read(struct hso_serial *serial)
1857 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1858 /* make the request */
1860 if (serial->num_rx_urbs != 1) {
1861 dev_err(&serial->parent->interface->dev,
1862 "ERROR: mux'd reads with multiple buffers "
1866 return mux_device_request(serial,
1867 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1868 serial->parent->port_spec & HSO_PORT_MASK,
1870 &serial->ctrl_req_rx,
1871 serial->rx_data[0], serial->rx_data_length);
1874 /* used for muxed serial port callback (muxed serial read) */
1875 static void intr_callback(struct urb *urb)
1877 struct hso_shared_int *shared_int = urb->context;
1878 struct hso_serial *serial;
1879 unsigned char *port_req;
1880 int status = urb->status;
1883 usb_mark_last_busy(urb->dev);
1891 log_usb_status(status, __func__);
1894 D4("\n--- Got intr callback 0x%02X ---", status);
1897 port_req = urb->transfer_buffer;
1898 D4(" port_req = 0x%.2X\n", *port_req);
1899 /* loop over all muxed ports to find the one sending this */
1900 for (i = 0; i < 8; i++) {
1901 /* max 8 channels on MUX */
1902 if (*port_req & (1 << i)) {
1903 serial = get_serial_by_shared_int_and_type(shared_int,
1905 if (serial != NULL) {
1906 D1("Pending read interrupt on port %d\n", i);
1907 spin_lock(&serial->serial_lock);
1908 if (serial->rx_state == RX_IDLE) {
1909 /* Setup and send a ctrl req read on
1911 if (!serial->rx_urb_filled[0]) {
1912 serial->rx_state = RX_SENT;
1913 hso_mux_serial_read(serial);
1915 serial->rx_state = RX_PENDING;
1918 D1("Already pending a read on "
1921 spin_unlock(&serial->serial_lock);
1925 /* Resubmit interrupt urb */
1926 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1929 /* called for writing to muxed serial port */
1930 static int hso_mux_serial_write_data(struct hso_serial *serial)
1935 return mux_device_request(serial,
1936 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1937 serial->parent->port_spec & HSO_PORT_MASK,
1939 &serial->ctrl_req_tx,
1940 serial->tx_data, serial->tx_data_count);
1943 /* write callback for Diag and CS port */
1944 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1946 struct hso_serial *serial = urb->context;
1947 int status = urb->status;
1948 struct tty_struct *tty;
1952 D1("serial == NULL");
1956 spin_lock(&serial->serial_lock);
1957 serial->tx_urb_used = 0;
1958 tty = tty_kref_get(serial->tty);
1959 spin_unlock(&serial->serial_lock);
1961 log_usb_status(status, __func__);
1965 hso_put_activity(serial->parent);
1970 hso_kick_transmit(serial);
1976 /* called for writing diag or CS serial port */
1977 static int hso_std_serial_write_data(struct hso_serial *serial)
1979 int count = serial->tx_data_count;
1982 usb_fill_bulk_urb(serial->tx_urb,
1983 serial->parent->usb,
1984 usb_sndbulkpipe(serial->parent->usb,
1986 bEndpointAddress & 0x7F),
1987 serial->tx_data, serial->tx_data_count,
1988 hso_std_serial_write_bulk_callback, serial);
1990 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1992 dev_warn(&serial->parent->usb->dev,
1993 "Failed to submit urb - res %d\n", result);
2000 /* callback after read or write on muxed serial port */
2001 static void ctrl_callback(struct urb *urb)
2003 struct hso_serial *serial = urb->context;
2004 struct usb_ctrlrequest *req;
2005 int status = urb->status;
2006 struct tty_struct *tty;
2012 spin_lock(&serial->serial_lock);
2013 serial->tx_urb_used = 0;
2014 tty = tty_kref_get(serial->tty);
2015 spin_unlock(&serial->serial_lock);
2017 log_usb_status(status, __func__);
2023 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2024 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2025 D4("Actual length of urb = %d\n", urb->actual_length);
2026 DUMP1(urb->transfer_buffer, urb->actual_length);
2028 if (req->bRequestType ==
2029 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2030 /* response to a read command */
2031 serial->rx_urb_filled[0] = 1;
2032 spin_lock(&serial->serial_lock);
2033 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2034 spin_unlock(&serial->serial_lock);
2036 hso_put_activity(serial->parent);
2039 /* response to a write command */
2040 hso_kick_transmit(serial);
2045 /* handle RX data for serial port */
2046 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2048 struct tty_struct *tty;
2049 int write_length_remaining = 0;
2053 if (urb == NULL || serial == NULL) {
2054 D1("serial = NULL");
2058 /* All callers to put_rxbuf_data hold serial_lock */
2059 tty = tty_kref_get(serial->tty);
2061 /* Push data to tty */
2063 write_length_remaining = urb->actual_length -
2064 serial->curr_rx_urb_offset;
2065 D1("data to push to tty");
2066 while (write_length_remaining) {
2067 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2071 curr_write_len = tty_insert_flip_string
2072 (tty, urb->transfer_buffer +
2073 serial->curr_rx_urb_offset,
2074 write_length_remaining);
2075 serial->curr_rx_urb_offset += curr_write_len;
2076 write_length_remaining -= curr_write_len;
2077 tty_flip_buffer_push(tty);
2080 if (write_length_remaining == 0) {
2081 serial->curr_rx_urb_offset = 0;
2082 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2085 return write_length_remaining;
2089 /* Base driver functions */
2091 static void hso_log_port(struct hso_device *hso_dev)
2096 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2097 case HSO_PORT_CONTROL:
2098 port_type = "Control";
2101 port_type = "Application";
2106 case HSO_PORT_GPS_CONTROL:
2107 port_type = "GPS control";
2110 port_type = "Application2";
2116 port_type = "Diagnostic";
2118 case HSO_PORT_DIAG2:
2119 port_type = "Diagnostic2";
2121 case HSO_PORT_MODEM:
2122 port_type = "Modem";
2124 case HSO_PORT_NETWORK:
2125 port_type = "Network";
2128 port_type = "Unknown";
2131 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2132 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2134 sprintf(port_dev, "/dev/%s%d", tty_filename,
2135 dev2ser(hso_dev)->minor);
2137 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2138 port_type, port_dev);
2141 static int hso_start_net_device(struct hso_device *hso_dev)
2144 struct hso_net *hso_net = dev2net(hso_dev);
2149 /* send URBs for all read buffers */
2150 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2152 /* Prep a receive URB */
2153 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2155 usb_rcvbulkpipe(hso_dev->usb,
2157 bEndpointAddress & 0x7F),
2158 hso_net->mux_bulk_rx_buf_pool[i],
2159 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2162 /* Put it out there so the device can send us stuff */
2163 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2166 dev_warn(&hso_dev->usb->dev,
2167 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2174 static int hso_stop_net_device(struct hso_device *hso_dev)
2177 struct hso_net *hso_net = dev2net(hso_dev);
2182 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2183 if (hso_net->mux_bulk_rx_urb_pool[i])
2184 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2187 if (hso_net->mux_bulk_tx_urb)
2188 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2193 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2196 struct hso_serial *serial = dev2ser(hso_dev);
2201 /* If it is not the MUX port fill in and submit a bulk urb (already
2202 * allocated in hso_serial_start) */
2203 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2204 for (i = 0; i < serial->num_rx_urbs; i++) {
2205 usb_fill_bulk_urb(serial->rx_urb[i],
2206 serial->parent->usb,
2207 usb_rcvbulkpipe(serial->parent->usb,
2212 serial->rx_data_length,
2213 hso_std_serial_read_bulk_callback,
2215 result = usb_submit_urb(serial->rx_urb[i], flags);
2217 dev_warn(&serial->parent->usb->dev,
2218 "Failed to submit urb - res %d\n",
2224 mutex_lock(&serial->shared_int->shared_int_lock);
2225 if (!serial->shared_int->use_count) {
2227 hso_mux_submit_intr_urb(serial->shared_int,
2228 hso_dev->usb, flags);
2230 serial->shared_int->use_count++;
2231 mutex_unlock(&serial->shared_int->shared_int_lock);
2233 if (serial->tiocmget)
2234 tiocmget_submit_urb(serial,
2236 serial->parent->usb);
2240 static int hso_stop_serial_device(struct hso_device *hso_dev)
2243 struct hso_serial *serial = dev2ser(hso_dev);
2244 struct hso_tiocmget *tiocmget;
2249 for (i = 0; i < serial->num_rx_urbs; i++) {
2250 if (serial->rx_urb[i]) {
2251 usb_kill_urb(serial->rx_urb[i]);
2252 serial->rx_urb_filled[i] = 0;
2255 serial->curr_rx_urb_idx = 0;
2256 serial->curr_rx_urb_offset = 0;
2259 usb_kill_urb(serial->tx_urb);
2261 if (serial->shared_int) {
2262 mutex_lock(&serial->shared_int->shared_int_lock);
2263 if (serial->shared_int->use_count &&
2264 (--serial->shared_int->use_count == 0)) {
2267 urb = serial->shared_int->shared_intr_urb;
2271 mutex_unlock(&serial->shared_int->shared_int_lock);
2273 tiocmget = serial->tiocmget;
2275 wake_up_interruptible(&tiocmget->waitq);
2276 usb_kill_urb(tiocmget->urb);
2282 static void hso_serial_common_free(struct hso_serial *serial)
2286 if (serial->parent->dev)
2287 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2289 tty_unregister_device(tty_drv, serial->minor);
2291 for (i = 0; i < serial->num_rx_urbs; i++) {
2292 /* unlink and free RX URB */
2293 usb_free_urb(serial->rx_urb[i]);
2294 /* free the RX buffer */
2295 kfree(serial->rx_data[i]);
2298 /* unlink and free TX URB */
2299 usb_free_urb(serial->tx_urb);
2300 kfree(serial->tx_data);
2303 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2304 int rx_size, int tx_size)
2310 minor = get_free_serial_index();
2314 /* register our minor number */
2315 serial->parent->dev = tty_register_device(tty_drv, minor,
2316 &serial->parent->interface->dev);
2317 dev = serial->parent->dev;
2318 dev_set_drvdata(dev, serial->parent);
2319 i = device_create_file(dev, &dev_attr_hsotype);
2321 /* fill in specific data for later use */
2322 serial->minor = minor;
2323 serial->magic = HSO_SERIAL_MAGIC;
2324 spin_lock_init(&serial->serial_lock);
2325 serial->num_rx_urbs = num_urbs;
2327 /* RX, allocate urb and initialize */
2329 /* prepare our RX buffer */
2330 serial->rx_data_length = rx_size;
2331 for (i = 0; i < serial->num_rx_urbs; i++) {
2332 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2333 if (!serial->rx_urb[i]) {
2334 dev_err(dev, "Could not allocate urb?\n");
2337 serial->rx_urb[i]->transfer_buffer = NULL;
2338 serial->rx_urb[i]->transfer_buffer_length = 0;
2339 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2341 if (!serial->rx_data[i]) {
2342 dev_err(dev, "%s - Out of memory\n", __func__);
2347 /* TX, allocate urb and initialize */
2348 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2349 if (!serial->tx_urb) {
2350 dev_err(dev, "Could not allocate urb?\n");
2353 serial->tx_urb->transfer_buffer = NULL;
2354 serial->tx_urb->transfer_buffer_length = 0;
2355 /* prepare our TX buffer */
2356 serial->tx_data_count = 0;
2357 serial->tx_buffer_count = 0;
2358 serial->tx_data_length = tx_size;
2359 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2360 if (!serial->tx_data) {
2361 dev_err(dev, "%s - Out of memory", __func__);
2364 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2365 if (!serial->tx_buffer) {
2366 dev_err(dev, "%s - Out of memory", __func__);
2372 hso_serial_common_free(serial);
2376 /* Creates a general hso device */
2377 static struct hso_device *hso_create_device(struct usb_interface *intf,
2380 struct hso_device *hso_dev;
2382 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2386 hso_dev->port_spec = port_spec;
2387 hso_dev->usb = interface_to_usbdev(intf);
2388 hso_dev->interface = intf;
2389 kref_init(&hso_dev->ref);
2390 mutex_init(&hso_dev->mutex);
2392 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2393 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2398 /* Removes a network device in the network device table */
2399 static int remove_net_device(struct hso_device *hso_dev)
2403 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2404 if (network_table[i] == hso_dev) {
2405 network_table[i] = NULL;
2409 if (i == HSO_MAX_NET_DEVICES)
2414 /* Frees our network device */
2415 static void hso_free_net_device(struct hso_device *hso_dev)
2418 struct hso_net *hso_net = dev2net(hso_dev);
2423 remove_net_device(hso_net->parent);
2426 unregister_netdev(hso_net->net);
2427 free_netdev(hso_net->net);
2431 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2432 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2433 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2434 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2436 usb_free_urb(hso_net->mux_bulk_tx_urb);
2437 kfree(hso_net->mux_bulk_tx_buf);
2438 hso_net->mux_bulk_tx_buf = NULL;
2443 static const struct net_device_ops hso_netdev_ops = {
2444 .ndo_open = hso_net_open,
2445 .ndo_stop = hso_net_close,
2446 .ndo_start_xmit = hso_net_start_xmit,
2447 .ndo_tx_timeout = hso_net_tx_timeout,
2450 /* initialize the network interface */
2451 static void hso_net_init(struct net_device *net)
2453 struct hso_net *hso_net = netdev_priv(net);
2455 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2457 /* fill in the other fields */
2458 net->netdev_ops = &hso_netdev_ops;
2459 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2460 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2461 net->type = ARPHRD_NONE;
2462 net->mtu = DEFAULT_MTU - 14;
2463 net->tx_queue_len = 10;
2464 SET_ETHTOOL_OPS(net, &ops);
2466 /* and initialize the semaphore */
2467 spin_lock_init(&hso_net->net_lock);
2470 /* Adds a network device in the network device table */
2471 static int add_net_device(struct hso_device *hso_dev)
2475 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2476 if (network_table[i] == NULL) {
2477 network_table[i] = hso_dev;
2481 if (i == HSO_MAX_NET_DEVICES)
2486 static int hso_rfkill_set_block(void *data, bool blocked)
2488 struct hso_device *hso_dev = data;
2489 int enabled = !blocked;
2492 mutex_lock(&hso_dev->mutex);
2493 if (hso_dev->usb_gone)
2496 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2497 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2498 USB_CTRL_SET_TIMEOUT);
2499 mutex_unlock(&hso_dev->mutex);
2503 static const struct rfkill_ops hso_rfkill_ops = {
2504 .set_block = hso_rfkill_set_block,
2507 /* Creates and sets up everything for rfkill */
2508 static void hso_create_rfkill(struct hso_device *hso_dev,
2509 struct usb_interface *interface)
2511 struct hso_net *hso_net = dev2net(hso_dev);
2512 struct device *dev = &hso_net->net->dev;
2515 rfkn = kzalloc(20, GFP_KERNEL);
2517 dev_err(dev, "%s - Out of memory\n", __func__);
2519 snprintf(rfkn, 20, "hso-%d",
2520 interface->altsetting->desc.bInterfaceNumber);
2522 hso_net->rfkill = rfkill_alloc(rfkn,
2523 &interface_to_usbdev(interface)->dev,
2525 &hso_rfkill_ops, hso_dev);
2526 if (!hso_net->rfkill) {
2527 dev_err(dev, "%s - Out of memory\n", __func__);
2531 if (rfkill_register(hso_net->rfkill) < 0) {
2532 rfkill_destroy(hso_net->rfkill);
2534 hso_net->rfkill = NULL;
2535 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2540 static struct device_type hso_type = {
2544 /* Creates our network device */
2545 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2549 struct net_device *net;
2550 struct hso_net *hso_net;
2551 struct hso_device *hso_dev;
2553 hso_dev = hso_create_device(interface, port_spec);
2557 /* allocate our network device, then we can put in our private data */
2558 /* call hso_net_init to do the basic initialization */
2559 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2561 dev_err(&interface->dev, "Unable to create ethernet device\n");
2565 hso_net = netdev_priv(net);
2567 hso_dev->port_data.dev_net = hso_net;
2569 hso_net->parent = hso_dev;
2571 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2573 if (!hso_net->in_endp) {
2574 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2577 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2579 if (!hso_net->out_endp) {
2580 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2583 SET_NETDEV_DEV(net, &interface->dev);
2584 SET_NETDEV_DEVTYPE(net, &hso_type);
2586 /* registering our net device */
2587 result = register_netdev(net);
2589 dev_err(&interface->dev, "Failed to register device\n");
2593 /* start allocating */
2594 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2595 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2596 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2597 dev_err(&interface->dev, "Could not allocate rx urb\n");
2600 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2602 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2603 dev_err(&interface->dev, "Could not allocate rx buf\n");
2607 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2608 if (!hso_net->mux_bulk_tx_urb) {
2609 dev_err(&interface->dev, "Could not allocate tx urb\n");
2612 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2613 if (!hso_net->mux_bulk_tx_buf) {
2614 dev_err(&interface->dev, "Could not allocate tx buf\n");
2618 add_net_device(hso_dev);
2620 hso_log_port(hso_dev);
2622 hso_create_rfkill(hso_dev, interface);
2626 hso_free_net_device(hso_dev);
2630 static void hso_free_tiomget(struct hso_serial *serial)
2632 struct hso_tiocmget *tiocmget = serial->tiocmget;
2634 if (tiocmget->urb) {
2635 usb_free_urb(tiocmget->urb);
2636 tiocmget->urb = NULL;
2638 serial->tiocmget = NULL;
2644 /* Frees an AT channel ( goes for both mux and non-mux ) */
2645 static void hso_free_serial_device(struct hso_device *hso_dev)
2647 struct hso_serial *serial = dev2ser(hso_dev);
2651 set_serial_by_index(serial->minor, NULL);
2653 hso_serial_common_free(serial);
2655 if (serial->shared_int) {
2656 mutex_lock(&serial->shared_int->shared_int_lock);
2657 if (--serial->shared_int->ref_count == 0)
2658 hso_free_shared_int(serial->shared_int);
2660 mutex_unlock(&serial->shared_int->shared_int_lock);
2662 hso_free_tiomget(serial);
2667 /* Creates a bulk AT channel */
2668 static struct hso_device *hso_create_bulk_serial_device(
2669 struct usb_interface *interface, int port)
2671 struct hso_device *hso_dev;
2672 struct hso_serial *serial;
2674 struct hso_tiocmget *tiocmget;
2676 hso_dev = hso_create_device(interface, port);
2680 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2684 serial->parent = hso_dev;
2685 hso_dev->port_data.dev_serial = serial;
2687 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2689 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2691 /* it isn't going to break our heart if serial->tiocmget
2692 * allocation fails don't bother checking this.
2694 if (serial->tiocmget) {
2695 tiocmget = serial->tiocmget;
2696 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2697 if (tiocmget->urb) {
2698 mutex_init(&tiocmget->mutex);
2699 init_waitqueue_head(&tiocmget->waitq);
2700 tiocmget->endp = hso_get_ep(
2702 USB_ENDPOINT_XFER_INT,
2705 hso_free_tiomget(serial);
2711 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2715 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2717 if (!serial->in_endp) {
2718 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2724 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2725 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2729 serial->write_data = hso_std_serial_write_data;
2731 /* and record this serial */
2732 set_serial_by_index(serial->minor, serial);
2734 /* setup the proc dirs and files if needed */
2735 hso_log_port(hso_dev);
2737 /* done, return it */
2741 hso_serial_common_free(serial);
2743 hso_free_tiomget(serial);
2749 /* Creates a multiplexed AT channel */
2751 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2753 struct hso_shared_int *mux)
2755 struct hso_device *hso_dev;
2756 struct hso_serial *serial;
2759 port_spec = HSO_INTF_MUX;
2760 port_spec &= ~HSO_PORT_MASK;
2762 port_spec |= hso_mux_to_port(port);
2763 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2766 hso_dev = hso_create_device(interface, port_spec);
2770 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2774 hso_dev->port_data.dev_serial = serial;
2775 serial->parent = hso_dev;
2777 if (hso_serial_common_create
2778 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2781 serial->tx_data_length--;
2782 serial->write_data = hso_mux_serial_write_data;
2784 serial->shared_int = mux;
2785 mutex_lock(&serial->shared_int->shared_int_lock);
2786 serial->shared_int->ref_count++;
2787 mutex_unlock(&serial->shared_int->shared_int_lock);
2789 /* and record this serial */
2790 set_serial_by_index(serial->minor, serial);
2792 /* setup the proc dirs and files if needed */
2793 hso_log_port(hso_dev);
2795 /* done, return it */
2800 tty_unregister_device(tty_drv, serial->minor);
2809 static void hso_free_shared_int(struct hso_shared_int *mux)
2811 usb_free_urb(mux->shared_intr_urb);
2812 kfree(mux->shared_intr_buf);
2813 mutex_unlock(&mux->shared_int_lock);
2818 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2820 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2825 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2827 if (!mux->intr_endp) {
2828 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2832 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2833 if (!mux->shared_intr_urb) {
2834 dev_err(&interface->dev, "Could not allocate intr urb?");
2837 mux->shared_intr_buf = kzalloc(mux->intr_endp->wMaxPacketSize,
2839 if (!mux->shared_intr_buf) {
2840 dev_err(&interface->dev, "Could not allocate intr buf?");
2844 mutex_init(&mux->shared_int_lock);
2849 kfree(mux->shared_intr_buf);
2850 usb_free_urb(mux->shared_intr_urb);
2855 /* Gets the port spec for a certain interface */
2856 static int hso_get_config_data(struct usb_interface *interface)
2858 struct usb_device *usbdev = interface_to_usbdev(interface);
2860 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2863 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2864 0x86, 0xC0, 0, 0, config_data, 17,
2865 USB_CTRL_SET_TIMEOUT) != 0x11) {
2869 switch (config_data[if_num]) {
2874 result = HSO_PORT_DIAG;
2877 result = HSO_PORT_GPS;
2880 result = HSO_PORT_GPS_CONTROL;
2883 result = HSO_PORT_APP;
2886 result = HSO_PORT_APP2;
2889 result = HSO_PORT_CONTROL;
2892 result = HSO_PORT_NETWORK;
2895 result = HSO_PORT_MODEM;
2898 result = HSO_PORT_MSD;
2901 result = HSO_PORT_PCSC;
2904 result = HSO_PORT_VOICE;
2911 result |= HSO_INTF_BULK;
2913 if (config_data[16] & 0x1)
2914 result |= HSO_INFO_CRC_BUG;
2919 /* called once for each interface upon device insertion */
2920 static int hso_probe(struct usb_interface *interface,
2921 const struct usb_device_id *id)
2923 int mux, i, if_num, port_spec;
2924 unsigned char port_mask;
2925 struct hso_device *hso_dev = NULL;
2926 struct hso_shared_int *shared_int;
2927 struct hso_device *tmp_dev = NULL;
2929 if_num = interface->altsetting->desc.bInterfaceNumber;
2931 /* Get the interface/port specification from either driver_info or from
2932 * the device itself */
2933 if (id->driver_info)
2934 port_spec = ((u32 *)(id->driver_info))[if_num];
2936 port_spec = hso_get_config_data(interface);
2938 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2939 dev_err(&interface->dev, "Not our interface\n");
2942 /* Check if we need to switch to alt interfaces prior to port
2944 if (interface->num_altsetting > 1)
2945 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2946 interface->needs_remote_wakeup = 1;
2948 /* Allocate new hso device(s) */
2949 switch (port_spec & HSO_INTF_MASK) {
2951 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2952 /* Create the network device */
2954 hso_dev = hso_create_net_device(interface,
2962 if (hso_get_mux_ports(interface, &port_mask))
2963 /* TODO: de-allocate everything */
2966 shared_int = hso_create_shared_int(interface);
2970 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2971 if (port_mask & i) {
2972 hso_dev = hso_create_mux_serial_device(
2973 interface, i, shared_int);
2984 /* It's a regular bulk interface */
2985 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK)
2987 hso_dev = hso_create_net_device(interface, port_spec);
2990 hso_create_bulk_serial_device(interface, port_spec);
2998 /* save our data pointer in this device */
2999 usb_set_intfdata(interface, hso_dev);
3004 hso_free_interface(interface);
3008 /* device removed, cleaning up */
3009 static void hso_disconnect(struct usb_interface *interface)
3011 hso_free_interface(interface);
3013 /* remove reference of our private data */
3014 usb_set_intfdata(interface, NULL);
3017 static void async_get_intf(struct work_struct *data)
3019 struct hso_device *hso_dev =
3020 container_of(data, struct hso_device, async_get_intf);
3021 usb_autopm_get_interface(hso_dev->interface);
3024 static void async_put_intf(struct work_struct *data)
3026 struct hso_device *hso_dev =
3027 container_of(data, struct hso_device, async_put_intf);
3028 usb_autopm_put_interface(hso_dev->interface);
3031 static int hso_get_activity(struct hso_device *hso_dev)
3033 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3034 if (!hso_dev->is_active) {
3035 hso_dev->is_active = 1;
3036 schedule_work(&hso_dev->async_get_intf);
3040 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3043 usb_mark_last_busy(hso_dev->usb);
3048 static int hso_put_activity(struct hso_device *hso_dev)
3050 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3051 if (hso_dev->is_active) {
3052 hso_dev->is_active = 0;
3053 schedule_work(&hso_dev->async_put_intf);
3057 hso_dev->is_active = 0;
3061 /* called by kernel when we need to suspend device */
3062 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3066 /* Stop all serial ports */
3067 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3068 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3069 result = hso_stop_serial_device(serial_table[i]);
3075 /* Stop all network ports */
3076 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3077 if (network_table[i] &&
3078 (network_table[i]->interface == iface)) {
3079 result = hso_stop_net_device(network_table[i]);
3089 /* called by kernel when we need to resume device */
3090 static int hso_resume(struct usb_interface *iface)
3093 struct hso_net *hso_net;
3095 /* Start all serial ports */
3096 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3097 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3098 if (dev2ser(serial_table[i])->open_count) {
3100 hso_start_serial_device(serial_table[i], GFP_NOIO);
3101 hso_kick_transmit(dev2ser(serial_table[i]));
3108 /* Start all network ports */
3109 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3110 if (network_table[i] &&
3111 (network_table[i]->interface == iface)) {
3112 hso_net = dev2net(network_table[i]);
3113 if (hso_net->flags & IFF_UP) {
3114 /* First transmit any lingering data,
3115 then restart the device. */
3116 if (hso_net->skb_tx_buf) {
3117 dev_dbg(&iface->dev,
3119 " lingering data\n");
3120 hso_net_start_xmit(hso_net->skb_tx_buf,
3122 hso_net->skb_tx_buf = NULL;
3124 result = hso_start_net_device(network_table[i]);
3135 static void hso_serial_ref_free(struct kref *ref)
3137 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3139 hso_free_serial_device(hso_dev);
3142 static void hso_free_interface(struct usb_interface *interface)
3144 struct hso_serial *hso_dev;
3145 struct tty_struct *tty;
3148 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3150 && (serial_table[i]->interface == interface)) {
3151 hso_dev = dev2ser(serial_table[i]);
3152 spin_lock_irq(&hso_dev->serial_lock);
3153 tty = tty_kref_get(hso_dev->tty);
3154 spin_unlock_irq(&hso_dev->serial_lock);
3157 mutex_lock(&hso_dev->parent->mutex);
3159 hso_dev->parent->usb_gone = 1;
3160 mutex_unlock(&hso_dev->parent->mutex);
3161 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3165 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3166 if (network_table[i]
3167 && (network_table[i]->interface == interface)) {
3168 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3169 /* hso_stop_net_device doesn't stop the net queue since
3170 * traffic needs to start it again when suspended */
3171 netif_stop_queue(dev2net(network_table[i])->net);
3172 hso_stop_net_device(network_table[i]);
3173 cancel_work_sync(&network_table[i]->async_put_intf);
3174 cancel_work_sync(&network_table[i]->async_get_intf);
3176 rfkill_unregister(rfk);
3177 rfkill_destroy(rfk);
3179 hso_free_net_device(network_table[i]);
3184 /* Helper functions */
3186 /* Get the endpoint ! */
3187 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3191 struct usb_host_interface *iface = intf->cur_altsetting;
3192 struct usb_endpoint_descriptor *endp;
3194 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3195 endp = &iface->endpoint[i].desc;
3196 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3197 (usb_endpoint_type(endp) == type))
3204 /* Get the byte that describes which ports are enabled */
3205 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3208 struct usb_host_interface *iface = intf->cur_altsetting;
3210 if (iface->extralen == 3) {
3211 *ports = iface->extra[2];
3215 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3216 if (iface->endpoint[i].extralen == 3) {
3217 *ports = iface->endpoint[i].extra[2];
3225 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3226 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3227 struct usb_device *usb, gfp_t gfp)
3231 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3233 shared_int->intr_endp->bEndpointAddress & 0x7F),
3234 shared_int->shared_intr_buf,
3235 shared_int->intr_endp->wMaxPacketSize,
3236 intr_callback, shared_int,
3237 shared_int->intr_endp->bInterval);
3239 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3241 dev_warn(&usb->dev, "%s failed mux_intr_urb %d", __func__,
3247 /* operations setup of the serial interface */
3248 static const struct tty_operations hso_serial_ops = {
3249 .open = hso_serial_open,
3250 .close = hso_serial_close,
3251 .write = hso_serial_write,
3252 .write_room = hso_serial_write_room,
3253 .ioctl = hso_serial_ioctl,
3254 .set_termios = hso_serial_set_termios,
3255 .chars_in_buffer = hso_serial_chars_in_buffer,
3256 .tiocmget = hso_serial_tiocmget,
3257 .tiocmset = hso_serial_tiocmset,
3258 .unthrottle = hso_unthrottle
3261 static struct usb_driver hso_driver = {
3262 .name = driver_name,
3264 .disconnect = hso_disconnect,
3265 .id_table = hso_ids,
3266 .suspend = hso_suspend,
3267 .resume = hso_resume,
3268 .reset_resume = hso_resume,
3269 .supports_autosuspend = 1,
3272 static int __init hso_init(void)
3277 /* put it in the log */
3278 printk(KERN_INFO "hso: %s\n", version);
3280 /* Initialise the serial table semaphore and table */
3281 spin_lock_init(&serial_table_lock);
3282 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3283 serial_table[i] = NULL;
3285 /* allocate our driver using the proper amount of supported minors */
3286 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3290 /* fill in all needed values */
3291 tty_drv->magic = TTY_DRIVER_MAGIC;
3292 tty_drv->owner = THIS_MODULE;
3293 tty_drv->driver_name = driver_name;
3294 tty_drv->name = tty_filename;
3296 /* if major number is provided as parameter, use that one */
3298 tty_drv->major = tty_major;
3300 tty_drv->minor_start = 0;
3301 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3302 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3303 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3304 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3305 tty_drv->init_termios = tty_std_termios;
3306 hso_init_termios(&tty_drv->init_termios);
3307 tty_set_operations(tty_drv, &hso_serial_ops);
3309 /* register the tty driver */
3310 result = tty_register_driver(tty_drv);
3312 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3317 /* register this module as an usb driver */
3318 result = usb_register(&hso_driver);
3320 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3322 /* cleanup serial interface */
3323 tty_unregister_driver(tty_drv);
3331 static void __exit hso_exit(void)
3333 printk(KERN_INFO "hso: unloaded\n");
3335 tty_unregister_driver(tty_drv);
3336 /* deregister the usb driver */
3337 usb_deregister(&hso_driver);
3340 /* Module definitions */
3341 module_init(hso_init);
3342 module_exit(hso_exit);
3344 MODULE_AUTHOR(MOD_AUTHOR);
3345 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3346 MODULE_LICENSE(MOD_LICENSE);
3347 MODULE_INFO(Version, DRIVER_VERSION);
3349 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3350 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3351 module_param(debug, int, S_IRUGO | S_IWUSR);
3353 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3354 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3355 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3357 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3358 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3359 module_param(disable_net, int, S_IRUGO | S_IWUSR);