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 usb_unlink_urb(odev->mux_bulk_tx_urb);
837 /* Update statistics */
838 net->stats.tx_errors++;
841 /* make a real packet from the received USB buffer */
842 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
843 unsigned int count, unsigned char is_eop)
845 unsigned short temp_bytes;
846 unsigned short buffer_offset = 0;
847 unsigned short frame_len;
850 hso_dbg(0x1, "Rx %d bytes\n", count);
851 DUMP(ip_pkt, min(128, (int)count));
854 switch (odev->rx_parse_state) {
856 /* waiting for IP header. */
857 /* wanted bytes - size of ip header */
860 odev->rx_buf_missing) ? count : odev->
863 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
864 odev->rx_buf_size, ip_pkt + buffer_offset,
867 odev->rx_buf_size += temp_bytes;
868 buffer_offset += temp_bytes;
869 odev->rx_buf_missing -= temp_bytes;
872 if (!odev->rx_buf_missing) {
873 /* header is complete allocate an sk_buffer and
874 * continue to WAIT_DATA */
875 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
877 if ((frame_len > DEFAULT_MRU) ||
878 (frame_len < sizeof(struct iphdr))) {
879 dev_err(&odev->net->dev,
880 "Invalid frame (%d) length\n",
882 odev->rx_parse_state = WAIT_SYNC;
885 /* Allocate an sk_buff */
886 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
888 if (!odev->skb_rx_buf) {
889 /* We got no receive buffer. */
890 hso_dbg(0x1, "could not allocate memory\n");
891 odev->rx_parse_state = WAIT_SYNC;
895 /* Copy what we got so far. make room for iphdr
897 skb_put_data(odev->skb_rx_buf,
898 (char *)&(odev->rx_ip_hdr),
899 sizeof(struct iphdr));
902 odev->rx_buf_size = sizeof(struct iphdr);
904 /* Filip actually use .tot_len */
905 odev->rx_buf_missing =
906 frame_len - sizeof(struct iphdr);
907 odev->rx_parse_state = WAIT_DATA;
912 temp_bytes = (count < odev->rx_buf_missing)
913 ? count : odev->rx_buf_missing;
915 /* Copy the rest of the bytes that are left in the
916 * buffer into the waiting sk_buf. */
917 /* Make room for temp_bytes after tail. */
918 skb_put_data(odev->skb_rx_buf,
919 ip_pkt + buffer_offset,
922 odev->rx_buf_missing -= temp_bytes;
924 buffer_offset += temp_bytes;
925 odev->rx_buf_size += temp_bytes;
926 if (!odev->rx_buf_missing) {
927 /* Packet is complete. Inject into stack. */
928 /* We have IP packet here */
929 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
930 skb_reset_mac_header(odev->skb_rx_buf);
932 /* Ship it off to the kernel */
933 netif_rx(odev->skb_rx_buf);
934 /* No longer our buffer. */
935 odev->skb_rx_buf = NULL;
937 /* update out statistics */
938 odev->net->stats.rx_packets++;
940 odev->net->stats.rx_bytes += odev->rx_buf_size;
942 odev->rx_buf_size = 0;
943 odev->rx_buf_missing = sizeof(struct iphdr);
944 odev->rx_parse_state = WAIT_IP;
949 hso_dbg(0x1, " W_S\n");
959 /* Recovery mechanism for WAIT_SYNC state. */
961 if (odev->rx_parse_state == WAIT_SYNC) {
962 odev->rx_parse_state = WAIT_IP;
963 odev->rx_buf_size = 0;
964 odev->rx_buf_missing = sizeof(struct iphdr);
969 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size)
971 static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
972 u32 rest = urb->actual_length % le16_to_cpu(max_packet_size);
974 if (((rest == 5) || (rest == 6)) &&
975 !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4,
977 urb->actual_length -= 4;
981 /* Moving data from usb to kernel (in interrupt state) */
982 static void read_bulk_callback(struct urb *urb)
984 struct hso_net *odev = urb->context;
985 struct net_device *net;
988 int status = urb->status;
990 /* is al ok? (Filip: Who's Al ?) */
992 handle_usb_error(status, __func__, odev->parent);
997 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
998 hso_dbg(0x1, "BULK IN callback but driver is not active!\n");
1001 usb_mark_last_busy(urb->dev);
1005 if (!netif_device_present(net)) {
1006 /* Somebody killed our network interface... */
1010 if (odev->parent->port_spec & HSO_INFO_CRC_BUG)
1011 fix_crc_bug(urb, odev->in_endp->wMaxPacketSize);
1013 /* do we even have a packet? */
1014 if (urb->actual_length) {
1015 /* Handle the IP stream, add header and push it onto network
1016 * stack if the packet is complete. */
1017 spin_lock_irqsave(&odev->net_lock, flags);
1018 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1019 (urb->transfer_buffer_length >
1020 urb->actual_length) ? 1 : 0);
1021 spin_unlock_irqrestore(&odev->net_lock, flags);
1024 /* We are done with this URB, resubmit it. Prep the USB to wait for
1025 * another frame. Reuse same as received. */
1026 usb_fill_bulk_urb(urb,
1028 usb_rcvbulkpipe(odev->parent->usb,
1030 bEndpointAddress & 0x7F),
1031 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1032 read_bulk_callback, odev);
1034 /* Give this to the USB subsystem so it can tell us when more data
1036 result = usb_submit_urb(urb, GFP_ATOMIC);
1038 dev_warn(&odev->parent->interface->dev,
1039 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1043 /* Serial driver functions */
1045 static void hso_init_termios(struct ktermios *termios)
1048 * The default requirements for this device are:
1051 ~(IGNBRK /* disable ignore break */
1052 | BRKINT /* disable break causes interrupt */
1053 | PARMRK /* disable mark parity errors */
1054 | ISTRIP /* disable clear high bit of input characters */
1055 | INLCR /* disable translate NL to CR */
1056 | IGNCR /* disable ignore CR */
1057 | ICRNL /* disable translate CR to NL */
1058 | IXON); /* disable enable XON/XOFF flow control */
1060 /* disable postprocess output characters */
1061 termios->c_oflag &= ~OPOST;
1064 ~(ECHO /* disable echo input characters */
1065 | ECHONL /* disable echo new line */
1066 | ICANON /* disable erase, kill, werase, and rprnt
1067 special characters */
1068 | ISIG /* disable interrupt, quit, and suspend special
1070 | IEXTEN); /* disable non-POSIX special characters */
1073 ~(CSIZE /* no size */
1074 | PARENB /* disable parity bit */
1075 | CBAUD /* clear current baud rate */
1076 | CBAUDEX); /* clear current buad rate */
1078 termios->c_cflag |= CS8; /* character size 8 bits */
1080 /* baud rate 115200 */
1081 tty_termios_encode_baud_rate(termios, 115200, 115200);
1084 static void _hso_serial_set_termios(struct tty_struct *tty,
1085 struct ktermios *old)
1087 struct hso_serial *serial = tty->driver_data;
1090 pr_err("%s: no tty structures", __func__);
1094 hso_dbg(0x8, "port %d\n", serial->minor);
1097 * Fix up unsupported bits
1099 tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1101 tty->termios.c_cflag &=
1102 ~(CSIZE /* no size */
1103 | PARENB /* disable parity bit */
1104 | CBAUD /* clear current baud rate */
1105 | CBAUDEX); /* clear current buad rate */
1107 tty->termios.c_cflag |= CS8; /* character size 8 bits */
1109 /* baud rate 115200 */
1110 tty_encode_baud_rate(tty, 115200, 115200);
1113 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1116 /* We are done with this URB, resubmit it. Prep the USB to wait for
1118 usb_fill_bulk_urb(urb, serial->parent->usb,
1119 usb_rcvbulkpipe(serial->parent->usb,
1121 bEndpointAddress & 0x7F),
1122 urb->transfer_buffer, serial->rx_data_length,
1123 hso_std_serial_read_bulk_callback, serial);
1124 /* Give this to the USB subsystem so it can tell us when more data
1126 result = usb_submit_urb(urb, GFP_ATOMIC);
1128 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1136 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1139 struct urb *curr_urb;
1141 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1142 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1143 count = put_rxbuf_data(curr_urb, serial);
1147 serial->curr_rx_urb_idx++;
1148 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1149 serial->curr_rx_urb_idx = 0;
1150 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1155 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1160 urb = serial->rx_urb[0];
1161 if (serial->port.count > 0) {
1162 count = put_rxbuf_data(urb, serial);
1166 /* Re issue a read as long as we receive data. */
1168 if (count == 0 && ((urb->actual_length != 0) ||
1169 (serial->rx_state == RX_PENDING))) {
1170 serial->rx_state = RX_SENT;
1171 hso_mux_serial_read(serial);
1173 serial->rx_state = RX_IDLE;
1177 /* read callback for Diag and CS port */
1178 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1180 struct hso_serial *serial = urb->context;
1181 int status = urb->status;
1182 unsigned long flags;
1184 hso_dbg(0x8, "--- Got serial_read_bulk callback %02x ---\n", status);
1188 hso_dbg(0x1, "serial == NULL\n");
1192 handle_usb_error(status, __func__, serial->parent);
1196 hso_dbg(0x1, "Actual length = %d\n", urb->actual_length);
1197 DUMP1(urb->transfer_buffer, urb->actual_length);
1199 /* Anyone listening? */
1200 if (serial->port.count == 0)
1203 if (serial->parent->port_spec & HSO_INFO_CRC_BUG)
1204 fix_crc_bug(urb, serial->in_endp->wMaxPacketSize);
1205 /* Valid data, handle RX data */
1206 spin_lock_irqsave(&serial->serial_lock, flags);
1207 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1208 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1209 spin_unlock_irqrestore(&serial->serial_lock, flags);
1213 * This needs to be a tasklet otherwise we will
1214 * end up recursively calling this function.
1216 static void hso_unthrottle_tasklet(unsigned long data)
1218 struct hso_serial *serial = (struct hso_serial *)data;
1219 unsigned long flags;
1221 spin_lock_irqsave(&serial->serial_lock, flags);
1222 if ((serial->parent->port_spec & HSO_INTF_MUX))
1223 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1225 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1226 spin_unlock_irqrestore(&serial->serial_lock, flags);
1229 static void hso_unthrottle(struct tty_struct *tty)
1231 struct hso_serial *serial = tty->driver_data;
1233 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1236 /* open the requested serial port */
1237 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1239 struct hso_serial *serial = get_serial_by_index(tty->index);
1243 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1245 tty->driver_data = NULL;
1246 hso_dbg(0x1, "Failed to open port\n");
1250 mutex_lock(&serial->parent->mutex);
1251 result = usb_autopm_get_interface(serial->parent->interface);
1255 hso_dbg(0x1, "Opening %d\n", serial->minor);
1258 tty->driver_data = serial;
1259 tty_port_tty_set(&serial->port, tty);
1261 /* check for port already opened, if not set the termios */
1262 serial->port.count++;
1263 if (serial->port.count == 1) {
1264 serial->rx_state = RX_IDLE;
1265 /* Force default termio settings */
1266 _hso_serial_set_termios(tty, NULL);
1267 tasklet_init(&serial->unthrottle_tasklet,
1268 hso_unthrottle_tasklet,
1269 (unsigned long)serial);
1270 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1272 hso_stop_serial_device(serial->parent);
1273 serial->port.count--;
1275 kref_get(&serial->parent->ref);
1278 hso_dbg(0x1, "Port was already open\n");
1281 usb_autopm_put_interface(serial->parent->interface);
1285 hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0);
1287 mutex_unlock(&serial->parent->mutex);
1291 /* close the requested serial port */
1292 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1294 struct hso_serial *serial = tty->driver_data;
1297 hso_dbg(0x1, "Closing serial port\n");
1299 /* Open failed, no close cleanup required */
1303 mutex_lock(&serial->parent->mutex);
1304 usb_gone = serial->parent->usb_gone;
1307 usb_autopm_get_interface(serial->parent->interface);
1309 /* reset the rts and dtr */
1310 /* do the actual close */
1311 serial->port.count--;
1313 if (serial->port.count <= 0) {
1314 serial->port.count = 0;
1315 tty_port_tty_set(&serial->port, NULL);
1317 hso_stop_serial_device(serial->parent);
1318 tasklet_kill(&serial->unthrottle_tasklet);
1322 usb_autopm_put_interface(serial->parent->interface);
1324 mutex_unlock(&serial->parent->mutex);
1327 /* close the requested serial port */
1328 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1331 struct hso_serial *serial = tty->driver_data;
1332 int space, tx_bytes;
1333 unsigned long flags;
1336 if (serial == NULL) {
1337 pr_err("%s: serial is NULL\n", __func__);
1341 spin_lock_irqsave(&serial->serial_lock, flags);
1343 space = serial->tx_data_length - serial->tx_buffer_count;
1344 tx_bytes = (count < space) ? count : space;
1349 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1350 serial->tx_buffer_count += tx_bytes;
1353 spin_unlock_irqrestore(&serial->serial_lock, flags);
1355 hso_kick_transmit(serial);
1360 /* how much room is there for writing */
1361 static int hso_serial_write_room(struct tty_struct *tty)
1363 struct hso_serial *serial = tty->driver_data;
1365 unsigned long flags;
1367 spin_lock_irqsave(&serial->serial_lock, flags);
1368 room = serial->tx_data_length - serial->tx_buffer_count;
1369 spin_unlock_irqrestore(&serial->serial_lock, flags);
1371 /* return free room */
1375 static void hso_serial_cleanup(struct tty_struct *tty)
1377 struct hso_serial *serial = tty->driver_data;
1382 kref_put(&serial->parent->ref, hso_serial_ref_free);
1385 /* setup the term */
1386 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1388 struct hso_serial *serial = tty->driver_data;
1389 unsigned long flags;
1392 hso_dbg(0x16, "Termios called with: cflags new[%u] - old[%u]\n",
1393 (unsigned int)tty->termios.c_cflag,
1394 (unsigned int)old->c_cflag);
1396 /* the actual setup */
1397 spin_lock_irqsave(&serial->serial_lock, flags);
1398 if (serial->port.count)
1399 _hso_serial_set_termios(tty, old);
1401 tty->termios = *old;
1402 spin_unlock_irqrestore(&serial->serial_lock, flags);
1407 /* how many characters in the buffer */
1408 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1410 struct hso_serial *serial = tty->driver_data;
1412 unsigned long flags;
1418 spin_lock_irqsave(&serial->serial_lock, flags);
1419 chars = serial->tx_buffer_count;
1420 spin_unlock_irqrestore(&serial->serial_lock, flags);
1424 static int tiocmget_submit_urb(struct hso_serial *serial,
1425 struct hso_tiocmget *tiocmget,
1426 struct usb_device *usb)
1430 if (serial->parent->usb_gone)
1432 usb_fill_int_urb(tiocmget->urb, usb,
1435 bEndpointAddress & 0x7F),
1436 tiocmget->serial_state_notification,
1437 sizeof(struct hso_serial_state_notification),
1438 tiocmget_intr_callback, serial,
1439 tiocmget->endp->bInterval);
1440 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1442 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1449 static void tiocmget_intr_callback(struct urb *urb)
1451 struct hso_serial *serial = urb->context;
1452 struct hso_tiocmget *tiocmget;
1453 int status = urb->status;
1454 u16 UART_state_bitmap, prev_UART_state_bitmap;
1455 struct uart_icount *icount;
1456 struct hso_serial_state_notification *serial_state_notification;
1457 struct usb_device *usb;
1458 struct usb_interface *interface;
1465 handle_usb_error(status, __func__, serial->parent);
1469 /* tiocmget is only supported on HSO_PORT_MODEM */
1470 tiocmget = serial->tiocmget;
1473 BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1475 usb = serial->parent->usb;
1476 interface = serial->parent->interface;
1478 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1480 /* wIndex should be the USB interface number of the port to which the
1481 * notification applies, which should always be the Modem port.
1483 serial_state_notification = tiocmget->serial_state_notification;
1484 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1485 serial_state_notification->bNotification != B_NOTIFICATION ||
1486 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1487 le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1488 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1490 "hso received invalid serial state notification\n");
1491 DUMP(serial_state_notification,
1492 sizeof(struct hso_serial_state_notification));
1494 unsigned long flags;
1496 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1498 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1499 icount = &tiocmget->icount;
1500 spin_lock_irqsave(&serial->serial_lock, flags);
1501 if ((UART_state_bitmap & B_OVERRUN) !=
1502 (prev_UART_state_bitmap & B_OVERRUN))
1504 if ((UART_state_bitmap & B_PARITY) !=
1505 (prev_UART_state_bitmap & B_PARITY))
1507 if ((UART_state_bitmap & B_FRAMING) !=
1508 (prev_UART_state_bitmap & B_FRAMING))
1510 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1511 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1513 if ((UART_state_bitmap & B_BREAK) !=
1514 (prev_UART_state_bitmap & B_BREAK))
1516 if ((UART_state_bitmap & B_TX_CARRIER) !=
1517 (prev_UART_state_bitmap & B_TX_CARRIER))
1519 if ((UART_state_bitmap & B_RX_CARRIER) !=
1520 (prev_UART_state_bitmap & B_RX_CARRIER))
1522 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1523 spin_unlock_irqrestore(&serial->serial_lock, flags);
1524 tiocmget->intr_completed = 1;
1525 wake_up_interruptible(&tiocmget->waitq);
1527 memset(serial_state_notification, 0,
1528 sizeof(struct hso_serial_state_notification));
1529 tiocmget_submit_urb(serial,
1531 serial->parent->usb);
1535 * next few functions largely stolen from drivers/serial/serial_core.c
1537 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1538 * - mask passed in arg for lines of interest
1539 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1540 * Caller should use TIOCGICOUNT to see which one it was
1543 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1545 DECLARE_WAITQUEUE(wait, current);
1546 struct uart_icount cprev, cnow;
1547 struct hso_tiocmget *tiocmget;
1550 tiocmget = serial->tiocmget;
1554 * note the counters on entry
1556 spin_lock_irq(&serial->serial_lock);
1557 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1558 spin_unlock_irq(&serial->serial_lock);
1559 add_wait_queue(&tiocmget->waitq, &wait);
1561 spin_lock_irq(&serial->serial_lock);
1562 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1563 spin_unlock_irq(&serial->serial_lock);
1564 set_current_state(TASK_INTERRUPTIBLE);
1565 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1566 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1567 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1572 /* see if a signal did it */
1573 if (signal_pending(current)) {
1579 __set_current_state(TASK_RUNNING);
1580 remove_wait_queue(&tiocmget->waitq, &wait);
1586 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1587 * Return: write counters to the user passed counter struct
1588 * NB: both 1->0 and 0->1 transitions are counted except for
1589 * RI where only 0->1 is counted.
1591 static int hso_get_count(struct tty_struct *tty,
1592 struct serial_icounter_struct *icount)
1594 struct uart_icount cnow;
1595 struct hso_serial *serial = tty->driver_data;
1596 struct hso_tiocmget *tiocmget = serial->tiocmget;
1598 memset(icount, 0, sizeof(struct serial_icounter_struct));
1602 spin_lock_irq(&serial->serial_lock);
1603 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1604 spin_unlock_irq(&serial->serial_lock);
1606 icount->cts = cnow.cts;
1607 icount->dsr = cnow.dsr;
1608 icount->rng = cnow.rng;
1609 icount->dcd = cnow.dcd;
1610 icount->rx = cnow.rx;
1611 icount->tx = cnow.tx;
1612 icount->frame = cnow.frame;
1613 icount->overrun = cnow.overrun;
1614 icount->parity = cnow.parity;
1615 icount->brk = cnow.brk;
1616 icount->buf_overrun = cnow.buf_overrun;
1622 static int hso_serial_tiocmget(struct tty_struct *tty)
1625 struct hso_serial *serial = tty->driver_data;
1626 struct hso_tiocmget *tiocmget;
1627 u16 UART_state_bitmap;
1631 hso_dbg(0x1, "no tty structures\n");
1634 spin_lock_irq(&serial->serial_lock);
1635 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1636 ((serial->dtr_state) ? TIOCM_DTR : 0);
1637 tiocmget = serial->tiocmget;
1640 UART_state_bitmap = le16_to_cpu(
1641 tiocmget->prev_UART_state_bitmap);
1642 if (UART_state_bitmap & B_RING_SIGNAL)
1643 retval |= TIOCM_RNG;
1644 if (UART_state_bitmap & B_RX_CARRIER)
1646 if (UART_state_bitmap & B_TX_CARRIER)
1647 retval |= TIOCM_DSR;
1649 spin_unlock_irq(&serial->serial_lock);
1653 static int hso_serial_tiocmset(struct tty_struct *tty,
1654 unsigned int set, unsigned int clear)
1657 unsigned long flags;
1659 struct hso_serial *serial = tty->driver_data;
1660 struct usb_interface *interface;
1664 hso_dbg(0x1, "no tty structures\n");
1668 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1671 interface = serial->parent->interface;
1672 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1674 spin_lock_irqsave(&serial->serial_lock, flags);
1675 if (set & TIOCM_RTS)
1676 serial->rts_state = 1;
1677 if (set & TIOCM_DTR)
1678 serial->dtr_state = 1;
1680 if (clear & TIOCM_RTS)
1681 serial->rts_state = 0;
1682 if (clear & TIOCM_DTR)
1683 serial->dtr_state = 0;
1685 if (serial->dtr_state)
1687 if (serial->rts_state)
1690 spin_unlock_irqrestore(&serial->serial_lock, flags);
1692 return usb_control_msg(serial->parent->usb,
1693 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1694 0x21, val, if_num, NULL, 0,
1695 USB_CTRL_SET_TIMEOUT);
1698 static int hso_serial_ioctl(struct tty_struct *tty,
1699 unsigned int cmd, unsigned long arg)
1701 struct hso_serial *serial = tty->driver_data;
1703 hso_dbg(0x8, "IOCTL cmd: %d, arg: %ld\n", cmd, arg);
1709 ret = hso_wait_modem_status(serial, arg);
1719 /* starts a transmit */
1720 static void hso_kick_transmit(struct hso_serial *serial)
1722 unsigned long flags;
1725 spin_lock_irqsave(&serial->serial_lock, flags);
1726 if (!serial->tx_buffer_count)
1729 if (serial->tx_urb_used)
1732 /* Wakeup USB interface if necessary */
1733 if (hso_get_activity(serial->parent) == -EAGAIN)
1736 /* Switch pointers around to avoid memcpy */
1737 swap(serial->tx_buffer, serial->tx_data);
1738 serial->tx_data_count = serial->tx_buffer_count;
1739 serial->tx_buffer_count = 0;
1741 /* If serial->tx_data is set, it means we switched buffers */
1742 if (serial->tx_data && serial->write_data) {
1743 res = serial->write_data(serial);
1745 serial->tx_urb_used = 1;
1748 spin_unlock_irqrestore(&serial->serial_lock, flags);
1751 /* make a request (for reading and writing data to muxed serial port) */
1752 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1753 struct urb *ctrl_urb,
1754 struct usb_ctrlrequest *ctrl_req,
1755 u8 *ctrl_urb_data, u32 size)
1761 if (!serial || !ctrl_urb || !ctrl_req) {
1762 pr_err("%s: Wrong arguments\n", __func__);
1767 ctrl_req->wValue = 0;
1768 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1769 ctrl_req->wLength = cpu_to_le16(size);
1771 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1772 /* Reading command */
1773 ctrl_req->bRequestType = USB_DIR_IN |
1774 USB_TYPE_OPTION_VENDOR |
1775 USB_RECIP_INTERFACE;
1776 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1777 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1779 /* Writing command */
1780 ctrl_req->bRequestType = USB_DIR_OUT |
1781 USB_TYPE_OPTION_VENDOR |
1782 USB_RECIP_INTERFACE;
1783 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1784 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1787 hso_dbg(0x2, "%s command (%02x) len: %d, port: %d\n",
1788 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1789 ctrl_req->bRequestType, ctrl_req->wLength, port);
1792 ctrl_urb->transfer_flags = 0;
1793 usb_fill_control_urb(ctrl_urb,
1794 serial->parent->usb,
1797 ctrl_urb_data, size, ctrl_callback, serial);
1798 /* Send it on merry way */
1799 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1801 dev_err(&ctrl_urb->dev->dev,
1802 "%s failed submit ctrl_urb %d type %d\n", __func__,
1811 /* called by intr_callback when read occurs */
1812 static int hso_mux_serial_read(struct hso_serial *serial)
1818 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1819 /* make the request */
1821 if (serial->num_rx_urbs != 1) {
1822 dev_err(&serial->parent->interface->dev,
1823 "ERROR: mux'd reads with multiple buffers "
1827 return mux_device_request(serial,
1828 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1829 serial->parent->port_spec & HSO_PORT_MASK,
1831 &serial->ctrl_req_rx,
1832 serial->rx_data[0], serial->rx_data_length);
1835 /* used for muxed serial port callback (muxed serial read) */
1836 static void intr_callback(struct urb *urb)
1838 struct hso_shared_int *shared_int = urb->context;
1839 struct hso_serial *serial;
1840 unsigned char *port_req;
1841 int status = urb->status;
1842 unsigned long flags;
1845 usb_mark_last_busy(urb->dev);
1853 handle_usb_error(status, __func__, NULL);
1856 hso_dbg(0x8, "--- Got intr callback 0x%02X ---\n", status);
1859 port_req = urb->transfer_buffer;
1860 hso_dbg(0x8, "port_req = 0x%.2X\n", *port_req);
1861 /* loop over all muxed ports to find the one sending this */
1862 for (i = 0; i < 8; i++) {
1863 /* max 8 channels on MUX */
1864 if (*port_req & (1 << i)) {
1865 serial = get_serial_by_shared_int_and_type(shared_int,
1867 if (serial != NULL) {
1868 hso_dbg(0x1, "Pending read interrupt on port %d\n",
1870 spin_lock_irqsave(&serial->serial_lock, flags);
1871 if (serial->rx_state == RX_IDLE &&
1872 serial->port.count > 0) {
1873 /* Setup and send a ctrl req read on
1875 if (!serial->rx_urb_filled[0]) {
1876 serial->rx_state = RX_SENT;
1877 hso_mux_serial_read(serial);
1879 serial->rx_state = RX_PENDING;
1881 hso_dbg(0x1, "Already a read pending on port %d or port not open\n",
1884 spin_unlock_irqrestore(&serial->serial_lock,
1889 /* Resubmit interrupt urb */
1890 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1893 /* called for writing to muxed serial port */
1894 static int hso_mux_serial_write_data(struct hso_serial *serial)
1899 return mux_device_request(serial,
1900 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1901 serial->parent->port_spec & HSO_PORT_MASK,
1903 &serial->ctrl_req_tx,
1904 serial->tx_data, serial->tx_data_count);
1907 /* write callback for Diag and CS port */
1908 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1910 struct hso_serial *serial = urb->context;
1911 int status = urb->status;
1912 unsigned long flags;
1916 hso_dbg(0x1, "serial == NULL\n");
1920 spin_lock_irqsave(&serial->serial_lock, flags);
1921 serial->tx_urb_used = 0;
1922 spin_unlock_irqrestore(&serial->serial_lock, flags);
1924 handle_usb_error(status, __func__, serial->parent);
1927 hso_put_activity(serial->parent);
1928 tty_port_tty_wakeup(&serial->port);
1929 hso_kick_transmit(serial);
1934 /* called for writing diag or CS serial port */
1935 static int hso_std_serial_write_data(struct hso_serial *serial)
1937 int count = serial->tx_data_count;
1940 usb_fill_bulk_urb(serial->tx_urb,
1941 serial->parent->usb,
1942 usb_sndbulkpipe(serial->parent->usb,
1944 bEndpointAddress & 0x7F),
1945 serial->tx_data, serial->tx_data_count,
1946 hso_std_serial_write_bulk_callback, serial);
1948 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1950 dev_warn(&serial->parent->usb->dev,
1951 "Failed to submit urb - res %d\n", result);
1958 /* callback after read or write on muxed serial port */
1959 static void ctrl_callback(struct urb *urb)
1961 struct hso_serial *serial = urb->context;
1962 struct usb_ctrlrequest *req;
1963 int status = urb->status;
1964 unsigned long flags;
1970 spin_lock_irqsave(&serial->serial_lock, flags);
1971 serial->tx_urb_used = 0;
1972 spin_unlock_irqrestore(&serial->serial_lock, flags);
1974 handle_usb_error(status, __func__, serial->parent);
1979 req = (struct usb_ctrlrequest *)(urb->setup_packet);
1980 hso_dbg(0x8, "--- Got muxed ctrl callback 0x%02X ---\n", status);
1981 hso_dbg(0x8, "Actual length of urb = %d\n", urb->actual_length);
1982 DUMP1(urb->transfer_buffer, urb->actual_length);
1984 if (req->bRequestType ==
1985 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
1986 /* response to a read command */
1987 serial->rx_urb_filled[0] = 1;
1988 spin_lock_irqsave(&serial->serial_lock, flags);
1989 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1990 spin_unlock_irqrestore(&serial->serial_lock, flags);
1992 hso_put_activity(serial->parent);
1993 tty_port_tty_wakeup(&serial->port);
1994 /* response to a write command */
1995 hso_kick_transmit(serial);
1999 /* handle RX data for serial port */
2000 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2002 struct tty_struct *tty;
2006 if (urb == NULL || serial == NULL) {
2007 hso_dbg(0x1, "serial = NULL\n");
2011 tty = tty_port_tty_get(&serial->port);
2013 if (tty && tty_throttled(tty)) {
2018 /* Push data to tty */
2019 hso_dbg(0x1, "data to push to tty\n");
2020 count = tty_buffer_request_room(&serial->port, urb->actual_length);
2021 if (count >= urb->actual_length) {
2022 tty_insert_flip_string(&serial->port, urb->transfer_buffer,
2023 urb->actual_length);
2024 tty_flip_buffer_push(&serial->port);
2026 dev_warn(&serial->parent->usb->dev,
2027 "dropping data, %d bytes lost\n", urb->actual_length);
2032 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2038 /* Base driver functions */
2040 static void hso_log_port(struct hso_device *hso_dev)
2045 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2046 case HSO_PORT_CONTROL:
2047 port_type = "Control";
2050 port_type = "Application";
2055 case HSO_PORT_GPS_CONTROL:
2056 port_type = "GPS control";
2059 port_type = "Application2";
2065 port_type = "Diagnostic";
2067 case HSO_PORT_DIAG2:
2068 port_type = "Diagnostic2";
2070 case HSO_PORT_MODEM:
2071 port_type = "Modem";
2073 case HSO_PORT_NETWORK:
2074 port_type = "Network";
2077 port_type = "Unknown";
2080 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2081 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2083 sprintf(port_dev, "/dev/%s%d", tty_filename,
2084 dev2ser(hso_dev)->minor);
2086 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2087 port_type, port_dev);
2090 static int hso_start_net_device(struct hso_device *hso_dev)
2093 struct hso_net *hso_net = dev2net(hso_dev);
2098 /* send URBs for all read buffers */
2099 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2101 /* Prep a receive URB */
2102 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2104 usb_rcvbulkpipe(hso_dev->usb,
2106 bEndpointAddress & 0x7F),
2107 hso_net->mux_bulk_rx_buf_pool[i],
2108 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2111 /* Put it out there so the device can send us stuff */
2112 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2115 dev_warn(&hso_dev->usb->dev,
2116 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2123 static int hso_stop_net_device(struct hso_device *hso_dev)
2126 struct hso_net *hso_net = dev2net(hso_dev);
2131 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2132 if (hso_net->mux_bulk_rx_urb_pool[i])
2133 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2136 if (hso_net->mux_bulk_tx_urb)
2137 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2142 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2145 struct hso_serial *serial = dev2ser(hso_dev);
2150 /* If it is not the MUX port fill in and submit a bulk urb (already
2151 * allocated in hso_serial_start) */
2152 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2153 for (i = 0; i < serial->num_rx_urbs; i++) {
2154 usb_fill_bulk_urb(serial->rx_urb[i],
2155 serial->parent->usb,
2156 usb_rcvbulkpipe(serial->parent->usb,
2161 serial->rx_data_length,
2162 hso_std_serial_read_bulk_callback,
2164 result = usb_submit_urb(serial->rx_urb[i], flags);
2166 dev_warn(&serial->parent->usb->dev,
2167 "Failed to submit urb - res %d\n",
2173 mutex_lock(&serial->shared_int->shared_int_lock);
2174 if (!serial->shared_int->use_count) {
2176 hso_mux_submit_intr_urb(serial->shared_int,
2177 hso_dev->usb, flags);
2179 serial->shared_int->use_count++;
2180 mutex_unlock(&serial->shared_int->shared_int_lock);
2182 if (serial->tiocmget)
2183 tiocmget_submit_urb(serial,
2185 serial->parent->usb);
2189 static int hso_stop_serial_device(struct hso_device *hso_dev)
2192 struct hso_serial *serial = dev2ser(hso_dev);
2193 struct hso_tiocmget *tiocmget;
2198 for (i = 0; i < serial->num_rx_urbs; i++) {
2199 if (serial->rx_urb[i]) {
2200 usb_kill_urb(serial->rx_urb[i]);
2201 serial->rx_urb_filled[i] = 0;
2204 serial->curr_rx_urb_idx = 0;
2207 usb_kill_urb(serial->tx_urb);
2209 if (serial->shared_int) {
2210 mutex_lock(&serial->shared_int->shared_int_lock);
2211 if (serial->shared_int->use_count &&
2212 (--serial->shared_int->use_count == 0)) {
2215 urb = serial->shared_int->shared_intr_urb;
2219 mutex_unlock(&serial->shared_int->shared_int_lock);
2221 tiocmget = serial->tiocmget;
2223 wake_up_interruptible(&tiocmget->waitq);
2224 usb_kill_urb(tiocmget->urb);
2230 static void hso_serial_tty_unregister(struct hso_serial *serial)
2232 tty_unregister_device(tty_drv, serial->minor);
2235 static void hso_serial_common_free(struct hso_serial *serial)
2239 for (i = 0; i < serial->num_rx_urbs; i++) {
2240 /* unlink and free RX URB */
2241 usb_free_urb(serial->rx_urb[i]);
2242 /* free the RX buffer */
2243 kfree(serial->rx_data[i]);
2246 /* unlink and free TX URB */
2247 usb_free_urb(serial->tx_urb);
2248 kfree(serial->tx_buffer);
2249 kfree(serial->tx_data);
2250 tty_port_destroy(&serial->port);
2253 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2254 int rx_size, int tx_size)
2259 tty_port_init(&serial->port);
2261 minor = get_free_serial_index();
2265 /* register our minor number */
2266 serial->parent->dev = tty_port_register_device_attr(&serial->port,
2267 tty_drv, minor, &serial->parent->interface->dev,
2268 serial->parent, hso_serial_dev_groups);
2269 if (IS_ERR(serial->parent->dev))
2272 /* fill in specific data for later use */
2273 serial->minor = minor;
2274 serial->magic = HSO_SERIAL_MAGIC;
2275 spin_lock_init(&serial->serial_lock);
2276 serial->num_rx_urbs = num_urbs;
2278 /* RX, allocate urb and initialize */
2280 /* prepare our RX buffer */
2281 serial->rx_data_length = rx_size;
2282 for (i = 0; i < serial->num_rx_urbs; i++) {
2283 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2284 if (!serial->rx_urb[i])
2286 serial->rx_urb[i]->transfer_buffer = NULL;
2287 serial->rx_urb[i]->transfer_buffer_length = 0;
2288 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2290 if (!serial->rx_data[i])
2294 /* TX, allocate urb and initialize */
2295 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2296 if (!serial->tx_urb)
2298 serial->tx_urb->transfer_buffer = NULL;
2299 serial->tx_urb->transfer_buffer_length = 0;
2300 /* prepare our TX buffer */
2301 serial->tx_data_count = 0;
2302 serial->tx_buffer_count = 0;
2303 serial->tx_data_length = tx_size;
2304 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2305 if (!serial->tx_data)
2308 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2309 if (!serial->tx_buffer)
2314 hso_serial_tty_unregister(serial);
2316 hso_serial_common_free(serial);
2320 /* Creates a general hso device */
2321 static struct hso_device *hso_create_device(struct usb_interface *intf,
2324 struct hso_device *hso_dev;
2326 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2330 hso_dev->port_spec = port_spec;
2331 hso_dev->usb = interface_to_usbdev(intf);
2332 hso_dev->interface = intf;
2333 kref_init(&hso_dev->ref);
2334 mutex_init(&hso_dev->mutex);
2336 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2337 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2342 /* Removes a network device in the network device table */
2343 static int remove_net_device(struct hso_device *hso_dev)
2347 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2348 if (network_table[i] == hso_dev) {
2349 network_table[i] = NULL;
2353 if (i == HSO_MAX_NET_DEVICES)
2358 /* Frees our network device */
2359 static void hso_free_net_device(struct hso_device *hso_dev, bool bailout)
2362 struct hso_net *hso_net = dev2net(hso_dev);
2367 remove_net_device(hso_net->parent);
2370 unregister_netdev(hso_net->net);
2373 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2374 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2375 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2376 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2378 usb_free_urb(hso_net->mux_bulk_tx_urb);
2379 kfree(hso_net->mux_bulk_tx_buf);
2380 hso_net->mux_bulk_tx_buf = NULL;
2382 if (hso_net->net && !bailout)
2383 free_netdev(hso_net->net);
2388 static const struct net_device_ops hso_netdev_ops = {
2389 .ndo_open = hso_net_open,
2390 .ndo_stop = hso_net_close,
2391 .ndo_start_xmit = hso_net_start_xmit,
2392 .ndo_tx_timeout = hso_net_tx_timeout,
2395 /* initialize the network interface */
2396 static void hso_net_init(struct net_device *net)
2398 struct hso_net *hso_net = netdev_priv(net);
2400 hso_dbg(0x1, "sizeof hso_net is %zu\n", sizeof(*hso_net));
2402 /* fill in the other fields */
2403 net->netdev_ops = &hso_netdev_ops;
2404 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2405 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2406 net->type = ARPHRD_NONE;
2407 net->mtu = DEFAULT_MTU - 14;
2408 net->tx_queue_len = 10;
2409 net->ethtool_ops = &ops;
2411 /* and initialize the semaphore */
2412 spin_lock_init(&hso_net->net_lock);
2415 /* Adds a network device in the network device table */
2416 static int add_net_device(struct hso_device *hso_dev)
2420 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2421 if (network_table[i] == NULL) {
2422 network_table[i] = hso_dev;
2426 if (i == HSO_MAX_NET_DEVICES)
2431 static int hso_rfkill_set_block(void *data, bool blocked)
2433 struct hso_device *hso_dev = data;
2434 int enabled = !blocked;
2437 mutex_lock(&hso_dev->mutex);
2438 if (hso_dev->usb_gone)
2441 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2442 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2443 USB_CTRL_SET_TIMEOUT);
2444 mutex_unlock(&hso_dev->mutex);
2448 static const struct rfkill_ops hso_rfkill_ops = {
2449 .set_block = hso_rfkill_set_block,
2452 /* Creates and sets up everything for rfkill */
2453 static void hso_create_rfkill(struct hso_device *hso_dev,
2454 struct usb_interface *interface)
2456 struct hso_net *hso_net = dev2net(hso_dev);
2457 struct device *dev = &hso_net->net->dev;
2458 static u32 rfkill_counter;
2460 snprintf(hso_net->name, sizeof(hso_net->name), "hso-%d",
2463 hso_net->rfkill = rfkill_alloc(hso_net->name,
2464 &interface_to_usbdev(interface)->dev,
2466 &hso_rfkill_ops, hso_dev);
2467 if (!hso_net->rfkill)
2470 if (rfkill_register(hso_net->rfkill) < 0) {
2471 rfkill_destroy(hso_net->rfkill);
2472 hso_net->rfkill = NULL;
2473 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2478 static struct device_type hso_type = {
2482 /* Creates our network device */
2483 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2487 struct net_device *net;
2488 struct hso_net *hso_net;
2489 struct hso_device *hso_dev;
2491 hso_dev = hso_create_device(interface, port_spec);
2495 /* allocate our network device, then we can put in our private data */
2496 /* call hso_net_init to do the basic initialization */
2497 net = alloc_netdev(sizeof(struct hso_net), "hso%d", NET_NAME_UNKNOWN,
2500 dev_err(&interface->dev, "Unable to create ethernet device\n");
2504 hso_net = netdev_priv(net);
2506 hso_dev->port_data.dev_net = hso_net;
2508 hso_net->parent = hso_dev;
2510 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2512 if (!hso_net->in_endp) {
2513 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2516 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2518 if (!hso_net->out_endp) {
2519 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2522 SET_NETDEV_DEV(net, &interface->dev);
2523 SET_NETDEV_DEVTYPE(net, &hso_type);
2525 /* start allocating */
2526 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2527 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2528 if (!hso_net->mux_bulk_rx_urb_pool[i])
2530 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2532 if (!hso_net->mux_bulk_rx_buf_pool[i])
2535 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2536 if (!hso_net->mux_bulk_tx_urb)
2538 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2539 if (!hso_net->mux_bulk_tx_buf)
2542 add_net_device(hso_dev);
2544 /* registering our net device */
2545 result = register_netdev(net);
2547 dev_err(&interface->dev, "Failed to register device\n");
2551 hso_log_port(hso_dev);
2553 hso_create_rfkill(hso_dev, interface);
2557 hso_free_net_device(hso_dev, true);
2561 static void hso_free_tiomget(struct hso_serial *serial)
2563 struct hso_tiocmget *tiocmget;
2566 tiocmget = serial->tiocmget;
2568 usb_free_urb(tiocmget->urb);
2569 tiocmget->urb = NULL;
2570 serial->tiocmget = NULL;
2571 kfree(tiocmget->serial_state_notification);
2572 tiocmget->serial_state_notification = NULL;
2577 /* Frees an AT channel ( goes for both mux and non-mux ) */
2578 static void hso_free_serial_device(struct hso_device *hso_dev)
2580 struct hso_serial *serial = dev2ser(hso_dev);
2585 hso_serial_common_free(serial);
2587 if (serial->shared_int) {
2588 mutex_lock(&serial->shared_int->shared_int_lock);
2589 if (--serial->shared_int->ref_count == 0)
2590 hso_free_shared_int(serial->shared_int);
2592 mutex_unlock(&serial->shared_int->shared_int_lock);
2594 hso_free_tiomget(serial);
2599 /* Creates a bulk AT channel */
2600 static struct hso_device *hso_create_bulk_serial_device(
2601 struct usb_interface *interface, int port)
2603 struct hso_device *hso_dev;
2604 struct hso_serial *serial;
2606 struct hso_tiocmget *tiocmget;
2608 hso_dev = hso_create_device(interface, port);
2612 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2616 serial->parent = hso_dev;
2617 hso_dev->port_data.dev_serial = serial;
2619 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2621 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2623 serial->tiocmget->serial_state_notification
2624 = kzalloc(sizeof(struct hso_serial_state_notification),
2626 /* it isn't going to break our heart if serial->tiocmget
2627 * allocation fails don't bother checking this.
2629 if (serial->tiocmget && serial->tiocmget->serial_state_notification) {
2630 tiocmget = serial->tiocmget;
2631 tiocmget->endp = hso_get_ep(interface,
2632 USB_ENDPOINT_XFER_INT,
2634 if (!tiocmget->endp) {
2635 dev_err(&interface->dev, "Failed to find INT IN ep\n");
2639 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2640 if (tiocmget->urb) {
2641 mutex_init(&tiocmget->mutex);
2642 init_waitqueue_head(&tiocmget->waitq);
2644 hso_free_tiomget(serial);
2650 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2654 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2656 if (!serial->in_endp) {
2657 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2663 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2664 dev_err(&interface->dev, "Failed to find BULK OUT ep\n");
2668 serial->write_data = hso_std_serial_write_data;
2670 /* and record this serial */
2671 set_serial_by_index(serial->minor, serial);
2673 /* setup the proc dirs and files if needed */
2674 hso_log_port(hso_dev);
2676 /* done, return it */
2680 hso_serial_tty_unregister(serial);
2681 hso_serial_common_free(serial);
2683 hso_free_tiomget(serial);
2689 /* Creates a multiplexed AT channel */
2691 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2693 struct hso_shared_int *mux)
2695 struct hso_device *hso_dev;
2696 struct hso_serial *serial;
2699 port_spec = HSO_INTF_MUX;
2700 port_spec &= ~HSO_PORT_MASK;
2702 port_spec |= hso_mux_to_port(port);
2703 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2706 hso_dev = hso_create_device(interface, port_spec);
2710 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2714 hso_dev->port_data.dev_serial = serial;
2715 serial->parent = hso_dev;
2717 if (hso_serial_common_create
2718 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2721 serial->tx_data_length--;
2722 serial->write_data = hso_mux_serial_write_data;
2724 serial->shared_int = mux;
2725 mutex_lock(&serial->shared_int->shared_int_lock);
2726 serial->shared_int->ref_count++;
2727 mutex_unlock(&serial->shared_int->shared_int_lock);
2729 /* and record this serial */
2730 set_serial_by_index(serial->minor, serial);
2732 /* setup the proc dirs and files if needed */
2733 hso_log_port(hso_dev);
2735 /* done, return it */
2740 tty_unregister_device(tty_drv, serial->minor);
2748 static void hso_free_shared_int(struct hso_shared_int *mux)
2750 usb_free_urb(mux->shared_intr_urb);
2751 kfree(mux->shared_intr_buf);
2752 mutex_unlock(&mux->shared_int_lock);
2757 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2759 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2764 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2766 if (!mux->intr_endp) {
2767 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2771 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2772 if (!mux->shared_intr_urb)
2774 mux->shared_intr_buf =
2775 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2777 if (!mux->shared_intr_buf)
2780 mutex_init(&mux->shared_int_lock);
2785 kfree(mux->shared_intr_buf);
2786 usb_free_urb(mux->shared_intr_urb);
2791 /* Gets the port spec for a certain interface */
2792 static int hso_get_config_data(struct usb_interface *interface)
2794 struct usb_device *usbdev = interface_to_usbdev(interface);
2795 u8 *config_data = kmalloc(17, GFP_KERNEL);
2796 u32 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2801 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2802 0x86, 0xC0, 0, 0, config_data, 17,
2803 USB_CTRL_SET_TIMEOUT) != 0x11) {
2808 /* check if we have a valid interface */
2814 switch (config_data[if_num]) {
2819 result = HSO_PORT_DIAG;
2822 result = HSO_PORT_GPS;
2825 result = HSO_PORT_GPS_CONTROL;
2828 result = HSO_PORT_APP;
2831 result = HSO_PORT_APP2;
2834 result = HSO_PORT_CONTROL;
2837 result = HSO_PORT_NETWORK;
2840 result = HSO_PORT_MODEM;
2843 result = HSO_PORT_MSD;
2846 result = HSO_PORT_PCSC;
2849 result = HSO_PORT_VOICE;
2856 result |= HSO_INTF_BULK;
2858 if (config_data[16] & 0x1)
2859 result |= HSO_INFO_CRC_BUG;
2865 /* called once for each interface upon device insertion */
2866 static int hso_probe(struct usb_interface *interface,
2867 const struct usb_device_id *id)
2869 int mux, i, if_num, port_spec;
2870 unsigned char port_mask;
2871 struct hso_device *hso_dev = NULL;
2872 struct hso_shared_int *shared_int;
2873 struct hso_device *tmp_dev = NULL;
2875 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2876 dev_err(&interface->dev, "Not our interface\n");
2880 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2882 /* Get the interface/port specification from either driver_info or from
2883 * the device itself */
2884 if (id->driver_info) {
2885 /* if_num is controlled by the device, driver_info is a 0 terminated
2886 * array. Make sure, the access is in bounds! */
2887 for (i = 0; i <= if_num; ++i)
2888 if (((u32 *)(id->driver_info))[i] == 0)
2890 port_spec = ((u32 *)(id->driver_info))[if_num];
2892 port_spec = hso_get_config_data(interface);
2897 /* Check if we need to switch to alt interfaces prior to port
2899 if (interface->num_altsetting > 1)
2900 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2901 interface->needs_remote_wakeup = 1;
2903 /* Allocate new hso device(s) */
2904 switch (port_spec & HSO_INTF_MASK) {
2906 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2907 /* Create the network device */
2909 hso_dev = hso_create_net_device(interface,
2917 if (hso_get_mux_ports(interface, &port_mask))
2918 /* TODO: de-allocate everything */
2921 shared_int = hso_create_shared_int(interface);
2925 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2926 if (port_mask & i) {
2927 hso_dev = hso_create_mux_serial_device(
2928 interface, i, shared_int);
2939 /* It's a regular bulk interface */
2940 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2943 hso_create_net_device(interface, port_spec);
2946 hso_create_bulk_serial_device(interface, port_spec);
2955 /* save our data pointer in this device */
2956 usb_set_intfdata(interface, hso_dev);
2961 hso_free_interface(interface);
2965 /* device removed, cleaning up */
2966 static void hso_disconnect(struct usb_interface *interface)
2968 hso_free_interface(interface);
2970 /* remove reference of our private data */
2971 usb_set_intfdata(interface, NULL);
2974 static void async_get_intf(struct work_struct *data)
2976 struct hso_device *hso_dev =
2977 container_of(data, struct hso_device, async_get_intf);
2978 usb_autopm_get_interface(hso_dev->interface);
2981 static void async_put_intf(struct work_struct *data)
2983 struct hso_device *hso_dev =
2984 container_of(data, struct hso_device, async_put_intf);
2985 usb_autopm_put_interface(hso_dev->interface);
2988 static int hso_get_activity(struct hso_device *hso_dev)
2990 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
2991 if (!hso_dev->is_active) {
2992 hso_dev->is_active = 1;
2993 schedule_work(&hso_dev->async_get_intf);
2997 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3000 usb_mark_last_busy(hso_dev->usb);
3005 static int hso_put_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 = 0;
3010 schedule_work(&hso_dev->async_put_intf);
3014 hso_dev->is_active = 0;
3018 /* called by kernel when we need to suspend device */
3019 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3023 /* Stop all serial ports */
3024 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3025 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3026 result = hso_stop_serial_device(serial_table[i]);
3032 /* Stop all network ports */
3033 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3034 if (network_table[i] &&
3035 (network_table[i]->interface == iface)) {
3036 result = hso_stop_net_device(network_table[i]);
3046 /* called by kernel when we need to resume device */
3047 static int hso_resume(struct usb_interface *iface)
3050 struct hso_net *hso_net;
3052 /* Start all serial ports */
3053 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3054 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3055 if (dev2ser(serial_table[i])->port.count) {
3057 hso_start_serial_device(serial_table[i], GFP_NOIO);
3058 hso_kick_transmit(dev2ser(serial_table[i]));
3065 /* Start all network ports */
3066 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3067 if (network_table[i] &&
3068 (network_table[i]->interface == iface)) {
3069 hso_net = dev2net(network_table[i]);
3070 if (hso_net->flags & IFF_UP) {
3071 /* First transmit any lingering data,
3072 then restart the device. */
3073 if (hso_net->skb_tx_buf) {
3074 dev_dbg(&iface->dev,
3076 " lingering data\n");
3077 hso_net_start_xmit(hso_net->skb_tx_buf,
3079 hso_net->skb_tx_buf = NULL;
3081 result = hso_start_net_device(network_table[i]);
3092 static void hso_serial_ref_free(struct kref *ref)
3094 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3096 hso_free_serial_device(hso_dev);
3099 static void hso_free_interface(struct usb_interface *interface)
3101 struct hso_serial *serial;
3104 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3105 if (serial_table[i] &&
3106 (serial_table[i]->interface == interface)) {
3107 serial = dev2ser(serial_table[i]);
3108 tty_port_tty_hangup(&serial->port, false);
3109 mutex_lock(&serial->parent->mutex);
3110 serial->parent->usb_gone = 1;
3111 mutex_unlock(&serial->parent->mutex);
3112 cancel_work_sync(&serial_table[i]->async_put_intf);
3113 cancel_work_sync(&serial_table[i]->async_get_intf);
3114 hso_serial_tty_unregister(serial);
3115 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3116 set_serial_by_index(i, NULL);
3120 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3121 if (network_table[i] &&
3122 (network_table[i]->interface == interface)) {
3123 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3124 /* hso_stop_net_device doesn't stop the net queue since
3125 * traffic needs to start it again when suspended */
3126 netif_stop_queue(dev2net(network_table[i])->net);
3127 hso_stop_net_device(network_table[i]);
3128 cancel_work_sync(&network_table[i]->async_put_intf);
3129 cancel_work_sync(&network_table[i]->async_get_intf);
3131 rfkill_unregister(rfk);
3132 rfkill_destroy(rfk);
3134 hso_free_net_device(network_table[i], false);
3139 /* Helper functions */
3141 /* Get the endpoint ! */
3142 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3146 struct usb_host_interface *iface = intf->cur_altsetting;
3147 struct usb_endpoint_descriptor *endp;
3149 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3150 endp = &iface->endpoint[i].desc;
3151 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3152 (usb_endpoint_type(endp) == type))
3159 /* Get the byte that describes which ports are enabled */
3160 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3163 struct usb_host_interface *iface = intf->cur_altsetting;
3165 if (iface->extralen == 3) {
3166 *ports = iface->extra[2];
3170 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3171 if (iface->endpoint[i].extralen == 3) {
3172 *ports = iface->endpoint[i].extra[2];
3180 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3181 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3182 struct usb_device *usb, gfp_t gfp)
3186 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3188 shared_int->intr_endp->bEndpointAddress & 0x7F),
3189 shared_int->shared_intr_buf,
3191 intr_callback, shared_int,
3192 shared_int->intr_endp->bInterval);
3194 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3196 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3202 /* operations setup of the serial interface */
3203 static const struct tty_operations hso_serial_ops = {
3204 .open = hso_serial_open,
3205 .close = hso_serial_close,
3206 .write = hso_serial_write,
3207 .write_room = hso_serial_write_room,
3208 .cleanup = hso_serial_cleanup,
3209 .ioctl = hso_serial_ioctl,
3210 .set_termios = hso_serial_set_termios,
3211 .chars_in_buffer = hso_serial_chars_in_buffer,
3212 .tiocmget = hso_serial_tiocmget,
3213 .tiocmset = hso_serial_tiocmset,
3214 .get_icount = hso_get_count,
3215 .unthrottle = hso_unthrottle
3218 static struct usb_driver hso_driver = {
3219 .name = driver_name,
3221 .disconnect = hso_disconnect,
3222 .id_table = hso_ids,
3223 .suspend = hso_suspend,
3224 .resume = hso_resume,
3225 .reset_resume = hso_resume,
3226 .supports_autosuspend = 1,
3227 .disable_hub_initiated_lpm = 1,
3230 static int __init hso_init(void)
3235 /* put it in the log */
3236 pr_info("%s\n", version);
3238 /* Initialise the serial table semaphore and table */
3239 spin_lock_init(&serial_table_lock);
3240 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3241 serial_table[i] = NULL;
3243 /* allocate our driver using the proper amount of supported minors */
3244 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3248 /* fill in all needed values */
3249 tty_drv->driver_name = driver_name;
3250 tty_drv->name = tty_filename;
3252 /* if major number is provided as parameter, use that one */
3254 tty_drv->major = tty_major;
3256 tty_drv->minor_start = 0;
3257 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3258 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3259 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3260 tty_drv->init_termios = tty_std_termios;
3261 hso_init_termios(&tty_drv->init_termios);
3262 tty_set_operations(tty_drv, &hso_serial_ops);
3264 /* register the tty driver */
3265 result = tty_register_driver(tty_drv);
3267 pr_err("%s - tty_register_driver failed(%d)\n",
3272 /* register this module as an usb driver */
3273 result = usb_register(&hso_driver);
3275 pr_err("Could not register hso driver - error: %d\n", result);
3282 tty_unregister_driver(tty_drv);
3284 put_tty_driver(tty_drv);
3288 static void __exit hso_exit(void)
3290 pr_info("unloaded\n");
3292 tty_unregister_driver(tty_drv);
3293 /* deregister the usb driver */
3294 usb_deregister(&hso_driver);
3295 put_tty_driver(tty_drv);
3298 /* Module definitions */
3299 module_init(hso_init);
3300 module_exit(hso_exit);
3302 MODULE_AUTHOR(MOD_AUTHOR);
3303 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3304 MODULE_LICENSE("GPL");
3306 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3307 MODULE_PARM_DESC(debug, "debug level mask [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3308 module_param(debug, int, 0644);
3310 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3311 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3312 module_param(tty_major, int, 0644);
3314 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3315 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3316 module_param(disable_net, int, 0644);