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 MOD_AUTHOR "Option Wireless"
77 #define MOD_DESCRIPTION "USB High Speed Option driver"
78 #define MOD_LICENSE "GPL"
80 #define HSO_MAX_NET_DEVICES 10
81 #define HSO__MAX_MTU 2048
82 #define DEFAULT_MTU 1500
83 #define DEFAULT_MRU 1500
85 #define CTRL_URB_RX_SIZE 1024
86 #define CTRL_URB_TX_SIZE 64
88 #define BULK_URB_RX_SIZE 4096
89 #define BULK_URB_TX_SIZE 8192
91 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
92 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
93 #define MUX_BULK_RX_BUF_COUNT 4
94 #define USB_TYPE_OPTION_VENDOR 0x20
96 /* These definitions are used with the struct hso_net flags element */
97 /* - use *_bit operations on it. (bit indices not values.) */
98 #define HSO_NET_RUNNING 0
100 #define HSO_NET_TX_TIMEOUT (HZ*10)
102 #define HSO_SERIAL_MAGIC 0x48534f31
104 /* Number of ttys to handle */
105 #define HSO_SERIAL_TTY_MINORS 256
107 #define MAX_RX_URBS 2
109 /*****************************************************************************/
110 /* Debugging functions */
111 /*****************************************************************************/
112 #define D__(lvl_, fmt, arg...) \
114 printk(lvl_ "[%d:%s]: " fmt "\n", \
115 __LINE__, __func__, ## arg); \
118 #define D_(lvl, args...) \
121 D__(KERN_INFO, args); \
124 #define D1(args...) D_(0x01, ##args)
125 #define D2(args...) D_(0x02, ##args)
126 #define D3(args...) D_(0x04, ##args)
127 #define D4(args...) D_(0x08, ##args)
128 #define D5(args...) D_(0x10, ##args)
130 /*****************************************************************************/
132 /*****************************************************************************/
133 enum pkt_parse_state {
139 /*****************************************************************************/
141 /*****************************************************************************/
143 struct hso_shared_int {
144 struct usb_endpoint_descriptor *intr_endp;
145 void *shared_intr_buf;
146 struct urb *shared_intr_urb;
147 struct usb_device *usb;
150 struct mutex shared_int_lock;
154 struct hso_device *parent;
155 struct net_device *net;
156 struct rfkill *rfkill;
158 struct usb_endpoint_descriptor *in_endp;
159 struct usb_endpoint_descriptor *out_endp;
161 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
162 struct urb *mux_bulk_tx_urb;
163 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
164 void *mux_bulk_tx_buf;
166 struct sk_buff *skb_rx_buf;
167 struct sk_buff *skb_tx_buf;
169 enum pkt_parse_state rx_parse_state;
172 unsigned short rx_buf_size;
173 unsigned short rx_buf_missing;
174 struct iphdr rx_ip_hdr;
185 #define BM_REQUEST_TYPE (0xa1)
186 #define B_NOTIFICATION (0x20)
187 #define W_VALUE (0x0)
188 #define W_LENGTH (0x2)
190 #define B_OVERRUN (0x1<<6)
191 #define B_PARITY (0x1<<5)
192 #define B_FRAMING (0x1<<4)
193 #define B_RING_SIGNAL (0x1<<3)
194 #define B_BREAK (0x1<<2)
195 #define B_TX_CARRIER (0x1<<1)
196 #define B_RX_CARRIER (0x1<<0)
198 struct hso_serial_state_notification {
204 u16 UART_state_bitmap;
207 struct hso_tiocmget {
209 wait_queue_head_t waitq;
211 struct usb_endpoint_descriptor *endp;
213 struct hso_serial_state_notification serial_state_notification;
214 u16 prev_UART_state_bitmap;
215 struct uart_icount icount;
220 struct hso_device *parent;
224 struct hso_shared_int *shared_int;
226 /* rx/tx urb could be either a bulk urb or a control urb depending
227 on which serial port it is used on. */
228 struct urb *rx_urb[MAX_RX_URBS];
230 u8 *rx_data[MAX_RX_URBS];
231 u16 rx_data_length; /* should contain allocated length */
236 u16 tx_data_length; /* should contain allocated length */
239 struct usb_ctrlrequest ctrl_req_tx;
240 struct usb_ctrlrequest ctrl_req_rx;
242 struct usb_endpoint_descriptor *in_endp;
243 struct usb_endpoint_descriptor *out_endp;
245 enum rx_ctrl_state rx_state;
248 unsigned tx_urb_used:1;
250 struct tty_port port;
251 /* from usb_serial_port */
252 spinlock_t serial_lock;
254 int (*write_data) (struct hso_serial *serial);
255 struct hso_tiocmget *tiocmget;
256 /* Hacks required to get flow control
257 * working on the serial receive buffers
258 * so as not to drop characters on the floor.
261 u8 rx_urb_filled[MAX_RX_URBS];
262 struct tasklet_struct unthrottle_tasklet;
267 struct hso_serial *dev_serial;
268 struct hso_net *dev_net;
275 struct work_struct async_get_intf;
276 struct work_struct async_put_intf;
277 struct work_struct reset_device;
279 struct usb_device *usb;
280 struct usb_interface *interface;
287 /* Type of interface */
288 #define HSO_INTF_MASK 0xFF00
289 #define HSO_INTF_MUX 0x0100
290 #define HSO_INTF_BULK 0x0200
293 #define HSO_PORT_MASK 0xFF
294 #define HSO_PORT_NO_PORT 0x0
295 #define HSO_PORT_CONTROL 0x1
296 #define HSO_PORT_APP 0x2
297 #define HSO_PORT_GPS 0x3
298 #define HSO_PORT_PCSC 0x4
299 #define HSO_PORT_APP2 0x5
300 #define HSO_PORT_GPS_CONTROL 0x6
301 #define HSO_PORT_MSD 0x7
302 #define HSO_PORT_VOICE 0x8
303 #define HSO_PORT_DIAG2 0x9
304 #define HSO_PORT_DIAG 0x10
305 #define HSO_PORT_MODEM 0x11
306 #define HSO_PORT_NETWORK 0x12
308 /* Additional device info */
309 #define HSO_INFO_MASK 0xFF000000
310 #define HSO_INFO_CRC_BUG 0x01000000
312 /*****************************************************************************/
314 /*****************************************************************************/
315 /* Serial driver functions */
316 static int hso_serial_tiocmset(struct tty_struct *tty,
317 unsigned int set, unsigned int clear);
318 static void ctrl_callback(struct urb *urb);
319 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
320 static void hso_kick_transmit(struct hso_serial *serial);
321 /* Helper functions */
322 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
323 struct usb_device *usb, gfp_t gfp);
324 static void handle_usb_error(int status, const char *function,
325 struct hso_device *hso_dev);
326 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
328 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
329 static void hso_free_interface(struct usb_interface *intf);
330 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
331 static int hso_stop_serial_device(struct hso_device *hso_dev);
332 static int hso_start_net_device(struct hso_device *hso_dev);
333 static void hso_free_shared_int(struct hso_shared_int *shared_int);
334 static int hso_stop_net_device(struct hso_device *hso_dev);
335 static void hso_serial_ref_free(struct kref *ref);
336 static void hso_std_serial_read_bulk_callback(struct urb *urb);
337 static int hso_mux_serial_read(struct hso_serial *serial);
338 static void async_get_intf(struct work_struct *data);
339 static void async_put_intf(struct work_struct *data);
340 static int hso_put_activity(struct hso_device *hso_dev);
341 static int hso_get_activity(struct hso_device *hso_dev);
342 static void tiocmget_intr_callback(struct urb *urb);
343 static void reset_device(struct work_struct *data);
344 /*****************************************************************************/
345 /* Helping functions */
346 /*****************************************************************************/
350 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
352 return hso_dev->port_data.dev_net;
355 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
357 return hso_dev->port_data.dev_serial;
360 /* Debugging functions */
362 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
365 static char name[255];
367 sprintf(name, "hso[%d:%s]", line_count, func_name);
368 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
371 #define DUMP(buf_, len_) \
372 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
374 #define DUMP1(buf_, len_) \
380 #define DUMP(buf_, len_)
381 #define DUMP1(buf_, len_)
384 /* module parameters */
386 static int tty_major;
387 static int disable_net;
390 static const char driver_name[] = "hso";
391 static const char tty_filename[] = "ttyHS";
392 static const char *version = __FILE__ ": " MOD_AUTHOR;
393 /* the usb driver itself (registered in hso_init) */
394 static struct usb_driver hso_driver;
395 /* serial structures */
396 static struct tty_driver *tty_drv;
397 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
398 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
399 static spinlock_t serial_table_lock;
401 static const s32 default_port_spec[] = {
402 HSO_INTF_MUX | HSO_PORT_NETWORK,
403 HSO_INTF_BULK | HSO_PORT_DIAG,
404 HSO_INTF_BULK | HSO_PORT_MODEM,
408 static const s32 icon321_port_spec[] = {
409 HSO_INTF_MUX | HSO_PORT_NETWORK,
410 HSO_INTF_BULK | HSO_PORT_DIAG2,
411 HSO_INTF_BULK | HSO_PORT_MODEM,
412 HSO_INTF_BULK | HSO_PORT_DIAG,
416 #define default_port_device(vendor, product) \
417 USB_DEVICE(vendor, product), \
418 .driver_info = (kernel_ulong_t)default_port_spec
420 #define icon321_port_device(vendor, product) \
421 USB_DEVICE(vendor, product), \
422 .driver_info = (kernel_ulong_t)icon321_port_spec
424 /* list of devices we support */
425 static const struct usb_device_id hso_ids[] = {
426 {default_port_device(0x0af0, 0x6711)},
427 {default_port_device(0x0af0, 0x6731)},
428 {default_port_device(0x0af0, 0x6751)},
429 {default_port_device(0x0af0, 0x6771)},
430 {default_port_device(0x0af0, 0x6791)},
431 {default_port_device(0x0af0, 0x6811)},
432 {default_port_device(0x0af0, 0x6911)},
433 {default_port_device(0x0af0, 0x6951)},
434 {default_port_device(0x0af0, 0x6971)},
435 {default_port_device(0x0af0, 0x7011)},
436 {default_port_device(0x0af0, 0x7031)},
437 {default_port_device(0x0af0, 0x7051)},
438 {default_port_device(0x0af0, 0x7071)},
439 {default_port_device(0x0af0, 0x7111)},
440 {default_port_device(0x0af0, 0x7211)},
441 {default_port_device(0x0af0, 0x7251)},
442 {default_port_device(0x0af0, 0x7271)},
443 {default_port_device(0x0af0, 0x7311)},
444 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
445 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
446 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
447 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
448 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
449 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
450 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
451 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
452 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
453 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
454 {USB_DEVICE(0x0af0, 0x7701)},
455 {USB_DEVICE(0x0af0, 0x7706)},
456 {USB_DEVICE(0x0af0, 0x7801)},
457 {USB_DEVICE(0x0af0, 0x7901)},
458 {USB_DEVICE(0x0af0, 0x7A01)},
459 {USB_DEVICE(0x0af0, 0x7A05)},
460 {USB_DEVICE(0x0af0, 0x8200)},
461 {USB_DEVICE(0x0af0, 0x8201)},
462 {USB_DEVICE(0x0af0, 0x8300)},
463 {USB_DEVICE(0x0af0, 0x8302)},
464 {USB_DEVICE(0x0af0, 0x8304)},
465 {USB_DEVICE(0x0af0, 0x8400)},
466 {USB_DEVICE(0x0af0, 0x8600)},
467 {USB_DEVICE(0x0af0, 0x8800)},
468 {USB_DEVICE(0x0af0, 0x8900)},
469 {USB_DEVICE(0x0af0, 0x9000)},
470 {USB_DEVICE(0x0af0, 0xd035)},
471 {USB_DEVICE(0x0af0, 0xd055)},
472 {USB_DEVICE(0x0af0, 0xd155)},
473 {USB_DEVICE(0x0af0, 0xd255)},
474 {USB_DEVICE(0x0af0, 0xd057)},
475 {USB_DEVICE(0x0af0, 0xd157)},
476 {USB_DEVICE(0x0af0, 0xd257)},
477 {USB_DEVICE(0x0af0, 0xd357)},
478 {USB_DEVICE(0x0af0, 0xd058)},
479 {USB_DEVICE(0x0af0, 0xc100)},
482 MODULE_DEVICE_TABLE(usb, hso_ids);
484 /* Sysfs attribute */
485 static ssize_t hso_sysfs_show_porttype(struct device *dev,
486 struct device_attribute *attr,
489 struct hso_device *hso_dev = dev_get_drvdata(dev);
495 switch (hso_dev->port_spec & HSO_PORT_MASK) {
496 case HSO_PORT_CONTROL:
497 port_name = "Control";
500 port_name = "Application";
503 port_name = "Application2";
508 case HSO_PORT_GPS_CONTROL:
509 port_name = "GPS Control";
515 port_name = "Diagnostic";
518 port_name = "Diagnostic2";
523 case HSO_PORT_NETWORK:
524 port_name = "Network";
527 port_name = "Unknown";
531 return sprintf(buf, "%s\n", port_name);
533 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
535 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
539 for (idx = 0; idx < serial->num_rx_urbs; idx++)
540 if (serial->rx_urb[idx] == urb)
542 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
546 /* converts mux value to a port spec value */
547 static u32 hso_mux_to_port(int mux)
553 result = HSO_PORT_CONTROL;
556 result = HSO_PORT_APP;
559 result = HSO_PORT_PCSC;
562 result = HSO_PORT_GPS;
565 result = HSO_PORT_APP2;
568 result = HSO_PORT_NO_PORT;
573 /* converts port spec value to a mux value */
574 static u32 hso_port_to_mux(int port)
578 switch (port & HSO_PORT_MASK) {
579 case HSO_PORT_CONTROL:
600 static struct hso_serial *get_serial_by_shared_int_and_type(
601 struct hso_shared_int *shared_int,
606 port = hso_mux_to_port(mux);
608 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
609 if (serial_table[i] &&
610 (dev2ser(serial_table[i])->shared_int == shared_int) &&
611 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
612 return dev2ser(serial_table[i]);
619 static struct hso_serial *get_serial_by_index(unsigned index)
621 struct hso_serial *serial = NULL;
624 spin_lock_irqsave(&serial_table_lock, flags);
625 if (serial_table[index])
626 serial = dev2ser(serial_table[index]);
627 spin_unlock_irqrestore(&serial_table_lock, flags);
632 static int get_free_serial_index(void)
637 spin_lock_irqsave(&serial_table_lock, flags);
638 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
639 if (serial_table[index] == NULL) {
640 spin_unlock_irqrestore(&serial_table_lock, flags);
644 spin_unlock_irqrestore(&serial_table_lock, flags);
646 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
650 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
654 spin_lock_irqsave(&serial_table_lock, flags);
656 serial_table[index] = serial->parent;
658 serial_table[index] = NULL;
659 spin_unlock_irqrestore(&serial_table_lock, flags);
662 static void handle_usb_error(int status, const char *function,
663 struct hso_device *hso_dev)
669 explanation = "no device";
672 explanation = "endpoint not enabled";
675 explanation = "endpoint stalled";
678 explanation = "not enough bandwidth";
681 explanation = "device disabled";
684 explanation = "device suspended";
690 explanation = "internal error";
696 explanation = "protocol error";
698 schedule_work(&hso_dev->reset_device);
701 explanation = "unknown status";
705 /* log a meaningful explanation of an USB status */
706 D1("%s: received USB status - %s (%d)", function, explanation, status);
709 /* Network interface functions */
711 /* called when net interface is brought up by ifconfig */
712 static int hso_net_open(struct net_device *net)
714 struct hso_net *odev = netdev_priv(net);
715 unsigned long flags = 0;
718 dev_err(&net->dev, "No net device !\n");
722 odev->skb_tx_buf = NULL;
724 /* setup environment */
725 spin_lock_irqsave(&odev->net_lock, flags);
726 odev->rx_parse_state = WAIT_IP;
727 odev->rx_buf_size = 0;
728 odev->rx_buf_missing = sizeof(struct iphdr);
729 spin_unlock_irqrestore(&odev->net_lock, flags);
731 /* We are up and running. */
732 set_bit(HSO_NET_RUNNING, &odev->flags);
733 hso_start_net_device(odev->parent);
735 /* Tell the kernel we are ready to start receiving from it */
736 netif_start_queue(net);
741 /* called when interface is brought down by ifconfig */
742 static int hso_net_close(struct net_device *net)
744 struct hso_net *odev = netdev_priv(net);
746 /* we don't need the queue anymore */
747 netif_stop_queue(net);
748 /* no longer running */
749 clear_bit(HSO_NET_RUNNING, &odev->flags);
751 hso_stop_net_device(odev->parent);
757 /* USB tells is xmit done, we should start the netqueue again */
758 static void write_bulk_callback(struct urb *urb)
760 struct hso_net *odev = urb->context;
761 int status = urb->status;
764 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
765 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
769 /* Do we still have a valid kernel network device? */
770 if (!netif_device_present(odev->net)) {
771 dev_err(&urb->dev->dev, "%s: net device not present\n",
776 /* log status, but don't act on it, we don't need to resubmit anything
779 handle_usb_error(status, __func__, odev->parent);
781 hso_put_activity(odev->parent);
783 /* Tell the network interface we are ready for another frame */
784 netif_wake_queue(odev->net);
787 /* called by kernel when we need to transmit a packet */
788 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
789 struct net_device *net)
791 struct hso_net *odev = netdev_priv(net);
794 /* Tell the kernel, "No more frames 'til we are done with this one." */
795 netif_stop_queue(net);
796 if (hso_get_activity(odev->parent) == -EAGAIN) {
797 odev->skb_tx_buf = skb;
802 DUMP1(skb->data, skb->len);
803 /* Copy it from kernel memory to OUR memory */
804 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
805 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
807 /* Fill in the URB for shipping it out. */
808 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
810 usb_sndbulkpipe(odev->parent->usb,
812 bEndpointAddress & 0x7F),
813 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
816 /* Deal with the Zero Length packet problem, I hope */
817 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
819 /* Send the URB on its merry way. */
820 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
822 dev_warn(&odev->parent->interface->dev,
823 "failed mux_bulk_tx_urb %d\n", result);
824 net->stats.tx_errors++;
825 netif_start_queue(net);
827 net->stats.tx_packets++;
828 net->stats.tx_bytes += skb->len;
835 static const struct ethtool_ops ops = {
836 .get_link = ethtool_op_get_link
839 /* called when a packet did not ack after watchdogtimeout */
840 static void hso_net_tx_timeout(struct net_device *net)
842 struct hso_net *odev = netdev_priv(net);
847 /* Tell syslog we are hosed. */
848 dev_warn(&net->dev, "Tx timed out.\n");
850 /* Tear the waiting frame off the list */
851 if (odev->mux_bulk_tx_urb &&
852 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
853 usb_unlink_urb(odev->mux_bulk_tx_urb);
855 /* Update statistics */
856 net->stats.tx_errors++;
859 /* make a real packet from the received USB buffer */
860 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
861 unsigned int count, unsigned char is_eop)
863 unsigned short temp_bytes;
864 unsigned short buffer_offset = 0;
865 unsigned short frame_len;
866 unsigned char *tmp_rx_buf;
869 D1("Rx %d bytes", count);
870 DUMP(ip_pkt, min(128, (int)count));
873 switch (odev->rx_parse_state) {
875 /* waiting for IP header. */
876 /* wanted bytes - size of ip header */
879 odev->rx_buf_missing) ? count : odev->
882 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
883 odev->rx_buf_size, ip_pkt + buffer_offset,
886 odev->rx_buf_size += temp_bytes;
887 buffer_offset += temp_bytes;
888 odev->rx_buf_missing -= temp_bytes;
891 if (!odev->rx_buf_missing) {
892 /* header is complete allocate an sk_buffer and
893 * continue to WAIT_DATA */
894 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
896 if ((frame_len > DEFAULT_MRU) ||
897 (frame_len < sizeof(struct iphdr))) {
898 dev_err(&odev->net->dev,
899 "Invalid frame (%d) length\n",
901 odev->rx_parse_state = WAIT_SYNC;
904 /* Allocate an sk_buff */
905 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
907 if (!odev->skb_rx_buf) {
908 /* We got no receive buffer. */
909 D1("could not allocate memory");
910 odev->rx_parse_state = WAIT_SYNC;
914 /* Copy what we got so far. make room for iphdr
917 skb_put(odev->skb_rx_buf,
918 sizeof(struct iphdr));
919 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
920 sizeof(struct iphdr));
923 odev->rx_buf_size = sizeof(struct iphdr);
925 /* Filip actually use .tot_len */
926 odev->rx_buf_missing =
927 frame_len - sizeof(struct iphdr);
928 odev->rx_parse_state = WAIT_DATA;
933 temp_bytes = (count < odev->rx_buf_missing)
934 ? count : odev->rx_buf_missing;
936 /* Copy the rest of the bytes that are left in the
937 * buffer into the waiting sk_buf. */
938 /* Make room for temp_bytes after tail. */
939 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
940 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
942 odev->rx_buf_missing -= temp_bytes;
944 buffer_offset += temp_bytes;
945 odev->rx_buf_size += temp_bytes;
946 if (!odev->rx_buf_missing) {
947 /* Packet is complete. Inject into stack. */
948 /* We have IP packet here */
949 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
950 skb_reset_mac_header(odev->skb_rx_buf);
952 /* Ship it off to the kernel */
953 netif_rx(odev->skb_rx_buf);
954 /* No longer our buffer. */
955 odev->skb_rx_buf = NULL;
957 /* update out statistics */
958 odev->net->stats.rx_packets++;
960 odev->net->stats.rx_bytes += odev->rx_buf_size;
962 odev->rx_buf_size = 0;
963 odev->rx_buf_missing = sizeof(struct iphdr);
964 odev->rx_parse_state = WAIT_IP;
979 /* Recovery mechanism for WAIT_SYNC state. */
981 if (odev->rx_parse_state == WAIT_SYNC) {
982 odev->rx_parse_state = WAIT_IP;
983 odev->rx_buf_size = 0;
984 odev->rx_buf_missing = sizeof(struct iphdr);
989 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size)
991 static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
992 u32 rest = urb->actual_length % le16_to_cpu(max_packet_size);
994 if (((rest == 5) || (rest == 6)) &&
995 !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4,
997 urb->actual_length -= 4;
1001 /* Moving data from usb to kernel (in interrupt state) */
1002 static void read_bulk_callback(struct urb *urb)
1004 struct hso_net *odev = urb->context;
1005 struct net_device *net;
1007 int status = urb->status;
1009 /* is al ok? (Filip: Who's Al ?) */
1011 handle_usb_error(status, __func__, odev->parent);
1016 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1017 D1("BULK IN callback but driver is not active!");
1020 usb_mark_last_busy(urb->dev);
1024 if (!netif_device_present(net)) {
1025 /* Somebody killed our network interface... */
1029 if (odev->parent->port_spec & HSO_INFO_CRC_BUG)
1030 fix_crc_bug(urb, odev->in_endp->wMaxPacketSize);
1032 /* do we even have a packet? */
1033 if (urb->actual_length) {
1034 /* Handle the IP stream, add header and push it onto network
1035 * stack if the packet is complete. */
1036 spin_lock(&odev->net_lock);
1037 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1038 (urb->transfer_buffer_length >
1039 urb->actual_length) ? 1 : 0);
1040 spin_unlock(&odev->net_lock);
1043 /* We are done with this URB, resubmit it. Prep the USB to wait for
1044 * another frame. Reuse same as received. */
1045 usb_fill_bulk_urb(urb,
1047 usb_rcvbulkpipe(odev->parent->usb,
1049 bEndpointAddress & 0x7F),
1050 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1051 read_bulk_callback, odev);
1053 /* Give this to the USB subsystem so it can tell us when more data
1055 result = usb_submit_urb(urb, GFP_ATOMIC);
1057 dev_warn(&odev->parent->interface->dev,
1058 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1062 /* Serial driver functions */
1064 static void hso_init_termios(struct ktermios *termios)
1067 * The default requirements for this device are:
1070 ~(IGNBRK /* disable ignore break */
1071 | BRKINT /* disable break causes interrupt */
1072 | PARMRK /* disable mark parity errors */
1073 | ISTRIP /* disable clear high bit of input characters */
1074 | INLCR /* disable translate NL to CR */
1075 | IGNCR /* disable ignore CR */
1076 | ICRNL /* disable translate CR to NL */
1077 | IXON); /* disable enable XON/XOFF flow control */
1079 /* disable postprocess output characters */
1080 termios->c_oflag &= ~OPOST;
1083 ~(ECHO /* disable echo input characters */
1084 | ECHONL /* disable echo new line */
1085 | ICANON /* disable erase, kill, werase, and rprnt
1086 special characters */
1087 | ISIG /* disable interrupt, quit, and suspend special
1089 | IEXTEN); /* disable non-POSIX special characters */
1092 ~(CSIZE /* no size */
1093 | PARENB /* disable parity bit */
1094 | CBAUD /* clear current baud rate */
1095 | CBAUDEX); /* clear current buad rate */
1097 termios->c_cflag |= CS8; /* character size 8 bits */
1099 /* baud rate 115200 */
1100 tty_termios_encode_baud_rate(termios, 115200, 115200);
1103 static void _hso_serial_set_termios(struct tty_struct *tty,
1104 struct ktermios *old)
1106 struct hso_serial *serial = tty->driver_data;
1109 printk(KERN_ERR "%s: no tty structures", __func__);
1113 D4("port %d", serial->minor);
1116 * Fix up unsupported bits
1118 tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1120 tty->termios.c_cflag &=
1121 ~(CSIZE /* no size */
1122 | PARENB /* disable parity bit */
1123 | CBAUD /* clear current baud rate */
1124 | CBAUDEX); /* clear current buad rate */
1126 tty->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 /* We are done with this URB, resubmit it. Prep the USB to wait for
1137 usb_fill_bulk_urb(urb, serial->parent->usb,
1138 usb_rcvbulkpipe(serial->parent->usb,
1140 bEndpointAddress & 0x7F),
1141 urb->transfer_buffer, serial->rx_data_length,
1142 hso_std_serial_read_bulk_callback, serial);
1143 /* Give this to the USB subsystem so it can tell us when more data
1145 result = usb_submit_urb(urb, GFP_ATOMIC);
1147 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1155 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1158 struct urb *curr_urb;
1160 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1161 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1162 count = put_rxbuf_data(curr_urb, serial);
1166 serial->curr_rx_urb_idx++;
1167 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1168 serial->curr_rx_urb_idx = 0;
1169 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1174 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1179 urb = serial->rx_urb[0];
1180 if (serial->port.count > 0) {
1181 count = put_rxbuf_data(urb, serial);
1185 /* Re issue a read as long as we receive data. */
1187 if (count == 0 && ((urb->actual_length != 0) ||
1188 (serial->rx_state == RX_PENDING))) {
1189 serial->rx_state = RX_SENT;
1190 hso_mux_serial_read(serial);
1192 serial->rx_state = RX_IDLE;
1196 /* read callback for Diag and CS port */
1197 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1199 struct hso_serial *serial = urb->context;
1200 int status = urb->status;
1202 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1206 D1("serial == NULL");
1210 handle_usb_error(status, __func__, serial->parent);
1214 D1("Actual length = %d\n", urb->actual_length);
1215 DUMP1(urb->transfer_buffer, urb->actual_length);
1217 /* Anyone listening? */
1218 if (serial->port.count == 0)
1221 if (serial->parent->port_spec & HSO_INFO_CRC_BUG)
1222 fix_crc_bug(urb, serial->in_endp->wMaxPacketSize);
1223 /* Valid data, handle RX data */
1224 spin_lock(&serial->serial_lock);
1225 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1226 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1227 spin_unlock(&serial->serial_lock);
1231 * This needs to be a tasklet otherwise we will
1232 * end up recursively calling this function.
1234 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1236 unsigned long flags;
1238 spin_lock_irqsave(&serial->serial_lock, flags);
1239 if ((serial->parent->port_spec & HSO_INTF_MUX))
1240 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1242 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1243 spin_unlock_irqrestore(&serial->serial_lock, flags);
1246 static void hso_unthrottle(struct tty_struct *tty)
1248 struct hso_serial *serial = tty->driver_data;
1250 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1253 /* open the requested serial port */
1254 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1256 struct hso_serial *serial = get_serial_by_index(tty->index);
1260 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1262 tty->driver_data = NULL;
1263 D1("Failed to open port");
1267 mutex_lock(&serial->parent->mutex);
1268 result = usb_autopm_get_interface(serial->parent->interface);
1272 D1("Opening %d", serial->minor);
1273 kref_get(&serial->parent->ref);
1276 tty->driver_data = serial;
1277 tty_port_tty_set(&serial->port, tty);
1279 /* check for port already opened, if not set the termios */
1280 serial->port.count++;
1281 if (serial->port.count == 1) {
1282 serial->rx_state = RX_IDLE;
1283 /* Force default termio settings */
1284 _hso_serial_set_termios(tty, NULL);
1285 tasklet_init(&serial->unthrottle_tasklet,
1286 (void (*)(unsigned long))hso_unthrottle_tasklet,
1287 (unsigned long)serial);
1288 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1290 hso_stop_serial_device(serial->parent);
1291 serial->port.count--;
1292 kref_put(&serial->parent->ref, hso_serial_ref_free);
1295 D1("Port was already open");
1298 usb_autopm_put_interface(serial->parent->interface);
1302 hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0);
1304 mutex_unlock(&serial->parent->mutex);
1308 /* close the requested serial port */
1309 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1311 struct hso_serial *serial = tty->driver_data;
1314 D1("Closing serial port");
1316 /* Open failed, no close cleanup required */
1320 mutex_lock(&serial->parent->mutex);
1321 usb_gone = serial->parent->usb_gone;
1324 usb_autopm_get_interface(serial->parent->interface);
1326 /* reset the rts and dtr */
1327 /* do the actual close */
1328 serial->port.count--;
1330 if (serial->port.count <= 0) {
1331 serial->port.count = 0;
1332 tty_port_tty_set(&serial->port, NULL);
1334 hso_stop_serial_device(serial->parent);
1335 tasklet_kill(&serial->unthrottle_tasklet);
1339 usb_autopm_put_interface(serial->parent->interface);
1341 mutex_unlock(&serial->parent->mutex);
1343 kref_put(&serial->parent->ref, hso_serial_ref_free);
1346 /* close the requested serial port */
1347 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1350 struct hso_serial *serial = tty->driver_data;
1351 int space, tx_bytes;
1352 unsigned long flags;
1355 if (serial == NULL) {
1356 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1360 spin_lock_irqsave(&serial->serial_lock, flags);
1362 space = serial->tx_data_length - serial->tx_buffer_count;
1363 tx_bytes = (count < space) ? count : space;
1368 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1369 serial->tx_buffer_count += tx_bytes;
1372 spin_unlock_irqrestore(&serial->serial_lock, flags);
1374 hso_kick_transmit(serial);
1379 /* how much room is there for writing */
1380 static int hso_serial_write_room(struct tty_struct *tty)
1382 struct hso_serial *serial = tty->driver_data;
1384 unsigned long flags;
1386 spin_lock_irqsave(&serial->serial_lock, flags);
1387 room = serial->tx_data_length - serial->tx_buffer_count;
1388 spin_unlock_irqrestore(&serial->serial_lock, flags);
1390 /* return free room */
1394 /* setup the term */
1395 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1397 struct hso_serial *serial = tty->driver_data;
1398 unsigned long flags;
1401 D5("Termios called with: cflags new[%d] - old[%d]",
1402 tty->termios.c_cflag, old->c_cflag);
1404 /* the actual setup */
1405 spin_lock_irqsave(&serial->serial_lock, flags);
1406 if (serial->port.count)
1407 _hso_serial_set_termios(tty, old);
1409 tty->termios = *old;
1410 spin_unlock_irqrestore(&serial->serial_lock, flags);
1415 /* how many characters in the buffer */
1416 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1418 struct hso_serial *serial = tty->driver_data;
1420 unsigned long flags;
1426 spin_lock_irqsave(&serial->serial_lock, flags);
1427 chars = serial->tx_buffer_count;
1428 spin_unlock_irqrestore(&serial->serial_lock, flags);
1432 static int tiocmget_submit_urb(struct hso_serial *serial,
1433 struct hso_tiocmget *tiocmget,
1434 struct usb_device *usb)
1438 if (serial->parent->usb_gone)
1440 usb_fill_int_urb(tiocmget->urb, usb,
1443 bEndpointAddress & 0x7F),
1444 &tiocmget->serial_state_notification,
1445 sizeof(struct hso_serial_state_notification),
1446 tiocmget_intr_callback, serial,
1447 tiocmget->endp->bInterval);
1448 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1450 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1457 static void tiocmget_intr_callback(struct urb *urb)
1459 struct hso_serial *serial = urb->context;
1460 struct hso_tiocmget *tiocmget;
1461 int status = urb->status;
1462 u16 UART_state_bitmap, prev_UART_state_bitmap;
1463 struct uart_icount *icount;
1464 struct hso_serial_state_notification *serial_state_notification;
1465 struct usb_device *usb;
1472 handle_usb_error(status, __func__, serial->parent);
1476 /* tiocmget is only supported on HSO_PORT_MODEM */
1477 tiocmget = serial->tiocmget;
1480 BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1482 usb = serial->parent->usb;
1483 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1485 /* wIndex should be the USB interface number of the port to which the
1486 * notification applies, which should always be the Modem port.
1488 serial_state_notification = &tiocmget->serial_state_notification;
1489 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1490 serial_state_notification->bNotification != B_NOTIFICATION ||
1491 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1492 le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1493 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1495 "hso received invalid serial state notification\n");
1496 DUMP(serial_state_notification,
1497 sizeof(struct hso_serial_state_notification));
1500 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1502 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1503 icount = &tiocmget->icount;
1504 spin_lock(&serial->serial_lock);
1505 if ((UART_state_bitmap & B_OVERRUN) !=
1506 (prev_UART_state_bitmap & B_OVERRUN))
1508 if ((UART_state_bitmap & B_PARITY) !=
1509 (prev_UART_state_bitmap & B_PARITY))
1511 if ((UART_state_bitmap & B_FRAMING) !=
1512 (prev_UART_state_bitmap & B_FRAMING))
1514 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1515 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1517 if ((UART_state_bitmap & B_BREAK) !=
1518 (prev_UART_state_bitmap & B_BREAK))
1520 if ((UART_state_bitmap & B_TX_CARRIER) !=
1521 (prev_UART_state_bitmap & B_TX_CARRIER))
1523 if ((UART_state_bitmap & B_RX_CARRIER) !=
1524 (prev_UART_state_bitmap & B_RX_CARRIER))
1526 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1527 spin_unlock(&serial->serial_lock);
1528 tiocmget->intr_completed = 1;
1529 wake_up_interruptible(&tiocmget->waitq);
1531 memset(serial_state_notification, 0,
1532 sizeof(struct hso_serial_state_notification));
1533 tiocmget_submit_urb(serial,
1535 serial->parent->usb);
1539 * next few functions largely stolen from drivers/serial/serial_core.c
1541 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1542 * - mask passed in arg for lines of interest
1543 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1544 * Caller should use TIOCGICOUNT to see which one it was
1547 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1549 DECLARE_WAITQUEUE(wait, current);
1550 struct uart_icount cprev, cnow;
1551 struct hso_tiocmget *tiocmget;
1554 tiocmget = serial->tiocmget;
1558 * note the counters on entry
1560 spin_lock_irq(&serial->serial_lock);
1561 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1562 spin_unlock_irq(&serial->serial_lock);
1563 add_wait_queue(&tiocmget->waitq, &wait);
1565 spin_lock_irq(&serial->serial_lock);
1566 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1567 spin_unlock_irq(&serial->serial_lock);
1568 set_current_state(TASK_INTERRUPTIBLE);
1569 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1570 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1571 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1576 /* see if a signal did it */
1577 if (signal_pending(current)) {
1583 current->state = TASK_RUNNING;
1584 remove_wait_queue(&tiocmget->waitq, &wait);
1590 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1591 * Return: write counters to the user passed counter struct
1592 * NB: both 1->0 and 0->1 transitions are counted except for
1593 * RI where only 0->1 is counted.
1595 static int hso_get_count(struct tty_struct *tty,
1596 struct serial_icounter_struct *icount)
1598 struct uart_icount cnow;
1599 struct hso_serial *serial = tty->driver_data;
1600 struct hso_tiocmget *tiocmget = serial->tiocmget;
1602 memset(icount, 0, sizeof(struct serial_icounter_struct));
1606 spin_lock_irq(&serial->serial_lock);
1607 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1608 spin_unlock_irq(&serial->serial_lock);
1610 icount->cts = cnow.cts;
1611 icount->dsr = cnow.dsr;
1612 icount->rng = cnow.rng;
1613 icount->dcd = cnow.dcd;
1614 icount->rx = cnow.rx;
1615 icount->tx = cnow.tx;
1616 icount->frame = cnow.frame;
1617 icount->overrun = cnow.overrun;
1618 icount->parity = cnow.parity;
1619 icount->brk = cnow.brk;
1620 icount->buf_overrun = cnow.buf_overrun;
1626 static int hso_serial_tiocmget(struct tty_struct *tty)
1629 struct hso_serial *serial = tty->driver_data;
1630 struct hso_tiocmget *tiocmget;
1631 u16 UART_state_bitmap;
1635 D1("no tty structures");
1638 spin_lock_irq(&serial->serial_lock);
1639 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1640 ((serial->dtr_state) ? TIOCM_DTR : 0);
1641 tiocmget = serial->tiocmget;
1644 UART_state_bitmap = le16_to_cpu(
1645 tiocmget->prev_UART_state_bitmap);
1646 if (UART_state_bitmap & B_RING_SIGNAL)
1647 retval |= TIOCM_RNG;
1648 if (UART_state_bitmap & B_RX_CARRIER)
1650 if (UART_state_bitmap & B_TX_CARRIER)
1651 retval |= TIOCM_DSR;
1653 spin_unlock_irq(&serial->serial_lock);
1657 static int hso_serial_tiocmset(struct tty_struct *tty,
1658 unsigned int set, unsigned int clear)
1661 unsigned long flags;
1663 struct hso_serial *serial = tty->driver_data;
1667 D1("no tty structures");
1671 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1674 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1676 spin_lock_irqsave(&serial->serial_lock, flags);
1677 if (set & TIOCM_RTS)
1678 serial->rts_state = 1;
1679 if (set & TIOCM_DTR)
1680 serial->dtr_state = 1;
1682 if (clear & TIOCM_RTS)
1683 serial->rts_state = 0;
1684 if (clear & TIOCM_DTR)
1685 serial->dtr_state = 0;
1687 if (serial->dtr_state)
1689 if (serial->rts_state)
1692 spin_unlock_irqrestore(&serial->serial_lock, flags);
1694 return usb_control_msg(serial->parent->usb,
1695 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1696 0x21, val, if_num, NULL, 0,
1697 USB_CTRL_SET_TIMEOUT);
1700 static int hso_serial_ioctl(struct tty_struct *tty,
1701 unsigned int cmd, unsigned long arg)
1703 struct hso_serial *serial = tty->driver_data;
1705 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1711 ret = hso_wait_modem_status(serial, arg);
1721 /* starts a transmit */
1722 static void hso_kick_transmit(struct hso_serial *serial)
1725 unsigned long flags;
1728 spin_lock_irqsave(&serial->serial_lock, flags);
1729 if (!serial->tx_buffer_count)
1732 if (serial->tx_urb_used)
1735 /* Wakeup USB interface if necessary */
1736 if (hso_get_activity(serial->parent) == -EAGAIN)
1739 /* Switch pointers around to avoid memcpy */
1740 temp = serial->tx_buffer;
1741 serial->tx_buffer = serial->tx_data;
1742 serial->tx_data = temp;
1743 serial->tx_data_count = serial->tx_buffer_count;
1744 serial->tx_buffer_count = 0;
1746 /* If temp is set, it means we switched buffers */
1747 if (temp && serial->write_data) {
1748 res = serial->write_data(serial);
1750 serial->tx_urb_used = 1;
1753 spin_unlock_irqrestore(&serial->serial_lock, flags);
1756 /* make a request (for reading and writing data to muxed serial port) */
1757 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1758 struct urb *ctrl_urb,
1759 struct usb_ctrlrequest *ctrl_req,
1760 u8 *ctrl_urb_data, u32 size)
1766 if (!serial || !ctrl_urb || !ctrl_req) {
1767 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1772 ctrl_req->wValue = 0;
1773 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1774 ctrl_req->wLength = cpu_to_le16(size);
1776 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1777 /* Reading command */
1778 ctrl_req->bRequestType = USB_DIR_IN |
1779 USB_TYPE_OPTION_VENDOR |
1780 USB_RECIP_INTERFACE;
1781 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1782 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1784 /* Writing command */
1785 ctrl_req->bRequestType = USB_DIR_OUT |
1786 USB_TYPE_OPTION_VENDOR |
1787 USB_RECIP_INTERFACE;
1788 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1789 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1792 D2("%s command (%02x) len: %d, port: %d",
1793 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1794 ctrl_req->bRequestType, ctrl_req->wLength, port);
1797 ctrl_urb->transfer_flags = 0;
1798 usb_fill_control_urb(ctrl_urb,
1799 serial->parent->usb,
1802 ctrl_urb_data, size, ctrl_callback, serial);
1803 /* Send it on merry way */
1804 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1806 dev_err(&ctrl_urb->dev->dev,
1807 "%s failed submit ctrl_urb %d type %d\n", __func__,
1816 /* called by intr_callback when read occurs */
1817 static int hso_mux_serial_read(struct hso_serial *serial)
1823 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1824 /* make the request */
1826 if (serial->num_rx_urbs != 1) {
1827 dev_err(&serial->parent->interface->dev,
1828 "ERROR: mux'd reads with multiple buffers "
1832 return mux_device_request(serial,
1833 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1834 serial->parent->port_spec & HSO_PORT_MASK,
1836 &serial->ctrl_req_rx,
1837 serial->rx_data[0], serial->rx_data_length);
1840 /* used for muxed serial port callback (muxed serial read) */
1841 static void intr_callback(struct urb *urb)
1843 struct hso_shared_int *shared_int = urb->context;
1844 struct hso_serial *serial;
1845 unsigned char *port_req;
1846 int status = urb->status;
1849 usb_mark_last_busy(urb->dev);
1857 handle_usb_error(status, __func__, NULL);
1860 D4("\n--- Got intr callback 0x%02X ---", status);
1863 port_req = urb->transfer_buffer;
1864 D4(" port_req = 0x%.2X\n", *port_req);
1865 /* loop over all muxed ports to find the one sending this */
1866 for (i = 0; i < 8; i++) {
1867 /* max 8 channels on MUX */
1868 if (*port_req & (1 << i)) {
1869 serial = get_serial_by_shared_int_and_type(shared_int,
1871 if (serial != NULL) {
1872 D1("Pending read interrupt on port %d\n", i);
1873 spin_lock(&serial->serial_lock);
1874 if (serial->rx_state == RX_IDLE &&
1875 serial->port.count > 0) {
1876 /* Setup and send a ctrl req read on
1878 if (!serial->rx_urb_filled[0]) {
1879 serial->rx_state = RX_SENT;
1880 hso_mux_serial_read(serial);
1882 serial->rx_state = RX_PENDING;
1884 D1("Already a read pending on "
1885 "port %d or port not open\n", i);
1887 spin_unlock(&serial->serial_lock);
1891 /* Resubmit interrupt urb */
1892 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1895 /* called for writing to muxed serial port */
1896 static int hso_mux_serial_write_data(struct hso_serial *serial)
1901 return mux_device_request(serial,
1902 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1903 serial->parent->port_spec & HSO_PORT_MASK,
1905 &serial->ctrl_req_tx,
1906 serial->tx_data, serial->tx_data_count);
1909 /* write callback for Diag and CS port */
1910 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1912 struct hso_serial *serial = urb->context;
1913 int status = urb->status;
1917 D1("serial == NULL");
1921 spin_lock(&serial->serial_lock);
1922 serial->tx_urb_used = 0;
1923 spin_unlock(&serial->serial_lock);
1925 handle_usb_error(status, __func__, serial->parent);
1928 hso_put_activity(serial->parent);
1929 tty_port_tty_wakeup(&serial->port);
1930 hso_kick_transmit(serial);
1935 /* called for writing diag or CS serial port */
1936 static int hso_std_serial_write_data(struct hso_serial *serial)
1938 int count = serial->tx_data_count;
1941 usb_fill_bulk_urb(serial->tx_urb,
1942 serial->parent->usb,
1943 usb_sndbulkpipe(serial->parent->usb,
1945 bEndpointAddress & 0x7F),
1946 serial->tx_data, serial->tx_data_count,
1947 hso_std_serial_write_bulk_callback, serial);
1949 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1951 dev_warn(&serial->parent->usb->dev,
1952 "Failed to submit urb - res %d\n", result);
1959 /* callback after read or write on muxed serial port */
1960 static void ctrl_callback(struct urb *urb)
1962 struct hso_serial *serial = urb->context;
1963 struct usb_ctrlrequest *req;
1964 int status = urb->status;
1970 spin_lock(&serial->serial_lock);
1971 serial->tx_urb_used = 0;
1972 spin_unlock(&serial->serial_lock);
1974 handle_usb_error(status, __func__, serial->parent);
1979 req = (struct usb_ctrlrequest *)(urb->setup_packet);
1980 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
1981 D4("Actual length of urb = %d\n", urb->actual_length);
1982 DUMP1(urb->transfer_buffer, urb->actual_length);
1984 if (req->bRequestType ==
1985 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
1986 /* response to a read command */
1987 serial->rx_urb_filled[0] = 1;
1988 spin_lock(&serial->serial_lock);
1989 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1990 spin_unlock(&serial->serial_lock);
1992 hso_put_activity(serial->parent);
1993 tty_port_tty_wakeup(&serial->port);
1994 /* response to a write command */
1995 hso_kick_transmit(serial);
1999 /* handle RX data for serial port */
2000 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2002 struct tty_struct *tty;
2006 if (urb == NULL || serial == NULL) {
2007 D1("serial = NULL");
2011 tty = tty_port_tty_get(&serial->port);
2013 if (tty && test_bit(TTY_THROTTLED, &tty->flags)) {
2018 /* Push data to tty */
2019 D1("data to push to tty");
2020 count = tty_buffer_request_room(&serial->port, urb->actual_length);
2021 if (count >= urb->actual_length) {
2022 tty_insert_flip_string(&serial->port, urb->transfer_buffer,
2023 urb->actual_length);
2024 tty_flip_buffer_push(&serial->port);
2026 dev_warn(&serial->parent->usb->dev,
2027 "dropping data, %d bytes lost\n", urb->actual_length);
2032 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2038 /* Base driver functions */
2040 static void hso_log_port(struct hso_device *hso_dev)
2045 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2046 case HSO_PORT_CONTROL:
2047 port_type = "Control";
2050 port_type = "Application";
2055 case HSO_PORT_GPS_CONTROL:
2056 port_type = "GPS control";
2059 port_type = "Application2";
2065 port_type = "Diagnostic";
2067 case HSO_PORT_DIAG2:
2068 port_type = "Diagnostic2";
2070 case HSO_PORT_MODEM:
2071 port_type = "Modem";
2073 case HSO_PORT_NETWORK:
2074 port_type = "Network";
2077 port_type = "Unknown";
2080 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2081 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2083 sprintf(port_dev, "/dev/%s%d", tty_filename,
2084 dev2ser(hso_dev)->minor);
2086 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2087 port_type, port_dev);
2090 static int hso_start_net_device(struct hso_device *hso_dev)
2093 struct hso_net *hso_net = dev2net(hso_dev);
2098 /* send URBs for all read buffers */
2099 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2101 /* Prep a receive URB */
2102 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2104 usb_rcvbulkpipe(hso_dev->usb,
2106 bEndpointAddress & 0x7F),
2107 hso_net->mux_bulk_rx_buf_pool[i],
2108 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2111 /* Put it out there so the device can send us stuff */
2112 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2115 dev_warn(&hso_dev->usb->dev,
2116 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2123 static int hso_stop_net_device(struct hso_device *hso_dev)
2126 struct hso_net *hso_net = dev2net(hso_dev);
2131 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2132 if (hso_net->mux_bulk_rx_urb_pool[i])
2133 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2136 if (hso_net->mux_bulk_tx_urb)
2137 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2142 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2145 struct hso_serial *serial = dev2ser(hso_dev);
2150 /* If it is not the MUX port fill in and submit a bulk urb (already
2151 * allocated in hso_serial_start) */
2152 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2153 for (i = 0; i < serial->num_rx_urbs; i++) {
2154 usb_fill_bulk_urb(serial->rx_urb[i],
2155 serial->parent->usb,
2156 usb_rcvbulkpipe(serial->parent->usb,
2161 serial->rx_data_length,
2162 hso_std_serial_read_bulk_callback,
2164 result = usb_submit_urb(serial->rx_urb[i], flags);
2166 dev_warn(&serial->parent->usb->dev,
2167 "Failed to submit urb - res %d\n",
2173 mutex_lock(&serial->shared_int->shared_int_lock);
2174 if (!serial->shared_int->use_count) {
2176 hso_mux_submit_intr_urb(serial->shared_int,
2177 hso_dev->usb, flags);
2179 serial->shared_int->use_count++;
2180 mutex_unlock(&serial->shared_int->shared_int_lock);
2182 if (serial->tiocmget)
2183 tiocmget_submit_urb(serial,
2185 serial->parent->usb);
2189 static int hso_stop_serial_device(struct hso_device *hso_dev)
2192 struct hso_serial *serial = dev2ser(hso_dev);
2193 struct hso_tiocmget *tiocmget;
2198 for (i = 0; i < serial->num_rx_urbs; i++) {
2199 if (serial->rx_urb[i]) {
2200 usb_kill_urb(serial->rx_urb[i]);
2201 serial->rx_urb_filled[i] = 0;
2204 serial->curr_rx_urb_idx = 0;
2207 usb_kill_urb(serial->tx_urb);
2209 if (serial->shared_int) {
2210 mutex_lock(&serial->shared_int->shared_int_lock);
2211 if (serial->shared_int->use_count &&
2212 (--serial->shared_int->use_count == 0)) {
2215 urb = serial->shared_int->shared_intr_urb;
2219 mutex_unlock(&serial->shared_int->shared_int_lock);
2221 tiocmget = serial->tiocmget;
2223 wake_up_interruptible(&tiocmget->waitq);
2224 usb_kill_urb(tiocmget->urb);
2230 static void hso_serial_common_free(struct hso_serial *serial)
2234 if (serial->parent->dev)
2235 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2237 tty_unregister_device(tty_drv, serial->minor);
2239 for (i = 0; i < serial->num_rx_urbs; i++) {
2240 /* unlink and free RX URB */
2241 usb_free_urb(serial->rx_urb[i]);
2242 /* free the RX buffer */
2243 kfree(serial->rx_data[i]);
2246 /* unlink and free TX URB */
2247 usb_free_urb(serial->tx_urb);
2248 kfree(serial->tx_data);
2249 tty_port_destroy(&serial->port);
2252 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2253 int rx_size, int tx_size)
2259 tty_port_init(&serial->port);
2261 minor = get_free_serial_index();
2265 /* register our minor number */
2266 serial->parent->dev = tty_port_register_device(&serial->port, tty_drv,
2267 minor, &serial->parent->interface->dev);
2268 dev = serial->parent->dev;
2269 dev_set_drvdata(dev, serial->parent);
2270 i = device_create_file(dev, &dev_attr_hsotype);
2272 /* fill in specific data for later use */
2273 serial->minor = minor;
2274 serial->magic = HSO_SERIAL_MAGIC;
2275 spin_lock_init(&serial->serial_lock);
2276 serial->num_rx_urbs = num_urbs;
2278 /* RX, allocate urb and initialize */
2280 /* prepare our RX buffer */
2281 serial->rx_data_length = rx_size;
2282 for (i = 0; i < serial->num_rx_urbs; i++) {
2283 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2284 if (!serial->rx_urb[i]) {
2285 dev_err(dev, "Could not allocate urb?\n");
2288 serial->rx_urb[i]->transfer_buffer = NULL;
2289 serial->rx_urb[i]->transfer_buffer_length = 0;
2290 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2292 if (!serial->rx_data[i])
2296 /* TX, allocate urb and initialize */
2297 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2298 if (!serial->tx_urb) {
2299 dev_err(dev, "Could not allocate urb?\n");
2302 serial->tx_urb->transfer_buffer = NULL;
2303 serial->tx_urb->transfer_buffer_length = 0;
2304 /* prepare our TX buffer */
2305 serial->tx_data_count = 0;
2306 serial->tx_buffer_count = 0;
2307 serial->tx_data_length = tx_size;
2308 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2309 if (!serial->tx_data)
2312 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2313 if (!serial->tx_buffer)
2318 hso_serial_common_free(serial);
2322 /* Creates a general hso device */
2323 static struct hso_device *hso_create_device(struct usb_interface *intf,
2326 struct hso_device *hso_dev;
2328 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2332 hso_dev->port_spec = port_spec;
2333 hso_dev->usb = interface_to_usbdev(intf);
2334 hso_dev->interface = intf;
2335 kref_init(&hso_dev->ref);
2336 mutex_init(&hso_dev->mutex);
2338 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2339 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2340 INIT_WORK(&hso_dev->reset_device, reset_device);
2345 /* Removes a network device in the network device table */
2346 static int remove_net_device(struct hso_device *hso_dev)
2350 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2351 if (network_table[i] == hso_dev) {
2352 network_table[i] = NULL;
2356 if (i == HSO_MAX_NET_DEVICES)
2361 /* Frees our network device */
2362 static void hso_free_net_device(struct hso_device *hso_dev)
2365 struct hso_net *hso_net = dev2net(hso_dev);
2370 remove_net_device(hso_net->parent);
2373 unregister_netdev(hso_net->net);
2376 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2377 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2378 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2379 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2381 usb_free_urb(hso_net->mux_bulk_tx_urb);
2382 kfree(hso_net->mux_bulk_tx_buf);
2383 hso_net->mux_bulk_tx_buf = NULL;
2386 free_netdev(hso_net->net);
2391 static const struct net_device_ops hso_netdev_ops = {
2392 .ndo_open = hso_net_open,
2393 .ndo_stop = hso_net_close,
2394 .ndo_start_xmit = hso_net_start_xmit,
2395 .ndo_tx_timeout = hso_net_tx_timeout,
2398 /* initialize the network interface */
2399 static void hso_net_init(struct net_device *net)
2401 struct hso_net *hso_net = netdev_priv(net);
2403 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2405 /* fill in the other fields */
2406 net->netdev_ops = &hso_netdev_ops;
2407 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2408 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2409 net->type = ARPHRD_NONE;
2410 net->mtu = DEFAULT_MTU - 14;
2411 net->tx_queue_len = 10;
2412 net->ethtool_ops = &ops;
2414 /* and initialize the semaphore */
2415 spin_lock_init(&hso_net->net_lock);
2418 /* Adds a network device in the network device table */
2419 static int add_net_device(struct hso_device *hso_dev)
2423 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2424 if (network_table[i] == NULL) {
2425 network_table[i] = hso_dev;
2429 if (i == HSO_MAX_NET_DEVICES)
2434 static int hso_rfkill_set_block(void *data, bool blocked)
2436 struct hso_device *hso_dev = data;
2437 int enabled = !blocked;
2440 mutex_lock(&hso_dev->mutex);
2441 if (hso_dev->usb_gone)
2444 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2445 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2446 USB_CTRL_SET_TIMEOUT);
2447 mutex_unlock(&hso_dev->mutex);
2451 static const struct rfkill_ops hso_rfkill_ops = {
2452 .set_block = hso_rfkill_set_block,
2455 /* Creates and sets up everything for rfkill */
2456 static void hso_create_rfkill(struct hso_device *hso_dev,
2457 struct usb_interface *interface)
2459 struct hso_net *hso_net = dev2net(hso_dev);
2460 struct device *dev = &hso_net->net->dev;
2463 rfkn = kzalloc(20, GFP_KERNEL);
2465 dev_err(dev, "%s - Out of memory\n", __func__);
2467 snprintf(rfkn, 20, "hso-%d",
2468 interface->altsetting->desc.bInterfaceNumber);
2470 hso_net->rfkill = rfkill_alloc(rfkn,
2471 &interface_to_usbdev(interface)->dev,
2473 &hso_rfkill_ops, hso_dev);
2474 if (!hso_net->rfkill) {
2475 dev_err(dev, "%s - Out of memory\n", __func__);
2479 if (rfkill_register(hso_net->rfkill) < 0) {
2480 rfkill_destroy(hso_net->rfkill);
2482 hso_net->rfkill = NULL;
2483 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2488 static struct device_type hso_type = {
2492 /* Creates our network device */
2493 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2497 struct net_device *net;
2498 struct hso_net *hso_net;
2499 struct hso_device *hso_dev;
2501 hso_dev = hso_create_device(interface, port_spec);
2505 /* allocate our network device, then we can put in our private data */
2506 /* call hso_net_init to do the basic initialization */
2507 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2509 dev_err(&interface->dev, "Unable to create ethernet device\n");
2513 hso_net = netdev_priv(net);
2515 hso_dev->port_data.dev_net = hso_net;
2517 hso_net->parent = hso_dev;
2519 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2521 if (!hso_net->in_endp) {
2522 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2525 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2527 if (!hso_net->out_endp) {
2528 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2531 SET_NETDEV_DEV(net, &interface->dev);
2532 SET_NETDEV_DEVTYPE(net, &hso_type);
2534 /* registering our net device */
2535 result = register_netdev(net);
2537 dev_err(&interface->dev, "Failed to register device\n");
2541 /* start allocating */
2542 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2543 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2544 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2545 dev_err(&interface->dev, "Could not allocate rx urb\n");
2548 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2550 if (!hso_net->mux_bulk_rx_buf_pool[i])
2553 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2554 if (!hso_net->mux_bulk_tx_urb) {
2555 dev_err(&interface->dev, "Could not allocate tx urb\n");
2558 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2559 if (!hso_net->mux_bulk_tx_buf)
2562 add_net_device(hso_dev);
2564 hso_log_port(hso_dev);
2566 hso_create_rfkill(hso_dev, interface);
2570 hso_free_net_device(hso_dev);
2574 static void hso_free_tiomget(struct hso_serial *serial)
2576 struct hso_tiocmget *tiocmget;
2579 tiocmget = serial->tiocmget;
2581 usb_free_urb(tiocmget->urb);
2582 tiocmget->urb = NULL;
2583 serial->tiocmget = NULL;
2588 /* Frees an AT channel ( goes for both mux and non-mux ) */
2589 static void hso_free_serial_device(struct hso_device *hso_dev)
2591 struct hso_serial *serial = dev2ser(hso_dev);
2595 set_serial_by_index(serial->minor, NULL);
2597 hso_serial_common_free(serial);
2599 if (serial->shared_int) {
2600 mutex_lock(&serial->shared_int->shared_int_lock);
2601 if (--serial->shared_int->ref_count == 0)
2602 hso_free_shared_int(serial->shared_int);
2604 mutex_unlock(&serial->shared_int->shared_int_lock);
2606 hso_free_tiomget(serial);
2611 /* Creates a bulk AT channel */
2612 static struct hso_device *hso_create_bulk_serial_device(
2613 struct usb_interface *interface, int port)
2615 struct hso_device *hso_dev;
2616 struct hso_serial *serial;
2618 struct hso_tiocmget *tiocmget;
2620 hso_dev = hso_create_device(interface, port);
2624 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2628 serial->parent = hso_dev;
2629 hso_dev->port_data.dev_serial = serial;
2631 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2633 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2635 /* it isn't going to break our heart if serial->tiocmget
2636 * allocation fails don't bother checking this.
2638 if (serial->tiocmget) {
2639 tiocmget = serial->tiocmget;
2640 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2641 if (tiocmget->urb) {
2642 mutex_init(&tiocmget->mutex);
2643 init_waitqueue_head(&tiocmget->waitq);
2644 tiocmget->endp = hso_get_ep(
2646 USB_ENDPOINT_XFER_INT,
2649 hso_free_tiomget(serial);
2655 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2659 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2661 if (!serial->in_endp) {
2662 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2668 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2669 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2673 serial->write_data = hso_std_serial_write_data;
2675 /* and record this serial */
2676 set_serial_by_index(serial->minor, serial);
2678 /* setup the proc dirs and files if needed */
2679 hso_log_port(hso_dev);
2681 /* done, return it */
2685 hso_serial_common_free(serial);
2687 hso_free_tiomget(serial);
2693 /* Creates a multiplexed AT channel */
2695 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2697 struct hso_shared_int *mux)
2699 struct hso_device *hso_dev;
2700 struct hso_serial *serial;
2703 port_spec = HSO_INTF_MUX;
2704 port_spec &= ~HSO_PORT_MASK;
2706 port_spec |= hso_mux_to_port(port);
2707 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2710 hso_dev = hso_create_device(interface, port_spec);
2714 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2718 hso_dev->port_data.dev_serial = serial;
2719 serial->parent = hso_dev;
2721 if (hso_serial_common_create
2722 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2725 serial->tx_data_length--;
2726 serial->write_data = hso_mux_serial_write_data;
2728 serial->shared_int = mux;
2729 mutex_lock(&serial->shared_int->shared_int_lock);
2730 serial->shared_int->ref_count++;
2731 mutex_unlock(&serial->shared_int->shared_int_lock);
2733 /* and record this serial */
2734 set_serial_by_index(serial->minor, serial);
2736 /* setup the proc dirs and files if needed */
2737 hso_log_port(hso_dev);
2739 /* done, return it */
2744 tty_unregister_device(tty_drv, serial->minor);
2753 static void hso_free_shared_int(struct hso_shared_int *mux)
2755 usb_free_urb(mux->shared_intr_urb);
2756 kfree(mux->shared_intr_buf);
2757 mutex_unlock(&mux->shared_int_lock);
2762 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2764 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2769 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2771 if (!mux->intr_endp) {
2772 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2776 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2777 if (!mux->shared_intr_urb) {
2778 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2781 mux->shared_intr_buf =
2782 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2784 if (!mux->shared_intr_buf)
2787 mutex_init(&mux->shared_int_lock);
2792 kfree(mux->shared_intr_buf);
2793 usb_free_urb(mux->shared_intr_urb);
2798 /* Gets the port spec for a certain interface */
2799 static int hso_get_config_data(struct usb_interface *interface)
2801 struct usb_device *usbdev = interface_to_usbdev(interface);
2802 u8 *config_data = kmalloc(17, GFP_KERNEL);
2803 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2808 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2809 0x86, 0xC0, 0, 0, config_data, 17,
2810 USB_CTRL_SET_TIMEOUT) != 0x11) {
2815 switch (config_data[if_num]) {
2820 result = HSO_PORT_DIAG;
2823 result = HSO_PORT_GPS;
2826 result = HSO_PORT_GPS_CONTROL;
2829 result = HSO_PORT_APP;
2832 result = HSO_PORT_APP2;
2835 result = HSO_PORT_CONTROL;
2838 result = HSO_PORT_NETWORK;
2841 result = HSO_PORT_MODEM;
2844 result = HSO_PORT_MSD;
2847 result = HSO_PORT_PCSC;
2850 result = HSO_PORT_VOICE;
2857 result |= HSO_INTF_BULK;
2859 if (config_data[16] & 0x1)
2860 result |= HSO_INFO_CRC_BUG;
2866 /* called once for each interface upon device insertion */
2867 static int hso_probe(struct usb_interface *interface,
2868 const struct usb_device_id *id)
2870 int mux, i, if_num, port_spec;
2871 unsigned char port_mask;
2872 struct hso_device *hso_dev = NULL;
2873 struct hso_shared_int *shared_int;
2874 struct hso_device *tmp_dev = NULL;
2876 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2877 dev_err(&interface->dev, "Not our interface\n");
2881 if_num = interface->altsetting->desc.bInterfaceNumber;
2883 /* Get the interface/port specification from either driver_info or from
2884 * the device itself */
2885 if (id->driver_info)
2886 port_spec = ((u32 *)(id->driver_info))[if_num];
2888 port_spec = hso_get_config_data(interface);
2890 /* Check if we need to switch to alt interfaces prior to port
2892 if (interface->num_altsetting > 1)
2893 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2894 interface->needs_remote_wakeup = 1;
2896 /* Allocate new hso device(s) */
2897 switch (port_spec & HSO_INTF_MASK) {
2899 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2900 /* Create the network device */
2902 hso_dev = hso_create_net_device(interface,
2910 if (hso_get_mux_ports(interface, &port_mask))
2911 /* TODO: de-allocate everything */
2914 shared_int = hso_create_shared_int(interface);
2918 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2919 if (port_mask & i) {
2920 hso_dev = hso_create_mux_serial_device(
2921 interface, i, shared_int);
2932 /* It's a regular bulk interface */
2933 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2936 hso_create_net_device(interface, port_spec);
2939 hso_create_bulk_serial_device(interface, port_spec);
2948 /* save our data pointer in this device */
2949 usb_set_intfdata(interface, hso_dev);
2954 hso_free_interface(interface);
2958 /* device removed, cleaning up */
2959 static void hso_disconnect(struct usb_interface *interface)
2961 hso_free_interface(interface);
2963 /* remove reference of our private data */
2964 usb_set_intfdata(interface, NULL);
2967 static void async_get_intf(struct work_struct *data)
2969 struct hso_device *hso_dev =
2970 container_of(data, struct hso_device, async_get_intf);
2971 usb_autopm_get_interface(hso_dev->interface);
2974 static void async_put_intf(struct work_struct *data)
2976 struct hso_device *hso_dev =
2977 container_of(data, struct hso_device, async_put_intf);
2978 usb_autopm_put_interface(hso_dev->interface);
2981 static int hso_get_activity(struct hso_device *hso_dev)
2983 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
2984 if (!hso_dev->is_active) {
2985 hso_dev->is_active = 1;
2986 schedule_work(&hso_dev->async_get_intf);
2990 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
2993 usb_mark_last_busy(hso_dev->usb);
2998 static int hso_put_activity(struct hso_device *hso_dev)
3000 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3001 if (hso_dev->is_active) {
3002 hso_dev->is_active = 0;
3003 schedule_work(&hso_dev->async_put_intf);
3007 hso_dev->is_active = 0;
3011 /* called by kernel when we need to suspend device */
3012 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3016 /* Stop all serial ports */
3017 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3018 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3019 result = hso_stop_serial_device(serial_table[i]);
3025 /* Stop all network ports */
3026 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3027 if (network_table[i] &&
3028 (network_table[i]->interface == iface)) {
3029 result = hso_stop_net_device(network_table[i]);
3039 /* called by kernel when we need to resume device */
3040 static int hso_resume(struct usb_interface *iface)
3043 struct hso_net *hso_net;
3045 /* Start all serial ports */
3046 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3047 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3048 if (dev2ser(serial_table[i])->port.count) {
3050 hso_start_serial_device(serial_table[i], GFP_NOIO);
3051 hso_kick_transmit(dev2ser(serial_table[i]));
3058 /* Start all network ports */
3059 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3060 if (network_table[i] &&
3061 (network_table[i]->interface == iface)) {
3062 hso_net = dev2net(network_table[i]);
3063 if (hso_net->flags & IFF_UP) {
3064 /* First transmit any lingering data,
3065 then restart the device. */
3066 if (hso_net->skb_tx_buf) {
3067 dev_dbg(&iface->dev,
3069 " lingering data\n");
3070 hso_net_start_xmit(hso_net->skb_tx_buf,
3072 hso_net->skb_tx_buf = NULL;
3074 result = hso_start_net_device(network_table[i]);
3085 static void reset_device(struct work_struct *data)
3087 struct hso_device *hso_dev =
3088 container_of(data, struct hso_device, reset_device);
3089 struct usb_device *usb = hso_dev->usb;
3092 if (hso_dev->usb_gone) {
3093 D1("No reset during disconnect\n");
3095 result = usb_lock_device_for_reset(usb, hso_dev->interface);
3097 D1("unable to lock device for reset: %d\n", result);
3099 usb_reset_device(usb);
3100 usb_unlock_device(usb);
3105 static void hso_serial_ref_free(struct kref *ref)
3107 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3109 hso_free_serial_device(hso_dev);
3112 static void hso_free_interface(struct usb_interface *interface)
3114 struct hso_serial *hso_dev;
3117 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3118 if (serial_table[i] &&
3119 (serial_table[i]->interface == interface)) {
3120 hso_dev = dev2ser(serial_table[i]);
3121 tty_port_tty_hangup(&hso_dev->port, false);
3122 mutex_lock(&hso_dev->parent->mutex);
3123 hso_dev->parent->usb_gone = 1;
3124 mutex_unlock(&hso_dev->parent->mutex);
3125 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3129 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3130 if (network_table[i] &&
3131 (network_table[i]->interface == interface)) {
3132 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3133 /* hso_stop_net_device doesn't stop the net queue since
3134 * traffic needs to start it again when suspended */
3135 netif_stop_queue(dev2net(network_table[i])->net);
3136 hso_stop_net_device(network_table[i]);
3137 cancel_work_sync(&network_table[i]->async_put_intf);
3138 cancel_work_sync(&network_table[i]->async_get_intf);
3140 rfkill_unregister(rfk);
3141 rfkill_destroy(rfk);
3143 hso_free_net_device(network_table[i]);
3148 /* Helper functions */
3150 /* Get the endpoint ! */
3151 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3155 struct usb_host_interface *iface = intf->cur_altsetting;
3156 struct usb_endpoint_descriptor *endp;
3158 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3159 endp = &iface->endpoint[i].desc;
3160 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3161 (usb_endpoint_type(endp) == type))
3168 /* Get the byte that describes which ports are enabled */
3169 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3172 struct usb_host_interface *iface = intf->cur_altsetting;
3174 if (iface->extralen == 3) {
3175 *ports = iface->extra[2];
3179 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3180 if (iface->endpoint[i].extralen == 3) {
3181 *ports = iface->endpoint[i].extra[2];
3189 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3190 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3191 struct usb_device *usb, gfp_t gfp)
3195 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3197 shared_int->intr_endp->bEndpointAddress & 0x7F),
3198 shared_int->shared_intr_buf,
3200 intr_callback, shared_int,
3201 shared_int->intr_endp->bInterval);
3203 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3205 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3211 /* operations setup of the serial interface */
3212 static const struct tty_operations hso_serial_ops = {
3213 .open = hso_serial_open,
3214 .close = hso_serial_close,
3215 .write = hso_serial_write,
3216 .write_room = hso_serial_write_room,
3217 .ioctl = hso_serial_ioctl,
3218 .set_termios = hso_serial_set_termios,
3219 .chars_in_buffer = hso_serial_chars_in_buffer,
3220 .tiocmget = hso_serial_tiocmget,
3221 .tiocmset = hso_serial_tiocmset,
3222 .get_icount = hso_get_count,
3223 .unthrottle = hso_unthrottle
3226 static struct usb_driver hso_driver = {
3227 .name = driver_name,
3229 .disconnect = hso_disconnect,
3230 .id_table = hso_ids,
3231 .suspend = hso_suspend,
3232 .resume = hso_resume,
3233 .reset_resume = hso_resume,
3234 .supports_autosuspend = 1,
3235 .disable_hub_initiated_lpm = 1,
3238 static int __init hso_init(void)
3243 /* put it in the log */
3244 printk(KERN_INFO "hso: %s\n", version);
3246 /* Initialise the serial table semaphore and table */
3247 spin_lock_init(&serial_table_lock);
3248 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3249 serial_table[i] = NULL;
3251 /* allocate our driver using the proper amount of supported minors */
3252 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3256 /* fill in all needed values */
3257 tty_drv->driver_name = driver_name;
3258 tty_drv->name = tty_filename;
3260 /* if major number is provided as parameter, use that one */
3262 tty_drv->major = tty_major;
3264 tty_drv->minor_start = 0;
3265 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3266 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3267 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3268 tty_drv->init_termios = tty_std_termios;
3269 hso_init_termios(&tty_drv->init_termios);
3270 tty_set_operations(tty_drv, &hso_serial_ops);
3272 /* register the tty driver */
3273 result = tty_register_driver(tty_drv);
3275 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3280 /* register this module as an usb driver */
3281 result = usb_register(&hso_driver);
3283 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3291 tty_unregister_driver(tty_drv);
3293 put_tty_driver(tty_drv);
3297 static void __exit hso_exit(void)
3299 printk(KERN_INFO "hso: unloaded\n");
3301 tty_unregister_driver(tty_drv);
3302 put_tty_driver(tty_drv);
3303 /* deregister the usb driver */
3304 usb_deregister(&hso_driver);
3307 /* Module definitions */
3308 module_init(hso_init);
3309 module_exit(hso_exit);
3311 MODULE_AUTHOR(MOD_AUTHOR);
3312 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3313 MODULE_LICENSE(MOD_LICENSE);
3315 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3316 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3317 module_param(debug, int, S_IRUGO | S_IWUSR);
3319 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3320 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3321 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3323 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3324 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3325 module_param(disable_net, int, S_IRUGO | S_IWUSR);