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 static inline struct hso_serial *get_serial_by_tty(struct tty_struct *tty)
112 return tty->driver_data;
116 /*****************************************************************************/
117 /* Debugging functions */
118 /*****************************************************************************/
119 #define D__(lvl_, fmt, arg...) \
121 printk(lvl_ "[%d:%s]: " fmt "\n", \
122 __LINE__, __func__, ## arg); \
125 #define D_(lvl, args...) \
128 D__(KERN_INFO, args); \
131 #define D1(args...) D_(0x01, ##args)
132 #define D2(args...) D_(0x02, ##args)
133 #define D3(args...) D_(0x04, ##args)
134 #define D4(args...) D_(0x08, ##args)
135 #define D5(args...) D_(0x10, ##args)
137 /*****************************************************************************/
139 /*****************************************************************************/
140 enum pkt_parse_state {
146 /*****************************************************************************/
148 /*****************************************************************************/
150 struct hso_shared_int {
151 struct usb_endpoint_descriptor *intr_endp;
152 void *shared_intr_buf;
153 struct urb *shared_intr_urb;
154 struct usb_device *usb;
157 struct mutex shared_int_lock;
161 struct hso_device *parent;
162 struct net_device *net;
163 struct rfkill *rfkill;
165 struct usb_endpoint_descriptor *in_endp;
166 struct usb_endpoint_descriptor *out_endp;
168 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
169 struct urb *mux_bulk_tx_urb;
170 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
171 void *mux_bulk_tx_buf;
173 struct sk_buff *skb_rx_buf;
174 struct sk_buff *skb_tx_buf;
176 enum pkt_parse_state rx_parse_state;
179 unsigned short rx_buf_size;
180 unsigned short rx_buf_missing;
181 struct iphdr rx_ip_hdr;
192 #define BM_REQUEST_TYPE (0xa1)
193 #define B_NOTIFICATION (0x20)
194 #define W_VALUE (0x0)
195 #define W_INDEX (0x2)
196 #define W_LENGTH (0x2)
198 #define B_OVERRUN (0x1<<6)
199 #define B_PARITY (0x1<<5)
200 #define B_FRAMING (0x1<<4)
201 #define B_RING_SIGNAL (0x1<<3)
202 #define B_BREAK (0x1<<2)
203 #define B_TX_CARRIER (0x1<<1)
204 #define B_RX_CARRIER (0x1<<0)
206 struct hso_serial_state_notification {
212 u16 UART_state_bitmap;
215 struct hso_tiocmget {
217 wait_queue_head_t waitq;
219 struct usb_endpoint_descriptor *endp;
221 struct hso_serial_state_notification serial_state_notification;
222 u16 prev_UART_state_bitmap;
223 struct uart_icount icount;
228 struct hso_device *parent;
232 struct hso_shared_int *shared_int;
234 /* rx/tx urb could be either a bulk urb or a control urb depending
235 on which serial port it is used on. */
236 struct urb *rx_urb[MAX_RX_URBS];
238 u8 *rx_data[MAX_RX_URBS];
239 u16 rx_data_length; /* should contain allocated length */
244 u16 tx_data_length; /* should contain allocated length */
247 struct usb_ctrlrequest ctrl_req_tx;
248 struct usb_ctrlrequest ctrl_req_rx;
250 struct usb_endpoint_descriptor *in_endp;
251 struct usb_endpoint_descriptor *out_endp;
253 enum rx_ctrl_state rx_state;
256 unsigned tx_urb_used:1;
258 /* from usb_serial_port */
259 struct tty_struct *tty;
261 spinlock_t serial_lock;
263 int (*write_data) (struct hso_serial *serial);
264 struct hso_tiocmget *tiocmget;
265 /* Hacks required to get flow control
266 * working on the serial receive buffers
267 * so as not to drop characters on the floor.
270 u16 curr_rx_urb_offset;
271 u8 rx_urb_filled[MAX_RX_URBS];
272 struct tasklet_struct unthrottle_tasklet;
273 struct work_struct retry_unthrottle_workqueue;
278 struct hso_serial *dev_serial;
279 struct hso_net *dev_net;
286 struct work_struct async_get_intf;
287 struct work_struct async_put_intf;
288 struct work_struct reset_device;
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 handle_usb_error(int status, const char *function,
336 struct hso_device *hso_dev);
337 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
339 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
340 static void hso_free_interface(struct usb_interface *intf);
341 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
342 static int hso_stop_serial_device(struct hso_device *hso_dev);
343 static int hso_start_net_device(struct hso_device *hso_dev);
344 static void hso_free_shared_int(struct hso_shared_int *shared_int);
345 static int hso_stop_net_device(struct hso_device *hso_dev);
346 static void hso_serial_ref_free(struct kref *ref);
347 static void hso_std_serial_read_bulk_callback(struct urb *urb);
348 static int hso_mux_serial_read(struct hso_serial *serial);
349 static void async_get_intf(struct work_struct *data);
350 static void async_put_intf(struct work_struct *data);
351 static int hso_put_activity(struct hso_device *hso_dev);
352 static int hso_get_activity(struct hso_device *hso_dev);
353 static void tiocmget_intr_callback(struct urb *urb);
354 static void reset_device(struct work_struct *data);
355 /*****************************************************************************/
356 /* Helping functions */
357 /*****************************************************************************/
361 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
363 return hso_dev->port_data.dev_net;
366 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
368 return hso_dev->port_data.dev_serial;
371 /* Debugging functions */
373 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
376 static char name[255];
378 sprintf(name, "hso[%d:%s]", line_count, func_name);
379 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
382 #define DUMP(buf_, len_) \
383 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
385 #define DUMP1(buf_, len_) \
391 #define DUMP(buf_, len_)
392 #define DUMP1(buf_, len_)
395 /* module parameters */
397 static int tty_major;
398 static int disable_net;
401 static const char driver_name[] = "hso";
402 static const char tty_filename[] = "ttyHS";
403 static const char *version = __FILE__ ": " MOD_AUTHOR;
404 /* the usb driver itself (registered in hso_init) */
405 static struct usb_driver hso_driver;
406 /* serial structures */
407 static struct tty_driver *tty_drv;
408 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
409 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
410 static spinlock_t serial_table_lock;
412 static const s32 default_port_spec[] = {
413 HSO_INTF_MUX | HSO_PORT_NETWORK,
414 HSO_INTF_BULK | HSO_PORT_DIAG,
415 HSO_INTF_BULK | HSO_PORT_MODEM,
419 static const s32 icon321_port_spec[] = {
420 HSO_INTF_MUX | HSO_PORT_NETWORK,
421 HSO_INTF_BULK | HSO_PORT_DIAG2,
422 HSO_INTF_BULK | HSO_PORT_MODEM,
423 HSO_INTF_BULK | HSO_PORT_DIAG,
427 #define default_port_device(vendor, product) \
428 USB_DEVICE(vendor, product), \
429 .driver_info = (kernel_ulong_t)default_port_spec
431 #define icon321_port_device(vendor, product) \
432 USB_DEVICE(vendor, product), \
433 .driver_info = (kernel_ulong_t)icon321_port_spec
435 /* list of devices we support */
436 static const struct usb_device_id hso_ids[] = {
437 {default_port_device(0x0af0, 0x6711)},
438 {default_port_device(0x0af0, 0x6731)},
439 {default_port_device(0x0af0, 0x6751)},
440 {default_port_device(0x0af0, 0x6771)},
441 {default_port_device(0x0af0, 0x6791)},
442 {default_port_device(0x0af0, 0x6811)},
443 {default_port_device(0x0af0, 0x6911)},
444 {default_port_device(0x0af0, 0x6951)},
445 {default_port_device(0x0af0, 0x6971)},
446 {default_port_device(0x0af0, 0x7011)},
447 {default_port_device(0x0af0, 0x7031)},
448 {default_port_device(0x0af0, 0x7051)},
449 {default_port_device(0x0af0, 0x7071)},
450 {default_port_device(0x0af0, 0x7111)},
451 {default_port_device(0x0af0, 0x7211)},
452 {default_port_device(0x0af0, 0x7251)},
453 {default_port_device(0x0af0, 0x7271)},
454 {default_port_device(0x0af0, 0x7311)},
455 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
456 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
457 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
458 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
459 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
460 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
461 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
462 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
463 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
464 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
465 {USB_DEVICE(0x0af0, 0x7701)},
466 {USB_DEVICE(0x0af0, 0x7706)},
467 {USB_DEVICE(0x0af0, 0x7801)},
468 {USB_DEVICE(0x0af0, 0x7901)},
469 {USB_DEVICE(0x0af0, 0x7A01)},
470 {USB_DEVICE(0x0af0, 0x7A05)},
471 {USB_DEVICE(0x0af0, 0x8200)},
472 {USB_DEVICE(0x0af0, 0x8201)},
473 {USB_DEVICE(0x0af0, 0x8300)},
474 {USB_DEVICE(0x0af0, 0x8302)},
475 {USB_DEVICE(0x0af0, 0x8304)},
476 {USB_DEVICE(0x0af0, 0x8400)},
477 {USB_DEVICE(0x0af0, 0x8600)},
478 {USB_DEVICE(0x0af0, 0x8800)},
479 {USB_DEVICE(0x0af0, 0x8900)},
480 {USB_DEVICE(0x0af0, 0x9000)},
481 {USB_DEVICE(0x0af0, 0xd035)},
482 {USB_DEVICE(0x0af0, 0xd055)},
483 {USB_DEVICE(0x0af0, 0xd155)},
484 {USB_DEVICE(0x0af0, 0xd255)},
485 {USB_DEVICE(0x0af0, 0xd057)},
486 {USB_DEVICE(0x0af0, 0xd157)},
487 {USB_DEVICE(0x0af0, 0xd257)},
488 {USB_DEVICE(0x0af0, 0xd357)},
489 {USB_DEVICE(0x0af0, 0xd058)},
490 {USB_DEVICE(0x0af0, 0xc100)},
493 MODULE_DEVICE_TABLE(usb, hso_ids);
495 /* Sysfs attribute */
496 static ssize_t hso_sysfs_show_porttype(struct device *dev,
497 struct device_attribute *attr,
500 struct hso_device *hso_dev = dev_get_drvdata(dev);
506 switch (hso_dev->port_spec & HSO_PORT_MASK) {
507 case HSO_PORT_CONTROL:
508 port_name = "Control";
511 port_name = "Application";
514 port_name = "Application2";
519 case HSO_PORT_GPS_CONTROL:
520 port_name = "GPS Control";
526 port_name = "Diagnostic";
529 port_name = "Diagnostic2";
534 case HSO_PORT_NETWORK:
535 port_name = "Network";
538 port_name = "Unknown";
542 return sprintf(buf, "%s\n", port_name);
544 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
546 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
550 for (idx = 0; idx < serial->num_rx_urbs; idx++)
551 if (serial->rx_urb[idx] == urb)
553 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
557 /* converts mux value to a port spec value */
558 static u32 hso_mux_to_port(int mux)
564 result = HSO_PORT_CONTROL;
567 result = HSO_PORT_APP;
570 result = HSO_PORT_PCSC;
573 result = HSO_PORT_GPS;
576 result = HSO_PORT_APP2;
579 result = HSO_PORT_NO_PORT;
584 /* converts port spec value to a mux value */
585 static u32 hso_port_to_mux(int port)
589 switch (port & HSO_PORT_MASK) {
590 case HSO_PORT_CONTROL:
611 static struct hso_serial *get_serial_by_shared_int_and_type(
612 struct hso_shared_int *shared_int,
617 port = hso_mux_to_port(mux);
619 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
620 if (serial_table[i] &&
621 (dev2ser(serial_table[i])->shared_int == shared_int) &&
622 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
623 return dev2ser(serial_table[i]);
630 static struct hso_serial *get_serial_by_index(unsigned index)
632 struct hso_serial *serial = NULL;
635 spin_lock_irqsave(&serial_table_lock, flags);
636 if (serial_table[index])
637 serial = dev2ser(serial_table[index]);
638 spin_unlock_irqrestore(&serial_table_lock, flags);
643 static int get_free_serial_index(void)
648 spin_lock_irqsave(&serial_table_lock, flags);
649 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
650 if (serial_table[index] == NULL) {
651 spin_unlock_irqrestore(&serial_table_lock, flags);
655 spin_unlock_irqrestore(&serial_table_lock, flags);
657 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
661 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
665 spin_lock_irqsave(&serial_table_lock, flags);
667 serial_table[index] = serial->parent;
669 serial_table[index] = NULL;
670 spin_unlock_irqrestore(&serial_table_lock, flags);
673 static void handle_usb_error(int status, const char *function,
674 struct hso_device *hso_dev)
680 explanation = "no device";
683 explanation = "endpoint not enabled";
686 explanation = "endpoint stalled";
689 explanation = "not enough bandwidth";
692 explanation = "device disabled";
695 explanation = "device suspended";
701 explanation = "internal error";
707 explanation = "protocol error";
709 schedule_work(&hso_dev->reset_device);
712 explanation = "unknown status";
716 /* log a meaningful explanation of an USB status */
717 D1("%s: received USB status - %s (%d)", function, explanation, status);
720 /* Network interface functions */
722 /* called when net interface is brought up by ifconfig */
723 static int hso_net_open(struct net_device *net)
725 struct hso_net *odev = netdev_priv(net);
726 unsigned long flags = 0;
729 dev_err(&net->dev, "No net device !\n");
733 odev->skb_tx_buf = NULL;
735 /* setup environment */
736 spin_lock_irqsave(&odev->net_lock, flags);
737 odev->rx_parse_state = WAIT_IP;
738 odev->rx_buf_size = 0;
739 odev->rx_buf_missing = sizeof(struct iphdr);
740 spin_unlock_irqrestore(&odev->net_lock, flags);
742 /* We are up and running. */
743 set_bit(HSO_NET_RUNNING, &odev->flags);
744 hso_start_net_device(odev->parent);
746 /* Tell the kernel we are ready to start receiving from it */
747 netif_start_queue(net);
752 /* called when interface is brought down by ifconfig */
753 static int hso_net_close(struct net_device *net)
755 struct hso_net *odev = netdev_priv(net);
757 /* we don't need the queue anymore */
758 netif_stop_queue(net);
759 /* no longer running */
760 clear_bit(HSO_NET_RUNNING, &odev->flags);
762 hso_stop_net_device(odev->parent);
768 /* USB tells is xmit done, we should start the netqueue again */
769 static void write_bulk_callback(struct urb *urb)
771 struct hso_net *odev = urb->context;
772 int status = urb->status;
775 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
776 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
780 /* Do we still have a valid kernel network device? */
781 if (!netif_device_present(odev->net)) {
782 dev_err(&urb->dev->dev, "%s: net device not present\n",
787 /* log status, but don't act on it, we don't need to resubmit anything
790 handle_usb_error(status, __func__, odev->parent);
792 hso_put_activity(odev->parent);
794 /* Tell the network interface we are ready for another frame */
795 netif_wake_queue(odev->net);
798 /* called by kernel when we need to transmit a packet */
799 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
800 struct net_device *net)
802 struct hso_net *odev = netdev_priv(net);
805 /* Tell the kernel, "No more frames 'til we are done with this one." */
806 netif_stop_queue(net);
807 if (hso_get_activity(odev->parent) == -EAGAIN) {
808 odev->skb_tx_buf = skb;
813 DUMP1(skb->data, skb->len);
814 /* Copy it from kernel memory to OUR memory */
815 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
816 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
818 /* Fill in the URB for shipping it out. */
819 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
821 usb_sndbulkpipe(odev->parent->usb,
823 bEndpointAddress & 0x7F),
824 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
827 /* Deal with the Zero Length packet problem, I hope */
828 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
830 /* Send the URB on its merry way. */
831 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
833 dev_warn(&odev->parent->interface->dev,
834 "failed mux_bulk_tx_urb %d\n", result);
835 net->stats.tx_errors++;
836 netif_start_queue(net);
838 net->stats.tx_packets++;
839 net->stats.tx_bytes += skb->len;
846 static const struct ethtool_ops ops = {
847 .get_link = ethtool_op_get_link
850 /* called when a packet did not ack after watchdogtimeout */
851 static void hso_net_tx_timeout(struct net_device *net)
853 struct hso_net *odev = netdev_priv(net);
858 /* Tell syslog we are hosed. */
859 dev_warn(&net->dev, "Tx timed out.\n");
861 /* Tear the waiting frame off the list */
862 if (odev->mux_bulk_tx_urb &&
863 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
864 usb_unlink_urb(odev->mux_bulk_tx_urb);
866 /* Update statistics */
867 net->stats.tx_errors++;
870 /* make a real packet from the received USB buffer */
871 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
872 unsigned int count, unsigned char is_eop)
874 unsigned short temp_bytes;
875 unsigned short buffer_offset = 0;
876 unsigned short frame_len;
877 unsigned char *tmp_rx_buf;
880 D1("Rx %d bytes", count);
881 DUMP(ip_pkt, min(128, (int)count));
884 switch (odev->rx_parse_state) {
886 /* waiting for IP header. */
887 /* wanted bytes - size of ip header */
890 odev->rx_buf_missing) ? count : odev->
893 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
894 odev->rx_buf_size, ip_pkt + buffer_offset,
897 odev->rx_buf_size += temp_bytes;
898 buffer_offset += temp_bytes;
899 odev->rx_buf_missing -= temp_bytes;
902 if (!odev->rx_buf_missing) {
903 /* header is complete allocate an sk_buffer and
904 * continue to WAIT_DATA */
905 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
907 if ((frame_len > DEFAULT_MRU) ||
908 (frame_len < sizeof(struct iphdr))) {
909 dev_err(&odev->net->dev,
910 "Invalid frame (%d) length\n",
912 odev->rx_parse_state = WAIT_SYNC;
915 /* Allocate an sk_buff */
916 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
918 if (!odev->skb_rx_buf) {
919 /* We got no receive buffer. */
920 D1("could not allocate memory");
921 odev->rx_parse_state = WAIT_SYNC;
925 /* Copy what we got so far. make room for iphdr
928 skb_put(odev->skb_rx_buf,
929 sizeof(struct iphdr));
930 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
931 sizeof(struct iphdr));
934 odev->rx_buf_size = sizeof(struct iphdr);
936 /* Filip actually use .tot_len */
937 odev->rx_buf_missing =
938 frame_len - sizeof(struct iphdr);
939 odev->rx_parse_state = WAIT_DATA;
944 temp_bytes = (count < odev->rx_buf_missing)
945 ? count : odev->rx_buf_missing;
947 /* Copy the rest of the bytes that are left in the
948 * buffer into the waiting sk_buf. */
949 /* Make room for temp_bytes after tail. */
950 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
951 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
953 odev->rx_buf_missing -= temp_bytes;
955 buffer_offset += temp_bytes;
956 odev->rx_buf_size += temp_bytes;
957 if (!odev->rx_buf_missing) {
958 /* Packet is complete. Inject into stack. */
959 /* We have IP packet here */
960 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
961 skb_reset_mac_header(odev->skb_rx_buf);
963 /* Ship it off to the kernel */
964 netif_rx(odev->skb_rx_buf);
965 /* No longer our buffer. */
966 odev->skb_rx_buf = NULL;
968 /* update out statistics */
969 odev->net->stats.rx_packets++;
971 odev->net->stats.rx_bytes += odev->rx_buf_size;
973 odev->rx_buf_size = 0;
974 odev->rx_buf_missing = sizeof(struct iphdr);
975 odev->rx_parse_state = WAIT_IP;
990 /* Recovery mechanism for WAIT_SYNC state. */
992 if (odev->rx_parse_state == WAIT_SYNC) {
993 odev->rx_parse_state = WAIT_IP;
994 odev->rx_buf_size = 0;
995 odev->rx_buf_missing = sizeof(struct iphdr);
1000 /* Moving data from usb to kernel (in interrupt state) */
1001 static void read_bulk_callback(struct urb *urb)
1003 struct hso_net *odev = urb->context;
1004 struct net_device *net;
1006 int status = urb->status;
1008 /* is al ok? (Filip: Who's Al ?) */
1010 handle_usb_error(status, __func__, odev->parent);
1015 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1016 D1("BULK IN callback but driver is not active!");
1019 usb_mark_last_busy(urb->dev);
1023 if (!netif_device_present(net)) {
1024 /* Somebody killed our network interface... */
1028 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
1030 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1031 rest = urb->actual_length %
1032 le16_to_cpu(odev->in_endp->wMaxPacketSize);
1033 if (((rest == 5) || (rest == 6)) &&
1034 !memcmp(((u8 *) urb->transfer_buffer) +
1035 urb->actual_length - 4, crc_check, 4)) {
1036 urb->actual_length -= 4;
1040 /* do we even have a packet? */
1041 if (urb->actual_length) {
1042 /* Handle the IP stream, add header and push it onto network
1043 * stack if the packet is complete. */
1044 spin_lock(&odev->net_lock);
1045 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1046 (urb->transfer_buffer_length >
1047 urb->actual_length) ? 1 : 0);
1048 spin_unlock(&odev->net_lock);
1051 /* We are done with this URB, resubmit it. Prep the USB to wait for
1052 * another frame. Reuse same as received. */
1053 usb_fill_bulk_urb(urb,
1055 usb_rcvbulkpipe(odev->parent->usb,
1057 bEndpointAddress & 0x7F),
1058 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1059 read_bulk_callback, odev);
1061 /* Give this to the USB subsystem so it can tell us when more data
1063 result = usb_submit_urb(urb, GFP_ATOMIC);
1065 dev_warn(&odev->parent->interface->dev,
1066 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1070 /* Serial driver functions */
1072 static void hso_init_termios(struct ktermios *termios)
1075 * The default requirements for this device are:
1078 ~(IGNBRK /* disable ignore break */
1079 | BRKINT /* disable break causes interrupt */
1080 | PARMRK /* disable mark parity errors */
1081 | ISTRIP /* disable clear high bit of input characters */
1082 | INLCR /* disable translate NL to CR */
1083 | IGNCR /* disable ignore CR */
1084 | ICRNL /* disable translate CR to NL */
1085 | IXON); /* disable enable XON/XOFF flow control */
1087 /* disable postprocess output characters */
1088 termios->c_oflag &= ~OPOST;
1091 ~(ECHO /* disable echo input characters */
1092 | ECHONL /* disable echo new line */
1093 | ICANON /* disable erase, kill, werase, and rprnt
1094 special characters */
1095 | ISIG /* disable interrupt, quit, and suspend special
1097 | IEXTEN); /* disable non-POSIX special characters */
1100 ~(CSIZE /* no size */
1101 | PARENB /* disable parity bit */
1102 | CBAUD /* clear current baud rate */
1103 | CBAUDEX); /* clear current buad rate */
1105 termios->c_cflag |= CS8; /* character size 8 bits */
1107 /* baud rate 115200 */
1108 tty_termios_encode_baud_rate(termios, 115200, 115200);
1111 static void _hso_serial_set_termios(struct tty_struct *tty,
1112 struct ktermios *old)
1114 struct hso_serial *serial = get_serial_by_tty(tty);
1115 struct ktermios *termios;
1118 printk(KERN_ERR "%s: no tty structures", __func__);
1122 D4("port %d", serial->minor);
1125 * Fix up unsupported bits
1127 termios = tty->termios;
1128 termios->c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1131 ~(CSIZE /* no size */
1132 | PARENB /* disable parity bit */
1133 | CBAUD /* clear current baud rate */
1134 | CBAUDEX); /* clear current buad rate */
1136 termios->c_cflag |= CS8; /* character size 8 bits */
1138 /* baud rate 115200 */
1139 tty_encode_baud_rate(tty, 115200, 115200);
1142 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1145 /* We are done with this URB, resubmit it. Prep the USB to wait for
1147 usb_fill_bulk_urb(urb, serial->parent->usb,
1148 usb_rcvbulkpipe(serial->parent->usb,
1150 bEndpointAddress & 0x7F),
1151 urb->transfer_buffer, serial->rx_data_length,
1152 hso_std_serial_read_bulk_callback, serial);
1153 /* Give this to the USB subsystem so it can tell us when more data
1155 result = usb_submit_urb(urb, GFP_ATOMIC);
1157 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1165 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1168 struct urb *curr_urb;
1170 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1171 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1172 count = put_rxbuf_data(curr_urb, serial);
1176 serial->curr_rx_urb_idx++;
1177 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1178 serial->curr_rx_urb_idx = 0;
1179 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1184 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1189 urb = serial->rx_urb[0];
1190 if (serial->open_count > 0) {
1191 count = put_rxbuf_data(urb, serial);
1195 /* Re issue a read as long as we receive data. */
1197 if (count == 0 && ((urb->actual_length != 0) ||
1198 (serial->rx_state == RX_PENDING))) {
1199 serial->rx_state = RX_SENT;
1200 hso_mux_serial_read(serial);
1202 serial->rx_state = RX_IDLE;
1206 /* read callback for Diag and CS port */
1207 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1209 struct hso_serial *serial = urb->context;
1210 int status = urb->status;
1214 D1("serial == NULL");
1216 } else if (status) {
1217 handle_usb_error(status, __func__, serial->parent);
1221 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1222 D1("Actual length = %d\n", urb->actual_length);
1223 DUMP1(urb->transfer_buffer, urb->actual_length);
1225 /* Anyone listening? */
1226 if (serial->open_count == 0)
1230 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1232 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1234 urb->actual_length %
1235 le16_to_cpu(serial->in_endp->wMaxPacketSize);
1236 if (((rest == 5) || (rest == 6)) &&
1237 !memcmp(((u8 *) urb->transfer_buffer) +
1238 urb->actual_length - 4, crc_check, 4)) {
1239 urb->actual_length -= 4;
1242 /* Valid data, handle RX data */
1243 spin_lock(&serial->serial_lock);
1244 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1245 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1246 spin_unlock(&serial->serial_lock);
1247 } else if (status == -ENOENT || status == -ECONNRESET) {
1248 /* Unlinked - check for throttled port. */
1249 D2("Port %d, successfully unlinked urb", serial->minor);
1250 spin_lock(&serial->serial_lock);
1251 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1252 hso_resubmit_rx_bulk_urb(serial, urb);
1253 spin_unlock(&serial->serial_lock);
1255 D2("Port %d, status = %d for read urb", serial->minor, status);
1261 * This needs to be a tasklet otherwise we will
1262 * end up recursively calling this function.
1264 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1266 unsigned long flags;
1268 spin_lock_irqsave(&serial->serial_lock, flags);
1269 if ((serial->parent->port_spec & HSO_INTF_MUX))
1270 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1272 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1273 spin_unlock_irqrestore(&serial->serial_lock, flags);
1276 static void hso_unthrottle(struct tty_struct *tty)
1278 struct hso_serial *serial = get_serial_by_tty(tty);
1280 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1283 static void hso_unthrottle_workfunc(struct work_struct *work)
1285 struct hso_serial *serial =
1286 container_of(work, struct hso_serial,
1287 retry_unthrottle_workqueue);
1288 hso_unthrottle_tasklet(serial);
1291 /* open the requested serial port */
1292 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1294 struct hso_serial *serial = get_serial_by_index(tty->index);
1298 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1300 tty->driver_data = NULL;
1301 D1("Failed to open port");
1305 mutex_lock(&serial->parent->mutex);
1306 result = usb_autopm_get_interface(serial->parent->interface);
1310 D1("Opening %d", serial->minor);
1311 kref_get(&serial->parent->ref);
1314 spin_lock_irq(&serial->serial_lock);
1315 tty->driver_data = serial;
1316 tty_kref_put(serial->tty);
1317 serial->tty = tty_kref_get(tty);
1318 spin_unlock_irq(&serial->serial_lock);
1320 /* check for port already opened, if not set the termios */
1321 serial->open_count++;
1322 if (serial->open_count == 1) {
1323 serial->rx_state = RX_IDLE;
1324 /* Force default termio settings */
1325 _hso_serial_set_termios(tty, NULL);
1326 tasklet_init(&serial->unthrottle_tasklet,
1327 (void (*)(unsigned long))hso_unthrottle_tasklet,
1328 (unsigned long)serial);
1329 INIT_WORK(&serial->retry_unthrottle_workqueue,
1330 hso_unthrottle_workfunc);
1331 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1333 hso_stop_serial_device(serial->parent);
1334 serial->open_count--;
1335 kref_put(&serial->parent->ref, hso_serial_ref_free);
1338 D1("Port was already open");
1341 usb_autopm_put_interface(serial->parent->interface);
1345 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1347 mutex_unlock(&serial->parent->mutex);
1351 /* close the requested serial port */
1352 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1354 struct hso_serial *serial = tty->driver_data;
1357 D1("Closing serial port");
1359 /* Open failed, no close cleanup required */
1363 mutex_lock(&serial->parent->mutex);
1364 usb_gone = serial->parent->usb_gone;
1367 usb_autopm_get_interface(serial->parent->interface);
1369 /* reset the rts and dtr */
1370 /* do the actual close */
1371 serial->open_count--;
1373 if (serial->open_count <= 0) {
1374 serial->open_count = 0;
1375 spin_lock_irq(&serial->serial_lock);
1376 if (serial->tty == tty) {
1377 serial->tty->driver_data = NULL;
1381 spin_unlock_irq(&serial->serial_lock);
1383 hso_stop_serial_device(serial->parent);
1384 tasklet_kill(&serial->unthrottle_tasklet);
1385 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1389 usb_autopm_put_interface(serial->parent->interface);
1391 mutex_unlock(&serial->parent->mutex);
1393 kref_put(&serial->parent->ref, hso_serial_ref_free);
1396 /* close the requested serial port */
1397 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1400 struct hso_serial *serial = get_serial_by_tty(tty);
1401 int space, tx_bytes;
1402 unsigned long flags;
1405 if (serial == NULL) {
1406 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1410 spin_lock_irqsave(&serial->serial_lock, flags);
1412 space = serial->tx_data_length - serial->tx_buffer_count;
1413 tx_bytes = (count < space) ? count : space;
1418 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1419 serial->tx_buffer_count += tx_bytes;
1422 spin_unlock_irqrestore(&serial->serial_lock, flags);
1424 hso_kick_transmit(serial);
1429 /* how much room is there for writing */
1430 static int hso_serial_write_room(struct tty_struct *tty)
1432 struct hso_serial *serial = get_serial_by_tty(tty);
1434 unsigned long flags;
1436 spin_lock_irqsave(&serial->serial_lock, flags);
1437 room = serial->tx_data_length - serial->tx_buffer_count;
1438 spin_unlock_irqrestore(&serial->serial_lock, flags);
1440 /* return free room */
1444 /* setup the term */
1445 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1447 struct hso_serial *serial = get_serial_by_tty(tty);
1448 unsigned long flags;
1451 D5("Termios called with: cflags new[%d] - old[%d]",
1452 tty->termios->c_cflag, old->c_cflag);
1454 /* the actual setup */
1455 spin_lock_irqsave(&serial->serial_lock, flags);
1456 if (serial->open_count)
1457 _hso_serial_set_termios(tty, old);
1460 spin_unlock_irqrestore(&serial->serial_lock, flags);
1465 /* how many characters in the buffer */
1466 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1468 struct hso_serial *serial = get_serial_by_tty(tty);
1470 unsigned long flags;
1476 spin_lock_irqsave(&serial->serial_lock, flags);
1477 chars = serial->tx_buffer_count;
1478 spin_unlock_irqrestore(&serial->serial_lock, flags);
1482 static int tiocmget_submit_urb(struct hso_serial *serial,
1483 struct hso_tiocmget *tiocmget,
1484 struct usb_device *usb)
1488 if (serial->parent->usb_gone)
1490 usb_fill_int_urb(tiocmget->urb, usb,
1493 bEndpointAddress & 0x7F),
1494 &tiocmget->serial_state_notification,
1495 sizeof(struct hso_serial_state_notification),
1496 tiocmget_intr_callback, serial,
1497 tiocmget->endp->bInterval);
1498 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1500 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1507 static void tiocmget_intr_callback(struct urb *urb)
1509 struct hso_serial *serial = urb->context;
1510 struct hso_tiocmget *tiocmget;
1511 int status = urb->status;
1512 u16 UART_state_bitmap, prev_UART_state_bitmap;
1513 struct uart_icount *icount;
1514 struct hso_serial_state_notification *serial_state_notification;
1515 struct usb_device *usb;
1521 handle_usb_error(status, __func__, serial->parent);
1524 tiocmget = serial->tiocmget;
1527 usb = serial->parent->usb;
1528 serial_state_notification = &tiocmget->serial_state_notification;
1529 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1530 serial_state_notification->bNotification != B_NOTIFICATION ||
1531 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1532 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1533 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1535 "hso received invalid serial state notification\n");
1536 DUMP(serial_state_notification,
1537 sizeof(struct hso_serial_state_notification));
1540 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1542 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1543 icount = &tiocmget->icount;
1544 spin_lock(&serial->serial_lock);
1545 if ((UART_state_bitmap & B_OVERRUN) !=
1546 (prev_UART_state_bitmap & B_OVERRUN))
1548 if ((UART_state_bitmap & B_PARITY) !=
1549 (prev_UART_state_bitmap & B_PARITY))
1551 if ((UART_state_bitmap & B_FRAMING) !=
1552 (prev_UART_state_bitmap & B_FRAMING))
1554 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1555 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1557 if ((UART_state_bitmap & B_BREAK) !=
1558 (prev_UART_state_bitmap & B_BREAK))
1560 if ((UART_state_bitmap & B_TX_CARRIER) !=
1561 (prev_UART_state_bitmap & B_TX_CARRIER))
1563 if ((UART_state_bitmap & B_RX_CARRIER) !=
1564 (prev_UART_state_bitmap & B_RX_CARRIER))
1566 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1567 spin_unlock(&serial->serial_lock);
1568 tiocmget->intr_completed = 1;
1569 wake_up_interruptible(&tiocmget->waitq);
1571 memset(serial_state_notification, 0,
1572 sizeof(struct hso_serial_state_notification));
1573 tiocmget_submit_urb(serial,
1575 serial->parent->usb);
1579 * next few functions largely stolen from drivers/serial/serial_core.c
1581 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1582 * - mask passed in arg for lines of interest
1583 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1584 * Caller should use TIOCGICOUNT to see which one it was
1587 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1589 DECLARE_WAITQUEUE(wait, current);
1590 struct uart_icount cprev, cnow;
1591 struct hso_tiocmget *tiocmget;
1594 tiocmget = serial->tiocmget;
1598 * note the counters on entry
1600 spin_lock_irq(&serial->serial_lock);
1601 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1602 spin_unlock_irq(&serial->serial_lock);
1603 add_wait_queue(&tiocmget->waitq, &wait);
1605 spin_lock_irq(&serial->serial_lock);
1606 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1607 spin_unlock_irq(&serial->serial_lock);
1608 set_current_state(TASK_INTERRUPTIBLE);
1609 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1610 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1611 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1616 /* see if a signal did it */
1617 if (signal_pending(current)) {
1623 current->state = TASK_RUNNING;
1624 remove_wait_queue(&tiocmget->waitq, &wait);
1630 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1631 * Return: write counters to the user passed counter struct
1632 * NB: both 1->0 and 0->1 transitions are counted except for
1633 * RI where only 0->1 is counted.
1635 static int hso_get_count(struct tty_struct *tty,
1636 struct serial_icounter_struct *icount)
1638 struct uart_icount cnow;
1639 struct hso_serial *serial = get_serial_by_tty(tty);
1640 struct hso_tiocmget *tiocmget = serial->tiocmget;
1642 memset(&icount, 0, sizeof(struct serial_icounter_struct));
1646 spin_lock_irq(&serial->serial_lock);
1647 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1648 spin_unlock_irq(&serial->serial_lock);
1650 icount->cts = cnow.cts;
1651 icount->dsr = cnow.dsr;
1652 icount->rng = cnow.rng;
1653 icount->dcd = cnow.dcd;
1654 icount->rx = cnow.rx;
1655 icount->tx = cnow.tx;
1656 icount->frame = cnow.frame;
1657 icount->overrun = cnow.overrun;
1658 icount->parity = cnow.parity;
1659 icount->brk = cnow.brk;
1660 icount->buf_overrun = cnow.buf_overrun;
1666 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1669 struct hso_serial *serial = get_serial_by_tty(tty);
1670 struct hso_tiocmget *tiocmget;
1671 u16 UART_state_bitmap;
1675 D1("no tty structures");
1678 spin_lock_irq(&serial->serial_lock);
1679 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1680 ((serial->dtr_state) ? TIOCM_DTR : 0);
1681 tiocmget = serial->tiocmget;
1684 UART_state_bitmap = le16_to_cpu(
1685 tiocmget->prev_UART_state_bitmap);
1686 if (UART_state_bitmap & B_RING_SIGNAL)
1687 retval |= TIOCM_RNG;
1688 if (UART_state_bitmap & B_RX_CARRIER)
1690 if (UART_state_bitmap & B_TX_CARRIER)
1691 retval |= TIOCM_DSR;
1693 spin_unlock_irq(&serial->serial_lock);
1697 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1698 unsigned int set, unsigned int clear)
1701 unsigned long flags;
1703 struct hso_serial *serial = get_serial_by_tty(tty);
1707 D1("no tty structures");
1711 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1714 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1716 spin_lock_irqsave(&serial->serial_lock, flags);
1717 if (set & TIOCM_RTS)
1718 serial->rts_state = 1;
1719 if (set & TIOCM_DTR)
1720 serial->dtr_state = 1;
1722 if (clear & TIOCM_RTS)
1723 serial->rts_state = 0;
1724 if (clear & TIOCM_DTR)
1725 serial->dtr_state = 0;
1727 if (serial->dtr_state)
1729 if (serial->rts_state)
1732 spin_unlock_irqrestore(&serial->serial_lock, flags);
1734 return usb_control_msg(serial->parent->usb,
1735 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1736 0x21, val, if_num, NULL, 0,
1737 USB_CTRL_SET_TIMEOUT);
1740 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1741 unsigned int cmd, unsigned long arg)
1743 struct hso_serial *serial = get_serial_by_tty(tty);
1744 void __user *uarg = (void __user *)arg;
1746 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1752 ret = hso_wait_modem_status(serial, arg);
1762 /* starts a transmit */
1763 static void hso_kick_transmit(struct hso_serial *serial)
1766 unsigned long flags;
1769 spin_lock_irqsave(&serial->serial_lock, flags);
1770 if (!serial->tx_buffer_count)
1773 if (serial->tx_urb_used)
1776 /* Wakeup USB interface if necessary */
1777 if (hso_get_activity(serial->parent) == -EAGAIN)
1780 /* Switch pointers around to avoid memcpy */
1781 temp = serial->tx_buffer;
1782 serial->tx_buffer = serial->tx_data;
1783 serial->tx_data = temp;
1784 serial->tx_data_count = serial->tx_buffer_count;
1785 serial->tx_buffer_count = 0;
1787 /* If temp is set, it means we switched buffers */
1788 if (temp && serial->write_data) {
1789 res = serial->write_data(serial);
1791 serial->tx_urb_used = 1;
1794 spin_unlock_irqrestore(&serial->serial_lock, flags);
1797 /* make a request (for reading and writing data to muxed serial port) */
1798 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1799 struct urb *ctrl_urb,
1800 struct usb_ctrlrequest *ctrl_req,
1801 u8 *ctrl_urb_data, u32 size)
1807 if (!serial || !ctrl_urb || !ctrl_req) {
1808 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1813 ctrl_req->wValue = 0;
1814 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1815 ctrl_req->wLength = cpu_to_le16(size);
1817 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1818 /* Reading command */
1819 ctrl_req->bRequestType = USB_DIR_IN |
1820 USB_TYPE_OPTION_VENDOR |
1821 USB_RECIP_INTERFACE;
1822 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1823 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1825 /* Writing command */
1826 ctrl_req->bRequestType = USB_DIR_OUT |
1827 USB_TYPE_OPTION_VENDOR |
1828 USB_RECIP_INTERFACE;
1829 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1830 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1833 D2("%s command (%02x) len: %d, port: %d",
1834 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1835 ctrl_req->bRequestType, ctrl_req->wLength, port);
1838 ctrl_urb->transfer_flags = 0;
1839 usb_fill_control_urb(ctrl_urb,
1840 serial->parent->usb,
1843 ctrl_urb_data, size, ctrl_callback, serial);
1844 /* Send it on merry way */
1845 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1847 dev_err(&ctrl_urb->dev->dev,
1848 "%s failed submit ctrl_urb %d type %d\n", __func__,
1857 /* called by intr_callback when read occurs */
1858 static int hso_mux_serial_read(struct hso_serial *serial)
1864 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1865 /* make the request */
1867 if (serial->num_rx_urbs != 1) {
1868 dev_err(&serial->parent->interface->dev,
1869 "ERROR: mux'd reads with multiple buffers "
1873 return mux_device_request(serial,
1874 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1875 serial->parent->port_spec & HSO_PORT_MASK,
1877 &serial->ctrl_req_rx,
1878 serial->rx_data[0], serial->rx_data_length);
1881 /* used for muxed serial port callback (muxed serial read) */
1882 static void intr_callback(struct urb *urb)
1884 struct hso_shared_int *shared_int = urb->context;
1885 struct hso_serial *serial;
1886 unsigned char *port_req;
1887 int status = urb->status;
1890 usb_mark_last_busy(urb->dev);
1898 handle_usb_error(status, __func__, NULL);
1901 D4("\n--- Got intr callback 0x%02X ---", status);
1904 port_req = urb->transfer_buffer;
1905 D4(" port_req = 0x%.2X\n", *port_req);
1906 /* loop over all muxed ports to find the one sending this */
1907 for (i = 0; i < 8; i++) {
1908 /* max 8 channels on MUX */
1909 if (*port_req & (1 << i)) {
1910 serial = get_serial_by_shared_int_and_type(shared_int,
1912 if (serial != NULL) {
1913 D1("Pending read interrupt on port %d\n", i);
1914 spin_lock(&serial->serial_lock);
1915 if (serial->rx_state == RX_IDLE &&
1916 serial->open_count > 0) {
1917 /* Setup and send a ctrl req read on
1919 if (!serial->rx_urb_filled[0]) {
1920 serial->rx_state = RX_SENT;
1921 hso_mux_serial_read(serial);
1923 serial->rx_state = RX_PENDING;
1925 D1("Already a read pending on "
1926 "port %d or port not open\n", i);
1928 spin_unlock(&serial->serial_lock);
1932 /* Resubmit interrupt urb */
1933 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1936 /* called for writing to muxed serial port */
1937 static int hso_mux_serial_write_data(struct hso_serial *serial)
1942 return mux_device_request(serial,
1943 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1944 serial->parent->port_spec & HSO_PORT_MASK,
1946 &serial->ctrl_req_tx,
1947 serial->tx_data, serial->tx_data_count);
1950 /* write callback for Diag and CS port */
1951 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1953 struct hso_serial *serial = urb->context;
1954 int status = urb->status;
1955 struct tty_struct *tty;
1959 D1("serial == NULL");
1963 spin_lock(&serial->serial_lock);
1964 serial->tx_urb_used = 0;
1965 tty = tty_kref_get(serial->tty);
1966 spin_unlock(&serial->serial_lock);
1968 handle_usb_error(status, __func__, serial->parent);
1972 hso_put_activity(serial->parent);
1977 hso_kick_transmit(serial);
1982 /* called for writing diag or CS serial port */
1983 static int hso_std_serial_write_data(struct hso_serial *serial)
1985 int count = serial->tx_data_count;
1988 usb_fill_bulk_urb(serial->tx_urb,
1989 serial->parent->usb,
1990 usb_sndbulkpipe(serial->parent->usb,
1992 bEndpointAddress & 0x7F),
1993 serial->tx_data, serial->tx_data_count,
1994 hso_std_serial_write_bulk_callback, serial);
1996 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1998 dev_warn(&serial->parent->usb->dev,
1999 "Failed to submit urb - res %d\n", result);
2006 /* callback after read or write on muxed serial port */
2007 static void ctrl_callback(struct urb *urb)
2009 struct hso_serial *serial = urb->context;
2010 struct usb_ctrlrequest *req;
2011 int status = urb->status;
2012 struct tty_struct *tty;
2018 spin_lock(&serial->serial_lock);
2019 serial->tx_urb_used = 0;
2020 tty = tty_kref_get(serial->tty);
2021 spin_unlock(&serial->serial_lock);
2023 handle_usb_error(status, __func__, serial->parent);
2029 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2030 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2031 D4("Actual length of urb = %d\n", urb->actual_length);
2032 DUMP1(urb->transfer_buffer, urb->actual_length);
2034 if (req->bRequestType ==
2035 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2036 /* response to a read command */
2037 serial->rx_urb_filled[0] = 1;
2038 spin_lock(&serial->serial_lock);
2039 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2040 spin_unlock(&serial->serial_lock);
2042 hso_put_activity(serial->parent);
2045 /* response to a write command */
2046 hso_kick_transmit(serial);
2051 /* handle RX data for serial port */
2052 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2054 struct tty_struct *tty;
2055 int write_length_remaining = 0;
2059 if (urb == NULL || serial == NULL) {
2060 D1("serial = NULL");
2064 /* All callers to put_rxbuf_data hold serial_lock */
2065 tty = tty_kref_get(serial->tty);
2067 /* Push data to tty */
2069 write_length_remaining = urb->actual_length -
2070 serial->curr_rx_urb_offset;
2071 D1("data to push to tty");
2072 while (write_length_remaining) {
2073 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2077 curr_write_len = tty_insert_flip_string
2078 (tty, urb->transfer_buffer +
2079 serial->curr_rx_urb_offset,
2080 write_length_remaining);
2081 serial->curr_rx_urb_offset += curr_write_len;
2082 write_length_remaining -= curr_write_len;
2083 tty_flip_buffer_push(tty);
2086 if (write_length_remaining == 0) {
2087 serial->curr_rx_urb_offset = 0;
2088 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2091 return write_length_remaining;
2095 /* Base driver functions */
2097 static void hso_log_port(struct hso_device *hso_dev)
2102 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2103 case HSO_PORT_CONTROL:
2104 port_type = "Control";
2107 port_type = "Application";
2112 case HSO_PORT_GPS_CONTROL:
2113 port_type = "GPS control";
2116 port_type = "Application2";
2122 port_type = "Diagnostic";
2124 case HSO_PORT_DIAG2:
2125 port_type = "Diagnostic2";
2127 case HSO_PORT_MODEM:
2128 port_type = "Modem";
2130 case HSO_PORT_NETWORK:
2131 port_type = "Network";
2134 port_type = "Unknown";
2137 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2138 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2140 sprintf(port_dev, "/dev/%s%d", tty_filename,
2141 dev2ser(hso_dev)->minor);
2143 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2144 port_type, port_dev);
2147 static int hso_start_net_device(struct hso_device *hso_dev)
2150 struct hso_net *hso_net = dev2net(hso_dev);
2155 /* send URBs for all read buffers */
2156 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2158 /* Prep a receive URB */
2159 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2161 usb_rcvbulkpipe(hso_dev->usb,
2163 bEndpointAddress & 0x7F),
2164 hso_net->mux_bulk_rx_buf_pool[i],
2165 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2168 /* Put it out there so the device can send us stuff */
2169 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2172 dev_warn(&hso_dev->usb->dev,
2173 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2180 static int hso_stop_net_device(struct hso_device *hso_dev)
2183 struct hso_net *hso_net = dev2net(hso_dev);
2188 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2189 if (hso_net->mux_bulk_rx_urb_pool[i])
2190 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2193 if (hso_net->mux_bulk_tx_urb)
2194 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2199 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2202 struct hso_serial *serial = dev2ser(hso_dev);
2207 /* If it is not the MUX port fill in and submit a bulk urb (already
2208 * allocated in hso_serial_start) */
2209 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2210 for (i = 0; i < serial->num_rx_urbs; i++) {
2211 usb_fill_bulk_urb(serial->rx_urb[i],
2212 serial->parent->usb,
2213 usb_rcvbulkpipe(serial->parent->usb,
2218 serial->rx_data_length,
2219 hso_std_serial_read_bulk_callback,
2221 result = usb_submit_urb(serial->rx_urb[i], flags);
2223 dev_warn(&serial->parent->usb->dev,
2224 "Failed to submit urb - res %d\n",
2230 mutex_lock(&serial->shared_int->shared_int_lock);
2231 if (!serial->shared_int->use_count) {
2233 hso_mux_submit_intr_urb(serial->shared_int,
2234 hso_dev->usb, flags);
2236 serial->shared_int->use_count++;
2237 mutex_unlock(&serial->shared_int->shared_int_lock);
2239 if (serial->tiocmget)
2240 tiocmget_submit_urb(serial,
2242 serial->parent->usb);
2246 static int hso_stop_serial_device(struct hso_device *hso_dev)
2249 struct hso_serial *serial = dev2ser(hso_dev);
2250 struct hso_tiocmget *tiocmget;
2255 for (i = 0; i < serial->num_rx_urbs; i++) {
2256 if (serial->rx_urb[i]) {
2257 usb_kill_urb(serial->rx_urb[i]);
2258 serial->rx_urb_filled[i] = 0;
2261 serial->curr_rx_urb_idx = 0;
2262 serial->curr_rx_urb_offset = 0;
2265 usb_kill_urb(serial->tx_urb);
2267 if (serial->shared_int) {
2268 mutex_lock(&serial->shared_int->shared_int_lock);
2269 if (serial->shared_int->use_count &&
2270 (--serial->shared_int->use_count == 0)) {
2273 urb = serial->shared_int->shared_intr_urb;
2277 mutex_unlock(&serial->shared_int->shared_int_lock);
2279 tiocmget = serial->tiocmget;
2281 wake_up_interruptible(&tiocmget->waitq);
2282 usb_kill_urb(tiocmget->urb);
2288 static void hso_serial_common_free(struct hso_serial *serial)
2292 if (serial->parent->dev)
2293 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2295 tty_unregister_device(tty_drv, serial->minor);
2297 for (i = 0; i < serial->num_rx_urbs; i++) {
2298 /* unlink and free RX URB */
2299 usb_free_urb(serial->rx_urb[i]);
2300 /* free the RX buffer */
2301 kfree(serial->rx_data[i]);
2304 /* unlink and free TX URB */
2305 usb_free_urb(serial->tx_urb);
2306 kfree(serial->tx_data);
2309 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2310 int rx_size, int tx_size)
2316 minor = get_free_serial_index();
2320 /* register our minor number */
2321 serial->parent->dev = tty_register_device(tty_drv, minor,
2322 &serial->parent->interface->dev);
2323 dev = serial->parent->dev;
2324 dev_set_drvdata(dev, serial->parent);
2325 i = device_create_file(dev, &dev_attr_hsotype);
2327 /* fill in specific data for later use */
2328 serial->minor = minor;
2329 serial->magic = HSO_SERIAL_MAGIC;
2330 spin_lock_init(&serial->serial_lock);
2331 serial->num_rx_urbs = num_urbs;
2333 /* RX, allocate urb and initialize */
2335 /* prepare our RX buffer */
2336 serial->rx_data_length = rx_size;
2337 for (i = 0; i < serial->num_rx_urbs; i++) {
2338 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2339 if (!serial->rx_urb[i]) {
2340 dev_err(dev, "Could not allocate urb?\n");
2343 serial->rx_urb[i]->transfer_buffer = NULL;
2344 serial->rx_urb[i]->transfer_buffer_length = 0;
2345 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2347 if (!serial->rx_data[i]) {
2348 dev_err(dev, "%s - Out of memory\n", __func__);
2353 /* TX, allocate urb and initialize */
2354 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2355 if (!serial->tx_urb) {
2356 dev_err(dev, "Could not allocate urb?\n");
2359 serial->tx_urb->transfer_buffer = NULL;
2360 serial->tx_urb->transfer_buffer_length = 0;
2361 /* prepare our TX buffer */
2362 serial->tx_data_count = 0;
2363 serial->tx_buffer_count = 0;
2364 serial->tx_data_length = tx_size;
2365 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2366 if (!serial->tx_data) {
2367 dev_err(dev, "%s - Out of memory\n", __func__);
2370 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2371 if (!serial->tx_buffer) {
2372 dev_err(dev, "%s - Out of memory\n", __func__);
2378 hso_serial_common_free(serial);
2382 /* Creates a general hso device */
2383 static struct hso_device *hso_create_device(struct usb_interface *intf,
2386 struct hso_device *hso_dev;
2388 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2392 hso_dev->port_spec = port_spec;
2393 hso_dev->usb = interface_to_usbdev(intf);
2394 hso_dev->interface = intf;
2395 kref_init(&hso_dev->ref);
2396 mutex_init(&hso_dev->mutex);
2398 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2399 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2400 INIT_WORK(&hso_dev->reset_device, reset_device);
2405 /* Removes a network device in the network device table */
2406 static int remove_net_device(struct hso_device *hso_dev)
2410 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2411 if (network_table[i] == hso_dev) {
2412 network_table[i] = NULL;
2416 if (i == HSO_MAX_NET_DEVICES)
2421 /* Frees our network device */
2422 static void hso_free_net_device(struct hso_device *hso_dev)
2425 struct hso_net *hso_net = dev2net(hso_dev);
2430 remove_net_device(hso_net->parent);
2433 unregister_netdev(hso_net->net);
2434 free_netdev(hso_net->net);
2438 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2439 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2440 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2441 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2443 usb_free_urb(hso_net->mux_bulk_tx_urb);
2444 kfree(hso_net->mux_bulk_tx_buf);
2445 hso_net->mux_bulk_tx_buf = NULL;
2450 static const struct net_device_ops hso_netdev_ops = {
2451 .ndo_open = hso_net_open,
2452 .ndo_stop = hso_net_close,
2453 .ndo_start_xmit = hso_net_start_xmit,
2454 .ndo_tx_timeout = hso_net_tx_timeout,
2457 /* initialize the network interface */
2458 static void hso_net_init(struct net_device *net)
2460 struct hso_net *hso_net = netdev_priv(net);
2462 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2464 /* fill in the other fields */
2465 net->netdev_ops = &hso_netdev_ops;
2466 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2467 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2468 net->type = ARPHRD_NONE;
2469 net->mtu = DEFAULT_MTU - 14;
2470 net->tx_queue_len = 10;
2471 SET_ETHTOOL_OPS(net, &ops);
2473 /* and initialize the semaphore */
2474 spin_lock_init(&hso_net->net_lock);
2477 /* Adds a network device in the network device table */
2478 static int add_net_device(struct hso_device *hso_dev)
2482 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2483 if (network_table[i] == NULL) {
2484 network_table[i] = hso_dev;
2488 if (i == HSO_MAX_NET_DEVICES)
2493 static int hso_rfkill_set_block(void *data, bool blocked)
2495 struct hso_device *hso_dev = data;
2496 int enabled = !blocked;
2499 mutex_lock(&hso_dev->mutex);
2500 if (hso_dev->usb_gone)
2503 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2504 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2505 USB_CTRL_SET_TIMEOUT);
2506 mutex_unlock(&hso_dev->mutex);
2510 static const struct rfkill_ops hso_rfkill_ops = {
2511 .set_block = hso_rfkill_set_block,
2514 /* Creates and sets up everything for rfkill */
2515 static void hso_create_rfkill(struct hso_device *hso_dev,
2516 struct usb_interface *interface)
2518 struct hso_net *hso_net = dev2net(hso_dev);
2519 struct device *dev = &hso_net->net->dev;
2522 rfkn = kzalloc(20, GFP_KERNEL);
2524 dev_err(dev, "%s - Out of memory\n", __func__);
2526 snprintf(rfkn, 20, "hso-%d",
2527 interface->altsetting->desc.bInterfaceNumber);
2529 hso_net->rfkill = rfkill_alloc(rfkn,
2530 &interface_to_usbdev(interface)->dev,
2532 &hso_rfkill_ops, hso_dev);
2533 if (!hso_net->rfkill) {
2534 dev_err(dev, "%s - Out of memory\n", __func__);
2538 if (rfkill_register(hso_net->rfkill) < 0) {
2539 rfkill_destroy(hso_net->rfkill);
2541 hso_net->rfkill = NULL;
2542 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2547 static struct device_type hso_type = {
2551 /* Creates our network device */
2552 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2556 struct net_device *net;
2557 struct hso_net *hso_net;
2558 struct hso_device *hso_dev;
2560 hso_dev = hso_create_device(interface, port_spec);
2564 /* allocate our network device, then we can put in our private data */
2565 /* call hso_net_init to do the basic initialization */
2566 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2568 dev_err(&interface->dev, "Unable to create ethernet device\n");
2572 hso_net = netdev_priv(net);
2574 hso_dev->port_data.dev_net = hso_net;
2576 hso_net->parent = hso_dev;
2578 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2580 if (!hso_net->in_endp) {
2581 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2584 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2586 if (!hso_net->out_endp) {
2587 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2590 SET_NETDEV_DEV(net, &interface->dev);
2591 SET_NETDEV_DEVTYPE(net, &hso_type);
2593 /* registering our net device */
2594 result = register_netdev(net);
2596 dev_err(&interface->dev, "Failed to register device\n");
2600 /* start allocating */
2601 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2602 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2603 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2604 dev_err(&interface->dev, "Could not allocate rx urb\n");
2607 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2609 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2610 dev_err(&interface->dev, "Could not allocate rx buf\n");
2614 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2615 if (!hso_net->mux_bulk_tx_urb) {
2616 dev_err(&interface->dev, "Could not allocate tx urb\n");
2619 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2620 if (!hso_net->mux_bulk_tx_buf) {
2621 dev_err(&interface->dev, "Could not allocate tx buf\n");
2625 add_net_device(hso_dev);
2627 hso_log_port(hso_dev);
2629 hso_create_rfkill(hso_dev, interface);
2633 hso_free_net_device(hso_dev);
2637 static void hso_free_tiomget(struct hso_serial *serial)
2639 struct hso_tiocmget *tiocmget = serial->tiocmget;
2641 if (tiocmget->urb) {
2642 usb_free_urb(tiocmget->urb);
2643 tiocmget->urb = NULL;
2645 serial->tiocmget = NULL;
2651 /* Frees an AT channel ( goes for both mux and non-mux ) */
2652 static void hso_free_serial_device(struct hso_device *hso_dev)
2654 struct hso_serial *serial = dev2ser(hso_dev);
2658 set_serial_by_index(serial->minor, NULL);
2660 hso_serial_common_free(serial);
2662 if (serial->shared_int) {
2663 mutex_lock(&serial->shared_int->shared_int_lock);
2664 if (--serial->shared_int->ref_count == 0)
2665 hso_free_shared_int(serial->shared_int);
2667 mutex_unlock(&serial->shared_int->shared_int_lock);
2669 hso_free_tiomget(serial);
2674 /* Creates a bulk AT channel */
2675 static struct hso_device *hso_create_bulk_serial_device(
2676 struct usb_interface *interface, int port)
2678 struct hso_device *hso_dev;
2679 struct hso_serial *serial;
2681 struct hso_tiocmget *tiocmget;
2683 hso_dev = hso_create_device(interface, port);
2687 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2691 serial->parent = hso_dev;
2692 hso_dev->port_data.dev_serial = serial;
2694 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2696 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2698 /* it isn't going to break our heart if serial->tiocmget
2699 * allocation fails don't bother checking this.
2701 if (serial->tiocmget) {
2702 tiocmget = serial->tiocmget;
2703 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2704 if (tiocmget->urb) {
2705 mutex_init(&tiocmget->mutex);
2706 init_waitqueue_head(&tiocmget->waitq);
2707 tiocmget->endp = hso_get_ep(
2709 USB_ENDPOINT_XFER_INT,
2712 hso_free_tiomget(serial);
2718 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2722 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2724 if (!serial->in_endp) {
2725 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2731 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2732 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2736 serial->write_data = hso_std_serial_write_data;
2738 /* and record this serial */
2739 set_serial_by_index(serial->minor, serial);
2741 /* setup the proc dirs and files if needed */
2742 hso_log_port(hso_dev);
2744 /* done, return it */
2748 hso_serial_common_free(serial);
2750 hso_free_tiomget(serial);
2756 /* Creates a multiplexed AT channel */
2758 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2760 struct hso_shared_int *mux)
2762 struct hso_device *hso_dev;
2763 struct hso_serial *serial;
2766 port_spec = HSO_INTF_MUX;
2767 port_spec &= ~HSO_PORT_MASK;
2769 port_spec |= hso_mux_to_port(port);
2770 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2773 hso_dev = hso_create_device(interface, port_spec);
2777 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2781 hso_dev->port_data.dev_serial = serial;
2782 serial->parent = hso_dev;
2784 if (hso_serial_common_create
2785 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2788 serial->tx_data_length--;
2789 serial->write_data = hso_mux_serial_write_data;
2791 serial->shared_int = mux;
2792 mutex_lock(&serial->shared_int->shared_int_lock);
2793 serial->shared_int->ref_count++;
2794 mutex_unlock(&serial->shared_int->shared_int_lock);
2796 /* and record this serial */
2797 set_serial_by_index(serial->minor, serial);
2799 /* setup the proc dirs and files if needed */
2800 hso_log_port(hso_dev);
2802 /* done, return it */
2807 tty_unregister_device(tty_drv, serial->minor);
2816 static void hso_free_shared_int(struct hso_shared_int *mux)
2818 usb_free_urb(mux->shared_intr_urb);
2819 kfree(mux->shared_intr_buf);
2820 mutex_unlock(&mux->shared_int_lock);
2825 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2827 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2832 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2834 if (!mux->intr_endp) {
2835 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2839 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2840 if (!mux->shared_intr_urb) {
2841 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2844 mux->shared_intr_buf =
2845 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2847 if (!mux->shared_intr_buf) {
2848 dev_err(&interface->dev, "Could not allocate intr buf?\n");
2852 mutex_init(&mux->shared_int_lock);
2857 kfree(mux->shared_intr_buf);
2858 usb_free_urb(mux->shared_intr_urb);
2863 /* Gets the port spec for a certain interface */
2864 static int hso_get_config_data(struct usb_interface *interface)
2866 struct usb_device *usbdev = interface_to_usbdev(interface);
2868 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2871 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2872 0x86, 0xC0, 0, 0, config_data, 17,
2873 USB_CTRL_SET_TIMEOUT) != 0x11) {
2877 switch (config_data[if_num]) {
2882 result = HSO_PORT_DIAG;
2885 result = HSO_PORT_GPS;
2888 result = HSO_PORT_GPS_CONTROL;
2891 result = HSO_PORT_APP;
2894 result = HSO_PORT_APP2;
2897 result = HSO_PORT_CONTROL;
2900 result = HSO_PORT_NETWORK;
2903 result = HSO_PORT_MODEM;
2906 result = HSO_PORT_MSD;
2909 result = HSO_PORT_PCSC;
2912 result = HSO_PORT_VOICE;
2919 result |= HSO_INTF_BULK;
2921 if (config_data[16] & 0x1)
2922 result |= HSO_INFO_CRC_BUG;
2927 /* called once for each interface upon device insertion */
2928 static int hso_probe(struct usb_interface *interface,
2929 const struct usb_device_id *id)
2931 int mux, i, if_num, port_spec;
2932 unsigned char port_mask;
2933 struct hso_device *hso_dev = NULL;
2934 struct hso_shared_int *shared_int;
2935 struct hso_device *tmp_dev = NULL;
2937 if_num = interface->altsetting->desc.bInterfaceNumber;
2939 /* Get the interface/port specification from either driver_info or from
2940 * the device itself */
2941 if (id->driver_info)
2942 port_spec = ((u32 *)(id->driver_info))[if_num];
2944 port_spec = hso_get_config_data(interface);
2946 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2947 dev_err(&interface->dev, "Not our interface\n");
2950 /* Check if we need to switch to alt interfaces prior to port
2952 if (interface->num_altsetting > 1)
2953 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2954 interface->needs_remote_wakeup = 1;
2956 /* Allocate new hso device(s) */
2957 switch (port_spec & HSO_INTF_MASK) {
2959 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2960 /* Create the network device */
2962 hso_dev = hso_create_net_device(interface,
2970 if (hso_get_mux_ports(interface, &port_mask))
2971 /* TODO: de-allocate everything */
2974 shared_int = hso_create_shared_int(interface);
2978 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2979 if (port_mask & i) {
2980 hso_dev = hso_create_mux_serial_device(
2981 interface, i, shared_int);
2992 /* It's a regular bulk interface */
2993 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2996 hso_create_net_device(interface, port_spec);
2999 hso_create_bulk_serial_device(interface, port_spec);
3008 /* save our data pointer in this device */
3009 usb_set_intfdata(interface, hso_dev);
3014 hso_free_interface(interface);
3018 /* device removed, cleaning up */
3019 static void hso_disconnect(struct usb_interface *interface)
3021 hso_free_interface(interface);
3023 /* remove reference of our private data */
3024 usb_set_intfdata(interface, NULL);
3027 static void async_get_intf(struct work_struct *data)
3029 struct hso_device *hso_dev =
3030 container_of(data, struct hso_device, async_get_intf);
3031 usb_autopm_get_interface(hso_dev->interface);
3034 static void async_put_intf(struct work_struct *data)
3036 struct hso_device *hso_dev =
3037 container_of(data, struct hso_device, async_put_intf);
3038 usb_autopm_put_interface(hso_dev->interface);
3041 static int hso_get_activity(struct hso_device *hso_dev)
3043 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3044 if (!hso_dev->is_active) {
3045 hso_dev->is_active = 1;
3046 schedule_work(&hso_dev->async_get_intf);
3050 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3053 usb_mark_last_busy(hso_dev->usb);
3058 static int hso_put_activity(struct hso_device *hso_dev)
3060 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3061 if (hso_dev->is_active) {
3062 hso_dev->is_active = 0;
3063 schedule_work(&hso_dev->async_put_intf);
3067 hso_dev->is_active = 0;
3071 /* called by kernel when we need to suspend device */
3072 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3076 /* Stop all serial ports */
3077 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3078 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3079 result = hso_stop_serial_device(serial_table[i]);
3085 /* Stop all network ports */
3086 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3087 if (network_table[i] &&
3088 (network_table[i]->interface == iface)) {
3089 result = hso_stop_net_device(network_table[i]);
3099 /* called by kernel when we need to resume device */
3100 static int hso_resume(struct usb_interface *iface)
3103 struct hso_net *hso_net;
3105 /* Start all serial ports */
3106 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3107 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3108 if (dev2ser(serial_table[i])->open_count) {
3110 hso_start_serial_device(serial_table[i], GFP_NOIO);
3111 hso_kick_transmit(dev2ser(serial_table[i]));
3118 /* Start all network ports */
3119 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3120 if (network_table[i] &&
3121 (network_table[i]->interface == iface)) {
3122 hso_net = dev2net(network_table[i]);
3123 if (hso_net->flags & IFF_UP) {
3124 /* First transmit any lingering data,
3125 then restart the device. */
3126 if (hso_net->skb_tx_buf) {
3127 dev_dbg(&iface->dev,
3129 " lingering data\n");
3130 hso_net_start_xmit(hso_net->skb_tx_buf,
3132 hso_net->skb_tx_buf = NULL;
3134 result = hso_start_net_device(network_table[i]);
3145 static void reset_device(struct work_struct *data)
3147 struct hso_device *hso_dev =
3148 container_of(data, struct hso_device, reset_device);
3149 struct usb_device *usb = hso_dev->usb;
3152 if (hso_dev->usb_gone) {
3153 D1("No reset during disconnect\n");
3155 result = usb_lock_device_for_reset(usb, hso_dev->interface);
3157 D1("unable to lock device for reset: %d\n", result);
3159 usb_reset_device(usb);
3160 usb_unlock_device(usb);
3165 static void hso_serial_ref_free(struct kref *ref)
3167 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3169 hso_free_serial_device(hso_dev);
3172 static void hso_free_interface(struct usb_interface *interface)
3174 struct hso_serial *hso_dev;
3175 struct tty_struct *tty;
3178 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3179 if (serial_table[i] &&
3180 (serial_table[i]->interface == interface)) {
3181 hso_dev = dev2ser(serial_table[i]);
3182 spin_lock_irq(&hso_dev->serial_lock);
3183 tty = tty_kref_get(hso_dev->tty);
3184 spin_unlock_irq(&hso_dev->serial_lock);
3187 mutex_lock(&hso_dev->parent->mutex);
3189 hso_dev->parent->usb_gone = 1;
3190 mutex_unlock(&hso_dev->parent->mutex);
3191 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3195 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3196 if (network_table[i] &&
3197 (network_table[i]->interface == interface)) {
3198 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3199 /* hso_stop_net_device doesn't stop the net queue since
3200 * traffic needs to start it again when suspended */
3201 netif_stop_queue(dev2net(network_table[i])->net);
3202 hso_stop_net_device(network_table[i]);
3203 cancel_work_sync(&network_table[i]->async_put_intf);
3204 cancel_work_sync(&network_table[i]->async_get_intf);
3206 rfkill_unregister(rfk);
3207 rfkill_destroy(rfk);
3209 hso_free_net_device(network_table[i]);
3214 /* Helper functions */
3216 /* Get the endpoint ! */
3217 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3221 struct usb_host_interface *iface = intf->cur_altsetting;
3222 struct usb_endpoint_descriptor *endp;
3224 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3225 endp = &iface->endpoint[i].desc;
3226 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3227 (usb_endpoint_type(endp) == type))
3234 /* Get the byte that describes which ports are enabled */
3235 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3238 struct usb_host_interface *iface = intf->cur_altsetting;
3240 if (iface->extralen == 3) {
3241 *ports = iface->extra[2];
3245 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3246 if (iface->endpoint[i].extralen == 3) {
3247 *ports = iface->endpoint[i].extra[2];
3255 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3256 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3257 struct usb_device *usb, gfp_t gfp)
3261 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3263 shared_int->intr_endp->bEndpointAddress & 0x7F),
3264 shared_int->shared_intr_buf,
3266 intr_callback, shared_int,
3267 shared_int->intr_endp->bInterval);
3269 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3271 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3277 /* operations setup of the serial interface */
3278 static const struct tty_operations hso_serial_ops = {
3279 .open = hso_serial_open,
3280 .close = hso_serial_close,
3281 .write = hso_serial_write,
3282 .write_room = hso_serial_write_room,
3283 .ioctl = hso_serial_ioctl,
3284 .set_termios = hso_serial_set_termios,
3285 .chars_in_buffer = hso_serial_chars_in_buffer,
3286 .tiocmget = hso_serial_tiocmget,
3287 .tiocmset = hso_serial_tiocmset,
3288 .get_icount = hso_get_count,
3289 .unthrottle = hso_unthrottle
3292 static struct usb_driver hso_driver = {
3293 .name = driver_name,
3295 .disconnect = hso_disconnect,
3296 .id_table = hso_ids,
3297 .suspend = hso_suspend,
3298 .resume = hso_resume,
3299 .reset_resume = hso_resume,
3300 .supports_autosuspend = 1,
3303 static int __init hso_init(void)
3308 /* put it in the log */
3309 printk(KERN_INFO "hso: %s\n", version);
3311 /* Initialise the serial table semaphore and table */
3312 spin_lock_init(&serial_table_lock);
3313 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3314 serial_table[i] = NULL;
3316 /* allocate our driver using the proper amount of supported minors */
3317 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3321 /* fill in all needed values */
3322 tty_drv->magic = TTY_DRIVER_MAGIC;
3323 tty_drv->owner = THIS_MODULE;
3324 tty_drv->driver_name = driver_name;
3325 tty_drv->name = tty_filename;
3327 /* if major number is provided as parameter, use that one */
3329 tty_drv->major = tty_major;
3331 tty_drv->minor_start = 0;
3332 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3333 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3334 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3335 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3336 tty_drv->init_termios = tty_std_termios;
3337 hso_init_termios(&tty_drv->init_termios);
3338 tty_set_operations(tty_drv, &hso_serial_ops);
3340 /* register the tty driver */
3341 result = tty_register_driver(tty_drv);
3343 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3348 /* register this module as an usb driver */
3349 result = usb_register(&hso_driver);
3351 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3353 /* cleanup serial interface */
3354 tty_unregister_driver(tty_drv);
3362 static void __exit hso_exit(void)
3364 printk(KERN_INFO "hso: unloaded\n");
3366 tty_unregister_driver(tty_drv);
3367 /* deregister the usb driver */
3368 usb_deregister(&hso_driver);
3371 /* Module definitions */
3372 module_init(hso_init);
3373 module_exit(hso_exit);
3375 MODULE_AUTHOR(MOD_AUTHOR);
3376 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3377 MODULE_LICENSE(MOD_LICENSE);
3379 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3380 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3381 module_param(debug, int, S_IRUGO | S_IWUSR);
3383 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3384 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3385 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3387 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3388 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3389 module_param(disable_net, int, S_IRUGO | S_IWUSR);