1 // SPDX-License-Identifier: GPL-2.0-only
2 /******************************************************************************
4 * Driver for Option High Speed Mobile Devices.
6 * Copyright (C) 2008 Option International
10 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
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 DEFINE_SPINLOCK(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 hsotype_show(struct device *dev,
461 struct device_attribute *attr, char *buf)
463 struct hso_device *hso_dev = dev_get_drvdata(dev);
469 switch (hso_dev->port_spec & HSO_PORT_MASK) {
470 case HSO_PORT_CONTROL:
471 port_name = "Control";
474 port_name = "Application";
477 port_name = "Application2";
482 case HSO_PORT_GPS_CONTROL:
483 port_name = "GPS Control";
489 port_name = "Diagnostic";
492 port_name = "Diagnostic2";
497 case HSO_PORT_NETWORK:
498 port_name = "Network";
501 port_name = "Unknown";
505 return sprintf(buf, "%s\n", port_name);
507 static DEVICE_ATTR_RO(hsotype);
509 static struct attribute *hso_serial_dev_attrs[] = {
510 &dev_attr_hsotype.attr,
514 ATTRIBUTE_GROUPS(hso_serial_dev);
516 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
520 for (idx = 0; idx < serial->num_rx_urbs; idx++)
521 if (serial->rx_urb[idx] == urb)
523 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
527 /* converts mux value to a port spec value */
528 static u32 hso_mux_to_port(int mux)
534 result = HSO_PORT_CONTROL;
537 result = HSO_PORT_APP;
540 result = HSO_PORT_PCSC;
543 result = HSO_PORT_GPS;
546 result = HSO_PORT_APP2;
549 result = HSO_PORT_NO_PORT;
554 /* converts port spec value to a mux value */
555 static u32 hso_port_to_mux(int port)
559 switch (port & HSO_PORT_MASK) {
560 case HSO_PORT_CONTROL:
581 static struct hso_serial *get_serial_by_shared_int_and_type(
582 struct hso_shared_int *shared_int,
587 port = hso_mux_to_port(mux);
589 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
590 if (serial_table[i] &&
591 (dev2ser(serial_table[i])->shared_int == shared_int) &&
592 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
593 return dev2ser(serial_table[i]);
600 static struct hso_serial *get_serial_by_index(unsigned index)
602 struct hso_serial *serial = NULL;
605 spin_lock_irqsave(&serial_table_lock, flags);
606 if (serial_table[index])
607 serial = dev2ser(serial_table[index]);
608 spin_unlock_irqrestore(&serial_table_lock, flags);
613 static int obtain_minor(struct hso_serial *serial)
618 spin_lock_irqsave(&serial_table_lock, flags);
619 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
620 if (serial_table[index] == NULL) {
621 serial_table[index] = serial->parent;
622 serial->minor = index;
623 spin_unlock_irqrestore(&serial_table_lock, flags);
627 spin_unlock_irqrestore(&serial_table_lock, flags);
629 pr_err("%s: no free serial devices in table\n", __func__);
633 static void release_minor(struct hso_serial *serial)
637 spin_lock_irqsave(&serial_table_lock, flags);
638 serial_table[serial->minor] = NULL;
639 spin_unlock_irqrestore(&serial_table_lock, flags);
642 static void handle_usb_error(int status, const char *function,
643 struct hso_device *hso_dev)
649 explanation = "no device";
652 explanation = "endpoint not enabled";
655 explanation = "endpoint stalled";
658 explanation = "not enough bandwidth";
661 explanation = "device disabled";
664 explanation = "device suspended";
670 explanation = "internal error";
676 explanation = "protocol error";
678 usb_queue_reset_device(hso_dev->interface);
681 explanation = "unknown status";
685 /* log a meaningful explanation of an USB status */
686 hso_dbg(0x1, "%s: received USB status - %s (%d)\n",
687 function, explanation, status);
690 /* Network interface functions */
692 /* called when net interface is brought up by ifconfig */
693 static int hso_net_open(struct net_device *net)
695 struct hso_net *odev = netdev_priv(net);
696 unsigned long flags = 0;
699 dev_err(&net->dev, "No net device !\n");
703 odev->skb_tx_buf = NULL;
705 /* setup environment */
706 spin_lock_irqsave(&odev->net_lock, flags);
707 odev->rx_parse_state = WAIT_IP;
708 odev->rx_buf_size = 0;
709 odev->rx_buf_missing = sizeof(struct iphdr);
710 spin_unlock_irqrestore(&odev->net_lock, flags);
712 /* We are up and running. */
713 set_bit(HSO_NET_RUNNING, &odev->flags);
714 hso_start_net_device(odev->parent);
716 /* Tell the kernel we are ready to start receiving from it */
717 netif_start_queue(net);
722 /* called when interface is brought down by ifconfig */
723 static int hso_net_close(struct net_device *net)
725 struct hso_net *odev = netdev_priv(net);
727 /* we don't need the queue anymore */
728 netif_stop_queue(net);
729 /* no longer running */
730 clear_bit(HSO_NET_RUNNING, &odev->flags);
732 hso_stop_net_device(odev->parent);
738 /* USB tells is xmit done, we should start the netqueue again */
739 static void write_bulk_callback(struct urb *urb)
741 struct hso_net *odev = urb->context;
742 int status = urb->status;
745 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
746 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
750 /* Do we still have a valid kernel network device? */
751 if (!netif_device_present(odev->net)) {
752 dev_err(&urb->dev->dev, "%s: net device not present\n",
757 /* log status, but don't act on it, we don't need to resubmit anything
760 handle_usb_error(status, __func__, odev->parent);
762 hso_put_activity(odev->parent);
764 /* Tell the network interface we are ready for another frame */
765 netif_wake_queue(odev->net);
768 /* called by kernel when we need to transmit a packet */
769 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
770 struct net_device *net)
772 struct hso_net *odev = netdev_priv(net);
775 /* Tell the kernel, "No more frames 'til we are done with this one." */
776 netif_stop_queue(net);
777 if (hso_get_activity(odev->parent) == -EAGAIN) {
778 odev->skb_tx_buf = skb;
783 DUMP1(skb->data, skb->len);
784 /* Copy it from kernel memory to OUR memory */
785 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
786 hso_dbg(0x1, "len: %d/%d\n", skb->len, MUX_BULK_TX_BUF_SIZE);
788 /* Fill in the URB for shipping it out. */
789 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
791 usb_sndbulkpipe(odev->parent->usb,
793 bEndpointAddress & 0x7F),
794 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
797 /* Deal with the Zero Length packet problem, I hope */
798 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
800 /* Send the URB on its merry way. */
801 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
803 dev_warn(&odev->parent->interface->dev,
804 "failed mux_bulk_tx_urb %d\n", result);
805 net->stats.tx_errors++;
806 netif_start_queue(net);
808 net->stats.tx_packets++;
809 net->stats.tx_bytes += skb->len;
816 static const struct ethtool_ops ops = {
817 .get_link = ethtool_op_get_link
820 /* called when a packet did not ack after watchdogtimeout */
821 static void hso_net_tx_timeout(struct net_device *net, unsigned int txqueue)
823 struct hso_net *odev = netdev_priv(net);
828 /* Tell syslog we are hosed. */
829 dev_warn(&net->dev, "Tx timed out.\n");
831 /* Tear the waiting frame off the list */
832 if (odev->mux_bulk_tx_urb)
833 usb_unlink_urb(odev->mux_bulk_tx_urb);
835 /* Update statistics */
836 net->stats.tx_errors++;
839 /* make a real packet from the received USB buffer */
840 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
841 unsigned int count, unsigned char is_eop)
843 unsigned short temp_bytes;
844 unsigned short buffer_offset = 0;
845 unsigned short frame_len;
848 hso_dbg(0x1, "Rx %d bytes\n", count);
849 DUMP(ip_pkt, min(128, (int)count));
852 switch (odev->rx_parse_state) {
854 /* waiting for IP header. */
855 /* wanted bytes - size of ip header */
858 odev->rx_buf_missing) ? count : odev->
861 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
862 odev->rx_buf_size, ip_pkt + buffer_offset,
865 odev->rx_buf_size += temp_bytes;
866 buffer_offset += temp_bytes;
867 odev->rx_buf_missing -= temp_bytes;
870 if (!odev->rx_buf_missing) {
871 /* header is complete allocate an sk_buffer and
872 * continue to WAIT_DATA */
873 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
875 if ((frame_len > DEFAULT_MRU) ||
876 (frame_len < sizeof(struct iphdr))) {
877 dev_err(&odev->net->dev,
878 "Invalid frame (%d) length\n",
880 odev->rx_parse_state = WAIT_SYNC;
883 /* Allocate an sk_buff */
884 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
886 if (!odev->skb_rx_buf) {
887 /* We got no receive buffer. */
888 hso_dbg(0x1, "could not allocate memory\n");
889 odev->rx_parse_state = WAIT_SYNC;
893 /* Copy what we got so far. make room for iphdr
895 skb_put_data(odev->skb_rx_buf,
896 (char *)&(odev->rx_ip_hdr),
897 sizeof(struct iphdr));
900 odev->rx_buf_size = sizeof(struct iphdr);
902 /* Filip actually use .tot_len */
903 odev->rx_buf_missing =
904 frame_len - sizeof(struct iphdr);
905 odev->rx_parse_state = WAIT_DATA;
910 temp_bytes = (count < odev->rx_buf_missing)
911 ? count : odev->rx_buf_missing;
913 /* Copy the rest of the bytes that are left in the
914 * buffer into the waiting sk_buf. */
915 /* Make room for temp_bytes after tail. */
916 skb_put_data(odev->skb_rx_buf,
917 ip_pkt + buffer_offset,
920 odev->rx_buf_missing -= temp_bytes;
922 buffer_offset += temp_bytes;
923 odev->rx_buf_size += temp_bytes;
924 if (!odev->rx_buf_missing) {
925 /* Packet is complete. Inject into stack. */
926 /* We have IP packet here */
927 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
928 skb_reset_mac_header(odev->skb_rx_buf);
930 /* Ship it off to the kernel */
931 netif_rx(odev->skb_rx_buf);
932 /* No longer our buffer. */
933 odev->skb_rx_buf = NULL;
935 /* update out statistics */
936 odev->net->stats.rx_packets++;
938 odev->net->stats.rx_bytes += odev->rx_buf_size;
940 odev->rx_buf_size = 0;
941 odev->rx_buf_missing = sizeof(struct iphdr);
942 odev->rx_parse_state = WAIT_IP;
947 hso_dbg(0x1, " W_S\n");
957 /* Recovery mechanism for WAIT_SYNC state. */
959 if (odev->rx_parse_state == WAIT_SYNC) {
960 odev->rx_parse_state = WAIT_IP;
961 odev->rx_buf_size = 0;
962 odev->rx_buf_missing = sizeof(struct iphdr);
967 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size)
969 static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
970 u32 rest = urb->actual_length % le16_to_cpu(max_packet_size);
972 if (((rest == 5) || (rest == 6)) &&
973 !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4,
975 urb->actual_length -= 4;
979 /* Moving data from usb to kernel (in interrupt state) */
980 static void read_bulk_callback(struct urb *urb)
982 struct hso_net *odev = urb->context;
983 struct net_device *net;
986 int status = urb->status;
988 /* is al ok? (Filip: Who's Al ?) */
990 handle_usb_error(status, __func__, odev->parent);
995 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
996 hso_dbg(0x1, "BULK IN callback but driver is not active!\n");
999 usb_mark_last_busy(urb->dev);
1003 if (!netif_device_present(net)) {
1004 /* Somebody killed our network interface... */
1008 if (odev->parent->port_spec & HSO_INFO_CRC_BUG)
1009 fix_crc_bug(urb, odev->in_endp->wMaxPacketSize);
1011 /* do we even have a packet? */
1012 if (urb->actual_length) {
1013 /* Handle the IP stream, add header and push it onto network
1014 * stack if the packet is complete. */
1015 spin_lock_irqsave(&odev->net_lock, flags);
1016 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1017 (urb->transfer_buffer_length >
1018 urb->actual_length) ? 1 : 0);
1019 spin_unlock_irqrestore(&odev->net_lock, flags);
1022 /* We are done with this URB, resubmit it. Prep the USB to wait for
1023 * another frame. Reuse same as received. */
1024 usb_fill_bulk_urb(urb,
1026 usb_rcvbulkpipe(odev->parent->usb,
1028 bEndpointAddress & 0x7F),
1029 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1030 read_bulk_callback, odev);
1032 /* Give this to the USB subsystem so it can tell us when more data
1034 result = usb_submit_urb(urb, GFP_ATOMIC);
1036 dev_warn(&odev->parent->interface->dev,
1037 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1041 /* Serial driver functions */
1043 static void hso_init_termios(struct ktermios *termios)
1046 * The default requirements for this device are:
1049 ~(IGNBRK /* disable ignore break */
1050 | BRKINT /* disable break causes interrupt */
1051 | PARMRK /* disable mark parity errors */
1052 | ISTRIP /* disable clear high bit of input characters */
1053 | INLCR /* disable translate NL to CR */
1054 | IGNCR /* disable ignore CR */
1055 | ICRNL /* disable translate CR to NL */
1056 | IXON); /* disable enable XON/XOFF flow control */
1058 /* disable postprocess output characters */
1059 termios->c_oflag &= ~OPOST;
1062 ~(ECHO /* disable echo input characters */
1063 | ECHONL /* disable echo new line */
1064 | ICANON /* disable erase, kill, werase, and rprnt
1065 special characters */
1066 | ISIG /* disable interrupt, quit, and suspend special
1068 | IEXTEN); /* disable non-POSIX special characters */
1071 ~(CSIZE /* no size */
1072 | PARENB /* disable parity bit */
1073 | CBAUD /* clear current baud rate */
1074 | CBAUDEX); /* clear current buad rate */
1076 termios->c_cflag |= CS8; /* character size 8 bits */
1078 /* baud rate 115200 */
1079 tty_termios_encode_baud_rate(termios, 115200, 115200);
1082 static void _hso_serial_set_termios(struct tty_struct *tty)
1084 struct hso_serial *serial = tty->driver_data;
1087 pr_err("%s: no tty structures", __func__);
1091 hso_dbg(0x8, "port %d\n", serial->minor);
1094 * Fix up unsupported bits
1096 tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1098 tty->termios.c_cflag &=
1099 ~(CSIZE /* no size */
1100 | PARENB /* disable parity bit */
1101 | CBAUD /* clear current baud rate */
1102 | CBAUDEX); /* clear current buad rate */
1104 tty->termios.c_cflag |= CS8; /* character size 8 bits */
1106 /* baud rate 115200 */
1107 tty_encode_baud_rate(tty, 115200, 115200);
1110 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1113 /* We are done with this URB, resubmit it. Prep the USB to wait for
1115 usb_fill_bulk_urb(urb, serial->parent->usb,
1116 usb_rcvbulkpipe(serial->parent->usb,
1118 bEndpointAddress & 0x7F),
1119 urb->transfer_buffer, serial->rx_data_length,
1120 hso_std_serial_read_bulk_callback, serial);
1121 /* Give this to the USB subsystem so it can tell us when more data
1123 result = usb_submit_urb(urb, GFP_ATOMIC);
1125 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1133 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1136 struct urb *curr_urb;
1138 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1139 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1140 count = put_rxbuf_data(curr_urb, serial);
1144 serial->curr_rx_urb_idx++;
1145 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1146 serial->curr_rx_urb_idx = 0;
1147 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1152 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1157 urb = serial->rx_urb[0];
1158 if (serial->port.count > 0) {
1159 count = put_rxbuf_data(urb, serial);
1163 /* Re issue a read as long as we receive data. */
1165 if (count == 0 && ((urb->actual_length != 0) ||
1166 (serial->rx_state == RX_PENDING))) {
1167 serial->rx_state = RX_SENT;
1168 hso_mux_serial_read(serial);
1170 serial->rx_state = RX_IDLE;
1174 /* read callback for Diag and CS port */
1175 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1177 struct hso_serial *serial = urb->context;
1178 int status = urb->status;
1179 unsigned long flags;
1181 hso_dbg(0x8, "--- Got serial_read_bulk callback %02x ---\n", status);
1185 hso_dbg(0x1, "serial == NULL\n");
1189 handle_usb_error(status, __func__, serial->parent);
1193 hso_dbg(0x1, "Actual length = %d\n", urb->actual_length);
1194 DUMP1(urb->transfer_buffer, urb->actual_length);
1196 /* Anyone listening? */
1197 if (serial->port.count == 0)
1200 if (serial->parent->port_spec & HSO_INFO_CRC_BUG)
1201 fix_crc_bug(urb, serial->in_endp->wMaxPacketSize);
1202 /* Valid data, handle RX data */
1203 spin_lock_irqsave(&serial->serial_lock, flags);
1204 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1205 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1206 spin_unlock_irqrestore(&serial->serial_lock, flags);
1210 * This needs to be a tasklet otherwise we will
1211 * end up recursively calling this function.
1213 static void hso_unthrottle_tasklet(struct tasklet_struct *t)
1215 struct hso_serial *serial = from_tasklet(serial, t,
1216 unthrottle_tasklet);
1217 unsigned long flags;
1219 spin_lock_irqsave(&serial->serial_lock, flags);
1220 if ((serial->parent->port_spec & HSO_INTF_MUX))
1221 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1223 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1224 spin_unlock_irqrestore(&serial->serial_lock, flags);
1227 static void hso_unthrottle(struct tty_struct *tty)
1229 struct hso_serial *serial = tty->driver_data;
1231 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1234 /* open the requested serial port */
1235 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1237 struct hso_serial *serial = get_serial_by_index(tty->index);
1241 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1243 tty->driver_data = NULL;
1244 hso_dbg(0x1, "Failed to open port\n");
1248 mutex_lock(&serial->parent->mutex);
1249 result = usb_autopm_get_interface(serial->parent->interface);
1253 hso_dbg(0x1, "Opening %d\n", serial->minor);
1256 tty->driver_data = serial;
1257 tty_port_tty_set(&serial->port, tty);
1259 /* check for port already opened, if not set the termios */
1260 serial->port.count++;
1261 if (serial->port.count == 1) {
1262 serial->rx_state = RX_IDLE;
1263 /* Force default termio settings */
1264 _hso_serial_set_termios(tty);
1265 tasklet_setup(&serial->unthrottle_tasklet,
1266 hso_unthrottle_tasklet);
1267 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1269 hso_stop_serial_device(serial->parent);
1270 serial->port.count--;
1272 kref_get(&serial->parent->ref);
1275 hso_dbg(0x1, "Port was already open\n");
1278 usb_autopm_put_interface(serial->parent->interface);
1282 hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0);
1284 mutex_unlock(&serial->parent->mutex);
1288 /* close the requested serial port */
1289 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1291 struct hso_serial *serial = tty->driver_data;
1294 hso_dbg(0x1, "Closing serial port\n");
1296 /* Open failed, no close cleanup required */
1300 mutex_lock(&serial->parent->mutex);
1301 usb_gone = serial->parent->usb_gone;
1304 usb_autopm_get_interface(serial->parent->interface);
1306 /* reset the rts and dtr */
1307 /* do the actual close */
1308 serial->port.count--;
1310 if (serial->port.count <= 0) {
1311 serial->port.count = 0;
1312 tty_port_tty_set(&serial->port, NULL);
1314 hso_stop_serial_device(serial->parent);
1315 tasklet_kill(&serial->unthrottle_tasklet);
1319 usb_autopm_put_interface(serial->parent->interface);
1321 mutex_unlock(&serial->parent->mutex);
1324 /* close the requested serial port */
1325 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1328 struct hso_serial *serial = tty->driver_data;
1329 int space, tx_bytes;
1330 unsigned long flags;
1333 if (serial == NULL) {
1334 pr_err("%s: serial is NULL\n", __func__);
1338 spin_lock_irqsave(&serial->serial_lock, flags);
1340 space = serial->tx_data_length - serial->tx_buffer_count;
1341 tx_bytes = (count < space) ? count : space;
1346 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1347 serial->tx_buffer_count += tx_bytes;
1350 spin_unlock_irqrestore(&serial->serial_lock, flags);
1352 hso_kick_transmit(serial);
1357 /* how much room is there for writing */
1358 static unsigned int hso_serial_write_room(struct tty_struct *tty)
1360 struct hso_serial *serial = tty->driver_data;
1362 unsigned long flags;
1364 spin_lock_irqsave(&serial->serial_lock, flags);
1365 room = serial->tx_data_length - serial->tx_buffer_count;
1366 spin_unlock_irqrestore(&serial->serial_lock, flags);
1368 /* return free room */
1372 static void hso_serial_cleanup(struct tty_struct *tty)
1374 struct hso_serial *serial = tty->driver_data;
1379 kref_put(&serial->parent->ref, hso_serial_ref_free);
1382 /* setup the term */
1383 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1385 struct hso_serial *serial = tty->driver_data;
1386 unsigned long flags;
1389 hso_dbg(0x16, "Termios called with: cflags new[%u] - old[%u]\n",
1390 (unsigned int)tty->termios.c_cflag,
1391 (unsigned int)old->c_cflag);
1393 /* the actual setup */
1394 spin_lock_irqsave(&serial->serial_lock, flags);
1395 if (serial->port.count)
1396 _hso_serial_set_termios(tty);
1398 tty->termios = *old;
1399 spin_unlock_irqrestore(&serial->serial_lock, flags);
1404 /* how many characters in the buffer */
1405 static unsigned int hso_serial_chars_in_buffer(struct tty_struct *tty)
1407 struct hso_serial *serial = tty->driver_data;
1408 unsigned long flags;
1415 spin_lock_irqsave(&serial->serial_lock, flags);
1416 chars = serial->tx_buffer_count;
1417 spin_unlock_irqrestore(&serial->serial_lock, flags);
1421 static int tiocmget_submit_urb(struct hso_serial *serial,
1422 struct hso_tiocmget *tiocmget,
1423 struct usb_device *usb)
1427 if (serial->parent->usb_gone)
1429 usb_fill_int_urb(tiocmget->urb, usb,
1432 bEndpointAddress & 0x7F),
1433 tiocmget->serial_state_notification,
1434 sizeof(struct hso_serial_state_notification),
1435 tiocmget_intr_callback, serial,
1436 tiocmget->endp->bInterval);
1437 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1439 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1446 static void tiocmget_intr_callback(struct urb *urb)
1448 struct hso_serial *serial = urb->context;
1449 struct hso_tiocmget *tiocmget;
1450 int status = urb->status;
1451 u16 UART_state_bitmap, prev_UART_state_bitmap;
1452 struct uart_icount *icount;
1453 struct hso_serial_state_notification *serial_state_notification;
1454 struct usb_device *usb;
1455 struct usb_interface *interface;
1462 handle_usb_error(status, __func__, serial->parent);
1466 /* tiocmget is only supported on HSO_PORT_MODEM */
1467 tiocmget = serial->tiocmget;
1470 BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1472 usb = serial->parent->usb;
1473 interface = serial->parent->interface;
1475 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1477 /* wIndex should be the USB interface number of the port to which the
1478 * notification applies, which should always be the Modem port.
1480 serial_state_notification = tiocmget->serial_state_notification;
1481 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1482 serial_state_notification->bNotification != B_NOTIFICATION ||
1483 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1484 le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1485 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1487 "hso received invalid serial state notification\n");
1488 DUMP(serial_state_notification,
1489 sizeof(struct hso_serial_state_notification));
1491 unsigned long flags;
1493 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1495 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1496 icount = &tiocmget->icount;
1497 spin_lock_irqsave(&serial->serial_lock, flags);
1498 if ((UART_state_bitmap & B_OVERRUN) !=
1499 (prev_UART_state_bitmap & B_OVERRUN))
1501 if ((UART_state_bitmap & B_PARITY) !=
1502 (prev_UART_state_bitmap & B_PARITY))
1504 if ((UART_state_bitmap & B_FRAMING) !=
1505 (prev_UART_state_bitmap & B_FRAMING))
1507 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1508 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1510 if ((UART_state_bitmap & B_BREAK) !=
1511 (prev_UART_state_bitmap & B_BREAK))
1513 if ((UART_state_bitmap & B_TX_CARRIER) !=
1514 (prev_UART_state_bitmap & B_TX_CARRIER))
1516 if ((UART_state_bitmap & B_RX_CARRIER) !=
1517 (prev_UART_state_bitmap & B_RX_CARRIER))
1519 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1520 spin_unlock_irqrestore(&serial->serial_lock, flags);
1521 tiocmget->intr_completed = 1;
1522 wake_up_interruptible(&tiocmget->waitq);
1524 memset(serial_state_notification, 0,
1525 sizeof(struct hso_serial_state_notification));
1526 tiocmget_submit_urb(serial,
1528 serial->parent->usb);
1532 * next few functions largely stolen from drivers/serial/serial_core.c
1534 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1535 * - mask passed in arg for lines of interest
1536 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1537 * Caller should use TIOCGICOUNT to see which one it was
1540 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1542 DECLARE_WAITQUEUE(wait, current);
1543 struct uart_icount cprev, cnow;
1544 struct hso_tiocmget *tiocmget;
1547 tiocmget = serial->tiocmget;
1551 * note the counters on entry
1553 spin_lock_irq(&serial->serial_lock);
1554 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1555 spin_unlock_irq(&serial->serial_lock);
1556 add_wait_queue(&tiocmget->waitq, &wait);
1558 spin_lock_irq(&serial->serial_lock);
1559 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1560 spin_unlock_irq(&serial->serial_lock);
1561 set_current_state(TASK_INTERRUPTIBLE);
1562 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1563 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1564 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1569 /* see if a signal did it */
1570 if (signal_pending(current)) {
1576 __set_current_state(TASK_RUNNING);
1577 remove_wait_queue(&tiocmget->waitq, &wait);
1583 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1584 * Return: write counters to the user passed counter struct
1585 * NB: both 1->0 and 0->1 transitions are counted except for
1586 * RI where only 0->1 is counted.
1588 static int hso_get_count(struct tty_struct *tty,
1589 struct serial_icounter_struct *icount)
1591 struct uart_icount cnow;
1592 struct hso_serial *serial = tty->driver_data;
1593 struct hso_tiocmget *tiocmget = serial->tiocmget;
1595 memset(icount, 0, sizeof(struct serial_icounter_struct));
1599 spin_lock_irq(&serial->serial_lock);
1600 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1601 spin_unlock_irq(&serial->serial_lock);
1603 icount->cts = cnow.cts;
1604 icount->dsr = cnow.dsr;
1605 icount->rng = cnow.rng;
1606 icount->dcd = cnow.dcd;
1607 icount->rx = cnow.rx;
1608 icount->tx = cnow.tx;
1609 icount->frame = cnow.frame;
1610 icount->overrun = cnow.overrun;
1611 icount->parity = cnow.parity;
1612 icount->brk = cnow.brk;
1613 icount->buf_overrun = cnow.buf_overrun;
1619 static int hso_serial_tiocmget(struct tty_struct *tty)
1622 struct hso_serial *serial = tty->driver_data;
1623 struct hso_tiocmget *tiocmget;
1624 u16 UART_state_bitmap;
1628 hso_dbg(0x1, "no tty structures\n");
1631 spin_lock_irq(&serial->serial_lock);
1632 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1633 ((serial->dtr_state) ? TIOCM_DTR : 0);
1634 tiocmget = serial->tiocmget;
1637 UART_state_bitmap = le16_to_cpu(
1638 tiocmget->prev_UART_state_bitmap);
1639 if (UART_state_bitmap & B_RING_SIGNAL)
1640 retval |= TIOCM_RNG;
1641 if (UART_state_bitmap & B_RX_CARRIER)
1643 if (UART_state_bitmap & B_TX_CARRIER)
1644 retval |= TIOCM_DSR;
1646 spin_unlock_irq(&serial->serial_lock);
1650 static int hso_serial_tiocmset(struct tty_struct *tty,
1651 unsigned int set, unsigned int clear)
1654 unsigned long flags;
1656 struct hso_serial *serial = tty->driver_data;
1657 struct usb_interface *interface;
1661 hso_dbg(0x1, "no tty structures\n");
1665 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1668 interface = serial->parent->interface;
1669 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
1671 spin_lock_irqsave(&serial->serial_lock, flags);
1672 if (set & TIOCM_RTS)
1673 serial->rts_state = 1;
1674 if (set & TIOCM_DTR)
1675 serial->dtr_state = 1;
1677 if (clear & TIOCM_RTS)
1678 serial->rts_state = 0;
1679 if (clear & TIOCM_DTR)
1680 serial->dtr_state = 0;
1682 if (serial->dtr_state)
1684 if (serial->rts_state)
1687 spin_unlock_irqrestore(&serial->serial_lock, flags);
1689 return usb_control_msg(serial->parent->usb,
1690 usb_sndctrlpipe(serial->parent->usb, 0), 0x22,
1691 0x21, val, if_num, NULL, 0,
1692 USB_CTRL_SET_TIMEOUT);
1695 static int hso_serial_ioctl(struct tty_struct *tty,
1696 unsigned int cmd, unsigned long arg)
1698 struct hso_serial *serial = tty->driver_data;
1700 hso_dbg(0x8, "IOCTL cmd: %d, arg: %ld\n", cmd, arg);
1706 ret = hso_wait_modem_status(serial, arg);
1716 /* starts a transmit */
1717 static void hso_kick_transmit(struct hso_serial *serial)
1719 unsigned long flags;
1722 spin_lock_irqsave(&serial->serial_lock, flags);
1723 if (!serial->tx_buffer_count)
1726 if (serial->tx_urb_used)
1729 /* Wakeup USB interface if necessary */
1730 if (hso_get_activity(serial->parent) == -EAGAIN)
1733 /* Switch pointers around to avoid memcpy */
1734 swap(serial->tx_buffer, serial->tx_data);
1735 serial->tx_data_count = serial->tx_buffer_count;
1736 serial->tx_buffer_count = 0;
1738 /* If serial->tx_data is set, it means we switched buffers */
1739 if (serial->tx_data && serial->write_data) {
1740 res = serial->write_data(serial);
1742 serial->tx_urb_used = 1;
1745 spin_unlock_irqrestore(&serial->serial_lock, flags);
1748 /* make a request (for reading and writing data to muxed serial port) */
1749 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1750 struct urb *ctrl_urb,
1751 struct usb_ctrlrequest *ctrl_req,
1752 u8 *ctrl_urb_data, u32 size)
1758 if (!serial || !ctrl_urb || !ctrl_req) {
1759 pr_err("%s: Wrong arguments\n", __func__);
1764 ctrl_req->wValue = 0;
1765 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1766 ctrl_req->wLength = cpu_to_le16(size);
1768 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1769 /* Reading command */
1770 ctrl_req->bRequestType = USB_DIR_IN |
1771 USB_TYPE_OPTION_VENDOR |
1772 USB_RECIP_INTERFACE;
1773 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1774 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1776 /* Writing command */
1777 ctrl_req->bRequestType = USB_DIR_OUT |
1778 USB_TYPE_OPTION_VENDOR |
1779 USB_RECIP_INTERFACE;
1780 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1781 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1784 hso_dbg(0x2, "%s command (%02x) len: %d, port: %d\n",
1785 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1786 ctrl_req->bRequestType, ctrl_req->wLength, port);
1789 ctrl_urb->transfer_flags = 0;
1790 usb_fill_control_urb(ctrl_urb,
1791 serial->parent->usb,
1794 ctrl_urb_data, size, ctrl_callback, serial);
1795 /* Send it on merry way */
1796 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1798 dev_err(&ctrl_urb->dev->dev,
1799 "%s failed submit ctrl_urb %d type %d\n", __func__,
1808 /* called by intr_callback when read occurs */
1809 static int hso_mux_serial_read(struct hso_serial *serial)
1815 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1816 /* make the request */
1818 if (serial->num_rx_urbs != 1) {
1819 dev_err(&serial->parent->interface->dev,
1820 "ERROR: mux'd reads with multiple buffers "
1824 return mux_device_request(serial,
1825 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1826 serial->parent->port_spec & HSO_PORT_MASK,
1828 &serial->ctrl_req_rx,
1829 serial->rx_data[0], serial->rx_data_length);
1832 /* used for muxed serial port callback (muxed serial read) */
1833 static void intr_callback(struct urb *urb)
1835 struct hso_shared_int *shared_int = urb->context;
1836 struct hso_serial *serial;
1837 unsigned char *port_req;
1838 int status = urb->status;
1839 unsigned long flags;
1842 usb_mark_last_busy(urb->dev);
1850 handle_usb_error(status, __func__, NULL);
1853 hso_dbg(0x8, "--- Got intr callback 0x%02X ---\n", status);
1856 port_req = urb->transfer_buffer;
1857 hso_dbg(0x8, "port_req = 0x%.2X\n", *port_req);
1858 /* loop over all muxed ports to find the one sending this */
1859 for (i = 0; i < 8; i++) {
1860 /* max 8 channels on MUX */
1861 if (*port_req & (1 << i)) {
1862 serial = get_serial_by_shared_int_and_type(shared_int,
1864 if (serial != NULL) {
1865 hso_dbg(0x1, "Pending read interrupt on port %d\n",
1867 spin_lock_irqsave(&serial->serial_lock, flags);
1868 if (serial->rx_state == RX_IDLE &&
1869 serial->port.count > 0) {
1870 /* Setup and send a ctrl req read on
1872 if (!serial->rx_urb_filled[0]) {
1873 serial->rx_state = RX_SENT;
1874 hso_mux_serial_read(serial);
1876 serial->rx_state = RX_PENDING;
1878 hso_dbg(0x1, "Already a read pending on port %d or port not open\n",
1881 spin_unlock_irqrestore(&serial->serial_lock,
1886 /* Resubmit interrupt urb */
1887 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1890 /* called for writing to muxed serial port */
1891 static int hso_mux_serial_write_data(struct hso_serial *serial)
1896 return mux_device_request(serial,
1897 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1898 serial->parent->port_spec & HSO_PORT_MASK,
1900 &serial->ctrl_req_tx,
1901 serial->tx_data, serial->tx_data_count);
1904 /* write callback for Diag and CS port */
1905 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1907 struct hso_serial *serial = urb->context;
1908 int status = urb->status;
1909 unsigned long flags;
1913 hso_dbg(0x1, "serial == NULL\n");
1917 spin_lock_irqsave(&serial->serial_lock, flags);
1918 serial->tx_urb_used = 0;
1919 spin_unlock_irqrestore(&serial->serial_lock, flags);
1921 handle_usb_error(status, __func__, serial->parent);
1924 hso_put_activity(serial->parent);
1925 tty_port_tty_wakeup(&serial->port);
1926 hso_kick_transmit(serial);
1931 /* called for writing diag or CS serial port */
1932 static int hso_std_serial_write_data(struct hso_serial *serial)
1934 int count = serial->tx_data_count;
1937 usb_fill_bulk_urb(serial->tx_urb,
1938 serial->parent->usb,
1939 usb_sndbulkpipe(serial->parent->usb,
1941 bEndpointAddress & 0x7F),
1942 serial->tx_data, serial->tx_data_count,
1943 hso_std_serial_write_bulk_callback, serial);
1945 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1947 dev_warn(&serial->parent->usb->dev,
1948 "Failed to submit urb - res %d\n", result);
1955 /* callback after read or write on muxed serial port */
1956 static void ctrl_callback(struct urb *urb)
1958 struct hso_serial *serial = urb->context;
1959 struct usb_ctrlrequest *req;
1960 int status = urb->status;
1961 unsigned long flags;
1967 spin_lock_irqsave(&serial->serial_lock, flags);
1968 serial->tx_urb_used = 0;
1969 spin_unlock_irqrestore(&serial->serial_lock, flags);
1971 handle_usb_error(status, __func__, serial->parent);
1976 req = (struct usb_ctrlrequest *)(urb->setup_packet);
1977 hso_dbg(0x8, "--- Got muxed ctrl callback 0x%02X ---\n", status);
1978 hso_dbg(0x8, "Actual length of urb = %d\n", urb->actual_length);
1979 DUMP1(urb->transfer_buffer, urb->actual_length);
1981 if (req->bRequestType ==
1982 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
1983 /* response to a read command */
1984 serial->rx_urb_filled[0] = 1;
1985 spin_lock_irqsave(&serial->serial_lock, flags);
1986 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1987 spin_unlock_irqrestore(&serial->serial_lock, flags);
1989 hso_put_activity(serial->parent);
1990 tty_port_tty_wakeup(&serial->port);
1991 /* response to a write command */
1992 hso_kick_transmit(serial);
1996 /* handle RX data for serial port */
1997 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
1999 struct tty_struct *tty;
2003 if (urb == NULL || serial == NULL) {
2004 hso_dbg(0x1, "serial = NULL\n");
2008 tty = tty_port_tty_get(&serial->port);
2010 if (tty && tty_throttled(tty)) {
2015 /* Push data to tty */
2016 hso_dbg(0x1, "data to push to tty\n");
2017 count = tty_buffer_request_room(&serial->port, urb->actual_length);
2018 if (count >= urb->actual_length) {
2019 tty_insert_flip_string(&serial->port, urb->transfer_buffer,
2020 urb->actual_length);
2021 tty_flip_buffer_push(&serial->port);
2023 dev_warn(&serial->parent->usb->dev,
2024 "dropping data, %d bytes lost\n", urb->actual_length);
2029 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2035 /* Base driver functions */
2037 static void hso_log_port(struct hso_device *hso_dev)
2042 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2043 case HSO_PORT_CONTROL:
2044 port_type = "Control";
2047 port_type = "Application";
2052 case HSO_PORT_GPS_CONTROL:
2053 port_type = "GPS control";
2056 port_type = "Application2";
2062 port_type = "Diagnostic";
2064 case HSO_PORT_DIAG2:
2065 port_type = "Diagnostic2";
2067 case HSO_PORT_MODEM:
2068 port_type = "Modem";
2070 case HSO_PORT_NETWORK:
2071 port_type = "Network";
2074 port_type = "Unknown";
2077 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2078 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2080 sprintf(port_dev, "/dev/%s%d", tty_filename,
2081 dev2ser(hso_dev)->minor);
2083 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2084 port_type, port_dev);
2087 static int hso_start_net_device(struct hso_device *hso_dev)
2090 struct hso_net *hso_net = dev2net(hso_dev);
2095 /* send URBs for all read buffers */
2096 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2098 /* Prep a receive URB */
2099 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2101 usb_rcvbulkpipe(hso_dev->usb,
2103 bEndpointAddress & 0x7F),
2104 hso_net->mux_bulk_rx_buf_pool[i],
2105 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2108 /* Put it out there so the device can send us stuff */
2109 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2112 dev_warn(&hso_dev->usb->dev,
2113 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2120 static int hso_stop_net_device(struct hso_device *hso_dev)
2123 struct hso_net *hso_net = dev2net(hso_dev);
2128 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2129 if (hso_net->mux_bulk_rx_urb_pool[i])
2130 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2133 if (hso_net->mux_bulk_tx_urb)
2134 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2139 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2142 struct hso_serial *serial = dev2ser(hso_dev);
2147 /* If it is not the MUX port fill in and submit a bulk urb (already
2148 * allocated in hso_serial_start) */
2149 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2150 for (i = 0; i < serial->num_rx_urbs; i++) {
2151 usb_fill_bulk_urb(serial->rx_urb[i],
2152 serial->parent->usb,
2153 usb_rcvbulkpipe(serial->parent->usb,
2158 serial->rx_data_length,
2159 hso_std_serial_read_bulk_callback,
2161 result = usb_submit_urb(serial->rx_urb[i], flags);
2163 dev_warn(&serial->parent->usb->dev,
2164 "Failed to submit urb - res %d\n",
2170 mutex_lock(&serial->shared_int->shared_int_lock);
2171 if (!serial->shared_int->use_count) {
2173 hso_mux_submit_intr_urb(serial->shared_int,
2174 hso_dev->usb, flags);
2176 serial->shared_int->use_count++;
2177 mutex_unlock(&serial->shared_int->shared_int_lock);
2179 if (serial->tiocmget)
2180 tiocmget_submit_urb(serial,
2182 serial->parent->usb);
2186 static int hso_stop_serial_device(struct hso_device *hso_dev)
2189 struct hso_serial *serial = dev2ser(hso_dev);
2190 struct hso_tiocmget *tiocmget;
2195 for (i = 0; i < serial->num_rx_urbs; i++) {
2196 if (serial->rx_urb[i]) {
2197 usb_kill_urb(serial->rx_urb[i]);
2198 serial->rx_urb_filled[i] = 0;
2201 serial->curr_rx_urb_idx = 0;
2204 usb_kill_urb(serial->tx_urb);
2206 if (serial->shared_int) {
2207 mutex_lock(&serial->shared_int->shared_int_lock);
2208 if (serial->shared_int->use_count &&
2209 (--serial->shared_int->use_count == 0)) {
2212 urb = serial->shared_int->shared_intr_urb;
2216 mutex_unlock(&serial->shared_int->shared_int_lock);
2218 tiocmget = serial->tiocmget;
2220 wake_up_interruptible(&tiocmget->waitq);
2221 usb_kill_urb(tiocmget->urb);
2227 static void hso_serial_tty_unregister(struct hso_serial *serial)
2229 tty_unregister_device(tty_drv, serial->minor);
2230 release_minor(serial);
2233 static void hso_serial_common_free(struct hso_serial *serial)
2237 for (i = 0; i < serial->num_rx_urbs; i++) {
2238 /* unlink and free RX URB */
2239 usb_free_urb(serial->rx_urb[i]);
2240 /* free the RX buffer */
2241 kfree(serial->rx_data[i]);
2244 /* unlink and free TX URB */
2245 usb_free_urb(serial->tx_urb);
2246 kfree(serial->tx_buffer);
2247 kfree(serial->tx_data);
2248 tty_port_destroy(&serial->port);
2251 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2252 int rx_size, int tx_size)
2256 tty_port_init(&serial->port);
2258 if (obtain_minor(serial))
2261 /* register our minor number */
2262 serial->parent->dev = tty_port_register_device_attr(&serial->port,
2263 tty_drv, serial->minor, &serial->parent->interface->dev,
2264 serial->parent, hso_serial_dev_groups);
2265 if (IS_ERR(serial->parent->dev)) {
2266 release_minor(serial);
2270 serial->magic = HSO_SERIAL_MAGIC;
2271 spin_lock_init(&serial->serial_lock);
2272 serial->num_rx_urbs = num_urbs;
2274 /* RX, allocate urb and initialize */
2276 /* prepare our RX buffer */
2277 serial->rx_data_length = rx_size;
2278 for (i = 0; i < serial->num_rx_urbs; i++) {
2279 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2280 if (!serial->rx_urb[i])
2282 serial->rx_urb[i]->transfer_buffer = NULL;
2283 serial->rx_urb[i]->transfer_buffer_length = 0;
2284 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2286 if (!serial->rx_data[i])
2290 /* TX, allocate urb and initialize */
2291 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2292 if (!serial->tx_urb)
2294 serial->tx_urb->transfer_buffer = NULL;
2295 serial->tx_urb->transfer_buffer_length = 0;
2296 /* prepare our TX buffer */
2297 serial->tx_data_count = 0;
2298 serial->tx_buffer_count = 0;
2299 serial->tx_data_length = tx_size;
2300 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2301 if (!serial->tx_data)
2304 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2305 if (!serial->tx_buffer)
2310 hso_serial_tty_unregister(serial);
2312 hso_serial_common_free(serial);
2316 /* Creates a general hso device */
2317 static struct hso_device *hso_create_device(struct usb_interface *intf,
2320 struct hso_device *hso_dev;
2322 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2326 hso_dev->port_spec = port_spec;
2327 hso_dev->usb = interface_to_usbdev(intf);
2328 hso_dev->interface = intf;
2329 kref_init(&hso_dev->ref);
2330 mutex_init(&hso_dev->mutex);
2332 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2333 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2338 /* Removes a network device in the network device table */
2339 static int remove_net_device(struct hso_device *hso_dev)
2343 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2344 if (network_table[i] == hso_dev) {
2345 network_table[i] = NULL;
2349 if (i == HSO_MAX_NET_DEVICES)
2354 /* Frees our network device */
2355 static void hso_free_net_device(struct hso_device *hso_dev)
2358 struct hso_net *hso_net = dev2net(hso_dev);
2363 remove_net_device(hso_net->parent);
2366 unregister_netdev(hso_net->net);
2369 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2370 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2371 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2372 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2374 usb_free_urb(hso_net->mux_bulk_tx_urb);
2375 kfree(hso_net->mux_bulk_tx_buf);
2376 hso_net->mux_bulk_tx_buf = NULL;
2379 free_netdev(hso_net->net);
2384 static const struct net_device_ops hso_netdev_ops = {
2385 .ndo_open = hso_net_open,
2386 .ndo_stop = hso_net_close,
2387 .ndo_start_xmit = hso_net_start_xmit,
2388 .ndo_tx_timeout = hso_net_tx_timeout,
2391 /* initialize the network interface */
2392 static void hso_net_init(struct net_device *net)
2394 struct hso_net *hso_net = netdev_priv(net);
2396 hso_dbg(0x1, "sizeof hso_net is %zu\n", sizeof(*hso_net));
2398 /* fill in the other fields */
2399 net->netdev_ops = &hso_netdev_ops;
2400 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2401 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2402 net->type = ARPHRD_NONE;
2403 net->mtu = DEFAULT_MTU - 14;
2404 net->tx_queue_len = 10;
2405 net->ethtool_ops = &ops;
2407 /* and initialize the semaphore */
2408 spin_lock_init(&hso_net->net_lock);
2411 /* Adds a network device in the network device table */
2412 static int add_net_device(struct hso_device *hso_dev)
2416 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2417 if (network_table[i] == NULL) {
2418 network_table[i] = hso_dev;
2422 if (i == HSO_MAX_NET_DEVICES)
2427 static int hso_rfkill_set_block(void *data, bool blocked)
2429 struct hso_device *hso_dev = data;
2430 int enabled = !blocked;
2433 mutex_lock(&hso_dev->mutex);
2434 if (hso_dev->usb_gone)
2437 rv = usb_control_msg(hso_dev->usb, usb_sndctrlpipe(hso_dev->usb, 0),
2438 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2439 USB_CTRL_SET_TIMEOUT);
2440 mutex_unlock(&hso_dev->mutex);
2444 static const struct rfkill_ops hso_rfkill_ops = {
2445 .set_block = hso_rfkill_set_block,
2448 /* Creates and sets up everything for rfkill */
2449 static void hso_create_rfkill(struct hso_device *hso_dev,
2450 struct usb_interface *interface)
2452 struct hso_net *hso_net = dev2net(hso_dev);
2453 struct device *dev = &hso_net->net->dev;
2454 static u32 rfkill_counter;
2456 snprintf(hso_net->name, sizeof(hso_net->name), "hso-%d",
2459 hso_net->rfkill = rfkill_alloc(hso_net->name,
2460 &interface_to_usbdev(interface)->dev,
2462 &hso_rfkill_ops, hso_dev);
2463 if (!hso_net->rfkill)
2466 if (rfkill_register(hso_net->rfkill) < 0) {
2467 rfkill_destroy(hso_net->rfkill);
2468 hso_net->rfkill = NULL;
2469 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2474 static struct device_type hso_type = {
2478 /* Creates our network device */
2479 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2483 struct net_device *net;
2484 struct hso_net *hso_net;
2485 struct hso_device *hso_dev;
2487 hso_dev = hso_create_device(interface, port_spec);
2491 /* allocate our network device, then we can put in our private data */
2492 /* call hso_net_init to do the basic initialization */
2493 net = alloc_netdev(sizeof(struct hso_net), "hso%d", NET_NAME_UNKNOWN,
2496 dev_err(&interface->dev, "Unable to create ethernet device\n");
2500 hso_net = netdev_priv(net);
2502 hso_dev->port_data.dev_net = hso_net;
2504 hso_net->parent = hso_dev;
2506 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2508 if (!hso_net->in_endp) {
2509 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2512 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2514 if (!hso_net->out_endp) {
2515 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2518 SET_NETDEV_DEV(net, &interface->dev);
2519 SET_NETDEV_DEVTYPE(net, &hso_type);
2521 /* start allocating */
2522 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2523 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2524 if (!hso_net->mux_bulk_rx_urb_pool[i])
2525 goto err_mux_bulk_rx;
2526 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2528 if (!hso_net->mux_bulk_rx_buf_pool[i])
2529 goto err_mux_bulk_rx;
2531 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2532 if (!hso_net->mux_bulk_tx_urb)
2533 goto err_mux_bulk_rx;
2534 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2535 if (!hso_net->mux_bulk_tx_buf)
2536 goto err_free_tx_urb;
2538 result = add_net_device(hso_dev);
2540 dev_err(&interface->dev, "Failed to add net device\n");
2541 goto err_free_tx_buf;
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);
2558 remove_net_device(hso_dev);
2560 kfree(hso_net->mux_bulk_tx_buf);
2562 usb_free_urb(hso_net->mux_bulk_tx_urb);
2564 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2565 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2566 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2575 static void hso_free_tiomget(struct hso_serial *serial)
2577 struct hso_tiocmget *tiocmget;
2580 tiocmget = serial->tiocmget;
2582 usb_free_urb(tiocmget->urb);
2583 tiocmget->urb = NULL;
2584 serial->tiocmget = NULL;
2585 kfree(tiocmget->serial_state_notification);
2586 tiocmget->serial_state_notification = NULL;
2591 /* Frees an AT channel ( goes for both mux and non-mux ) */
2592 static void hso_free_serial_device(struct hso_device *hso_dev)
2594 struct hso_serial *serial = dev2ser(hso_dev);
2599 hso_serial_common_free(serial);
2601 if (serial->shared_int) {
2602 mutex_lock(&serial->shared_int->shared_int_lock);
2603 if (--serial->shared_int->ref_count == 0)
2604 hso_free_shared_int(serial->shared_int);
2606 mutex_unlock(&serial->shared_int->shared_int_lock);
2608 hso_free_tiomget(serial);
2613 /* Creates a bulk AT channel */
2614 static struct hso_device *hso_create_bulk_serial_device(
2615 struct usb_interface *interface, int port)
2617 struct hso_device *hso_dev;
2618 struct hso_serial *serial;
2620 struct hso_tiocmget *tiocmget;
2622 hso_dev = hso_create_device(interface, port);
2626 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2630 serial->parent = hso_dev;
2631 hso_dev->port_data.dev_serial = serial;
2633 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2635 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2637 if (!serial->tiocmget)
2639 serial->tiocmget->serial_state_notification
2640 = kzalloc(sizeof(struct hso_serial_state_notification),
2642 if (!serial->tiocmget->serial_state_notification)
2644 tiocmget = serial->tiocmget;
2645 tiocmget->endp = hso_get_ep(interface,
2646 USB_ENDPOINT_XFER_INT,
2648 if (!tiocmget->endp) {
2649 dev_err(&interface->dev, "Failed to find INT IN ep\n");
2653 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2657 mutex_init(&tiocmget->mutex);
2658 init_waitqueue_head(&tiocmget->waitq);
2663 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2667 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2669 if (!serial->in_endp) {
2670 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2676 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2677 dev_err(&interface->dev, "Failed to find BULK OUT ep\n");
2681 serial->write_data = hso_std_serial_write_data;
2683 /* setup the proc dirs and files if needed */
2684 hso_log_port(hso_dev);
2686 /* done, return it */
2690 hso_serial_tty_unregister(serial);
2691 hso_serial_common_free(serial);
2693 hso_free_tiomget(serial);
2699 /* Creates a multiplexed AT channel */
2701 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2703 struct hso_shared_int *mux)
2705 struct hso_device *hso_dev;
2706 struct hso_serial *serial;
2709 port_spec = HSO_INTF_MUX;
2710 port_spec &= ~HSO_PORT_MASK;
2712 port_spec |= hso_mux_to_port(port);
2713 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2716 hso_dev = hso_create_device(interface, port_spec);
2720 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2724 hso_dev->port_data.dev_serial = serial;
2725 serial->parent = hso_dev;
2727 if (hso_serial_common_create
2728 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2729 goto err_free_serial;
2731 serial->tx_data_length--;
2732 serial->write_data = hso_mux_serial_write_data;
2734 serial->shared_int = mux;
2735 mutex_lock(&serial->shared_int->shared_int_lock);
2736 serial->shared_int->ref_count++;
2737 mutex_unlock(&serial->shared_int->shared_int_lock);
2739 /* setup the proc dirs and files if needed */
2740 hso_log_port(hso_dev);
2742 /* done, return it */
2753 static void hso_free_shared_int(struct hso_shared_int *mux)
2755 usb_free_urb(mux->shared_intr_urb);
2756 kfree(mux->shared_intr_buf);
2757 mutex_unlock(&mux->shared_int_lock);
2762 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2764 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2769 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2771 if (!mux->intr_endp) {
2772 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2776 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2777 if (!mux->shared_intr_urb)
2779 mux->shared_intr_buf =
2780 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2782 if (!mux->shared_intr_buf)
2785 mutex_init(&mux->shared_int_lock);
2790 kfree(mux->shared_intr_buf);
2791 usb_free_urb(mux->shared_intr_urb);
2796 /* Gets the port spec for a certain interface */
2797 static int hso_get_config_data(struct usb_interface *interface)
2799 struct usb_device *usbdev = interface_to_usbdev(interface);
2800 u8 *config_data = kmalloc(17, GFP_KERNEL);
2801 u32 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2806 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2807 0x86, 0xC0, 0, 0, config_data, 17,
2808 USB_CTRL_SET_TIMEOUT) != 0x11) {
2813 /* check if we have a valid interface */
2819 switch (config_data[if_num]) {
2824 result = HSO_PORT_DIAG;
2827 result = HSO_PORT_GPS;
2830 result = HSO_PORT_GPS_CONTROL;
2833 result = HSO_PORT_APP;
2836 result = HSO_PORT_APP2;
2839 result = HSO_PORT_CONTROL;
2842 result = HSO_PORT_NETWORK;
2845 result = HSO_PORT_MODEM;
2848 result = HSO_PORT_MSD;
2851 result = HSO_PORT_PCSC;
2854 result = HSO_PORT_VOICE;
2861 result |= HSO_INTF_BULK;
2863 if (config_data[16] & 0x1)
2864 result |= HSO_INFO_CRC_BUG;
2870 /* called once for each interface upon device insertion */
2871 static int hso_probe(struct usb_interface *interface,
2872 const struct usb_device_id *id)
2874 int mux, i, if_num, port_spec;
2875 unsigned char port_mask;
2876 struct hso_device *hso_dev = NULL;
2877 struct hso_shared_int *shared_int;
2878 struct hso_device *tmp_dev = NULL;
2880 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2881 dev_err(&interface->dev, "Not our interface\n");
2885 if_num = interface->cur_altsetting->desc.bInterfaceNumber;
2887 /* Get the interface/port specification from either driver_info or from
2888 * the device itself */
2889 if (id->driver_info) {
2890 /* if_num is controlled by the device, driver_info is a 0 terminated
2891 * array. Make sure, the access is in bounds! */
2892 for (i = 0; i <= if_num; ++i)
2893 if (((u32 *)(id->driver_info))[i] == 0)
2895 port_spec = ((u32 *)(id->driver_info))[if_num];
2897 port_spec = hso_get_config_data(interface);
2902 /* Check if we need to switch to alt interfaces prior to port
2904 if (interface->num_altsetting > 1)
2905 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2906 interface->needs_remote_wakeup = 1;
2908 /* Allocate new hso device(s) */
2909 switch (port_spec & HSO_INTF_MASK) {
2911 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2912 /* Create the network device */
2914 hso_dev = hso_create_net_device(interface,
2922 if (hso_get_mux_ports(interface, &port_mask))
2923 /* TODO: de-allocate everything */
2926 shared_int = hso_create_shared_int(interface);
2930 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2931 if (port_mask & i) {
2932 hso_dev = hso_create_mux_serial_device(
2933 interface, i, shared_int);
2944 /* It's a regular bulk interface */
2945 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2948 hso_create_net_device(interface, port_spec);
2951 hso_create_bulk_serial_device(interface, port_spec);
2960 /* save our data pointer in this device */
2961 usb_set_intfdata(interface, hso_dev);
2966 hso_free_interface(interface);
2970 /* device removed, cleaning up */
2971 static void hso_disconnect(struct usb_interface *interface)
2973 hso_free_interface(interface);
2975 /* remove reference of our private data */
2976 usb_set_intfdata(interface, NULL);
2979 static void async_get_intf(struct work_struct *data)
2981 struct hso_device *hso_dev =
2982 container_of(data, struct hso_device, async_get_intf);
2983 usb_autopm_get_interface(hso_dev->interface);
2986 static void async_put_intf(struct work_struct *data)
2988 struct hso_device *hso_dev =
2989 container_of(data, struct hso_device, async_put_intf);
2990 usb_autopm_put_interface(hso_dev->interface);
2993 static int hso_get_activity(struct hso_device *hso_dev)
2995 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
2996 if (!hso_dev->is_active) {
2997 hso_dev->is_active = 1;
2998 schedule_work(&hso_dev->async_get_intf);
3002 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3005 usb_mark_last_busy(hso_dev->usb);
3010 static int hso_put_activity(struct hso_device *hso_dev)
3012 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3013 if (hso_dev->is_active) {
3014 hso_dev->is_active = 0;
3015 schedule_work(&hso_dev->async_put_intf);
3019 hso_dev->is_active = 0;
3023 /* called by kernel when we need to suspend device */
3024 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3028 /* Stop all serial ports */
3029 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3030 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3031 result = hso_stop_serial_device(serial_table[i]);
3037 /* Stop all network ports */
3038 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3039 if (network_table[i] &&
3040 (network_table[i]->interface == iface)) {
3041 result = hso_stop_net_device(network_table[i]);
3051 /* called by kernel when we need to resume device */
3052 static int hso_resume(struct usb_interface *iface)
3055 struct hso_net *hso_net;
3057 /* Start all serial ports */
3058 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3059 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3060 if (dev2ser(serial_table[i])->port.count) {
3062 hso_start_serial_device(serial_table[i], GFP_NOIO);
3063 hso_kick_transmit(dev2ser(serial_table[i]));
3070 /* Start all network ports */
3071 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3072 if (network_table[i] &&
3073 (network_table[i]->interface == iface)) {
3074 hso_net = dev2net(network_table[i]);
3075 if (hso_net->flags & IFF_UP) {
3076 /* First transmit any lingering data,
3077 then restart the device. */
3078 if (hso_net->skb_tx_buf) {
3079 dev_dbg(&iface->dev,
3081 " lingering data\n");
3082 hso_net_start_xmit(hso_net->skb_tx_buf,
3084 hso_net->skb_tx_buf = NULL;
3086 result = hso_start_net_device(network_table[i]);
3097 static void hso_serial_ref_free(struct kref *ref)
3099 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3101 hso_free_serial_device(hso_dev);
3104 static void hso_free_interface(struct usb_interface *interface)
3106 struct hso_serial *serial;
3109 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3110 if (serial_table[i] &&
3111 (serial_table[i]->interface == interface)) {
3112 serial = dev2ser(serial_table[i]);
3113 tty_port_tty_hangup(&serial->port, false);
3114 mutex_lock(&serial->parent->mutex);
3115 serial->parent->usb_gone = 1;
3116 mutex_unlock(&serial->parent->mutex);
3117 cancel_work_sync(&serial_table[i]->async_put_intf);
3118 cancel_work_sync(&serial_table[i]->async_get_intf);
3119 hso_serial_tty_unregister(serial);
3120 kref_put(&serial->parent->ref, hso_serial_ref_free);
3124 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3125 if (network_table[i] &&
3126 (network_table[i]->interface == interface)) {
3127 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3128 /* hso_stop_net_device doesn't stop the net queue since
3129 * traffic needs to start it again when suspended */
3130 netif_stop_queue(dev2net(network_table[i])->net);
3131 hso_stop_net_device(network_table[i]);
3132 cancel_work_sync(&network_table[i]->async_put_intf);
3133 cancel_work_sync(&network_table[i]->async_get_intf);
3135 rfkill_unregister(rfk);
3136 rfkill_destroy(rfk);
3138 hso_free_net_device(network_table[i]);
3143 /* Helper functions */
3145 /* Get the endpoint ! */
3146 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3150 struct usb_host_interface *iface = intf->cur_altsetting;
3151 struct usb_endpoint_descriptor *endp;
3153 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3154 endp = &iface->endpoint[i].desc;
3155 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3156 (usb_endpoint_type(endp) == type))
3163 /* Get the byte that describes which ports are enabled */
3164 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3167 struct usb_host_interface *iface = intf->cur_altsetting;
3169 if (iface->extralen == 3) {
3170 *ports = iface->extra[2];
3174 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3175 if (iface->endpoint[i].extralen == 3) {
3176 *ports = iface->endpoint[i].extra[2];
3184 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3185 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3186 struct usb_device *usb, gfp_t gfp)
3190 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3192 shared_int->intr_endp->bEndpointAddress & 0x7F),
3193 shared_int->shared_intr_buf,
3195 intr_callback, shared_int,
3196 shared_int->intr_endp->bInterval);
3198 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3200 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3206 /* operations setup of the serial interface */
3207 static const struct tty_operations hso_serial_ops = {
3208 .open = hso_serial_open,
3209 .close = hso_serial_close,
3210 .write = hso_serial_write,
3211 .write_room = hso_serial_write_room,
3212 .cleanup = hso_serial_cleanup,
3213 .ioctl = hso_serial_ioctl,
3214 .set_termios = hso_serial_set_termios,
3215 .chars_in_buffer = hso_serial_chars_in_buffer,
3216 .tiocmget = hso_serial_tiocmget,
3217 .tiocmset = hso_serial_tiocmset,
3218 .get_icount = hso_get_count,
3219 .unthrottle = hso_unthrottle
3222 static struct usb_driver hso_driver = {
3223 .name = driver_name,
3225 .disconnect = hso_disconnect,
3226 .id_table = hso_ids,
3227 .suspend = hso_suspend,
3228 .resume = hso_resume,
3229 .reset_resume = hso_resume,
3230 .supports_autosuspend = 1,
3231 .disable_hub_initiated_lpm = 1,
3234 static int __init hso_init(void)
3239 /* put it in the log */
3240 pr_info("%s\n", version);
3242 /* Initialise the serial table semaphore and table */
3243 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3244 serial_table[i] = NULL;
3246 /* allocate our driver using the proper amount of supported minors */
3247 tty_drv = tty_alloc_driver(HSO_SERIAL_TTY_MINORS, TTY_DRIVER_REAL_RAW |
3248 TTY_DRIVER_DYNAMIC_DEV);
3249 if (IS_ERR(tty_drv))
3250 return PTR_ERR(tty_drv);
3252 /* fill in all needed values */
3253 tty_drv->driver_name = driver_name;
3254 tty_drv->name = tty_filename;
3256 /* if major number is provided as parameter, use that one */
3258 tty_drv->major = tty_major;
3260 tty_drv->minor_start = 0;
3261 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3262 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3263 tty_drv->init_termios = tty_std_termios;
3264 hso_init_termios(&tty_drv->init_termios);
3265 tty_set_operations(tty_drv, &hso_serial_ops);
3267 /* register the tty driver */
3268 result = tty_register_driver(tty_drv);
3270 pr_err("%s - tty_register_driver failed(%d)\n",
3275 /* register this module as an usb driver */
3276 result = usb_register(&hso_driver);
3278 pr_err("Could not register hso driver - error: %d\n", result);
3285 tty_unregister_driver(tty_drv);
3287 tty_driver_kref_put(tty_drv);
3291 static void __exit hso_exit(void)
3293 pr_info("unloaded\n");
3295 tty_unregister_driver(tty_drv);
3296 /* deregister the usb driver */
3297 usb_deregister(&hso_driver);
3298 tty_driver_kref_put(tty_drv);
3301 /* Module definitions */
3302 module_init(hso_init);
3303 module_exit(hso_exit);
3305 MODULE_AUTHOR(MOD_AUTHOR);
3306 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3307 MODULE_LICENSE("GPL");
3309 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3310 MODULE_PARM_DESC(debug, "debug level mask [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3311 module_param(debug, int, 0644);
3313 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3314 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3315 module_param(tty_major, int, 0644);
3317 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3318 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3319 module_param(disable_net, int, 0644);