drivers/net: Remove unnecessary returns from void function()s
[firewire-audio.git] / drivers / net / usb / hso.c
blob9964df199511879b4f5d73c0ca36014da972009e
1 /******************************************************************************
3 * Driver for Option High Speed Mobile Devices.
5 * Copyright (C) 2008 Option International
6 * Filip Aben <f.aben@option.com>
7 * Denis Joseph Barrow <d.barow@option.com>
8 * Jan Dumon <j.dumon@option.com>
9 * Copyright (C) 2007 Andrew Bird (Sphere Systems Ltd)
10 * <ajb@spheresystems.co.uk>
11 * Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de>
12 * Copyright (C) 2008 Novell, Inc.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
26 * USA
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
37 * control endpoints.
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
43 * throughput.
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>
67 #include <linux/ip.h>
68 #include <linux/uaccess.h>
69 #include <linux/usb/cdc.h>
70 #include <net/arp.h>
71 #include <asm/byteorder.h>
72 #include <linux/serial_core.h>
73 #include <linux/serial.h>
76 #define DRIVER_VERSION "1.2"
77 #define MOD_AUTHOR "Option Wireless"
78 #define MOD_DESCRIPTION "USB High Speed Option driver"
79 #define MOD_LICENSE "GPL"
81 #define HSO_MAX_NET_DEVICES 10
82 #define HSO__MAX_MTU 2048
83 #define DEFAULT_MTU 1500
84 #define DEFAULT_MRU 1500
86 #define CTRL_URB_RX_SIZE 1024
87 #define CTRL_URB_TX_SIZE 64
89 #define BULK_URB_RX_SIZE 4096
90 #define BULK_URB_TX_SIZE 8192
92 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
93 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
94 #define MUX_BULK_RX_BUF_COUNT 4
95 #define USB_TYPE_OPTION_VENDOR 0x20
97 /* These definitions are used with the struct hso_net flags element */
98 /* - use *_bit operations on it. (bit indices not values.) */
99 #define HSO_NET_RUNNING 0
101 #define HSO_NET_TX_TIMEOUT (HZ*10)
103 #define HSO_SERIAL_MAGIC 0x48534f31
105 /* Number of ttys to handle */
106 #define HSO_SERIAL_TTY_MINORS 256
108 #define MAX_RX_URBS 2
110 static inline struct hso_serial *get_serial_by_tty(struct tty_struct *tty)
112 if (tty)
113 return tty->driver_data;
114 return NULL;
117 /*****************************************************************************/
118 /* Debugging functions */
119 /*****************************************************************************/
120 #define D__(lvl_, fmt, arg...) \
121 do { \
122 printk(lvl_ "[%d:%s]: " fmt "\n", \
123 __LINE__, __func__, ## arg); \
124 } while (0)
126 #define D_(lvl, args...) \
127 do { \
128 if (lvl & debug) \
129 D__(KERN_INFO, args); \
130 } while (0)
132 #define D1(args...) D_(0x01, ##args)
133 #define D2(args...) D_(0x02, ##args)
134 #define D3(args...) D_(0x04, ##args)
135 #define D4(args...) D_(0x08, ##args)
136 #define D5(args...) D_(0x10, ##args)
138 /*****************************************************************************/
139 /* Enumerators */
140 /*****************************************************************************/
141 enum pkt_parse_state {
142 WAIT_IP,
143 WAIT_DATA,
144 WAIT_SYNC
147 /*****************************************************************************/
148 /* Structs */
149 /*****************************************************************************/
151 struct hso_shared_int {
152 struct usb_endpoint_descriptor *intr_endp;
153 void *shared_intr_buf;
154 struct urb *shared_intr_urb;
155 struct usb_device *usb;
156 int use_count;
157 int ref_count;
158 struct mutex shared_int_lock;
161 struct hso_net {
162 struct hso_device *parent;
163 struct net_device *net;
164 struct rfkill *rfkill;
166 struct usb_endpoint_descriptor *in_endp;
167 struct usb_endpoint_descriptor *out_endp;
169 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
170 struct urb *mux_bulk_tx_urb;
171 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
172 void *mux_bulk_tx_buf;
174 struct sk_buff *skb_rx_buf;
175 struct sk_buff *skb_tx_buf;
177 enum pkt_parse_state rx_parse_state;
178 spinlock_t net_lock;
180 unsigned short rx_buf_size;
181 unsigned short rx_buf_missing;
182 struct iphdr rx_ip_hdr;
184 unsigned long flags;
187 enum rx_ctrl_state{
188 RX_IDLE,
189 RX_SENT,
190 RX_PENDING
193 #define BM_REQUEST_TYPE (0xa1)
194 #define B_NOTIFICATION (0x20)
195 #define W_VALUE (0x0)
196 #define W_INDEX (0x2)
197 #define W_LENGTH (0x2)
199 #define B_OVERRUN (0x1<<6)
200 #define B_PARITY (0x1<<5)
201 #define B_FRAMING (0x1<<4)
202 #define B_RING_SIGNAL (0x1<<3)
203 #define B_BREAK (0x1<<2)
204 #define B_TX_CARRIER (0x1<<1)
205 #define B_RX_CARRIER (0x1<<0)
207 struct hso_serial_state_notification {
208 u8 bmRequestType;
209 u8 bNotification;
210 u16 wValue;
211 u16 wIndex;
212 u16 wLength;
213 u16 UART_state_bitmap;
214 } __attribute__((packed));
216 struct hso_tiocmget {
217 struct mutex mutex;
218 wait_queue_head_t waitq;
219 int intr_completed;
220 struct usb_endpoint_descriptor *endp;
221 struct urb *urb;
222 struct hso_serial_state_notification serial_state_notification;
223 u16 prev_UART_state_bitmap;
224 struct uart_icount icount;
228 struct hso_serial {
229 struct hso_device *parent;
230 int magic;
231 u8 minor;
233 struct hso_shared_int *shared_int;
235 /* rx/tx urb could be either a bulk urb or a control urb depending
236 on which serial port it is used on. */
237 struct urb *rx_urb[MAX_RX_URBS];
238 u8 num_rx_urbs;
239 u8 *rx_data[MAX_RX_URBS];
240 u16 rx_data_length; /* should contain allocated length */
242 struct urb *tx_urb;
243 u8 *tx_data;
244 u8 *tx_buffer;
245 u16 tx_data_length; /* should contain allocated length */
246 u16 tx_data_count;
247 u16 tx_buffer_count;
248 struct usb_ctrlrequest ctrl_req_tx;
249 struct usb_ctrlrequest ctrl_req_rx;
251 struct usb_endpoint_descriptor *in_endp;
252 struct usb_endpoint_descriptor *out_endp;
254 enum rx_ctrl_state rx_state;
255 u8 rts_state;
256 u8 dtr_state;
257 unsigned tx_urb_used:1;
259 /* from usb_serial_port */
260 struct tty_struct *tty;
261 int open_count;
262 spinlock_t serial_lock;
264 int (*write_data) (struct hso_serial *serial);
265 struct hso_tiocmget *tiocmget;
266 /* Hacks required to get flow control
267 * working on the serial receive buffers
268 * so as not to drop characters on the floor.
270 int curr_rx_urb_idx;
271 u16 curr_rx_urb_offset;
272 u8 rx_urb_filled[MAX_RX_URBS];
273 struct tasklet_struct unthrottle_tasklet;
274 struct work_struct retry_unthrottle_workqueue;
277 struct hso_device {
278 union {
279 struct hso_serial *dev_serial;
280 struct hso_net *dev_net;
281 } port_data;
283 u32 port_spec;
285 u8 is_active;
286 u8 usb_gone;
287 struct work_struct async_get_intf;
288 struct work_struct async_put_intf;
289 struct work_struct reset_device;
291 struct usb_device *usb;
292 struct usb_interface *interface;
294 struct device *dev;
295 struct kref ref;
296 struct mutex mutex;
299 /* Type of interface */
300 #define HSO_INTF_MASK 0xFF00
301 #define HSO_INTF_MUX 0x0100
302 #define HSO_INTF_BULK 0x0200
304 /* Type of port */
305 #define HSO_PORT_MASK 0xFF
306 #define HSO_PORT_NO_PORT 0x0
307 #define HSO_PORT_CONTROL 0x1
308 #define HSO_PORT_APP 0x2
309 #define HSO_PORT_GPS 0x3
310 #define HSO_PORT_PCSC 0x4
311 #define HSO_PORT_APP2 0x5
312 #define HSO_PORT_GPS_CONTROL 0x6
313 #define HSO_PORT_MSD 0x7
314 #define HSO_PORT_VOICE 0x8
315 #define HSO_PORT_DIAG2 0x9
316 #define HSO_PORT_DIAG 0x10
317 #define HSO_PORT_MODEM 0x11
318 #define HSO_PORT_NETWORK 0x12
320 /* Additional device info */
321 #define HSO_INFO_MASK 0xFF000000
322 #define HSO_INFO_CRC_BUG 0x01000000
324 /*****************************************************************************/
325 /* Prototypes */
326 /*****************************************************************************/
327 /* Serial driver functions */
328 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
329 unsigned int set, unsigned int clear);
330 static void ctrl_callback(struct urb *urb);
331 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
332 static void hso_kick_transmit(struct hso_serial *serial);
333 /* Helper functions */
334 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
335 struct usb_device *usb, gfp_t gfp);
336 static void handle_usb_error(int status, const char *function,
337 struct hso_device *hso_dev);
338 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
339 int type, int dir);
340 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
341 static void hso_free_interface(struct usb_interface *intf);
342 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
343 static int hso_stop_serial_device(struct hso_device *hso_dev);
344 static int hso_start_net_device(struct hso_device *hso_dev);
345 static void hso_free_shared_int(struct hso_shared_int *shared_int);
346 static int hso_stop_net_device(struct hso_device *hso_dev);
347 static void hso_serial_ref_free(struct kref *ref);
348 static void hso_std_serial_read_bulk_callback(struct urb *urb);
349 static int hso_mux_serial_read(struct hso_serial *serial);
350 static void async_get_intf(struct work_struct *data);
351 static void async_put_intf(struct work_struct *data);
352 static int hso_put_activity(struct hso_device *hso_dev);
353 static int hso_get_activity(struct hso_device *hso_dev);
354 static void tiocmget_intr_callback(struct urb *urb);
355 static void reset_device(struct work_struct *data);
356 /*****************************************************************************/
357 /* Helping functions */
358 /*****************************************************************************/
360 /* #define DEBUG */
362 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
364 return hso_dev->port_data.dev_net;
367 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
369 return hso_dev->port_data.dev_serial;
372 /* Debugging functions */
373 #ifdef DEBUG
374 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
375 unsigned int len)
377 static char name[255];
379 sprintf(name, "hso[%d:%s]", line_count, func_name);
380 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
383 #define DUMP(buf_, len_) \
384 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
386 #define DUMP1(buf_, len_) \
387 do { \
388 if (0x01 & debug) \
389 DUMP(buf_, len_); \
390 } while (0)
391 #else
392 #define DUMP(buf_, len_)
393 #define DUMP1(buf_, len_)
394 #endif
396 /* module parameters */
397 static int debug;
398 static int tty_major;
399 static int disable_net;
401 /* driver info */
402 static const char driver_name[] = "hso";
403 static const char tty_filename[] = "ttyHS";
404 static const char *version = __FILE__ ": " DRIVER_VERSION " " MOD_AUTHOR;
405 /* the usb driver itself (registered in hso_init) */
406 static struct usb_driver hso_driver;
407 /* serial structures */
408 static struct tty_driver *tty_drv;
409 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
410 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
411 static spinlock_t serial_table_lock;
413 static const s32 default_port_spec[] = {
414 HSO_INTF_MUX | HSO_PORT_NETWORK,
415 HSO_INTF_BULK | HSO_PORT_DIAG,
416 HSO_INTF_BULK | HSO_PORT_MODEM,
420 static const s32 icon321_port_spec[] = {
421 HSO_INTF_MUX | HSO_PORT_NETWORK,
422 HSO_INTF_BULK | HSO_PORT_DIAG2,
423 HSO_INTF_BULK | HSO_PORT_MODEM,
424 HSO_INTF_BULK | HSO_PORT_DIAG,
428 #define default_port_device(vendor, product) \
429 USB_DEVICE(vendor, product), \
430 .driver_info = (kernel_ulong_t)default_port_spec
432 #define icon321_port_device(vendor, product) \
433 USB_DEVICE(vendor, product), \
434 .driver_info = (kernel_ulong_t)icon321_port_spec
436 /* list of devices we support */
437 static const struct usb_device_id hso_ids[] = {
438 {default_port_device(0x0af0, 0x6711)},
439 {default_port_device(0x0af0, 0x6731)},
440 {default_port_device(0x0af0, 0x6751)},
441 {default_port_device(0x0af0, 0x6771)},
442 {default_port_device(0x0af0, 0x6791)},
443 {default_port_device(0x0af0, 0x6811)},
444 {default_port_device(0x0af0, 0x6911)},
445 {default_port_device(0x0af0, 0x6951)},
446 {default_port_device(0x0af0, 0x6971)},
447 {default_port_device(0x0af0, 0x7011)},
448 {default_port_device(0x0af0, 0x7031)},
449 {default_port_device(0x0af0, 0x7051)},
450 {default_port_device(0x0af0, 0x7071)},
451 {default_port_device(0x0af0, 0x7111)},
452 {default_port_device(0x0af0, 0x7211)},
453 {default_port_device(0x0af0, 0x7251)},
454 {default_port_device(0x0af0, 0x7271)},
455 {default_port_device(0x0af0, 0x7311)},
456 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
457 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
458 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
459 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
460 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
461 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
462 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
463 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
464 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
465 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
466 {USB_DEVICE(0x0af0, 0x7701)},
467 {USB_DEVICE(0x0af0, 0x7706)},
468 {USB_DEVICE(0x0af0, 0x7801)},
469 {USB_DEVICE(0x0af0, 0x7901)},
470 {USB_DEVICE(0x0af0, 0x7A01)},
471 {USB_DEVICE(0x0af0, 0x7A05)},
472 {USB_DEVICE(0x0af0, 0x8200)},
473 {USB_DEVICE(0x0af0, 0x8201)},
474 {USB_DEVICE(0x0af0, 0x8300)},
475 {USB_DEVICE(0x0af0, 0x8302)},
476 {USB_DEVICE(0x0af0, 0x8304)},
477 {USB_DEVICE(0x0af0, 0x8400)},
478 {USB_DEVICE(0x0af0, 0xd035)},
479 {USB_DEVICE(0x0af0, 0xd055)},
480 {USB_DEVICE(0x0af0, 0xd155)},
481 {USB_DEVICE(0x0af0, 0xd255)},
482 {USB_DEVICE(0x0af0, 0xd057)},
483 {USB_DEVICE(0x0af0, 0xd157)},
484 {USB_DEVICE(0x0af0, 0xd257)},
485 {USB_DEVICE(0x0af0, 0xd357)},
486 {USB_DEVICE(0x0af0, 0xd058)},
487 {USB_DEVICE(0x0af0, 0xc100)},
490 MODULE_DEVICE_TABLE(usb, hso_ids);
492 /* Sysfs attribute */
493 static ssize_t hso_sysfs_show_porttype(struct device *dev,
494 struct device_attribute *attr,
495 char *buf)
497 struct hso_device *hso_dev = dev_get_drvdata(dev);
498 char *port_name;
500 if (!hso_dev)
501 return 0;
503 switch (hso_dev->port_spec & HSO_PORT_MASK) {
504 case HSO_PORT_CONTROL:
505 port_name = "Control";
506 break;
507 case HSO_PORT_APP:
508 port_name = "Application";
509 break;
510 case HSO_PORT_APP2:
511 port_name = "Application2";
512 break;
513 case HSO_PORT_GPS:
514 port_name = "GPS";
515 break;
516 case HSO_PORT_GPS_CONTROL:
517 port_name = "GPS Control";
518 break;
519 case HSO_PORT_PCSC:
520 port_name = "PCSC";
521 break;
522 case HSO_PORT_DIAG:
523 port_name = "Diagnostic";
524 break;
525 case HSO_PORT_DIAG2:
526 port_name = "Diagnostic2";
527 break;
528 case HSO_PORT_MODEM:
529 port_name = "Modem";
530 break;
531 case HSO_PORT_NETWORK:
532 port_name = "Network";
533 break;
534 default:
535 port_name = "Unknown";
536 break;
539 return sprintf(buf, "%s\n", port_name);
541 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
543 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
545 int idx;
547 for (idx = 0; idx < serial->num_rx_urbs; idx++)
548 if (serial->rx_urb[idx] == urb)
549 return idx;
550 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
551 return -1;
554 /* converts mux value to a port spec value */
555 static u32 hso_mux_to_port(int mux)
557 u32 result;
559 switch (mux) {
560 case 0x1:
561 result = HSO_PORT_CONTROL;
562 break;
563 case 0x2:
564 result = HSO_PORT_APP;
565 break;
566 case 0x4:
567 result = HSO_PORT_PCSC;
568 break;
569 case 0x8:
570 result = HSO_PORT_GPS;
571 break;
572 case 0x10:
573 result = HSO_PORT_APP2;
574 break;
575 default:
576 result = HSO_PORT_NO_PORT;
578 return result;
581 /* converts port spec value to a mux value */
582 static u32 hso_port_to_mux(int port)
584 u32 result;
586 switch (port & HSO_PORT_MASK) {
587 case HSO_PORT_CONTROL:
588 result = 0x0;
589 break;
590 case HSO_PORT_APP:
591 result = 0x1;
592 break;
593 case HSO_PORT_PCSC:
594 result = 0x2;
595 break;
596 case HSO_PORT_GPS:
597 result = 0x3;
598 break;
599 case HSO_PORT_APP2:
600 result = 0x4;
601 break;
602 default:
603 result = 0x0;
605 return result;
608 static struct hso_serial *get_serial_by_shared_int_and_type(
609 struct hso_shared_int *shared_int,
610 int mux)
612 int i, port;
614 port = hso_mux_to_port(mux);
616 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
617 if (serial_table[i] &&
618 (dev2ser(serial_table[i])->shared_int == shared_int) &&
619 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
620 return dev2ser(serial_table[i]);
624 return NULL;
627 static struct hso_serial *get_serial_by_index(unsigned index)
629 struct hso_serial *serial = NULL;
630 unsigned long flags;
632 spin_lock_irqsave(&serial_table_lock, flags);
633 if (serial_table[index])
634 serial = dev2ser(serial_table[index]);
635 spin_unlock_irqrestore(&serial_table_lock, flags);
637 return serial;
640 static int get_free_serial_index(void)
642 int index;
643 unsigned long flags;
645 spin_lock_irqsave(&serial_table_lock, flags);
646 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
647 if (serial_table[index] == NULL) {
648 spin_unlock_irqrestore(&serial_table_lock, flags);
649 return index;
652 spin_unlock_irqrestore(&serial_table_lock, flags);
654 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
655 return -1;
658 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
660 unsigned long flags;
662 spin_lock_irqsave(&serial_table_lock, flags);
663 if (serial)
664 serial_table[index] = serial->parent;
665 else
666 serial_table[index] = NULL;
667 spin_unlock_irqrestore(&serial_table_lock, flags);
670 static void handle_usb_error(int status, const char *function,
671 struct hso_device *hso_dev)
673 char *explanation;
675 switch (status) {
676 case -ENODEV:
677 explanation = "no device";
678 break;
679 case -ENOENT:
680 explanation = "endpoint not enabled";
681 break;
682 case -EPIPE:
683 explanation = "endpoint stalled";
684 break;
685 case -ENOSPC:
686 explanation = "not enough bandwidth";
687 break;
688 case -ESHUTDOWN:
689 explanation = "device disabled";
690 break;
691 case -EHOSTUNREACH:
692 explanation = "device suspended";
693 break;
694 case -EINVAL:
695 case -EAGAIN:
696 case -EFBIG:
697 case -EMSGSIZE:
698 explanation = "internal error";
699 break;
700 case -EILSEQ:
701 case -EPROTO:
702 case -ETIME:
703 case -ETIMEDOUT:
704 explanation = "protocol error";
705 if (hso_dev)
706 schedule_work(&hso_dev->reset_device);
707 break;
708 default:
709 explanation = "unknown status";
710 break;
713 /* log a meaningful explanation of an USB status */
714 D1("%s: received USB status - %s (%d)", function, explanation, status);
717 /* Network interface functions */
719 /* called when net interface is brought up by ifconfig */
720 static int hso_net_open(struct net_device *net)
722 struct hso_net *odev = netdev_priv(net);
723 unsigned long flags = 0;
725 if (!odev) {
726 dev_err(&net->dev, "No net device !\n");
727 return -ENODEV;
730 odev->skb_tx_buf = NULL;
732 /* setup environment */
733 spin_lock_irqsave(&odev->net_lock, flags);
734 odev->rx_parse_state = WAIT_IP;
735 odev->rx_buf_size = 0;
736 odev->rx_buf_missing = sizeof(struct iphdr);
737 spin_unlock_irqrestore(&odev->net_lock, flags);
739 /* We are up and running. */
740 set_bit(HSO_NET_RUNNING, &odev->flags);
741 hso_start_net_device(odev->parent);
743 /* Tell the kernel we are ready to start receiving from it */
744 netif_start_queue(net);
746 return 0;
749 /* called when interface is brought down by ifconfig */
750 static int hso_net_close(struct net_device *net)
752 struct hso_net *odev = netdev_priv(net);
754 /* we don't need the queue anymore */
755 netif_stop_queue(net);
756 /* no longer running */
757 clear_bit(HSO_NET_RUNNING, &odev->flags);
759 hso_stop_net_device(odev->parent);
761 /* done */
762 return 0;
765 /* USB tells is xmit done, we should start the netqueue again */
766 static void write_bulk_callback(struct urb *urb)
768 struct hso_net *odev = urb->context;
769 int status = urb->status;
771 /* Sanity check */
772 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
773 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
774 return;
777 /* Do we still have a valid kernel network device? */
778 if (!netif_device_present(odev->net)) {
779 dev_err(&urb->dev->dev, "%s: net device not present\n",
780 __func__);
781 return;
784 /* log status, but don't act on it, we don't need to resubmit anything
785 * anyhow */
786 if (status)
787 handle_usb_error(status, __func__, odev->parent);
789 hso_put_activity(odev->parent);
791 /* Tell the network interface we are ready for another frame */
792 netif_wake_queue(odev->net);
795 /* called by kernel when we need to transmit a packet */
796 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
797 struct net_device *net)
799 struct hso_net *odev = netdev_priv(net);
800 int result;
802 /* Tell the kernel, "No more frames 'til we are done with this one." */
803 netif_stop_queue(net);
804 if (hso_get_activity(odev->parent) == -EAGAIN) {
805 odev->skb_tx_buf = skb;
806 return NETDEV_TX_OK;
809 /* log if asked */
810 DUMP1(skb->data, skb->len);
811 /* Copy it from kernel memory to OUR memory */
812 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
813 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
815 /* Fill in the URB for shipping it out. */
816 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
817 odev->parent->usb,
818 usb_sndbulkpipe(odev->parent->usb,
819 odev->out_endp->
820 bEndpointAddress & 0x7F),
821 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
822 odev);
824 /* Deal with the Zero Length packet problem, I hope */
825 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
827 /* Send the URB on its merry way. */
828 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
829 if (result) {
830 dev_warn(&odev->parent->interface->dev,
831 "failed mux_bulk_tx_urb %d\n", result);
832 net->stats.tx_errors++;
833 netif_start_queue(net);
834 } else {
835 net->stats.tx_packets++;
836 net->stats.tx_bytes += skb->len;
838 dev_kfree_skb(skb);
839 /* we're done */
840 return NETDEV_TX_OK;
843 static void hso_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
845 struct hso_net *odev = netdev_priv(net);
847 strncpy(info->driver, driver_name, ETHTOOL_BUSINFO_LEN);
848 strncpy(info->version, DRIVER_VERSION, ETHTOOL_BUSINFO_LEN);
849 usb_make_path(odev->parent->usb, info->bus_info, sizeof info->bus_info);
852 static const struct ethtool_ops ops = {
853 .get_drvinfo = hso_get_drvinfo,
854 .get_link = ethtool_op_get_link
857 /* called when a packet did not ack after watchdogtimeout */
858 static void hso_net_tx_timeout(struct net_device *net)
860 struct hso_net *odev = netdev_priv(net);
862 if (!odev)
863 return;
865 /* Tell syslog we are hosed. */
866 dev_warn(&net->dev, "Tx timed out.\n");
868 /* Tear the waiting frame off the list */
869 if (odev->mux_bulk_tx_urb &&
870 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
871 usb_unlink_urb(odev->mux_bulk_tx_urb);
873 /* Update statistics */
874 net->stats.tx_errors++;
877 /* make a real packet from the received USB buffer */
878 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
879 unsigned int count, unsigned char is_eop)
881 unsigned short temp_bytes;
882 unsigned short buffer_offset = 0;
883 unsigned short frame_len;
884 unsigned char *tmp_rx_buf;
886 /* log if needed */
887 D1("Rx %d bytes", count);
888 DUMP(ip_pkt, min(128, (int)count));
890 while (count) {
891 switch (odev->rx_parse_state) {
892 case WAIT_IP:
893 /* waiting for IP header. */
894 /* wanted bytes - size of ip header */
895 temp_bytes =
896 (count <
897 odev->rx_buf_missing) ? count : odev->
898 rx_buf_missing;
900 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
901 odev->rx_buf_size, ip_pkt + buffer_offset,
902 temp_bytes);
904 odev->rx_buf_size += temp_bytes;
905 buffer_offset += temp_bytes;
906 odev->rx_buf_missing -= temp_bytes;
907 count -= temp_bytes;
909 if (!odev->rx_buf_missing) {
910 /* header is complete allocate an sk_buffer and
911 * continue to WAIT_DATA */
912 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
914 if ((frame_len > DEFAULT_MRU) ||
915 (frame_len < sizeof(struct iphdr))) {
916 dev_err(&odev->net->dev,
917 "Invalid frame (%d) length\n",
918 frame_len);
919 odev->rx_parse_state = WAIT_SYNC;
920 continue;
922 /* Allocate an sk_buff */
923 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
924 frame_len);
925 if (!odev->skb_rx_buf) {
926 /* We got no receive buffer. */
927 D1("could not allocate memory");
928 odev->rx_parse_state = WAIT_SYNC;
929 return;
932 /* Copy what we got so far. make room for iphdr
933 * after tail. */
934 tmp_rx_buf =
935 skb_put(odev->skb_rx_buf,
936 sizeof(struct iphdr));
937 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
938 sizeof(struct iphdr));
940 /* ETH_HLEN */
941 odev->rx_buf_size = sizeof(struct iphdr);
943 /* Filip actually use .tot_len */
944 odev->rx_buf_missing =
945 frame_len - sizeof(struct iphdr);
946 odev->rx_parse_state = WAIT_DATA;
948 break;
950 case WAIT_DATA:
951 temp_bytes = (count < odev->rx_buf_missing)
952 ? count : odev->rx_buf_missing;
954 /* Copy the rest of the bytes that are left in the
955 * buffer into the waiting sk_buf. */
956 /* Make room for temp_bytes after tail. */
957 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
958 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
960 odev->rx_buf_missing -= temp_bytes;
961 count -= temp_bytes;
962 buffer_offset += temp_bytes;
963 odev->rx_buf_size += temp_bytes;
964 if (!odev->rx_buf_missing) {
965 /* Packet is complete. Inject into stack. */
966 /* We have IP packet here */
967 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
968 /* don't check it */
969 odev->skb_rx_buf->ip_summed =
970 CHECKSUM_UNNECESSARY;
972 skb_reset_mac_header(odev->skb_rx_buf);
974 /* Ship it off to the kernel */
975 netif_rx(odev->skb_rx_buf);
976 /* No longer our buffer. */
977 odev->skb_rx_buf = NULL;
979 /* update out statistics */
980 odev->net->stats.rx_packets++;
982 odev->net->stats.rx_bytes += odev->rx_buf_size;
984 odev->rx_buf_size = 0;
985 odev->rx_buf_missing = sizeof(struct iphdr);
986 odev->rx_parse_state = WAIT_IP;
988 break;
990 case WAIT_SYNC:
991 D1(" W_S");
992 count = 0;
993 break;
994 default:
995 D1(" ");
996 count--;
997 break;
1001 /* Recovery mechanism for WAIT_SYNC state. */
1002 if (is_eop) {
1003 if (odev->rx_parse_state == WAIT_SYNC) {
1004 odev->rx_parse_state = WAIT_IP;
1005 odev->rx_buf_size = 0;
1006 odev->rx_buf_missing = sizeof(struct iphdr);
1011 /* Moving data from usb to kernel (in interrupt state) */
1012 static void read_bulk_callback(struct urb *urb)
1014 struct hso_net *odev = urb->context;
1015 struct net_device *net;
1016 int result;
1017 int status = urb->status;
1019 /* is al ok? (Filip: Who's Al ?) */
1020 if (status) {
1021 handle_usb_error(status, __func__, odev->parent);
1022 return;
1025 /* Sanity check */
1026 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1027 D1("BULK IN callback but driver is not active!");
1028 return;
1030 usb_mark_last_busy(urb->dev);
1032 net = odev->net;
1034 if (!netif_device_present(net)) {
1035 /* Somebody killed our network interface... */
1036 return;
1039 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
1040 u32 rest;
1041 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1042 rest = urb->actual_length %
1043 le16_to_cpu(odev->in_endp->wMaxPacketSize);
1044 if (((rest == 5) || (rest == 6)) &&
1045 !memcmp(((u8 *) urb->transfer_buffer) +
1046 urb->actual_length - 4, crc_check, 4)) {
1047 urb->actual_length -= 4;
1051 /* do we even have a packet? */
1052 if (urb->actual_length) {
1053 /* Handle the IP stream, add header and push it onto network
1054 * stack if the packet is complete. */
1055 spin_lock(&odev->net_lock);
1056 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1057 (urb->transfer_buffer_length >
1058 urb->actual_length) ? 1 : 0);
1059 spin_unlock(&odev->net_lock);
1062 /* We are done with this URB, resubmit it. Prep the USB to wait for
1063 * another frame. Reuse same as received. */
1064 usb_fill_bulk_urb(urb,
1065 odev->parent->usb,
1066 usb_rcvbulkpipe(odev->parent->usb,
1067 odev->in_endp->
1068 bEndpointAddress & 0x7F),
1069 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1070 read_bulk_callback, odev);
1072 /* Give this to the USB subsystem so it can tell us when more data
1073 * arrives. */
1074 result = usb_submit_urb(urb, GFP_ATOMIC);
1075 if (result)
1076 dev_warn(&odev->parent->interface->dev,
1077 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1078 result);
1081 /* Serial driver functions */
1083 static void hso_init_termios(struct ktermios *termios)
1086 * The default requirements for this device are:
1088 termios->c_iflag &=
1089 ~(IGNBRK /* disable ignore break */
1090 | BRKINT /* disable break causes interrupt */
1091 | PARMRK /* disable mark parity errors */
1092 | ISTRIP /* disable clear high bit of input characters */
1093 | INLCR /* disable translate NL to CR */
1094 | IGNCR /* disable ignore CR */
1095 | ICRNL /* disable translate CR to NL */
1096 | IXON); /* disable enable XON/XOFF flow control */
1098 /* disable postprocess output characters */
1099 termios->c_oflag &= ~OPOST;
1101 termios->c_lflag &=
1102 ~(ECHO /* disable echo input characters */
1103 | ECHONL /* disable echo new line */
1104 | ICANON /* disable erase, kill, werase, and rprnt
1105 special characters */
1106 | ISIG /* disable interrupt, quit, and suspend special
1107 characters */
1108 | IEXTEN); /* disable non-POSIX special characters */
1110 termios->c_cflag &=
1111 ~(CSIZE /* no size */
1112 | PARENB /* disable parity bit */
1113 | CBAUD /* clear current baud rate */
1114 | CBAUDEX); /* clear current buad rate */
1116 termios->c_cflag |= CS8; /* character size 8 bits */
1118 /* baud rate 115200 */
1119 tty_termios_encode_baud_rate(termios, 115200, 115200);
1122 static void _hso_serial_set_termios(struct tty_struct *tty,
1123 struct ktermios *old)
1125 struct hso_serial *serial = get_serial_by_tty(tty);
1126 struct ktermios *termios;
1128 if (!serial) {
1129 printk(KERN_ERR "%s: no tty structures", __func__);
1130 return;
1133 D4("port %d", serial->minor);
1136 * Fix up unsupported bits
1138 termios = tty->termios;
1139 termios->c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1141 termios->c_cflag &=
1142 ~(CSIZE /* no size */
1143 | PARENB /* disable parity bit */
1144 | CBAUD /* clear current baud rate */
1145 | CBAUDEX); /* clear current buad rate */
1147 termios->c_cflag |= CS8; /* character size 8 bits */
1149 /* baud rate 115200 */
1150 tty_encode_baud_rate(tty, 115200, 115200);
1153 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1155 int result;
1156 /* We are done with this URB, resubmit it. Prep the USB to wait for
1157 * another frame */
1158 usb_fill_bulk_urb(urb, serial->parent->usb,
1159 usb_rcvbulkpipe(serial->parent->usb,
1160 serial->in_endp->
1161 bEndpointAddress & 0x7F),
1162 urb->transfer_buffer, serial->rx_data_length,
1163 hso_std_serial_read_bulk_callback, serial);
1164 /* Give this to the USB subsystem so it can tell us when more data
1165 * arrives. */
1166 result = usb_submit_urb(urb, GFP_ATOMIC);
1167 if (result) {
1168 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1169 __func__, result);
1176 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1178 int count;
1179 struct urb *curr_urb;
1181 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1182 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1183 count = put_rxbuf_data(curr_urb, serial);
1184 if (count == -1)
1185 return;
1186 if (count == 0) {
1187 serial->curr_rx_urb_idx++;
1188 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1189 serial->curr_rx_urb_idx = 0;
1190 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1195 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1197 int count = 0;
1198 struct urb *urb;
1200 urb = serial->rx_urb[0];
1201 if (serial->open_count > 0) {
1202 count = put_rxbuf_data(urb, serial);
1203 if (count == -1)
1204 return;
1206 /* Re issue a read as long as we receive data. */
1208 if (count == 0 && ((urb->actual_length != 0) ||
1209 (serial->rx_state == RX_PENDING))) {
1210 serial->rx_state = RX_SENT;
1211 hso_mux_serial_read(serial);
1212 } else
1213 serial->rx_state = RX_IDLE;
1217 /* read callback for Diag and CS port */
1218 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1220 struct hso_serial *serial = urb->context;
1221 int status = urb->status;
1223 /* sanity check */
1224 if (!serial) {
1225 D1("serial == NULL");
1226 return;
1227 } else if (status) {
1228 handle_usb_error(status, __func__, serial->parent);
1229 return;
1232 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1233 D1("Actual length = %d\n", urb->actual_length);
1234 DUMP1(urb->transfer_buffer, urb->actual_length);
1236 /* Anyone listening? */
1237 if (serial->open_count == 0)
1238 return;
1240 if (status == 0) {
1241 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1242 u32 rest;
1243 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1244 rest =
1245 urb->actual_length %
1246 le16_to_cpu(serial->in_endp->wMaxPacketSize);
1247 if (((rest == 5) || (rest == 6)) &&
1248 !memcmp(((u8 *) urb->transfer_buffer) +
1249 urb->actual_length - 4, crc_check, 4)) {
1250 urb->actual_length -= 4;
1253 /* Valid data, handle RX data */
1254 spin_lock(&serial->serial_lock);
1255 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1256 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1257 spin_unlock(&serial->serial_lock);
1258 } else if (status == -ENOENT || status == -ECONNRESET) {
1259 /* Unlinked - check for throttled port. */
1260 D2("Port %d, successfully unlinked urb", serial->minor);
1261 spin_lock(&serial->serial_lock);
1262 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1263 hso_resubmit_rx_bulk_urb(serial, urb);
1264 spin_unlock(&serial->serial_lock);
1265 } else {
1266 D2("Port %d, status = %d for read urb", serial->minor, status);
1267 return;
1272 * This needs to be a tasklet otherwise we will
1273 * end up recursively calling this function.
1275 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1277 unsigned long flags;
1279 spin_lock_irqsave(&serial->serial_lock, flags);
1280 if ((serial->parent->port_spec & HSO_INTF_MUX))
1281 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1282 else
1283 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1284 spin_unlock_irqrestore(&serial->serial_lock, flags);
1287 static void hso_unthrottle(struct tty_struct *tty)
1289 struct hso_serial *serial = get_serial_by_tty(tty);
1291 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1294 static void hso_unthrottle_workfunc(struct work_struct *work)
1296 struct hso_serial *serial =
1297 container_of(work, struct hso_serial,
1298 retry_unthrottle_workqueue);
1299 hso_unthrottle_tasklet(serial);
1302 /* open the requested serial port */
1303 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1305 struct hso_serial *serial = get_serial_by_index(tty->index);
1306 int result;
1308 /* sanity check */
1309 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1310 WARN_ON(1);
1311 tty->driver_data = NULL;
1312 D1("Failed to open port");
1313 return -ENODEV;
1316 mutex_lock(&serial->parent->mutex);
1317 result = usb_autopm_get_interface(serial->parent->interface);
1318 if (result < 0)
1319 goto err_out;
1321 D1("Opening %d", serial->minor);
1322 kref_get(&serial->parent->ref);
1324 /* setup */
1325 spin_lock_irq(&serial->serial_lock);
1326 tty->driver_data = serial;
1327 tty_kref_put(serial->tty);
1328 serial->tty = tty_kref_get(tty);
1329 spin_unlock_irq(&serial->serial_lock);
1331 /* check for port already opened, if not set the termios */
1332 serial->open_count++;
1333 if (serial->open_count == 1) {
1334 tty->low_latency = 1;
1335 serial->rx_state = RX_IDLE;
1336 /* Force default termio settings */
1337 _hso_serial_set_termios(tty, NULL);
1338 tasklet_init(&serial->unthrottle_tasklet,
1339 (void (*)(unsigned long))hso_unthrottle_tasklet,
1340 (unsigned long)serial);
1341 INIT_WORK(&serial->retry_unthrottle_workqueue,
1342 hso_unthrottle_workfunc);
1343 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1344 if (result) {
1345 hso_stop_serial_device(serial->parent);
1346 serial->open_count--;
1347 kref_put(&serial->parent->ref, hso_serial_ref_free);
1349 } else {
1350 D1("Port was already open");
1353 usb_autopm_put_interface(serial->parent->interface);
1355 /* done */
1356 if (result)
1357 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1358 err_out:
1359 mutex_unlock(&serial->parent->mutex);
1360 return result;
1363 /* close the requested serial port */
1364 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1366 struct hso_serial *serial = tty->driver_data;
1367 u8 usb_gone;
1369 D1("Closing serial port");
1371 /* Open failed, no close cleanup required */
1372 if (serial == NULL)
1373 return;
1375 mutex_lock(&serial->parent->mutex);
1376 usb_gone = serial->parent->usb_gone;
1378 if (!usb_gone)
1379 usb_autopm_get_interface(serial->parent->interface);
1381 /* reset the rts and dtr */
1382 /* do the actual close */
1383 serial->open_count--;
1385 if (serial->open_count <= 0) {
1386 serial->open_count = 0;
1387 spin_lock_irq(&serial->serial_lock);
1388 if (serial->tty == tty) {
1389 serial->tty->driver_data = NULL;
1390 serial->tty = NULL;
1391 tty_kref_put(tty);
1393 spin_unlock_irq(&serial->serial_lock);
1394 if (!usb_gone)
1395 hso_stop_serial_device(serial->parent);
1396 tasklet_kill(&serial->unthrottle_tasklet);
1397 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1400 if (!usb_gone)
1401 usb_autopm_put_interface(serial->parent->interface);
1403 mutex_unlock(&serial->parent->mutex);
1405 kref_put(&serial->parent->ref, hso_serial_ref_free);
1408 /* close the requested serial port */
1409 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1410 int count)
1412 struct hso_serial *serial = get_serial_by_tty(tty);
1413 int space, tx_bytes;
1414 unsigned long flags;
1416 /* sanity check */
1417 if (serial == NULL) {
1418 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1419 return -ENODEV;
1422 spin_lock_irqsave(&serial->serial_lock, flags);
1424 space = serial->tx_data_length - serial->tx_buffer_count;
1425 tx_bytes = (count < space) ? count : space;
1427 if (!tx_bytes)
1428 goto out;
1430 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1431 serial->tx_buffer_count += tx_bytes;
1433 out:
1434 spin_unlock_irqrestore(&serial->serial_lock, flags);
1436 hso_kick_transmit(serial);
1437 /* done */
1438 return tx_bytes;
1441 /* how much room is there for writing */
1442 static int hso_serial_write_room(struct tty_struct *tty)
1444 struct hso_serial *serial = get_serial_by_tty(tty);
1445 int room;
1446 unsigned long flags;
1448 spin_lock_irqsave(&serial->serial_lock, flags);
1449 room = serial->tx_data_length - serial->tx_buffer_count;
1450 spin_unlock_irqrestore(&serial->serial_lock, flags);
1452 /* return free room */
1453 return room;
1456 /* setup the term */
1457 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1459 struct hso_serial *serial = get_serial_by_tty(tty);
1460 unsigned long flags;
1462 if (old)
1463 D5("Termios called with: cflags new[%d] - old[%d]",
1464 tty->termios->c_cflag, old->c_cflag);
1466 /* the actual setup */
1467 spin_lock_irqsave(&serial->serial_lock, flags);
1468 if (serial->open_count)
1469 _hso_serial_set_termios(tty, old);
1470 else
1471 tty->termios = old;
1472 spin_unlock_irqrestore(&serial->serial_lock, flags);
1474 /* done */
1477 /* how many characters in the buffer */
1478 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1480 struct hso_serial *serial = get_serial_by_tty(tty);
1481 int chars;
1482 unsigned long flags;
1484 /* sanity check */
1485 if (serial == NULL)
1486 return 0;
1488 spin_lock_irqsave(&serial->serial_lock, flags);
1489 chars = serial->tx_buffer_count;
1490 spin_unlock_irqrestore(&serial->serial_lock, flags);
1492 return chars;
1494 static int tiocmget_submit_urb(struct hso_serial *serial,
1495 struct hso_tiocmget *tiocmget,
1496 struct usb_device *usb)
1498 int result;
1500 if (serial->parent->usb_gone)
1501 return -ENODEV;
1502 usb_fill_int_urb(tiocmget->urb, usb,
1503 usb_rcvintpipe(usb,
1504 tiocmget->endp->
1505 bEndpointAddress & 0x7F),
1506 &tiocmget->serial_state_notification,
1507 sizeof(struct hso_serial_state_notification),
1508 tiocmget_intr_callback, serial,
1509 tiocmget->endp->bInterval);
1510 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1511 if (result) {
1512 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1513 result);
1515 return result;
1519 static void tiocmget_intr_callback(struct urb *urb)
1521 struct hso_serial *serial = urb->context;
1522 struct hso_tiocmget *tiocmget;
1523 int status = urb->status;
1524 u16 UART_state_bitmap, prev_UART_state_bitmap;
1525 struct uart_icount *icount;
1526 struct hso_serial_state_notification *serial_state_notification;
1527 struct usb_device *usb;
1529 /* Sanity checks */
1530 if (!serial)
1531 return;
1532 if (status) {
1533 handle_usb_error(status, __func__, serial->parent);
1534 return;
1536 tiocmget = serial->tiocmget;
1537 if (!tiocmget)
1538 return;
1539 usb = serial->parent->usb;
1540 serial_state_notification = &tiocmget->serial_state_notification;
1541 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1542 serial_state_notification->bNotification != B_NOTIFICATION ||
1543 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1544 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1545 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1546 dev_warn(&usb->dev,
1547 "hso received invalid serial state notification\n");
1548 DUMP(serial_state_notification,
1549 sizeof(struct hso_serial_state_notification));
1550 } else {
1552 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1553 UART_state_bitmap);
1554 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1555 icount = &tiocmget->icount;
1556 spin_lock(&serial->serial_lock);
1557 if ((UART_state_bitmap & B_OVERRUN) !=
1558 (prev_UART_state_bitmap & B_OVERRUN))
1559 icount->parity++;
1560 if ((UART_state_bitmap & B_PARITY) !=
1561 (prev_UART_state_bitmap & B_PARITY))
1562 icount->parity++;
1563 if ((UART_state_bitmap & B_FRAMING) !=
1564 (prev_UART_state_bitmap & B_FRAMING))
1565 icount->frame++;
1566 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1567 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1568 icount->rng++;
1569 if ((UART_state_bitmap & B_BREAK) !=
1570 (prev_UART_state_bitmap & B_BREAK))
1571 icount->brk++;
1572 if ((UART_state_bitmap & B_TX_CARRIER) !=
1573 (prev_UART_state_bitmap & B_TX_CARRIER))
1574 icount->dsr++;
1575 if ((UART_state_bitmap & B_RX_CARRIER) !=
1576 (prev_UART_state_bitmap & B_RX_CARRIER))
1577 icount->dcd++;
1578 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1579 spin_unlock(&serial->serial_lock);
1580 tiocmget->intr_completed = 1;
1581 wake_up_interruptible(&tiocmget->waitq);
1583 memset(serial_state_notification, 0,
1584 sizeof(struct hso_serial_state_notification));
1585 tiocmget_submit_urb(serial,
1586 tiocmget,
1587 serial->parent->usb);
1591 * next few functions largely stolen from drivers/serial/serial_core.c
1593 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1594 * - mask passed in arg for lines of interest
1595 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1596 * Caller should use TIOCGICOUNT to see which one it was
1598 static int
1599 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1601 DECLARE_WAITQUEUE(wait, current);
1602 struct uart_icount cprev, cnow;
1603 struct hso_tiocmget *tiocmget;
1604 int ret;
1606 tiocmget = serial->tiocmget;
1607 if (!tiocmget)
1608 return -ENOENT;
1610 * note the counters on entry
1612 spin_lock_irq(&serial->serial_lock);
1613 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1614 spin_unlock_irq(&serial->serial_lock);
1615 add_wait_queue(&tiocmget->waitq, &wait);
1616 for (;;) {
1617 spin_lock_irq(&serial->serial_lock);
1618 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1619 spin_unlock_irq(&serial->serial_lock);
1620 set_current_state(TASK_INTERRUPTIBLE);
1621 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1622 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1623 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1624 ret = 0;
1625 break;
1627 schedule();
1628 /* see if a signal did it */
1629 if (signal_pending(current)) {
1630 ret = -ERESTARTSYS;
1631 break;
1633 cprev = cnow;
1635 current->state = TASK_RUNNING;
1636 remove_wait_queue(&tiocmget->waitq, &wait);
1638 return ret;
1642 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1643 * Return: write counters to the user passed counter struct
1644 * NB: both 1->0 and 0->1 transitions are counted except for
1645 * RI where only 0->1 is counted.
1647 static int hso_get_count(struct hso_serial *serial,
1648 struct serial_icounter_struct __user *icnt)
1650 struct serial_icounter_struct icount;
1651 struct uart_icount cnow;
1652 struct hso_tiocmget *tiocmget = serial->tiocmget;
1654 if (!tiocmget)
1655 return -ENOENT;
1656 spin_lock_irq(&serial->serial_lock);
1657 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1658 spin_unlock_irq(&serial->serial_lock);
1660 icount.cts = cnow.cts;
1661 icount.dsr = cnow.dsr;
1662 icount.rng = cnow.rng;
1663 icount.dcd = cnow.dcd;
1664 icount.rx = cnow.rx;
1665 icount.tx = cnow.tx;
1666 icount.frame = cnow.frame;
1667 icount.overrun = cnow.overrun;
1668 icount.parity = cnow.parity;
1669 icount.brk = cnow.brk;
1670 icount.buf_overrun = cnow.buf_overrun;
1672 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1676 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1678 int retval;
1679 struct hso_serial *serial = get_serial_by_tty(tty);
1680 struct hso_tiocmget *tiocmget;
1681 u16 UART_state_bitmap;
1683 /* sanity check */
1684 if (!serial) {
1685 D1("no tty structures");
1686 return -EINVAL;
1688 spin_lock_irq(&serial->serial_lock);
1689 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1690 ((serial->dtr_state) ? TIOCM_DTR : 0);
1691 tiocmget = serial->tiocmget;
1692 if (tiocmget) {
1694 UART_state_bitmap = le16_to_cpu(
1695 tiocmget->prev_UART_state_bitmap);
1696 if (UART_state_bitmap & B_RING_SIGNAL)
1697 retval |= TIOCM_RNG;
1698 if (UART_state_bitmap & B_RX_CARRIER)
1699 retval |= TIOCM_CD;
1700 if (UART_state_bitmap & B_TX_CARRIER)
1701 retval |= TIOCM_DSR;
1703 spin_unlock_irq(&serial->serial_lock);
1704 return retval;
1707 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1708 unsigned int set, unsigned int clear)
1710 int val = 0;
1711 unsigned long flags;
1712 int if_num;
1713 struct hso_serial *serial = get_serial_by_tty(tty);
1715 /* sanity check */
1716 if (!serial) {
1717 D1("no tty structures");
1718 return -EINVAL;
1721 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1722 return -EINVAL;
1724 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1726 spin_lock_irqsave(&serial->serial_lock, flags);
1727 if (set & TIOCM_RTS)
1728 serial->rts_state = 1;
1729 if (set & TIOCM_DTR)
1730 serial->dtr_state = 1;
1732 if (clear & TIOCM_RTS)
1733 serial->rts_state = 0;
1734 if (clear & TIOCM_DTR)
1735 serial->dtr_state = 0;
1737 if (serial->dtr_state)
1738 val |= 0x01;
1739 if (serial->rts_state)
1740 val |= 0x02;
1742 spin_unlock_irqrestore(&serial->serial_lock, flags);
1744 return usb_control_msg(serial->parent->usb,
1745 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1746 0x21, val, if_num, NULL, 0,
1747 USB_CTRL_SET_TIMEOUT);
1750 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1751 unsigned int cmd, unsigned long arg)
1753 struct hso_serial *serial = get_serial_by_tty(tty);
1754 void __user *uarg = (void __user *)arg;
1755 int ret = 0;
1756 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1758 if (!serial)
1759 return -ENODEV;
1760 switch (cmd) {
1761 case TIOCMIWAIT:
1762 ret = hso_wait_modem_status(serial, arg);
1763 break;
1765 case TIOCGICOUNT:
1766 ret = hso_get_count(serial, uarg);
1767 break;
1768 default:
1769 ret = -ENOIOCTLCMD;
1770 break;
1772 return ret;
1776 /* starts a transmit */
1777 static void hso_kick_transmit(struct hso_serial *serial)
1779 u8 *temp;
1780 unsigned long flags;
1781 int res;
1783 spin_lock_irqsave(&serial->serial_lock, flags);
1784 if (!serial->tx_buffer_count)
1785 goto out;
1787 if (serial->tx_urb_used)
1788 goto out;
1790 /* Wakeup USB interface if necessary */
1791 if (hso_get_activity(serial->parent) == -EAGAIN)
1792 goto out;
1794 /* Switch pointers around to avoid memcpy */
1795 temp = serial->tx_buffer;
1796 serial->tx_buffer = serial->tx_data;
1797 serial->tx_data = temp;
1798 serial->tx_data_count = serial->tx_buffer_count;
1799 serial->tx_buffer_count = 0;
1801 /* If temp is set, it means we switched buffers */
1802 if (temp && serial->write_data) {
1803 res = serial->write_data(serial);
1804 if (res >= 0)
1805 serial->tx_urb_used = 1;
1807 out:
1808 spin_unlock_irqrestore(&serial->serial_lock, flags);
1811 /* make a request (for reading and writing data to muxed serial port) */
1812 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1813 struct urb *ctrl_urb,
1814 struct usb_ctrlrequest *ctrl_req,
1815 u8 *ctrl_urb_data, u32 size)
1817 int result;
1818 int pipe;
1820 /* Sanity check */
1821 if (!serial || !ctrl_urb || !ctrl_req) {
1822 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1823 return -EINVAL;
1826 /* initialize */
1827 ctrl_req->wValue = 0;
1828 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1829 ctrl_req->wLength = cpu_to_le16(size);
1831 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1832 /* Reading command */
1833 ctrl_req->bRequestType = USB_DIR_IN |
1834 USB_TYPE_OPTION_VENDOR |
1835 USB_RECIP_INTERFACE;
1836 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1837 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1838 } else {
1839 /* Writing command */
1840 ctrl_req->bRequestType = USB_DIR_OUT |
1841 USB_TYPE_OPTION_VENDOR |
1842 USB_RECIP_INTERFACE;
1843 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1844 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1846 /* syslog */
1847 D2("%s command (%02x) len: %d, port: %d",
1848 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1849 ctrl_req->bRequestType, ctrl_req->wLength, port);
1851 /* Load ctrl urb */
1852 ctrl_urb->transfer_flags = 0;
1853 usb_fill_control_urb(ctrl_urb,
1854 serial->parent->usb,
1855 pipe,
1856 (u8 *) ctrl_req,
1857 ctrl_urb_data, size, ctrl_callback, serial);
1858 /* Send it on merry way */
1859 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1860 if (result) {
1861 dev_err(&ctrl_urb->dev->dev,
1862 "%s failed submit ctrl_urb %d type %d\n", __func__,
1863 result, type);
1864 return result;
1867 /* done */
1868 return size;
1871 /* called by intr_callback when read occurs */
1872 static int hso_mux_serial_read(struct hso_serial *serial)
1874 if (!serial)
1875 return -EINVAL;
1877 /* clean data */
1878 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1879 /* make the request */
1881 if (serial->num_rx_urbs != 1) {
1882 dev_err(&serial->parent->interface->dev,
1883 "ERROR: mux'd reads with multiple buffers "
1884 "not possible\n");
1885 return 0;
1887 return mux_device_request(serial,
1888 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1889 serial->parent->port_spec & HSO_PORT_MASK,
1890 serial->rx_urb[0],
1891 &serial->ctrl_req_rx,
1892 serial->rx_data[0], serial->rx_data_length);
1895 /* used for muxed serial port callback (muxed serial read) */
1896 static void intr_callback(struct urb *urb)
1898 struct hso_shared_int *shared_int = urb->context;
1899 struct hso_serial *serial;
1900 unsigned char *port_req;
1901 int status = urb->status;
1902 int i;
1904 usb_mark_last_busy(urb->dev);
1906 /* sanity check */
1907 if (!shared_int)
1908 return;
1910 /* status check */
1911 if (status) {
1912 handle_usb_error(status, __func__, NULL);
1913 return;
1915 D4("\n--- Got intr callback 0x%02X ---", status);
1917 /* what request? */
1918 port_req = urb->transfer_buffer;
1919 D4(" port_req = 0x%.2X\n", *port_req);
1920 /* loop over all muxed ports to find the one sending this */
1921 for (i = 0; i < 8; i++) {
1922 /* max 8 channels on MUX */
1923 if (*port_req & (1 << i)) {
1924 serial = get_serial_by_shared_int_and_type(shared_int,
1925 (1 << i));
1926 if (serial != NULL) {
1927 D1("Pending read interrupt on port %d\n", i);
1928 spin_lock(&serial->serial_lock);
1929 if (serial->rx_state == RX_IDLE &&
1930 serial->open_count > 0) {
1931 /* Setup and send a ctrl req read on
1932 * port i */
1933 if (!serial->rx_urb_filled[0]) {
1934 serial->rx_state = RX_SENT;
1935 hso_mux_serial_read(serial);
1936 } else
1937 serial->rx_state = RX_PENDING;
1938 } else {
1939 D1("Already a read pending on "
1940 "port %d or port not open\n", i);
1942 spin_unlock(&serial->serial_lock);
1946 /* Resubmit interrupt urb */
1947 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1950 /* called for writing to muxed serial port */
1951 static int hso_mux_serial_write_data(struct hso_serial *serial)
1953 if (NULL == serial)
1954 return -EINVAL;
1956 return mux_device_request(serial,
1957 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1958 serial->parent->port_spec & HSO_PORT_MASK,
1959 serial->tx_urb,
1960 &serial->ctrl_req_tx,
1961 serial->tx_data, serial->tx_data_count);
1964 /* write callback for Diag and CS port */
1965 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1967 struct hso_serial *serial = urb->context;
1968 int status = urb->status;
1969 struct tty_struct *tty;
1971 /* sanity check */
1972 if (!serial) {
1973 D1("serial == NULL");
1974 return;
1977 spin_lock(&serial->serial_lock);
1978 serial->tx_urb_used = 0;
1979 tty = tty_kref_get(serial->tty);
1980 spin_unlock(&serial->serial_lock);
1981 if (status) {
1982 handle_usb_error(status, __func__, serial->parent);
1983 tty_kref_put(tty);
1984 return;
1986 hso_put_activity(serial->parent);
1987 if (tty) {
1988 tty_wakeup(tty);
1989 tty_kref_put(tty);
1991 hso_kick_transmit(serial);
1993 D1(" ");
1996 /* called for writing diag or CS serial port */
1997 static int hso_std_serial_write_data(struct hso_serial *serial)
1999 int count = serial->tx_data_count;
2000 int result;
2002 usb_fill_bulk_urb(serial->tx_urb,
2003 serial->parent->usb,
2004 usb_sndbulkpipe(serial->parent->usb,
2005 serial->out_endp->
2006 bEndpointAddress & 0x7F),
2007 serial->tx_data, serial->tx_data_count,
2008 hso_std_serial_write_bulk_callback, serial);
2010 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
2011 if (result) {
2012 dev_warn(&serial->parent->usb->dev,
2013 "Failed to submit urb - res %d\n", result);
2014 return result;
2017 return count;
2020 /* callback after read or write on muxed serial port */
2021 static void ctrl_callback(struct urb *urb)
2023 struct hso_serial *serial = urb->context;
2024 struct usb_ctrlrequest *req;
2025 int status = urb->status;
2026 struct tty_struct *tty;
2028 /* sanity check */
2029 if (!serial)
2030 return;
2032 spin_lock(&serial->serial_lock);
2033 serial->tx_urb_used = 0;
2034 tty = tty_kref_get(serial->tty);
2035 spin_unlock(&serial->serial_lock);
2036 if (status) {
2037 handle_usb_error(status, __func__, serial->parent);
2038 tty_kref_put(tty);
2039 return;
2042 /* what request? */
2043 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2044 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2045 D4("Actual length of urb = %d\n", urb->actual_length);
2046 DUMP1(urb->transfer_buffer, urb->actual_length);
2048 if (req->bRequestType ==
2049 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2050 /* response to a read command */
2051 serial->rx_urb_filled[0] = 1;
2052 spin_lock(&serial->serial_lock);
2053 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2054 spin_unlock(&serial->serial_lock);
2055 } else {
2056 hso_put_activity(serial->parent);
2057 if (tty)
2058 tty_wakeup(tty);
2059 /* response to a write command */
2060 hso_kick_transmit(serial);
2062 tty_kref_put(tty);
2065 /* handle RX data for serial port */
2066 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2068 struct tty_struct *tty;
2069 int write_length_remaining = 0;
2070 int curr_write_len;
2072 /* Sanity check */
2073 if (urb == NULL || serial == NULL) {
2074 D1("serial = NULL");
2075 return -2;
2078 /* All callers to put_rxbuf_data hold serial_lock */
2079 tty = tty_kref_get(serial->tty);
2081 /* Push data to tty */
2082 if (tty) {
2083 write_length_remaining = urb->actual_length -
2084 serial->curr_rx_urb_offset;
2085 D1("data to push to tty");
2086 while (write_length_remaining) {
2087 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2088 tty_kref_put(tty);
2089 return -1;
2091 curr_write_len = tty_insert_flip_string
2092 (tty, urb->transfer_buffer +
2093 serial->curr_rx_urb_offset,
2094 write_length_remaining);
2095 serial->curr_rx_urb_offset += curr_write_len;
2096 write_length_remaining -= curr_write_len;
2097 tty_flip_buffer_push(tty);
2100 if (write_length_remaining == 0) {
2101 serial->curr_rx_urb_offset = 0;
2102 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2104 tty_kref_put(tty);
2105 return write_length_remaining;
2109 /* Base driver functions */
2111 static void hso_log_port(struct hso_device *hso_dev)
2113 char *port_type;
2114 char port_dev[20];
2116 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2117 case HSO_PORT_CONTROL:
2118 port_type = "Control";
2119 break;
2120 case HSO_PORT_APP:
2121 port_type = "Application";
2122 break;
2123 case HSO_PORT_GPS:
2124 port_type = "GPS";
2125 break;
2126 case HSO_PORT_GPS_CONTROL:
2127 port_type = "GPS control";
2128 break;
2129 case HSO_PORT_APP2:
2130 port_type = "Application2";
2131 break;
2132 case HSO_PORT_PCSC:
2133 port_type = "PCSC";
2134 break;
2135 case HSO_PORT_DIAG:
2136 port_type = "Diagnostic";
2137 break;
2138 case HSO_PORT_DIAG2:
2139 port_type = "Diagnostic2";
2140 break;
2141 case HSO_PORT_MODEM:
2142 port_type = "Modem";
2143 break;
2144 case HSO_PORT_NETWORK:
2145 port_type = "Network";
2146 break;
2147 default:
2148 port_type = "Unknown";
2149 break;
2151 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2152 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2153 } else
2154 sprintf(port_dev, "/dev/%s%d", tty_filename,
2155 dev2ser(hso_dev)->minor);
2157 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2158 port_type, port_dev);
2161 static int hso_start_net_device(struct hso_device *hso_dev)
2163 int i, result = 0;
2164 struct hso_net *hso_net = dev2net(hso_dev);
2166 if (!hso_net)
2167 return -ENODEV;
2169 /* send URBs for all read buffers */
2170 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2172 /* Prep a receive URB */
2173 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2174 hso_dev->usb,
2175 usb_rcvbulkpipe(hso_dev->usb,
2176 hso_net->in_endp->
2177 bEndpointAddress & 0x7F),
2178 hso_net->mux_bulk_rx_buf_pool[i],
2179 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2180 hso_net);
2182 /* Put it out there so the device can send us stuff */
2183 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2184 GFP_NOIO);
2185 if (result)
2186 dev_warn(&hso_dev->usb->dev,
2187 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2188 i, result);
2191 return result;
2194 static int hso_stop_net_device(struct hso_device *hso_dev)
2196 int i;
2197 struct hso_net *hso_net = dev2net(hso_dev);
2199 if (!hso_net)
2200 return -ENODEV;
2202 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2203 if (hso_net->mux_bulk_rx_urb_pool[i])
2204 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2207 if (hso_net->mux_bulk_tx_urb)
2208 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2210 return 0;
2213 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2215 int i, result = 0;
2216 struct hso_serial *serial = dev2ser(hso_dev);
2218 if (!serial)
2219 return -ENODEV;
2221 /* If it is not the MUX port fill in and submit a bulk urb (already
2222 * allocated in hso_serial_start) */
2223 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2224 for (i = 0; i < serial->num_rx_urbs; i++) {
2225 usb_fill_bulk_urb(serial->rx_urb[i],
2226 serial->parent->usb,
2227 usb_rcvbulkpipe(serial->parent->usb,
2228 serial->in_endp->
2229 bEndpointAddress &
2230 0x7F),
2231 serial->rx_data[i],
2232 serial->rx_data_length,
2233 hso_std_serial_read_bulk_callback,
2234 serial);
2235 result = usb_submit_urb(serial->rx_urb[i], flags);
2236 if (result) {
2237 dev_warn(&serial->parent->usb->dev,
2238 "Failed to submit urb - res %d\n",
2239 result);
2240 break;
2243 } else {
2244 mutex_lock(&serial->shared_int->shared_int_lock);
2245 if (!serial->shared_int->use_count) {
2246 result =
2247 hso_mux_submit_intr_urb(serial->shared_int,
2248 hso_dev->usb, flags);
2250 serial->shared_int->use_count++;
2251 mutex_unlock(&serial->shared_int->shared_int_lock);
2253 if (serial->tiocmget)
2254 tiocmget_submit_urb(serial,
2255 serial->tiocmget,
2256 serial->parent->usb);
2257 return result;
2260 static int hso_stop_serial_device(struct hso_device *hso_dev)
2262 int i;
2263 struct hso_serial *serial = dev2ser(hso_dev);
2264 struct hso_tiocmget *tiocmget;
2266 if (!serial)
2267 return -ENODEV;
2269 for (i = 0; i < serial->num_rx_urbs; i++) {
2270 if (serial->rx_urb[i]) {
2271 usb_kill_urb(serial->rx_urb[i]);
2272 serial->rx_urb_filled[i] = 0;
2275 serial->curr_rx_urb_idx = 0;
2276 serial->curr_rx_urb_offset = 0;
2278 if (serial->tx_urb)
2279 usb_kill_urb(serial->tx_urb);
2281 if (serial->shared_int) {
2282 mutex_lock(&serial->shared_int->shared_int_lock);
2283 if (serial->shared_int->use_count &&
2284 (--serial->shared_int->use_count == 0)) {
2285 struct urb *urb;
2287 urb = serial->shared_int->shared_intr_urb;
2288 if (urb)
2289 usb_kill_urb(urb);
2291 mutex_unlock(&serial->shared_int->shared_int_lock);
2293 tiocmget = serial->tiocmget;
2294 if (tiocmget) {
2295 wake_up_interruptible(&tiocmget->waitq);
2296 usb_kill_urb(tiocmget->urb);
2299 return 0;
2302 static void hso_serial_common_free(struct hso_serial *serial)
2304 int i;
2306 if (serial->parent->dev)
2307 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2309 tty_unregister_device(tty_drv, serial->minor);
2311 for (i = 0; i < serial->num_rx_urbs; i++) {
2312 /* unlink and free RX URB */
2313 usb_free_urb(serial->rx_urb[i]);
2314 /* free the RX buffer */
2315 kfree(serial->rx_data[i]);
2318 /* unlink and free TX URB */
2319 usb_free_urb(serial->tx_urb);
2320 kfree(serial->tx_data);
2323 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2324 int rx_size, int tx_size)
2326 struct device *dev;
2327 int minor;
2328 int i;
2330 minor = get_free_serial_index();
2331 if (minor < 0)
2332 goto exit;
2334 /* register our minor number */
2335 serial->parent->dev = tty_register_device(tty_drv, minor,
2336 &serial->parent->interface->dev);
2337 dev = serial->parent->dev;
2338 dev_set_drvdata(dev, serial->parent);
2339 i = device_create_file(dev, &dev_attr_hsotype);
2341 /* fill in specific data for later use */
2342 serial->minor = minor;
2343 serial->magic = HSO_SERIAL_MAGIC;
2344 spin_lock_init(&serial->serial_lock);
2345 serial->num_rx_urbs = num_urbs;
2347 /* RX, allocate urb and initialize */
2349 /* prepare our RX buffer */
2350 serial->rx_data_length = rx_size;
2351 for (i = 0; i < serial->num_rx_urbs; i++) {
2352 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2353 if (!serial->rx_urb[i]) {
2354 dev_err(dev, "Could not allocate urb?\n");
2355 goto exit;
2357 serial->rx_urb[i]->transfer_buffer = NULL;
2358 serial->rx_urb[i]->transfer_buffer_length = 0;
2359 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2360 GFP_KERNEL);
2361 if (!serial->rx_data[i]) {
2362 dev_err(dev, "%s - Out of memory\n", __func__);
2363 goto exit;
2367 /* TX, allocate urb and initialize */
2368 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2369 if (!serial->tx_urb) {
2370 dev_err(dev, "Could not allocate urb?\n");
2371 goto exit;
2373 serial->tx_urb->transfer_buffer = NULL;
2374 serial->tx_urb->transfer_buffer_length = 0;
2375 /* prepare our TX buffer */
2376 serial->tx_data_count = 0;
2377 serial->tx_buffer_count = 0;
2378 serial->tx_data_length = tx_size;
2379 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2380 if (!serial->tx_data) {
2381 dev_err(dev, "%s - Out of memory\n", __func__);
2382 goto exit;
2384 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2385 if (!serial->tx_buffer) {
2386 dev_err(dev, "%s - Out of memory\n", __func__);
2387 goto exit;
2390 return 0;
2391 exit:
2392 hso_serial_common_free(serial);
2393 return -1;
2396 /* Creates a general hso device */
2397 static struct hso_device *hso_create_device(struct usb_interface *intf,
2398 int port_spec)
2400 struct hso_device *hso_dev;
2402 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2403 if (!hso_dev)
2404 return NULL;
2406 hso_dev->port_spec = port_spec;
2407 hso_dev->usb = interface_to_usbdev(intf);
2408 hso_dev->interface = intf;
2409 kref_init(&hso_dev->ref);
2410 mutex_init(&hso_dev->mutex);
2412 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2413 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2414 INIT_WORK(&hso_dev->reset_device, reset_device);
2416 return hso_dev;
2419 /* Removes a network device in the network device table */
2420 static int remove_net_device(struct hso_device *hso_dev)
2422 int i;
2424 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2425 if (network_table[i] == hso_dev) {
2426 network_table[i] = NULL;
2427 break;
2430 if (i == HSO_MAX_NET_DEVICES)
2431 return -1;
2432 return 0;
2435 /* Frees our network device */
2436 static void hso_free_net_device(struct hso_device *hso_dev)
2438 int i;
2439 struct hso_net *hso_net = dev2net(hso_dev);
2441 if (!hso_net)
2442 return;
2444 remove_net_device(hso_net->parent);
2446 if (hso_net->net) {
2447 unregister_netdev(hso_net->net);
2448 free_netdev(hso_net->net);
2451 /* start freeing */
2452 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2453 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2454 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2455 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2457 usb_free_urb(hso_net->mux_bulk_tx_urb);
2458 kfree(hso_net->mux_bulk_tx_buf);
2459 hso_net->mux_bulk_tx_buf = NULL;
2461 kfree(hso_dev);
2464 static const struct net_device_ops hso_netdev_ops = {
2465 .ndo_open = hso_net_open,
2466 .ndo_stop = hso_net_close,
2467 .ndo_start_xmit = hso_net_start_xmit,
2468 .ndo_tx_timeout = hso_net_tx_timeout,
2471 /* initialize the network interface */
2472 static void hso_net_init(struct net_device *net)
2474 struct hso_net *hso_net = netdev_priv(net);
2476 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2478 /* fill in the other fields */
2479 net->netdev_ops = &hso_netdev_ops;
2480 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2481 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2482 net->type = ARPHRD_NONE;
2483 net->mtu = DEFAULT_MTU - 14;
2484 net->tx_queue_len = 10;
2485 SET_ETHTOOL_OPS(net, &ops);
2487 /* and initialize the semaphore */
2488 spin_lock_init(&hso_net->net_lock);
2491 /* Adds a network device in the network device table */
2492 static int add_net_device(struct hso_device *hso_dev)
2494 int i;
2496 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2497 if (network_table[i] == NULL) {
2498 network_table[i] = hso_dev;
2499 break;
2502 if (i == HSO_MAX_NET_DEVICES)
2503 return -1;
2504 return 0;
2507 static int hso_rfkill_set_block(void *data, bool blocked)
2509 struct hso_device *hso_dev = data;
2510 int enabled = !blocked;
2511 int rv;
2513 mutex_lock(&hso_dev->mutex);
2514 if (hso_dev->usb_gone)
2515 rv = 0;
2516 else
2517 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2518 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2519 USB_CTRL_SET_TIMEOUT);
2520 mutex_unlock(&hso_dev->mutex);
2521 return rv;
2524 static const struct rfkill_ops hso_rfkill_ops = {
2525 .set_block = hso_rfkill_set_block,
2528 /* Creates and sets up everything for rfkill */
2529 static void hso_create_rfkill(struct hso_device *hso_dev,
2530 struct usb_interface *interface)
2532 struct hso_net *hso_net = dev2net(hso_dev);
2533 struct device *dev = &hso_net->net->dev;
2534 char *rfkn;
2536 rfkn = kzalloc(20, GFP_KERNEL);
2537 if (!rfkn)
2538 dev_err(dev, "%s - Out of memory\n", __func__);
2540 snprintf(rfkn, 20, "hso-%d",
2541 interface->altsetting->desc.bInterfaceNumber);
2543 hso_net->rfkill = rfkill_alloc(rfkn,
2544 &interface_to_usbdev(interface)->dev,
2545 RFKILL_TYPE_WWAN,
2546 &hso_rfkill_ops, hso_dev);
2547 if (!hso_net->rfkill) {
2548 dev_err(dev, "%s - Out of memory\n", __func__);
2549 kfree(rfkn);
2550 return;
2552 if (rfkill_register(hso_net->rfkill) < 0) {
2553 rfkill_destroy(hso_net->rfkill);
2554 kfree(rfkn);
2555 hso_net->rfkill = NULL;
2556 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2557 return;
2561 static struct device_type hso_type = {
2562 .name = "wwan",
2565 /* Creates our network device */
2566 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2567 int port_spec)
2569 int result, i;
2570 struct net_device *net;
2571 struct hso_net *hso_net;
2572 struct hso_device *hso_dev;
2574 hso_dev = hso_create_device(interface, port_spec);
2575 if (!hso_dev)
2576 return NULL;
2578 /* allocate our network device, then we can put in our private data */
2579 /* call hso_net_init to do the basic initialization */
2580 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2581 if (!net) {
2582 dev_err(&interface->dev, "Unable to create ethernet device\n");
2583 goto exit;
2586 hso_net = netdev_priv(net);
2588 hso_dev->port_data.dev_net = hso_net;
2589 hso_net->net = net;
2590 hso_net->parent = hso_dev;
2592 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2593 USB_DIR_IN);
2594 if (!hso_net->in_endp) {
2595 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2596 goto exit;
2598 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2599 USB_DIR_OUT);
2600 if (!hso_net->out_endp) {
2601 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2602 goto exit;
2604 SET_NETDEV_DEV(net, &interface->dev);
2605 SET_NETDEV_DEVTYPE(net, &hso_type);
2607 /* registering our net device */
2608 result = register_netdev(net);
2609 if (result) {
2610 dev_err(&interface->dev, "Failed to register device\n");
2611 goto exit;
2614 /* start allocating */
2615 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2616 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2617 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2618 dev_err(&interface->dev, "Could not allocate rx urb\n");
2619 goto exit;
2621 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2622 GFP_KERNEL);
2623 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2624 dev_err(&interface->dev, "Could not allocate rx buf\n");
2625 goto exit;
2628 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2629 if (!hso_net->mux_bulk_tx_urb) {
2630 dev_err(&interface->dev, "Could not allocate tx urb\n");
2631 goto exit;
2633 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2634 if (!hso_net->mux_bulk_tx_buf) {
2635 dev_err(&interface->dev, "Could not allocate tx buf\n");
2636 goto exit;
2639 add_net_device(hso_dev);
2641 hso_log_port(hso_dev);
2643 hso_create_rfkill(hso_dev, interface);
2645 return hso_dev;
2646 exit:
2647 hso_free_net_device(hso_dev);
2648 return NULL;
2651 static void hso_free_tiomget(struct hso_serial *serial)
2653 struct hso_tiocmget *tiocmget = serial->tiocmget;
2654 if (tiocmget) {
2655 if (tiocmget->urb) {
2656 usb_free_urb(tiocmget->urb);
2657 tiocmget->urb = NULL;
2659 serial->tiocmget = NULL;
2660 kfree(tiocmget);
2665 /* Frees an AT channel ( goes for both mux and non-mux ) */
2666 static void hso_free_serial_device(struct hso_device *hso_dev)
2668 struct hso_serial *serial = dev2ser(hso_dev);
2670 if (!serial)
2671 return;
2672 set_serial_by_index(serial->minor, NULL);
2674 hso_serial_common_free(serial);
2676 if (serial->shared_int) {
2677 mutex_lock(&serial->shared_int->shared_int_lock);
2678 if (--serial->shared_int->ref_count == 0)
2679 hso_free_shared_int(serial->shared_int);
2680 else
2681 mutex_unlock(&serial->shared_int->shared_int_lock);
2683 hso_free_tiomget(serial);
2684 kfree(serial);
2685 kfree(hso_dev);
2688 /* Creates a bulk AT channel */
2689 static struct hso_device *hso_create_bulk_serial_device(
2690 struct usb_interface *interface, int port)
2692 struct hso_device *hso_dev;
2693 struct hso_serial *serial;
2694 int num_urbs;
2695 struct hso_tiocmget *tiocmget;
2697 hso_dev = hso_create_device(interface, port);
2698 if (!hso_dev)
2699 return NULL;
2701 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2702 if (!serial)
2703 goto exit;
2705 serial->parent = hso_dev;
2706 hso_dev->port_data.dev_serial = serial;
2708 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2709 num_urbs = 2;
2710 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2711 GFP_KERNEL);
2712 /* it isn't going to break our heart if serial->tiocmget
2713 * allocation fails don't bother checking this.
2715 if (serial->tiocmget) {
2716 tiocmget = serial->tiocmget;
2717 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2718 if (tiocmget->urb) {
2719 mutex_init(&tiocmget->mutex);
2720 init_waitqueue_head(&tiocmget->waitq);
2721 tiocmget->endp = hso_get_ep(
2722 interface,
2723 USB_ENDPOINT_XFER_INT,
2724 USB_DIR_IN);
2725 } else
2726 hso_free_tiomget(serial);
2729 else
2730 num_urbs = 1;
2732 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2733 BULK_URB_TX_SIZE))
2734 goto exit;
2736 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2737 USB_DIR_IN);
2738 if (!serial->in_endp) {
2739 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2740 goto exit2;
2743 if (!
2744 (serial->out_endp =
2745 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2746 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2747 goto exit2;
2750 serial->write_data = hso_std_serial_write_data;
2752 /* and record this serial */
2753 set_serial_by_index(serial->minor, serial);
2755 /* setup the proc dirs and files if needed */
2756 hso_log_port(hso_dev);
2758 /* done, return it */
2759 return hso_dev;
2761 exit2:
2762 hso_serial_common_free(serial);
2763 exit:
2764 hso_free_tiomget(serial);
2765 kfree(serial);
2766 kfree(hso_dev);
2767 return NULL;
2770 /* Creates a multiplexed AT channel */
2771 static
2772 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2773 int port,
2774 struct hso_shared_int *mux)
2776 struct hso_device *hso_dev;
2777 struct hso_serial *serial;
2778 int port_spec;
2780 port_spec = HSO_INTF_MUX;
2781 port_spec &= ~HSO_PORT_MASK;
2783 port_spec |= hso_mux_to_port(port);
2784 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2785 return NULL;
2787 hso_dev = hso_create_device(interface, port_spec);
2788 if (!hso_dev)
2789 return NULL;
2791 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2792 if (!serial)
2793 goto exit;
2795 hso_dev->port_data.dev_serial = serial;
2796 serial->parent = hso_dev;
2798 if (hso_serial_common_create
2799 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2800 goto exit;
2802 serial->tx_data_length--;
2803 serial->write_data = hso_mux_serial_write_data;
2805 serial->shared_int = mux;
2806 mutex_lock(&serial->shared_int->shared_int_lock);
2807 serial->shared_int->ref_count++;
2808 mutex_unlock(&serial->shared_int->shared_int_lock);
2810 /* and record this serial */
2811 set_serial_by_index(serial->minor, serial);
2813 /* setup the proc dirs and files if needed */
2814 hso_log_port(hso_dev);
2816 /* done, return it */
2817 return hso_dev;
2819 exit:
2820 if (serial) {
2821 tty_unregister_device(tty_drv, serial->minor);
2822 kfree(serial);
2824 if (hso_dev)
2825 kfree(hso_dev);
2826 return NULL;
2830 static void hso_free_shared_int(struct hso_shared_int *mux)
2832 usb_free_urb(mux->shared_intr_urb);
2833 kfree(mux->shared_intr_buf);
2834 mutex_unlock(&mux->shared_int_lock);
2835 kfree(mux);
2838 static
2839 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2841 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2843 if (!mux)
2844 return NULL;
2846 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2847 USB_DIR_IN);
2848 if (!mux->intr_endp) {
2849 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2850 goto exit;
2853 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2854 if (!mux->shared_intr_urb) {
2855 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2856 goto exit;
2858 mux->shared_intr_buf =
2859 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2860 GFP_KERNEL);
2861 if (!mux->shared_intr_buf) {
2862 dev_err(&interface->dev, "Could not allocate intr buf?\n");
2863 goto exit;
2866 mutex_init(&mux->shared_int_lock);
2868 return mux;
2870 exit:
2871 kfree(mux->shared_intr_buf);
2872 usb_free_urb(mux->shared_intr_urb);
2873 kfree(mux);
2874 return NULL;
2877 /* Gets the port spec for a certain interface */
2878 static int hso_get_config_data(struct usb_interface *interface)
2880 struct usb_device *usbdev = interface_to_usbdev(interface);
2881 u8 config_data[17];
2882 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2883 s32 result;
2885 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2886 0x86, 0xC0, 0, 0, config_data, 17,
2887 USB_CTRL_SET_TIMEOUT) != 0x11) {
2888 return -EIO;
2891 switch (config_data[if_num]) {
2892 case 0x0:
2893 result = 0;
2894 break;
2895 case 0x1:
2896 result = HSO_PORT_DIAG;
2897 break;
2898 case 0x2:
2899 result = HSO_PORT_GPS;
2900 break;
2901 case 0x3:
2902 result = HSO_PORT_GPS_CONTROL;
2903 break;
2904 case 0x4:
2905 result = HSO_PORT_APP;
2906 break;
2907 case 0x5:
2908 result = HSO_PORT_APP2;
2909 break;
2910 case 0x6:
2911 result = HSO_PORT_CONTROL;
2912 break;
2913 case 0x7:
2914 result = HSO_PORT_NETWORK;
2915 break;
2916 case 0x8:
2917 result = HSO_PORT_MODEM;
2918 break;
2919 case 0x9:
2920 result = HSO_PORT_MSD;
2921 break;
2922 case 0xa:
2923 result = HSO_PORT_PCSC;
2924 break;
2925 case 0xb:
2926 result = HSO_PORT_VOICE;
2927 break;
2928 default:
2929 result = 0;
2932 if (result)
2933 result |= HSO_INTF_BULK;
2935 if (config_data[16] & 0x1)
2936 result |= HSO_INFO_CRC_BUG;
2938 return result;
2941 /* called once for each interface upon device insertion */
2942 static int hso_probe(struct usb_interface *interface,
2943 const struct usb_device_id *id)
2945 int mux, i, if_num, port_spec;
2946 unsigned char port_mask;
2947 struct hso_device *hso_dev = NULL;
2948 struct hso_shared_int *shared_int;
2949 struct hso_device *tmp_dev = NULL;
2951 if_num = interface->altsetting->desc.bInterfaceNumber;
2953 /* Get the interface/port specification from either driver_info or from
2954 * the device itself */
2955 if (id->driver_info)
2956 port_spec = ((u32 *)(id->driver_info))[if_num];
2957 else
2958 port_spec = hso_get_config_data(interface);
2960 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2961 dev_err(&interface->dev, "Not our interface\n");
2962 return -ENODEV;
2964 /* Check if we need to switch to alt interfaces prior to port
2965 * configuration */
2966 if (interface->num_altsetting > 1)
2967 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2968 interface->needs_remote_wakeup = 1;
2970 /* Allocate new hso device(s) */
2971 switch (port_spec & HSO_INTF_MASK) {
2972 case HSO_INTF_MUX:
2973 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2974 /* Create the network device */
2975 if (!disable_net) {
2976 hso_dev = hso_create_net_device(interface,
2977 port_spec);
2978 if (!hso_dev)
2979 goto exit;
2980 tmp_dev = hso_dev;
2984 if (hso_get_mux_ports(interface, &port_mask))
2985 /* TODO: de-allocate everything */
2986 goto exit;
2988 shared_int = hso_create_shared_int(interface);
2989 if (!shared_int)
2990 goto exit;
2992 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2993 if (port_mask & i) {
2994 hso_dev = hso_create_mux_serial_device(
2995 interface, i, shared_int);
2996 if (!hso_dev)
2997 goto exit;
3001 if (tmp_dev)
3002 hso_dev = tmp_dev;
3003 break;
3005 case HSO_INTF_BULK:
3006 /* It's a regular bulk interface */
3007 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) &&
3008 !disable_net)
3009 hso_dev = hso_create_net_device(interface, port_spec);
3010 else
3011 hso_dev =
3012 hso_create_bulk_serial_device(interface, port_spec);
3013 if (!hso_dev)
3014 goto exit;
3015 break;
3016 default:
3017 goto exit;
3020 /* save our data pointer in this device */
3021 usb_set_intfdata(interface, hso_dev);
3023 /* done */
3024 return 0;
3025 exit:
3026 hso_free_interface(interface);
3027 return -ENODEV;
3030 /* device removed, cleaning up */
3031 static void hso_disconnect(struct usb_interface *interface)
3033 hso_free_interface(interface);
3035 /* remove reference of our private data */
3036 usb_set_intfdata(interface, NULL);
3039 static void async_get_intf(struct work_struct *data)
3041 struct hso_device *hso_dev =
3042 container_of(data, struct hso_device, async_get_intf);
3043 usb_autopm_get_interface(hso_dev->interface);
3046 static void async_put_intf(struct work_struct *data)
3048 struct hso_device *hso_dev =
3049 container_of(data, struct hso_device, async_put_intf);
3050 usb_autopm_put_interface(hso_dev->interface);
3053 static int hso_get_activity(struct hso_device *hso_dev)
3055 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3056 if (!hso_dev->is_active) {
3057 hso_dev->is_active = 1;
3058 schedule_work(&hso_dev->async_get_intf);
3062 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3063 return -EAGAIN;
3065 usb_mark_last_busy(hso_dev->usb);
3067 return 0;
3070 static int hso_put_activity(struct hso_device *hso_dev)
3072 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3073 if (hso_dev->is_active) {
3074 hso_dev->is_active = 0;
3075 schedule_work(&hso_dev->async_put_intf);
3076 return -EAGAIN;
3079 hso_dev->is_active = 0;
3080 return 0;
3083 /* called by kernel when we need to suspend device */
3084 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3086 int i, result;
3088 /* Stop all serial ports */
3089 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3090 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3091 result = hso_stop_serial_device(serial_table[i]);
3092 if (result)
3093 goto out;
3097 /* Stop all network ports */
3098 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3099 if (network_table[i] &&
3100 (network_table[i]->interface == iface)) {
3101 result = hso_stop_net_device(network_table[i]);
3102 if (result)
3103 goto out;
3107 out:
3108 return 0;
3111 /* called by kernel when we need to resume device */
3112 static int hso_resume(struct usb_interface *iface)
3114 int i, result = 0;
3115 struct hso_net *hso_net;
3117 /* Start all serial ports */
3118 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3119 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3120 if (dev2ser(serial_table[i])->open_count) {
3121 result =
3122 hso_start_serial_device(serial_table[i], GFP_NOIO);
3123 hso_kick_transmit(dev2ser(serial_table[i]));
3124 if (result)
3125 goto out;
3130 /* Start all network ports */
3131 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3132 if (network_table[i] &&
3133 (network_table[i]->interface == iface)) {
3134 hso_net = dev2net(network_table[i]);
3135 if (hso_net->flags & IFF_UP) {
3136 /* First transmit any lingering data,
3137 then restart the device. */
3138 if (hso_net->skb_tx_buf) {
3139 dev_dbg(&iface->dev,
3140 "Transmitting"
3141 " lingering data\n");
3142 hso_net_start_xmit(hso_net->skb_tx_buf,
3143 hso_net->net);
3144 hso_net->skb_tx_buf = NULL;
3146 result = hso_start_net_device(network_table[i]);
3147 if (result)
3148 goto out;
3153 out:
3154 return result;
3157 static void reset_device(struct work_struct *data)
3159 struct hso_device *hso_dev =
3160 container_of(data, struct hso_device, reset_device);
3161 struct usb_device *usb = hso_dev->usb;
3162 int result;
3164 if (hso_dev->usb_gone) {
3165 D1("No reset during disconnect\n");
3166 } else {
3167 result = usb_lock_device_for_reset(usb, hso_dev->interface);
3168 if (result < 0)
3169 D1("unable to lock device for reset: %d\n", result);
3170 else {
3171 usb_reset_device(usb);
3172 usb_unlock_device(usb);
3177 static void hso_serial_ref_free(struct kref *ref)
3179 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3181 hso_free_serial_device(hso_dev);
3184 static void hso_free_interface(struct usb_interface *interface)
3186 struct hso_serial *hso_dev;
3187 struct tty_struct *tty;
3188 int i;
3190 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3191 if (serial_table[i] &&
3192 (serial_table[i]->interface == interface)) {
3193 hso_dev = dev2ser(serial_table[i]);
3194 spin_lock_irq(&hso_dev->serial_lock);
3195 tty = tty_kref_get(hso_dev->tty);
3196 spin_unlock_irq(&hso_dev->serial_lock);
3197 if (tty)
3198 tty_hangup(tty);
3199 mutex_lock(&hso_dev->parent->mutex);
3200 tty_kref_put(tty);
3201 hso_dev->parent->usb_gone = 1;
3202 mutex_unlock(&hso_dev->parent->mutex);
3203 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3207 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3208 if (network_table[i] &&
3209 (network_table[i]->interface == interface)) {
3210 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3211 /* hso_stop_net_device doesn't stop the net queue since
3212 * traffic needs to start it again when suspended */
3213 netif_stop_queue(dev2net(network_table[i])->net);
3214 hso_stop_net_device(network_table[i]);
3215 cancel_work_sync(&network_table[i]->async_put_intf);
3216 cancel_work_sync(&network_table[i]->async_get_intf);
3217 if (rfk) {
3218 rfkill_unregister(rfk);
3219 rfkill_destroy(rfk);
3221 hso_free_net_device(network_table[i]);
3226 /* Helper functions */
3228 /* Get the endpoint ! */
3229 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3230 int type, int dir)
3232 int i;
3233 struct usb_host_interface *iface = intf->cur_altsetting;
3234 struct usb_endpoint_descriptor *endp;
3236 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3237 endp = &iface->endpoint[i].desc;
3238 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3239 (usb_endpoint_type(endp) == type))
3240 return endp;
3243 return NULL;
3246 /* Get the byte that describes which ports are enabled */
3247 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3249 int i;
3250 struct usb_host_interface *iface = intf->cur_altsetting;
3252 if (iface->extralen == 3) {
3253 *ports = iface->extra[2];
3254 return 0;
3257 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3258 if (iface->endpoint[i].extralen == 3) {
3259 *ports = iface->endpoint[i].extra[2];
3260 return 0;
3264 return -1;
3267 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3268 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3269 struct usb_device *usb, gfp_t gfp)
3271 int result;
3273 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3274 usb_rcvintpipe(usb,
3275 shared_int->intr_endp->bEndpointAddress & 0x7F),
3276 shared_int->shared_intr_buf,
3278 intr_callback, shared_int,
3279 shared_int->intr_endp->bInterval);
3281 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3282 if (result)
3283 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3284 result);
3286 return result;
3289 /* operations setup of the serial interface */
3290 static const struct tty_operations hso_serial_ops = {
3291 .open = hso_serial_open,
3292 .close = hso_serial_close,
3293 .write = hso_serial_write,
3294 .write_room = hso_serial_write_room,
3295 .ioctl = hso_serial_ioctl,
3296 .set_termios = hso_serial_set_termios,
3297 .chars_in_buffer = hso_serial_chars_in_buffer,
3298 .tiocmget = hso_serial_tiocmget,
3299 .tiocmset = hso_serial_tiocmset,
3300 .unthrottle = hso_unthrottle
3303 static struct usb_driver hso_driver = {
3304 .name = driver_name,
3305 .probe = hso_probe,
3306 .disconnect = hso_disconnect,
3307 .id_table = hso_ids,
3308 .suspend = hso_suspend,
3309 .resume = hso_resume,
3310 .reset_resume = hso_resume,
3311 .supports_autosuspend = 1,
3314 static int __init hso_init(void)
3316 int i;
3317 int result;
3319 /* put it in the log */
3320 printk(KERN_INFO "hso: %s\n", version);
3322 /* Initialise the serial table semaphore and table */
3323 spin_lock_init(&serial_table_lock);
3324 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3325 serial_table[i] = NULL;
3327 /* allocate our driver using the proper amount of supported minors */
3328 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3329 if (!tty_drv)
3330 return -ENOMEM;
3332 /* fill in all needed values */
3333 tty_drv->magic = TTY_DRIVER_MAGIC;
3334 tty_drv->owner = THIS_MODULE;
3335 tty_drv->driver_name = driver_name;
3336 tty_drv->name = tty_filename;
3338 /* if major number is provided as parameter, use that one */
3339 if (tty_major)
3340 tty_drv->major = tty_major;
3342 tty_drv->minor_start = 0;
3343 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3344 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3345 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3346 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3347 tty_drv->init_termios = tty_std_termios;
3348 hso_init_termios(&tty_drv->init_termios);
3349 tty_set_operations(tty_drv, &hso_serial_ops);
3351 /* register the tty driver */
3352 result = tty_register_driver(tty_drv);
3353 if (result) {
3354 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3355 __func__, result);
3356 return result;
3359 /* register this module as an usb driver */
3360 result = usb_register(&hso_driver);
3361 if (result) {
3362 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3363 result);
3364 /* cleanup serial interface */
3365 tty_unregister_driver(tty_drv);
3366 return result;
3369 /* done */
3370 return 0;
3373 static void __exit hso_exit(void)
3375 printk(KERN_INFO "hso: unloaded\n");
3377 tty_unregister_driver(tty_drv);
3378 /* deregister the usb driver */
3379 usb_deregister(&hso_driver);
3382 /* Module definitions */
3383 module_init(hso_init);
3384 module_exit(hso_exit);
3386 MODULE_AUTHOR(MOD_AUTHOR);
3387 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3388 MODULE_LICENSE(MOD_LICENSE);
3389 MODULE_INFO(Version, DRIVER_VERSION);
3391 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3392 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3393 module_param(debug, int, S_IRUGO | S_IWUSR);
3395 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3396 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3397 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3399 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3400 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3401 module_param(disable_net, int, S_IRUGO | S_IWUSR);