1 // SPDX-License-Identifier: GPL-2.0-only
2 /******************************************************************************
4 * Driver for Option High Speed Mobile Devices.
6 * Copyright (C) 2008 Option International
7 * Filip Aben <f.aben@option.com>
8 * Denis Joseph Barrow <d.barow@option.com>
9 * Jan Dumon <j.dumon@option.com>
10 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
11 * <ajb@spheresystems.co.uk>
12 * Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de>
13 * Copyright (C) 2008 Novell, Inc.
15 *****************************************************************************/
17 /******************************************************************************
19 * Description of the device:
21 * Interface 0: Contains the IP network interface on the bulk end points.
22 * The multiplexed serial ports are using the interrupt and
24 * Interrupt contains a bitmap telling which multiplexed
25 * serialport needs servicing.
27 * Interface 1: Diagnostics port, uses bulk only, do not submit urbs until the
28 * port is opened, as this have a huge impact on the network port
31 * Interface 2: Standard modem interface - circuit switched interface, this
32 * can be used to make a standard ppp connection however it
33 * should not be used in conjunction with the IP network interface
34 * enabled for USB performance reasons i.e. if using this set
35 * ideally disable_net=1.
37 *****************************************************************************/
39 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
41 #include <linux/sched/signal.h>
42 #include <linux/slab.h>
43 #include <linux/init.h>
44 #include <linux/delay.h>
45 #include <linux/netdevice.h>
46 #include <linux/module.h>
47 #include <linux/ethtool.h>
48 #include <linux/usb.h>
49 #include <linux/tty.h>
50 #include <linux/tty_driver.h>
51 #include <linux/tty_flip.h>
52 #include <linux/kmod.h>
53 #include <linux/rfkill.h>
55 #include <linux/uaccess.h>
56 #include <linux/usb/cdc.h>
58 #include <asm/byteorder.h>
59 #include <linux/serial_core.h>
60 #include <linux/serial.h>
63 #define MOD_AUTHOR "Option Wireless"
64 #define MOD_DESCRIPTION "USB High Speed Option driver"
66 #define HSO_MAX_NET_DEVICES 10
67 #define HSO__MAX_MTU 2048
68 #define DEFAULT_MTU 1500
69 #define DEFAULT_MRU 1500
71 #define CTRL_URB_RX_SIZE 1024
72 #define CTRL_URB_TX_SIZE 64
74 #define BULK_URB_RX_SIZE 4096
75 #define BULK_URB_TX_SIZE 8192
77 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
78 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
79 #define MUX_BULK_RX_BUF_COUNT 4
80 #define USB_TYPE_OPTION_VENDOR 0x20
82 /* These definitions are used with the struct hso_net flags element */
83 /* - use *_bit operations on it. (bit indices not values.) */
84 #define HSO_NET_RUNNING 0
86 #define HSO_NET_TX_TIMEOUT (HZ*10)
88 #define HSO_SERIAL_MAGIC 0x48534f31
90 /* Number of ttys to handle */
91 #define HSO_SERIAL_TTY_MINORS 256
95 /*****************************************************************************/
96 /* Debugging functions */
97 /*****************************************************************************/
98 #define hso_dbg(lvl, fmt, ...) \
101 pr_info("[%d:%s] " fmt, \
102 __LINE__, __func__, ##__VA_ARGS__); \
105 /*****************************************************************************/
107 /*****************************************************************************/
108 enum pkt_parse_state {
114 /*****************************************************************************/
116 /*****************************************************************************/
118 struct hso_shared_int {
119 struct usb_endpoint_descriptor *intr_endp;
120 void *shared_intr_buf;
121 struct urb *shared_intr_urb;
122 struct usb_device *usb;
125 struct mutex shared_int_lock;
129 struct hso_device *parent;
130 struct net_device *net;
131 struct rfkill *rfkill;
134 struct usb_endpoint_descriptor *in_endp;
135 struct usb_endpoint_descriptor *out_endp;
137 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
138 struct urb *mux_bulk_tx_urb;
139 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
140 void *mux_bulk_tx_buf;
142 struct sk_buff *skb_rx_buf;
143 struct sk_buff *skb_tx_buf;
145 enum pkt_parse_state rx_parse_state;
148 unsigned short rx_buf_size;
149 unsigned short rx_buf_missing;
150 struct iphdr rx_ip_hdr;
161 #define BM_REQUEST_TYPE (0xa1)
162 #define B_NOTIFICATION (0x20)
163 #define W_VALUE (0x0)
164 #define W_LENGTH (0x2)
166 #define B_OVERRUN (0x1<<6)
167 #define B_PARITY (0x1<<5)
168 #define B_FRAMING (0x1<<4)
169 #define B_RING_SIGNAL (0x1<<3)
170 #define B_BREAK (0x1<<2)
171 #define B_TX_CARRIER (0x1<<1)
172 #define B_RX_CARRIER (0x1<<0)
174 struct hso_serial_state_notification {
180 u16 UART_state_bitmap;
183 struct hso_tiocmget {
185 wait_queue_head_t waitq;
187 struct usb_endpoint_descriptor *endp;
189 struct hso_serial_state_notification *serial_state_notification;
190 u16 prev_UART_state_bitmap;
191 struct uart_icount icount;
196 struct hso_device *parent;
200 struct hso_shared_int *shared_int;
202 /* rx/tx urb could be either a bulk urb or a control urb depending
203 on which serial port it is used on. */
204 struct urb *rx_urb[MAX_RX_URBS];
206 u8 *rx_data[MAX_RX_URBS];
207 u16 rx_data_length; /* should contain allocated length */
212 u16 tx_data_length; /* should contain allocated length */
215 struct usb_ctrlrequest ctrl_req_tx;
216 struct usb_ctrlrequest ctrl_req_rx;
218 struct usb_endpoint_descriptor *in_endp;
219 struct usb_endpoint_descriptor *out_endp;
221 enum rx_ctrl_state rx_state;
224 unsigned tx_urb_used:1;
226 struct tty_port port;
227 /* from usb_serial_port */
228 spinlock_t serial_lock;
230 int (*write_data) (struct hso_serial *serial);
231 struct hso_tiocmget *tiocmget;
232 /* Hacks required to get flow control
233 * working on the serial receive buffers
234 * so as not to drop characters on the floor.
237 u8 rx_urb_filled[MAX_RX_URBS];
238 struct tasklet_struct unthrottle_tasklet;
243 struct hso_serial *dev_serial;
244 struct hso_net *dev_net;
251 struct work_struct async_get_intf;
252 struct work_struct async_put_intf;
254 struct usb_device *usb;
255 struct usb_interface *interface;
262 /* Type of interface */
263 #define HSO_INTF_MASK 0xFF00
264 #define HSO_INTF_MUX 0x0100
265 #define HSO_INTF_BULK 0x0200
268 #define HSO_PORT_MASK 0xFF
269 #define HSO_PORT_NO_PORT 0x0
270 #define HSO_PORT_CONTROL 0x1
271 #define HSO_PORT_APP 0x2
272 #define HSO_PORT_GPS 0x3
273 #define HSO_PORT_PCSC 0x4
274 #define HSO_PORT_APP2 0x5
275 #define HSO_PORT_GPS_CONTROL 0x6
276 #define HSO_PORT_MSD 0x7
277 #define HSO_PORT_VOICE 0x8
278 #define HSO_PORT_DIAG2 0x9
279 #define HSO_PORT_DIAG 0x10
280 #define HSO_PORT_MODEM 0x11
281 #define HSO_PORT_NETWORK 0x12
283 /* Additional device info */
284 #define HSO_INFO_MASK 0xFF000000
285 #define HSO_INFO_CRC_BUG 0x01000000
287 /*****************************************************************************/
289 /*****************************************************************************/
290 /* Serial driver functions */
291 static int hso_serial_tiocmset(struct tty_struct *tty,
292 unsigned int set, unsigned int clear);
293 static void ctrl_callback(struct urb *urb);
294 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
295 static void hso_kick_transmit(struct hso_serial *serial);
296 /* Helper functions */
297 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
298 struct usb_device *usb, gfp_t gfp);
299 static void handle_usb_error(int status, const char *function,
300 struct hso_device *hso_dev);
301 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
303 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
304 static void hso_free_interface(struct usb_interface *intf);
305 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
306 static int hso_stop_serial_device(struct hso_device *hso_dev);
307 static int hso_start_net_device(struct hso_device *hso_dev);
308 static void hso_free_shared_int(struct hso_shared_int *shared_int);
309 static int hso_stop_net_device(struct hso_device *hso_dev);
310 static void hso_serial_ref_free(struct kref *ref);
311 static void hso_std_serial_read_bulk_callback(struct urb *urb);
312 static int hso_mux_serial_read(struct hso_serial *serial);
313 static void async_get_intf(struct work_struct *data);
314 static void async_put_intf(struct work_struct *data);
315 static int hso_put_activity(struct hso_device *hso_dev);
316 static int hso_get_activity(struct hso_device *hso_dev);
317 static void tiocmget_intr_callback(struct urb *urb);
318 /*****************************************************************************/
319 /* Helping functions */
320 /*****************************************************************************/
324 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
326 return hso_dev->port_data.dev_net;
329 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
331 return hso_dev->port_data.dev_serial;
334 /* Debugging functions */
336 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
339 static char name[255];
341 sprintf(name, "hso[%d:%s]", line_count, func_name);
342 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
345 #define DUMP(buf_, len_) \
346 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
348 #define DUMP1(buf_, len_) \
354 #define DUMP(buf_, len_)
355 #define DUMP1(buf_, len_)
358 /* module parameters */
360 static int tty_major;
361 static int disable_net;
364 static const char driver_name[] = "hso";
365 static const char tty_filename[] = "ttyHS";
366 static const char *version = __FILE__ ": " MOD_AUTHOR;
367 /* the usb driver itself (registered in hso_init) */
368 static struct usb_driver hso_driver;
369 /* serial structures */
370 static struct tty_driver *tty_drv;
371 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
372 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
373 static spinlock_t serial_table_lock;
375 static const s32 default_port_spec[] = {
376 HSO_INTF_MUX | HSO_PORT_NETWORK,
377 HSO_INTF_BULK | HSO_PORT_DIAG,
378 HSO_INTF_BULK | HSO_PORT_MODEM,
382 static const s32 icon321_port_spec[] = {
383 HSO_INTF_MUX | HSO_PORT_NETWORK,
384 HSO_INTF_BULK | HSO_PORT_DIAG2,
385 HSO_INTF_BULK | HSO_PORT_MODEM,
386 HSO_INTF_BULK | HSO_PORT_DIAG,
390 #define default_port_device(vendor, product) \
391 USB_DEVICE(vendor, product), \
392 .driver_info = (kernel_ulong_t)default_port_spec
394 #define icon321_port_device(vendor, product) \
395 USB_DEVICE(vendor, product), \
396 .driver_info = (kernel_ulong_t)icon321_port_spec
398 /* list of devices we support */
399 static const struct usb_device_id hso_ids[] = {
400 {default_port_device(0x0af0, 0x6711)},
401 {default_port_device(0x0af0, 0x6731)},
402 {default_port_device(0x0af0, 0x6751)},
403 {default_port_device(0x0af0, 0x6771)},
404 {default_port_device(0x0af0, 0x6791)},
405 {default_port_device(0x0af0, 0x6811)},
406 {default_port_device(0x0af0, 0x6911)},
407 {default_port_device(0x0af0, 0x6951)},
408 {default_port_device(0x0af0, 0x6971)},
409 {default_port_device(0x0af0, 0x7011)},
410 {default_port_device(0x0af0, 0x7031)},
411 {default_port_device(0x0af0, 0x7051)},
412 {default_port_device(0x0af0, 0x7071)},
413 {default_port_device(0x0af0, 0x7111)},
414 {default_port_device(0x0af0, 0x7211)},
415 {default_port_device(0x0af0, 0x7251)},
416 {default_port_device(0x0af0, 0x7271)},
417 {default_port_device(0x0af0, 0x7311)},
418 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
419 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
420 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
421 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
422 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
423 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
424 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
425 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
426 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
427 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
428 {USB_DEVICE(0x0af0, 0x7701)},
429 {USB_DEVICE(0x0af0, 0x7706)},
430 {USB_DEVICE(0x0af0, 0x7801)},
431 {USB_DEVICE(0x0af0, 0x7901)},
432 {USB_DEVICE(0x0af0, 0x7A01)},
433 {USB_DEVICE(0x0af0, 0x7A05)},
434 {USB_DEVICE(0x0af0, 0x8200)},
435 {USB_DEVICE(0x0af0, 0x8201)},
436 {USB_DEVICE(0x0af0, 0x8300)},
437 {USB_DEVICE(0x0af0, 0x8302)},
438 {USB_DEVICE(0x0af0, 0x8304)},
439 {USB_DEVICE(0x0af0, 0x8400)},
440 {USB_DEVICE(0x0af0, 0x8600)},
441 {USB_DEVICE(0x0af0, 0x8800)},
442 {USB_DEVICE(0x0af0, 0x8900)},
443 {USB_DEVICE(0x0af0, 0x9000)},
444 {USB_DEVICE(0x0af0, 0x9200)}, /* Option GTM671WFS */
445 {USB_DEVICE(0x0af0, 0xd035)},
446 {USB_DEVICE(0x0af0, 0xd055)},
447 {USB_DEVICE(0x0af0, 0xd155)},
448 {USB_DEVICE(0x0af0, 0xd255)},
449 {USB_DEVICE(0x0af0, 0xd057)},
450 {USB_DEVICE(0x0af0, 0xd157)},
451 {USB_DEVICE(0x0af0, 0xd257)},
452 {USB_DEVICE(0x0af0, 0xd357)},
453 {USB_DEVICE(0x0af0, 0xd058)},
454 {USB_DEVICE(0x0af0, 0xc100)},
457 MODULE_DEVICE_TABLE(usb, hso_ids);
459 /* Sysfs attribute */
460 static ssize_t hso_sysfs_show_porttype(struct device *dev,
461 struct device_attribute *attr,
464 struct hso_device *hso_dev = dev_get_drvdata(dev);
470 switch (hso_dev->port_spec & HSO_PORT_MASK) {
471 case HSO_PORT_CONTROL:
472 port_name = "Control";
475 port_name = "Application";
478 port_name = "Application2";
483 case HSO_PORT_GPS_CONTROL:
484 port_name = "GPS Control";
490 port_name = "Diagnostic";
493 port_name = "Diagnostic2";
498 case HSO_PORT_NETWORK:
499 port_name = "Network";
502 port_name = "Unknown";
506 return sprintf(buf, "%s\n", port_name);
508 static DEVICE_ATTR(hsotype, 0444, hso_sysfs_show_porttype, NULL);
510 static struct attribute *hso_serial_dev_attrs[] = {
511 &dev_attr_hsotype.attr,
515 ATTRIBUTE_GROUPS(hso_serial_dev);
517 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
521 for (idx = 0; idx < serial->num_rx_urbs; idx++)
522 if (serial->rx_urb[idx] == urb)
524 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
528 /* converts mux value to a port spec value */
529 static u32 hso_mux_to_port(int mux)
535 result = HSO_PORT_CONTROL;
538 result = HSO_PORT_APP;
541 result = HSO_PORT_PCSC;
544 result = HSO_PORT_GPS;
547 result = HSO_PORT_APP2;
550 result = HSO_PORT_NO_PORT;
555 /* converts port spec value to a mux value */
556 static u32 hso_port_to_mux(int port)
560 switch (port & HSO_PORT_MASK) {
561 case HSO_PORT_CONTROL:
582 static struct hso_serial *get_serial_by_shared_int_and_type(
583 struct hso_shared_int *shared_int,
588 port = hso_mux_to_port(mux);
590 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
591 if (serial_table[i] &&
592 (dev2ser(serial_table[i])->shared_int == shared_int) &&
593 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
594 return dev2ser(serial_table[i]);
601 static struct hso_serial *get_serial_by_index(unsigned index)
603 struct hso_serial *serial = NULL;
606 spin_lock_irqsave(&serial_table_lock, flags);
607 if (serial_table[index])
608 serial = dev2ser(serial_table[index]);
609 spin_unlock_irqrestore(&serial_table_lock, flags);
614 static int get_free_serial_index(void)
619 spin_lock_irqsave(&serial_table_lock, flags);
620 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
621 if (serial_table[index] == NULL) {
622 spin_unlock_irqrestore(&serial_table_lock, flags);
626 spin_unlock_irqrestore(&serial_table_lock, flags);
628 pr_err("%s: no free serial devices in table\n", __func__);
632 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
636 spin_lock_irqsave(&serial_table_lock, flags);
638 serial_table[index] = serial->parent;
640 serial_table[index] = NULL;
641 spin_unlock_irqrestore(&serial_table_lock, flags);
644 static void handle_usb_error(int status, const char *function,
645 struct hso_device *hso_dev)
651 explanation = "no device";
654 explanation = "endpoint not enabled";
657 explanation = "endpoint stalled";
660 explanation = "not enough bandwidth";
663 explanation = "device disabled";
666 explanation = "device suspended";
672 explanation = "internal error";
678 explanation = "protocol error";
680 usb_queue_reset_device(hso_dev->interface);
683 explanation = "unknown status";
687 /* log a meaningful explanation of an USB status */
688 hso_dbg(0x1, "%s: received USB status - %s (%d)\n",
689 function, explanation, status);
692 /* Network interface functions */
694 /* called when net interface is brought up by ifconfig */
695 static int hso_net_open(struct net_device *net)
697 struct hso_net *odev = netdev_priv(net);
698 unsigned long flags = 0;
701 dev_err(&net->dev, "No net device !\n");
705 odev->skb_tx_buf = NULL;
707 /* setup environment */
708 spin_lock_irqsave(&odev->net_lock, flags);
709 odev->rx_parse_state = WAIT_IP;
710 odev->rx_buf_size = 0;
711 odev->rx_buf_missing = sizeof(struct iphdr);
712 spin_unlock_irqrestore(&odev->net_lock, flags);
714 /* We are up and running. */
715 set_bit(HSO_NET_RUNNING, &odev->flags);
716 hso_start_net_device(odev->parent);
718 /* Tell the kernel we are ready to start receiving from it */
719 netif_start_queue(net);
724 /* called when interface is brought down by ifconfig */
725 static int hso_net_close(struct net_device *net)
727 struct hso_net *odev = netdev_priv(net);
729 /* we don't need the queue anymore */
730 netif_stop_queue(net);
731 /* no longer running */
732 clear_bit(HSO_NET_RUNNING, &odev->flags);
734 hso_stop_net_device(odev->parent);
740 /* USB tells is xmit done, we should start the netqueue again */
741 static void write_bulk_callback(struct urb *urb)
743 struct hso_net *odev = urb->context;
744 int status = urb->status;
747 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
748 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
752 /* Do we still have a valid kernel network device? */
753 if (!netif_device_present(odev->net)) {
754 dev_err(&urb->dev->dev, "%s: net device not present\n",
759 /* log status, but don't act on it, we don't need to resubmit anything
762 handle_usb_error(status, __func__, odev->parent);
764 hso_put_activity(odev->parent);
766 /* Tell the network interface we are ready for another frame */
767 netif_wake_queue(odev->net);
770 /* called by kernel when we need to transmit a packet */
771 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
772 struct net_device *net)
774 struct hso_net *odev = netdev_priv(net);
777 /* Tell the kernel, "No more frames 'til we are done with this one." */
778 netif_stop_queue(net);
779 if (hso_get_activity(odev->parent) == -EAGAIN) {
780 odev->skb_tx_buf = skb;
785 DUMP1(skb->data, skb->len);
786 /* Copy it from kernel memory to OUR memory */
787 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
788 hso_dbg(0x1, "len: %d/%d\n", skb->len, MUX_BULK_TX_BUF_SIZE);
790 /* Fill in the URB for shipping it out. */
791 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
793 usb_sndbulkpipe(odev->parent->usb,
795 bEndpointAddress & 0x7F),
796 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
799 /* Deal with the Zero Length packet problem, I hope */
800 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
802 /* Send the URB on its merry way. */
803 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
805 dev_warn(&odev->parent->interface->dev,
806 "failed mux_bulk_tx_urb %d\n", result);
807 net->stats.tx_errors++;
808 netif_start_queue(net);
810 net->stats.tx_packets++;
811 net->stats.tx_bytes += skb->len;
818 static const struct ethtool_ops ops = {
819 .get_link = ethtool_op_get_link
822 /* called when a packet did not ack after watchdogtimeout */
823 static void hso_net_tx_timeout(struct net_device *net, unsigned int txqueue)
825 struct hso_net *odev = netdev_priv(net);
830 /* Tell syslog we are hosed. */
831 dev_warn(&net->dev, "Tx timed out.\n");
833 /* Tear the waiting frame off the list */
834 if (odev->mux_bulk_tx_urb &&
835 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
836 usb_unlink_urb(odev->mux_bulk_tx_urb);
838 /* Update statistics */
839 net->stats.tx_errors++;
842 /* make a real packet from the received USB buffer */
843 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
844 unsigned int count, unsigned char is_eop)
846 unsigned short temp_bytes;
847 unsigned short buffer_offset = 0;
848 unsigned short frame_len;
851 hso_dbg(0x1, "Rx %d bytes\n", count);
852 DUMP(ip_pkt, min(128, (int)count));
855 switch (odev->rx_parse_state) {
857 /* waiting for IP header. */
858 /* wanted bytes - size of ip header */
861 odev->rx_buf_missing) ? count : odev->
864 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
865 odev->rx_buf_size, ip_pkt + buffer_offset,
868 odev->rx_buf_size += temp_bytes;
869 buffer_offset += temp_bytes;
870 odev->rx_buf_missing -= temp_bytes;
873 if (!odev->rx_buf_missing) {
874 /* header is complete allocate an sk_buffer and
875 * continue to WAIT_DATA */
876 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
878 if ((frame_len > DEFAULT_MRU) ||
879 (frame_len < sizeof(struct iphdr))) {
880 dev_err(&odev->net->dev,
881 "Invalid frame (%d) length\n",
883 odev->rx_parse_state = WAIT_SYNC;
886 /* Allocate an sk_buff */
887 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
889 if (!odev->skb_rx_buf) {
890 /* We got no receive buffer. */
891 hso_dbg(0x1, "could not allocate memory\n");
892 odev->rx_parse_state = WAIT_SYNC;
896 /* Copy what we got so far. make room for iphdr
898 skb_put_data(odev->skb_rx_buf,
899 (char *)&(odev->rx_ip_hdr),
900 sizeof(struct iphdr));
903 odev->rx_buf_size = sizeof(struct iphdr);
905 /* Filip actually use .tot_len */
906 odev->rx_buf_missing =
907 frame_len - sizeof(struct iphdr);
908 odev->rx_parse_state = WAIT_DATA;
913 temp_bytes = (count < odev->rx_buf_missing)
914 ? count : odev->rx_buf_missing;
916 /* Copy the rest of the bytes that are left in the
917 * buffer into the waiting sk_buf. */
918 /* Make room for temp_bytes after tail. */
919 skb_put_data(odev->skb_rx_buf,
920 ip_pkt + buffer_offset,
923 odev->rx_buf_missing -= temp_bytes;
925 buffer_offset += temp_bytes;
926 odev->rx_buf_size += temp_bytes;
927 if (!odev->rx_buf_missing) {
928 /* Packet is complete. Inject into stack. */
929 /* We have IP packet here */
930 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
931 skb_reset_mac_header(odev->skb_rx_buf);
933 /* Ship it off to the kernel */
934 netif_rx(odev->skb_rx_buf);
935 /* No longer our buffer. */
936 odev->skb_rx_buf = NULL;
938 /* update out statistics */
939 odev->net->stats.rx_packets++;
941 odev->net->stats.rx_bytes += odev->rx_buf_size;
943 odev->rx_buf_size = 0;
944 odev->rx_buf_missing = sizeof(struct iphdr);
945 odev->rx_parse_state = WAIT_IP;
950 hso_dbg(0x1, " W_S\n");
960 /* Recovery mechanism for WAIT_SYNC state. */
962 if (odev->rx_parse_state == WAIT_SYNC) {
963 odev->rx_parse_state = WAIT_IP;
964 odev->rx_buf_size = 0;
965 odev->rx_buf_missing = sizeof(struct iphdr);
970 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size)
972 static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
973 u32 rest = urb->actual_length % le16_to_cpu(max_packet_size);
975 if (((rest == 5) || (rest == 6)) &&
976 !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4,
978 urb->actual_length -= 4;
982 /* Moving data from usb to kernel (in interrupt state) */
983 static void read_bulk_callback(struct urb *urb)
985 struct hso_net *odev = urb->context;
986 struct net_device *net;
989 int status = urb->status;
991 /* is al ok? (Filip: Who's Al ?) */
993 handle_usb_error(status, __func__, odev->parent);
998 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
999 hso_dbg(0x1, "BULK IN callback but driver is not active!\n");
1002 usb_mark_last_busy(urb->dev);
1006 if (!netif_device_present(net)) {
1007 /* Somebody killed our network interface... */
1011 if (odev->parent->port_spec & HSO_INFO_CRC_BUG)
1012 fix_crc_bug(urb, odev->in_endp->wMaxPacketSize);
1014 /* do we even have a packet? */
1015 if (urb->actual_length) {
1016 /* Handle the IP stream, add header and push it onto network
1017 * stack if the packet is complete. */
1018 spin_lock_irqsave(&odev->net_lock, flags);
1019 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1020 (urb->transfer_buffer_length >
1021 urb->actual_length) ? 1 : 0);
1022 spin_unlock_irqrestore(&odev->net_lock, flags);
1025 /* We are done with this URB, resubmit it. Prep the USB to wait for
1026 * another frame. Reuse same as received. */
1027 usb_fill_bulk_urb(urb,
1029 usb_rcvbulkpipe(odev->parent->usb,
1031 bEndpointAddress & 0x7F),
1032 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1033 read_bulk_callback, odev);
1035 /* Give this to the USB subsystem so it can tell us when more data
1037 result = usb_submit_urb(urb, GFP_ATOMIC);
1039 dev_warn(&odev->parent->interface->dev,
1040 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1044 /* Serial driver functions */
1046 static void hso_init_termios(struct ktermios *termios)
1049 * The default requirements for this device are:
1052 ~(IGNBRK /* disable ignore break */
1053 | BRKINT /* disable break causes interrupt */
1054 | PARMRK /* disable mark parity errors */
1055 | ISTRIP /* disable clear high bit of input characters */
1056 | INLCR /* disable translate NL to CR */
1057 | IGNCR /* disable ignore CR */
1058 | ICRNL /* disable translate CR to NL */
1059 | IXON); /* disable enable XON/XOFF flow control */
1061 /* disable postprocess output characters */
1062 termios->c_oflag &= ~OPOST;
1065 ~(ECHO /* disable echo input characters */
1066 | ECHONL /* disable echo new line */
1067 | ICANON /* disable erase, kill, werase, and rprnt
1068 special characters */
1069 | ISIG /* disable interrupt, quit, and suspend special
1071 | IEXTEN); /* disable non-POSIX special characters */
1074 ~(CSIZE /* no size */
1075 | PARENB /* disable parity bit */
1076 | CBAUD /* clear current baud rate */
1077 | CBAUDEX); /* clear current buad rate */
1079 termios->c_cflag |= CS8; /* character size 8 bits */
1081 /* baud rate 115200 */
1082 tty_termios_encode_baud_rate(termios, 115200, 115200);
1085 static void _hso_serial_set_termios(struct tty_struct *tty,
1086 struct ktermios *old)
1088 struct hso_serial *serial = tty->driver_data;
1091 pr_err("%s: no tty structures", __func__);
1095 hso_dbg(0x8, "port %d\n", serial->minor);
1098 * Fix up unsupported bits
1100 tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1102 tty->termios.c_cflag &=
1103 ~(CSIZE /* no size */
1104 | PARENB /* disable parity bit */
1105 | CBAUD /* clear current baud rate */
1106 | CBAUDEX); /* clear current buad rate */
1108 tty->termios.c_cflag |= CS8; /* character size 8 bits */
1110 /* baud rate 115200 */
1111 tty_encode_baud_rate(tty, 115200, 115200);
1114 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1117 /* We are done with this URB, resubmit it. Prep the USB to wait for
1119 usb_fill_bulk_urb(urb, serial->parent->usb,
1120 usb_rcvbulkpipe(serial->parent->usb,
1122 bEndpointAddress & 0x7F),
1123 urb->transfer_buffer, serial->rx_data_length,
1124 hso_std_serial_read_bulk_callback, serial);
1125 /* Give this to the USB subsystem so it can tell us when more data
1127 result = usb_submit_urb(urb, GFP_ATOMIC);
1129 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1137 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1140 struct urb *curr_urb;
1142 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1143 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1144 count = put_rxbuf_data(curr_urb, serial);
1148 serial->curr_rx_urb_idx++;
1149 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1150 serial->curr_rx_urb_idx = 0;
1151 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1156 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1161 urb = serial->rx_urb[0];
1162 if (serial->port.count > 0) {
1163 count = put_rxbuf_data(urb, serial);
1167 /* Re issue a read as long as we receive data. */
1169 if (count == 0 && ((urb->actual_length != 0) ||
1170 (serial->rx_state == RX_PENDING))) {
1171 serial->rx_state = RX_SENT;
1172 hso_mux_serial_read(serial);
1174 serial->rx_state = RX_IDLE;
1178 /* read callback for Diag and CS port */
1179 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1181 struct hso_serial *serial = urb->context;
1182 int status = urb->status;
1183 unsigned long flags;
1185 hso_dbg(0x8, "--- Got serial_read_bulk callback %02x ---\n", status);
1189 hso_dbg(0x1, "serial == NULL\n");
1193 handle_usb_error(status, __func__, serial->parent);
1197 hso_dbg(0x1, "Actual length = %d\n", urb->actual_length);
1198 DUMP1(urb->transfer_buffer, urb->actual_length);
1200 /* Anyone listening? */
1201 if (serial->port.count == 0)
1204 if (serial->parent->port_spec & HSO_INFO_CRC_BUG)
1205 fix_crc_bug(urb, serial->in_endp->wMaxPacketSize);
1206 /* Valid data, handle RX data */
1207 spin_lock_irqsave(&serial->serial_lock, flags);
1208 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1209 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1210 spin_unlock_irqrestore(&serial->serial_lock, flags);
1214 * This needs to be a tasklet otherwise we will
1215 * end up recursively calling this function.
1217 static void hso_unthrottle_tasklet(unsigned long data)
1219 struct hso_serial *serial = (struct hso_serial *)data;
1220 unsigned long flags;
1222 spin_lock_irqsave(&serial->serial_lock, flags);
1223 if ((serial->parent->port_spec & HSO_INTF_MUX))
1224 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1226 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1227 spin_unlock_irqrestore(&serial->serial_lock, flags);
1230 static void hso_unthrottle(struct tty_struct *tty)
1232 struct hso_serial *serial = tty->driver_data;
1234 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1237 /* open the requested serial port */
1238 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1240 struct hso_serial *serial = get_serial_by_index(tty->index);
1244 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1246 tty->driver_data = NULL;
1247 hso_dbg(0x1, "Failed to open port\n");
1251 mutex_lock(&serial->parent->mutex);
1252 result = usb_autopm_get_interface(serial->parent->interface);
1256 hso_dbg(0x1, "Opening %d\n", serial->minor);
1259 tty->driver_data = serial;
1260 tty_port_tty_set(&serial->port, tty);
1262 /* check for port already opened, if not set the termios */
1263 serial->port.count++;
1264 if (serial->port.count == 1) {
1265 serial->rx_state = RX_IDLE;
1266 /* Force default termio settings */
1267 _hso_serial_set_termios(tty, NULL);
1268 tasklet_init(&serial->unthrottle_tasklet,
1269 hso_unthrottle_tasklet,
1270 (unsigned long)serial);
1271 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1273 hso_stop_serial_device(serial->parent);
1274 serial->port.count--;
1276 kref_get(&serial->parent->ref);
1279 hso_dbg(0x1, "Port was already open\n");
1282 usb_autopm_put_interface(serial->parent->interface);
1286 hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0);
1288 mutex_unlock(&serial->parent->mutex);
1292 /* close the requested serial port */
1293 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1295 struct hso_serial *serial = tty->driver_data;
1298 hso_dbg(0x1, "Closing serial port\n");
1300 /* Open failed, no close cleanup required */
1304 mutex_lock(&serial->parent->mutex);
1305 usb_gone = serial->parent->usb_gone;
1308 usb_autopm_get_interface(serial->parent->interface);
1310 /* reset the rts and dtr */
1311 /* do the actual close */
1312 serial->port.count--;
1314 if (serial->port.count <= 0) {
1315 serial->port.count = 0;
1316 tty_port_tty_set(&serial->port, NULL);
1318 hso_stop_serial_device(serial->parent);
1319 tasklet_kill(&serial->unthrottle_tasklet);
1323 usb_autopm_put_interface(serial->parent->interface);
1325 mutex_unlock(&serial->parent->mutex);
1328 /* close the requested serial port */
1329 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1332 struct hso_serial *serial = tty->driver_data;
1333 int space, tx_bytes;
1334 unsigned long flags;
1337 if (serial == NULL) {
1338 pr_err("%s: serial is NULL\n", __func__);
1342 spin_lock_irqsave(&serial->serial_lock, flags);
1344 space = serial->tx_data_length - serial->tx_buffer_count;
1345 tx_bytes = (count < space) ? count : space;
1350 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1351 serial->tx_buffer_count += tx_bytes;
1354 spin_unlock_irqrestore(&serial->serial_lock, flags);
1356 hso_kick_transmit(serial);
1361 /* how much room is there for writing */
1362 static int hso_serial_write_room(struct tty_struct *tty)
1364 struct hso_serial *serial = tty->driver_data;
1366 unsigned long flags;
1368 spin_lock_irqsave(&serial->serial_lock, flags);
1369 room = serial->tx_data_length - serial->tx_buffer_count;
1370 spin_unlock_irqrestore(&serial->serial_lock, flags);
1372 /* return free room */
1376 static void hso_serial_cleanup(struct tty_struct *tty)
1378 struct hso_serial *serial = tty->driver_data;
1383 kref_put(&serial->parent->ref, hso_serial_ref_free);
1386 /* setup the term */
1387 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1389 struct hso_serial *serial = tty->driver_data;
1390 unsigned long flags;
1393 hso_dbg(0x16, "Termios called with: cflags new[%u] - old[%u]\n",
1394 (unsigned int)tty->termios.c_cflag,
1395 (unsigned int)old->c_cflag);
1397 /* the actual setup */
1398 spin_lock_irqsave(&serial->serial_lock, flags);
1399 if (serial->port.count)
1400 _hso_serial_set_termios(tty, old);
1402 tty->termios = *old;
1403 spin_unlock_irqrestore(&serial->serial_lock, flags);
1408 /* how many characters in the buffer */
1409 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1411 struct hso_serial *serial = tty->driver_data;
1413 unsigned long flags;
1419 spin_lock_irqsave(&serial->serial_lock, flags);
1420 chars = serial->tx_buffer_count;
1421 spin_unlock_irqrestore(&serial->serial_lock, flags);
1425 static int tiocmget_submit_urb(struct hso_serial *serial,
1426 struct hso_tiocmget *tiocmget,
1427 struct usb_device *usb)
1431 if (serial->parent->usb_gone)
1433 usb_fill_int_urb(tiocmget->urb, usb,
1436 bEndpointAddress & 0x7F),
1437 tiocmget->serial_state_notification,
1438 sizeof(struct hso_serial_state_notification),
1439 tiocmget_intr_callback, serial,
1440 tiocmget->endp->bInterval);
1441 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1443 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1450 static void tiocmget_intr_callback(struct urb *urb)
1452 struct hso_serial *serial = urb->context;
1453 struct hso_tiocmget *tiocmget;
1454 int status = urb->status;
1455 u16 UART_state_bitmap, prev_UART_state_bitmap;
1456 struct uart_icount *icount;
1457 struct hso_serial_state_notification *serial_state_notification;
1458 struct usb_device *usb;
1459 struct usb_interface *interface;
1466 handle_usb_error(status, __func__, serial->parent);
1470 /* tiocmget is only supported on HSO_PORT_MODEM */
1471 tiocmget = serial->tiocmget;
1474 BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1476 usb = serial->parent->usb;
1477 interface = serial->parent->interface;
1479 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1481 /* wIndex should be the USB interface number of the port to which the
1482 * notification applies, which should always be the Modem port.
1484 serial_state_notification = tiocmget->serial_state_notification;
1485 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1486 serial_state_notification->bNotification != B_NOTIFICATION ||
1487 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1488 le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1489 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1491 "hso received invalid serial state notification\n");
1492 DUMP(serial_state_notification,
1493 sizeof(struct hso_serial_state_notification));
1495 unsigned long flags;
1497 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1499 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1500 icount = &tiocmget->icount;
1501 spin_lock_irqsave(&serial->serial_lock, flags);
1502 if ((UART_state_bitmap & B_OVERRUN) !=
1503 (prev_UART_state_bitmap & B_OVERRUN))
1505 if ((UART_state_bitmap & B_PARITY) !=
1506 (prev_UART_state_bitmap & B_PARITY))
1508 if ((UART_state_bitmap & B_FRAMING) !=
1509 (prev_UART_state_bitmap & B_FRAMING))
1511 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1512 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1514 if ((UART_state_bitmap & B_BREAK) !=
1515 (prev_UART_state_bitmap & B_BREAK))
1517 if ((UART_state_bitmap & B_TX_CARRIER) !=
1518 (prev_UART_state_bitmap & B_TX_CARRIER))
1520 if ((UART_state_bitmap & B_RX_CARRIER) !=
1521 (prev_UART_state_bitmap & B_RX_CARRIER))
1523 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1524 spin_unlock_irqrestore(&serial->serial_lock, flags);
1525 tiocmget->intr_completed = 1;
1526 wake_up_interruptible(&tiocmget->waitq);
1528 memset(serial_state_notification, 0,
1529 sizeof(struct hso_serial_state_notification));
1530 tiocmget_submit_urb(serial,
1532 serial->parent->usb);
1536 * next few functions largely stolen from drivers/serial/serial_core.c
1538 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1539 * - mask passed in arg for lines of interest
1540 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1541 * Caller should use TIOCGICOUNT to see which one it was
1544 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1546 DECLARE_WAITQUEUE(wait, current);
1547 struct uart_icount cprev, cnow;
1548 struct hso_tiocmget *tiocmget;
1551 tiocmget = serial->tiocmget;
1555 * note the counters on entry
1557 spin_lock_irq(&serial->serial_lock);
1558 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1559 spin_unlock_irq(&serial->serial_lock);
1560 add_wait_queue(&tiocmget->waitq, &wait);
1562 spin_lock_irq(&serial->serial_lock);
1563 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1564 spin_unlock_irq(&serial->serial_lock);
1565 set_current_state(TASK_INTERRUPTIBLE);
1566 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1567 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1568 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1573 /* see if a signal did it */
1574 if (signal_pending(current)) {
1580 __set_current_state(TASK_RUNNING);
1581 remove_wait_queue(&tiocmget->waitq, &wait);
1587 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1588 * Return: write counters to the user passed counter struct
1589 * NB: both 1->0 and 0->1 transitions are counted except for
1590 * RI where only 0->1 is counted.
1592 static int hso_get_count(struct tty_struct *tty,
1593 struct serial_icounter_struct *icount)
1595 struct uart_icount cnow;
1596 struct hso_serial *serial = tty->driver_data;
1597 struct hso_tiocmget *tiocmget = serial->tiocmget;
1599 memset(icount, 0, sizeof(struct serial_icounter_struct));
1603 spin_lock_irq(&serial->serial_lock);
1604 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1605 spin_unlock_irq(&serial->serial_lock);
1607 icount->cts = cnow.cts;
1608 icount->dsr = cnow.dsr;
1609 icount->rng = cnow.rng;
1610 icount->dcd = cnow.dcd;
1611 icount->rx = cnow.rx;
1612 icount->tx = cnow.tx;
1613 icount->frame = cnow.frame;
1614 icount->overrun = cnow.overrun;
1615 icount->parity = cnow.parity;
1616 icount->brk = cnow.brk;
1617 icount->buf_overrun = cnow.buf_overrun;
1623 static int hso_serial_tiocmget(struct tty_struct *tty)
1626 struct hso_serial *serial = tty->driver_data;
1627 struct hso_tiocmget *tiocmget;
1628 u16 UART_state_bitmap;
1632 hso_dbg(0x1, "no tty structures\n");
1635 spin_lock_irq(&serial->serial_lock);
1636 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1637 ((serial->dtr_state) ? TIOCM_DTR : 0);
1638 tiocmget = serial->tiocmget;
1641 UART_state_bitmap = le16_to_cpu(
1642 tiocmget->prev_UART_state_bitmap);
1643 if (UART_state_bitmap & B_RING_SIGNAL)
1644 retval |= TIOCM_RNG;
1645 if (UART_state_bitmap & B_RX_CARRIER)
1647 if (UART_state_bitmap & B_TX_CARRIER)
1648 retval |= TIOCM_DSR;
1650 spin_unlock_irq(&serial->serial_lock);
1654 static int hso_serial_tiocmset(struct tty_struct *tty,
1655 unsigned int set, unsigned int clear)
1658 unsigned long flags;
1660 struct hso_serial *serial = tty->driver_data;
1661 struct usb_interface *interface;
1665 hso_dbg(0x1, "no tty structures\n");
1669 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1672 interface = serial->parent->interface;
1673 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1675 spin_lock_irqsave(&serial->serial_lock, flags);
1676 if (set & TIOCM_RTS)
1677 serial->rts_state = 1;
1678 if (set & TIOCM_DTR)
1679 serial->dtr_state = 1;
1681 if (clear & TIOCM_RTS)
1682 serial->rts_state = 0;
1683 if (clear & TIOCM_DTR)
1684 serial->dtr_state = 0;
1686 if (serial->dtr_state)
1688 if (serial->rts_state)
1691 spin_unlock_irqrestore(&serial->serial_lock, flags);
1693 return usb_control_msg(serial->parent->usb,
1694 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1695 0x21, val, if_num, NULL, 0,
1696 USB_CTRL_SET_TIMEOUT);
1699 static int hso_serial_ioctl(struct tty_struct *tty,
1700 unsigned int cmd, unsigned long arg)
1702 struct hso_serial *serial = tty->driver_data;
1704 hso_dbg(0x8, "IOCTL cmd: %d, arg: %ld\n", cmd, arg);
1710 ret = hso_wait_modem_status(serial, arg);
1720 /* starts a transmit */
1721 static void hso_kick_transmit(struct hso_serial *serial)
1723 unsigned long flags;
1726 spin_lock_irqsave(&serial->serial_lock, flags);
1727 if (!serial->tx_buffer_count)
1730 if (serial->tx_urb_used)
1733 /* Wakeup USB interface if necessary */
1734 if (hso_get_activity(serial->parent) == -EAGAIN)
1737 /* Switch pointers around to avoid memcpy */
1738 swap(serial->tx_buffer, serial->tx_data);
1739 serial->tx_data_count = serial->tx_buffer_count;
1740 serial->tx_buffer_count = 0;
1742 /* If serial->tx_data is set, it means we switched buffers */
1743 if (serial->tx_data && serial->write_data) {
1744 res = serial->write_data(serial);
1746 serial->tx_urb_used = 1;
1749 spin_unlock_irqrestore(&serial->serial_lock, flags);
1752 /* make a request (for reading and writing data to muxed serial port) */
1753 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1754 struct urb *ctrl_urb,
1755 struct usb_ctrlrequest *ctrl_req,
1756 u8 *ctrl_urb_data, u32 size)
1762 if (!serial || !ctrl_urb || !ctrl_req) {
1763 pr_err("%s: Wrong arguments\n", __func__);
1768 ctrl_req->wValue = 0;
1769 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1770 ctrl_req->wLength = cpu_to_le16(size);
1772 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1773 /* Reading command */
1774 ctrl_req->bRequestType = USB_DIR_IN |
1775 USB_TYPE_OPTION_VENDOR |
1776 USB_RECIP_INTERFACE;
1777 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1778 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1780 /* Writing command */
1781 ctrl_req->bRequestType = USB_DIR_OUT |
1782 USB_TYPE_OPTION_VENDOR |
1783 USB_RECIP_INTERFACE;
1784 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1785 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1788 hso_dbg(0x2, "%s command (%02x) len: %d, port: %d\n",
1789 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1790 ctrl_req->bRequestType, ctrl_req->wLength, port);
1793 ctrl_urb->transfer_flags = 0;
1794 usb_fill_control_urb(ctrl_urb,
1795 serial->parent->usb,
1798 ctrl_urb_data, size, ctrl_callback, serial);
1799 /* Send it on merry way */
1800 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1802 dev_err(&ctrl_urb->dev->dev,
1803 "%s failed submit ctrl_urb %d type %d\n", __func__,
1812 /* called by intr_callback when read occurs */
1813 static int hso_mux_serial_read(struct hso_serial *serial)
1819 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1820 /* make the request */
1822 if (serial->num_rx_urbs != 1) {
1823 dev_err(&serial->parent->interface->dev,
1824 "ERROR: mux'd reads with multiple buffers "
1828 return mux_device_request(serial,
1829 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1830 serial->parent->port_spec & HSO_PORT_MASK,
1832 &serial->ctrl_req_rx,
1833 serial->rx_data[0], serial->rx_data_length);
1836 /* used for muxed serial port callback (muxed serial read) */
1837 static void intr_callback(struct urb *urb)
1839 struct hso_shared_int *shared_int = urb->context;
1840 struct hso_serial *serial;
1841 unsigned char *port_req;
1842 int status = urb->status;
1843 unsigned long flags;
1846 usb_mark_last_busy(urb->dev);
1854 handle_usb_error(status, __func__, NULL);
1857 hso_dbg(0x8, "--- Got intr callback 0x%02X ---\n", status);
1860 port_req = urb->transfer_buffer;
1861 hso_dbg(0x8, "port_req = 0x%.2X\n", *port_req);
1862 /* loop over all muxed ports to find the one sending this */
1863 for (i = 0; i < 8; i++) {
1864 /* max 8 channels on MUX */
1865 if (*port_req & (1 << i)) {
1866 serial = get_serial_by_shared_int_and_type(shared_int,
1868 if (serial != NULL) {
1869 hso_dbg(0x1, "Pending read interrupt on port %d\n",
1871 spin_lock_irqsave(&serial->serial_lock, flags);
1872 if (serial->rx_state == RX_IDLE &&
1873 serial->port.count > 0) {
1874 /* Setup and send a ctrl req read on
1876 if (!serial->rx_urb_filled[0]) {
1877 serial->rx_state = RX_SENT;
1878 hso_mux_serial_read(serial);
1880 serial->rx_state = RX_PENDING;
1882 hso_dbg(0x1, "Already a read pending on port %d or port not open\n",
1885 spin_unlock_irqrestore(&serial->serial_lock,
1890 /* Resubmit interrupt urb */
1891 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1894 /* called for writing to muxed serial port */
1895 static int hso_mux_serial_write_data(struct hso_serial *serial)
1900 return mux_device_request(serial,
1901 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1902 serial->parent->port_spec & HSO_PORT_MASK,
1904 &serial->ctrl_req_tx,
1905 serial->tx_data, serial->tx_data_count);
1908 /* write callback for Diag and CS port */
1909 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1911 struct hso_serial *serial = urb->context;
1912 int status = urb->status;
1913 unsigned long flags;
1917 hso_dbg(0x1, "serial == NULL\n");
1921 spin_lock_irqsave(&serial->serial_lock, flags);
1922 serial->tx_urb_used = 0;
1923 spin_unlock_irqrestore(&serial->serial_lock, flags);
1925 handle_usb_error(status, __func__, serial->parent);
1928 hso_put_activity(serial->parent);
1929 tty_port_tty_wakeup(&serial->port);
1930 hso_kick_transmit(serial);
1935 /* called for writing diag or CS serial port */
1936 static int hso_std_serial_write_data(struct hso_serial *serial)
1938 int count = serial->tx_data_count;
1941 usb_fill_bulk_urb(serial->tx_urb,
1942 serial->parent->usb,
1943 usb_sndbulkpipe(serial->parent->usb,
1945 bEndpointAddress & 0x7F),
1946 serial->tx_data, serial->tx_data_count,
1947 hso_std_serial_write_bulk_callback, serial);
1949 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1951 dev_warn(&serial->parent->usb->dev,
1952 "Failed to submit urb - res %d\n", result);
1959 /* callback after read or write on muxed serial port */
1960 static void ctrl_callback(struct urb *urb)
1962 struct hso_serial *serial = urb->context;
1963 struct usb_ctrlrequest *req;
1964 int status = urb->status;
1965 unsigned long flags;
1971 spin_lock_irqsave(&serial->serial_lock, flags);
1972 serial->tx_urb_used = 0;
1973 spin_unlock_irqrestore(&serial->serial_lock, flags);
1975 handle_usb_error(status, __func__, serial->parent);
1980 req = (struct usb_ctrlrequest *)(urb->setup_packet);
1981 hso_dbg(0x8, "--- Got muxed ctrl callback 0x%02X ---\n", status);
1982 hso_dbg(0x8, "Actual length of urb = %d\n", urb->actual_length);
1983 DUMP1(urb->transfer_buffer, urb->actual_length);
1985 if (req->bRequestType ==
1986 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
1987 /* response to a read command */
1988 serial->rx_urb_filled[0] = 1;
1989 spin_lock_irqsave(&serial->serial_lock, flags);
1990 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1991 spin_unlock_irqrestore(&serial->serial_lock, flags);
1993 hso_put_activity(serial->parent);
1994 tty_port_tty_wakeup(&serial->port);
1995 /* response to a write command */
1996 hso_kick_transmit(serial);
2000 /* handle RX data for serial port */
2001 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2003 struct tty_struct *tty;
2007 if (urb == NULL || serial == NULL) {
2008 hso_dbg(0x1, "serial = NULL\n");
2012 tty = tty_port_tty_get(&serial->port);
2014 if (tty && tty_throttled(tty)) {
2019 /* Push data to tty */
2020 hso_dbg(0x1, "data to push to tty\n");
2021 count = tty_buffer_request_room(&serial->port, urb->actual_length);
2022 if (count >= urb->actual_length) {
2023 tty_insert_flip_string(&serial->port, urb->transfer_buffer,
2024 urb->actual_length);
2025 tty_flip_buffer_push(&serial->port);
2027 dev_warn(&serial->parent->usb->dev,
2028 "dropping data, %d bytes lost\n", urb->actual_length);
2033 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2039 /* Base driver functions */
2041 static void hso_log_port(struct hso_device *hso_dev)
2046 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2047 case HSO_PORT_CONTROL:
2048 port_type = "Control";
2051 port_type = "Application";
2056 case HSO_PORT_GPS_CONTROL:
2057 port_type = "GPS control";
2060 port_type = "Application2";
2066 port_type = "Diagnostic";
2068 case HSO_PORT_DIAG2:
2069 port_type = "Diagnostic2";
2071 case HSO_PORT_MODEM:
2072 port_type = "Modem";
2074 case HSO_PORT_NETWORK:
2075 port_type = "Network";
2078 port_type = "Unknown";
2081 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2082 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2084 sprintf(port_dev, "/dev/%s%d", tty_filename,
2085 dev2ser(hso_dev)->minor);
2087 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2088 port_type, port_dev);
2091 static int hso_start_net_device(struct hso_device *hso_dev)
2094 struct hso_net *hso_net = dev2net(hso_dev);
2099 /* send URBs for all read buffers */
2100 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2102 /* Prep a receive URB */
2103 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2105 usb_rcvbulkpipe(hso_dev->usb,
2107 bEndpointAddress & 0x7F),
2108 hso_net->mux_bulk_rx_buf_pool[i],
2109 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2112 /* Put it out there so the device can send us stuff */
2113 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2116 dev_warn(&hso_dev->usb->dev,
2117 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2124 static int hso_stop_net_device(struct hso_device *hso_dev)
2127 struct hso_net *hso_net = dev2net(hso_dev);
2132 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2133 if (hso_net->mux_bulk_rx_urb_pool[i])
2134 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2137 if (hso_net->mux_bulk_tx_urb)
2138 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2143 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2146 struct hso_serial *serial = dev2ser(hso_dev);
2151 /* If it is not the MUX port fill in and submit a bulk urb (already
2152 * allocated in hso_serial_start) */
2153 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2154 for (i = 0; i < serial->num_rx_urbs; i++) {
2155 usb_fill_bulk_urb(serial->rx_urb[i],
2156 serial->parent->usb,
2157 usb_rcvbulkpipe(serial->parent->usb,
2162 serial->rx_data_length,
2163 hso_std_serial_read_bulk_callback,
2165 result = usb_submit_urb(serial->rx_urb[i], flags);
2167 dev_warn(&serial->parent->usb->dev,
2168 "Failed to submit urb - res %d\n",
2174 mutex_lock(&serial->shared_int->shared_int_lock);
2175 if (!serial->shared_int->use_count) {
2177 hso_mux_submit_intr_urb(serial->shared_int,
2178 hso_dev->usb, flags);
2180 serial->shared_int->use_count++;
2181 mutex_unlock(&serial->shared_int->shared_int_lock);
2183 if (serial->tiocmget)
2184 tiocmget_submit_urb(serial,
2186 serial->parent->usb);
2190 static int hso_stop_serial_device(struct hso_device *hso_dev)
2193 struct hso_serial *serial = dev2ser(hso_dev);
2194 struct hso_tiocmget *tiocmget;
2199 for (i = 0; i < serial->num_rx_urbs; i++) {
2200 if (serial->rx_urb[i]) {
2201 usb_kill_urb(serial->rx_urb[i]);
2202 serial->rx_urb_filled[i] = 0;
2205 serial->curr_rx_urb_idx = 0;
2208 usb_kill_urb(serial->tx_urb);
2210 if (serial->shared_int) {
2211 mutex_lock(&serial->shared_int->shared_int_lock);
2212 if (serial->shared_int->use_count &&
2213 (--serial->shared_int->use_count == 0)) {
2216 urb = serial->shared_int->shared_intr_urb;
2220 mutex_unlock(&serial->shared_int->shared_int_lock);
2222 tiocmget = serial->tiocmget;
2224 wake_up_interruptible(&tiocmget->waitq);
2225 usb_kill_urb(tiocmget->urb);
2231 static void hso_serial_tty_unregister(struct hso_serial *serial)
2233 tty_unregister_device(tty_drv, serial->minor);
2236 static void hso_serial_common_free(struct hso_serial *serial)
2240 for (i = 0; i < serial->num_rx_urbs; i++) {
2241 /* unlink and free RX URB */
2242 usb_free_urb(serial->rx_urb[i]);
2243 /* free the RX buffer */
2244 kfree(serial->rx_data[i]);
2247 /* unlink and free TX URB */
2248 usb_free_urb(serial->tx_urb);
2249 kfree(serial->tx_buffer);
2250 kfree(serial->tx_data);
2251 tty_port_destroy(&serial->port);
2254 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2255 int rx_size, int tx_size)
2260 tty_port_init(&serial->port);
2262 minor = get_free_serial_index();
2266 /* register our minor number */
2267 serial->parent->dev = tty_port_register_device_attr(&serial->port,
2268 tty_drv, minor, &serial->parent->interface->dev,
2269 serial->parent, hso_serial_dev_groups);
2270 if (IS_ERR(serial->parent->dev))
2273 /* fill in specific data for later use */
2274 serial->minor = minor;
2275 serial->magic = HSO_SERIAL_MAGIC;
2276 spin_lock_init(&serial->serial_lock);
2277 serial->num_rx_urbs = num_urbs;
2279 /* RX, allocate urb and initialize */
2281 /* prepare our RX buffer */
2282 serial->rx_data_length = rx_size;
2283 for (i = 0; i < serial->num_rx_urbs; i++) {
2284 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2285 if (!serial->rx_urb[i])
2287 serial->rx_urb[i]->transfer_buffer = NULL;
2288 serial->rx_urb[i]->transfer_buffer_length = 0;
2289 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2291 if (!serial->rx_data[i])
2295 /* TX, allocate urb and initialize */
2296 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2297 if (!serial->tx_urb)
2299 serial->tx_urb->transfer_buffer = NULL;
2300 serial->tx_urb->transfer_buffer_length = 0;
2301 /* prepare our TX buffer */
2302 serial->tx_data_count = 0;
2303 serial->tx_buffer_count = 0;
2304 serial->tx_data_length = tx_size;
2305 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2306 if (!serial->tx_data)
2309 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2310 if (!serial->tx_buffer)
2315 hso_serial_tty_unregister(serial);
2317 hso_serial_common_free(serial);
2321 /* Creates a general hso device */
2322 static struct hso_device *hso_create_device(struct usb_interface *intf,
2325 struct hso_device *hso_dev;
2327 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2331 hso_dev->port_spec = port_spec;
2332 hso_dev->usb = interface_to_usbdev(intf);
2333 hso_dev->interface = intf;
2334 kref_init(&hso_dev->ref);
2335 mutex_init(&hso_dev->mutex);
2337 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2338 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2343 /* Removes a network device in the network device table */
2344 static int remove_net_device(struct hso_device *hso_dev)
2348 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2349 if (network_table[i] == hso_dev) {
2350 network_table[i] = NULL;
2354 if (i == HSO_MAX_NET_DEVICES)
2359 /* Frees our network device */
2360 static void hso_free_net_device(struct hso_device *hso_dev)
2363 struct hso_net *hso_net = dev2net(hso_dev);
2368 remove_net_device(hso_net->parent);
2371 unregister_netdev(hso_net->net);
2374 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2375 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2376 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2377 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2379 usb_free_urb(hso_net->mux_bulk_tx_urb);
2380 kfree(hso_net->mux_bulk_tx_buf);
2381 hso_net->mux_bulk_tx_buf = NULL;
2384 free_netdev(hso_net->net);
2389 static const struct net_device_ops hso_netdev_ops = {
2390 .ndo_open = hso_net_open,
2391 .ndo_stop = hso_net_close,
2392 .ndo_start_xmit = hso_net_start_xmit,
2393 .ndo_tx_timeout = hso_net_tx_timeout,
2396 /* initialize the network interface */
2397 static void hso_net_init(struct net_device *net)
2399 struct hso_net *hso_net = netdev_priv(net);
2401 hso_dbg(0x1, "sizeof hso_net is %zu\n", sizeof(*hso_net));
2403 /* fill in the other fields */
2404 net->netdev_ops = &hso_netdev_ops;
2405 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2406 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2407 net->type = ARPHRD_NONE;
2408 net->mtu = DEFAULT_MTU - 14;
2409 net->tx_queue_len = 10;
2410 net->ethtool_ops = &ops;
2412 /* and initialize the semaphore */
2413 spin_lock_init(&hso_net->net_lock);
2416 /* Adds a network device in the network device table */
2417 static int add_net_device(struct hso_device *hso_dev)
2421 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2422 if (network_table[i] == NULL) {
2423 network_table[i] = hso_dev;
2427 if (i == HSO_MAX_NET_DEVICES)
2432 static int hso_rfkill_set_block(void *data, bool blocked)
2434 struct hso_device *hso_dev = data;
2435 int enabled = !blocked;
2438 mutex_lock(&hso_dev->mutex);
2439 if (hso_dev->usb_gone)
2442 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2443 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2444 USB_CTRL_SET_TIMEOUT);
2445 mutex_unlock(&hso_dev->mutex);
2449 static const struct rfkill_ops hso_rfkill_ops = {
2450 .set_block = hso_rfkill_set_block,
2453 /* Creates and sets up everything for rfkill */
2454 static void hso_create_rfkill(struct hso_device *hso_dev,
2455 struct usb_interface *interface)
2457 struct hso_net *hso_net = dev2net(hso_dev);
2458 struct device *dev = &hso_net->net->dev;
2459 static u32 rfkill_counter;
2461 snprintf(hso_net->name, sizeof(hso_net->name), "hso-%d",
2464 hso_net->rfkill = rfkill_alloc(hso_net->name,
2465 &interface_to_usbdev(interface)->dev,
2467 &hso_rfkill_ops, hso_dev);
2468 if (!hso_net->rfkill) {
2469 dev_err(dev, "%s - Out of memory\n", __func__);
2472 if (rfkill_register(hso_net->rfkill) < 0) {
2473 rfkill_destroy(hso_net->rfkill);
2474 hso_net->rfkill = NULL;
2475 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2480 static struct device_type hso_type = {
2484 /* Creates our network device */
2485 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2489 struct net_device *net;
2490 struct hso_net *hso_net;
2491 struct hso_device *hso_dev;
2493 hso_dev = hso_create_device(interface, port_spec);
2497 /* allocate our network device, then we can put in our private data */
2498 /* call hso_net_init to do the basic initialization */
2499 net = alloc_netdev(sizeof(struct hso_net), "hso%d", NET_NAME_UNKNOWN,
2502 dev_err(&interface->dev, "Unable to create ethernet device\n");
2506 hso_net = netdev_priv(net);
2508 hso_dev->port_data.dev_net = hso_net;
2510 hso_net->parent = hso_dev;
2512 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2514 if (!hso_net->in_endp) {
2515 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2518 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2520 if (!hso_net->out_endp) {
2521 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2524 SET_NETDEV_DEV(net, &interface->dev);
2525 SET_NETDEV_DEVTYPE(net, &hso_type);
2527 /* start allocating */
2528 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2529 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2530 if (!hso_net->mux_bulk_rx_urb_pool[i])
2532 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2534 if (!hso_net->mux_bulk_rx_buf_pool[i])
2537 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2538 if (!hso_net->mux_bulk_tx_urb)
2540 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2541 if (!hso_net->mux_bulk_tx_buf)
2544 add_net_device(hso_dev);
2546 /* registering our net device */
2547 result = register_netdev(net);
2549 dev_err(&interface->dev, "Failed to register device\n");
2553 hso_log_port(hso_dev);
2555 hso_create_rfkill(hso_dev, interface);
2559 hso_free_net_device(hso_dev);
2563 static void hso_free_tiomget(struct hso_serial *serial)
2565 struct hso_tiocmget *tiocmget;
2568 tiocmget = serial->tiocmget;
2570 usb_free_urb(tiocmget->urb);
2571 tiocmget->urb = NULL;
2572 serial->tiocmget = NULL;
2573 kfree(tiocmget->serial_state_notification);
2574 tiocmget->serial_state_notification = NULL;
2579 /* Frees an AT channel ( goes for both mux and non-mux ) */
2580 static void hso_free_serial_device(struct hso_device *hso_dev)
2582 struct hso_serial *serial = dev2ser(hso_dev);
2587 hso_serial_common_free(serial);
2589 if (serial->shared_int) {
2590 mutex_lock(&serial->shared_int->shared_int_lock);
2591 if (--serial->shared_int->ref_count == 0)
2592 hso_free_shared_int(serial->shared_int);
2594 mutex_unlock(&serial->shared_int->shared_int_lock);
2596 hso_free_tiomget(serial);
2601 /* Creates a bulk AT channel */
2602 static struct hso_device *hso_create_bulk_serial_device(
2603 struct usb_interface *interface, int port)
2605 struct hso_device *hso_dev;
2606 struct hso_serial *serial;
2608 struct hso_tiocmget *tiocmget;
2610 hso_dev = hso_create_device(interface, port);
2614 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2618 serial->parent = hso_dev;
2619 hso_dev->port_data.dev_serial = serial;
2621 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2623 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2625 serial->tiocmget->serial_state_notification
2626 = kzalloc(sizeof(struct hso_serial_state_notification),
2628 /* it isn't going to break our heart if serial->tiocmget
2629 * allocation fails don't bother checking this.
2631 if (serial->tiocmget && serial->tiocmget->serial_state_notification) {
2632 tiocmget = serial->tiocmget;
2633 tiocmget->endp = hso_get_ep(interface,
2634 USB_ENDPOINT_XFER_INT,
2636 if (!tiocmget->endp) {
2637 dev_err(&interface->dev, "Failed to find INT IN ep\n");
2641 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2642 if (tiocmget->urb) {
2643 mutex_init(&tiocmget->mutex);
2644 init_waitqueue_head(&tiocmget->waitq);
2646 hso_free_tiomget(serial);
2652 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2656 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2658 if (!serial->in_endp) {
2659 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2665 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2666 dev_err(&interface->dev, "Failed to find BULK OUT ep\n");
2670 serial->write_data = hso_std_serial_write_data;
2672 /* and record this serial */
2673 set_serial_by_index(serial->minor, serial);
2675 /* setup the proc dirs and files if needed */
2676 hso_log_port(hso_dev);
2678 /* done, return it */
2682 hso_serial_tty_unregister(serial);
2683 hso_serial_common_free(serial);
2685 hso_free_tiomget(serial);
2691 /* Creates a multiplexed AT channel */
2693 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2695 struct hso_shared_int *mux)
2697 struct hso_device *hso_dev;
2698 struct hso_serial *serial;
2701 port_spec = HSO_INTF_MUX;
2702 port_spec &= ~HSO_PORT_MASK;
2704 port_spec |= hso_mux_to_port(port);
2705 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2708 hso_dev = hso_create_device(interface, port_spec);
2712 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2716 hso_dev->port_data.dev_serial = serial;
2717 serial->parent = hso_dev;
2719 if (hso_serial_common_create
2720 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2723 serial->tx_data_length--;
2724 serial->write_data = hso_mux_serial_write_data;
2726 serial->shared_int = mux;
2727 mutex_lock(&serial->shared_int->shared_int_lock);
2728 serial->shared_int->ref_count++;
2729 mutex_unlock(&serial->shared_int->shared_int_lock);
2731 /* and record this serial */
2732 set_serial_by_index(serial->minor, serial);
2734 /* setup the proc dirs and files if needed */
2735 hso_log_port(hso_dev);
2737 /* done, return it */
2742 tty_unregister_device(tty_drv, serial->minor);
2750 static void hso_free_shared_int(struct hso_shared_int *mux)
2752 usb_free_urb(mux->shared_intr_urb);
2753 kfree(mux->shared_intr_buf);
2754 mutex_unlock(&mux->shared_int_lock);
2759 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2761 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2766 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2768 if (!mux->intr_endp) {
2769 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2773 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2774 if (!mux->shared_intr_urb)
2776 mux->shared_intr_buf =
2777 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2779 if (!mux->shared_intr_buf)
2782 mutex_init(&mux->shared_int_lock);
2787 kfree(mux->shared_intr_buf);
2788 usb_free_urb(mux->shared_intr_urb);
2793 /* Gets the port spec for a certain interface */
2794 static int hso_get_config_data(struct usb_interface *interface)
2796 struct usb_device *usbdev = interface_to_usbdev(interface);
2797 u8 *config_data = kmalloc(17, GFP_KERNEL);
2798 u32 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2803 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2804 0x86, 0xC0, 0, 0, config_data, 17,
2805 USB_CTRL_SET_TIMEOUT) != 0x11) {
2810 /* check if we have a valid interface */
2816 switch (config_data[if_num]) {
2821 result = HSO_PORT_DIAG;
2824 result = HSO_PORT_GPS;
2827 result = HSO_PORT_GPS_CONTROL;
2830 result = HSO_PORT_APP;
2833 result = HSO_PORT_APP2;
2836 result = HSO_PORT_CONTROL;
2839 result = HSO_PORT_NETWORK;
2842 result = HSO_PORT_MODEM;
2845 result = HSO_PORT_MSD;
2848 result = HSO_PORT_PCSC;
2851 result = HSO_PORT_VOICE;
2858 result |= HSO_INTF_BULK;
2860 if (config_data[16] & 0x1)
2861 result |= HSO_INFO_CRC_BUG;
2867 /* called once for each interface upon device insertion */
2868 static int hso_probe(struct usb_interface *interface,
2869 const struct usb_device_id *id)
2871 int mux, i, if_num, port_spec;
2872 unsigned char port_mask;
2873 struct hso_device *hso_dev = NULL;
2874 struct hso_shared_int *shared_int;
2875 struct hso_device *tmp_dev = NULL;
2877 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2878 dev_err(&interface->dev, "Not our interface\n");
2882 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2884 /* Get the interface/port specification from either driver_info or from
2885 * the device itself */
2886 if (id->driver_info) {
2887 /* if_num is controlled by the device, driver_info is a 0 terminated
2888 * array. Make sure, the access is in bounds! */
2889 for (i = 0; i <= if_num; ++i)
2890 if (((u32 *)(id->driver_info))[i] == 0)
2892 port_spec = ((u32 *)(id->driver_info))[if_num];
2894 port_spec = hso_get_config_data(interface);
2899 /* Check if we need to switch to alt interfaces prior to port
2901 if (interface->num_altsetting > 1)
2902 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2903 interface->needs_remote_wakeup = 1;
2905 /* Allocate new hso device(s) */
2906 switch (port_spec & HSO_INTF_MASK) {
2908 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2909 /* Create the network device */
2911 hso_dev = hso_create_net_device(interface,
2919 if (hso_get_mux_ports(interface, &port_mask))
2920 /* TODO: de-allocate everything */
2923 shared_int = hso_create_shared_int(interface);
2927 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2928 if (port_mask & i) {
2929 hso_dev = hso_create_mux_serial_device(
2930 interface, i, shared_int);
2941 /* It's a regular bulk interface */
2942 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2945 hso_create_net_device(interface, port_spec);
2948 hso_create_bulk_serial_device(interface, port_spec);
2957 /* save our data pointer in this device */
2958 usb_set_intfdata(interface, hso_dev);
2963 hso_free_interface(interface);
2967 /* device removed, cleaning up */
2968 static void hso_disconnect(struct usb_interface *interface)
2970 hso_free_interface(interface);
2972 /* remove reference of our private data */
2973 usb_set_intfdata(interface, NULL);
2976 static void async_get_intf(struct work_struct *data)
2978 struct hso_device *hso_dev =
2979 container_of(data, struct hso_device, async_get_intf);
2980 usb_autopm_get_interface(hso_dev->interface);
2983 static void async_put_intf(struct work_struct *data)
2985 struct hso_device *hso_dev =
2986 container_of(data, struct hso_device, async_put_intf);
2987 usb_autopm_put_interface(hso_dev->interface);
2990 static int hso_get_activity(struct hso_device *hso_dev)
2992 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
2993 if (!hso_dev->is_active) {
2994 hso_dev->is_active = 1;
2995 schedule_work(&hso_dev->async_get_intf);
2999 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3002 usb_mark_last_busy(hso_dev->usb);
3007 static int hso_put_activity(struct hso_device *hso_dev)
3009 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3010 if (hso_dev->is_active) {
3011 hso_dev->is_active = 0;
3012 schedule_work(&hso_dev->async_put_intf);
3016 hso_dev->is_active = 0;
3020 /* called by kernel when we need to suspend device */
3021 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3025 /* Stop all serial ports */
3026 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3027 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3028 result = hso_stop_serial_device(serial_table[i]);
3034 /* Stop all network ports */
3035 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3036 if (network_table[i] &&
3037 (network_table[i]->interface == iface)) {
3038 result = hso_stop_net_device(network_table[i]);
3048 /* called by kernel when we need to resume device */
3049 static int hso_resume(struct usb_interface *iface)
3052 struct hso_net *hso_net;
3054 /* Start all serial ports */
3055 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3056 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3057 if (dev2ser(serial_table[i])->port.count) {
3059 hso_start_serial_device(serial_table[i], GFP_NOIO);
3060 hso_kick_transmit(dev2ser(serial_table[i]));
3067 /* Start all network ports */
3068 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3069 if (network_table[i] &&
3070 (network_table[i]->interface == iface)) {
3071 hso_net = dev2net(network_table[i]);
3072 if (hso_net->flags & IFF_UP) {
3073 /* First transmit any lingering data,
3074 then restart the device. */
3075 if (hso_net->skb_tx_buf) {
3076 dev_dbg(&iface->dev,
3078 " lingering data\n");
3079 hso_net_start_xmit(hso_net->skb_tx_buf,
3081 hso_net->skb_tx_buf = NULL;
3083 result = hso_start_net_device(network_table[i]);
3094 static void hso_serial_ref_free(struct kref *ref)
3096 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3098 hso_free_serial_device(hso_dev);
3101 static void hso_free_interface(struct usb_interface *interface)
3103 struct hso_serial *serial;
3106 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3107 if (serial_table[i] &&
3108 (serial_table[i]->interface == interface)) {
3109 serial = dev2ser(serial_table[i]);
3110 tty_port_tty_hangup(&serial->port, false);
3111 mutex_lock(&serial->parent->mutex);
3112 serial->parent->usb_gone = 1;
3113 mutex_unlock(&serial->parent->mutex);
3114 cancel_work_sync(&serial_table[i]->async_put_intf);
3115 cancel_work_sync(&serial_table[i]->async_get_intf);
3116 hso_serial_tty_unregister(serial);
3117 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3118 set_serial_by_index(i, NULL);
3122 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3123 if (network_table[i] &&
3124 (network_table[i]->interface == interface)) {
3125 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3126 /* hso_stop_net_device doesn't stop the net queue since
3127 * traffic needs to start it again when suspended */
3128 netif_stop_queue(dev2net(network_table[i])->net);
3129 hso_stop_net_device(network_table[i]);
3130 cancel_work_sync(&network_table[i]->async_put_intf);
3131 cancel_work_sync(&network_table[i]->async_get_intf);
3133 rfkill_unregister(rfk);
3134 rfkill_destroy(rfk);
3136 hso_free_net_device(network_table[i]);
3141 /* Helper functions */
3143 /* Get the endpoint ! */
3144 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3148 struct usb_host_interface *iface = intf->cur_altsetting;
3149 struct usb_endpoint_descriptor *endp;
3151 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3152 endp = &iface->endpoint[i].desc;
3153 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3154 (usb_endpoint_type(endp) == type))
3161 /* Get the byte that describes which ports are enabled */
3162 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3165 struct usb_host_interface *iface = intf->cur_altsetting;
3167 if (iface->extralen == 3) {
3168 *ports = iface->extra[2];
3172 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3173 if (iface->endpoint[i].extralen == 3) {
3174 *ports = iface->endpoint[i].extra[2];
3182 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3183 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3184 struct usb_device *usb, gfp_t gfp)
3188 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3190 shared_int->intr_endp->bEndpointAddress & 0x7F),
3191 shared_int->shared_intr_buf,
3193 intr_callback, shared_int,
3194 shared_int->intr_endp->bInterval);
3196 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3198 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3204 /* operations setup of the serial interface */
3205 static const struct tty_operations hso_serial_ops = {
3206 .open = hso_serial_open,
3207 .close = hso_serial_close,
3208 .write = hso_serial_write,
3209 .write_room = hso_serial_write_room,
3210 .cleanup = hso_serial_cleanup,
3211 .ioctl = hso_serial_ioctl,
3212 .set_termios = hso_serial_set_termios,
3213 .chars_in_buffer = hso_serial_chars_in_buffer,
3214 .tiocmget = hso_serial_tiocmget,
3215 .tiocmset = hso_serial_tiocmset,
3216 .get_icount = hso_get_count,
3217 .unthrottle = hso_unthrottle
3220 static struct usb_driver hso_driver = {
3221 .name = driver_name,
3223 .disconnect = hso_disconnect,
3224 .id_table = hso_ids,
3225 .suspend = hso_suspend,
3226 .resume = hso_resume,
3227 .reset_resume = hso_resume,
3228 .supports_autosuspend = 1,
3229 .disable_hub_initiated_lpm = 1,
3232 static int __init hso_init(void)
3237 /* put it in the log */
3238 pr_info("%s\n", version);
3240 /* Initialise the serial table semaphore and table */
3241 spin_lock_init(&serial_table_lock);
3242 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3243 serial_table[i] = NULL;
3245 /* allocate our driver using the proper amount of supported minors */
3246 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3250 /* fill in all needed values */
3251 tty_drv->driver_name = driver_name;
3252 tty_drv->name = tty_filename;
3254 /* if major number is provided as parameter, use that one */
3256 tty_drv->major = tty_major;
3258 tty_drv->minor_start = 0;
3259 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3260 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3261 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3262 tty_drv->init_termios = tty_std_termios;
3263 hso_init_termios(&tty_drv->init_termios);
3264 tty_set_operations(tty_drv, &hso_serial_ops);
3266 /* register the tty driver */
3267 result = tty_register_driver(tty_drv);
3269 pr_err("%s - tty_register_driver failed(%d)\n",
3274 /* register this module as an usb driver */
3275 result = usb_register(&hso_driver);
3277 pr_err("Could not register hso driver - error: %d\n", result);
3284 tty_unregister_driver(tty_drv);
3286 put_tty_driver(tty_drv);
3290 static void __exit hso_exit(void)
3292 pr_info("unloaded\n");
3294 tty_unregister_driver(tty_drv);
3295 /* deregister the usb driver */
3296 usb_deregister(&hso_driver);
3297 put_tty_driver(tty_drv);
3300 /* Module definitions */
3301 module_init(hso_init);
3302 module_exit(hso_exit);
3304 MODULE_AUTHOR(MOD_AUTHOR);
3305 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3306 MODULE_LICENSE("GPL");
3308 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3309 MODULE_PARM_DESC(debug, "debug level mask [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3310 module_param(debug, int, 0644);
3312 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3313 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3314 module_param(tty_major, int, 0644);
3316 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3317 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3318 module_param(disable_net, int, 0644);