1 /******************************************************************************
3 * Driver for Option High Speed Mobile Devices.
5 * Copyright (C) 2008 Option International
9 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
12 * Copyright (C) 2008 Novell, Inc.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
29 *****************************************************************************/
31 /******************************************************************************
33 * Description of the device:
35 * Interface 0: Contains the IP network interface on the bulk end points.
36 * The multiplexed serial ports are using the interrupt and
38 * Interrupt contains a bitmap telling which multiplexed
39 * serialport needs servicing.
41 * Interface 1: Diagnostics port, uses bulk only, do not submit urbs until the
42 * port is opened, as this have a huge impact on the network port
45 * Interface 2: Standard modem interface - circuit switched interface, this
46 * can be used to make a standard ppp connection however it
47 * should not be used in conjunction with the IP network interface
48 * enabled for USB performance reasons i.e. if using this set
49 * ideally disable_net=1.
51 *****************************************************************************/
53 #include <linux/sched.h>
54 #include <linux/slab.h>
55 #include <linux/init.h>
56 #include <linux/delay.h>
57 #include <linux/netdevice.h>
58 #include <linux/module.h>
59 #include <linux/ethtool.h>
60 #include <linux/usb.h>
61 #include <linux/timer.h>
62 #include <linux/tty.h>
63 #include <linux/tty_driver.h>
64 #include <linux/tty_flip.h>
65 #include <linux/kmod.h>
66 #include <linux/rfkill.h>
68 #include <linux/uaccess.h>
69 #include <linux/usb/cdc.h>
71 #include <asm/byteorder.h>
72 #include <linux/serial_core.h>
73 #include <linux/serial.h>
76 #define MOD_AUTHOR "Option Wireless"
77 #define MOD_DESCRIPTION "USB High Speed Option driver"
78 #define MOD_LICENSE "GPL"
80 #define HSO_MAX_NET_DEVICES 10
81 #define HSO__MAX_MTU 2048
82 #define DEFAULT_MTU 1500
83 #define DEFAULT_MRU 1500
85 #define CTRL_URB_RX_SIZE 1024
86 #define CTRL_URB_TX_SIZE 64
88 #define BULK_URB_RX_SIZE 4096
89 #define BULK_URB_TX_SIZE 8192
91 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
92 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
93 #define MUX_BULK_RX_BUF_COUNT 4
94 #define USB_TYPE_OPTION_VENDOR 0x20
96 /* These definitions are used with the struct hso_net flags element */
97 /* - use *_bit operations on it. (bit indices not values.) */
98 #define HSO_NET_RUNNING 0
100 #define HSO_NET_TX_TIMEOUT (HZ*10)
102 #define HSO_SERIAL_MAGIC 0x48534f31
104 /* Number of ttys to handle */
105 #define HSO_SERIAL_TTY_MINORS 256
107 #define MAX_RX_URBS 2
109 /*****************************************************************************/
110 /* Debugging functions */
111 /*****************************************************************************/
112 #define D__(lvl_, fmt, arg...) \
114 printk(lvl_ "[%d:%s]: " fmt "\n", \
115 __LINE__, __func__, ## arg); \
118 #define D_(lvl, args...) \
121 D__(KERN_INFO, args); \
124 #define D1(args...) D_(0x01, ##args)
125 #define D2(args...) D_(0x02, ##args)
126 #define D3(args...) D_(0x04, ##args)
127 #define D4(args...) D_(0x08, ##args)
128 #define D5(args...) D_(0x10, ##args)
130 /*****************************************************************************/
132 /*****************************************************************************/
133 enum pkt_parse_state {
139 /*****************************************************************************/
141 /*****************************************************************************/
143 struct hso_shared_int {
144 struct usb_endpoint_descriptor *intr_endp;
145 void *shared_intr_buf;
146 struct urb *shared_intr_urb;
147 struct usb_device *usb;
150 struct mutex shared_int_lock;
154 struct hso_device *parent;
155 struct net_device *net;
156 struct rfkill *rfkill;
158 struct usb_endpoint_descriptor *in_endp;
159 struct usb_endpoint_descriptor *out_endp;
161 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
162 struct urb *mux_bulk_tx_urb;
163 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
164 void *mux_bulk_tx_buf;
166 struct sk_buff *skb_rx_buf;
167 struct sk_buff *skb_tx_buf;
169 enum pkt_parse_state rx_parse_state;
172 unsigned short rx_buf_size;
173 unsigned short rx_buf_missing;
174 struct iphdr rx_ip_hdr;
185 #define BM_REQUEST_TYPE (0xa1)
186 #define B_NOTIFICATION (0x20)
187 #define W_VALUE (0x0)
188 #define W_LENGTH (0x2)
190 #define B_OVERRUN (0x1<<6)
191 #define B_PARITY (0x1<<5)
192 #define B_FRAMING (0x1<<4)
193 #define B_RING_SIGNAL (0x1<<3)
194 #define B_BREAK (0x1<<2)
195 #define B_TX_CARRIER (0x1<<1)
196 #define B_RX_CARRIER (0x1<<0)
198 struct hso_serial_state_notification {
204 u16 UART_state_bitmap;
207 struct hso_tiocmget {
209 wait_queue_head_t waitq;
211 struct usb_endpoint_descriptor *endp;
213 struct hso_serial_state_notification serial_state_notification;
214 u16 prev_UART_state_bitmap;
215 struct uart_icount icount;
220 struct hso_device *parent;
224 struct hso_shared_int *shared_int;
226 /* rx/tx urb could be either a bulk urb or a control urb depending
227 on which serial port it is used on. */
228 struct urb *rx_urb[MAX_RX_URBS];
230 u8 *rx_data[MAX_RX_URBS];
231 u16 rx_data_length; /* should contain allocated length */
236 u16 tx_data_length; /* should contain allocated length */
239 struct usb_ctrlrequest ctrl_req_tx;
240 struct usb_ctrlrequest ctrl_req_rx;
242 struct usb_endpoint_descriptor *in_endp;
243 struct usb_endpoint_descriptor *out_endp;
245 enum rx_ctrl_state rx_state;
248 unsigned tx_urb_used:1;
250 struct tty_port port;
251 /* from usb_serial_port */
252 spinlock_t serial_lock;
254 int (*write_data) (struct hso_serial *serial);
255 struct hso_tiocmget *tiocmget;
256 /* Hacks required to get flow control
257 * working on the serial receive buffers
258 * so as not to drop characters on the floor.
261 u16 curr_rx_urb_offset;
262 u8 rx_urb_filled[MAX_RX_URBS];
263 struct tasklet_struct unthrottle_tasklet;
264 struct work_struct retry_unthrottle_workqueue;
269 struct hso_serial *dev_serial;
270 struct hso_net *dev_net;
277 struct work_struct async_get_intf;
278 struct work_struct async_put_intf;
279 struct work_struct reset_device;
281 struct usb_device *usb;
282 struct usb_interface *interface;
289 /* Type of interface */
290 #define HSO_INTF_MASK 0xFF00
291 #define HSO_INTF_MUX 0x0100
292 #define HSO_INTF_BULK 0x0200
295 #define HSO_PORT_MASK 0xFF
296 #define HSO_PORT_NO_PORT 0x0
297 #define HSO_PORT_CONTROL 0x1
298 #define HSO_PORT_APP 0x2
299 #define HSO_PORT_GPS 0x3
300 #define HSO_PORT_PCSC 0x4
301 #define HSO_PORT_APP2 0x5
302 #define HSO_PORT_GPS_CONTROL 0x6
303 #define HSO_PORT_MSD 0x7
304 #define HSO_PORT_VOICE 0x8
305 #define HSO_PORT_DIAG2 0x9
306 #define HSO_PORT_DIAG 0x10
307 #define HSO_PORT_MODEM 0x11
308 #define HSO_PORT_NETWORK 0x12
310 /* Additional device info */
311 #define HSO_INFO_MASK 0xFF000000
312 #define HSO_INFO_CRC_BUG 0x01000000
314 /*****************************************************************************/
316 /*****************************************************************************/
317 /* Serial driver functions */
318 static int hso_serial_tiocmset(struct tty_struct *tty,
319 unsigned int set, unsigned int clear);
320 static void ctrl_callback(struct urb *urb);
321 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
322 static void hso_kick_transmit(struct hso_serial *serial);
323 /* Helper functions */
324 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
325 struct usb_device *usb, gfp_t gfp);
326 static void handle_usb_error(int status, const char *function,
327 struct hso_device *hso_dev);
328 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
330 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
331 static void hso_free_interface(struct usb_interface *intf);
332 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
333 static int hso_stop_serial_device(struct hso_device *hso_dev);
334 static int hso_start_net_device(struct hso_device *hso_dev);
335 static void hso_free_shared_int(struct hso_shared_int *shared_int);
336 static int hso_stop_net_device(struct hso_device *hso_dev);
337 static void hso_serial_ref_free(struct kref *ref);
338 static void hso_std_serial_read_bulk_callback(struct urb *urb);
339 static int hso_mux_serial_read(struct hso_serial *serial);
340 static void async_get_intf(struct work_struct *data);
341 static void async_put_intf(struct work_struct *data);
342 static int hso_put_activity(struct hso_device *hso_dev);
343 static int hso_get_activity(struct hso_device *hso_dev);
344 static void tiocmget_intr_callback(struct urb *urb);
345 static void reset_device(struct work_struct *data);
346 /*****************************************************************************/
347 /* Helping functions */
348 /*****************************************************************************/
352 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
354 return hso_dev->port_data.dev_net;
357 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
359 return hso_dev->port_data.dev_serial;
362 /* Debugging functions */
364 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
367 static char name[255];
369 sprintf(name, "hso[%d:%s]", line_count, func_name);
370 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
373 #define DUMP(buf_, len_) \
374 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
376 #define DUMP1(buf_, len_) \
382 #define DUMP(buf_, len_)
383 #define DUMP1(buf_, len_)
386 /* module parameters */
388 static int tty_major;
389 static int disable_net;
392 static const char driver_name[] = "hso";
393 static const char tty_filename[] = "ttyHS";
394 static const char *version = __FILE__ ": " MOD_AUTHOR;
395 /* the usb driver itself (registered in hso_init) */
396 static struct usb_driver hso_driver;
397 /* serial structures */
398 static struct tty_driver *tty_drv;
399 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
400 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
401 static spinlock_t serial_table_lock;
403 static const s32 default_port_spec[] = {
404 HSO_INTF_MUX | HSO_PORT_NETWORK,
405 HSO_INTF_BULK | HSO_PORT_DIAG,
406 HSO_INTF_BULK | HSO_PORT_MODEM,
410 static const s32 icon321_port_spec[] = {
411 HSO_INTF_MUX | HSO_PORT_NETWORK,
412 HSO_INTF_BULK | HSO_PORT_DIAG2,
413 HSO_INTF_BULK | HSO_PORT_MODEM,
414 HSO_INTF_BULK | HSO_PORT_DIAG,
418 #define default_port_device(vendor, product) \
419 USB_DEVICE(vendor, product), \
420 .driver_info = (kernel_ulong_t)default_port_spec
422 #define icon321_port_device(vendor, product) \
423 USB_DEVICE(vendor, product), \
424 .driver_info = (kernel_ulong_t)icon321_port_spec
426 /* list of devices we support */
427 static const struct usb_device_id hso_ids[] = {
428 {default_port_device(0x0af0, 0x6711)},
429 {default_port_device(0x0af0, 0x6731)},
430 {default_port_device(0x0af0, 0x6751)},
431 {default_port_device(0x0af0, 0x6771)},
432 {default_port_device(0x0af0, 0x6791)},
433 {default_port_device(0x0af0, 0x6811)},
434 {default_port_device(0x0af0, 0x6911)},
435 {default_port_device(0x0af0, 0x6951)},
436 {default_port_device(0x0af0, 0x6971)},
437 {default_port_device(0x0af0, 0x7011)},
438 {default_port_device(0x0af0, 0x7031)},
439 {default_port_device(0x0af0, 0x7051)},
440 {default_port_device(0x0af0, 0x7071)},
441 {default_port_device(0x0af0, 0x7111)},
442 {default_port_device(0x0af0, 0x7211)},
443 {default_port_device(0x0af0, 0x7251)},
444 {default_port_device(0x0af0, 0x7271)},
445 {default_port_device(0x0af0, 0x7311)},
446 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
447 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
448 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
449 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
450 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
451 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
452 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
453 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
454 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
455 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
456 {USB_DEVICE(0x0af0, 0x7701)},
457 {USB_DEVICE(0x0af0, 0x7706)},
458 {USB_DEVICE(0x0af0, 0x7801)},
459 {USB_DEVICE(0x0af0, 0x7901)},
460 {USB_DEVICE(0x0af0, 0x7A01)},
461 {USB_DEVICE(0x0af0, 0x7A05)},
462 {USB_DEVICE(0x0af0, 0x8200)},
463 {USB_DEVICE(0x0af0, 0x8201)},
464 {USB_DEVICE(0x0af0, 0x8300)},
465 {USB_DEVICE(0x0af0, 0x8302)},
466 {USB_DEVICE(0x0af0, 0x8304)},
467 {USB_DEVICE(0x0af0, 0x8400)},
468 {USB_DEVICE(0x0af0, 0x8600)},
469 {USB_DEVICE(0x0af0, 0x8800)},
470 {USB_DEVICE(0x0af0, 0x8900)},
471 {USB_DEVICE(0x0af0, 0x9000)},
472 {USB_DEVICE(0x0af0, 0xd035)},
473 {USB_DEVICE(0x0af0, 0xd055)},
474 {USB_DEVICE(0x0af0, 0xd155)},
475 {USB_DEVICE(0x0af0, 0xd255)},
476 {USB_DEVICE(0x0af0, 0xd057)},
477 {USB_DEVICE(0x0af0, 0xd157)},
478 {USB_DEVICE(0x0af0, 0xd257)},
479 {USB_DEVICE(0x0af0, 0xd357)},
480 {USB_DEVICE(0x0af0, 0xd058)},
481 {USB_DEVICE(0x0af0, 0xc100)},
484 MODULE_DEVICE_TABLE(usb, hso_ids);
486 /* Sysfs attribute */
487 static ssize_t hso_sysfs_show_porttype(struct device *dev,
488 struct device_attribute *attr,
491 struct hso_device *hso_dev = dev_get_drvdata(dev);
497 switch (hso_dev->port_spec & HSO_PORT_MASK) {
498 case HSO_PORT_CONTROL:
499 port_name = "Control";
502 port_name = "Application";
505 port_name = "Application2";
510 case HSO_PORT_GPS_CONTROL:
511 port_name = "GPS Control";
517 port_name = "Diagnostic";
520 port_name = "Diagnostic2";
525 case HSO_PORT_NETWORK:
526 port_name = "Network";
529 port_name = "Unknown";
533 return sprintf(buf, "%s\n", port_name);
535 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
537 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
541 for (idx = 0; idx < serial->num_rx_urbs; idx++)
542 if (serial->rx_urb[idx] == urb)
544 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
548 /* converts mux value to a port spec value */
549 static u32 hso_mux_to_port(int mux)
555 result = HSO_PORT_CONTROL;
558 result = HSO_PORT_APP;
561 result = HSO_PORT_PCSC;
564 result = HSO_PORT_GPS;
567 result = HSO_PORT_APP2;
570 result = HSO_PORT_NO_PORT;
575 /* converts port spec value to a mux value */
576 static u32 hso_port_to_mux(int port)
580 switch (port & HSO_PORT_MASK) {
581 case HSO_PORT_CONTROL:
602 static struct hso_serial *get_serial_by_shared_int_and_type(
603 struct hso_shared_int *shared_int,
608 port = hso_mux_to_port(mux);
610 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
611 if (serial_table[i] &&
612 (dev2ser(serial_table[i])->shared_int == shared_int) &&
613 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
614 return dev2ser(serial_table[i]);
621 static struct hso_serial *get_serial_by_index(unsigned index)
623 struct hso_serial *serial = NULL;
626 spin_lock_irqsave(&serial_table_lock, flags);
627 if (serial_table[index])
628 serial = dev2ser(serial_table[index]);
629 spin_unlock_irqrestore(&serial_table_lock, flags);
634 static int get_free_serial_index(void)
639 spin_lock_irqsave(&serial_table_lock, flags);
640 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
641 if (serial_table[index] == NULL) {
642 spin_unlock_irqrestore(&serial_table_lock, flags);
646 spin_unlock_irqrestore(&serial_table_lock, flags);
648 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
652 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
656 spin_lock_irqsave(&serial_table_lock, flags);
658 serial_table[index] = serial->parent;
660 serial_table[index] = NULL;
661 spin_unlock_irqrestore(&serial_table_lock, flags);
664 static void handle_usb_error(int status, const char *function,
665 struct hso_device *hso_dev)
671 explanation = "no device";
674 explanation = "endpoint not enabled";
677 explanation = "endpoint stalled";
680 explanation = "not enough bandwidth";
683 explanation = "device disabled";
686 explanation = "device suspended";
692 explanation = "internal error";
698 explanation = "protocol error";
700 schedule_work(&hso_dev->reset_device);
703 explanation = "unknown status";
707 /* log a meaningful explanation of an USB status */
708 D1("%s: received USB status - %s (%d)", function, explanation, status);
711 /* Network interface functions */
713 /* called when net interface is brought up by ifconfig */
714 static int hso_net_open(struct net_device *net)
716 struct hso_net *odev = netdev_priv(net);
717 unsigned long flags = 0;
720 dev_err(&net->dev, "No net device !\n");
724 odev->skb_tx_buf = NULL;
726 /* setup environment */
727 spin_lock_irqsave(&odev->net_lock, flags);
728 odev->rx_parse_state = WAIT_IP;
729 odev->rx_buf_size = 0;
730 odev->rx_buf_missing = sizeof(struct iphdr);
731 spin_unlock_irqrestore(&odev->net_lock, flags);
733 /* We are up and running. */
734 set_bit(HSO_NET_RUNNING, &odev->flags);
735 hso_start_net_device(odev->parent);
737 /* Tell the kernel we are ready to start receiving from it */
738 netif_start_queue(net);
743 /* called when interface is brought down by ifconfig */
744 static int hso_net_close(struct net_device *net)
746 struct hso_net *odev = netdev_priv(net);
748 /* we don't need the queue anymore */
749 netif_stop_queue(net);
750 /* no longer running */
751 clear_bit(HSO_NET_RUNNING, &odev->flags);
753 hso_stop_net_device(odev->parent);
759 /* USB tells is xmit done, we should start the netqueue again */
760 static void write_bulk_callback(struct urb *urb)
762 struct hso_net *odev = urb->context;
763 int status = urb->status;
766 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
767 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
771 /* Do we still have a valid kernel network device? */
772 if (!netif_device_present(odev->net)) {
773 dev_err(&urb->dev->dev, "%s: net device not present\n",
778 /* log status, but don't act on it, we don't need to resubmit anything
781 handle_usb_error(status, __func__, odev->parent);
783 hso_put_activity(odev->parent);
785 /* Tell the network interface we are ready for another frame */
786 netif_wake_queue(odev->net);
789 /* called by kernel when we need to transmit a packet */
790 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
791 struct net_device *net)
793 struct hso_net *odev = netdev_priv(net);
796 /* Tell the kernel, "No more frames 'til we are done with this one." */
797 netif_stop_queue(net);
798 if (hso_get_activity(odev->parent) == -EAGAIN) {
799 odev->skb_tx_buf = skb;
804 DUMP1(skb->data, skb->len);
805 /* Copy it from kernel memory to OUR memory */
806 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
807 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
809 /* Fill in the URB for shipping it out. */
810 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
812 usb_sndbulkpipe(odev->parent->usb,
814 bEndpointAddress & 0x7F),
815 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
818 /* Deal with the Zero Length packet problem, I hope */
819 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
821 /* Send the URB on its merry way. */
822 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
824 dev_warn(&odev->parent->interface->dev,
825 "failed mux_bulk_tx_urb %d\n", result);
826 net->stats.tx_errors++;
827 netif_start_queue(net);
829 net->stats.tx_packets++;
830 net->stats.tx_bytes += skb->len;
837 static const struct ethtool_ops ops = {
838 .get_link = ethtool_op_get_link
841 /* called when a packet did not ack after watchdogtimeout */
842 static void hso_net_tx_timeout(struct net_device *net)
844 struct hso_net *odev = netdev_priv(net);
849 /* Tell syslog we are hosed. */
850 dev_warn(&net->dev, "Tx timed out.\n");
852 /* Tear the waiting frame off the list */
853 if (odev->mux_bulk_tx_urb &&
854 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
855 usb_unlink_urb(odev->mux_bulk_tx_urb);
857 /* Update statistics */
858 net->stats.tx_errors++;
861 /* make a real packet from the received USB buffer */
862 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
863 unsigned int count, unsigned char is_eop)
865 unsigned short temp_bytes;
866 unsigned short buffer_offset = 0;
867 unsigned short frame_len;
868 unsigned char *tmp_rx_buf;
871 D1("Rx %d bytes", count);
872 DUMP(ip_pkt, min(128, (int)count));
875 switch (odev->rx_parse_state) {
877 /* waiting for IP header. */
878 /* wanted bytes - size of ip header */
881 odev->rx_buf_missing) ? count : odev->
884 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
885 odev->rx_buf_size, ip_pkt + buffer_offset,
888 odev->rx_buf_size += temp_bytes;
889 buffer_offset += temp_bytes;
890 odev->rx_buf_missing -= temp_bytes;
893 if (!odev->rx_buf_missing) {
894 /* header is complete allocate an sk_buffer and
895 * continue to WAIT_DATA */
896 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
898 if ((frame_len > DEFAULT_MRU) ||
899 (frame_len < sizeof(struct iphdr))) {
900 dev_err(&odev->net->dev,
901 "Invalid frame (%d) length\n",
903 odev->rx_parse_state = WAIT_SYNC;
906 /* Allocate an sk_buff */
907 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
909 if (!odev->skb_rx_buf) {
910 /* We got no receive buffer. */
911 D1("could not allocate memory");
912 odev->rx_parse_state = WAIT_SYNC;
916 /* Copy what we got so far. make room for iphdr
919 skb_put(odev->skb_rx_buf,
920 sizeof(struct iphdr));
921 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
922 sizeof(struct iphdr));
925 odev->rx_buf_size = sizeof(struct iphdr);
927 /* Filip actually use .tot_len */
928 odev->rx_buf_missing =
929 frame_len - sizeof(struct iphdr);
930 odev->rx_parse_state = WAIT_DATA;
935 temp_bytes = (count < odev->rx_buf_missing)
936 ? count : odev->rx_buf_missing;
938 /* Copy the rest of the bytes that are left in the
939 * buffer into the waiting sk_buf. */
940 /* Make room for temp_bytes after tail. */
941 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
942 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
944 odev->rx_buf_missing -= temp_bytes;
946 buffer_offset += temp_bytes;
947 odev->rx_buf_size += temp_bytes;
948 if (!odev->rx_buf_missing) {
949 /* Packet is complete. Inject into stack. */
950 /* We have IP packet here */
951 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
952 skb_reset_mac_header(odev->skb_rx_buf);
954 /* Ship it off to the kernel */
955 netif_rx(odev->skb_rx_buf);
956 /* No longer our buffer. */
957 odev->skb_rx_buf = NULL;
959 /* update out statistics */
960 odev->net->stats.rx_packets++;
962 odev->net->stats.rx_bytes += odev->rx_buf_size;
964 odev->rx_buf_size = 0;
965 odev->rx_buf_missing = sizeof(struct iphdr);
966 odev->rx_parse_state = WAIT_IP;
981 /* Recovery mechanism for WAIT_SYNC state. */
983 if (odev->rx_parse_state == WAIT_SYNC) {
984 odev->rx_parse_state = WAIT_IP;
985 odev->rx_buf_size = 0;
986 odev->rx_buf_missing = sizeof(struct iphdr);
991 static void fix_crc_bug(struct urb *urb, __le16 max_packet_size)
993 static const u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
994 u32 rest = urb->actual_length % le16_to_cpu(max_packet_size);
996 if (((rest == 5) || (rest == 6)) &&
997 !memcmp(((u8 *)urb->transfer_buffer) + urb->actual_length - 4,
999 urb->actual_length -= 4;
1003 /* Moving data from usb to kernel (in interrupt state) */
1004 static void read_bulk_callback(struct urb *urb)
1006 struct hso_net *odev = urb->context;
1007 struct net_device *net;
1009 int status = urb->status;
1011 /* is al ok? (Filip: Who's Al ?) */
1013 handle_usb_error(status, __func__, odev->parent);
1018 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1019 D1("BULK IN callback but driver is not active!");
1022 usb_mark_last_busy(urb->dev);
1026 if (!netif_device_present(net)) {
1027 /* Somebody killed our network interface... */
1031 if (odev->parent->port_spec & HSO_INFO_CRC_BUG)
1032 fix_crc_bug(urb, odev->in_endp->wMaxPacketSize);
1034 /* do we even have a packet? */
1035 if (urb->actual_length) {
1036 /* Handle the IP stream, add header and push it onto network
1037 * stack if the packet is complete. */
1038 spin_lock(&odev->net_lock);
1039 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1040 (urb->transfer_buffer_length >
1041 urb->actual_length) ? 1 : 0);
1042 spin_unlock(&odev->net_lock);
1045 /* We are done with this URB, resubmit it. Prep the USB to wait for
1046 * another frame. Reuse same as received. */
1047 usb_fill_bulk_urb(urb,
1049 usb_rcvbulkpipe(odev->parent->usb,
1051 bEndpointAddress & 0x7F),
1052 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1053 read_bulk_callback, odev);
1055 /* Give this to the USB subsystem so it can tell us when more data
1057 result = usb_submit_urb(urb, GFP_ATOMIC);
1059 dev_warn(&odev->parent->interface->dev,
1060 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1064 /* Serial driver functions */
1066 static void hso_init_termios(struct ktermios *termios)
1069 * The default requirements for this device are:
1072 ~(IGNBRK /* disable ignore break */
1073 | BRKINT /* disable break causes interrupt */
1074 | PARMRK /* disable mark parity errors */
1075 | ISTRIP /* disable clear high bit of input characters */
1076 | INLCR /* disable translate NL to CR */
1077 | IGNCR /* disable ignore CR */
1078 | ICRNL /* disable translate CR to NL */
1079 | IXON); /* disable enable XON/XOFF flow control */
1081 /* disable postprocess output characters */
1082 termios->c_oflag &= ~OPOST;
1085 ~(ECHO /* disable echo input characters */
1086 | ECHONL /* disable echo new line */
1087 | ICANON /* disable erase, kill, werase, and rprnt
1088 special characters */
1089 | ISIG /* disable interrupt, quit, and suspend special
1091 | IEXTEN); /* disable non-POSIX special characters */
1094 ~(CSIZE /* no size */
1095 | PARENB /* disable parity bit */
1096 | CBAUD /* clear current baud rate */
1097 | CBAUDEX); /* clear current buad rate */
1099 termios->c_cflag |= CS8; /* character size 8 bits */
1101 /* baud rate 115200 */
1102 tty_termios_encode_baud_rate(termios, 115200, 115200);
1105 static void _hso_serial_set_termios(struct tty_struct *tty,
1106 struct ktermios *old)
1108 struct hso_serial *serial = tty->driver_data;
1111 printk(KERN_ERR "%s: no tty structures", __func__);
1115 D4("port %d", serial->minor);
1118 * Fix up unsupported bits
1120 tty->termios.c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1122 tty->termios.c_cflag &=
1123 ~(CSIZE /* no size */
1124 | PARENB /* disable parity bit */
1125 | CBAUD /* clear current baud rate */
1126 | CBAUDEX); /* clear current buad rate */
1128 tty->termios.c_cflag |= CS8; /* character size 8 bits */
1130 /* baud rate 115200 */
1131 tty_encode_baud_rate(tty, 115200, 115200);
1134 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1137 /* We are done with this URB, resubmit it. Prep the USB to wait for
1139 usb_fill_bulk_urb(urb, serial->parent->usb,
1140 usb_rcvbulkpipe(serial->parent->usb,
1142 bEndpointAddress & 0x7F),
1143 urb->transfer_buffer, serial->rx_data_length,
1144 hso_std_serial_read_bulk_callback, serial);
1145 /* Give this to the USB subsystem so it can tell us when more data
1147 result = usb_submit_urb(urb, GFP_ATOMIC);
1149 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1157 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1160 struct urb *curr_urb;
1162 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1163 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1164 count = put_rxbuf_data(curr_urb, serial);
1168 serial->curr_rx_urb_idx++;
1169 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1170 serial->curr_rx_urb_idx = 0;
1171 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1176 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1181 urb = serial->rx_urb[0];
1182 if (serial->port.count > 0) {
1183 count = put_rxbuf_data(urb, serial);
1187 /* Re issue a read as long as we receive data. */
1189 if (count == 0 && ((urb->actual_length != 0) ||
1190 (serial->rx_state == RX_PENDING))) {
1191 serial->rx_state = RX_SENT;
1192 hso_mux_serial_read(serial);
1194 serial->rx_state = RX_IDLE;
1198 /* read callback for Diag and CS port */
1199 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1201 struct hso_serial *serial = urb->context;
1202 int status = urb->status;
1204 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1208 D1("serial == NULL");
1212 handle_usb_error(status, __func__, serial->parent);
1216 D1("Actual length = %d\n", urb->actual_length);
1217 DUMP1(urb->transfer_buffer, urb->actual_length);
1219 /* Anyone listening? */
1220 if (serial->port.count == 0)
1223 if (serial->parent->port_spec & HSO_INFO_CRC_BUG)
1224 fix_crc_bug(urb, serial->in_endp->wMaxPacketSize);
1225 /* Valid data, handle RX data */
1226 spin_lock(&serial->serial_lock);
1227 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1228 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1229 spin_unlock(&serial->serial_lock);
1233 * This needs to be a tasklet otherwise we will
1234 * end up recursively calling this function.
1236 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1238 unsigned long flags;
1240 spin_lock_irqsave(&serial->serial_lock, flags);
1241 if ((serial->parent->port_spec & HSO_INTF_MUX))
1242 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1244 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1245 spin_unlock_irqrestore(&serial->serial_lock, flags);
1248 static void hso_unthrottle(struct tty_struct *tty)
1250 struct hso_serial *serial = tty->driver_data;
1252 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1255 static void hso_unthrottle_workfunc(struct work_struct *work)
1257 struct hso_serial *serial =
1258 container_of(work, struct hso_serial,
1259 retry_unthrottle_workqueue);
1260 hso_unthrottle_tasklet(serial);
1263 /* open the requested serial port */
1264 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1266 struct hso_serial *serial = get_serial_by_index(tty->index);
1270 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1272 tty->driver_data = NULL;
1273 D1("Failed to open port");
1277 mutex_lock(&serial->parent->mutex);
1278 result = usb_autopm_get_interface(serial->parent->interface);
1282 D1("Opening %d", serial->minor);
1283 kref_get(&serial->parent->ref);
1286 tty->driver_data = serial;
1287 tty_port_tty_set(&serial->port, tty);
1289 /* check for port already opened, if not set the termios */
1290 serial->port.count++;
1291 if (serial->port.count == 1) {
1292 serial->rx_state = RX_IDLE;
1293 /* Force default termio settings */
1294 _hso_serial_set_termios(tty, NULL);
1295 tasklet_init(&serial->unthrottle_tasklet,
1296 (void (*)(unsigned long))hso_unthrottle_tasklet,
1297 (unsigned long)serial);
1298 INIT_WORK(&serial->retry_unthrottle_workqueue,
1299 hso_unthrottle_workfunc);
1300 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1302 hso_stop_serial_device(serial->parent);
1303 serial->port.count--;
1304 kref_put(&serial->parent->ref, hso_serial_ref_free);
1307 D1("Port was already open");
1310 usb_autopm_put_interface(serial->parent->interface);
1314 hso_serial_tiocmset(tty, TIOCM_RTS | TIOCM_DTR, 0);
1316 mutex_unlock(&serial->parent->mutex);
1320 /* close the requested serial port */
1321 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1323 struct hso_serial *serial = tty->driver_data;
1326 D1("Closing serial port");
1328 /* Open failed, no close cleanup required */
1332 mutex_lock(&serial->parent->mutex);
1333 usb_gone = serial->parent->usb_gone;
1336 usb_autopm_get_interface(serial->parent->interface);
1338 /* reset the rts and dtr */
1339 /* do the actual close */
1340 serial->port.count--;
1342 if (serial->port.count <= 0) {
1343 serial->port.count = 0;
1344 tty_port_tty_set(&serial->port, NULL);
1346 hso_stop_serial_device(serial->parent);
1347 tasklet_kill(&serial->unthrottle_tasklet);
1348 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1352 usb_autopm_put_interface(serial->parent->interface);
1354 mutex_unlock(&serial->parent->mutex);
1356 kref_put(&serial->parent->ref, hso_serial_ref_free);
1359 /* close the requested serial port */
1360 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1363 struct hso_serial *serial = tty->driver_data;
1364 int space, tx_bytes;
1365 unsigned long flags;
1368 if (serial == NULL) {
1369 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1373 spin_lock_irqsave(&serial->serial_lock, flags);
1375 space = serial->tx_data_length - serial->tx_buffer_count;
1376 tx_bytes = (count < space) ? count : space;
1381 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1382 serial->tx_buffer_count += tx_bytes;
1385 spin_unlock_irqrestore(&serial->serial_lock, flags);
1387 hso_kick_transmit(serial);
1392 /* how much room is there for writing */
1393 static int hso_serial_write_room(struct tty_struct *tty)
1395 struct hso_serial *serial = tty->driver_data;
1397 unsigned long flags;
1399 spin_lock_irqsave(&serial->serial_lock, flags);
1400 room = serial->tx_data_length - serial->tx_buffer_count;
1401 spin_unlock_irqrestore(&serial->serial_lock, flags);
1403 /* return free room */
1407 /* setup the term */
1408 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1410 struct hso_serial *serial = tty->driver_data;
1411 unsigned long flags;
1414 D5("Termios called with: cflags new[%d] - old[%d]",
1415 tty->termios.c_cflag, old->c_cflag);
1417 /* the actual setup */
1418 spin_lock_irqsave(&serial->serial_lock, flags);
1419 if (serial->port.count)
1420 _hso_serial_set_termios(tty, old);
1422 tty->termios = *old;
1423 spin_unlock_irqrestore(&serial->serial_lock, flags);
1428 /* how many characters in the buffer */
1429 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1431 struct hso_serial *serial = tty->driver_data;
1433 unsigned long flags;
1439 spin_lock_irqsave(&serial->serial_lock, flags);
1440 chars = serial->tx_buffer_count;
1441 spin_unlock_irqrestore(&serial->serial_lock, flags);
1445 static int tiocmget_submit_urb(struct hso_serial *serial,
1446 struct hso_tiocmget *tiocmget,
1447 struct usb_device *usb)
1451 if (serial->parent->usb_gone)
1453 usb_fill_int_urb(tiocmget->urb, usb,
1456 bEndpointAddress & 0x7F),
1457 &tiocmget->serial_state_notification,
1458 sizeof(struct hso_serial_state_notification),
1459 tiocmget_intr_callback, serial,
1460 tiocmget->endp->bInterval);
1461 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1463 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1470 static void tiocmget_intr_callback(struct urb *urb)
1472 struct hso_serial *serial = urb->context;
1473 struct hso_tiocmget *tiocmget;
1474 int status = urb->status;
1475 u16 UART_state_bitmap, prev_UART_state_bitmap;
1476 struct uart_icount *icount;
1477 struct hso_serial_state_notification *serial_state_notification;
1478 struct usb_device *usb;
1485 handle_usb_error(status, __func__, serial->parent);
1489 /* tiocmget is only supported on HSO_PORT_MODEM */
1490 tiocmget = serial->tiocmget;
1493 BUG_ON((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM);
1495 usb = serial->parent->usb;
1496 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1498 /* wIndex should be the USB interface number of the port to which the
1499 * notification applies, which should always be the Modem port.
1501 serial_state_notification = &tiocmget->serial_state_notification;
1502 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1503 serial_state_notification->bNotification != B_NOTIFICATION ||
1504 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1505 le16_to_cpu(serial_state_notification->wIndex) != if_num ||
1506 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1508 "hso received invalid serial state notification\n");
1509 DUMP(serial_state_notification,
1510 sizeof(struct hso_serial_state_notification));
1513 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1515 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1516 icount = &tiocmget->icount;
1517 spin_lock(&serial->serial_lock);
1518 if ((UART_state_bitmap & B_OVERRUN) !=
1519 (prev_UART_state_bitmap & B_OVERRUN))
1521 if ((UART_state_bitmap & B_PARITY) !=
1522 (prev_UART_state_bitmap & B_PARITY))
1524 if ((UART_state_bitmap & B_FRAMING) !=
1525 (prev_UART_state_bitmap & B_FRAMING))
1527 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1528 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1530 if ((UART_state_bitmap & B_BREAK) !=
1531 (prev_UART_state_bitmap & B_BREAK))
1533 if ((UART_state_bitmap & B_TX_CARRIER) !=
1534 (prev_UART_state_bitmap & B_TX_CARRIER))
1536 if ((UART_state_bitmap & B_RX_CARRIER) !=
1537 (prev_UART_state_bitmap & B_RX_CARRIER))
1539 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1540 spin_unlock(&serial->serial_lock);
1541 tiocmget->intr_completed = 1;
1542 wake_up_interruptible(&tiocmget->waitq);
1544 memset(serial_state_notification, 0,
1545 sizeof(struct hso_serial_state_notification));
1546 tiocmget_submit_urb(serial,
1548 serial->parent->usb);
1552 * next few functions largely stolen from drivers/serial/serial_core.c
1554 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1555 * - mask passed in arg for lines of interest
1556 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1557 * Caller should use TIOCGICOUNT to see which one it was
1560 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1562 DECLARE_WAITQUEUE(wait, current);
1563 struct uart_icount cprev, cnow;
1564 struct hso_tiocmget *tiocmget;
1567 tiocmget = serial->tiocmget;
1571 * note the counters on entry
1573 spin_lock_irq(&serial->serial_lock);
1574 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1575 spin_unlock_irq(&serial->serial_lock);
1576 add_wait_queue(&tiocmget->waitq, &wait);
1578 spin_lock_irq(&serial->serial_lock);
1579 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1580 spin_unlock_irq(&serial->serial_lock);
1581 set_current_state(TASK_INTERRUPTIBLE);
1582 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1583 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1584 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1589 /* see if a signal did it */
1590 if (signal_pending(current)) {
1596 current->state = TASK_RUNNING;
1597 remove_wait_queue(&tiocmget->waitq, &wait);
1603 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1604 * Return: write counters to the user passed counter struct
1605 * NB: both 1->0 and 0->1 transitions are counted except for
1606 * RI where only 0->1 is counted.
1608 static int hso_get_count(struct tty_struct *tty,
1609 struct serial_icounter_struct *icount)
1611 struct uart_icount cnow;
1612 struct hso_serial *serial = tty->driver_data;
1613 struct hso_tiocmget *tiocmget = serial->tiocmget;
1615 memset(icount, 0, sizeof(struct serial_icounter_struct));
1619 spin_lock_irq(&serial->serial_lock);
1620 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1621 spin_unlock_irq(&serial->serial_lock);
1623 icount->cts = cnow.cts;
1624 icount->dsr = cnow.dsr;
1625 icount->rng = cnow.rng;
1626 icount->dcd = cnow.dcd;
1627 icount->rx = cnow.rx;
1628 icount->tx = cnow.tx;
1629 icount->frame = cnow.frame;
1630 icount->overrun = cnow.overrun;
1631 icount->parity = cnow.parity;
1632 icount->brk = cnow.brk;
1633 icount->buf_overrun = cnow.buf_overrun;
1639 static int hso_serial_tiocmget(struct tty_struct *tty)
1642 struct hso_serial *serial = tty->driver_data;
1643 struct hso_tiocmget *tiocmget;
1644 u16 UART_state_bitmap;
1648 D1("no tty structures");
1651 spin_lock_irq(&serial->serial_lock);
1652 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1653 ((serial->dtr_state) ? TIOCM_DTR : 0);
1654 tiocmget = serial->tiocmget;
1657 UART_state_bitmap = le16_to_cpu(
1658 tiocmget->prev_UART_state_bitmap);
1659 if (UART_state_bitmap & B_RING_SIGNAL)
1660 retval |= TIOCM_RNG;
1661 if (UART_state_bitmap & B_RX_CARRIER)
1663 if (UART_state_bitmap & B_TX_CARRIER)
1664 retval |= TIOCM_DSR;
1666 spin_unlock_irq(&serial->serial_lock);
1670 static int hso_serial_tiocmset(struct tty_struct *tty,
1671 unsigned int set, unsigned int clear)
1674 unsigned long flags;
1676 struct hso_serial *serial = tty->driver_data;
1680 D1("no tty structures");
1684 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1687 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1689 spin_lock_irqsave(&serial->serial_lock, flags);
1690 if (set & TIOCM_RTS)
1691 serial->rts_state = 1;
1692 if (set & TIOCM_DTR)
1693 serial->dtr_state = 1;
1695 if (clear & TIOCM_RTS)
1696 serial->rts_state = 0;
1697 if (clear & TIOCM_DTR)
1698 serial->dtr_state = 0;
1700 if (serial->dtr_state)
1702 if (serial->rts_state)
1705 spin_unlock_irqrestore(&serial->serial_lock, flags);
1707 return usb_control_msg(serial->parent->usb,
1708 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1709 0x21, val, if_num, NULL, 0,
1710 USB_CTRL_SET_TIMEOUT);
1713 static int hso_serial_ioctl(struct tty_struct *tty,
1714 unsigned int cmd, unsigned long arg)
1716 struct hso_serial *serial = tty->driver_data;
1718 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1724 ret = hso_wait_modem_status(serial, arg);
1734 /* starts a transmit */
1735 static void hso_kick_transmit(struct hso_serial *serial)
1738 unsigned long flags;
1741 spin_lock_irqsave(&serial->serial_lock, flags);
1742 if (!serial->tx_buffer_count)
1745 if (serial->tx_urb_used)
1748 /* Wakeup USB interface if necessary */
1749 if (hso_get_activity(serial->parent) == -EAGAIN)
1752 /* Switch pointers around to avoid memcpy */
1753 temp = serial->tx_buffer;
1754 serial->tx_buffer = serial->tx_data;
1755 serial->tx_data = temp;
1756 serial->tx_data_count = serial->tx_buffer_count;
1757 serial->tx_buffer_count = 0;
1759 /* If temp is set, it means we switched buffers */
1760 if (temp && serial->write_data) {
1761 res = serial->write_data(serial);
1763 serial->tx_urb_used = 1;
1766 spin_unlock_irqrestore(&serial->serial_lock, flags);
1769 /* make a request (for reading and writing data to muxed serial port) */
1770 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1771 struct urb *ctrl_urb,
1772 struct usb_ctrlrequest *ctrl_req,
1773 u8 *ctrl_urb_data, u32 size)
1779 if (!serial || !ctrl_urb || !ctrl_req) {
1780 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1785 ctrl_req->wValue = 0;
1786 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1787 ctrl_req->wLength = cpu_to_le16(size);
1789 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1790 /* Reading command */
1791 ctrl_req->bRequestType = USB_DIR_IN |
1792 USB_TYPE_OPTION_VENDOR |
1793 USB_RECIP_INTERFACE;
1794 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1795 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1797 /* Writing command */
1798 ctrl_req->bRequestType = USB_DIR_OUT |
1799 USB_TYPE_OPTION_VENDOR |
1800 USB_RECIP_INTERFACE;
1801 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1802 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1805 D2("%s command (%02x) len: %d, port: %d",
1806 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1807 ctrl_req->bRequestType, ctrl_req->wLength, port);
1810 ctrl_urb->transfer_flags = 0;
1811 usb_fill_control_urb(ctrl_urb,
1812 serial->parent->usb,
1815 ctrl_urb_data, size, ctrl_callback, serial);
1816 /* Send it on merry way */
1817 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1819 dev_err(&ctrl_urb->dev->dev,
1820 "%s failed submit ctrl_urb %d type %d\n", __func__,
1829 /* called by intr_callback when read occurs */
1830 static int hso_mux_serial_read(struct hso_serial *serial)
1836 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1837 /* make the request */
1839 if (serial->num_rx_urbs != 1) {
1840 dev_err(&serial->parent->interface->dev,
1841 "ERROR: mux'd reads with multiple buffers "
1845 return mux_device_request(serial,
1846 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1847 serial->parent->port_spec & HSO_PORT_MASK,
1849 &serial->ctrl_req_rx,
1850 serial->rx_data[0], serial->rx_data_length);
1853 /* used for muxed serial port callback (muxed serial read) */
1854 static void intr_callback(struct urb *urb)
1856 struct hso_shared_int *shared_int = urb->context;
1857 struct hso_serial *serial;
1858 unsigned char *port_req;
1859 int status = urb->status;
1862 usb_mark_last_busy(urb->dev);
1870 handle_usb_error(status, __func__, NULL);
1873 D4("\n--- Got intr callback 0x%02X ---", status);
1876 port_req = urb->transfer_buffer;
1877 D4(" port_req = 0x%.2X\n", *port_req);
1878 /* loop over all muxed ports to find the one sending this */
1879 for (i = 0; i < 8; i++) {
1880 /* max 8 channels on MUX */
1881 if (*port_req & (1 << i)) {
1882 serial = get_serial_by_shared_int_and_type(shared_int,
1884 if (serial != NULL) {
1885 D1("Pending read interrupt on port %d\n", i);
1886 spin_lock(&serial->serial_lock);
1887 if (serial->rx_state == RX_IDLE &&
1888 serial->port.count > 0) {
1889 /* Setup and send a ctrl req read on
1891 if (!serial->rx_urb_filled[0]) {
1892 serial->rx_state = RX_SENT;
1893 hso_mux_serial_read(serial);
1895 serial->rx_state = RX_PENDING;
1897 D1("Already a read pending on "
1898 "port %d or port not open\n", i);
1900 spin_unlock(&serial->serial_lock);
1904 /* Resubmit interrupt urb */
1905 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1908 /* called for writing to muxed serial port */
1909 static int hso_mux_serial_write_data(struct hso_serial *serial)
1914 return mux_device_request(serial,
1915 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1916 serial->parent->port_spec & HSO_PORT_MASK,
1918 &serial->ctrl_req_tx,
1919 serial->tx_data, serial->tx_data_count);
1922 /* write callback for Diag and CS port */
1923 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1925 struct hso_serial *serial = urb->context;
1926 int status = urb->status;
1930 D1("serial == NULL");
1934 spin_lock(&serial->serial_lock);
1935 serial->tx_urb_used = 0;
1936 spin_unlock(&serial->serial_lock);
1938 handle_usb_error(status, __func__, serial->parent);
1941 hso_put_activity(serial->parent);
1942 tty_port_tty_wakeup(&serial->port);
1943 hso_kick_transmit(serial);
1948 /* called for writing diag or CS serial port */
1949 static int hso_std_serial_write_data(struct hso_serial *serial)
1951 int count = serial->tx_data_count;
1954 usb_fill_bulk_urb(serial->tx_urb,
1955 serial->parent->usb,
1956 usb_sndbulkpipe(serial->parent->usb,
1958 bEndpointAddress & 0x7F),
1959 serial->tx_data, serial->tx_data_count,
1960 hso_std_serial_write_bulk_callback, serial);
1962 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
1964 dev_warn(&serial->parent->usb->dev,
1965 "Failed to submit urb - res %d\n", result);
1972 /* callback after read or write on muxed serial port */
1973 static void ctrl_callback(struct urb *urb)
1975 struct hso_serial *serial = urb->context;
1976 struct usb_ctrlrequest *req;
1977 int status = urb->status;
1983 spin_lock(&serial->serial_lock);
1984 serial->tx_urb_used = 0;
1985 spin_unlock(&serial->serial_lock);
1987 handle_usb_error(status, __func__, serial->parent);
1992 req = (struct usb_ctrlrequest *)(urb->setup_packet);
1993 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
1994 D4("Actual length of urb = %d\n", urb->actual_length);
1995 DUMP1(urb->transfer_buffer, urb->actual_length);
1997 if (req->bRequestType ==
1998 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
1999 /* response to a read command */
2000 serial->rx_urb_filled[0] = 1;
2001 spin_lock(&serial->serial_lock);
2002 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2003 spin_unlock(&serial->serial_lock);
2005 hso_put_activity(serial->parent);
2006 tty_port_tty_wakeup(&serial->port);
2007 /* response to a write command */
2008 hso_kick_transmit(serial);
2012 /* handle RX data for serial port */
2013 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2015 struct tty_struct *tty;
2016 int write_length_remaining = 0;
2020 if (urb == NULL || serial == NULL) {
2021 D1("serial = NULL");
2025 tty = tty_port_tty_get(&serial->port);
2027 /* Push data to tty */
2028 write_length_remaining = urb->actual_length -
2029 serial->curr_rx_urb_offset;
2030 D1("data to push to tty");
2031 while (write_length_remaining) {
2032 if (tty && test_bit(TTY_THROTTLED, &tty->flags)) {
2036 curr_write_len = tty_insert_flip_string(&serial->port,
2037 urb->transfer_buffer + serial->curr_rx_urb_offset,
2038 write_length_remaining);
2039 serial->curr_rx_urb_offset += curr_write_len;
2040 write_length_remaining -= curr_write_len;
2041 tty_flip_buffer_push(&serial->port);
2045 if (write_length_remaining == 0) {
2046 serial->curr_rx_urb_offset = 0;
2047 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2049 return write_length_remaining;
2053 /* Base driver functions */
2055 static void hso_log_port(struct hso_device *hso_dev)
2060 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2061 case HSO_PORT_CONTROL:
2062 port_type = "Control";
2065 port_type = "Application";
2070 case HSO_PORT_GPS_CONTROL:
2071 port_type = "GPS control";
2074 port_type = "Application2";
2080 port_type = "Diagnostic";
2082 case HSO_PORT_DIAG2:
2083 port_type = "Diagnostic2";
2085 case HSO_PORT_MODEM:
2086 port_type = "Modem";
2088 case HSO_PORT_NETWORK:
2089 port_type = "Network";
2092 port_type = "Unknown";
2095 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2096 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2098 sprintf(port_dev, "/dev/%s%d", tty_filename,
2099 dev2ser(hso_dev)->minor);
2101 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2102 port_type, port_dev);
2105 static int hso_start_net_device(struct hso_device *hso_dev)
2108 struct hso_net *hso_net = dev2net(hso_dev);
2113 /* send URBs for all read buffers */
2114 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2116 /* Prep a receive URB */
2117 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2119 usb_rcvbulkpipe(hso_dev->usb,
2121 bEndpointAddress & 0x7F),
2122 hso_net->mux_bulk_rx_buf_pool[i],
2123 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2126 /* Put it out there so the device can send us stuff */
2127 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2130 dev_warn(&hso_dev->usb->dev,
2131 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2138 static int hso_stop_net_device(struct hso_device *hso_dev)
2141 struct hso_net *hso_net = dev2net(hso_dev);
2146 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2147 if (hso_net->mux_bulk_rx_urb_pool[i])
2148 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2151 if (hso_net->mux_bulk_tx_urb)
2152 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2157 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2160 struct hso_serial *serial = dev2ser(hso_dev);
2165 /* If it is not the MUX port fill in and submit a bulk urb (already
2166 * allocated in hso_serial_start) */
2167 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2168 for (i = 0; i < serial->num_rx_urbs; i++) {
2169 usb_fill_bulk_urb(serial->rx_urb[i],
2170 serial->parent->usb,
2171 usb_rcvbulkpipe(serial->parent->usb,
2176 serial->rx_data_length,
2177 hso_std_serial_read_bulk_callback,
2179 result = usb_submit_urb(serial->rx_urb[i], flags);
2181 dev_warn(&serial->parent->usb->dev,
2182 "Failed to submit urb - res %d\n",
2188 mutex_lock(&serial->shared_int->shared_int_lock);
2189 if (!serial->shared_int->use_count) {
2191 hso_mux_submit_intr_urb(serial->shared_int,
2192 hso_dev->usb, flags);
2194 serial->shared_int->use_count++;
2195 mutex_unlock(&serial->shared_int->shared_int_lock);
2197 if (serial->tiocmget)
2198 tiocmget_submit_urb(serial,
2200 serial->parent->usb);
2204 static int hso_stop_serial_device(struct hso_device *hso_dev)
2207 struct hso_serial *serial = dev2ser(hso_dev);
2208 struct hso_tiocmget *tiocmget;
2213 for (i = 0; i < serial->num_rx_urbs; i++) {
2214 if (serial->rx_urb[i]) {
2215 usb_kill_urb(serial->rx_urb[i]);
2216 serial->rx_urb_filled[i] = 0;
2219 serial->curr_rx_urb_idx = 0;
2220 serial->curr_rx_urb_offset = 0;
2223 usb_kill_urb(serial->tx_urb);
2225 if (serial->shared_int) {
2226 mutex_lock(&serial->shared_int->shared_int_lock);
2227 if (serial->shared_int->use_count &&
2228 (--serial->shared_int->use_count == 0)) {
2231 urb = serial->shared_int->shared_intr_urb;
2235 mutex_unlock(&serial->shared_int->shared_int_lock);
2237 tiocmget = serial->tiocmget;
2239 wake_up_interruptible(&tiocmget->waitq);
2240 usb_kill_urb(tiocmget->urb);
2246 static void hso_serial_common_free(struct hso_serial *serial)
2250 if (serial->parent->dev)
2251 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2253 tty_unregister_device(tty_drv, serial->minor);
2255 for (i = 0; i < serial->num_rx_urbs; i++) {
2256 /* unlink and free RX URB */
2257 usb_free_urb(serial->rx_urb[i]);
2258 /* free the RX buffer */
2259 kfree(serial->rx_data[i]);
2262 /* unlink and free TX URB */
2263 usb_free_urb(serial->tx_urb);
2264 kfree(serial->tx_data);
2265 tty_port_destroy(&serial->port);
2268 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2269 int rx_size, int tx_size)
2275 tty_port_init(&serial->port);
2277 minor = get_free_serial_index();
2281 /* register our minor number */
2282 serial->parent->dev = tty_port_register_device(&serial->port, tty_drv,
2283 minor, &serial->parent->interface->dev);
2284 dev = serial->parent->dev;
2285 dev_set_drvdata(dev, serial->parent);
2286 i = device_create_file(dev, &dev_attr_hsotype);
2288 /* fill in specific data for later use */
2289 serial->minor = minor;
2290 serial->magic = HSO_SERIAL_MAGIC;
2291 spin_lock_init(&serial->serial_lock);
2292 serial->num_rx_urbs = num_urbs;
2294 /* RX, allocate urb and initialize */
2296 /* prepare our RX buffer */
2297 serial->rx_data_length = rx_size;
2298 for (i = 0; i < serial->num_rx_urbs; i++) {
2299 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2300 if (!serial->rx_urb[i]) {
2301 dev_err(dev, "Could not allocate urb?\n");
2304 serial->rx_urb[i]->transfer_buffer = NULL;
2305 serial->rx_urb[i]->transfer_buffer_length = 0;
2306 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2308 if (!serial->rx_data[i])
2312 /* TX, allocate urb and initialize */
2313 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2314 if (!serial->tx_urb) {
2315 dev_err(dev, "Could not allocate urb?\n");
2318 serial->tx_urb->transfer_buffer = NULL;
2319 serial->tx_urb->transfer_buffer_length = 0;
2320 /* prepare our TX buffer */
2321 serial->tx_data_count = 0;
2322 serial->tx_buffer_count = 0;
2323 serial->tx_data_length = tx_size;
2324 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2325 if (!serial->tx_data)
2328 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2329 if (!serial->tx_buffer)
2334 hso_serial_common_free(serial);
2338 /* Creates a general hso device */
2339 static struct hso_device *hso_create_device(struct usb_interface *intf,
2342 struct hso_device *hso_dev;
2344 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2348 hso_dev->port_spec = port_spec;
2349 hso_dev->usb = interface_to_usbdev(intf);
2350 hso_dev->interface = intf;
2351 kref_init(&hso_dev->ref);
2352 mutex_init(&hso_dev->mutex);
2354 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2355 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2356 INIT_WORK(&hso_dev->reset_device, reset_device);
2361 /* Removes a network device in the network device table */
2362 static int remove_net_device(struct hso_device *hso_dev)
2366 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2367 if (network_table[i] == hso_dev) {
2368 network_table[i] = NULL;
2372 if (i == HSO_MAX_NET_DEVICES)
2377 /* Frees our network device */
2378 static void hso_free_net_device(struct hso_device *hso_dev)
2381 struct hso_net *hso_net = dev2net(hso_dev);
2386 remove_net_device(hso_net->parent);
2389 unregister_netdev(hso_net->net);
2392 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2393 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2394 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2395 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2397 usb_free_urb(hso_net->mux_bulk_tx_urb);
2398 kfree(hso_net->mux_bulk_tx_buf);
2399 hso_net->mux_bulk_tx_buf = NULL;
2402 free_netdev(hso_net->net);
2407 static const struct net_device_ops hso_netdev_ops = {
2408 .ndo_open = hso_net_open,
2409 .ndo_stop = hso_net_close,
2410 .ndo_start_xmit = hso_net_start_xmit,
2411 .ndo_tx_timeout = hso_net_tx_timeout,
2414 /* initialize the network interface */
2415 static void hso_net_init(struct net_device *net)
2417 struct hso_net *hso_net = netdev_priv(net);
2419 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2421 /* fill in the other fields */
2422 net->netdev_ops = &hso_netdev_ops;
2423 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2424 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2425 net->type = ARPHRD_NONE;
2426 net->mtu = DEFAULT_MTU - 14;
2427 net->tx_queue_len = 10;
2428 net->ethtool_ops = &ops;
2430 /* and initialize the semaphore */
2431 spin_lock_init(&hso_net->net_lock);
2434 /* Adds a network device in the network device table */
2435 static int add_net_device(struct hso_device *hso_dev)
2439 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2440 if (network_table[i] == NULL) {
2441 network_table[i] = hso_dev;
2445 if (i == HSO_MAX_NET_DEVICES)
2450 static int hso_rfkill_set_block(void *data, bool blocked)
2452 struct hso_device *hso_dev = data;
2453 int enabled = !blocked;
2456 mutex_lock(&hso_dev->mutex);
2457 if (hso_dev->usb_gone)
2460 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2461 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2462 USB_CTRL_SET_TIMEOUT);
2463 mutex_unlock(&hso_dev->mutex);
2467 static const struct rfkill_ops hso_rfkill_ops = {
2468 .set_block = hso_rfkill_set_block,
2471 /* Creates and sets up everything for rfkill */
2472 static void hso_create_rfkill(struct hso_device *hso_dev,
2473 struct usb_interface *interface)
2475 struct hso_net *hso_net = dev2net(hso_dev);
2476 struct device *dev = &hso_net->net->dev;
2479 rfkn = kzalloc(20, GFP_KERNEL);
2481 dev_err(dev, "%s - Out of memory\n", __func__);
2483 snprintf(rfkn, 20, "hso-%d",
2484 interface->altsetting->desc.bInterfaceNumber);
2486 hso_net->rfkill = rfkill_alloc(rfkn,
2487 &interface_to_usbdev(interface)->dev,
2489 &hso_rfkill_ops, hso_dev);
2490 if (!hso_net->rfkill) {
2491 dev_err(dev, "%s - Out of memory\n", __func__);
2495 if (rfkill_register(hso_net->rfkill) < 0) {
2496 rfkill_destroy(hso_net->rfkill);
2498 hso_net->rfkill = NULL;
2499 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2504 static struct device_type hso_type = {
2508 /* Creates our network device */
2509 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2513 struct net_device *net;
2514 struct hso_net *hso_net;
2515 struct hso_device *hso_dev;
2517 hso_dev = hso_create_device(interface, port_spec);
2521 /* allocate our network device, then we can put in our private data */
2522 /* call hso_net_init to do the basic initialization */
2523 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2525 dev_err(&interface->dev, "Unable to create ethernet device\n");
2529 hso_net = netdev_priv(net);
2531 hso_dev->port_data.dev_net = hso_net;
2533 hso_net->parent = hso_dev;
2535 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2537 if (!hso_net->in_endp) {
2538 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2541 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2543 if (!hso_net->out_endp) {
2544 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2547 SET_NETDEV_DEV(net, &interface->dev);
2548 SET_NETDEV_DEVTYPE(net, &hso_type);
2550 /* registering our net device */
2551 result = register_netdev(net);
2553 dev_err(&interface->dev, "Failed to register device\n");
2557 /* start allocating */
2558 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2559 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2560 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2561 dev_err(&interface->dev, "Could not allocate rx urb\n");
2564 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2566 if (!hso_net->mux_bulk_rx_buf_pool[i])
2569 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2570 if (!hso_net->mux_bulk_tx_urb) {
2571 dev_err(&interface->dev, "Could not allocate tx urb\n");
2574 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2575 if (!hso_net->mux_bulk_tx_buf)
2578 add_net_device(hso_dev);
2580 hso_log_port(hso_dev);
2582 hso_create_rfkill(hso_dev, interface);
2586 hso_free_net_device(hso_dev);
2590 static void hso_free_tiomget(struct hso_serial *serial)
2592 struct hso_tiocmget *tiocmget;
2595 tiocmget = serial->tiocmget;
2597 usb_free_urb(tiocmget->urb);
2598 tiocmget->urb = NULL;
2599 serial->tiocmget = NULL;
2604 /* Frees an AT channel ( goes for both mux and non-mux ) */
2605 static void hso_free_serial_device(struct hso_device *hso_dev)
2607 struct hso_serial *serial = dev2ser(hso_dev);
2611 set_serial_by_index(serial->minor, NULL);
2613 hso_serial_common_free(serial);
2615 if (serial->shared_int) {
2616 mutex_lock(&serial->shared_int->shared_int_lock);
2617 if (--serial->shared_int->ref_count == 0)
2618 hso_free_shared_int(serial->shared_int);
2620 mutex_unlock(&serial->shared_int->shared_int_lock);
2622 hso_free_tiomget(serial);
2627 /* Creates a bulk AT channel */
2628 static struct hso_device *hso_create_bulk_serial_device(
2629 struct usb_interface *interface, int port)
2631 struct hso_device *hso_dev;
2632 struct hso_serial *serial;
2634 struct hso_tiocmget *tiocmget;
2636 hso_dev = hso_create_device(interface, port);
2640 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2644 serial->parent = hso_dev;
2645 hso_dev->port_data.dev_serial = serial;
2647 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2649 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2651 /* it isn't going to break our heart if serial->tiocmget
2652 * allocation fails don't bother checking this.
2654 if (serial->tiocmget) {
2655 tiocmget = serial->tiocmget;
2656 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2657 if (tiocmget->urb) {
2658 mutex_init(&tiocmget->mutex);
2659 init_waitqueue_head(&tiocmget->waitq);
2660 tiocmget->endp = hso_get_ep(
2662 USB_ENDPOINT_XFER_INT,
2665 hso_free_tiomget(serial);
2671 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2675 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2677 if (!serial->in_endp) {
2678 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2684 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2685 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2689 serial->write_data = hso_std_serial_write_data;
2691 /* and record this serial */
2692 set_serial_by_index(serial->minor, serial);
2694 /* setup the proc dirs and files if needed */
2695 hso_log_port(hso_dev);
2697 /* done, return it */
2701 hso_serial_common_free(serial);
2703 hso_free_tiomget(serial);
2709 /* Creates a multiplexed AT channel */
2711 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2713 struct hso_shared_int *mux)
2715 struct hso_device *hso_dev;
2716 struct hso_serial *serial;
2719 port_spec = HSO_INTF_MUX;
2720 port_spec &= ~HSO_PORT_MASK;
2722 port_spec |= hso_mux_to_port(port);
2723 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2726 hso_dev = hso_create_device(interface, port_spec);
2730 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2734 hso_dev->port_data.dev_serial = serial;
2735 serial->parent = hso_dev;
2737 if (hso_serial_common_create
2738 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2741 serial->tx_data_length--;
2742 serial->write_data = hso_mux_serial_write_data;
2744 serial->shared_int = mux;
2745 mutex_lock(&serial->shared_int->shared_int_lock);
2746 serial->shared_int->ref_count++;
2747 mutex_unlock(&serial->shared_int->shared_int_lock);
2749 /* and record this serial */
2750 set_serial_by_index(serial->minor, serial);
2752 /* setup the proc dirs and files if needed */
2753 hso_log_port(hso_dev);
2755 /* done, return it */
2760 tty_unregister_device(tty_drv, serial->minor);
2769 static void hso_free_shared_int(struct hso_shared_int *mux)
2771 usb_free_urb(mux->shared_intr_urb);
2772 kfree(mux->shared_intr_buf);
2773 mutex_unlock(&mux->shared_int_lock);
2778 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2780 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2785 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2787 if (!mux->intr_endp) {
2788 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2792 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2793 if (!mux->shared_intr_urb) {
2794 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2797 mux->shared_intr_buf =
2798 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2800 if (!mux->shared_intr_buf)
2803 mutex_init(&mux->shared_int_lock);
2808 kfree(mux->shared_intr_buf);
2809 usb_free_urb(mux->shared_intr_urb);
2814 /* Gets the port spec for a certain interface */
2815 static int hso_get_config_data(struct usb_interface *interface)
2817 struct usb_device *usbdev = interface_to_usbdev(interface);
2818 u8 *config_data = kmalloc(17, GFP_KERNEL);
2819 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2824 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2825 0x86, 0xC0, 0, 0, config_data, 17,
2826 USB_CTRL_SET_TIMEOUT) != 0x11) {
2831 switch (config_data[if_num]) {
2836 result = HSO_PORT_DIAG;
2839 result = HSO_PORT_GPS;
2842 result = HSO_PORT_GPS_CONTROL;
2845 result = HSO_PORT_APP;
2848 result = HSO_PORT_APP2;
2851 result = HSO_PORT_CONTROL;
2854 result = HSO_PORT_NETWORK;
2857 result = HSO_PORT_MODEM;
2860 result = HSO_PORT_MSD;
2863 result = HSO_PORT_PCSC;
2866 result = HSO_PORT_VOICE;
2873 result |= HSO_INTF_BULK;
2875 if (config_data[16] & 0x1)
2876 result |= HSO_INFO_CRC_BUG;
2882 /* called once for each interface upon device insertion */
2883 static int hso_probe(struct usb_interface *interface,
2884 const struct usb_device_id *id)
2886 int mux, i, if_num, port_spec;
2887 unsigned char port_mask;
2888 struct hso_device *hso_dev = NULL;
2889 struct hso_shared_int *shared_int;
2890 struct hso_device *tmp_dev = NULL;
2892 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2893 dev_err(&interface->dev, "Not our interface\n");
2897 if_num = interface->altsetting->desc.bInterfaceNumber;
2899 /* Get the interface/port specification from either driver_info or from
2900 * the device itself */
2901 if (id->driver_info)
2902 port_spec = ((u32 *)(id->driver_info))[if_num];
2904 port_spec = hso_get_config_data(interface);
2906 /* Check if we need to switch to alt interfaces prior to port
2908 if (interface->num_altsetting > 1)
2909 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2910 interface->needs_remote_wakeup = 1;
2912 /* Allocate new hso device(s) */
2913 switch (port_spec & HSO_INTF_MASK) {
2915 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2916 /* Create the network device */
2918 hso_dev = hso_create_net_device(interface,
2926 if (hso_get_mux_ports(interface, &port_mask))
2927 /* TODO: de-allocate everything */
2930 shared_int = hso_create_shared_int(interface);
2934 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2935 if (port_mask & i) {
2936 hso_dev = hso_create_mux_serial_device(
2937 interface, i, shared_int);
2948 /* It's a regular bulk interface */
2949 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2952 hso_create_net_device(interface, port_spec);
2955 hso_create_bulk_serial_device(interface, port_spec);
2964 /* save our data pointer in this device */
2965 usb_set_intfdata(interface, hso_dev);
2970 hso_free_interface(interface);
2974 /* device removed, cleaning up */
2975 static void hso_disconnect(struct usb_interface *interface)
2977 hso_free_interface(interface);
2979 /* remove reference of our private data */
2980 usb_set_intfdata(interface, NULL);
2983 static void async_get_intf(struct work_struct *data)
2985 struct hso_device *hso_dev =
2986 container_of(data, struct hso_device, async_get_intf);
2987 usb_autopm_get_interface(hso_dev->interface);
2990 static void async_put_intf(struct work_struct *data)
2992 struct hso_device *hso_dev =
2993 container_of(data, struct hso_device, async_put_intf);
2994 usb_autopm_put_interface(hso_dev->interface);
2997 static int hso_get_activity(struct hso_device *hso_dev)
2999 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3000 if (!hso_dev->is_active) {
3001 hso_dev->is_active = 1;
3002 schedule_work(&hso_dev->async_get_intf);
3006 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3009 usb_mark_last_busy(hso_dev->usb);
3014 static int hso_put_activity(struct hso_device *hso_dev)
3016 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3017 if (hso_dev->is_active) {
3018 hso_dev->is_active = 0;
3019 schedule_work(&hso_dev->async_put_intf);
3023 hso_dev->is_active = 0;
3027 /* called by kernel when we need to suspend device */
3028 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3032 /* Stop all serial ports */
3033 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3034 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3035 result = hso_stop_serial_device(serial_table[i]);
3041 /* Stop all network ports */
3042 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3043 if (network_table[i] &&
3044 (network_table[i]->interface == iface)) {
3045 result = hso_stop_net_device(network_table[i]);
3055 /* called by kernel when we need to resume device */
3056 static int hso_resume(struct usb_interface *iface)
3059 struct hso_net *hso_net;
3061 /* Start all serial ports */
3062 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3063 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3064 if (dev2ser(serial_table[i])->port.count) {
3066 hso_start_serial_device(serial_table[i], GFP_NOIO);
3067 hso_kick_transmit(dev2ser(serial_table[i]));
3074 /* Start all network ports */
3075 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3076 if (network_table[i] &&
3077 (network_table[i]->interface == iface)) {
3078 hso_net = dev2net(network_table[i]);
3079 if (hso_net->flags & IFF_UP) {
3080 /* First transmit any lingering data,
3081 then restart the device. */
3082 if (hso_net->skb_tx_buf) {
3083 dev_dbg(&iface->dev,
3085 " lingering data\n");
3086 hso_net_start_xmit(hso_net->skb_tx_buf,
3088 hso_net->skb_tx_buf = NULL;
3090 result = hso_start_net_device(network_table[i]);
3101 static void reset_device(struct work_struct *data)
3103 struct hso_device *hso_dev =
3104 container_of(data, struct hso_device, reset_device);
3105 struct usb_device *usb = hso_dev->usb;
3108 if (hso_dev->usb_gone) {
3109 D1("No reset during disconnect\n");
3111 result = usb_lock_device_for_reset(usb, hso_dev->interface);
3113 D1("unable to lock device for reset: %d\n", result);
3115 usb_reset_device(usb);
3116 usb_unlock_device(usb);
3121 static void hso_serial_ref_free(struct kref *ref)
3123 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3125 hso_free_serial_device(hso_dev);
3128 static void hso_free_interface(struct usb_interface *interface)
3130 struct hso_serial *hso_dev;
3133 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3134 if (serial_table[i] &&
3135 (serial_table[i]->interface == interface)) {
3136 hso_dev = dev2ser(serial_table[i]);
3137 tty_port_tty_hangup(&hso_dev->port, false);
3138 mutex_lock(&hso_dev->parent->mutex);
3139 hso_dev->parent->usb_gone = 1;
3140 mutex_unlock(&hso_dev->parent->mutex);
3141 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3145 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3146 if (network_table[i] &&
3147 (network_table[i]->interface == interface)) {
3148 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3149 /* hso_stop_net_device doesn't stop the net queue since
3150 * traffic needs to start it again when suspended */
3151 netif_stop_queue(dev2net(network_table[i])->net);
3152 hso_stop_net_device(network_table[i]);
3153 cancel_work_sync(&network_table[i]->async_put_intf);
3154 cancel_work_sync(&network_table[i]->async_get_intf);
3156 rfkill_unregister(rfk);
3157 rfkill_destroy(rfk);
3159 hso_free_net_device(network_table[i]);
3164 /* Helper functions */
3166 /* Get the endpoint ! */
3167 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3171 struct usb_host_interface *iface = intf->cur_altsetting;
3172 struct usb_endpoint_descriptor *endp;
3174 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3175 endp = &iface->endpoint[i].desc;
3176 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3177 (usb_endpoint_type(endp) == type))
3184 /* Get the byte that describes which ports are enabled */
3185 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3188 struct usb_host_interface *iface = intf->cur_altsetting;
3190 if (iface->extralen == 3) {
3191 *ports = iface->extra[2];
3195 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3196 if (iface->endpoint[i].extralen == 3) {
3197 *ports = iface->endpoint[i].extra[2];
3205 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3206 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3207 struct usb_device *usb, gfp_t gfp)
3211 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3213 shared_int->intr_endp->bEndpointAddress & 0x7F),
3214 shared_int->shared_intr_buf,
3216 intr_callback, shared_int,
3217 shared_int->intr_endp->bInterval);
3219 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3221 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3227 /* operations setup of the serial interface */
3228 static const struct tty_operations hso_serial_ops = {
3229 .open = hso_serial_open,
3230 .close = hso_serial_close,
3231 .write = hso_serial_write,
3232 .write_room = hso_serial_write_room,
3233 .ioctl = hso_serial_ioctl,
3234 .set_termios = hso_serial_set_termios,
3235 .chars_in_buffer = hso_serial_chars_in_buffer,
3236 .tiocmget = hso_serial_tiocmget,
3237 .tiocmset = hso_serial_tiocmset,
3238 .get_icount = hso_get_count,
3239 .unthrottle = hso_unthrottle
3242 static struct usb_driver hso_driver = {
3243 .name = driver_name,
3245 .disconnect = hso_disconnect,
3246 .id_table = hso_ids,
3247 .suspend = hso_suspend,
3248 .resume = hso_resume,
3249 .reset_resume = hso_resume,
3250 .supports_autosuspend = 1,
3251 .disable_hub_initiated_lpm = 1,
3254 static int __init hso_init(void)
3259 /* put it in the log */
3260 printk(KERN_INFO "hso: %s\n", version);
3262 /* Initialise the serial table semaphore and table */
3263 spin_lock_init(&serial_table_lock);
3264 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3265 serial_table[i] = NULL;
3267 /* allocate our driver using the proper amount of supported minors */
3268 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3272 /* fill in all needed values */
3273 tty_drv->driver_name = driver_name;
3274 tty_drv->name = tty_filename;
3276 /* if major number is provided as parameter, use that one */
3278 tty_drv->major = tty_major;
3280 tty_drv->minor_start = 0;
3281 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3282 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3283 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3284 tty_drv->init_termios = tty_std_termios;
3285 hso_init_termios(&tty_drv->init_termios);
3286 tty_set_operations(tty_drv, &hso_serial_ops);
3288 /* register the tty driver */
3289 result = tty_register_driver(tty_drv);
3291 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3296 /* register this module as an usb driver */
3297 result = usb_register(&hso_driver);
3299 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3307 tty_unregister_driver(tty_drv);
3309 put_tty_driver(tty_drv);
3313 static void __exit hso_exit(void)
3315 printk(KERN_INFO "hso: unloaded\n");
3317 tty_unregister_driver(tty_drv);
3318 put_tty_driver(tty_drv);
3319 /* deregister the usb driver */
3320 usb_deregister(&hso_driver);
3323 /* Module definitions */
3324 module_init(hso_init);
3325 module_exit(hso_exit);
3327 MODULE_AUTHOR(MOD_AUTHOR);
3328 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3329 MODULE_LICENSE(MOD_LICENSE);
3331 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3332 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3333 module_param(debug, int, S_IRUGO | S_IWUSR);
3335 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3336 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3337 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3339 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3340 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3341 module_param(disable_net, int, S_IRUGO | S_IWUSR);