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 obtain_minor(struct hso_serial *serial)
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 serial_table[index] = serial->parent;
647 serial->minor = index;
648 spin_unlock_irqrestore(&serial_table_lock, flags);
652 spin_unlock_irqrestore(&serial_table_lock, flags);
654 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
658 static void release_minor(struct hso_serial *serial)
662 spin_lock_irqsave(&serial_table_lock, flags);
663 serial_table[serial->minor] = NULL;
664 spin_unlock_irqrestore(&serial_table_lock, flags);
667 static void handle_usb_error(int status, const char *function,
668 struct hso_device *hso_dev)
674 explanation = "no device";
677 explanation = "endpoint not enabled";
680 explanation = "endpoint stalled";
683 explanation = "not enough bandwidth";
686 explanation = "device disabled";
689 explanation = "device suspended";
695 explanation = "internal error";
701 explanation = "protocol error";
703 usb_queue_reset_device(hso_dev->interface);
706 explanation = "unknown status";
710 /* log a meaningful explanation of an USB status */
711 D1("%s: received USB status - %s (%d)", function, explanation, status);
714 /* Network interface functions */
716 /* called when net interface is brought up by ifconfig */
717 static int hso_net_open(struct net_device *net)
719 struct hso_net *odev = netdev_priv(net);
720 unsigned long flags = 0;
723 dev_err(&net->dev, "No net device !\n");
727 odev->skb_tx_buf = NULL;
729 /* setup environment */
730 spin_lock_irqsave(&odev->net_lock, flags);
731 odev->rx_parse_state = WAIT_IP;
732 odev->rx_buf_size = 0;
733 odev->rx_buf_missing = sizeof(struct iphdr);
734 spin_unlock_irqrestore(&odev->net_lock, flags);
736 /* We are up and running. */
737 set_bit(HSO_NET_RUNNING, &odev->flags);
738 hso_start_net_device(odev->parent);
740 /* Tell the kernel we are ready to start receiving from it */
741 netif_start_queue(net);
746 /* called when interface is brought down by ifconfig */
747 static int hso_net_close(struct net_device *net)
749 struct hso_net *odev = netdev_priv(net);
751 /* we don't need the queue anymore */
752 netif_stop_queue(net);
753 /* no longer running */
754 clear_bit(HSO_NET_RUNNING, &odev->flags);
756 hso_stop_net_device(odev->parent);
762 /* USB tells is xmit done, we should start the netqueue again */
763 static void write_bulk_callback(struct urb *urb)
765 struct hso_net *odev = urb->context;
766 int status = urb->status;
769 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
770 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
774 /* Do we still have a valid kernel network device? */
775 if (!netif_device_present(odev->net)) {
776 dev_err(&urb->dev->dev, "%s: net device not present\n",
781 /* log status, but don't act on it, we don't need to resubmit anything
784 handle_usb_error(status, __func__, odev->parent);
786 hso_put_activity(odev->parent);
788 /* Tell the network interface we are ready for another frame */
789 netif_wake_queue(odev->net);
792 /* called by kernel when we need to transmit a packet */
793 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
794 struct net_device *net)
796 struct hso_net *odev = netdev_priv(net);
799 /* Tell the kernel, "No more frames 'til we are done with this one." */
800 netif_stop_queue(net);
801 if (hso_get_activity(odev->parent) == -EAGAIN) {
802 odev->skb_tx_buf = skb;
807 DUMP1(skb->data, skb->len);
808 /* Copy it from kernel memory to OUR memory */
809 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
810 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
812 /* Fill in the URB for shipping it out. */
813 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
815 usb_sndbulkpipe(odev->parent->usb,
817 bEndpointAddress & 0x7F),
818 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
821 /* Deal with the Zero Length packet problem, I hope */
822 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
824 /* Send the URB on its merry way. */
825 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
827 dev_warn(&odev->parent->interface->dev,
828 "failed mux_bulk_tx_urb %d\n", result);
829 net->stats.tx_errors++;
830 netif_start_queue(net);
832 net->stats.tx_packets++;
833 net->stats.tx_bytes += skb->len;
840 static const struct ethtool_ops ops = {
841 .get_link = ethtool_op_get_link
844 /* called when a packet did not ack after watchdogtimeout */
845 static void hso_net_tx_timeout(struct net_device *net)
847 struct hso_net *odev = netdev_priv(net);
852 /* Tell syslog we are hosed. */
853 dev_warn(&net->dev, "Tx timed out.\n");
855 /* Tear the waiting frame off the list */
856 if (odev->mux_bulk_tx_urb &&
857 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
858 usb_unlink_urb(odev->mux_bulk_tx_urb);
860 /* Update statistics */
861 net->stats.tx_errors++;
864 /* make a real packet from the received USB buffer */
865 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
866 unsigned int count, unsigned char is_eop)
868 unsigned short temp_bytes;
869 unsigned short buffer_offset = 0;
870 unsigned short frame_len;
871 unsigned char *tmp_rx_buf;
874 D1("Rx %d bytes", count);
875 DUMP(ip_pkt, min(128, (int)count));
878 switch (odev->rx_parse_state) {
880 /* waiting for IP header. */
881 /* wanted bytes - size of ip header */
884 odev->rx_buf_missing) ? count : odev->
887 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
888 odev->rx_buf_size, ip_pkt + buffer_offset,
891 odev->rx_buf_size += temp_bytes;
892 buffer_offset += temp_bytes;
893 odev->rx_buf_missing -= temp_bytes;
896 if (!odev->rx_buf_missing) {
897 /* header is complete allocate an sk_buffer and
898 * continue to WAIT_DATA */
899 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
901 if ((frame_len > DEFAULT_MRU) ||
902 (frame_len < sizeof(struct iphdr))) {
903 dev_err(&odev->net->dev,
904 "Invalid frame (%d) length\n",
906 odev->rx_parse_state = WAIT_SYNC;
909 /* Allocate an sk_buff */
910 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
912 if (!odev->skb_rx_buf) {
913 /* We got no receive buffer. */
914 D1("could not allocate memory");
915 odev->rx_parse_state = WAIT_SYNC;
919 /* Copy what we got so far. make room for iphdr
922 skb_put(odev->skb_rx_buf,
923 sizeof(struct iphdr));
924 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
925 sizeof(struct iphdr));
928 odev->rx_buf_size = sizeof(struct iphdr);
930 /* Filip actually use .tot_len */
931 odev->rx_buf_missing =
932 frame_len - sizeof(struct iphdr);
933 odev->rx_parse_state = WAIT_DATA;
938 temp_bytes = (count < odev->rx_buf_missing)
939 ? count : odev->rx_buf_missing;
941 /* Copy the rest of the bytes that are left in the
942 * buffer into the waiting sk_buf. */
943 /* Make room for temp_bytes after tail. */
944 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
945 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
947 odev->rx_buf_missing -= temp_bytes;
949 buffer_offset += temp_bytes;
950 odev->rx_buf_size += temp_bytes;
951 if (!odev->rx_buf_missing) {
952 /* Packet is complete. Inject into stack. */
953 /* We have IP packet here */
954 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
955 skb_reset_mac_header(odev->skb_rx_buf);
957 /* Ship it off to the kernel */
958 netif_rx(odev->skb_rx_buf);
959 /* No longer our buffer. */
960 odev->skb_rx_buf = NULL;
962 /* update out statistics */
963 odev->net->stats.rx_packets++;
965 odev->net->stats.rx_bytes += odev->rx_buf_size;
967 odev->rx_buf_size = 0;
968 odev->rx_buf_missing = sizeof(struct iphdr);
969 odev->rx_parse_state = WAIT_IP;
984 /* Recovery mechanism for WAIT_SYNC state. */
986 if (odev->rx_parse_state == WAIT_SYNC) {
987 odev->rx_parse_state = WAIT_IP;
988 odev->rx_buf_size = 0;
989 odev->rx_buf_missing = sizeof(struct iphdr);
994 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size)
996 static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
997 u32 rest = urb->actual_length % le16_to_cpu(max_packet_size);
999 if (((rest == 5) || (rest == 6)) &&
1000 !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4,
1002 urb->actual_length -= 4;
1006 /* Moving data from usb to kernel (in interrupt state) */
1007 static void read_bulk_callback(struct urb *urb)
1009 struct hso_net *odev = urb->context;
1010 struct net_device *net;
1012 int status = urb->status;
1014 /* is al ok? (Filip: Who's Al ?) */
1016 handle_usb_error(status, __func__, odev->parent);
1021 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1022 D1("BULK IN callback but driver is not active!");
1025 usb_mark_last_busy(urb->dev);
1029 if (!netif_device_present(net)) {
1030 /* Somebody killed our network interface... */
1034 if (odev->parent->port_spec & HSO_INFO_CRC_BUG)
1035 fix_crc_bug(urb, odev->in_endp->wMaxPacketSize);
1037 /* do we even have a packet? */
1038 if (urb->actual_length) {
1039 /* Handle the IP stream, add header and push it onto network
1040 * stack if the packet is complete. */
1041 spin_lock(&odev->net_lock);
1042 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1043 (urb->transfer_buffer_length >
1044 urb->actual_length) ? 1 : 0);
1045 spin_unlock(&odev->net_lock);
1048 /* We are done with this URB, resubmit it. Prep the USB to wait for
1049 * another frame. Reuse same as received. */
1050 usb_fill_bulk_urb(urb,
1052 usb_rcvbulkpipe(odev->parent->usb,
1054 bEndpointAddress & 0x7F),
1055 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1056 read_bulk_callback, odev);
1058 /* Give this to the USB subsystem so it can tell us when more data
1060 result = usb_submit_urb(urb, GFP_ATOMIC);
1062 dev_warn(&odev->parent->interface->dev,
1063 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1067 /* Serial driver functions */
1069 static void hso_init_termios(struct ktermios *termios)
1072 * The default requirements for this device are:
1075 ~(IGNBRK /* disable ignore break */
1076 | BRKINT /* disable break causes interrupt */
1077 | PARMRK /* disable mark parity errors */
1078 | ISTRIP /* disable clear high bit of input characters */
1079 | INLCR /* disable translate NL to CR */
1080 | IGNCR /* disable ignore CR */
1081 | ICRNL /* disable translate CR to NL */
1082 | IXON); /* disable enable XON/XOFF flow control */
1084 /* disable postprocess output characters */
1085 termios->c_oflag &= ~OPOST;
1088 ~(ECHO /* disable echo input characters */
1089 | ECHONL /* disable echo new line */
1090 | ICANON /* disable erase, kill, werase, and rprnt
1091 special characters */
1092 | ISIG /* disable interrupt, quit, and suspend special
1094 | IEXTEN); /* disable non-POSIX special characters */
1097 ~(CSIZE /* no size */
1098 | PARENB /* disable parity bit */
1099 | CBAUD /* clear current baud rate */
1100 | CBAUDEX); /* clear current buad rate */
1102 termios->c_cflag |= CS8; /* character size 8 bits */
1104 /* baud rate 115200 */
1105 tty_termios_encode_baud_rate(termios, 115200, 115200);
1108 static void _hso_serial_set_termios(struct tty_struct *tty,
1109 struct ktermios *old)
1111 struct hso_serial *serial = tty->driver_data;
1114 printk(KERN_ERR "%s: no tty structures", __func__);
1118 D4("port %d", serial->minor);
1121 * Fix up unsupported bits
1123 tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1125 tty->termios.c_cflag &=
1126 ~(CSIZE /* no size */
1127 | PARENB /* disable parity bit */
1128 | CBAUD /* clear current baud rate */
1129 | CBAUDEX); /* clear current buad rate */
1131 tty->termios.c_cflag |= CS8; /* character size 8 bits */
1133 /* baud rate 115200 */
1134 tty_encode_baud_rate(tty, 115200, 115200);
1137 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1140 /* We are done with this URB, resubmit it. Prep the USB to wait for
1142 usb_fill_bulk_urb(urb, serial->parent->usb,
1143 usb_rcvbulkpipe(serial->parent->usb,
1145 bEndpointAddress & 0x7F),
1146 urb->transfer_buffer, serial->rx_data_length,
1147 hso_std_serial_read_bulk_callback, serial);
1148 /* Give this to the USB subsystem so it can tell us when more data
1150 result = usb_submit_urb(urb, GFP_ATOMIC);
1152 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1160 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1163 struct urb *curr_urb;
1165 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1166 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1167 count = put_rxbuf_data(curr_urb, serial);
1171 serial->curr_rx_urb_idx++;
1172 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1173 serial->curr_rx_urb_idx = 0;
1174 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1179 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1184 urb = serial->rx_urb[0];
1185 if (serial->port.count > 0) {
1186 count = put_rxbuf_data(urb, serial);
1190 /* Re issue a read as long as we receive data. */
1192 if (count == 0 && ((urb->actual_length != 0) ||
1193 (serial->rx_state == RX_PENDING))) {
1194 serial->rx_state = RX_SENT;
1195 hso_mux_serial_read(serial);
1197 serial->rx_state = RX_IDLE;
1201 /* read callback for Diag and CS port */
1202 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1204 struct hso_serial *serial = urb->context;
1205 int status = urb->status;
1207 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1211 D1("serial == NULL");
1215 handle_usb_error(status, __func__, serial->parent);
1219 D1("Actual length = %d\n", urb->actual_length);
1220 DUMP1(urb->transfer_buffer, urb->actual_length);
1222 /* Anyone listening? */
1223 if (serial->port.count == 0)
1226 if (serial->parent->port_spec & HSO_INFO_CRC_BUG)
1227 fix_crc_bug(urb, serial->in_endp->wMaxPacketSize);
1228 /* Valid data, handle RX data */
1229 spin_lock(&serial->serial_lock);
1230 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1231 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1232 spin_unlock(&serial->serial_lock);
1236 * This needs to be a tasklet otherwise we will
1237 * end up recursively calling this function.
1239 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1241 unsigned long flags;
1243 spin_lock_irqsave(&serial->serial_lock, flags);
1244 if ((serial->parent->port_spec & HSO_INTF_MUX))
1245 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1247 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1248 spin_unlock_irqrestore(&serial->serial_lock, flags);
1251 static void hso_unthrottle(struct tty_struct *tty)
1253 struct hso_serial *serial = tty->driver_data;
1255 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1258 /* open the requested serial port */
1259 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1261 struct hso_serial *serial = get_serial_by_index(tty->index);
1265 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1267 tty->driver_data = NULL;
1268 D1("Failed to open port");
1272 mutex_lock(&serial->parent->mutex);
1273 result = usb_autopm_get_interface(serial->parent->interface);
1277 D1("Opening %d", serial->minor);
1280 tty->driver_data = serial;
1281 tty_port_tty_set(&serial->port, tty);
1283 /* check for port already opened, if not set the termios */
1284 serial->port.count++;
1285 if (serial->port.count == 1) {
1286 serial->rx_state = RX_IDLE;
1287 /* Force default termio settings */
1288 _hso_serial_set_termios(tty, NULL);
1289 tasklet_init(&serial->unthrottle_tasklet,
1290 (void (*)(unsigned long))hso_unthrottle_tasklet,
1291 (unsigned long)serial);
1292 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1294 hso_stop_serial_device(serial->parent);
1295 serial->port.count--;
1297 kref_get(&serial->parent->ref);
1300 D1("Port was already open");
1303 usb_autopm_put_interface(serial->parent->interface);
1307 hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0);
1309 mutex_unlock(&serial->parent->mutex);
1313 /* close the requested serial port */
1314 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1316 struct hso_serial *serial = tty->driver_data;
1319 D1("Closing serial port");
1321 /* Open failed, no close cleanup required */
1325 mutex_lock(&serial->parent->mutex);
1326 usb_gone = serial->parent->usb_gone;
1329 usb_autopm_get_interface(serial->parent->interface);
1331 /* reset the rts and dtr */
1332 /* do the actual close */
1333 serial->port.count--;
1335 if (serial->port.count <= 0) {
1336 serial->port.count = 0;
1337 tty_port_tty_set(&serial->port, NULL);
1339 hso_stop_serial_device(serial->parent);
1340 tasklet_kill(&serial->unthrottle_tasklet);
1344 usb_autopm_put_interface(serial->parent->interface);
1346 mutex_unlock(&serial->parent->mutex);
1349 /* close the requested serial port */
1350 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1353 struct hso_serial *serial = tty->driver_data;
1354 int space, tx_bytes;
1355 unsigned long flags;
1358 if (serial == NULL) {
1359 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1363 spin_lock_irqsave(&serial->serial_lock, flags);
1365 space = serial->tx_data_length - serial->tx_buffer_count;
1366 tx_bytes = (count < space) ? count : space;
1371 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1372 serial->tx_buffer_count += tx_bytes;
1375 spin_unlock_irqrestore(&serial->serial_lock, flags);
1377 hso_kick_transmit(serial);
1382 /* how much room is there for writing */
1383 static int hso_serial_write_room(struct tty_struct *tty)
1385 struct hso_serial *serial = tty->driver_data;
1387 unsigned long flags;
1389 spin_lock_irqsave(&serial->serial_lock, flags);
1390 room = serial->tx_data_length - serial->tx_buffer_count;
1391 spin_unlock_irqrestore(&serial->serial_lock, flags);
1393 /* return free room */
1397 static void hso_serial_cleanup(struct tty_struct *tty)
1399 struct hso_serial *serial = tty->driver_data;
1404 kref_put(&serial->parent->ref, hso_serial_ref_free);
1407 /* setup the term */
1408 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1410 struct hso_serial *serial = tty->driver_data;
1411 unsigned long flags;
1414 D5("Termios called with: cflags new[%d] - old[%d]",
1415 tty->termios.c_cflag, old->c_cflag);
1417 /* the actual setup */
1418 spin_lock_irqsave(&serial->serial_lock, flags);
1419 if (serial->port.count)
1420 _hso_serial_set_termios(tty, old);
1422 tty->termios = *old;
1423 spin_unlock_irqrestore(&serial->serial_lock, flags);
1428 /* how many characters in the buffer */
1429 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1431 struct hso_serial *serial = tty->driver_data;
1433 unsigned long flags;
1439 spin_lock_irqsave(&serial->serial_lock, flags);
1440 chars = serial->tx_buffer_count;
1441 spin_unlock_irqrestore(&serial->serial_lock, flags);
1445 static int tiocmget_submit_urb(struct hso_serial *serial,
1446 struct hso_tiocmget *tiocmget,
1447 struct usb_device *usb)
1451 if (serial->parent->usb_gone)
1453 usb_fill_int_urb(tiocmget->urb, usb,
1456 bEndpointAddress & 0x7F),
1457 &tiocmget->serial_state_notification,
1458 sizeof(struct hso_serial_state_notification),
1459 tiocmget_intr_callback, serial,
1460 tiocmget->endp->bInterval);
1461 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1463 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1470 static void tiocmget_intr_callback(struct urb *urb)
1472 struct hso_serial *serial = urb->context;
1473 struct hso_tiocmget *tiocmget;
1474 int status = urb->status;
1475 u16 UART_state_bitmap, prev_UART_state_bitmap;
1476 struct uart_icount *icount;
1477 struct hso_serial_state_notification *serial_state_notification;
1478 struct usb_device *usb;
1479 struct usb_interface *interface;
1486 handle_usb_error(status, __func__, serial->parent);
1490 /* tiocmget is only supported on HSO_PORT_MODEM */
1491 tiocmget = serial->tiocmget;
1494 BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1496 usb = serial->parent->usb;
1497 interface = serial->parent->interface;
1499 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1501 /* wIndex should be the USB interface number of the port to which the
1502 * notification applies, which should always be the Modem port.
1504 serial_state_notification = &tiocmget->serial_state_notification;
1505 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1506 serial_state_notification->bNotification != B_NOTIFICATION ||
1507 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1508 le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1509 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1511 "hso received invalid serial state notification\n");
1512 DUMP(serial_state_notification,
1513 sizeof(struct hso_serial_state_notification));
1516 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1518 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1519 icount = &tiocmget->icount;
1520 spin_lock(&serial->serial_lock);
1521 if ((UART_state_bitmap & B_OVERRUN) !=
1522 (prev_UART_state_bitmap & B_OVERRUN))
1524 if ((UART_state_bitmap & B_PARITY) !=
1525 (prev_UART_state_bitmap & B_PARITY))
1527 if ((UART_state_bitmap & B_FRAMING) !=
1528 (prev_UART_state_bitmap & B_FRAMING))
1530 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1531 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1533 if ((UART_state_bitmap & B_BREAK) !=
1534 (prev_UART_state_bitmap & B_BREAK))
1536 if ((UART_state_bitmap & B_TX_CARRIER) !=
1537 (prev_UART_state_bitmap & B_TX_CARRIER))
1539 if ((UART_state_bitmap & B_RX_CARRIER) !=
1540 (prev_UART_state_bitmap & B_RX_CARRIER))
1542 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1543 spin_unlock(&serial->serial_lock);
1544 tiocmget->intr_completed = 1;
1545 wake_up_interruptible(&tiocmget->waitq);
1547 memset(serial_state_notification, 0,
1548 sizeof(struct hso_serial_state_notification));
1549 tiocmget_submit_urb(serial,
1551 serial->parent->usb);
1555 * next few functions largely stolen from drivers/serial/serial_core.c
1557 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1558 * - mask passed in arg for lines of interest
1559 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1560 * Caller should use TIOCGICOUNT to see which one it was
1563 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1565 DECLARE_WAITQUEUE(wait, current);
1566 struct uart_icount cprev, cnow;
1567 struct hso_tiocmget *tiocmget;
1570 tiocmget = serial->tiocmget;
1574 * note the counters on entry
1576 spin_lock_irq(&serial->serial_lock);
1577 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1578 spin_unlock_irq(&serial->serial_lock);
1579 add_wait_queue(&tiocmget->waitq, &wait);
1581 spin_lock_irq(&serial->serial_lock);
1582 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1583 spin_unlock_irq(&serial->serial_lock);
1584 set_current_state(TASK_INTERRUPTIBLE);
1585 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1586 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1587 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1592 /* see if a signal did it */
1593 if (signal_pending(current)) {
1599 __set_current_state(TASK_RUNNING);
1600 remove_wait_queue(&tiocmget->waitq, &wait);
1606 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1607 * Return: write counters to the user passed counter struct
1608 * NB: both 1->0 and 0->1 transitions are counted except for
1609 * RI where only 0->1 is counted.
1611 static int hso_get_count(struct tty_struct *tty,
1612 struct serial_icounter_struct *icount)
1614 struct uart_icount cnow;
1615 struct hso_serial *serial = tty->driver_data;
1616 struct hso_tiocmget *tiocmget = serial->tiocmget;
1618 memset(icount, 0, sizeof(struct serial_icounter_struct));
1622 spin_lock_irq(&serial->serial_lock);
1623 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1624 spin_unlock_irq(&serial->serial_lock);
1626 icount->cts = cnow.cts;
1627 icount->dsr = cnow.dsr;
1628 icount->rng = cnow.rng;
1629 icount->dcd = cnow.dcd;
1630 icount->rx = cnow.rx;
1631 icount->tx = cnow.tx;
1632 icount->frame = cnow.frame;
1633 icount->overrun = cnow.overrun;
1634 icount->parity = cnow.parity;
1635 icount->brk = cnow.brk;
1636 icount->buf_overrun = cnow.buf_overrun;
1642 static int hso_serial_tiocmget(struct tty_struct *tty)
1645 struct hso_serial *serial = tty->driver_data;
1646 struct hso_tiocmget *tiocmget;
1647 u16 UART_state_bitmap;
1651 D1("no tty structures");
1654 spin_lock_irq(&serial->serial_lock);
1655 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1656 ((serial->dtr_state) ? TIOCM_DTR : 0);
1657 tiocmget = serial->tiocmget;
1660 UART_state_bitmap = le16_to_cpu(
1661 tiocmget->prev_UART_state_bitmap);
1662 if (UART_state_bitmap & B_RING_SIGNAL)
1663 retval |= TIOCM_RNG;
1664 if (UART_state_bitmap & B_RX_CARRIER)
1666 if (UART_state_bitmap & B_TX_CARRIER)
1667 retval |= TIOCM_DSR;
1669 spin_unlock_irq(&serial->serial_lock);
1673 static int hso_serial_tiocmset(struct tty_struct *tty,
1674 unsigned int set, unsigned int clear)
1677 unsigned long flags;
1679 struct hso_serial *serial = tty->driver_data;
1680 struct usb_interface *interface;
1684 D1("no tty structures");
1688 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1691 interface = serial->parent->interface;
1692 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1694 spin_lock_irqsave(&serial->serial_lock, flags);
1695 if (set & TIOCM_RTS)
1696 serial->rts_state = 1;
1697 if (set & TIOCM_DTR)
1698 serial->dtr_state = 1;
1700 if (clear & TIOCM_RTS)
1701 serial->rts_state = 0;
1702 if (clear & TIOCM_DTR)
1703 serial->dtr_state = 0;
1705 if (serial->dtr_state)
1707 if (serial->rts_state)
1710 spin_unlock_irqrestore(&serial->serial_lock, flags);
1712 return usb_control_msg(serial->parent->usb,
1713 usb_sndctrlpipe(serial->parent->usb, 0), 0x22,
1714 0x21, val, if_num, NULL, 0,
1715 USB_CTRL_SET_TIMEOUT);
1718 static int hso_serial_ioctl(struct tty_struct *tty,
1719 unsigned int cmd, unsigned long arg)
1721 struct hso_serial *serial = tty->driver_data;
1723 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1729 ret = hso_wait_modem_status(serial, arg);
1739 /* starts a transmit */
1740 static void hso_kick_transmit(struct hso_serial *serial)
1743 unsigned long flags;
1746 spin_lock_irqsave(&serial->serial_lock, flags);
1747 if (!serial->tx_buffer_count)
1750 if (serial->tx_urb_used)
1753 /* Wakeup USB interface if necessary */
1754 if (hso_get_activity(serial->parent) == -EAGAIN)
1757 /* Switch pointers around to avoid memcpy */
1758 temp = serial->tx_buffer;
1759 serial->tx_buffer = serial->tx_data;
1760 serial->tx_data = temp;
1761 serial->tx_data_count = serial->tx_buffer_count;
1762 serial->tx_buffer_count = 0;
1764 /* If temp is set, it means we switched buffers */
1765 if (temp && serial->write_data) {
1766 res = serial->write_data(serial);
1768 serial->tx_urb_used = 1;
1771 spin_unlock_irqrestore(&serial->serial_lock, flags);
1774 /* make a request (for reading and writing data to muxed serial port) */
1775 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1776 struct urb *ctrl_urb,
1777 struct usb_ctrlrequest *ctrl_req,
1778 u8 *ctrl_urb_data, u32 size)
1784 if (!serial || !ctrl_urb || !ctrl_req) {
1785 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1790 ctrl_req->wValue = 0;
1791 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1792 ctrl_req->wLength = cpu_to_le16(size);
1794 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1795 /* Reading command */
1796 ctrl_req->bRequestType = USB_DIR_IN |
1797 USB_TYPE_OPTION_VENDOR |
1798 USB_RECIP_INTERFACE;
1799 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1800 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1802 /* Writing command */
1803 ctrl_req->bRequestType = USB_DIR_OUT |
1804 USB_TYPE_OPTION_VENDOR |
1805 USB_RECIP_INTERFACE;
1806 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1807 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1810 D2("%s command (%02x) len: %d, port: %d",
1811 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1812 ctrl_req->bRequestType, ctrl_req->wLength, port);
1815 ctrl_urb->transfer_flags = 0;
1816 usb_fill_control_urb(ctrl_urb,
1817 serial->parent->usb,
1820 ctrl_urb_data, size, ctrl_callback, serial);
1821 /* Send it on merry way */
1822 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1824 dev_err(&ctrl_urb->dev->dev,
1825 "%s failed submit ctrl_urb %d type %d\n", __func__,
1834 /* called by intr_callback when read occurs */
1835 static int hso_mux_serial_read(struct hso_serial *serial)
1841 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1842 /* make the request */
1844 if (serial->num_rx_urbs != 1) {
1845 dev_err(&serial->parent->interface->dev,
1846 "ERROR: mux'd reads with multiple buffers "
1850 return mux_device_request(serial,
1851 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1852 serial->parent->port_spec & HSO_PORT_MASK,
1854 &serial->ctrl_req_rx,
1855 serial->rx_data[0], serial->rx_data_length);
1858 /* used for muxed serial port callback (muxed serial read) */
1859 static void intr_callback(struct urb *urb)
1861 struct hso_shared_int *shared_int = urb->context;
1862 struct hso_serial *serial;
1863 unsigned char *port_req;
1864 int status = urb->status;
1867 usb_mark_last_busy(urb->dev);
1875 handle_usb_error(status, __func__, NULL);
1878 D4("\n--- Got intr callback 0x%02X ---", status);
1881 port_req = urb->transfer_buffer;
1882 D4(" port_req = 0x%.2X\n", *port_req);
1883 /* loop over all muxed ports to find the one sending this */
1884 for (i = 0; i < 8; i++) {
1885 /* max 8 channels on MUX */
1886 if (*port_req & (1 << i)) {
1887 serial = get_serial_by_shared_int_and_type(shared_int,
1889 if (serial != NULL) {
1890 D1("Pending read interrupt on port %d\n", i);
1891 spin_lock(&serial->serial_lock);
1892 if (serial->rx_state == RX_IDLE &&
1893 serial->port.count > 0) {
1894 /* Setup and send a ctrl req read on
1896 if (!serial->rx_urb_filled[0]) {
1897 serial->rx_state = RX_SENT;
1898 hso_mux_serial_read(serial);
1900 serial->rx_state = RX_PENDING;
1902 D1("Already a read pending on "
1903 "port %d or port not open\n", i);
1905 spin_unlock(&serial->serial_lock);
1909 /* Resubmit interrupt urb */
1910 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1913 /* called for writing to muxed serial port */
1914 static int hso_mux_serial_write_data(struct hso_serial *serial)
1919 return mux_device_request(serial,
1920 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1921 serial->parent->port_spec & HSO_PORT_MASK,
1923 &serial->ctrl_req_tx,
1924 serial->tx_data, serial->tx_data_count);
1927 /* write callback for Diag and CS port */
1928 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1930 struct hso_serial *serial = urb->context;
1931 int status = urb->status;
1935 D1("serial == NULL");
1939 spin_lock(&serial->serial_lock);
1940 serial->tx_urb_used = 0;
1941 spin_unlock(&serial->serial_lock);
1943 handle_usb_error(status, __func__, serial->parent);
1946 hso_put_activity(serial->parent);
1947 tty_port_tty_wakeup(&serial->port);
1948 hso_kick_transmit(serial);
1953 /* called for writing diag or CS serial port */
1954 static int hso_std_serial_write_data(struct hso_serial *serial)
1956 int count = serial->tx_data_count;
1959 usb_fill_bulk_urb(serial->tx_urb,
1960 serial->parent->usb,
1961 usb_sndbulkpipe(serial->parent->usb,
1963 bEndpointAddress & 0x7F),
1964 serial->tx_data, serial->tx_data_count,
1965 hso_std_serial_write_bulk_callback, serial);
1967 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1969 dev_warn(&serial->parent->usb->dev,
1970 "Failed to submit urb - res %d\n", result);
1977 /* callback after read or write on muxed serial port */
1978 static void ctrl_callback(struct urb *urb)
1980 struct hso_serial *serial = urb->context;
1981 struct usb_ctrlrequest *req;
1982 int status = urb->status;
1988 spin_lock(&serial->serial_lock);
1989 serial->tx_urb_used = 0;
1990 spin_unlock(&serial->serial_lock);
1992 handle_usb_error(status, __func__, serial->parent);
1997 req = (struct usb_ctrlrequest *)(urb->setup_packet);
1998 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
1999 D4("Actual length of urb = %d\n", urb->actual_length);
2000 DUMP1(urb->transfer_buffer, urb->actual_length);
2002 if (req->bRequestType ==
2003 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2004 /* response to a read command */
2005 serial->rx_urb_filled[0] = 1;
2006 spin_lock(&serial->serial_lock);
2007 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2008 spin_unlock(&serial->serial_lock);
2010 hso_put_activity(serial->parent);
2011 tty_port_tty_wakeup(&serial->port);
2012 /* response to a write command */
2013 hso_kick_transmit(serial);
2017 /* handle RX data for serial port */
2018 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2020 struct tty_struct *tty;
2024 if (urb == NULL || serial == NULL) {
2025 D1("serial = NULL");
2029 tty = tty_port_tty_get(&serial->port);
2031 if (tty && test_bit(TTY_THROTTLED, &tty->flags)) {
2036 /* Push data to tty */
2037 D1("data to push to tty");
2038 count = tty_buffer_request_room(&serial->port, urb->actual_length);
2039 if (count >= urb->actual_length) {
2040 tty_insert_flip_string(&serial->port, urb->transfer_buffer,
2041 urb->actual_length);
2042 tty_flip_buffer_push(&serial->port);
2044 dev_warn(&serial->parent->usb->dev,
2045 "dropping data, %d bytes lost\n", urb->actual_length);
2050 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2056 /* Base driver functions */
2058 static void hso_log_port(struct hso_device *hso_dev)
2063 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2064 case HSO_PORT_CONTROL:
2065 port_type = "Control";
2068 port_type = "Application";
2073 case HSO_PORT_GPS_CONTROL:
2074 port_type = "GPS control";
2077 port_type = "Application2";
2083 port_type = "Diagnostic";
2085 case HSO_PORT_DIAG2:
2086 port_type = "Diagnostic2";
2088 case HSO_PORT_MODEM:
2089 port_type = "Modem";
2091 case HSO_PORT_NETWORK:
2092 port_type = "Network";
2095 port_type = "Unknown";
2098 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2099 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2101 sprintf(port_dev, "/dev/%s%d", tty_filename,
2102 dev2ser(hso_dev)->minor);
2104 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2105 port_type, port_dev);
2108 static int hso_start_net_device(struct hso_device *hso_dev)
2111 struct hso_net *hso_net = dev2net(hso_dev);
2116 /* send URBs for all read buffers */
2117 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2119 /* Prep a receive URB */
2120 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2122 usb_rcvbulkpipe(hso_dev->usb,
2124 bEndpointAddress & 0x7F),
2125 hso_net->mux_bulk_rx_buf_pool[i],
2126 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2129 /* Put it out there so the device can send us stuff */
2130 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2133 dev_warn(&hso_dev->usb->dev,
2134 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2141 static int hso_stop_net_device(struct hso_device *hso_dev)
2144 struct hso_net *hso_net = dev2net(hso_dev);
2149 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2150 if (hso_net->mux_bulk_rx_urb_pool[i])
2151 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2154 if (hso_net->mux_bulk_tx_urb)
2155 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2160 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2163 struct hso_serial *serial = dev2ser(hso_dev);
2168 /* If it is not the MUX port fill in and submit a bulk urb (already
2169 * allocated in hso_serial_start) */
2170 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2171 for (i = 0; i < serial->num_rx_urbs; i++) {
2172 usb_fill_bulk_urb(serial->rx_urb[i],
2173 serial->parent->usb,
2174 usb_rcvbulkpipe(serial->parent->usb,
2179 serial->rx_data_length,
2180 hso_std_serial_read_bulk_callback,
2182 result = usb_submit_urb(serial->rx_urb[i], flags);
2184 dev_warn(&serial->parent->usb->dev,
2185 "Failed to submit urb - res %d\n",
2191 mutex_lock(&serial->shared_int->shared_int_lock);
2192 if (!serial->shared_int->use_count) {
2194 hso_mux_submit_intr_urb(serial->shared_int,
2195 hso_dev->usb, flags);
2197 serial->shared_int->use_count++;
2198 mutex_unlock(&serial->shared_int->shared_int_lock);
2200 if (serial->tiocmget)
2201 tiocmget_submit_urb(serial,
2203 serial->parent->usb);
2207 static int hso_stop_serial_device(struct hso_device *hso_dev)
2210 struct hso_serial *serial = dev2ser(hso_dev);
2211 struct hso_tiocmget *tiocmget;
2216 for (i = 0; i < serial->num_rx_urbs; i++) {
2217 if (serial->rx_urb[i]) {
2218 usb_kill_urb(serial->rx_urb[i]);
2219 serial->rx_urb_filled[i] = 0;
2222 serial->curr_rx_urb_idx = 0;
2225 usb_kill_urb(serial->tx_urb);
2227 if (serial->shared_int) {
2228 mutex_lock(&serial->shared_int->shared_int_lock);
2229 if (serial->shared_int->use_count &&
2230 (--serial->shared_int->use_count == 0)) {
2233 urb = serial->shared_int->shared_intr_urb;
2237 mutex_unlock(&serial->shared_int->shared_int_lock);
2239 tiocmget = serial->tiocmget;
2241 wake_up_interruptible(&tiocmget->waitq);
2242 usb_kill_urb(tiocmget->urb);
2248 static void hso_serial_tty_unregister(struct hso_serial *serial)
2250 tty_unregister_device(tty_drv, serial->minor);
2251 release_minor(serial);
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)
2278 tty_port_init(&serial->port);
2280 if (obtain_minor(serial))
2283 /* register our minor number */
2284 serial->parent->dev = tty_port_register_device_attr(&serial->port,
2285 tty_drv, serial->minor, &serial->parent->interface->dev,
2286 serial->parent, hso_serial_dev_groups);
2287 if (IS_ERR(serial->parent->dev)) {
2288 release_minor(serial);
2291 dev = serial->parent->dev;
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);
2339 hso_serial_common_free(serial);
2343 /* Creates a general hso device */
2344 static struct hso_device *hso_create_device(struct usb_interface *intf,
2347 struct hso_device *hso_dev;
2349 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2353 hso_dev->port_spec = port_spec;
2354 hso_dev->usb = interface_to_usbdev(intf);
2355 hso_dev->interface = intf;
2356 kref_init(&hso_dev->ref);
2357 mutex_init(&hso_dev->mutex);
2359 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2360 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2365 /* Removes a network device in the network device table */
2366 static int remove_net_device(struct hso_device *hso_dev)
2370 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2371 if (network_table[i] == hso_dev) {
2372 network_table[i] = NULL;
2376 if (i == HSO_MAX_NET_DEVICES)
2381 /* Frees our network device */
2382 static void hso_free_net_device(struct hso_device *hso_dev)
2385 struct hso_net *hso_net = dev2net(hso_dev);
2390 remove_net_device(hso_net->parent);
2393 unregister_netdev(hso_net->net);
2396 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2397 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2398 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2399 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2401 usb_free_urb(hso_net->mux_bulk_tx_urb);
2402 kfree(hso_net->mux_bulk_tx_buf);
2403 hso_net->mux_bulk_tx_buf = NULL;
2406 free_netdev(hso_net->net);
2411 static const struct net_device_ops hso_netdev_ops = {
2412 .ndo_open = hso_net_open,
2413 .ndo_stop = hso_net_close,
2414 .ndo_start_xmit = hso_net_start_xmit,
2415 .ndo_tx_timeout = hso_net_tx_timeout,
2418 /* initialize the network interface */
2419 static void hso_net_init(struct net_device *net)
2421 struct hso_net *hso_net = netdev_priv(net);
2423 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2425 /* fill in the other fields */
2426 net->netdev_ops = &hso_netdev_ops;
2427 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2428 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2429 net->type = ARPHRD_NONE;
2430 net->mtu = DEFAULT_MTU - 14;
2431 net->tx_queue_len = 10;
2432 net->ethtool_ops = &ops;
2434 /* and initialize the semaphore */
2435 spin_lock_init(&hso_net->net_lock);
2438 /* Adds a network device in the network device table */
2439 static int add_net_device(struct hso_device *hso_dev)
2443 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2444 if (network_table[i] == NULL) {
2445 network_table[i] = hso_dev;
2449 if (i == HSO_MAX_NET_DEVICES)
2454 static int hso_rfkill_set_block(void *data, bool blocked)
2456 struct hso_device *hso_dev = data;
2457 int enabled = !blocked;
2460 mutex_lock(&hso_dev->mutex);
2461 if (hso_dev->usb_gone)
2464 rv = usb_control_msg(hso_dev->usb, usb_sndctrlpipe(hso_dev->usb, 0),
2465 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2466 USB_CTRL_SET_TIMEOUT);
2467 mutex_unlock(&hso_dev->mutex);
2471 static const struct rfkill_ops hso_rfkill_ops = {
2472 .set_block = hso_rfkill_set_block,
2475 /* Creates and sets up everything for rfkill */
2476 static void hso_create_rfkill(struct hso_device *hso_dev,
2477 struct usb_interface *interface)
2479 struct hso_net *hso_net = dev2net(hso_dev);
2480 struct device *dev = &hso_net->net->dev;
2481 static u32 rfkill_counter;
2483 snprintf(hso_net->name, sizeof(hso_net->name), "hso-%d",
2486 hso_net->rfkill = rfkill_alloc(hso_net->name,
2487 &interface_to_usbdev(interface)->dev,
2489 &hso_rfkill_ops, hso_dev);
2490 if (!hso_net->rfkill) {
2491 dev_err(dev, "%s - Out of memory\n", __func__);
2494 if (rfkill_register(hso_net->rfkill) < 0) {
2495 rfkill_destroy(hso_net->rfkill);
2496 hso_net->rfkill = NULL;
2497 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2502 static struct device_type hso_type = {
2506 /* Creates our network device */
2507 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2511 struct net_device *net;
2512 struct hso_net *hso_net;
2513 struct hso_device *hso_dev;
2515 hso_dev = hso_create_device(interface, port_spec);
2519 /* allocate our network device, then we can put in our private data */
2520 /* call hso_net_init to do the basic initialization */
2521 net = alloc_netdev(sizeof(struct hso_net), "hso%d", NET_NAME_UNKNOWN,
2524 dev_err(&interface->dev, "Unable to create ethernet device\n");
2528 hso_net = netdev_priv(net);
2530 hso_dev->port_data.dev_net = hso_net;
2532 hso_net->parent = hso_dev;
2534 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2536 if (!hso_net->in_endp) {
2537 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2540 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2542 if (!hso_net->out_endp) {
2543 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2546 SET_NETDEV_DEV(net, &interface->dev);
2547 SET_NETDEV_DEVTYPE(net, &hso_type);
2549 /* registering our net device */
2550 result = register_netdev(net);
2552 dev_err(&interface->dev, "Failed to register device\n");
2556 /* start allocating */
2557 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2558 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2559 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2560 dev_err(&interface->dev, "Could not allocate rx urb\n");
2563 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2565 if (!hso_net->mux_bulk_rx_buf_pool[i])
2568 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2569 if (!hso_net->mux_bulk_tx_urb) {
2570 dev_err(&interface->dev, "Could not allocate tx urb\n");
2573 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2574 if (!hso_net->mux_bulk_tx_buf)
2577 add_net_device(hso_dev);
2579 hso_log_port(hso_dev);
2581 hso_create_rfkill(hso_dev, interface);
2585 hso_free_net_device(hso_dev);
2589 static void hso_free_tiomget(struct hso_serial *serial)
2591 struct hso_tiocmget *tiocmget;
2594 tiocmget = serial->tiocmget;
2596 usb_free_urb(tiocmget->urb);
2597 tiocmget->urb = NULL;
2598 serial->tiocmget = NULL;
2603 /* Frees an AT channel ( goes for both mux and non-mux ) */
2604 static void hso_free_serial_device(struct hso_device *hso_dev)
2606 struct hso_serial *serial = dev2ser(hso_dev);
2611 hso_serial_common_free(serial);
2613 if (serial->shared_int) {
2614 mutex_lock(&serial->shared_int->shared_int_lock);
2615 if (--serial->shared_int->ref_count == 0)
2616 hso_free_shared_int(serial->shared_int);
2618 mutex_unlock(&serial->shared_int->shared_int_lock);
2620 hso_free_tiomget(serial);
2625 /* Creates a bulk AT channel */
2626 static struct hso_device *hso_create_bulk_serial_device(
2627 struct usb_interface *interface, int port)
2629 struct hso_device *hso_dev;
2630 struct hso_serial *serial;
2632 struct hso_tiocmget *tiocmget;
2634 hso_dev = hso_create_device(interface, port);
2638 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2642 serial->parent = hso_dev;
2643 hso_dev->port_data.dev_serial = serial;
2645 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2647 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2649 /* it isn't going to break our heart if serial->tiocmget
2650 * allocation fails don't bother checking this.
2652 if (serial->tiocmget) {
2653 tiocmget = serial->tiocmget;
2654 tiocmget->endp = hso_get_ep(interface,
2655 USB_ENDPOINT_XFER_INT,
2657 if (!tiocmget->endp) {
2658 dev_err(&interface->dev, "Failed to find INT IN ep\n");
2662 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2663 if (tiocmget->urb) {
2664 mutex_init(&tiocmget->mutex);
2665 init_waitqueue_head(&tiocmget->waitq);
2667 hso_free_tiomget(serial);
2673 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2677 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2679 if (!serial->in_endp) {
2680 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2686 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2687 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2691 serial->write_data = hso_std_serial_write_data;
2693 /* setup the proc dirs and files if needed */
2694 hso_log_port(hso_dev);
2696 /* done, return it */
2700 hso_serial_tty_unregister(serial);
2701 hso_serial_common_free(serial);
2703 hso_free_tiomget(serial);
2709 /* Creates a multiplexed AT channel */
2711 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2713 struct hso_shared_int *mux)
2715 struct hso_device *hso_dev;
2716 struct hso_serial *serial;
2719 port_spec = HSO_INTF_MUX;
2720 port_spec &= ~HSO_PORT_MASK;
2722 port_spec |= hso_mux_to_port(port);
2723 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2726 hso_dev = hso_create_device(interface, port_spec);
2730 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2734 hso_dev->port_data.dev_serial = serial;
2735 serial->parent = hso_dev;
2737 if (hso_serial_common_create
2738 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2739 goto err_free_serial;
2741 serial->tx_data_length--;
2742 serial->write_data = hso_mux_serial_write_data;
2744 serial->shared_int = mux;
2745 mutex_lock(&serial->shared_int->shared_int_lock);
2746 serial->shared_int->ref_count++;
2747 mutex_unlock(&serial->shared_int->shared_int_lock);
2749 /* setup the proc dirs and files if needed */
2750 hso_log_port(hso_dev);
2752 /* done, return it */
2763 static void hso_free_shared_int(struct hso_shared_int *mux)
2765 usb_free_urb(mux->shared_intr_urb);
2766 kfree(mux->shared_intr_buf);
2767 mutex_unlock(&mux->shared_int_lock);
2772 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2774 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2779 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2781 if (!mux->intr_endp) {
2782 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2786 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2787 if (!mux->shared_intr_urb) {
2788 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2791 mux->shared_intr_buf =
2792 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2794 if (!mux->shared_intr_buf)
2797 mutex_init(&mux->shared_int_lock);
2802 kfree(mux->shared_intr_buf);
2803 usb_free_urb(mux->shared_intr_urb);
2808 /* Gets the port spec for a certain interface */
2809 static int hso_get_config_data(struct usb_interface *interface)
2811 struct usb_device *usbdev = interface_to_usbdev(interface);
2812 u8 *config_data = kmalloc(17, GFP_KERNEL);
2813 u32 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2818 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2819 0x86, 0xC0, 0, 0, config_data, 17,
2820 USB_CTRL_SET_TIMEOUT) != 0x11) {
2825 /* check if we have a valid interface */
2831 switch (config_data[if_num]) {
2836 result = HSO_PORT_DIAG;
2839 result = HSO_PORT_GPS;
2842 result = HSO_PORT_GPS_CONTROL;
2845 result = HSO_PORT_APP;
2848 result = HSO_PORT_APP2;
2851 result = HSO_PORT_CONTROL;
2854 result = HSO_PORT_NETWORK;
2857 result = HSO_PORT_MODEM;
2860 result = HSO_PORT_MSD;
2863 result = HSO_PORT_PCSC;
2866 result = HSO_PORT_VOICE;
2873 result |= HSO_INTF_BULK;
2875 if (config_data[16] & 0x1)
2876 result |= HSO_INFO_CRC_BUG;
2882 /* called once for each interface upon device insertion */
2883 static int hso_probe(struct usb_interface *interface,
2884 const struct usb_device_id *id)
2886 int mux, i, if_num, port_spec;
2887 unsigned char port_mask;
2888 struct hso_device *hso_dev = NULL;
2889 struct hso_shared_int *shared_int;
2890 struct hso_device *tmp_dev = NULL;
2892 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2893 dev_err(&interface->dev, "Not our interface\n");
2897 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2899 /* Get the interface/port specification from either driver_info or from
2900 * the device itself */
2901 if (id->driver_info) {
2902 /* if_num is controlled by the device, driver_info is a 0 terminated
2903 * array. Make sure, the access is in bounds! */
2904 for (i = 0; i <= if_num; ++i)
2905 if (((u32 *)(id->driver_info))[i] == 0)
2907 port_spec = ((u32 *)(id->driver_info))[if_num];
2909 port_spec = hso_get_config_data(interface);
2914 /* Check if we need to switch to alt interfaces prior to port
2916 if (interface->num_altsetting > 1)
2917 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2918 interface->needs_remote_wakeup = 1;
2920 /* Allocate new hso device(s) */
2921 switch (port_spec & HSO_INTF_MASK) {
2923 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2924 /* Create the network device */
2926 hso_dev = hso_create_net_device(interface,
2934 if (hso_get_mux_ports(interface, &port_mask))
2935 /* TODO: de-allocate everything */
2938 shared_int = hso_create_shared_int(interface);
2942 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2943 if (port_mask & i) {
2944 hso_dev = hso_create_mux_serial_device(
2945 interface, i, shared_int);
2956 /* It's a regular bulk interface */
2957 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2960 hso_create_net_device(interface, port_spec);
2963 hso_create_bulk_serial_device(interface, port_spec);
2972 /* save our data pointer in this device */
2973 usb_set_intfdata(interface, hso_dev);
2978 hso_free_interface(interface);
2982 /* device removed, cleaning up */
2983 static void hso_disconnect(struct usb_interface *interface)
2985 hso_free_interface(interface);
2987 /* remove reference of our private data */
2988 usb_set_intfdata(interface, NULL);
2991 static void async_get_intf(struct work_struct *data)
2993 struct hso_device *hso_dev =
2994 container_of(data, struct hso_device, async_get_intf);
2995 usb_autopm_get_interface(hso_dev->interface);
2998 static void async_put_intf(struct work_struct *data)
3000 struct hso_device *hso_dev =
3001 container_of(data, struct hso_device, async_put_intf);
3002 usb_autopm_put_interface(hso_dev->interface);
3005 static int hso_get_activity(struct hso_device *hso_dev)
3007 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3008 if (!hso_dev->is_active) {
3009 hso_dev->is_active = 1;
3010 schedule_work(&hso_dev->async_get_intf);
3014 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3017 usb_mark_last_busy(hso_dev->usb);
3022 static int hso_put_activity(struct hso_device *hso_dev)
3024 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3025 if (hso_dev->is_active) {
3026 hso_dev->is_active = 0;
3027 schedule_work(&hso_dev->async_put_intf);
3031 hso_dev->is_active = 0;
3035 /* called by kernel when we need to suspend device */
3036 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3040 /* Stop all serial ports */
3041 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3042 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3043 result = hso_stop_serial_device(serial_table[i]);
3049 /* Stop all network ports */
3050 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3051 if (network_table[i] &&
3052 (network_table[i]->interface == iface)) {
3053 result = hso_stop_net_device(network_table[i]);
3063 /* called by kernel when we need to resume device */
3064 static int hso_resume(struct usb_interface *iface)
3067 struct hso_net *hso_net;
3069 /* Start all serial ports */
3070 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3071 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3072 if (dev2ser(serial_table[i])->port.count) {
3074 hso_start_serial_device(serial_table[i], GFP_NOIO);
3075 hso_kick_transmit(dev2ser(serial_table[i]));
3082 /* Start all network ports */
3083 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3084 if (network_table[i] &&
3085 (network_table[i]->interface == iface)) {
3086 hso_net = dev2net(network_table[i]);
3087 if (hso_net->flags & IFF_UP) {
3088 /* First transmit any lingering data,
3089 then restart the device. */
3090 if (hso_net->skb_tx_buf) {
3091 dev_dbg(&iface->dev,
3093 " lingering data\n");
3094 hso_net_start_xmit(hso_net->skb_tx_buf,
3096 hso_net->skb_tx_buf = NULL;
3098 result = hso_start_net_device(network_table[i]);
3109 static void hso_serial_ref_free(struct kref *ref)
3111 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3113 hso_free_serial_device(hso_dev);
3116 static void hso_free_interface(struct usb_interface *interface)
3118 struct hso_serial *serial;
3121 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3122 if (serial_table[i] &&
3123 (serial_table[i]->interface == interface)) {
3124 serial = dev2ser(serial_table[i]);
3125 tty_port_tty_hangup(&serial->port, false);
3126 mutex_lock(&serial->parent->mutex);
3127 serial->parent->usb_gone = 1;
3128 mutex_unlock(&serial->parent->mutex);
3129 cancel_work_sync(&serial_table[i]->async_put_intf);
3130 cancel_work_sync(&serial_table[i]->async_get_intf);
3131 hso_serial_tty_unregister(serial);
3132 kref_put(&serial->parent->ref, hso_serial_ref_free);
3136 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3137 if (network_table[i] &&
3138 (network_table[i]->interface == interface)) {
3139 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3140 /* hso_stop_net_device doesn't stop the net queue since
3141 * traffic needs to start it again when suspended */
3142 netif_stop_queue(dev2net(network_table[i])->net);
3143 hso_stop_net_device(network_table[i]);
3144 cancel_work_sync(&network_table[i]->async_put_intf);
3145 cancel_work_sync(&network_table[i]->async_get_intf);
3147 rfkill_unregister(rfk);
3148 rfkill_destroy(rfk);
3150 hso_free_net_device(network_table[i]);
3155 /* Helper functions */
3157 /* Get the endpoint ! */
3158 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3162 struct usb_host_interface *iface = intf->cur_altsetting;
3163 struct usb_endpoint_descriptor *endp;
3165 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3166 endp = &iface->endpoint[i].desc;
3167 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3168 (usb_endpoint_type(endp) == type))
3175 /* Get the byte that describes which ports are enabled */
3176 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3179 struct usb_host_interface *iface = intf->cur_altsetting;
3181 if (iface->extralen == 3) {
3182 *ports = iface->extra[2];
3186 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3187 if (iface->endpoint[i].extralen == 3) {
3188 *ports = iface->endpoint[i].extra[2];
3196 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3197 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3198 struct usb_device *usb, gfp_t gfp)
3202 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3204 shared_int->intr_endp->bEndpointAddress & 0x7F),
3205 shared_int->shared_intr_buf,
3207 intr_callback, shared_int,
3208 shared_int->intr_endp->bInterval);
3210 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3212 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3218 /* operations setup of the serial interface */
3219 static const struct tty_operations hso_serial_ops = {
3220 .open = hso_serial_open,
3221 .close = hso_serial_close,
3222 .write = hso_serial_write,
3223 .write_room = hso_serial_write_room,
3224 .cleanup = hso_serial_cleanup,
3225 .ioctl = hso_serial_ioctl,
3226 .set_termios = hso_serial_set_termios,
3227 .chars_in_buffer = hso_serial_chars_in_buffer,
3228 .tiocmget = hso_serial_tiocmget,
3229 .tiocmset = hso_serial_tiocmset,
3230 .get_icount = hso_get_count,
3231 .unthrottle = hso_unthrottle
3234 static struct usb_driver hso_driver = {
3235 .name = driver_name,
3237 .disconnect = hso_disconnect,
3238 .id_table = hso_ids,
3239 .suspend = hso_suspend,
3240 .resume = hso_resume,
3241 .reset_resume = hso_resume,
3242 .supports_autosuspend = 1,
3243 .disable_hub_initiated_lpm = 1,
3246 static int __init hso_init(void)
3251 /* put it in the log */
3252 printk(KERN_INFO "hso: %s\n", version);
3254 /* Initialise the serial table semaphore and table */
3255 spin_lock_init(&serial_table_lock);
3256 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3257 serial_table[i] = NULL;
3259 /* allocate our driver using the proper amount of supported minors */
3260 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3264 /* fill in all needed values */
3265 tty_drv->driver_name = driver_name;
3266 tty_drv->name = tty_filename;
3268 /* if major number is provided as parameter, use that one */
3270 tty_drv->major = tty_major;
3272 tty_drv->minor_start = 0;
3273 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3274 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3275 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3276 tty_drv->init_termios = tty_std_termios;
3277 hso_init_termios(&tty_drv->init_termios);
3278 tty_set_operations(tty_drv, &hso_serial_ops);
3280 /* register the tty driver */
3281 result = tty_register_driver(tty_drv);
3283 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3288 /* register this module as an usb driver */
3289 result = usb_register(&hso_driver);
3291 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3299 tty_unregister_driver(tty_drv);
3301 put_tty_driver(tty_drv);
3305 static void __exit hso_exit(void)
3307 printk(KERN_INFO "hso: unloaded\n");
3309 tty_unregister_driver(tty_drv);
3310 put_tty_driver(tty_drv);
3311 /* deregister the usb driver */
3312 usb_deregister(&hso_driver);
3315 /* Module definitions */
3316 module_init(hso_init);
3317 module_exit(hso_exit);
3319 MODULE_AUTHOR(MOD_AUTHOR);
3320 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3321 MODULE_LICENSE(MOD_LICENSE);
3323 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3324 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3325 module_param(debug, int, S_IRUGO | S_IWUSR);
3327 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3328 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3329 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3331 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3332 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3333 module_param(disable_net, int, S_IRUGO | S_IWUSR);