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/tty.h>
62 #include <linux/tty_driver.h>
63 #include <linux/tty_flip.h>
64 #include <linux/kmod.h>
65 #include <linux/rfkill.h>
67 #include <linux/uaccess.h>
68 #include <linux/usb/cdc.h>
70 #include <asm/byteorder.h>
71 #include <linux/serial_core.h>
72 #include <linux/serial.h>
75 #define MOD_AUTHOR "Option Wireless"
76 #define MOD_DESCRIPTION "USB High Speed Option driver"
77 #define MOD_LICENSE "GPL"
79 #define HSO_MAX_NET_DEVICES 10
80 #define HSO__MAX_MTU 2048
81 #define DEFAULT_MTU 1500
82 #define DEFAULT_MRU 1500
84 #define CTRL_URB_RX_SIZE 1024
85 #define CTRL_URB_TX_SIZE 64
87 #define BULK_URB_RX_SIZE 4096
88 #define BULK_URB_TX_SIZE 8192
90 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
91 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
92 #define MUX_BULK_RX_BUF_COUNT 4
93 #define USB_TYPE_OPTION_VENDOR 0x20
95 /* These definitions are used with the struct hso_net flags element */
96 /* - use *_bit operations on it. (bit indices not values.) */
97 #define HSO_NET_RUNNING 0
99 #define HSO_NET_TX_TIMEOUT (HZ*10)
101 #define HSO_SERIAL_MAGIC 0x48534f31
103 /* Number of ttys to handle */
104 #define HSO_SERIAL_TTY_MINORS 256
106 #define MAX_RX_URBS 2
108 /*****************************************************************************/
109 /* Debugging functions */
110 /*****************************************************************************/
111 #define D__(lvl_, fmt, arg...) \
113 printk(lvl_ "[%d:%s]: " fmt "\n", \
114 __LINE__, __func__, ## arg); \
117 #define D_(lvl, args...) \
120 D__(KERN_INFO, args); \
123 #define D1(args...) D_(0x01, ##args)
124 #define D2(args...) D_(0x02, ##args)
125 #define D3(args...) D_(0x04, ##args)
126 #define D4(args...) D_(0x08, ##args)
127 #define D5(args...) D_(0x10, ##args)
129 /*****************************************************************************/
131 /*****************************************************************************/
132 enum pkt_parse_state {
138 /*****************************************************************************/
140 /*****************************************************************************/
142 struct hso_shared_int {
143 struct usb_endpoint_descriptor *intr_endp;
144 void *shared_intr_buf;
145 struct urb *shared_intr_urb;
146 struct usb_device *usb;
149 struct mutex shared_int_lock;
153 struct hso_device *parent;
154 struct net_device *net;
155 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;
278 struct usb_device *usb;
279 struct usb_interface *interface;
286 /* Type of interface */
287 #define HSO_INTF_MASK 0xFF00
288 #define HSO_INTF_MUX 0x0100
289 #define HSO_INTF_BULK 0x0200
292 #define HSO_PORT_MASK 0xFF
293 #define HSO_PORT_NO_PORT 0x0
294 #define HSO_PORT_CONTROL 0x1
295 #define HSO_PORT_APP 0x2
296 #define HSO_PORT_GPS 0x3
297 #define HSO_PORT_PCSC 0x4
298 #define HSO_PORT_APP2 0x5
299 #define HSO_PORT_GPS_CONTROL 0x6
300 #define HSO_PORT_MSD 0x7
301 #define HSO_PORT_VOICE 0x8
302 #define HSO_PORT_DIAG2 0x9
303 #define HSO_PORT_DIAG 0x10
304 #define HSO_PORT_MODEM 0x11
305 #define HSO_PORT_NETWORK 0x12
307 /* Additional device info */
308 #define HSO_INFO_MASK 0xFF000000
309 #define HSO_INFO_CRC_BUG 0x01000000
311 /*****************************************************************************/
313 /*****************************************************************************/
314 /* Serial driver functions */
315 static int hso_serial_tiocmset(struct tty_struct *tty,
316 unsigned int set, unsigned int clear);
317 static void ctrl_callback(struct urb *urb);
318 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
319 static void hso_kick_transmit(struct hso_serial *serial);
320 /* Helper functions */
321 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
322 struct usb_device *usb, gfp_t gfp);
323 static void handle_usb_error(int status, const char *function,
324 struct hso_device *hso_dev);
325 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
327 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
328 static void hso_free_interface(struct usb_interface *intf);
329 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
330 static int hso_stop_serial_device(struct hso_device *hso_dev);
331 static int hso_start_net_device(struct hso_device *hso_dev);
332 static void hso_free_shared_int(struct hso_shared_int *shared_int);
333 static int hso_stop_net_device(struct hso_device *hso_dev);
334 static void hso_serial_ref_free(struct kref *ref);
335 static void hso_std_serial_read_bulk_callback(struct urb *urb);
336 static int hso_mux_serial_read(struct hso_serial *serial);
337 static void async_get_intf(struct work_struct *data);
338 static void async_put_intf(struct work_struct *data);
339 static int hso_put_activity(struct hso_device *hso_dev);
340 static int hso_get_activity(struct hso_device *hso_dev);
341 static void tiocmget_intr_callback(struct urb *urb);
342 /*****************************************************************************/
343 /* Helping functions */
344 /*****************************************************************************/
348 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
350 return hso_dev->port_data.dev_net;
353 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
355 return hso_dev->port_data.dev_serial;
358 /* Debugging functions */
360 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
363 static char name[255];
365 sprintf(name, "hso[%d:%s]", line_count, func_name);
366 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
369 #define DUMP(buf_, len_) \
370 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
372 #define DUMP1(buf_, len_) \
378 #define DUMP(buf_, len_)
379 #define DUMP1(buf_, len_)
382 /* module parameters */
384 static int tty_major;
385 static int disable_net;
388 static const char driver_name[] = "hso";
389 static const char tty_filename[] = "ttyHS";
390 static const char *version = __FILE__ ": " MOD_AUTHOR;
391 /* the usb driver itself (registered in hso_init) */
392 static struct usb_driver hso_driver;
393 /* serial structures */
394 static struct tty_driver *tty_drv;
395 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
396 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
397 static spinlock_t serial_table_lock;
399 static const s32 default_port_spec[] = {
400 HSO_INTF_MUX | HSO_PORT_NETWORK,
401 HSO_INTF_BULK | HSO_PORT_DIAG,
402 HSO_INTF_BULK | HSO_PORT_MODEM,
406 static const s32 icon321_port_spec[] = {
407 HSO_INTF_MUX | HSO_PORT_NETWORK,
408 HSO_INTF_BULK | HSO_PORT_DIAG2,
409 HSO_INTF_BULK | HSO_PORT_MODEM,
410 HSO_INTF_BULK | HSO_PORT_DIAG,
414 #define default_port_device(vendor, product) \
415 USB_DEVICE(vendor, product), \
416 .driver_info = (kernel_ulong_t)default_port_spec
418 #define icon321_port_device(vendor, product) \
419 USB_DEVICE(vendor, product), \
420 .driver_info = (kernel_ulong_t)icon321_port_spec
422 /* list of devices we support */
423 static const struct usb_device_id hso_ids[] = {
424 {default_port_device(0x0af0, 0x6711)},
425 {default_port_device(0x0af0, 0x6731)},
426 {default_port_device(0x0af0, 0x6751)},
427 {default_port_device(0x0af0, 0x6771)},
428 {default_port_device(0x0af0, 0x6791)},
429 {default_port_device(0x0af0, 0x6811)},
430 {default_port_device(0x0af0, 0x6911)},
431 {default_port_device(0x0af0, 0x6951)},
432 {default_port_device(0x0af0, 0x6971)},
433 {default_port_device(0x0af0, 0x7011)},
434 {default_port_device(0x0af0, 0x7031)},
435 {default_port_device(0x0af0, 0x7051)},
436 {default_port_device(0x0af0, 0x7071)},
437 {default_port_device(0x0af0, 0x7111)},
438 {default_port_device(0x0af0, 0x7211)},
439 {default_port_device(0x0af0, 0x7251)},
440 {default_port_device(0x0af0, 0x7271)},
441 {default_port_device(0x0af0, 0x7311)},
442 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
443 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
444 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
445 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
446 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
447 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
448 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
449 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
450 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
451 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
452 {USB_DEVICE(0x0af0, 0x7701)},
453 {USB_DEVICE(0x0af0, 0x7706)},
454 {USB_DEVICE(0x0af0, 0x7801)},
455 {USB_DEVICE(0x0af0, 0x7901)},
456 {USB_DEVICE(0x0af0, 0x7A01)},
457 {USB_DEVICE(0x0af0, 0x7A05)},
458 {USB_DEVICE(0x0af0, 0x8200)},
459 {USB_DEVICE(0x0af0, 0x8201)},
460 {USB_DEVICE(0x0af0, 0x8300)},
461 {USB_DEVICE(0x0af0, 0x8302)},
462 {USB_DEVICE(0x0af0, 0x8304)},
463 {USB_DEVICE(0x0af0, 0x8400)},
464 {USB_DEVICE(0x0af0, 0x8600)},
465 {USB_DEVICE(0x0af0, 0x8800)},
466 {USB_DEVICE(0x0af0, 0x8900)},
467 {USB_DEVICE(0x0af0, 0x9000)},
468 {USB_DEVICE(0x0af0, 0x9200)}, /* Option GTM671WFS */
469 {USB_DEVICE(0x0af0, 0xd035)},
470 {USB_DEVICE(0x0af0, 0xd055)},
471 {USB_DEVICE(0x0af0, 0xd155)},
472 {USB_DEVICE(0x0af0, 0xd255)},
473 {USB_DEVICE(0x0af0, 0xd057)},
474 {USB_DEVICE(0x0af0, 0xd157)},
475 {USB_DEVICE(0x0af0, 0xd257)},
476 {USB_DEVICE(0x0af0, 0xd357)},
477 {USB_DEVICE(0x0af0, 0xd058)},
478 {USB_DEVICE(0x0af0, 0xc100)},
481 MODULE_DEVICE_TABLE(usb, hso_ids);
483 /* Sysfs attribute */
484 static ssize_t hso_sysfs_show_porttype(struct device *dev,
485 struct device_attribute *attr,
488 struct hso_device *hso_dev = dev_get_drvdata(dev);
494 switch (hso_dev->port_spec & HSO_PORT_MASK) {
495 case HSO_PORT_CONTROL:
496 port_name = "Control";
499 port_name = "Application";
502 port_name = "Application2";
507 case HSO_PORT_GPS_CONTROL:
508 port_name = "GPS Control";
514 port_name = "Diagnostic";
517 port_name = "Diagnostic2";
522 case HSO_PORT_NETWORK:
523 port_name = "Network";
526 port_name = "Unknown";
530 return sprintf(buf, "%s\n", port_name);
532 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
534 static struct attribute *hso_serial_dev_attrs[] = {
535 &dev_attr_hsotype.attr,
539 ATTRIBUTE_GROUPS(hso_serial_dev);
541 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
545 for (idx = 0; idx < serial->num_rx_urbs; idx++)
546 if (serial->rx_urb[idx] == urb)
548 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
552 /* converts mux value to a port spec value */
553 static u32 hso_mux_to_port(int mux)
559 result = HSO_PORT_CONTROL;
562 result = HSO_PORT_APP;
565 result = HSO_PORT_PCSC;
568 result = HSO_PORT_GPS;
571 result = HSO_PORT_APP2;
574 result = HSO_PORT_NO_PORT;
579 /* converts port spec value to a mux value */
580 static u32 hso_port_to_mux(int port)
584 switch (port & HSO_PORT_MASK) {
585 case HSO_PORT_CONTROL:
606 static struct hso_serial *get_serial_by_shared_int_and_type(
607 struct hso_shared_int *shared_int,
612 port = hso_mux_to_port(mux);
614 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
615 if (serial_table[i] &&
616 (dev2ser(serial_table[i])->shared_int == shared_int) &&
617 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
618 return dev2ser(serial_table[i]);
625 static struct hso_serial *get_serial_by_index(unsigned index)
627 struct hso_serial *serial = NULL;
630 spin_lock_irqsave(&serial_table_lock, flags);
631 if (serial_table[index])
632 serial = dev2ser(serial_table[index]);
633 spin_unlock_irqrestore(&serial_table_lock, flags);
638 static int get_free_serial_index(void)
643 spin_lock_irqsave(&serial_table_lock, flags);
644 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
645 if (serial_table[index] == NULL) {
646 spin_unlock_irqrestore(&serial_table_lock, flags);
650 spin_unlock_irqrestore(&serial_table_lock, flags);
652 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
656 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
660 spin_lock_irqsave(&serial_table_lock, flags);
662 serial_table[index] = serial->parent;
664 serial_table[index] = NULL;
665 spin_unlock_irqrestore(&serial_table_lock, flags);
668 static void handle_usb_error(int status, const char *function,
669 struct hso_device *hso_dev)
675 explanation = "no device";
678 explanation = "endpoint not enabled";
681 explanation = "endpoint stalled";
684 explanation = "not enough bandwidth";
687 explanation = "device disabled";
690 explanation = "device suspended";
696 explanation = "internal error";
702 explanation = "protocol error";
704 usb_queue_reset_device(hso_dev->interface);
707 explanation = "unknown status";
711 /* log a meaningful explanation of an USB status */
712 D1("%s: received USB status - %s (%d)", function, explanation, status);
715 /* Network interface functions */
717 /* called when net interface is brought up by ifconfig */
718 static int hso_net_open(struct net_device *net)
720 struct hso_net *odev = netdev_priv(net);
721 unsigned long flags = 0;
724 dev_err(&net->dev, "No net device !\n");
728 odev->skb_tx_buf = NULL;
730 /* setup environment */
731 spin_lock_irqsave(&odev->net_lock, flags);
732 odev->rx_parse_state = WAIT_IP;
733 odev->rx_buf_size = 0;
734 odev->rx_buf_missing = sizeof(struct iphdr);
735 spin_unlock_irqrestore(&odev->net_lock, flags);
737 /* We are up and running. */
738 set_bit(HSO_NET_RUNNING, &odev->flags);
739 hso_start_net_device(odev->parent);
741 /* Tell the kernel we are ready to start receiving from it */
742 netif_start_queue(net);
747 /* called when interface is brought down by ifconfig */
748 static int hso_net_close(struct net_device *net)
750 struct hso_net *odev = netdev_priv(net);
752 /* we don't need the queue anymore */
753 netif_stop_queue(net);
754 /* no longer running */
755 clear_bit(HSO_NET_RUNNING, &odev->flags);
757 hso_stop_net_device(odev->parent);
763 /* USB tells is xmit done, we should start the netqueue again */
764 static void write_bulk_callback(struct urb *urb)
766 struct hso_net *odev = urb->context;
767 int status = urb->status;
770 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
771 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
775 /* Do we still have a valid kernel network device? */
776 if (!netif_device_present(odev->net)) {
777 dev_err(&urb->dev->dev, "%s: net device not present\n",
782 /* log status, but don't act on it, we don't need to resubmit anything
785 handle_usb_error(status, __func__, odev->parent);
787 hso_put_activity(odev->parent);
789 /* Tell the network interface we are ready for another frame */
790 netif_wake_queue(odev->net);
793 /* called by kernel when we need to transmit a packet */
794 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
795 struct net_device *net)
797 struct hso_net *odev = netdev_priv(net);
800 /* Tell the kernel, "No more frames 'til we are done with this one." */
801 netif_stop_queue(net);
802 if (hso_get_activity(odev->parent) == -EAGAIN) {
803 odev->skb_tx_buf = skb;
808 DUMP1(skb->data, skb->len);
809 /* Copy it from kernel memory to OUR memory */
810 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
811 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
813 /* Fill in the URB for shipping it out. */
814 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
816 usb_sndbulkpipe(odev->parent->usb,
818 bEndpointAddress & 0x7F),
819 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
822 /* Deal with the Zero Length packet problem, I hope */
823 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
825 /* Send the URB on its merry way. */
826 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
828 dev_warn(&odev->parent->interface->dev,
829 "failed mux_bulk_tx_urb %d\n", result);
830 net->stats.tx_errors++;
831 netif_start_queue(net);
833 net->stats.tx_packets++;
834 net->stats.tx_bytes += skb->len;
841 static const struct ethtool_ops ops = {
842 .get_link = ethtool_op_get_link
845 /* called when a packet did not ack after watchdogtimeout */
846 static void hso_net_tx_timeout(struct net_device *net)
848 struct hso_net *odev = netdev_priv(net);
853 /* Tell syslog we are hosed. */
854 dev_warn(&net->dev, "Tx timed out.\n");
856 /* Tear the waiting frame off the list */
857 if (odev->mux_bulk_tx_urb &&
858 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
859 usb_unlink_urb(odev->mux_bulk_tx_urb);
861 /* Update statistics */
862 net->stats.tx_errors++;
865 /* make a real packet from the received USB buffer */
866 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
867 unsigned int count, unsigned char is_eop)
869 unsigned short temp_bytes;
870 unsigned short buffer_offset = 0;
871 unsigned short frame_len;
872 unsigned char *tmp_rx_buf;
875 D1("Rx %d bytes", count);
876 DUMP(ip_pkt, min(128, (int)count));
879 switch (odev->rx_parse_state) {
881 /* waiting for IP header. */
882 /* wanted bytes - size of ip header */
885 odev->rx_buf_missing) ? count : odev->
888 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
889 odev->rx_buf_size, ip_pkt + buffer_offset,
892 odev->rx_buf_size += temp_bytes;
893 buffer_offset += temp_bytes;
894 odev->rx_buf_missing -= temp_bytes;
897 if (!odev->rx_buf_missing) {
898 /* header is complete allocate an sk_buffer and
899 * continue to WAIT_DATA */
900 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
902 if ((frame_len > DEFAULT_MRU) ||
903 (frame_len < sizeof(struct iphdr))) {
904 dev_err(&odev->net->dev,
905 "Invalid frame (%d) length\n",
907 odev->rx_parse_state = WAIT_SYNC;
910 /* Allocate an sk_buff */
911 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
913 if (!odev->skb_rx_buf) {
914 /* We got no receive buffer. */
915 D1("could not allocate memory");
916 odev->rx_parse_state = WAIT_SYNC;
920 /* Copy what we got so far. make room for iphdr
923 skb_put(odev->skb_rx_buf,
924 sizeof(struct iphdr));
925 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
926 sizeof(struct iphdr));
929 odev->rx_buf_size = sizeof(struct iphdr);
931 /* Filip actually use .tot_len */
932 odev->rx_buf_missing =
933 frame_len - sizeof(struct iphdr);
934 odev->rx_parse_state = WAIT_DATA;
939 temp_bytes = (count < odev->rx_buf_missing)
940 ? count : odev->rx_buf_missing;
942 /* Copy the rest of the bytes that are left in the
943 * buffer into the waiting sk_buf. */
944 /* Make room for temp_bytes after tail. */
945 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
946 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
948 odev->rx_buf_missing -= temp_bytes;
950 buffer_offset += temp_bytes;
951 odev->rx_buf_size += temp_bytes;
952 if (!odev->rx_buf_missing) {
953 /* Packet is complete. Inject into stack. */
954 /* We have IP packet here */
955 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
956 skb_reset_mac_header(odev->skb_rx_buf);
958 /* Ship it off to the kernel */
959 netif_rx(odev->skb_rx_buf);
960 /* No longer our buffer. */
961 odev->skb_rx_buf = NULL;
963 /* update out statistics */
964 odev->net->stats.rx_packets++;
966 odev->net->stats.rx_bytes += odev->rx_buf_size;
968 odev->rx_buf_size = 0;
969 odev->rx_buf_missing = sizeof(struct iphdr);
970 odev->rx_parse_state = WAIT_IP;
985 /* Recovery mechanism for WAIT_SYNC state. */
987 if (odev->rx_parse_state == WAIT_SYNC) {
988 odev->rx_parse_state = WAIT_IP;
989 odev->rx_buf_size = 0;
990 odev->rx_buf_missing = sizeof(struct iphdr);
995 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size)
997 static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
998 u32 rest = urb->actual_length % le16_to_cpu(max_packet_size);
1000 if (((rest == 5) || (rest == 6)) &&
1001 !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4,
1003 urb->actual_length -= 4;
1007 /* Moving data from usb to kernel (in interrupt state) */
1008 static void read_bulk_callback(struct urb *urb)
1010 struct hso_net *odev = urb->context;
1011 struct net_device *net;
1013 int status = urb->status;
1015 /* is al ok? (Filip: Who's Al ?) */
1017 handle_usb_error(status, __func__, odev->parent);
1022 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1023 D1("BULK IN callback but driver is not active!");
1026 usb_mark_last_busy(urb->dev);
1030 if (!netif_device_present(net)) {
1031 /* Somebody killed our network interface... */
1035 if (odev->parent->port_spec & HSO_INFO_CRC_BUG)
1036 fix_crc_bug(urb, odev->in_endp->wMaxPacketSize);
1038 /* do we even have a packet? */
1039 if (urb->actual_length) {
1040 /* Handle the IP stream, add header and push it onto network
1041 * stack if the packet is complete. */
1042 spin_lock(&odev->net_lock);
1043 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1044 (urb->transfer_buffer_length >
1045 urb->actual_length) ? 1 : 0);
1046 spin_unlock(&odev->net_lock);
1049 /* We are done with this URB, resubmit it. Prep the USB to wait for
1050 * another frame. Reuse same as received. */
1051 usb_fill_bulk_urb(urb,
1053 usb_rcvbulkpipe(odev->parent->usb,
1055 bEndpointAddress & 0x7F),
1056 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1057 read_bulk_callback, odev);
1059 /* Give this to the USB subsystem so it can tell us when more data
1061 result = usb_submit_urb(urb, GFP_ATOMIC);
1063 dev_warn(&odev->parent->interface->dev,
1064 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1068 /* Serial driver functions */
1070 static void hso_init_termios(struct ktermios *termios)
1073 * The default requirements for this device are:
1076 ~(IGNBRK /* disable ignore break */
1077 | BRKINT /* disable break causes interrupt */
1078 | PARMRK /* disable mark parity errors */
1079 | ISTRIP /* disable clear high bit of input characters */
1080 | INLCR /* disable translate NL to CR */
1081 | IGNCR /* disable ignore CR */
1082 | ICRNL /* disable translate CR to NL */
1083 | IXON); /* disable enable XON/XOFF flow control */
1085 /* disable postprocess output characters */
1086 termios->c_oflag &= ~OPOST;
1089 ~(ECHO /* disable echo input characters */
1090 | ECHONL /* disable echo new line */
1091 | ICANON /* disable erase, kill, werase, and rprnt
1092 special characters */
1093 | ISIG /* disable interrupt, quit, and suspend special
1095 | IEXTEN); /* disable non-POSIX special characters */
1098 ~(CSIZE /* no size */
1099 | PARENB /* disable parity bit */
1100 | CBAUD /* clear current baud rate */
1101 | CBAUDEX); /* clear current buad rate */
1103 termios->c_cflag |= CS8; /* character size 8 bits */
1105 /* baud rate 115200 */
1106 tty_termios_encode_baud_rate(termios, 115200, 115200);
1109 static void _hso_serial_set_termios(struct tty_struct *tty,
1110 struct ktermios *old)
1112 struct hso_serial *serial = tty->driver_data;
1115 printk(KERN_ERR "%s: no tty structures", __func__);
1119 D4("port %d", serial->minor);
1122 * Fix up unsupported bits
1124 tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1126 tty->termios.c_cflag &=
1127 ~(CSIZE /* no size */
1128 | PARENB /* disable parity bit */
1129 | CBAUD /* clear current baud rate */
1130 | CBAUDEX); /* clear current buad rate */
1132 tty->termios.c_cflag |= CS8; /* character size 8 bits */
1134 /* baud rate 115200 */
1135 tty_encode_baud_rate(tty, 115200, 115200);
1138 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1141 /* We are done with this URB, resubmit it. Prep the USB to wait for
1143 usb_fill_bulk_urb(urb, serial->parent->usb,
1144 usb_rcvbulkpipe(serial->parent->usb,
1146 bEndpointAddress & 0x7F),
1147 urb->transfer_buffer, serial->rx_data_length,
1148 hso_std_serial_read_bulk_callback, serial);
1149 /* Give this to the USB subsystem so it can tell us when more data
1151 result = usb_submit_urb(urb, GFP_ATOMIC);
1153 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1161 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1164 struct urb *curr_urb;
1166 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1167 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1168 count = put_rxbuf_data(curr_urb, serial);
1172 serial->curr_rx_urb_idx++;
1173 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1174 serial->curr_rx_urb_idx = 0;
1175 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1180 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1185 urb = serial->rx_urb[0];
1186 if (serial->port.count > 0) {
1187 count = put_rxbuf_data(urb, serial);
1191 /* Re issue a read as long as we receive data. */
1193 if (count == 0 && ((urb->actual_length != 0) ||
1194 (serial->rx_state == RX_PENDING))) {
1195 serial->rx_state = RX_SENT;
1196 hso_mux_serial_read(serial);
1198 serial->rx_state = RX_IDLE;
1202 /* read callback for Diag and CS port */
1203 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1205 struct hso_serial *serial = urb->context;
1206 int status = urb->status;
1208 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1212 D1("serial == NULL");
1216 handle_usb_error(status, __func__, serial->parent);
1220 D1("Actual length = %d\n", urb->actual_length);
1221 DUMP1(urb->transfer_buffer, urb->actual_length);
1223 /* Anyone listening? */
1224 if (serial->port.count == 0)
1227 if (serial->parent->port_spec & HSO_INFO_CRC_BUG)
1228 fix_crc_bug(urb, serial->in_endp->wMaxPacketSize);
1229 /* Valid data, handle RX data */
1230 spin_lock(&serial->serial_lock);
1231 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1232 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1233 spin_unlock(&serial->serial_lock);
1237 * This needs to be a tasklet otherwise we will
1238 * end up recursively calling this function.
1240 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1242 unsigned long flags;
1244 spin_lock_irqsave(&serial->serial_lock, flags);
1245 if ((serial->parent->port_spec & HSO_INTF_MUX))
1246 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1248 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1249 spin_unlock_irqrestore(&serial->serial_lock, flags);
1252 static void hso_unthrottle(struct tty_struct *tty)
1254 struct hso_serial *serial = tty->driver_data;
1256 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1259 /* open the requested serial port */
1260 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1262 struct hso_serial *serial = get_serial_by_index(tty->index);
1266 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1268 tty->driver_data = NULL;
1269 D1("Failed to open port");
1273 mutex_lock(&serial->parent->mutex);
1274 result = usb_autopm_get_interface(serial->parent->interface);
1278 D1("Opening %d", serial->minor);
1281 tty->driver_data = serial;
1282 tty_port_tty_set(&serial->port, tty);
1284 /* check for port already opened, if not set the termios */
1285 serial->port.count++;
1286 if (serial->port.count == 1) {
1287 serial->rx_state = RX_IDLE;
1288 /* Force default termio settings */
1289 _hso_serial_set_termios(tty, NULL);
1290 tasklet_init(&serial->unthrottle_tasklet,
1291 (void (*)(unsigned long))hso_unthrottle_tasklet,
1292 (unsigned long)serial);
1293 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1295 hso_stop_serial_device(serial->parent);
1296 serial->port.count--;
1298 kref_get(&serial->parent->ref);
1301 D1("Port was already open");
1304 usb_autopm_put_interface(serial->parent->interface);
1308 hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0);
1310 mutex_unlock(&serial->parent->mutex);
1314 /* close the requested serial port */
1315 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1317 struct hso_serial *serial = tty->driver_data;
1320 D1("Closing serial port");
1322 /* Open failed, no close cleanup required */
1326 mutex_lock(&serial->parent->mutex);
1327 usb_gone = serial->parent->usb_gone;
1330 usb_autopm_get_interface(serial->parent->interface);
1332 /* reset the rts and dtr */
1333 /* do the actual close */
1334 serial->port.count--;
1336 if (serial->port.count <= 0) {
1337 serial->port.count = 0;
1338 tty_port_tty_set(&serial->port, NULL);
1340 hso_stop_serial_device(serial->parent);
1341 tasklet_kill(&serial->unthrottle_tasklet);
1345 usb_autopm_put_interface(serial->parent->interface);
1347 mutex_unlock(&serial->parent->mutex);
1350 /* close the requested serial port */
1351 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1354 struct hso_serial *serial = tty->driver_data;
1355 int space, tx_bytes;
1356 unsigned long flags;
1359 if (serial == NULL) {
1360 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1364 spin_lock_irqsave(&serial->serial_lock, flags);
1366 space = serial->tx_data_length - serial->tx_buffer_count;
1367 tx_bytes = (count < space) ? count : space;
1372 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1373 serial->tx_buffer_count += tx_bytes;
1376 spin_unlock_irqrestore(&serial->serial_lock, flags);
1378 hso_kick_transmit(serial);
1383 /* how much room is there for writing */
1384 static int hso_serial_write_room(struct tty_struct *tty)
1386 struct hso_serial *serial = tty->driver_data;
1388 unsigned long flags;
1390 spin_lock_irqsave(&serial->serial_lock, flags);
1391 room = serial->tx_data_length - serial->tx_buffer_count;
1392 spin_unlock_irqrestore(&serial->serial_lock, flags);
1394 /* return free room */
1398 static void hso_serial_cleanup(struct tty_struct *tty)
1400 struct hso_serial *serial = tty->driver_data;
1405 kref_put(&serial->parent->ref, hso_serial_ref_free);
1408 /* setup the term */
1409 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1411 struct hso_serial *serial = tty->driver_data;
1412 unsigned long flags;
1415 D5("Termios called with: cflags new[%d] - old[%d]",
1416 tty->termios.c_cflag, old->c_cflag);
1418 /* the actual setup */
1419 spin_lock_irqsave(&serial->serial_lock, flags);
1420 if (serial->port.count)
1421 _hso_serial_set_termios(tty, old);
1423 tty->termios = *old;
1424 spin_unlock_irqrestore(&serial->serial_lock, flags);
1429 /* how many characters in the buffer */
1430 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1432 struct hso_serial *serial = tty->driver_data;
1434 unsigned long flags;
1440 spin_lock_irqsave(&serial->serial_lock, flags);
1441 chars = serial->tx_buffer_count;
1442 spin_unlock_irqrestore(&serial->serial_lock, flags);
1446 static int tiocmget_submit_urb(struct hso_serial *serial,
1447 struct hso_tiocmget *tiocmget,
1448 struct usb_device *usb)
1452 if (serial->parent->usb_gone)
1454 usb_fill_int_urb(tiocmget->urb, usb,
1457 bEndpointAddress & 0x7F),
1458 &tiocmget->serial_state_notification,
1459 sizeof(struct hso_serial_state_notification),
1460 tiocmget_intr_callback, serial,
1461 tiocmget->endp->bInterval);
1462 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1464 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1471 static void tiocmget_intr_callback(struct urb *urb)
1473 struct hso_serial *serial = urb->context;
1474 struct hso_tiocmget *tiocmget;
1475 int status = urb->status;
1476 u16 UART_state_bitmap, prev_UART_state_bitmap;
1477 struct uart_icount *icount;
1478 struct hso_serial_state_notification *serial_state_notification;
1479 struct usb_device *usb;
1480 struct usb_interface *interface;
1487 handle_usb_error(status, __func__, serial->parent);
1491 /* tiocmget is only supported on HSO_PORT_MODEM */
1492 tiocmget = serial->tiocmget;
1495 BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1497 usb = serial->parent->usb;
1498 interface = serial->parent->interface;
1500 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1502 /* wIndex should be the USB interface number of the port to which the
1503 * notification applies, which should always be the Modem port.
1505 serial_state_notification = &tiocmget->serial_state_notification;
1506 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1507 serial_state_notification->bNotification != B_NOTIFICATION ||
1508 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1509 le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1510 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1512 "hso received invalid serial state notification\n");
1513 DUMP(serial_state_notification,
1514 sizeof(struct hso_serial_state_notification));
1517 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1519 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1520 icount = &tiocmget->icount;
1521 spin_lock(&serial->serial_lock);
1522 if ((UART_state_bitmap & B_OVERRUN) !=
1523 (prev_UART_state_bitmap & B_OVERRUN))
1525 if ((UART_state_bitmap & B_PARITY) !=
1526 (prev_UART_state_bitmap & B_PARITY))
1528 if ((UART_state_bitmap & B_FRAMING) !=
1529 (prev_UART_state_bitmap & B_FRAMING))
1531 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1532 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1534 if ((UART_state_bitmap & B_BREAK) !=
1535 (prev_UART_state_bitmap & B_BREAK))
1537 if ((UART_state_bitmap & B_TX_CARRIER) !=
1538 (prev_UART_state_bitmap & B_TX_CARRIER))
1540 if ((UART_state_bitmap & B_RX_CARRIER) !=
1541 (prev_UART_state_bitmap & B_RX_CARRIER))
1543 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1544 spin_unlock(&serial->serial_lock);
1545 tiocmget->intr_completed = 1;
1546 wake_up_interruptible(&tiocmget->waitq);
1548 memset(serial_state_notification, 0,
1549 sizeof(struct hso_serial_state_notification));
1550 tiocmget_submit_urb(serial,
1552 serial->parent->usb);
1556 * next few functions largely stolen from drivers/serial/serial_core.c
1558 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1559 * - mask passed in arg for lines of interest
1560 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1561 * Caller should use TIOCGICOUNT to see which one it was
1564 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1566 DECLARE_WAITQUEUE(wait, current);
1567 struct uart_icount cprev, cnow;
1568 struct hso_tiocmget *tiocmget;
1571 tiocmget = serial->tiocmget;
1575 * note the counters on entry
1577 spin_lock_irq(&serial->serial_lock);
1578 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1579 spin_unlock_irq(&serial->serial_lock);
1580 add_wait_queue(&tiocmget->waitq, &wait);
1582 spin_lock_irq(&serial->serial_lock);
1583 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1584 spin_unlock_irq(&serial->serial_lock);
1585 set_current_state(TASK_INTERRUPTIBLE);
1586 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1587 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1588 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1593 /* see if a signal did it */
1594 if (signal_pending(current)) {
1600 __set_current_state(TASK_RUNNING);
1601 remove_wait_queue(&tiocmget->waitq, &wait);
1607 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1608 * Return: write counters to the user passed counter struct
1609 * NB: both 1->0 and 0->1 transitions are counted except for
1610 * RI where only 0->1 is counted.
1612 static int hso_get_count(struct tty_struct *tty,
1613 struct serial_icounter_struct *icount)
1615 struct uart_icount cnow;
1616 struct hso_serial *serial = tty->driver_data;
1617 struct hso_tiocmget *tiocmget = serial->tiocmget;
1619 memset(icount, 0, sizeof(struct serial_icounter_struct));
1623 spin_lock_irq(&serial->serial_lock);
1624 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1625 spin_unlock_irq(&serial->serial_lock);
1627 icount->cts = cnow.cts;
1628 icount->dsr = cnow.dsr;
1629 icount->rng = cnow.rng;
1630 icount->dcd = cnow.dcd;
1631 icount->rx = cnow.rx;
1632 icount->tx = cnow.tx;
1633 icount->frame = cnow.frame;
1634 icount->overrun = cnow.overrun;
1635 icount->parity = cnow.parity;
1636 icount->brk = cnow.brk;
1637 icount->buf_overrun = cnow.buf_overrun;
1643 static int hso_serial_tiocmget(struct tty_struct *tty)
1646 struct hso_serial *serial = tty->driver_data;
1647 struct hso_tiocmget *tiocmget;
1648 u16 UART_state_bitmap;
1652 D1("no tty structures");
1655 spin_lock_irq(&serial->serial_lock);
1656 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1657 ((serial->dtr_state) ? TIOCM_DTR : 0);
1658 tiocmget = serial->tiocmget;
1661 UART_state_bitmap = le16_to_cpu(
1662 tiocmget->prev_UART_state_bitmap);
1663 if (UART_state_bitmap & B_RING_SIGNAL)
1664 retval |= TIOCM_RNG;
1665 if (UART_state_bitmap & B_RX_CARRIER)
1667 if (UART_state_bitmap & B_TX_CARRIER)
1668 retval |= TIOCM_DSR;
1670 spin_unlock_irq(&serial->serial_lock);
1674 static int hso_serial_tiocmset(struct tty_struct *tty,
1675 unsigned int set, unsigned int clear)
1678 unsigned long flags;
1680 struct hso_serial *serial = tty->driver_data;
1681 struct usb_interface *interface;
1685 D1("no tty structures");
1689 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1692 interface = serial->parent->interface;
1693 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1695 spin_lock_irqsave(&serial->serial_lock, flags);
1696 if (set & TIOCM_RTS)
1697 serial->rts_state = 1;
1698 if (set & TIOCM_DTR)
1699 serial->dtr_state = 1;
1701 if (clear & TIOCM_RTS)
1702 serial->rts_state = 0;
1703 if (clear & TIOCM_DTR)
1704 serial->dtr_state = 0;
1706 if (serial->dtr_state)
1708 if (serial->rts_state)
1711 spin_unlock_irqrestore(&serial->serial_lock, flags);
1713 return usb_control_msg(serial->parent->usb,
1714 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1715 0x21, val, if_num, NULL, 0,
1716 USB_CTRL_SET_TIMEOUT);
1719 static int hso_serial_ioctl(struct tty_struct *tty,
1720 unsigned int cmd, unsigned long arg)
1722 struct hso_serial *serial = tty->driver_data;
1724 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1730 ret = hso_wait_modem_status(serial, arg);
1740 /* starts a transmit */
1741 static void hso_kick_transmit(struct hso_serial *serial)
1744 unsigned long flags;
1747 spin_lock_irqsave(&serial->serial_lock, flags);
1748 if (!serial->tx_buffer_count)
1751 if (serial->tx_urb_used)
1754 /* Wakeup USB interface if necessary */
1755 if (hso_get_activity(serial->parent) == -EAGAIN)
1758 /* Switch pointers around to avoid memcpy */
1759 temp = serial->tx_buffer;
1760 serial->tx_buffer = serial->tx_data;
1761 serial->tx_data = temp;
1762 serial->tx_data_count = serial->tx_buffer_count;
1763 serial->tx_buffer_count = 0;
1765 /* If temp is set, it means we switched buffers */
1766 if (temp && serial->write_data) {
1767 res = serial->write_data(serial);
1769 serial->tx_urb_used = 1;
1772 spin_unlock_irqrestore(&serial->serial_lock, flags);
1775 /* make a request (for reading and writing data to muxed serial port) */
1776 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1777 struct urb *ctrl_urb,
1778 struct usb_ctrlrequest *ctrl_req,
1779 u8 *ctrl_urb_data, u32 size)
1785 if (!serial || !ctrl_urb || !ctrl_req) {
1786 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1791 ctrl_req->wValue = 0;
1792 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1793 ctrl_req->wLength = cpu_to_le16(size);
1795 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1796 /* Reading command */
1797 ctrl_req->bRequestType = USB_DIR_IN |
1798 USB_TYPE_OPTION_VENDOR |
1799 USB_RECIP_INTERFACE;
1800 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1801 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1803 /* Writing command */
1804 ctrl_req->bRequestType = USB_DIR_OUT |
1805 USB_TYPE_OPTION_VENDOR |
1806 USB_RECIP_INTERFACE;
1807 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1808 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1811 D2("%s command (%02x) len: %d, port: %d",
1812 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1813 ctrl_req->bRequestType, ctrl_req->wLength, port);
1816 ctrl_urb->transfer_flags = 0;
1817 usb_fill_control_urb(ctrl_urb,
1818 serial->parent->usb,
1821 ctrl_urb_data, size, ctrl_callback, serial);
1822 /* Send it on merry way */
1823 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1825 dev_err(&ctrl_urb->dev->dev,
1826 "%s failed submit ctrl_urb %d type %d\n", __func__,
1835 /* called by intr_callback when read occurs */
1836 static int hso_mux_serial_read(struct hso_serial *serial)
1842 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1843 /* make the request */
1845 if (serial->num_rx_urbs != 1) {
1846 dev_err(&serial->parent->interface->dev,
1847 "ERROR: mux'd reads with multiple buffers "
1851 return mux_device_request(serial,
1852 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1853 serial->parent->port_spec & HSO_PORT_MASK,
1855 &serial->ctrl_req_rx,
1856 serial->rx_data[0], serial->rx_data_length);
1859 /* used for muxed serial port callback (muxed serial read) */
1860 static void intr_callback(struct urb *urb)
1862 struct hso_shared_int *shared_int = urb->context;
1863 struct hso_serial *serial;
1864 unsigned char *port_req;
1865 int status = urb->status;
1868 usb_mark_last_busy(urb->dev);
1876 handle_usb_error(status, __func__, NULL);
1879 D4("\n--- Got intr callback 0x%02X ---", status);
1882 port_req = urb->transfer_buffer;
1883 D4(" port_req = 0x%.2X\n", *port_req);
1884 /* loop over all muxed ports to find the one sending this */
1885 for (i = 0; i < 8; i++) {
1886 /* max 8 channels on MUX */
1887 if (*port_req & (1 << i)) {
1888 serial = get_serial_by_shared_int_and_type(shared_int,
1890 if (serial != NULL) {
1891 D1("Pending read interrupt on port %d\n", i);
1892 spin_lock(&serial->serial_lock);
1893 if (serial->rx_state == RX_IDLE &&
1894 serial->port.count > 0) {
1895 /* Setup and send a ctrl req read on
1897 if (!serial->rx_urb_filled[0]) {
1898 serial->rx_state = RX_SENT;
1899 hso_mux_serial_read(serial);
1901 serial->rx_state = RX_PENDING;
1903 D1("Already a read pending on "
1904 "port %d or port not open\n", i);
1906 spin_unlock(&serial->serial_lock);
1910 /* Resubmit interrupt urb */
1911 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1914 /* called for writing to muxed serial port */
1915 static int hso_mux_serial_write_data(struct hso_serial *serial)
1920 return mux_device_request(serial,
1921 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1922 serial->parent->port_spec & HSO_PORT_MASK,
1924 &serial->ctrl_req_tx,
1925 serial->tx_data, serial->tx_data_count);
1928 /* write callback for Diag and CS port */
1929 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1931 struct hso_serial *serial = urb->context;
1932 int status = urb->status;
1936 D1("serial == NULL");
1940 spin_lock(&serial->serial_lock);
1941 serial->tx_urb_used = 0;
1942 spin_unlock(&serial->serial_lock);
1944 handle_usb_error(status, __func__, serial->parent);
1947 hso_put_activity(serial->parent);
1948 tty_port_tty_wakeup(&serial->port);
1949 hso_kick_transmit(serial);
1954 /* called for writing diag or CS serial port */
1955 static int hso_std_serial_write_data(struct hso_serial *serial)
1957 int count = serial->tx_data_count;
1960 usb_fill_bulk_urb(serial->tx_urb,
1961 serial->parent->usb,
1962 usb_sndbulkpipe(serial->parent->usb,
1964 bEndpointAddress & 0x7F),
1965 serial->tx_data, serial->tx_data_count,
1966 hso_std_serial_write_bulk_callback, serial);
1968 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1970 dev_warn(&serial->parent->usb->dev,
1971 "Failed to submit urb - res %d\n", result);
1978 /* callback after read or write on muxed serial port */
1979 static void ctrl_callback(struct urb *urb)
1981 struct hso_serial *serial = urb->context;
1982 struct usb_ctrlrequest *req;
1983 int status = urb->status;
1989 spin_lock(&serial->serial_lock);
1990 serial->tx_urb_used = 0;
1991 spin_unlock(&serial->serial_lock);
1993 handle_usb_error(status, __func__, serial->parent);
1998 req = (struct usb_ctrlrequest *)(urb->setup_packet);
1999 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2000 D4("Actual length of urb = %d\n", urb->actual_length);
2001 DUMP1(urb->transfer_buffer, urb->actual_length);
2003 if (req->bRequestType ==
2004 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2005 /* response to a read command */
2006 serial->rx_urb_filled[0] = 1;
2007 spin_lock(&serial->serial_lock);
2008 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2009 spin_unlock(&serial->serial_lock);
2011 hso_put_activity(serial->parent);
2012 tty_port_tty_wakeup(&serial->port);
2013 /* response to a write command */
2014 hso_kick_transmit(serial);
2018 /* handle RX data for serial port */
2019 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2021 struct tty_struct *tty;
2025 if (urb == NULL || serial == NULL) {
2026 D1("serial = NULL");
2030 tty = tty_port_tty_get(&serial->port);
2032 if (tty && tty_throttled(tty)) {
2037 /* Push data to tty */
2038 D1("data to push to tty");
2039 count = tty_buffer_request_room(&serial->port, urb->actual_length);
2040 if (count >= urb->actual_length) {
2041 tty_insert_flip_string(&serial->port, urb->transfer_buffer,
2042 urb->actual_length);
2043 tty_flip_buffer_push(&serial->port);
2045 dev_warn(&serial->parent->usb->dev,
2046 "dropping data, %d bytes lost\n", urb->actual_length);
2051 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2057 /* Base driver functions */
2059 static void hso_log_port(struct hso_device *hso_dev)
2064 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2065 case HSO_PORT_CONTROL:
2066 port_type = "Control";
2069 port_type = "Application";
2074 case HSO_PORT_GPS_CONTROL:
2075 port_type = "GPS control";
2078 port_type = "Application2";
2084 port_type = "Diagnostic";
2086 case HSO_PORT_DIAG2:
2087 port_type = "Diagnostic2";
2089 case HSO_PORT_MODEM:
2090 port_type = "Modem";
2092 case HSO_PORT_NETWORK:
2093 port_type = "Network";
2096 port_type = "Unknown";
2099 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2100 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2102 sprintf(port_dev, "/dev/%s%d", tty_filename,
2103 dev2ser(hso_dev)->minor);
2105 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2106 port_type, port_dev);
2109 static int hso_start_net_device(struct hso_device *hso_dev)
2112 struct hso_net *hso_net = dev2net(hso_dev);
2117 /* send URBs for all read buffers */
2118 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2120 /* Prep a receive URB */
2121 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2123 usb_rcvbulkpipe(hso_dev->usb,
2125 bEndpointAddress & 0x7F),
2126 hso_net->mux_bulk_rx_buf_pool[i],
2127 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2130 /* Put it out there so the device can send us stuff */
2131 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2134 dev_warn(&hso_dev->usb->dev,
2135 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2142 static int hso_stop_net_device(struct hso_device *hso_dev)
2145 struct hso_net *hso_net = dev2net(hso_dev);
2150 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2151 if (hso_net->mux_bulk_rx_urb_pool[i])
2152 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2155 if (hso_net->mux_bulk_tx_urb)
2156 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2161 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2164 struct hso_serial *serial = dev2ser(hso_dev);
2169 /* If it is not the MUX port fill in and submit a bulk urb (already
2170 * allocated in hso_serial_start) */
2171 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2172 for (i = 0; i < serial->num_rx_urbs; i++) {
2173 usb_fill_bulk_urb(serial->rx_urb[i],
2174 serial->parent->usb,
2175 usb_rcvbulkpipe(serial->parent->usb,
2180 serial->rx_data_length,
2181 hso_std_serial_read_bulk_callback,
2183 result = usb_submit_urb(serial->rx_urb[i], flags);
2185 dev_warn(&serial->parent->usb->dev,
2186 "Failed to submit urb - res %d\n",
2192 mutex_lock(&serial->shared_int->shared_int_lock);
2193 if (!serial->shared_int->use_count) {
2195 hso_mux_submit_intr_urb(serial->shared_int,
2196 hso_dev->usb, flags);
2198 serial->shared_int->use_count++;
2199 mutex_unlock(&serial->shared_int->shared_int_lock);
2201 if (serial->tiocmget)
2202 tiocmget_submit_urb(serial,
2204 serial->parent->usb);
2208 static int hso_stop_serial_device(struct hso_device *hso_dev)
2211 struct hso_serial *serial = dev2ser(hso_dev);
2212 struct hso_tiocmget *tiocmget;
2217 for (i = 0; i < serial->num_rx_urbs; i++) {
2218 if (serial->rx_urb[i]) {
2219 usb_kill_urb(serial->rx_urb[i]);
2220 serial->rx_urb_filled[i] = 0;
2223 serial->curr_rx_urb_idx = 0;
2226 usb_kill_urb(serial->tx_urb);
2228 if (serial->shared_int) {
2229 mutex_lock(&serial->shared_int->shared_int_lock);
2230 if (serial->shared_int->use_count &&
2231 (--serial->shared_int->use_count == 0)) {
2234 urb = serial->shared_int->shared_intr_urb;
2238 mutex_unlock(&serial->shared_int->shared_int_lock);
2240 tiocmget = serial->tiocmget;
2242 wake_up_interruptible(&tiocmget->waitq);
2243 usb_kill_urb(tiocmget->urb);
2249 static void hso_serial_tty_unregister(struct hso_serial *serial)
2251 tty_unregister_device(tty_drv, serial->minor);
2254 static void hso_serial_common_free(struct hso_serial *serial)
2258 for (i = 0; i < serial->num_rx_urbs; i++) {
2259 /* unlink and free RX URB */
2260 usb_free_urb(serial->rx_urb[i]);
2261 /* free the RX buffer */
2262 kfree(serial->rx_data[i]);
2265 /* unlink and free TX URB */
2266 usb_free_urb(serial->tx_urb);
2267 kfree(serial->tx_buffer);
2268 kfree(serial->tx_data);
2269 tty_port_destroy(&serial->port);
2272 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2273 int rx_size, int tx_size)
2279 tty_port_init(&serial->port);
2281 minor = get_free_serial_index();
2285 /* register our minor number */
2286 serial->parent->dev = tty_port_register_device_attr(&serial->port,
2287 tty_drv, minor, &serial->parent->interface->dev,
2288 serial->parent, hso_serial_dev_groups);
2289 dev = serial->parent->dev;
2291 /* fill in specific data for later use */
2292 serial->minor = minor;
2293 serial->magic = HSO_SERIAL_MAGIC;
2294 spin_lock_init(&serial->serial_lock);
2295 serial->num_rx_urbs = num_urbs;
2297 /* RX, allocate urb and initialize */
2299 /* prepare our RX buffer */
2300 serial->rx_data_length = rx_size;
2301 for (i = 0; i < serial->num_rx_urbs; i++) {
2302 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2303 if (!serial->rx_urb[i]) {
2304 dev_err(dev, "Could not allocate urb?\n");
2307 serial->rx_urb[i]->transfer_buffer = NULL;
2308 serial->rx_urb[i]->transfer_buffer_length = 0;
2309 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2311 if (!serial->rx_data[i])
2315 /* TX, allocate urb and initialize */
2316 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2317 if (!serial->tx_urb) {
2318 dev_err(dev, "Could not allocate urb?\n");
2321 serial->tx_urb->transfer_buffer = NULL;
2322 serial->tx_urb->transfer_buffer_length = 0;
2323 /* prepare our TX buffer */
2324 serial->tx_data_count = 0;
2325 serial->tx_buffer_count = 0;
2326 serial->tx_data_length = tx_size;
2327 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2328 if (!serial->tx_data)
2331 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2332 if (!serial->tx_buffer)
2337 hso_serial_tty_unregister(serial);
2338 hso_serial_common_free(serial);
2342 /* Creates a general hso device */
2343 static struct hso_device *hso_create_device(struct usb_interface *intf,
2346 struct hso_device *hso_dev;
2348 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2352 hso_dev->port_spec = port_spec;
2353 hso_dev->usb = interface_to_usbdev(intf);
2354 hso_dev->interface = intf;
2355 kref_init(&hso_dev->ref);
2356 mutex_init(&hso_dev->mutex);
2358 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2359 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2364 /* Removes a network device in the network device table */
2365 static int remove_net_device(struct hso_device *hso_dev)
2369 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2370 if (network_table[i] == hso_dev) {
2371 network_table[i] = NULL;
2375 if (i == HSO_MAX_NET_DEVICES)
2380 /* Frees our network device */
2381 static void hso_free_net_device(struct hso_device *hso_dev)
2384 struct hso_net *hso_net = dev2net(hso_dev);
2389 remove_net_device(hso_net->parent);
2392 unregister_netdev(hso_net->net);
2395 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2396 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2397 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2398 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2400 usb_free_urb(hso_net->mux_bulk_tx_urb);
2401 kfree(hso_net->mux_bulk_tx_buf);
2402 hso_net->mux_bulk_tx_buf = NULL;
2405 free_netdev(hso_net->net);
2410 static const struct net_device_ops hso_netdev_ops = {
2411 .ndo_open = hso_net_open,
2412 .ndo_stop = hso_net_close,
2413 .ndo_start_xmit = hso_net_start_xmit,
2414 .ndo_tx_timeout = hso_net_tx_timeout,
2417 /* initialize the network interface */
2418 static void hso_net_init(struct net_device *net)
2420 struct hso_net *hso_net = netdev_priv(net);
2422 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2424 /* fill in the other fields */
2425 net->netdev_ops = &hso_netdev_ops;
2426 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2427 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2428 net->type = ARPHRD_NONE;
2429 net->mtu = DEFAULT_MTU - 14;
2430 net->tx_queue_len = 10;
2431 net->ethtool_ops = &ops;
2433 /* and initialize the semaphore */
2434 spin_lock_init(&hso_net->net_lock);
2437 /* Adds a network device in the network device table */
2438 static int add_net_device(struct hso_device *hso_dev)
2442 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2443 if (network_table[i] == NULL) {
2444 network_table[i] = hso_dev;
2448 if (i == HSO_MAX_NET_DEVICES)
2453 static int hso_rfkill_set_block(void *data, bool blocked)
2455 struct hso_device *hso_dev = data;
2456 int enabled = !blocked;
2459 mutex_lock(&hso_dev->mutex);
2460 if (hso_dev->usb_gone)
2463 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2464 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2465 USB_CTRL_SET_TIMEOUT);
2466 mutex_unlock(&hso_dev->mutex);
2470 static const struct rfkill_ops hso_rfkill_ops = {
2471 .set_block = hso_rfkill_set_block,
2474 /* Creates and sets up everything for rfkill */
2475 static void hso_create_rfkill(struct hso_device *hso_dev,
2476 struct usb_interface *interface)
2478 struct hso_net *hso_net = dev2net(hso_dev);
2479 struct device *dev = &hso_net->net->dev;
2480 static u32 rfkill_counter;
2482 snprintf(hso_net->name, sizeof(hso_net->name), "hso-%d",
2485 hso_net->rfkill = rfkill_alloc(hso_net->name,
2486 &interface_to_usbdev(interface)->dev,
2488 &hso_rfkill_ops, hso_dev);
2489 if (!hso_net->rfkill) {
2490 dev_err(dev, "%s - Out of memory\n", __func__);
2493 if (rfkill_register(hso_net->rfkill) < 0) {
2494 rfkill_destroy(hso_net->rfkill);
2495 hso_net->rfkill = NULL;
2496 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2501 static struct device_type hso_type = {
2505 /* Creates our network device */
2506 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2510 struct net_device *net;
2511 struct hso_net *hso_net;
2512 struct hso_device *hso_dev;
2514 hso_dev = hso_create_device(interface, port_spec);
2518 /* allocate our network device, then we can put in our private data */
2519 /* call hso_net_init to do the basic initialization */
2520 net = alloc_netdev(sizeof(struct hso_net), "hso%d", NET_NAME_UNKNOWN,
2523 dev_err(&interface->dev, "Unable to create ethernet device\n");
2527 hso_net = netdev_priv(net);
2529 hso_dev->port_data.dev_net = hso_net;
2531 hso_net->parent = hso_dev;
2533 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2535 if (!hso_net->in_endp) {
2536 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2539 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2541 if (!hso_net->out_endp) {
2542 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2545 SET_NETDEV_DEV(net, &interface->dev);
2546 SET_NETDEV_DEVTYPE(net, &hso_type);
2548 /* registering our net device */
2549 result = register_netdev(net);
2551 dev_err(&interface->dev, "Failed to register device\n");
2555 /* start allocating */
2556 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2557 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2558 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2559 dev_err(&interface->dev, "Could not allocate rx urb\n");
2562 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2564 if (!hso_net->mux_bulk_rx_buf_pool[i])
2567 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2568 if (!hso_net->mux_bulk_tx_urb) {
2569 dev_err(&interface->dev, "Could not allocate tx urb\n");
2572 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2573 if (!hso_net->mux_bulk_tx_buf)
2576 add_net_device(hso_dev);
2578 hso_log_port(hso_dev);
2580 hso_create_rfkill(hso_dev, interface);
2584 hso_free_net_device(hso_dev);
2588 static void hso_free_tiomget(struct hso_serial *serial)
2590 struct hso_tiocmget *tiocmget;
2593 tiocmget = serial->tiocmget;
2595 usb_free_urb(tiocmget->urb);
2596 tiocmget->urb = NULL;
2597 serial->tiocmget = NULL;
2602 /* Frees an AT channel ( goes for both mux and non-mux ) */
2603 static void hso_free_serial_device(struct hso_device *hso_dev)
2605 struct hso_serial *serial = dev2ser(hso_dev);
2610 hso_serial_common_free(serial);
2612 if (serial->shared_int) {
2613 mutex_lock(&serial->shared_int->shared_int_lock);
2614 if (--serial->shared_int->ref_count == 0)
2615 hso_free_shared_int(serial->shared_int);
2617 mutex_unlock(&serial->shared_int->shared_int_lock);
2619 hso_free_tiomget(serial);
2624 /* Creates a bulk AT channel */
2625 static struct hso_device *hso_create_bulk_serial_device(
2626 struct usb_interface *interface, int port)
2628 struct hso_device *hso_dev;
2629 struct hso_serial *serial;
2631 struct hso_tiocmget *tiocmget;
2633 hso_dev = hso_create_device(interface, port);
2637 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2641 serial->parent = hso_dev;
2642 hso_dev->port_data.dev_serial = serial;
2644 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2646 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2648 /* it isn't going to break our heart if serial->tiocmget
2649 * allocation fails don't bother checking this.
2651 if (serial->tiocmget) {
2652 tiocmget = serial->tiocmget;
2653 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2654 if (tiocmget->urb) {
2655 mutex_init(&tiocmget->mutex);
2656 init_waitqueue_head(&tiocmget->waitq);
2657 tiocmget->endp = hso_get_ep(
2659 USB_ENDPOINT_XFER_INT,
2662 hso_free_tiomget(serial);
2668 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2672 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2674 if (!serial->in_endp) {
2675 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2681 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2682 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2686 serial->write_data = hso_std_serial_write_data;
2688 /* and record this serial */
2689 set_serial_by_index(serial->minor, serial);
2691 /* setup the proc dirs and files if needed */
2692 hso_log_port(hso_dev);
2694 /* done, return it */
2698 hso_serial_tty_unregister(serial);
2699 hso_serial_common_free(serial);
2701 hso_free_tiomget(serial);
2707 /* Creates a multiplexed AT channel */
2709 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2711 struct hso_shared_int *mux)
2713 struct hso_device *hso_dev;
2714 struct hso_serial *serial;
2717 port_spec = HSO_INTF_MUX;
2718 port_spec &= ~HSO_PORT_MASK;
2720 port_spec |= hso_mux_to_port(port);
2721 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2724 hso_dev = hso_create_device(interface, port_spec);
2728 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2732 hso_dev->port_data.dev_serial = serial;
2733 serial->parent = hso_dev;
2735 if (hso_serial_common_create
2736 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2739 serial->tx_data_length--;
2740 serial->write_data = hso_mux_serial_write_data;
2742 serial->shared_int = mux;
2743 mutex_lock(&serial->shared_int->shared_int_lock);
2744 serial->shared_int->ref_count++;
2745 mutex_unlock(&serial->shared_int->shared_int_lock);
2747 /* and record this serial */
2748 set_serial_by_index(serial->minor, serial);
2750 /* setup the proc dirs and files if needed */
2751 hso_log_port(hso_dev);
2753 /* done, return it */
2758 tty_unregister_device(tty_drv, serial->minor);
2766 static void hso_free_shared_int(struct hso_shared_int *mux)
2768 usb_free_urb(mux->shared_intr_urb);
2769 kfree(mux->shared_intr_buf);
2770 mutex_unlock(&mux->shared_int_lock);
2775 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2777 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2782 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2784 if (!mux->intr_endp) {
2785 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2789 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2790 if (!mux->shared_intr_urb) {
2791 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2794 mux->shared_intr_buf =
2795 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2797 if (!mux->shared_intr_buf)
2800 mutex_init(&mux->shared_int_lock);
2805 kfree(mux->shared_intr_buf);
2806 usb_free_urb(mux->shared_intr_urb);
2811 /* Gets the port spec for a certain interface */
2812 static int hso_get_config_data(struct usb_interface *interface)
2814 struct usb_device *usbdev = interface_to_usbdev(interface);
2815 u8 *config_data = kmalloc(17, GFP_KERNEL);
2816 u32 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2821 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2822 0x86, 0xC0, 0, 0, config_data, 17,
2823 USB_CTRL_SET_TIMEOUT) != 0x11) {
2828 switch (config_data[if_num]) {
2833 result = HSO_PORT_DIAG;
2836 result = HSO_PORT_GPS;
2839 result = HSO_PORT_GPS_CONTROL;
2842 result = HSO_PORT_APP;
2845 result = HSO_PORT_APP2;
2848 result = HSO_PORT_CONTROL;
2851 result = HSO_PORT_NETWORK;
2854 result = HSO_PORT_MODEM;
2857 result = HSO_PORT_MSD;
2860 result = HSO_PORT_PCSC;
2863 result = HSO_PORT_VOICE;
2870 result |= HSO_INTF_BULK;
2872 if (config_data[16] & 0x1)
2873 result |= HSO_INFO_CRC_BUG;
2879 /* called once for each interface upon device insertion */
2880 static int hso_probe(struct usb_interface *interface,
2881 const struct usb_device_id *id)
2883 int mux, i, if_num, port_spec;
2884 unsigned char port_mask;
2885 struct hso_device *hso_dev = NULL;
2886 struct hso_shared_int *shared_int;
2887 struct hso_device *tmp_dev = NULL;
2889 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2890 dev_err(&interface->dev, "Not our interface\n");
2894 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2896 /* Get the interface/port specification from either driver_info or from
2897 * the device itself */
2898 if (id->driver_info)
2899 port_spec = ((u32 *)(id->driver_info))[if_num];
2901 port_spec = hso_get_config_data(interface);
2903 /* Check if we need to switch to alt interfaces prior to port
2905 if (interface->num_altsetting > 1)
2906 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2907 interface->needs_remote_wakeup = 1;
2909 /* Allocate new hso device(s) */
2910 switch (port_spec & HSO_INTF_MASK) {
2912 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2913 /* Create the network device */
2915 hso_dev = hso_create_net_device(interface,
2923 if (hso_get_mux_ports(interface, &port_mask))
2924 /* TODO: de-allocate everything */
2927 shared_int = hso_create_shared_int(interface);
2931 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2932 if (port_mask & i) {
2933 hso_dev = hso_create_mux_serial_device(
2934 interface, i, shared_int);
2945 /* It's a regular bulk interface */
2946 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2949 hso_create_net_device(interface, port_spec);
2952 hso_create_bulk_serial_device(interface, port_spec);
2961 /* save our data pointer in this device */
2962 usb_set_intfdata(interface, hso_dev);
2967 hso_free_interface(interface);
2971 /* device removed, cleaning up */
2972 static void hso_disconnect(struct usb_interface *interface)
2974 hso_free_interface(interface);
2976 /* remove reference of our private data */
2977 usb_set_intfdata(interface, NULL);
2980 static void async_get_intf(struct work_struct *data)
2982 struct hso_device *hso_dev =
2983 container_of(data, struct hso_device, async_get_intf);
2984 usb_autopm_get_interface(hso_dev->interface);
2987 static void async_put_intf(struct work_struct *data)
2989 struct hso_device *hso_dev =
2990 container_of(data, struct hso_device, async_put_intf);
2991 usb_autopm_put_interface(hso_dev->interface);
2994 static int hso_get_activity(struct hso_device *hso_dev)
2996 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
2997 if (!hso_dev->is_active) {
2998 hso_dev->is_active = 1;
2999 schedule_work(&hso_dev->async_get_intf);
3003 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3006 usb_mark_last_busy(hso_dev->usb);
3011 static int hso_put_activity(struct hso_device *hso_dev)
3013 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3014 if (hso_dev->is_active) {
3015 hso_dev->is_active = 0;
3016 schedule_work(&hso_dev->async_put_intf);
3020 hso_dev->is_active = 0;
3024 /* called by kernel when we need to suspend device */
3025 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3029 /* Stop all serial ports */
3030 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3031 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3032 result = hso_stop_serial_device(serial_table[i]);
3038 /* Stop all network ports */
3039 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3040 if (network_table[i] &&
3041 (network_table[i]->interface == iface)) {
3042 result = hso_stop_net_device(network_table[i]);
3052 /* called by kernel when we need to resume device */
3053 static int hso_resume(struct usb_interface *iface)
3056 struct hso_net *hso_net;
3058 /* Start all serial ports */
3059 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3060 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3061 if (dev2ser(serial_table[i])->port.count) {
3063 hso_start_serial_device(serial_table[i], GFP_NOIO);
3064 hso_kick_transmit(dev2ser(serial_table[i]));
3071 /* Start all network ports */
3072 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3073 if (network_table[i] &&
3074 (network_table[i]->interface == iface)) {
3075 hso_net = dev2net(network_table[i]);
3076 if (hso_net->flags & IFF_UP) {
3077 /* First transmit any lingering data,
3078 then restart the device. */
3079 if (hso_net->skb_tx_buf) {
3080 dev_dbg(&iface->dev,
3082 " lingering data\n");
3083 hso_net_start_xmit(hso_net->skb_tx_buf,
3085 hso_net->skb_tx_buf = NULL;
3087 result = hso_start_net_device(network_table[i]);
3098 static void hso_serial_ref_free(struct kref *ref)
3100 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3102 hso_free_serial_device(hso_dev);
3105 static void hso_free_interface(struct usb_interface *interface)
3107 struct hso_serial *serial;
3110 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3111 if (serial_table[i] &&
3112 (serial_table[i]->interface == interface)) {
3113 serial = dev2ser(serial_table[i]);
3114 tty_port_tty_hangup(&serial->port, false);
3115 mutex_lock(&serial->parent->mutex);
3116 serial->parent->usb_gone = 1;
3117 mutex_unlock(&serial->parent->mutex);
3118 cancel_work_sync(&serial_table[i]->async_put_intf);
3119 cancel_work_sync(&serial_table[i]->async_get_intf);
3120 hso_serial_tty_unregister(serial);
3121 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3122 set_serial_by_index(i, NULL);
3126 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3127 if (network_table[i] &&
3128 (network_table[i]->interface == interface)) {
3129 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3130 /* hso_stop_net_device doesn't stop the net queue since
3131 * traffic needs to start it again when suspended */
3132 netif_stop_queue(dev2net(network_table[i])->net);
3133 hso_stop_net_device(network_table[i]);
3134 cancel_work_sync(&network_table[i]->async_put_intf);
3135 cancel_work_sync(&network_table[i]->async_get_intf);
3137 rfkill_unregister(rfk);
3138 rfkill_destroy(rfk);
3140 hso_free_net_device(network_table[i]);
3145 /* Helper functions */
3147 /* Get the endpoint ! */
3148 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3152 struct usb_host_interface *iface = intf->cur_altsetting;
3153 struct usb_endpoint_descriptor *endp;
3155 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3156 endp = &iface->endpoint[i].desc;
3157 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3158 (usb_endpoint_type(endp) == type))
3165 /* Get the byte that describes which ports are enabled */
3166 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3169 struct usb_host_interface *iface = intf->cur_altsetting;
3171 if (iface->extralen == 3) {
3172 *ports = iface->extra[2];
3176 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3177 if (iface->endpoint[i].extralen == 3) {
3178 *ports = iface->endpoint[i].extra[2];
3186 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3187 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3188 struct usb_device *usb, gfp_t gfp)
3192 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3194 shared_int->intr_endp->bEndpointAddress & 0x7F),
3195 shared_int->shared_intr_buf,
3197 intr_callback, shared_int,
3198 shared_int->intr_endp->bInterval);
3200 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3202 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3208 /* operations setup of the serial interface */
3209 static const struct tty_operations hso_serial_ops = {
3210 .open = hso_serial_open,
3211 .close = hso_serial_close,
3212 .write = hso_serial_write,
3213 .write_room = hso_serial_write_room,
3214 .cleanup = hso_serial_cleanup,
3215 .ioctl = hso_serial_ioctl,
3216 .set_termios = hso_serial_set_termios,
3217 .chars_in_buffer = hso_serial_chars_in_buffer,
3218 .tiocmget = hso_serial_tiocmget,
3219 .tiocmset = hso_serial_tiocmset,
3220 .get_icount = hso_get_count,
3221 .unthrottle = hso_unthrottle
3224 static struct usb_driver hso_driver = {
3225 .name = driver_name,
3227 .disconnect = hso_disconnect,
3228 .id_table = hso_ids,
3229 .suspend = hso_suspend,
3230 .resume = hso_resume,
3231 .reset_resume = hso_resume,
3232 .supports_autosuspend = 1,
3233 .disable_hub_initiated_lpm = 1,
3236 static int __init hso_init(void)
3241 /* put it in the log */
3242 printk(KERN_INFO "hso: %s\n", version);
3244 /* Initialise the serial table semaphore and table */
3245 spin_lock_init(&serial_table_lock);
3246 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3247 serial_table[i] = NULL;
3249 /* allocate our driver using the proper amount of supported minors */
3250 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3254 /* fill in all needed values */
3255 tty_drv->driver_name = driver_name;
3256 tty_drv->name = tty_filename;
3258 /* if major number is provided as parameter, use that one */
3260 tty_drv->major = tty_major;
3262 tty_drv->minor_start = 0;
3263 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3264 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3265 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3266 tty_drv->init_termios = tty_std_termios;
3267 hso_init_termios(&tty_drv->init_termios);
3268 tty_set_operations(tty_drv, &hso_serial_ops);
3270 /* register the tty driver */
3271 result = tty_register_driver(tty_drv);
3273 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3278 /* register this module as an usb driver */
3279 result = usb_register(&hso_driver);
3281 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3289 tty_unregister_driver(tty_drv);
3291 put_tty_driver(tty_drv);
3295 static void __exit hso_exit(void)
3297 printk(KERN_INFO "hso: unloaded\n");
3299 tty_unregister_driver(tty_drv);
3300 put_tty_driver(tty_drv);
3301 /* deregister the usb driver */
3302 usb_deregister(&hso_driver);
3305 /* Module definitions */
3306 module_init(hso_init);
3307 module_exit(hso_exit);
3309 MODULE_AUTHOR(MOD_AUTHOR);
3310 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3311 MODULE_LICENSE(MOD_LICENSE);
3313 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3314 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3315 module_param(debug, int, S_IRUGO | S_IWUSR);
3317 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3318 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3319 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3321 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3322 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3323 module_param(disable_net, int, S_IRUGO | S_IWUSR);