enic: Add new firmware devcmds
[linux/fpc-iii.git] / drivers / net / usb / hso.c
blob4f123f869bdc8a26d97a90d5d8622d15dd366db9
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 MOD_AUTHOR "Option Wireless"
77 #define MOD_DESCRIPTION "USB High Speed Option driver"
78 #define MOD_LICENSE "GPL"
80 #define HSO_MAX_NET_DEVICES 10
81 #define HSO__MAX_MTU 2048
82 #define DEFAULT_MTU 1500
83 #define DEFAULT_MRU 1500
85 #define CTRL_URB_RX_SIZE 1024
86 #define CTRL_URB_TX_SIZE 64
88 #define BULK_URB_RX_SIZE 4096
89 #define BULK_URB_TX_SIZE 8192
91 #define MUX_BULK_RX_BUF_SIZE HSO__MAX_MTU
92 #define MUX_BULK_TX_BUF_SIZE HSO__MAX_MTU
93 #define MUX_BULK_RX_BUF_COUNT 4
94 #define USB_TYPE_OPTION_VENDOR 0x20
96 /* These definitions are used with the struct hso_net flags element */
97 /* - use *_bit operations on it. (bit indices not values.) */
98 #define HSO_NET_RUNNING 0
100 #define HSO_NET_TX_TIMEOUT (HZ*10)
102 #define HSO_SERIAL_MAGIC 0x48534f31
104 /* Number of ttys to handle */
105 #define HSO_SERIAL_TTY_MINORS 256
107 #define MAX_RX_URBS 2
109 static inline struct hso_serial *get_serial_by_tty(struct tty_struct *tty)
111 if (tty)
112 return tty->driver_data;
113 return NULL;
116 /*****************************************************************************/
117 /* Debugging functions */
118 /*****************************************************************************/
119 #define D__(lvl_, fmt, arg...) \
120 do { \
121 printk(lvl_ "[%d:%s]: " fmt "\n", \
122 __LINE__, __func__, ## arg); \
123 } while (0)
125 #define D_(lvl, args...) \
126 do { \
127 if (lvl & debug) \
128 D__(KERN_INFO, args); \
129 } while (0)
131 #define D1(args...) D_(0x01, ##args)
132 #define D2(args...) D_(0x02, ##args)
133 #define D3(args...) D_(0x04, ##args)
134 #define D4(args...) D_(0x08, ##args)
135 #define D5(args...) D_(0x10, ##args)
137 /*****************************************************************************/
138 /* Enumerators */
139 /*****************************************************************************/
140 enum pkt_parse_state {
141 WAIT_IP,
142 WAIT_DATA,
143 WAIT_SYNC
146 /*****************************************************************************/
147 /* Structs */
148 /*****************************************************************************/
150 struct hso_shared_int {
151 struct usb_endpoint_descriptor *intr_endp;
152 void *shared_intr_buf;
153 struct urb *shared_intr_urb;
154 struct usb_device *usb;
155 int use_count;
156 int ref_count;
157 struct mutex shared_int_lock;
160 struct hso_net {
161 struct hso_device *parent;
162 struct net_device *net;
163 struct rfkill *rfkill;
165 struct usb_endpoint_descriptor *in_endp;
166 struct usb_endpoint_descriptor *out_endp;
168 struct urb *mux_bulk_rx_urb_pool[MUX_BULK_RX_BUF_COUNT];
169 struct urb *mux_bulk_tx_urb;
170 void *mux_bulk_rx_buf_pool[MUX_BULK_RX_BUF_COUNT];
171 void *mux_bulk_tx_buf;
173 struct sk_buff *skb_rx_buf;
174 struct sk_buff *skb_tx_buf;
176 enum pkt_parse_state rx_parse_state;
177 spinlock_t net_lock;
179 unsigned short rx_buf_size;
180 unsigned short rx_buf_missing;
181 struct iphdr rx_ip_hdr;
183 unsigned long flags;
186 enum rx_ctrl_state{
187 RX_IDLE,
188 RX_SENT,
189 RX_PENDING
192 #define BM_REQUEST_TYPE (0xa1)
193 #define B_NOTIFICATION (0x20)
194 #define W_VALUE (0x0)
195 #define W_INDEX (0x2)
196 #define W_LENGTH (0x2)
198 #define B_OVERRUN (0x1<<6)
199 #define B_PARITY (0x1<<5)
200 #define B_FRAMING (0x1<<4)
201 #define B_RING_SIGNAL (0x1<<3)
202 #define B_BREAK (0x1<<2)
203 #define B_TX_CARRIER (0x1<<1)
204 #define B_RX_CARRIER (0x1<<0)
206 struct hso_serial_state_notification {
207 u8 bmRequestType;
208 u8 bNotification;
209 u16 wValue;
210 u16 wIndex;
211 u16 wLength;
212 u16 UART_state_bitmap;
213 } __packed;
215 struct hso_tiocmget {
216 struct mutex mutex;
217 wait_queue_head_t waitq;
218 int intr_completed;
219 struct usb_endpoint_descriptor *endp;
220 struct urb *urb;
221 struct hso_serial_state_notification serial_state_notification;
222 u16 prev_UART_state_bitmap;
223 struct uart_icount icount;
227 struct hso_serial {
228 struct hso_device *parent;
229 int magic;
230 u8 minor;
232 struct hso_shared_int *shared_int;
234 /* rx/tx urb could be either a bulk urb or a control urb depending
235 on which serial port it is used on. */
236 struct urb *rx_urb[MAX_RX_URBS];
237 u8 num_rx_urbs;
238 u8 *rx_data[MAX_RX_URBS];
239 u16 rx_data_length; /* should contain allocated length */
241 struct urb *tx_urb;
242 u8 *tx_data;
243 u8 *tx_buffer;
244 u16 tx_data_length; /* should contain allocated length */
245 u16 tx_data_count;
246 u16 tx_buffer_count;
247 struct usb_ctrlrequest ctrl_req_tx;
248 struct usb_ctrlrequest ctrl_req_rx;
250 struct usb_endpoint_descriptor *in_endp;
251 struct usb_endpoint_descriptor *out_endp;
253 enum rx_ctrl_state rx_state;
254 u8 rts_state;
255 u8 dtr_state;
256 unsigned tx_urb_used:1;
258 /* from usb_serial_port */
259 struct tty_struct *tty;
260 int open_count;
261 spinlock_t serial_lock;
263 int (*write_data) (struct hso_serial *serial);
264 struct hso_tiocmget *tiocmget;
265 /* Hacks required to get flow control
266 * working on the serial receive buffers
267 * so as not to drop characters on the floor.
269 int curr_rx_urb_idx;
270 u16 curr_rx_urb_offset;
271 u8 rx_urb_filled[MAX_RX_URBS];
272 struct tasklet_struct unthrottle_tasklet;
273 struct work_struct retry_unthrottle_workqueue;
276 struct hso_device {
277 union {
278 struct hso_serial *dev_serial;
279 struct hso_net *dev_net;
280 } port_data;
282 u32 port_spec;
284 u8 is_active;
285 u8 usb_gone;
286 struct work_struct async_get_intf;
287 struct work_struct async_put_intf;
288 struct work_struct reset_device;
290 struct usb_device *usb;
291 struct usb_interface *interface;
293 struct device *dev;
294 struct kref ref;
295 struct mutex mutex;
298 /* Type of interface */
299 #define HSO_INTF_MASK 0xFF00
300 #define HSO_INTF_MUX 0x0100
301 #define HSO_INTF_BULK 0x0200
303 /* Type of port */
304 #define HSO_PORT_MASK 0xFF
305 #define HSO_PORT_NO_PORT 0x0
306 #define HSO_PORT_CONTROL 0x1
307 #define HSO_PORT_APP 0x2
308 #define HSO_PORT_GPS 0x3
309 #define HSO_PORT_PCSC 0x4
310 #define HSO_PORT_APP2 0x5
311 #define HSO_PORT_GPS_CONTROL 0x6
312 #define HSO_PORT_MSD 0x7
313 #define HSO_PORT_VOICE 0x8
314 #define HSO_PORT_DIAG2 0x9
315 #define HSO_PORT_DIAG 0x10
316 #define HSO_PORT_MODEM 0x11
317 #define HSO_PORT_NETWORK 0x12
319 /* Additional device info */
320 #define HSO_INFO_MASK 0xFF000000
321 #define HSO_INFO_CRC_BUG 0x01000000
323 /*****************************************************************************/
324 /* Prototypes */
325 /*****************************************************************************/
326 /* Serial driver functions */
327 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
328 unsigned int set, unsigned int clear);
329 static void ctrl_callback(struct urb *urb);
330 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial);
331 static void hso_kick_transmit(struct hso_serial *serial);
332 /* Helper functions */
333 static int hso_mux_submit_intr_urb(struct hso_shared_int *mux_int,
334 struct usb_device *usb, gfp_t gfp);
335 static void handle_usb_error(int status, const char *function,
336 struct hso_device *hso_dev);
337 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
338 int type, int dir);
339 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports);
340 static void hso_free_interface(struct usb_interface *intf);
341 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags);
342 static int hso_stop_serial_device(struct hso_device *hso_dev);
343 static int hso_start_net_device(struct hso_device *hso_dev);
344 static void hso_free_shared_int(struct hso_shared_int *shared_int);
345 static int hso_stop_net_device(struct hso_device *hso_dev);
346 static void hso_serial_ref_free(struct kref *ref);
347 static void hso_std_serial_read_bulk_callback(struct urb *urb);
348 static int hso_mux_serial_read(struct hso_serial *serial);
349 static void async_get_intf(struct work_struct *data);
350 static void async_put_intf(struct work_struct *data);
351 static int hso_put_activity(struct hso_device *hso_dev);
352 static int hso_get_activity(struct hso_device *hso_dev);
353 static void tiocmget_intr_callback(struct urb *urb);
354 static void reset_device(struct work_struct *data);
355 /*****************************************************************************/
356 /* Helping functions */
357 /*****************************************************************************/
359 /* #define DEBUG */
361 static inline struct hso_net *dev2net(struct hso_device *hso_dev)
363 return hso_dev->port_data.dev_net;
366 static inline struct hso_serial *dev2ser(struct hso_device *hso_dev)
368 return hso_dev->port_data.dev_serial;
371 /* Debugging functions */
372 #ifdef DEBUG
373 static void dbg_dump(int line_count, const char *func_name, unsigned char *buf,
374 unsigned int len)
376 static char name[255];
378 sprintf(name, "hso[%d:%s]", line_count, func_name);
379 print_hex_dump_bytes(name, DUMP_PREFIX_NONE, buf, len);
382 #define DUMP(buf_, len_) \
383 dbg_dump(__LINE__, __func__, (unsigned char *)buf_, len_)
385 #define DUMP1(buf_, len_) \
386 do { \
387 if (0x01 & debug) \
388 DUMP(buf_, len_); \
389 } while (0)
390 #else
391 #define DUMP(buf_, len_)
392 #define DUMP1(buf_, len_)
393 #endif
395 /* module parameters */
396 static int debug;
397 static int tty_major;
398 static int disable_net;
400 /* driver info */
401 static const char driver_name[] = "hso";
402 static const char tty_filename[] = "ttyHS";
403 static const char *version = __FILE__ ": " MOD_AUTHOR;
404 /* the usb driver itself (registered in hso_init) */
405 static struct usb_driver hso_driver;
406 /* serial structures */
407 static struct tty_driver *tty_drv;
408 static struct hso_device *serial_table[HSO_SERIAL_TTY_MINORS];
409 static struct hso_device *network_table[HSO_MAX_NET_DEVICES];
410 static spinlock_t serial_table_lock;
412 static const s32 default_port_spec[] = {
413 HSO_INTF_MUX | HSO_PORT_NETWORK,
414 HSO_INTF_BULK | HSO_PORT_DIAG,
415 HSO_INTF_BULK | HSO_PORT_MODEM,
419 static const s32 icon321_port_spec[] = {
420 HSO_INTF_MUX | HSO_PORT_NETWORK,
421 HSO_INTF_BULK | HSO_PORT_DIAG2,
422 HSO_INTF_BULK | HSO_PORT_MODEM,
423 HSO_INTF_BULK | HSO_PORT_DIAG,
427 #define default_port_device(vendor, product) \
428 USB_DEVICE(vendor, product), \
429 .driver_info = (kernel_ulong_t)default_port_spec
431 #define icon321_port_device(vendor, product) \
432 USB_DEVICE(vendor, product), \
433 .driver_info = (kernel_ulong_t)icon321_port_spec
435 /* list of devices we support */
436 static const struct usb_device_id hso_ids[] = {
437 {default_port_device(0x0af0, 0x6711)},
438 {default_port_device(0x0af0, 0x6731)},
439 {default_port_device(0x0af0, 0x6751)},
440 {default_port_device(0x0af0, 0x6771)},
441 {default_port_device(0x0af0, 0x6791)},
442 {default_port_device(0x0af0, 0x6811)},
443 {default_port_device(0x0af0, 0x6911)},
444 {default_port_device(0x0af0, 0x6951)},
445 {default_port_device(0x0af0, 0x6971)},
446 {default_port_device(0x0af0, 0x7011)},
447 {default_port_device(0x0af0, 0x7031)},
448 {default_port_device(0x0af0, 0x7051)},
449 {default_port_device(0x0af0, 0x7071)},
450 {default_port_device(0x0af0, 0x7111)},
451 {default_port_device(0x0af0, 0x7211)},
452 {default_port_device(0x0af0, 0x7251)},
453 {default_port_device(0x0af0, 0x7271)},
454 {default_port_device(0x0af0, 0x7311)},
455 {default_port_device(0x0af0, 0xc031)}, /* Icon-Edge */
456 {icon321_port_device(0x0af0, 0xd013)}, /* Module HSxPA */
457 {icon321_port_device(0x0af0, 0xd031)}, /* Icon-321 */
458 {icon321_port_device(0x0af0, 0xd033)}, /* Icon-322 */
459 {USB_DEVICE(0x0af0, 0x7301)}, /* GE40x */
460 {USB_DEVICE(0x0af0, 0x7361)}, /* GE40x */
461 {USB_DEVICE(0x0af0, 0x7381)}, /* GE40x */
462 {USB_DEVICE(0x0af0, 0x7401)}, /* GI 0401 */
463 {USB_DEVICE(0x0af0, 0x7501)}, /* GTM 382 */
464 {USB_DEVICE(0x0af0, 0x7601)}, /* GE40x */
465 {USB_DEVICE(0x0af0, 0x7701)},
466 {USB_DEVICE(0x0af0, 0x7706)},
467 {USB_DEVICE(0x0af0, 0x7801)},
468 {USB_DEVICE(0x0af0, 0x7901)},
469 {USB_DEVICE(0x0af0, 0x7A01)},
470 {USB_DEVICE(0x0af0, 0x7A05)},
471 {USB_DEVICE(0x0af0, 0x8200)},
472 {USB_DEVICE(0x0af0, 0x8201)},
473 {USB_DEVICE(0x0af0, 0x8300)},
474 {USB_DEVICE(0x0af0, 0x8302)},
475 {USB_DEVICE(0x0af0, 0x8304)},
476 {USB_DEVICE(0x0af0, 0x8400)},
477 {USB_DEVICE(0x0af0, 0x8600)},
478 {USB_DEVICE(0x0af0, 0x8800)},
479 {USB_DEVICE(0x0af0, 0x8900)},
480 {USB_DEVICE(0x0af0, 0x9000)},
481 {USB_DEVICE(0x0af0, 0xd035)},
482 {USB_DEVICE(0x0af0, 0xd055)},
483 {USB_DEVICE(0x0af0, 0xd155)},
484 {USB_DEVICE(0x0af0, 0xd255)},
485 {USB_DEVICE(0x0af0, 0xd057)},
486 {USB_DEVICE(0x0af0, 0xd157)},
487 {USB_DEVICE(0x0af0, 0xd257)},
488 {USB_DEVICE(0x0af0, 0xd357)},
489 {USB_DEVICE(0x0af0, 0xd058)},
490 {USB_DEVICE(0x0af0, 0xc100)},
493 MODULE_DEVICE_TABLE(usb, hso_ids);
495 /* Sysfs attribute */
496 static ssize_t hso_sysfs_show_porttype(struct device *dev,
497 struct device_attribute *attr,
498 char *buf)
500 struct hso_device *hso_dev = dev_get_drvdata(dev);
501 char *port_name;
503 if (!hso_dev)
504 return 0;
506 switch (hso_dev->port_spec & HSO_PORT_MASK) {
507 case HSO_PORT_CONTROL:
508 port_name = "Control";
509 break;
510 case HSO_PORT_APP:
511 port_name = "Application";
512 break;
513 case HSO_PORT_APP2:
514 port_name = "Application2";
515 break;
516 case HSO_PORT_GPS:
517 port_name = "GPS";
518 break;
519 case HSO_PORT_GPS_CONTROL:
520 port_name = "GPS Control";
521 break;
522 case HSO_PORT_PCSC:
523 port_name = "PCSC";
524 break;
525 case HSO_PORT_DIAG:
526 port_name = "Diagnostic";
527 break;
528 case HSO_PORT_DIAG2:
529 port_name = "Diagnostic2";
530 break;
531 case HSO_PORT_MODEM:
532 port_name = "Modem";
533 break;
534 case HSO_PORT_NETWORK:
535 port_name = "Network";
536 break;
537 default:
538 port_name = "Unknown";
539 break;
542 return sprintf(buf, "%s\n", port_name);
544 static DEVICE_ATTR(hsotype, S_IRUGO, hso_sysfs_show_porttype, NULL);
546 static int hso_urb_to_index(struct hso_serial *serial, struct urb *urb)
548 int idx;
550 for (idx = 0; idx < serial->num_rx_urbs; idx++)
551 if (serial->rx_urb[idx] == urb)
552 return idx;
553 dev_err(serial->parent->dev, "hso_urb_to_index failed\n");
554 return -1;
557 /* converts mux value to a port spec value */
558 static u32 hso_mux_to_port(int mux)
560 u32 result;
562 switch (mux) {
563 case 0x1:
564 result = HSO_PORT_CONTROL;
565 break;
566 case 0x2:
567 result = HSO_PORT_APP;
568 break;
569 case 0x4:
570 result = HSO_PORT_PCSC;
571 break;
572 case 0x8:
573 result = HSO_PORT_GPS;
574 break;
575 case 0x10:
576 result = HSO_PORT_APP2;
577 break;
578 default:
579 result = HSO_PORT_NO_PORT;
581 return result;
584 /* converts port spec value to a mux value */
585 static u32 hso_port_to_mux(int port)
587 u32 result;
589 switch (port & HSO_PORT_MASK) {
590 case HSO_PORT_CONTROL:
591 result = 0x0;
592 break;
593 case HSO_PORT_APP:
594 result = 0x1;
595 break;
596 case HSO_PORT_PCSC:
597 result = 0x2;
598 break;
599 case HSO_PORT_GPS:
600 result = 0x3;
601 break;
602 case HSO_PORT_APP2:
603 result = 0x4;
604 break;
605 default:
606 result = 0x0;
608 return result;
611 static struct hso_serial *get_serial_by_shared_int_and_type(
612 struct hso_shared_int *shared_int,
613 int mux)
615 int i, port;
617 port = hso_mux_to_port(mux);
619 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
620 if (serial_table[i] &&
621 (dev2ser(serial_table[i])->shared_int == shared_int) &&
622 ((serial_table[i]->port_spec & HSO_PORT_MASK) == port)) {
623 return dev2ser(serial_table[i]);
627 return NULL;
630 static struct hso_serial *get_serial_by_index(unsigned index)
632 struct hso_serial *serial = NULL;
633 unsigned long flags;
635 spin_lock_irqsave(&serial_table_lock, flags);
636 if (serial_table[index])
637 serial = dev2ser(serial_table[index]);
638 spin_unlock_irqrestore(&serial_table_lock, flags);
640 return serial;
643 static int get_free_serial_index(void)
645 int index;
646 unsigned long flags;
648 spin_lock_irqsave(&serial_table_lock, flags);
649 for (index = 0; index < HSO_SERIAL_TTY_MINORS; index++) {
650 if (serial_table[index] == NULL) {
651 spin_unlock_irqrestore(&serial_table_lock, flags);
652 return index;
655 spin_unlock_irqrestore(&serial_table_lock, flags);
657 printk(KERN_ERR "%s: no free serial devices in table\n", __func__);
658 return -1;
661 static void set_serial_by_index(unsigned index, struct hso_serial *serial)
663 unsigned long flags;
665 spin_lock_irqsave(&serial_table_lock, flags);
666 if (serial)
667 serial_table[index] = serial->parent;
668 else
669 serial_table[index] = NULL;
670 spin_unlock_irqrestore(&serial_table_lock, flags);
673 static void handle_usb_error(int status, const char *function,
674 struct hso_device *hso_dev)
676 char *explanation;
678 switch (status) {
679 case -ENODEV:
680 explanation = "no device";
681 break;
682 case -ENOENT:
683 explanation = "endpoint not enabled";
684 break;
685 case -EPIPE:
686 explanation = "endpoint stalled";
687 break;
688 case -ENOSPC:
689 explanation = "not enough bandwidth";
690 break;
691 case -ESHUTDOWN:
692 explanation = "device disabled";
693 break;
694 case -EHOSTUNREACH:
695 explanation = "device suspended";
696 break;
697 case -EINVAL:
698 case -EAGAIN:
699 case -EFBIG:
700 case -EMSGSIZE:
701 explanation = "internal error";
702 break;
703 case -EILSEQ:
704 case -EPROTO:
705 case -ETIME:
706 case -ETIMEDOUT:
707 explanation = "protocol error";
708 if (hso_dev)
709 schedule_work(&hso_dev->reset_device);
710 break;
711 default:
712 explanation = "unknown status";
713 break;
716 /* log a meaningful explanation of an USB status */
717 D1("%s: received USB status - %s (%d)", function, explanation, status);
720 /* Network interface functions */
722 /* called when net interface is brought up by ifconfig */
723 static int hso_net_open(struct net_device *net)
725 struct hso_net *odev = netdev_priv(net);
726 unsigned long flags = 0;
728 if (!odev) {
729 dev_err(&net->dev, "No net device !\n");
730 return -ENODEV;
733 odev->skb_tx_buf = NULL;
735 /* setup environment */
736 spin_lock_irqsave(&odev->net_lock, flags);
737 odev->rx_parse_state = WAIT_IP;
738 odev->rx_buf_size = 0;
739 odev->rx_buf_missing = sizeof(struct iphdr);
740 spin_unlock_irqrestore(&odev->net_lock, flags);
742 /* We are up and running. */
743 set_bit(HSO_NET_RUNNING, &odev->flags);
744 hso_start_net_device(odev->parent);
746 /* Tell the kernel we are ready to start receiving from it */
747 netif_start_queue(net);
749 return 0;
752 /* called when interface is brought down by ifconfig */
753 static int hso_net_close(struct net_device *net)
755 struct hso_net *odev = netdev_priv(net);
757 /* we don't need the queue anymore */
758 netif_stop_queue(net);
759 /* no longer running */
760 clear_bit(HSO_NET_RUNNING, &odev->flags);
762 hso_stop_net_device(odev->parent);
764 /* done */
765 return 0;
768 /* USB tells is xmit done, we should start the netqueue again */
769 static void write_bulk_callback(struct urb *urb)
771 struct hso_net *odev = urb->context;
772 int status = urb->status;
774 /* Sanity check */
775 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
776 dev_err(&urb->dev->dev, "%s: device not running\n", __func__);
777 return;
780 /* Do we still have a valid kernel network device? */
781 if (!netif_device_present(odev->net)) {
782 dev_err(&urb->dev->dev, "%s: net device not present\n",
783 __func__);
784 return;
787 /* log status, but don't act on it, we don't need to resubmit anything
788 * anyhow */
789 if (status)
790 handle_usb_error(status, __func__, odev->parent);
792 hso_put_activity(odev->parent);
794 /* Tell the network interface we are ready for another frame */
795 netif_wake_queue(odev->net);
798 /* called by kernel when we need to transmit a packet */
799 static netdev_tx_t hso_net_start_xmit(struct sk_buff *skb,
800 struct net_device *net)
802 struct hso_net *odev = netdev_priv(net);
803 int result;
805 /* Tell the kernel, "No more frames 'til we are done with this one." */
806 netif_stop_queue(net);
807 if (hso_get_activity(odev->parent) == -EAGAIN) {
808 odev->skb_tx_buf = skb;
809 return NETDEV_TX_OK;
812 /* log if asked */
813 DUMP1(skb->data, skb->len);
814 /* Copy it from kernel memory to OUR memory */
815 memcpy(odev->mux_bulk_tx_buf, skb->data, skb->len);
816 D1("len: %d/%d", skb->len, MUX_BULK_TX_BUF_SIZE);
818 /* Fill in the URB for shipping it out. */
819 usb_fill_bulk_urb(odev->mux_bulk_tx_urb,
820 odev->parent->usb,
821 usb_sndbulkpipe(odev->parent->usb,
822 odev->out_endp->
823 bEndpointAddress & 0x7F),
824 odev->mux_bulk_tx_buf, skb->len, write_bulk_callback,
825 odev);
827 /* Deal with the Zero Length packet problem, I hope */
828 odev->mux_bulk_tx_urb->transfer_flags |= URB_ZERO_PACKET;
830 /* Send the URB on its merry way. */
831 result = usb_submit_urb(odev->mux_bulk_tx_urb, GFP_ATOMIC);
832 if (result) {
833 dev_warn(&odev->parent->interface->dev,
834 "failed mux_bulk_tx_urb %d\n", result);
835 net->stats.tx_errors++;
836 netif_start_queue(net);
837 } else {
838 net->stats.tx_packets++;
839 net->stats.tx_bytes += skb->len;
841 dev_kfree_skb(skb);
842 /* we're done */
843 return NETDEV_TX_OK;
846 static const struct ethtool_ops ops = {
847 .get_link = ethtool_op_get_link
850 /* called when a packet did not ack after watchdogtimeout */
851 static void hso_net_tx_timeout(struct net_device *net)
853 struct hso_net *odev = netdev_priv(net);
855 if (!odev)
856 return;
858 /* Tell syslog we are hosed. */
859 dev_warn(&net->dev, "Tx timed out.\n");
861 /* Tear the waiting frame off the list */
862 if (odev->mux_bulk_tx_urb &&
863 (odev->mux_bulk_tx_urb->status == -EINPROGRESS))
864 usb_unlink_urb(odev->mux_bulk_tx_urb);
866 /* Update statistics */
867 net->stats.tx_errors++;
870 /* make a real packet from the received USB buffer */
871 static void packetizeRx(struct hso_net *odev, unsigned char *ip_pkt,
872 unsigned int count, unsigned char is_eop)
874 unsigned short temp_bytes;
875 unsigned short buffer_offset = 0;
876 unsigned short frame_len;
877 unsigned char *tmp_rx_buf;
879 /* log if needed */
880 D1("Rx %d bytes", count);
881 DUMP(ip_pkt, min(128, (int)count));
883 while (count) {
884 switch (odev->rx_parse_state) {
885 case WAIT_IP:
886 /* waiting for IP header. */
887 /* wanted bytes - size of ip header */
888 temp_bytes =
889 (count <
890 odev->rx_buf_missing) ? count : odev->
891 rx_buf_missing;
893 memcpy(((unsigned char *)(&odev->rx_ip_hdr)) +
894 odev->rx_buf_size, ip_pkt + buffer_offset,
895 temp_bytes);
897 odev->rx_buf_size += temp_bytes;
898 buffer_offset += temp_bytes;
899 odev->rx_buf_missing -= temp_bytes;
900 count -= temp_bytes;
902 if (!odev->rx_buf_missing) {
903 /* header is complete allocate an sk_buffer and
904 * continue to WAIT_DATA */
905 frame_len = ntohs(odev->rx_ip_hdr.tot_len);
907 if ((frame_len > DEFAULT_MRU) ||
908 (frame_len < sizeof(struct iphdr))) {
909 dev_err(&odev->net->dev,
910 "Invalid frame (%d) length\n",
911 frame_len);
912 odev->rx_parse_state = WAIT_SYNC;
913 continue;
915 /* Allocate an sk_buff */
916 odev->skb_rx_buf = netdev_alloc_skb(odev->net,
917 frame_len);
918 if (!odev->skb_rx_buf) {
919 /* We got no receive buffer. */
920 D1("could not allocate memory");
921 odev->rx_parse_state = WAIT_SYNC;
922 return;
925 /* Copy what we got so far. make room for iphdr
926 * after tail. */
927 tmp_rx_buf =
928 skb_put(odev->skb_rx_buf,
929 sizeof(struct iphdr));
930 memcpy(tmp_rx_buf, (char *)&(odev->rx_ip_hdr),
931 sizeof(struct iphdr));
933 /* ETH_HLEN */
934 odev->rx_buf_size = sizeof(struct iphdr);
936 /* Filip actually use .tot_len */
937 odev->rx_buf_missing =
938 frame_len - sizeof(struct iphdr);
939 odev->rx_parse_state = WAIT_DATA;
941 break;
943 case WAIT_DATA:
944 temp_bytes = (count < odev->rx_buf_missing)
945 ? count : odev->rx_buf_missing;
947 /* Copy the rest of the bytes that are left in the
948 * buffer into the waiting sk_buf. */
949 /* Make room for temp_bytes after tail. */
950 tmp_rx_buf = skb_put(odev->skb_rx_buf, temp_bytes);
951 memcpy(tmp_rx_buf, ip_pkt + buffer_offset, temp_bytes);
953 odev->rx_buf_missing -= temp_bytes;
954 count -= temp_bytes;
955 buffer_offset += temp_bytes;
956 odev->rx_buf_size += temp_bytes;
957 if (!odev->rx_buf_missing) {
958 /* Packet is complete. Inject into stack. */
959 /* We have IP packet here */
960 odev->skb_rx_buf->protocol = cpu_to_be16(ETH_P_IP);
961 /* don't check it */
962 odev->skb_rx_buf->ip_summed =
963 CHECKSUM_UNNECESSARY;
965 skb_reset_mac_header(odev->skb_rx_buf);
967 /* Ship it off to the kernel */
968 netif_rx(odev->skb_rx_buf);
969 /* No longer our buffer. */
970 odev->skb_rx_buf = NULL;
972 /* update out statistics */
973 odev->net->stats.rx_packets++;
975 odev->net->stats.rx_bytes += odev->rx_buf_size;
977 odev->rx_buf_size = 0;
978 odev->rx_buf_missing = sizeof(struct iphdr);
979 odev->rx_parse_state = WAIT_IP;
981 break;
983 case WAIT_SYNC:
984 D1(" W_S");
985 count = 0;
986 break;
987 default:
988 D1(" ");
989 count--;
990 break;
994 /* Recovery mechanism for WAIT_SYNC state. */
995 if (is_eop) {
996 if (odev->rx_parse_state == WAIT_SYNC) {
997 odev->rx_parse_state = WAIT_IP;
998 odev->rx_buf_size = 0;
999 odev->rx_buf_missing = sizeof(struct iphdr);
1004 /* Moving data from usb to kernel (in interrupt state) */
1005 static void read_bulk_callback(struct urb *urb)
1007 struct hso_net *odev = urb->context;
1008 struct net_device *net;
1009 int result;
1010 int status = urb->status;
1012 /* is al ok? (Filip: Who's Al ?) */
1013 if (status) {
1014 handle_usb_error(status, __func__, odev->parent);
1015 return;
1018 /* Sanity check */
1019 if (!odev || !test_bit(HSO_NET_RUNNING, &odev->flags)) {
1020 D1("BULK IN callback but driver is not active!");
1021 return;
1023 usb_mark_last_busy(urb->dev);
1025 net = odev->net;
1027 if (!netif_device_present(net)) {
1028 /* Somebody killed our network interface... */
1029 return;
1032 if (odev->parent->port_spec & HSO_INFO_CRC_BUG) {
1033 u32 rest;
1034 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1035 rest = urb->actual_length %
1036 le16_to_cpu(odev->in_endp->wMaxPacketSize);
1037 if (((rest == 5) || (rest == 6)) &&
1038 !memcmp(((u8 *) urb->transfer_buffer) +
1039 urb->actual_length - 4, crc_check, 4)) {
1040 urb->actual_length -= 4;
1044 /* do we even have a packet? */
1045 if (urb->actual_length) {
1046 /* Handle the IP stream, add header and push it onto network
1047 * stack if the packet is complete. */
1048 spin_lock(&odev->net_lock);
1049 packetizeRx(odev, urb->transfer_buffer, urb->actual_length,
1050 (urb->transfer_buffer_length >
1051 urb->actual_length) ? 1 : 0);
1052 spin_unlock(&odev->net_lock);
1055 /* We are done with this URB, resubmit it. Prep the USB to wait for
1056 * another frame. Reuse same as received. */
1057 usb_fill_bulk_urb(urb,
1058 odev->parent->usb,
1059 usb_rcvbulkpipe(odev->parent->usb,
1060 odev->in_endp->
1061 bEndpointAddress & 0x7F),
1062 urb->transfer_buffer, MUX_BULK_RX_BUF_SIZE,
1063 read_bulk_callback, odev);
1065 /* Give this to the USB subsystem so it can tell us when more data
1066 * arrives. */
1067 result = usb_submit_urb(urb, GFP_ATOMIC);
1068 if (result)
1069 dev_warn(&odev->parent->interface->dev,
1070 "%s failed submit mux_bulk_rx_urb %d\n", __func__,
1071 result);
1074 /* Serial driver functions */
1076 static void hso_init_termios(struct ktermios *termios)
1079 * The default requirements for this device are:
1081 termios->c_iflag &=
1082 ~(IGNBRK /* disable ignore break */
1083 | BRKINT /* disable break causes interrupt */
1084 | PARMRK /* disable mark parity errors */
1085 | ISTRIP /* disable clear high bit of input characters */
1086 | INLCR /* disable translate NL to CR */
1087 | IGNCR /* disable ignore CR */
1088 | ICRNL /* disable translate CR to NL */
1089 | IXON); /* disable enable XON/XOFF flow control */
1091 /* disable postprocess output characters */
1092 termios->c_oflag &= ~OPOST;
1094 termios->c_lflag &=
1095 ~(ECHO /* disable echo input characters */
1096 | ECHONL /* disable echo new line */
1097 | ICANON /* disable erase, kill, werase, and rprnt
1098 special characters */
1099 | ISIG /* disable interrupt, quit, and suspend special
1100 characters */
1101 | IEXTEN); /* disable non-POSIX special characters */
1103 termios->c_cflag &=
1104 ~(CSIZE /* no size */
1105 | PARENB /* disable parity bit */
1106 | CBAUD /* clear current baud rate */
1107 | CBAUDEX); /* clear current buad rate */
1109 termios->c_cflag |= CS8; /* character size 8 bits */
1111 /* baud rate 115200 */
1112 tty_termios_encode_baud_rate(termios, 115200, 115200);
1115 static void _hso_serial_set_termios(struct tty_struct *tty,
1116 struct ktermios *old)
1118 struct hso_serial *serial = get_serial_by_tty(tty);
1119 struct ktermios *termios;
1121 if (!serial) {
1122 printk(KERN_ERR "%s: no tty structures", __func__);
1123 return;
1126 D4("port %d", serial->minor);
1129 * Fix up unsupported bits
1131 termios = tty->termios;
1132 termios->c_iflag &= ~IXON; /* disable enable XON/XOFF flow control */
1134 termios->c_cflag &=
1135 ~(CSIZE /* no size */
1136 | PARENB /* disable parity bit */
1137 | CBAUD /* clear current baud rate */
1138 | CBAUDEX); /* clear current buad rate */
1140 termios->c_cflag |= CS8; /* character size 8 bits */
1142 /* baud rate 115200 */
1143 tty_encode_baud_rate(tty, 115200, 115200);
1146 static void hso_resubmit_rx_bulk_urb(struct hso_serial *serial, struct urb *urb)
1148 int result;
1149 /* We are done with this URB, resubmit it. Prep the USB to wait for
1150 * another frame */
1151 usb_fill_bulk_urb(urb, serial->parent->usb,
1152 usb_rcvbulkpipe(serial->parent->usb,
1153 serial->in_endp->
1154 bEndpointAddress & 0x7F),
1155 urb->transfer_buffer, serial->rx_data_length,
1156 hso_std_serial_read_bulk_callback, serial);
1157 /* Give this to the USB subsystem so it can tell us when more data
1158 * arrives. */
1159 result = usb_submit_urb(urb, GFP_ATOMIC);
1160 if (result) {
1161 dev_err(&urb->dev->dev, "%s failed submit serial rx_urb %d\n",
1162 __func__, result);
1169 static void put_rxbuf_data_and_resubmit_bulk_urb(struct hso_serial *serial)
1171 int count;
1172 struct urb *curr_urb;
1174 while (serial->rx_urb_filled[serial->curr_rx_urb_idx]) {
1175 curr_urb = serial->rx_urb[serial->curr_rx_urb_idx];
1176 count = put_rxbuf_data(curr_urb, serial);
1177 if (count == -1)
1178 return;
1179 if (count == 0) {
1180 serial->curr_rx_urb_idx++;
1181 if (serial->curr_rx_urb_idx >= serial->num_rx_urbs)
1182 serial->curr_rx_urb_idx = 0;
1183 hso_resubmit_rx_bulk_urb(serial, curr_urb);
1188 static void put_rxbuf_data_and_resubmit_ctrl_urb(struct hso_serial *serial)
1190 int count = 0;
1191 struct urb *urb;
1193 urb = serial->rx_urb[0];
1194 if (serial->open_count > 0) {
1195 count = put_rxbuf_data(urb, serial);
1196 if (count == -1)
1197 return;
1199 /* Re issue a read as long as we receive data. */
1201 if (count == 0 && ((urb->actual_length != 0) ||
1202 (serial->rx_state == RX_PENDING))) {
1203 serial->rx_state = RX_SENT;
1204 hso_mux_serial_read(serial);
1205 } else
1206 serial->rx_state = RX_IDLE;
1210 /* read callback for Diag and CS port */
1211 static void hso_std_serial_read_bulk_callback(struct urb *urb)
1213 struct hso_serial *serial = urb->context;
1214 int status = urb->status;
1216 /* sanity check */
1217 if (!serial) {
1218 D1("serial == NULL");
1219 return;
1220 } else if (status) {
1221 handle_usb_error(status, __func__, serial->parent);
1222 return;
1225 D4("\n--- Got serial_read_bulk callback %02x ---", status);
1226 D1("Actual length = %d\n", urb->actual_length);
1227 DUMP1(urb->transfer_buffer, urb->actual_length);
1229 /* Anyone listening? */
1230 if (serial->open_count == 0)
1231 return;
1233 if (status == 0) {
1234 if (serial->parent->port_spec & HSO_INFO_CRC_BUG) {
1235 u32 rest;
1236 u8 crc_check[4] = { 0xDE, 0xAD, 0xBE, 0xEF };
1237 rest =
1238 urb->actual_length %
1239 le16_to_cpu(serial->in_endp->wMaxPacketSize);
1240 if (((rest == 5) || (rest == 6)) &&
1241 !memcmp(((u8 *) urb->transfer_buffer) +
1242 urb->actual_length - 4, crc_check, 4)) {
1243 urb->actual_length -= 4;
1246 /* Valid data, handle RX data */
1247 spin_lock(&serial->serial_lock);
1248 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 1;
1249 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1250 spin_unlock(&serial->serial_lock);
1251 } else if (status == -ENOENT || status == -ECONNRESET) {
1252 /* Unlinked - check for throttled port. */
1253 D2("Port %d, successfully unlinked urb", serial->minor);
1254 spin_lock(&serial->serial_lock);
1255 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
1256 hso_resubmit_rx_bulk_urb(serial, urb);
1257 spin_unlock(&serial->serial_lock);
1258 } else {
1259 D2("Port %d, status = %d for read urb", serial->minor, status);
1260 return;
1265 * This needs to be a tasklet otherwise we will
1266 * end up recursively calling this function.
1268 static void hso_unthrottle_tasklet(struct hso_serial *serial)
1270 unsigned long flags;
1272 spin_lock_irqsave(&serial->serial_lock, flags);
1273 if ((serial->parent->port_spec & HSO_INTF_MUX))
1274 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
1275 else
1276 put_rxbuf_data_and_resubmit_bulk_urb(serial);
1277 spin_unlock_irqrestore(&serial->serial_lock, flags);
1280 static void hso_unthrottle(struct tty_struct *tty)
1282 struct hso_serial *serial = get_serial_by_tty(tty);
1284 tasklet_hi_schedule(&serial->unthrottle_tasklet);
1287 static void hso_unthrottle_workfunc(struct work_struct *work)
1289 struct hso_serial *serial =
1290 container_of(work, struct hso_serial,
1291 retry_unthrottle_workqueue);
1292 hso_unthrottle_tasklet(serial);
1295 /* open the requested serial port */
1296 static int hso_serial_open(struct tty_struct *tty, struct file *filp)
1298 struct hso_serial *serial = get_serial_by_index(tty->index);
1299 int result;
1301 /* sanity check */
1302 if (serial == NULL || serial->magic != HSO_SERIAL_MAGIC) {
1303 WARN_ON(1);
1304 tty->driver_data = NULL;
1305 D1("Failed to open port");
1306 return -ENODEV;
1309 mutex_lock(&serial->parent->mutex);
1310 result = usb_autopm_get_interface(serial->parent->interface);
1311 if (result < 0)
1312 goto err_out;
1314 D1("Opening %d", serial->minor);
1315 kref_get(&serial->parent->ref);
1317 /* setup */
1318 spin_lock_irq(&serial->serial_lock);
1319 tty->driver_data = serial;
1320 tty_kref_put(serial->tty);
1321 serial->tty = tty_kref_get(tty);
1322 spin_unlock_irq(&serial->serial_lock);
1324 /* check for port already opened, if not set the termios */
1325 serial->open_count++;
1326 if (serial->open_count == 1) {
1327 serial->rx_state = RX_IDLE;
1328 /* Force default termio settings */
1329 _hso_serial_set_termios(tty, NULL);
1330 tasklet_init(&serial->unthrottle_tasklet,
1331 (void (*)(unsigned long))hso_unthrottle_tasklet,
1332 (unsigned long)serial);
1333 INIT_WORK(&serial->retry_unthrottle_workqueue,
1334 hso_unthrottle_workfunc);
1335 result = hso_start_serial_device(serial->parent, GFP_KERNEL);
1336 if (result) {
1337 hso_stop_serial_device(serial->parent);
1338 serial->open_count--;
1339 kref_put(&serial->parent->ref, hso_serial_ref_free);
1341 } else {
1342 D1("Port was already open");
1345 usb_autopm_put_interface(serial->parent->interface);
1347 /* done */
1348 if (result)
1349 hso_serial_tiocmset(tty, NULL, TIOCM_RTS | TIOCM_DTR, 0);
1350 err_out:
1351 mutex_unlock(&serial->parent->mutex);
1352 return result;
1355 /* close the requested serial port */
1356 static void hso_serial_close(struct tty_struct *tty, struct file *filp)
1358 struct hso_serial *serial = tty->driver_data;
1359 u8 usb_gone;
1361 D1("Closing serial port");
1363 /* Open failed, no close cleanup required */
1364 if (serial == NULL)
1365 return;
1367 mutex_lock(&serial->parent->mutex);
1368 usb_gone = serial->parent->usb_gone;
1370 if (!usb_gone)
1371 usb_autopm_get_interface(serial->parent->interface);
1373 /* reset the rts and dtr */
1374 /* do the actual close */
1375 serial->open_count--;
1377 if (serial->open_count <= 0) {
1378 serial->open_count = 0;
1379 spin_lock_irq(&serial->serial_lock);
1380 if (serial->tty == tty) {
1381 serial->tty->driver_data = NULL;
1382 serial->tty = NULL;
1383 tty_kref_put(tty);
1385 spin_unlock_irq(&serial->serial_lock);
1386 if (!usb_gone)
1387 hso_stop_serial_device(serial->parent);
1388 tasklet_kill(&serial->unthrottle_tasklet);
1389 cancel_work_sync(&serial->retry_unthrottle_workqueue);
1392 if (!usb_gone)
1393 usb_autopm_put_interface(serial->parent->interface);
1395 mutex_unlock(&serial->parent->mutex);
1397 kref_put(&serial->parent->ref, hso_serial_ref_free);
1400 /* close the requested serial port */
1401 static int hso_serial_write(struct tty_struct *tty, const unsigned char *buf,
1402 int count)
1404 struct hso_serial *serial = get_serial_by_tty(tty);
1405 int space, tx_bytes;
1406 unsigned long flags;
1408 /* sanity check */
1409 if (serial == NULL) {
1410 printk(KERN_ERR "%s: serial is NULL\n", __func__);
1411 return -ENODEV;
1414 spin_lock_irqsave(&serial->serial_lock, flags);
1416 space = serial->tx_data_length - serial->tx_buffer_count;
1417 tx_bytes = (count < space) ? count : space;
1419 if (!tx_bytes)
1420 goto out;
1422 memcpy(serial->tx_buffer + serial->tx_buffer_count, buf, tx_bytes);
1423 serial->tx_buffer_count += tx_bytes;
1425 out:
1426 spin_unlock_irqrestore(&serial->serial_lock, flags);
1428 hso_kick_transmit(serial);
1429 /* done */
1430 return tx_bytes;
1433 /* how much room is there for writing */
1434 static int hso_serial_write_room(struct tty_struct *tty)
1436 struct hso_serial *serial = get_serial_by_tty(tty);
1437 int room;
1438 unsigned long flags;
1440 spin_lock_irqsave(&serial->serial_lock, flags);
1441 room = serial->tx_data_length - serial->tx_buffer_count;
1442 spin_unlock_irqrestore(&serial->serial_lock, flags);
1444 /* return free room */
1445 return room;
1448 /* setup the term */
1449 static void hso_serial_set_termios(struct tty_struct *tty, struct ktermios *old)
1451 struct hso_serial *serial = get_serial_by_tty(tty);
1452 unsigned long flags;
1454 if (old)
1455 D5("Termios called with: cflags new[%d] - old[%d]",
1456 tty->termios->c_cflag, old->c_cflag);
1458 /* the actual setup */
1459 spin_lock_irqsave(&serial->serial_lock, flags);
1460 if (serial->open_count)
1461 _hso_serial_set_termios(tty, old);
1462 else
1463 tty->termios = old;
1464 spin_unlock_irqrestore(&serial->serial_lock, flags);
1466 /* done */
1469 /* how many characters in the buffer */
1470 static int hso_serial_chars_in_buffer(struct tty_struct *tty)
1472 struct hso_serial *serial = get_serial_by_tty(tty);
1473 int chars;
1474 unsigned long flags;
1476 /* sanity check */
1477 if (serial == NULL)
1478 return 0;
1480 spin_lock_irqsave(&serial->serial_lock, flags);
1481 chars = serial->tx_buffer_count;
1482 spin_unlock_irqrestore(&serial->serial_lock, flags);
1484 return chars;
1486 static int tiocmget_submit_urb(struct hso_serial *serial,
1487 struct hso_tiocmget *tiocmget,
1488 struct usb_device *usb)
1490 int result;
1492 if (serial->parent->usb_gone)
1493 return -ENODEV;
1494 usb_fill_int_urb(tiocmget->urb, usb,
1495 usb_rcvintpipe(usb,
1496 tiocmget->endp->
1497 bEndpointAddress & 0x7F),
1498 &tiocmget->serial_state_notification,
1499 sizeof(struct hso_serial_state_notification),
1500 tiocmget_intr_callback, serial,
1501 tiocmget->endp->bInterval);
1502 result = usb_submit_urb(tiocmget->urb, GFP_ATOMIC);
1503 if (result) {
1504 dev_warn(&usb->dev, "%s usb_submit_urb failed %d\n", __func__,
1505 result);
1507 return result;
1511 static void tiocmget_intr_callback(struct urb *urb)
1513 struct hso_serial *serial = urb->context;
1514 struct hso_tiocmget *tiocmget;
1515 int status = urb->status;
1516 u16 UART_state_bitmap, prev_UART_state_bitmap;
1517 struct uart_icount *icount;
1518 struct hso_serial_state_notification *serial_state_notification;
1519 struct usb_device *usb;
1521 /* Sanity checks */
1522 if (!serial)
1523 return;
1524 if (status) {
1525 handle_usb_error(status, __func__, serial->parent);
1526 return;
1528 tiocmget = serial->tiocmget;
1529 if (!tiocmget)
1530 return;
1531 usb = serial->parent->usb;
1532 serial_state_notification = &tiocmget->serial_state_notification;
1533 if (serial_state_notification->bmRequestType != BM_REQUEST_TYPE ||
1534 serial_state_notification->bNotification != B_NOTIFICATION ||
1535 le16_to_cpu(serial_state_notification->wValue) != W_VALUE ||
1536 le16_to_cpu(serial_state_notification->wIndex) != W_INDEX ||
1537 le16_to_cpu(serial_state_notification->wLength) != W_LENGTH) {
1538 dev_warn(&usb->dev,
1539 "hso received invalid serial state notification\n");
1540 DUMP(serial_state_notification,
1541 sizeof(struct hso_serial_state_notification));
1542 } else {
1544 UART_state_bitmap = le16_to_cpu(serial_state_notification->
1545 UART_state_bitmap);
1546 prev_UART_state_bitmap = tiocmget->prev_UART_state_bitmap;
1547 icount = &tiocmget->icount;
1548 spin_lock(&serial->serial_lock);
1549 if ((UART_state_bitmap & B_OVERRUN) !=
1550 (prev_UART_state_bitmap & B_OVERRUN))
1551 icount->parity++;
1552 if ((UART_state_bitmap & B_PARITY) !=
1553 (prev_UART_state_bitmap & B_PARITY))
1554 icount->parity++;
1555 if ((UART_state_bitmap & B_FRAMING) !=
1556 (prev_UART_state_bitmap & B_FRAMING))
1557 icount->frame++;
1558 if ((UART_state_bitmap & B_RING_SIGNAL) &&
1559 !(prev_UART_state_bitmap & B_RING_SIGNAL))
1560 icount->rng++;
1561 if ((UART_state_bitmap & B_BREAK) !=
1562 (prev_UART_state_bitmap & B_BREAK))
1563 icount->brk++;
1564 if ((UART_state_bitmap & B_TX_CARRIER) !=
1565 (prev_UART_state_bitmap & B_TX_CARRIER))
1566 icount->dsr++;
1567 if ((UART_state_bitmap & B_RX_CARRIER) !=
1568 (prev_UART_state_bitmap & B_RX_CARRIER))
1569 icount->dcd++;
1570 tiocmget->prev_UART_state_bitmap = UART_state_bitmap;
1571 spin_unlock(&serial->serial_lock);
1572 tiocmget->intr_completed = 1;
1573 wake_up_interruptible(&tiocmget->waitq);
1575 memset(serial_state_notification, 0,
1576 sizeof(struct hso_serial_state_notification));
1577 tiocmget_submit_urb(serial,
1578 tiocmget,
1579 serial->parent->usb);
1583 * next few functions largely stolen from drivers/serial/serial_core.c
1585 /* Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1586 * - mask passed in arg for lines of interest
1587 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1588 * Caller should use TIOCGICOUNT to see which one it was
1590 static int
1591 hso_wait_modem_status(struct hso_serial *serial, unsigned long arg)
1593 DECLARE_WAITQUEUE(wait, current);
1594 struct uart_icount cprev, cnow;
1595 struct hso_tiocmget *tiocmget;
1596 int ret;
1598 tiocmget = serial->tiocmget;
1599 if (!tiocmget)
1600 return -ENOENT;
1602 * note the counters on entry
1604 spin_lock_irq(&serial->serial_lock);
1605 memcpy(&cprev, &tiocmget->icount, sizeof(struct uart_icount));
1606 spin_unlock_irq(&serial->serial_lock);
1607 add_wait_queue(&tiocmget->waitq, &wait);
1608 for (;;) {
1609 spin_lock_irq(&serial->serial_lock);
1610 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1611 spin_unlock_irq(&serial->serial_lock);
1612 set_current_state(TASK_INTERRUPTIBLE);
1613 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1614 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1615 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd))) {
1616 ret = 0;
1617 break;
1619 schedule();
1620 /* see if a signal did it */
1621 if (signal_pending(current)) {
1622 ret = -ERESTARTSYS;
1623 break;
1625 cprev = cnow;
1627 current->state = TASK_RUNNING;
1628 remove_wait_queue(&tiocmget->waitq, &wait);
1630 return ret;
1634 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1635 * Return: write counters to the user passed counter struct
1636 * NB: both 1->0 and 0->1 transitions are counted except for
1637 * RI where only 0->1 is counted.
1639 static int hso_get_count(struct hso_serial *serial,
1640 struct serial_icounter_struct __user *icnt)
1642 struct serial_icounter_struct icount;
1643 struct uart_icount cnow;
1644 struct hso_tiocmget *tiocmget = serial->tiocmget;
1646 if (!tiocmget)
1647 return -ENOENT;
1648 spin_lock_irq(&serial->serial_lock);
1649 memcpy(&cnow, &tiocmget->icount, sizeof(struct uart_icount));
1650 spin_unlock_irq(&serial->serial_lock);
1652 icount.cts = cnow.cts;
1653 icount.dsr = cnow.dsr;
1654 icount.rng = cnow.rng;
1655 icount.dcd = cnow.dcd;
1656 icount.rx = cnow.rx;
1657 icount.tx = cnow.tx;
1658 icount.frame = cnow.frame;
1659 icount.overrun = cnow.overrun;
1660 icount.parity = cnow.parity;
1661 icount.brk = cnow.brk;
1662 icount.buf_overrun = cnow.buf_overrun;
1664 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1668 static int hso_serial_tiocmget(struct tty_struct *tty, struct file *file)
1670 int retval;
1671 struct hso_serial *serial = get_serial_by_tty(tty);
1672 struct hso_tiocmget *tiocmget;
1673 u16 UART_state_bitmap;
1675 /* sanity check */
1676 if (!serial) {
1677 D1("no tty structures");
1678 return -EINVAL;
1680 spin_lock_irq(&serial->serial_lock);
1681 retval = ((serial->rts_state) ? TIOCM_RTS : 0) |
1682 ((serial->dtr_state) ? TIOCM_DTR : 0);
1683 tiocmget = serial->tiocmget;
1684 if (tiocmget) {
1686 UART_state_bitmap = le16_to_cpu(
1687 tiocmget->prev_UART_state_bitmap);
1688 if (UART_state_bitmap & B_RING_SIGNAL)
1689 retval |= TIOCM_RNG;
1690 if (UART_state_bitmap & B_RX_CARRIER)
1691 retval |= TIOCM_CD;
1692 if (UART_state_bitmap & B_TX_CARRIER)
1693 retval |= TIOCM_DSR;
1695 spin_unlock_irq(&serial->serial_lock);
1696 return retval;
1699 static int hso_serial_tiocmset(struct tty_struct *tty, struct file *file,
1700 unsigned int set, unsigned int clear)
1702 int val = 0;
1703 unsigned long flags;
1704 int if_num;
1705 struct hso_serial *serial = get_serial_by_tty(tty);
1707 /* sanity check */
1708 if (!serial) {
1709 D1("no tty structures");
1710 return -EINVAL;
1713 if ((serial->parent->port_spec & HSO_PORT_MASK) != HSO_PORT_MODEM)
1714 return -EINVAL;
1716 if_num = serial->parent->interface->altsetting->desc.bInterfaceNumber;
1718 spin_lock_irqsave(&serial->serial_lock, flags);
1719 if (set & TIOCM_RTS)
1720 serial->rts_state = 1;
1721 if (set & TIOCM_DTR)
1722 serial->dtr_state = 1;
1724 if (clear & TIOCM_RTS)
1725 serial->rts_state = 0;
1726 if (clear & TIOCM_DTR)
1727 serial->dtr_state = 0;
1729 if (serial->dtr_state)
1730 val |= 0x01;
1731 if (serial->rts_state)
1732 val |= 0x02;
1734 spin_unlock_irqrestore(&serial->serial_lock, flags);
1736 return usb_control_msg(serial->parent->usb,
1737 usb_rcvctrlpipe(serial->parent->usb, 0), 0x22,
1738 0x21, val, if_num, NULL, 0,
1739 USB_CTRL_SET_TIMEOUT);
1742 static int hso_serial_ioctl(struct tty_struct *tty, struct file *file,
1743 unsigned int cmd, unsigned long arg)
1745 struct hso_serial *serial = get_serial_by_tty(tty);
1746 void __user *uarg = (void __user *)arg;
1747 int ret = 0;
1748 D4("IOCTL cmd: %d, arg: %ld", cmd, arg);
1750 if (!serial)
1751 return -ENODEV;
1752 switch (cmd) {
1753 case TIOCMIWAIT:
1754 ret = hso_wait_modem_status(serial, arg);
1755 break;
1757 case TIOCGICOUNT:
1758 ret = hso_get_count(serial, uarg);
1759 break;
1760 default:
1761 ret = -ENOIOCTLCMD;
1762 break;
1764 return ret;
1768 /* starts a transmit */
1769 static void hso_kick_transmit(struct hso_serial *serial)
1771 u8 *temp;
1772 unsigned long flags;
1773 int res;
1775 spin_lock_irqsave(&serial->serial_lock, flags);
1776 if (!serial->tx_buffer_count)
1777 goto out;
1779 if (serial->tx_urb_used)
1780 goto out;
1782 /* Wakeup USB interface if necessary */
1783 if (hso_get_activity(serial->parent) == -EAGAIN)
1784 goto out;
1786 /* Switch pointers around to avoid memcpy */
1787 temp = serial->tx_buffer;
1788 serial->tx_buffer = serial->tx_data;
1789 serial->tx_data = temp;
1790 serial->tx_data_count = serial->tx_buffer_count;
1791 serial->tx_buffer_count = 0;
1793 /* If temp is set, it means we switched buffers */
1794 if (temp && serial->write_data) {
1795 res = serial->write_data(serial);
1796 if (res >= 0)
1797 serial->tx_urb_used = 1;
1799 out:
1800 spin_unlock_irqrestore(&serial->serial_lock, flags);
1803 /* make a request (for reading and writing data to muxed serial port) */
1804 static int mux_device_request(struct hso_serial *serial, u8 type, u16 port,
1805 struct urb *ctrl_urb,
1806 struct usb_ctrlrequest *ctrl_req,
1807 u8 *ctrl_urb_data, u32 size)
1809 int result;
1810 int pipe;
1812 /* Sanity check */
1813 if (!serial || !ctrl_urb || !ctrl_req) {
1814 printk(KERN_ERR "%s: Wrong arguments\n", __func__);
1815 return -EINVAL;
1818 /* initialize */
1819 ctrl_req->wValue = 0;
1820 ctrl_req->wIndex = cpu_to_le16(hso_port_to_mux(port));
1821 ctrl_req->wLength = cpu_to_le16(size);
1823 if (type == USB_CDC_GET_ENCAPSULATED_RESPONSE) {
1824 /* Reading command */
1825 ctrl_req->bRequestType = USB_DIR_IN |
1826 USB_TYPE_OPTION_VENDOR |
1827 USB_RECIP_INTERFACE;
1828 ctrl_req->bRequest = USB_CDC_GET_ENCAPSULATED_RESPONSE;
1829 pipe = usb_rcvctrlpipe(serial->parent->usb, 0);
1830 } else {
1831 /* Writing command */
1832 ctrl_req->bRequestType = USB_DIR_OUT |
1833 USB_TYPE_OPTION_VENDOR |
1834 USB_RECIP_INTERFACE;
1835 ctrl_req->bRequest = USB_CDC_SEND_ENCAPSULATED_COMMAND;
1836 pipe = usb_sndctrlpipe(serial->parent->usb, 0);
1838 /* syslog */
1839 D2("%s command (%02x) len: %d, port: %d",
1840 type == USB_CDC_GET_ENCAPSULATED_RESPONSE ? "Read" : "Write",
1841 ctrl_req->bRequestType, ctrl_req->wLength, port);
1843 /* Load ctrl urb */
1844 ctrl_urb->transfer_flags = 0;
1845 usb_fill_control_urb(ctrl_urb,
1846 serial->parent->usb,
1847 pipe,
1848 (u8 *) ctrl_req,
1849 ctrl_urb_data, size, ctrl_callback, serial);
1850 /* Send it on merry way */
1851 result = usb_submit_urb(ctrl_urb, GFP_ATOMIC);
1852 if (result) {
1853 dev_err(&ctrl_urb->dev->dev,
1854 "%s failed submit ctrl_urb %d type %d\n", __func__,
1855 result, type);
1856 return result;
1859 /* done */
1860 return size;
1863 /* called by intr_callback when read occurs */
1864 static int hso_mux_serial_read(struct hso_serial *serial)
1866 if (!serial)
1867 return -EINVAL;
1869 /* clean data */
1870 memset(serial->rx_data[0], 0, CTRL_URB_RX_SIZE);
1871 /* make the request */
1873 if (serial->num_rx_urbs != 1) {
1874 dev_err(&serial->parent->interface->dev,
1875 "ERROR: mux'd reads with multiple buffers "
1876 "not possible\n");
1877 return 0;
1879 return mux_device_request(serial,
1880 USB_CDC_GET_ENCAPSULATED_RESPONSE,
1881 serial->parent->port_spec & HSO_PORT_MASK,
1882 serial->rx_urb[0],
1883 &serial->ctrl_req_rx,
1884 serial->rx_data[0], serial->rx_data_length);
1887 /* used for muxed serial port callback (muxed serial read) */
1888 static void intr_callback(struct urb *urb)
1890 struct hso_shared_int *shared_int = urb->context;
1891 struct hso_serial *serial;
1892 unsigned char *port_req;
1893 int status = urb->status;
1894 int i;
1896 usb_mark_last_busy(urb->dev);
1898 /* sanity check */
1899 if (!shared_int)
1900 return;
1902 /* status check */
1903 if (status) {
1904 handle_usb_error(status, __func__, NULL);
1905 return;
1907 D4("\n--- Got intr callback 0x%02X ---", status);
1909 /* what request? */
1910 port_req = urb->transfer_buffer;
1911 D4(" port_req = 0x%.2X\n", *port_req);
1912 /* loop over all muxed ports to find the one sending this */
1913 for (i = 0; i < 8; i++) {
1914 /* max 8 channels on MUX */
1915 if (*port_req & (1 << i)) {
1916 serial = get_serial_by_shared_int_and_type(shared_int,
1917 (1 << i));
1918 if (serial != NULL) {
1919 D1("Pending read interrupt on port %d\n", i);
1920 spin_lock(&serial->serial_lock);
1921 if (serial->rx_state == RX_IDLE &&
1922 serial->open_count > 0) {
1923 /* Setup and send a ctrl req read on
1924 * port i */
1925 if (!serial->rx_urb_filled[0]) {
1926 serial->rx_state = RX_SENT;
1927 hso_mux_serial_read(serial);
1928 } else
1929 serial->rx_state = RX_PENDING;
1930 } else {
1931 D1("Already a read pending on "
1932 "port %d or port not open\n", i);
1934 spin_unlock(&serial->serial_lock);
1938 /* Resubmit interrupt urb */
1939 hso_mux_submit_intr_urb(shared_int, urb->dev, GFP_ATOMIC);
1942 /* called for writing to muxed serial port */
1943 static int hso_mux_serial_write_data(struct hso_serial *serial)
1945 if (NULL == serial)
1946 return -EINVAL;
1948 return mux_device_request(serial,
1949 USB_CDC_SEND_ENCAPSULATED_COMMAND,
1950 serial->parent->port_spec & HSO_PORT_MASK,
1951 serial->tx_urb,
1952 &serial->ctrl_req_tx,
1953 serial->tx_data, serial->tx_data_count);
1956 /* write callback for Diag and CS port */
1957 static void hso_std_serial_write_bulk_callback(struct urb *urb)
1959 struct hso_serial *serial = urb->context;
1960 int status = urb->status;
1961 struct tty_struct *tty;
1963 /* sanity check */
1964 if (!serial) {
1965 D1("serial == NULL");
1966 return;
1969 spin_lock(&serial->serial_lock);
1970 serial->tx_urb_used = 0;
1971 tty = tty_kref_get(serial->tty);
1972 spin_unlock(&serial->serial_lock);
1973 if (status) {
1974 handle_usb_error(status, __func__, serial->parent);
1975 tty_kref_put(tty);
1976 return;
1978 hso_put_activity(serial->parent);
1979 if (tty) {
1980 tty_wakeup(tty);
1981 tty_kref_put(tty);
1983 hso_kick_transmit(serial);
1985 D1(" ");
1988 /* called for writing diag or CS serial port */
1989 static int hso_std_serial_write_data(struct hso_serial *serial)
1991 int count = serial->tx_data_count;
1992 int result;
1994 usb_fill_bulk_urb(serial->tx_urb,
1995 serial->parent->usb,
1996 usb_sndbulkpipe(serial->parent->usb,
1997 serial->out_endp->
1998 bEndpointAddress & 0x7F),
1999 serial->tx_data, serial->tx_data_count,
2000 hso_std_serial_write_bulk_callback, serial);
2002 result = usb_submit_urb(serial->tx_urb, GFP_ATOMIC);
2003 if (result) {
2004 dev_warn(&serial->parent->usb->dev,
2005 "Failed to submit urb - res %d\n", result);
2006 return result;
2009 return count;
2012 /* callback after read or write on muxed serial port */
2013 static void ctrl_callback(struct urb *urb)
2015 struct hso_serial *serial = urb->context;
2016 struct usb_ctrlrequest *req;
2017 int status = urb->status;
2018 struct tty_struct *tty;
2020 /* sanity check */
2021 if (!serial)
2022 return;
2024 spin_lock(&serial->serial_lock);
2025 serial->tx_urb_used = 0;
2026 tty = tty_kref_get(serial->tty);
2027 spin_unlock(&serial->serial_lock);
2028 if (status) {
2029 handle_usb_error(status, __func__, serial->parent);
2030 tty_kref_put(tty);
2031 return;
2034 /* what request? */
2035 req = (struct usb_ctrlrequest *)(urb->setup_packet);
2036 D4("\n--- Got muxed ctrl callback 0x%02X ---", status);
2037 D4("Actual length of urb = %d\n", urb->actual_length);
2038 DUMP1(urb->transfer_buffer, urb->actual_length);
2040 if (req->bRequestType ==
2041 (USB_DIR_IN | USB_TYPE_OPTION_VENDOR | USB_RECIP_INTERFACE)) {
2042 /* response to a read command */
2043 serial->rx_urb_filled[0] = 1;
2044 spin_lock(&serial->serial_lock);
2045 put_rxbuf_data_and_resubmit_ctrl_urb(serial);
2046 spin_unlock(&serial->serial_lock);
2047 } else {
2048 hso_put_activity(serial->parent);
2049 if (tty)
2050 tty_wakeup(tty);
2051 /* response to a write command */
2052 hso_kick_transmit(serial);
2054 tty_kref_put(tty);
2057 /* handle RX data for serial port */
2058 static int put_rxbuf_data(struct urb *urb, struct hso_serial *serial)
2060 struct tty_struct *tty;
2061 int write_length_remaining = 0;
2062 int curr_write_len;
2064 /* Sanity check */
2065 if (urb == NULL || serial == NULL) {
2066 D1("serial = NULL");
2067 return -2;
2070 /* All callers to put_rxbuf_data hold serial_lock */
2071 tty = tty_kref_get(serial->tty);
2073 /* Push data to tty */
2074 if (tty) {
2075 write_length_remaining = urb->actual_length -
2076 serial->curr_rx_urb_offset;
2077 D1("data to push to tty");
2078 while (write_length_remaining) {
2079 if (test_bit(TTY_THROTTLED, &tty->flags)) {
2080 tty_kref_put(tty);
2081 return -1;
2083 curr_write_len = tty_insert_flip_string
2084 (tty, urb->transfer_buffer +
2085 serial->curr_rx_urb_offset,
2086 write_length_remaining);
2087 serial->curr_rx_urb_offset += curr_write_len;
2088 write_length_remaining -= curr_write_len;
2089 tty_flip_buffer_push(tty);
2092 if (write_length_remaining == 0) {
2093 serial->curr_rx_urb_offset = 0;
2094 serial->rx_urb_filled[hso_urb_to_index(serial, urb)] = 0;
2096 tty_kref_put(tty);
2097 return write_length_remaining;
2101 /* Base driver functions */
2103 static void hso_log_port(struct hso_device *hso_dev)
2105 char *port_type;
2106 char port_dev[20];
2108 switch (hso_dev->port_spec & HSO_PORT_MASK) {
2109 case HSO_PORT_CONTROL:
2110 port_type = "Control";
2111 break;
2112 case HSO_PORT_APP:
2113 port_type = "Application";
2114 break;
2115 case HSO_PORT_GPS:
2116 port_type = "GPS";
2117 break;
2118 case HSO_PORT_GPS_CONTROL:
2119 port_type = "GPS control";
2120 break;
2121 case HSO_PORT_APP2:
2122 port_type = "Application2";
2123 break;
2124 case HSO_PORT_PCSC:
2125 port_type = "PCSC";
2126 break;
2127 case HSO_PORT_DIAG:
2128 port_type = "Diagnostic";
2129 break;
2130 case HSO_PORT_DIAG2:
2131 port_type = "Diagnostic2";
2132 break;
2133 case HSO_PORT_MODEM:
2134 port_type = "Modem";
2135 break;
2136 case HSO_PORT_NETWORK:
2137 port_type = "Network";
2138 break;
2139 default:
2140 port_type = "Unknown";
2141 break;
2143 if ((hso_dev->port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2144 sprintf(port_dev, "%s", dev2net(hso_dev)->net->name);
2145 } else
2146 sprintf(port_dev, "/dev/%s%d", tty_filename,
2147 dev2ser(hso_dev)->minor);
2149 dev_dbg(&hso_dev->interface->dev, "HSO: Found %s port %s\n",
2150 port_type, port_dev);
2153 static int hso_start_net_device(struct hso_device *hso_dev)
2155 int i, result = 0;
2156 struct hso_net *hso_net = dev2net(hso_dev);
2158 if (!hso_net)
2159 return -ENODEV;
2161 /* send URBs for all read buffers */
2162 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2164 /* Prep a receive URB */
2165 usb_fill_bulk_urb(hso_net->mux_bulk_rx_urb_pool[i],
2166 hso_dev->usb,
2167 usb_rcvbulkpipe(hso_dev->usb,
2168 hso_net->in_endp->
2169 bEndpointAddress & 0x7F),
2170 hso_net->mux_bulk_rx_buf_pool[i],
2171 MUX_BULK_RX_BUF_SIZE, read_bulk_callback,
2172 hso_net);
2174 /* Put it out there so the device can send us stuff */
2175 result = usb_submit_urb(hso_net->mux_bulk_rx_urb_pool[i],
2176 GFP_NOIO);
2177 if (result)
2178 dev_warn(&hso_dev->usb->dev,
2179 "%s failed mux_bulk_rx_urb[%d] %d\n", __func__,
2180 i, result);
2183 return result;
2186 static int hso_stop_net_device(struct hso_device *hso_dev)
2188 int i;
2189 struct hso_net *hso_net = dev2net(hso_dev);
2191 if (!hso_net)
2192 return -ENODEV;
2194 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2195 if (hso_net->mux_bulk_rx_urb_pool[i])
2196 usb_kill_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2199 if (hso_net->mux_bulk_tx_urb)
2200 usb_kill_urb(hso_net->mux_bulk_tx_urb);
2202 return 0;
2205 static int hso_start_serial_device(struct hso_device *hso_dev, gfp_t flags)
2207 int i, result = 0;
2208 struct hso_serial *serial = dev2ser(hso_dev);
2210 if (!serial)
2211 return -ENODEV;
2213 /* If it is not the MUX port fill in and submit a bulk urb (already
2214 * allocated in hso_serial_start) */
2215 if (!(serial->parent->port_spec & HSO_INTF_MUX)) {
2216 for (i = 0; i < serial->num_rx_urbs; i++) {
2217 usb_fill_bulk_urb(serial->rx_urb[i],
2218 serial->parent->usb,
2219 usb_rcvbulkpipe(serial->parent->usb,
2220 serial->in_endp->
2221 bEndpointAddress &
2222 0x7F),
2223 serial->rx_data[i],
2224 serial->rx_data_length,
2225 hso_std_serial_read_bulk_callback,
2226 serial);
2227 result = usb_submit_urb(serial->rx_urb[i], flags);
2228 if (result) {
2229 dev_warn(&serial->parent->usb->dev,
2230 "Failed to submit urb - res %d\n",
2231 result);
2232 break;
2235 } else {
2236 mutex_lock(&serial->shared_int->shared_int_lock);
2237 if (!serial->shared_int->use_count) {
2238 result =
2239 hso_mux_submit_intr_urb(serial->shared_int,
2240 hso_dev->usb, flags);
2242 serial->shared_int->use_count++;
2243 mutex_unlock(&serial->shared_int->shared_int_lock);
2245 if (serial->tiocmget)
2246 tiocmget_submit_urb(serial,
2247 serial->tiocmget,
2248 serial->parent->usb);
2249 return result;
2252 static int hso_stop_serial_device(struct hso_device *hso_dev)
2254 int i;
2255 struct hso_serial *serial = dev2ser(hso_dev);
2256 struct hso_tiocmget *tiocmget;
2258 if (!serial)
2259 return -ENODEV;
2261 for (i = 0; i < serial->num_rx_urbs; i++) {
2262 if (serial->rx_urb[i]) {
2263 usb_kill_urb(serial->rx_urb[i]);
2264 serial->rx_urb_filled[i] = 0;
2267 serial->curr_rx_urb_idx = 0;
2268 serial->curr_rx_urb_offset = 0;
2270 if (serial->tx_urb)
2271 usb_kill_urb(serial->tx_urb);
2273 if (serial->shared_int) {
2274 mutex_lock(&serial->shared_int->shared_int_lock);
2275 if (serial->shared_int->use_count &&
2276 (--serial->shared_int->use_count == 0)) {
2277 struct urb *urb;
2279 urb = serial->shared_int->shared_intr_urb;
2280 if (urb)
2281 usb_kill_urb(urb);
2283 mutex_unlock(&serial->shared_int->shared_int_lock);
2285 tiocmget = serial->tiocmget;
2286 if (tiocmget) {
2287 wake_up_interruptible(&tiocmget->waitq);
2288 usb_kill_urb(tiocmget->urb);
2291 return 0;
2294 static void hso_serial_common_free(struct hso_serial *serial)
2296 int i;
2298 if (serial->parent->dev)
2299 device_remove_file(serial->parent->dev, &dev_attr_hsotype);
2301 tty_unregister_device(tty_drv, serial->minor);
2303 for (i = 0; i < serial->num_rx_urbs; i++) {
2304 /* unlink and free RX URB */
2305 usb_free_urb(serial->rx_urb[i]);
2306 /* free the RX buffer */
2307 kfree(serial->rx_data[i]);
2310 /* unlink and free TX URB */
2311 usb_free_urb(serial->tx_urb);
2312 kfree(serial->tx_data);
2315 static int hso_serial_common_create(struct hso_serial *serial, int num_urbs,
2316 int rx_size, int tx_size)
2318 struct device *dev;
2319 int minor;
2320 int i;
2322 minor = get_free_serial_index();
2323 if (minor < 0)
2324 goto exit;
2326 /* register our minor number */
2327 serial->parent->dev = tty_register_device(tty_drv, minor,
2328 &serial->parent->interface->dev);
2329 dev = serial->parent->dev;
2330 dev_set_drvdata(dev, serial->parent);
2331 i = device_create_file(dev, &dev_attr_hsotype);
2333 /* fill in specific data for later use */
2334 serial->minor = minor;
2335 serial->magic = HSO_SERIAL_MAGIC;
2336 spin_lock_init(&serial->serial_lock);
2337 serial->num_rx_urbs = num_urbs;
2339 /* RX, allocate urb and initialize */
2341 /* prepare our RX buffer */
2342 serial->rx_data_length = rx_size;
2343 for (i = 0; i < serial->num_rx_urbs; i++) {
2344 serial->rx_urb[i] = usb_alloc_urb(0, GFP_KERNEL);
2345 if (!serial->rx_urb[i]) {
2346 dev_err(dev, "Could not allocate urb?\n");
2347 goto exit;
2349 serial->rx_urb[i]->transfer_buffer = NULL;
2350 serial->rx_urb[i]->transfer_buffer_length = 0;
2351 serial->rx_data[i] = kzalloc(serial->rx_data_length,
2352 GFP_KERNEL);
2353 if (!serial->rx_data[i]) {
2354 dev_err(dev, "%s - Out of memory\n", __func__);
2355 goto exit;
2359 /* TX, allocate urb and initialize */
2360 serial->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2361 if (!serial->tx_urb) {
2362 dev_err(dev, "Could not allocate urb?\n");
2363 goto exit;
2365 serial->tx_urb->transfer_buffer = NULL;
2366 serial->tx_urb->transfer_buffer_length = 0;
2367 /* prepare our TX buffer */
2368 serial->tx_data_count = 0;
2369 serial->tx_buffer_count = 0;
2370 serial->tx_data_length = tx_size;
2371 serial->tx_data = kzalloc(serial->tx_data_length, GFP_KERNEL);
2372 if (!serial->tx_data) {
2373 dev_err(dev, "%s - Out of memory\n", __func__);
2374 goto exit;
2376 serial->tx_buffer = kzalloc(serial->tx_data_length, GFP_KERNEL);
2377 if (!serial->tx_buffer) {
2378 dev_err(dev, "%s - Out of memory\n", __func__);
2379 goto exit;
2382 return 0;
2383 exit:
2384 hso_serial_common_free(serial);
2385 return -1;
2388 /* Creates a general hso device */
2389 static struct hso_device *hso_create_device(struct usb_interface *intf,
2390 int port_spec)
2392 struct hso_device *hso_dev;
2394 hso_dev = kzalloc(sizeof(*hso_dev), GFP_ATOMIC);
2395 if (!hso_dev)
2396 return NULL;
2398 hso_dev->port_spec = port_spec;
2399 hso_dev->usb = interface_to_usbdev(intf);
2400 hso_dev->interface = intf;
2401 kref_init(&hso_dev->ref);
2402 mutex_init(&hso_dev->mutex);
2404 INIT_WORK(&hso_dev->async_get_intf, async_get_intf);
2405 INIT_WORK(&hso_dev->async_put_intf, async_put_intf);
2406 INIT_WORK(&hso_dev->reset_device, reset_device);
2408 return hso_dev;
2411 /* Removes a network device in the network device table */
2412 static int remove_net_device(struct hso_device *hso_dev)
2414 int i;
2416 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2417 if (network_table[i] == hso_dev) {
2418 network_table[i] = NULL;
2419 break;
2422 if (i == HSO_MAX_NET_DEVICES)
2423 return -1;
2424 return 0;
2427 /* Frees our network device */
2428 static void hso_free_net_device(struct hso_device *hso_dev)
2430 int i;
2431 struct hso_net *hso_net = dev2net(hso_dev);
2433 if (!hso_net)
2434 return;
2436 remove_net_device(hso_net->parent);
2438 if (hso_net->net) {
2439 unregister_netdev(hso_net->net);
2440 free_netdev(hso_net->net);
2443 /* start freeing */
2444 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2445 usb_free_urb(hso_net->mux_bulk_rx_urb_pool[i]);
2446 kfree(hso_net->mux_bulk_rx_buf_pool[i]);
2447 hso_net->mux_bulk_rx_buf_pool[i] = NULL;
2449 usb_free_urb(hso_net->mux_bulk_tx_urb);
2450 kfree(hso_net->mux_bulk_tx_buf);
2451 hso_net->mux_bulk_tx_buf = NULL;
2453 kfree(hso_dev);
2456 static const struct net_device_ops hso_netdev_ops = {
2457 .ndo_open = hso_net_open,
2458 .ndo_stop = hso_net_close,
2459 .ndo_start_xmit = hso_net_start_xmit,
2460 .ndo_tx_timeout = hso_net_tx_timeout,
2463 /* initialize the network interface */
2464 static void hso_net_init(struct net_device *net)
2466 struct hso_net *hso_net = netdev_priv(net);
2468 D1("sizeof hso_net is %d", (int)sizeof(*hso_net));
2470 /* fill in the other fields */
2471 net->netdev_ops = &hso_netdev_ops;
2472 net->watchdog_timeo = HSO_NET_TX_TIMEOUT;
2473 net->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
2474 net->type = ARPHRD_NONE;
2475 net->mtu = DEFAULT_MTU - 14;
2476 net->tx_queue_len = 10;
2477 SET_ETHTOOL_OPS(net, &ops);
2479 /* and initialize the semaphore */
2480 spin_lock_init(&hso_net->net_lock);
2483 /* Adds a network device in the network device table */
2484 static int add_net_device(struct hso_device *hso_dev)
2486 int i;
2488 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
2489 if (network_table[i] == NULL) {
2490 network_table[i] = hso_dev;
2491 break;
2494 if (i == HSO_MAX_NET_DEVICES)
2495 return -1;
2496 return 0;
2499 static int hso_rfkill_set_block(void *data, bool blocked)
2501 struct hso_device *hso_dev = data;
2502 int enabled = !blocked;
2503 int rv;
2505 mutex_lock(&hso_dev->mutex);
2506 if (hso_dev->usb_gone)
2507 rv = 0;
2508 else
2509 rv = usb_control_msg(hso_dev->usb, usb_rcvctrlpipe(hso_dev->usb, 0),
2510 enabled ? 0x82 : 0x81, 0x40, 0, 0, NULL, 0,
2511 USB_CTRL_SET_TIMEOUT);
2512 mutex_unlock(&hso_dev->mutex);
2513 return rv;
2516 static const struct rfkill_ops hso_rfkill_ops = {
2517 .set_block = hso_rfkill_set_block,
2520 /* Creates and sets up everything for rfkill */
2521 static void hso_create_rfkill(struct hso_device *hso_dev,
2522 struct usb_interface *interface)
2524 struct hso_net *hso_net = dev2net(hso_dev);
2525 struct device *dev = &hso_net->net->dev;
2526 char *rfkn;
2528 rfkn = kzalloc(20, GFP_KERNEL);
2529 if (!rfkn)
2530 dev_err(dev, "%s - Out of memory\n", __func__);
2532 snprintf(rfkn, 20, "hso-%d",
2533 interface->altsetting->desc.bInterfaceNumber);
2535 hso_net->rfkill = rfkill_alloc(rfkn,
2536 &interface_to_usbdev(interface)->dev,
2537 RFKILL_TYPE_WWAN,
2538 &hso_rfkill_ops, hso_dev);
2539 if (!hso_net->rfkill) {
2540 dev_err(dev, "%s - Out of memory\n", __func__);
2541 kfree(rfkn);
2542 return;
2544 if (rfkill_register(hso_net->rfkill) < 0) {
2545 rfkill_destroy(hso_net->rfkill);
2546 kfree(rfkn);
2547 hso_net->rfkill = NULL;
2548 dev_err(dev, "%s - Failed to register rfkill\n", __func__);
2549 return;
2553 static struct device_type hso_type = {
2554 .name = "wwan",
2557 /* Creates our network device */
2558 static struct hso_device *hso_create_net_device(struct usb_interface *interface,
2559 int port_spec)
2561 int result, i;
2562 struct net_device *net;
2563 struct hso_net *hso_net;
2564 struct hso_device *hso_dev;
2566 hso_dev = hso_create_device(interface, port_spec);
2567 if (!hso_dev)
2568 return NULL;
2570 /* allocate our network device, then we can put in our private data */
2571 /* call hso_net_init to do the basic initialization */
2572 net = alloc_netdev(sizeof(struct hso_net), "hso%d", hso_net_init);
2573 if (!net) {
2574 dev_err(&interface->dev, "Unable to create ethernet device\n");
2575 goto exit;
2578 hso_net = netdev_priv(net);
2580 hso_dev->port_data.dev_net = hso_net;
2581 hso_net->net = net;
2582 hso_net->parent = hso_dev;
2584 hso_net->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2585 USB_DIR_IN);
2586 if (!hso_net->in_endp) {
2587 dev_err(&interface->dev, "Can't find BULK IN endpoint\n");
2588 goto exit;
2590 hso_net->out_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2591 USB_DIR_OUT);
2592 if (!hso_net->out_endp) {
2593 dev_err(&interface->dev, "Can't find BULK OUT endpoint\n");
2594 goto exit;
2596 SET_NETDEV_DEV(net, &interface->dev);
2597 SET_NETDEV_DEVTYPE(net, &hso_type);
2599 /* registering our net device */
2600 result = register_netdev(net);
2601 if (result) {
2602 dev_err(&interface->dev, "Failed to register device\n");
2603 goto exit;
2606 /* start allocating */
2607 for (i = 0; i < MUX_BULK_RX_BUF_COUNT; i++) {
2608 hso_net->mux_bulk_rx_urb_pool[i] = usb_alloc_urb(0, GFP_KERNEL);
2609 if (!hso_net->mux_bulk_rx_urb_pool[i]) {
2610 dev_err(&interface->dev, "Could not allocate rx urb\n");
2611 goto exit;
2613 hso_net->mux_bulk_rx_buf_pool[i] = kzalloc(MUX_BULK_RX_BUF_SIZE,
2614 GFP_KERNEL);
2615 if (!hso_net->mux_bulk_rx_buf_pool[i]) {
2616 dev_err(&interface->dev, "Could not allocate rx buf\n");
2617 goto exit;
2620 hso_net->mux_bulk_tx_urb = usb_alloc_urb(0, GFP_KERNEL);
2621 if (!hso_net->mux_bulk_tx_urb) {
2622 dev_err(&interface->dev, "Could not allocate tx urb\n");
2623 goto exit;
2625 hso_net->mux_bulk_tx_buf = kzalloc(MUX_BULK_TX_BUF_SIZE, GFP_KERNEL);
2626 if (!hso_net->mux_bulk_tx_buf) {
2627 dev_err(&interface->dev, "Could not allocate tx buf\n");
2628 goto exit;
2631 add_net_device(hso_dev);
2633 hso_log_port(hso_dev);
2635 hso_create_rfkill(hso_dev, interface);
2637 return hso_dev;
2638 exit:
2639 hso_free_net_device(hso_dev);
2640 return NULL;
2643 static void hso_free_tiomget(struct hso_serial *serial)
2645 struct hso_tiocmget *tiocmget = serial->tiocmget;
2646 if (tiocmget) {
2647 if (tiocmget->urb) {
2648 usb_free_urb(tiocmget->urb);
2649 tiocmget->urb = NULL;
2651 serial->tiocmget = NULL;
2652 kfree(tiocmget);
2657 /* Frees an AT channel ( goes for both mux and non-mux ) */
2658 static void hso_free_serial_device(struct hso_device *hso_dev)
2660 struct hso_serial *serial = dev2ser(hso_dev);
2662 if (!serial)
2663 return;
2664 set_serial_by_index(serial->minor, NULL);
2666 hso_serial_common_free(serial);
2668 if (serial->shared_int) {
2669 mutex_lock(&serial->shared_int->shared_int_lock);
2670 if (--serial->shared_int->ref_count == 0)
2671 hso_free_shared_int(serial->shared_int);
2672 else
2673 mutex_unlock(&serial->shared_int->shared_int_lock);
2675 hso_free_tiomget(serial);
2676 kfree(serial);
2677 kfree(hso_dev);
2680 /* Creates a bulk AT channel */
2681 static struct hso_device *hso_create_bulk_serial_device(
2682 struct usb_interface *interface, int port)
2684 struct hso_device *hso_dev;
2685 struct hso_serial *serial;
2686 int num_urbs;
2687 struct hso_tiocmget *tiocmget;
2689 hso_dev = hso_create_device(interface, port);
2690 if (!hso_dev)
2691 return NULL;
2693 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2694 if (!serial)
2695 goto exit;
2697 serial->parent = hso_dev;
2698 hso_dev->port_data.dev_serial = serial;
2700 if ((port & HSO_PORT_MASK) == HSO_PORT_MODEM) {
2701 num_urbs = 2;
2702 serial->tiocmget = kzalloc(sizeof(struct hso_tiocmget),
2703 GFP_KERNEL);
2704 /* it isn't going to break our heart if serial->tiocmget
2705 * allocation fails don't bother checking this.
2707 if (serial->tiocmget) {
2708 tiocmget = serial->tiocmget;
2709 tiocmget->urb = usb_alloc_urb(0, GFP_KERNEL);
2710 if (tiocmget->urb) {
2711 mutex_init(&tiocmget->mutex);
2712 init_waitqueue_head(&tiocmget->waitq);
2713 tiocmget->endp = hso_get_ep(
2714 interface,
2715 USB_ENDPOINT_XFER_INT,
2716 USB_DIR_IN);
2717 } else
2718 hso_free_tiomget(serial);
2721 else
2722 num_urbs = 1;
2724 if (hso_serial_common_create(serial, num_urbs, BULK_URB_RX_SIZE,
2725 BULK_URB_TX_SIZE))
2726 goto exit;
2728 serial->in_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_BULK,
2729 USB_DIR_IN);
2730 if (!serial->in_endp) {
2731 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2732 goto exit2;
2735 if (!
2736 (serial->out_endp =
2737 hso_get_ep(interface, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT))) {
2738 dev_err(&interface->dev, "Failed to find BULK IN ep\n");
2739 goto exit2;
2742 serial->write_data = hso_std_serial_write_data;
2744 /* and record this serial */
2745 set_serial_by_index(serial->minor, serial);
2747 /* setup the proc dirs and files if needed */
2748 hso_log_port(hso_dev);
2750 /* done, return it */
2751 return hso_dev;
2753 exit2:
2754 hso_serial_common_free(serial);
2755 exit:
2756 hso_free_tiomget(serial);
2757 kfree(serial);
2758 kfree(hso_dev);
2759 return NULL;
2762 /* Creates a multiplexed AT channel */
2763 static
2764 struct hso_device *hso_create_mux_serial_device(struct usb_interface *interface,
2765 int port,
2766 struct hso_shared_int *mux)
2768 struct hso_device *hso_dev;
2769 struct hso_serial *serial;
2770 int port_spec;
2772 port_spec = HSO_INTF_MUX;
2773 port_spec &= ~HSO_PORT_MASK;
2775 port_spec |= hso_mux_to_port(port);
2776 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NO_PORT)
2777 return NULL;
2779 hso_dev = hso_create_device(interface, port_spec);
2780 if (!hso_dev)
2781 return NULL;
2783 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2784 if (!serial)
2785 goto exit;
2787 hso_dev->port_data.dev_serial = serial;
2788 serial->parent = hso_dev;
2790 if (hso_serial_common_create
2791 (serial, 1, CTRL_URB_RX_SIZE, CTRL_URB_TX_SIZE))
2792 goto exit;
2794 serial->tx_data_length--;
2795 serial->write_data = hso_mux_serial_write_data;
2797 serial->shared_int = mux;
2798 mutex_lock(&serial->shared_int->shared_int_lock);
2799 serial->shared_int->ref_count++;
2800 mutex_unlock(&serial->shared_int->shared_int_lock);
2802 /* and record this serial */
2803 set_serial_by_index(serial->minor, serial);
2805 /* setup the proc dirs and files if needed */
2806 hso_log_port(hso_dev);
2808 /* done, return it */
2809 return hso_dev;
2811 exit:
2812 if (serial) {
2813 tty_unregister_device(tty_drv, serial->minor);
2814 kfree(serial);
2816 if (hso_dev)
2817 kfree(hso_dev);
2818 return NULL;
2822 static void hso_free_shared_int(struct hso_shared_int *mux)
2824 usb_free_urb(mux->shared_intr_urb);
2825 kfree(mux->shared_intr_buf);
2826 mutex_unlock(&mux->shared_int_lock);
2827 kfree(mux);
2830 static
2831 struct hso_shared_int *hso_create_shared_int(struct usb_interface *interface)
2833 struct hso_shared_int *mux = kzalloc(sizeof(*mux), GFP_KERNEL);
2835 if (!mux)
2836 return NULL;
2838 mux->intr_endp = hso_get_ep(interface, USB_ENDPOINT_XFER_INT,
2839 USB_DIR_IN);
2840 if (!mux->intr_endp) {
2841 dev_err(&interface->dev, "Can't find INT IN endpoint\n");
2842 goto exit;
2845 mux->shared_intr_urb = usb_alloc_urb(0, GFP_KERNEL);
2846 if (!mux->shared_intr_urb) {
2847 dev_err(&interface->dev, "Could not allocate intr urb?\n");
2848 goto exit;
2850 mux->shared_intr_buf =
2851 kzalloc(le16_to_cpu(mux->intr_endp->wMaxPacketSize),
2852 GFP_KERNEL);
2853 if (!mux->shared_intr_buf) {
2854 dev_err(&interface->dev, "Could not allocate intr buf?\n");
2855 goto exit;
2858 mutex_init(&mux->shared_int_lock);
2860 return mux;
2862 exit:
2863 kfree(mux->shared_intr_buf);
2864 usb_free_urb(mux->shared_intr_urb);
2865 kfree(mux);
2866 return NULL;
2869 /* Gets the port spec for a certain interface */
2870 static int hso_get_config_data(struct usb_interface *interface)
2872 struct usb_device *usbdev = interface_to_usbdev(interface);
2873 u8 config_data[17];
2874 u32 if_num = interface->altsetting->desc.bInterfaceNumber;
2875 s32 result;
2877 if (usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
2878 0x86, 0xC0, 0, 0, config_data, 17,
2879 USB_CTRL_SET_TIMEOUT) != 0x11) {
2880 return -EIO;
2883 switch (config_data[if_num]) {
2884 case 0x0:
2885 result = 0;
2886 break;
2887 case 0x1:
2888 result = HSO_PORT_DIAG;
2889 break;
2890 case 0x2:
2891 result = HSO_PORT_GPS;
2892 break;
2893 case 0x3:
2894 result = HSO_PORT_GPS_CONTROL;
2895 break;
2896 case 0x4:
2897 result = HSO_PORT_APP;
2898 break;
2899 case 0x5:
2900 result = HSO_PORT_APP2;
2901 break;
2902 case 0x6:
2903 result = HSO_PORT_CONTROL;
2904 break;
2905 case 0x7:
2906 result = HSO_PORT_NETWORK;
2907 break;
2908 case 0x8:
2909 result = HSO_PORT_MODEM;
2910 break;
2911 case 0x9:
2912 result = HSO_PORT_MSD;
2913 break;
2914 case 0xa:
2915 result = HSO_PORT_PCSC;
2916 break;
2917 case 0xb:
2918 result = HSO_PORT_VOICE;
2919 break;
2920 default:
2921 result = 0;
2924 if (result)
2925 result |= HSO_INTF_BULK;
2927 if (config_data[16] & 0x1)
2928 result |= HSO_INFO_CRC_BUG;
2930 return result;
2933 /* called once for each interface upon device insertion */
2934 static int hso_probe(struct usb_interface *interface,
2935 const struct usb_device_id *id)
2937 int mux, i, if_num, port_spec;
2938 unsigned char port_mask;
2939 struct hso_device *hso_dev = NULL;
2940 struct hso_shared_int *shared_int;
2941 struct hso_device *tmp_dev = NULL;
2943 if_num = interface->altsetting->desc.bInterfaceNumber;
2945 /* Get the interface/port specification from either driver_info or from
2946 * the device itself */
2947 if (id->driver_info)
2948 port_spec = ((u32 *)(id->driver_info))[if_num];
2949 else
2950 port_spec = hso_get_config_data(interface);
2952 if (interface->cur_altsetting->desc.bInterfaceClass != 0xFF) {
2953 dev_err(&interface->dev, "Not our interface\n");
2954 return -ENODEV;
2956 /* Check if we need to switch to alt interfaces prior to port
2957 * configuration */
2958 if (interface->num_altsetting > 1)
2959 usb_set_interface(interface_to_usbdev(interface), if_num, 1);
2960 interface->needs_remote_wakeup = 1;
2962 /* Allocate new hso device(s) */
2963 switch (port_spec & HSO_INTF_MASK) {
2964 case HSO_INTF_MUX:
2965 if ((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) {
2966 /* Create the network device */
2967 if (!disable_net) {
2968 hso_dev = hso_create_net_device(interface,
2969 port_spec);
2970 if (!hso_dev)
2971 goto exit;
2972 tmp_dev = hso_dev;
2976 if (hso_get_mux_ports(interface, &port_mask))
2977 /* TODO: de-allocate everything */
2978 goto exit;
2980 shared_int = hso_create_shared_int(interface);
2981 if (!shared_int)
2982 goto exit;
2984 for (i = 1, mux = 0; i < 0x100; i = i << 1, mux++) {
2985 if (port_mask & i) {
2986 hso_dev = hso_create_mux_serial_device(
2987 interface, i, shared_int);
2988 if (!hso_dev)
2989 goto exit;
2993 if (tmp_dev)
2994 hso_dev = tmp_dev;
2995 break;
2997 case HSO_INTF_BULK:
2998 /* It's a regular bulk interface */
2999 if (((port_spec & HSO_PORT_MASK) == HSO_PORT_NETWORK) &&
3000 !disable_net)
3001 hso_dev = hso_create_net_device(interface, port_spec);
3002 else
3003 hso_dev =
3004 hso_create_bulk_serial_device(interface, port_spec);
3005 if (!hso_dev)
3006 goto exit;
3007 break;
3008 default:
3009 goto exit;
3012 /* save our data pointer in this device */
3013 usb_set_intfdata(interface, hso_dev);
3015 /* done */
3016 return 0;
3017 exit:
3018 hso_free_interface(interface);
3019 return -ENODEV;
3022 /* device removed, cleaning up */
3023 static void hso_disconnect(struct usb_interface *interface)
3025 hso_free_interface(interface);
3027 /* remove reference of our private data */
3028 usb_set_intfdata(interface, NULL);
3031 static void async_get_intf(struct work_struct *data)
3033 struct hso_device *hso_dev =
3034 container_of(data, struct hso_device, async_get_intf);
3035 usb_autopm_get_interface(hso_dev->interface);
3038 static void async_put_intf(struct work_struct *data)
3040 struct hso_device *hso_dev =
3041 container_of(data, struct hso_device, async_put_intf);
3042 usb_autopm_put_interface(hso_dev->interface);
3045 static int hso_get_activity(struct hso_device *hso_dev)
3047 if (hso_dev->usb->state == USB_STATE_SUSPENDED) {
3048 if (!hso_dev->is_active) {
3049 hso_dev->is_active = 1;
3050 schedule_work(&hso_dev->async_get_intf);
3054 if (hso_dev->usb->state != USB_STATE_CONFIGURED)
3055 return -EAGAIN;
3057 usb_mark_last_busy(hso_dev->usb);
3059 return 0;
3062 static int hso_put_activity(struct hso_device *hso_dev)
3064 if (hso_dev->usb->state != USB_STATE_SUSPENDED) {
3065 if (hso_dev->is_active) {
3066 hso_dev->is_active = 0;
3067 schedule_work(&hso_dev->async_put_intf);
3068 return -EAGAIN;
3071 hso_dev->is_active = 0;
3072 return 0;
3075 /* called by kernel when we need to suspend device */
3076 static int hso_suspend(struct usb_interface *iface, pm_message_t message)
3078 int i, result;
3080 /* Stop all serial ports */
3081 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3082 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3083 result = hso_stop_serial_device(serial_table[i]);
3084 if (result)
3085 goto out;
3089 /* Stop all network ports */
3090 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3091 if (network_table[i] &&
3092 (network_table[i]->interface == iface)) {
3093 result = hso_stop_net_device(network_table[i]);
3094 if (result)
3095 goto out;
3099 out:
3100 return 0;
3103 /* called by kernel when we need to resume device */
3104 static int hso_resume(struct usb_interface *iface)
3106 int i, result = 0;
3107 struct hso_net *hso_net;
3109 /* Start all serial ports */
3110 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3111 if (serial_table[i] && (serial_table[i]->interface == iface)) {
3112 if (dev2ser(serial_table[i])->open_count) {
3113 result =
3114 hso_start_serial_device(serial_table[i], GFP_NOIO);
3115 hso_kick_transmit(dev2ser(serial_table[i]));
3116 if (result)
3117 goto out;
3122 /* Start all network ports */
3123 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3124 if (network_table[i] &&
3125 (network_table[i]->interface == iface)) {
3126 hso_net = dev2net(network_table[i]);
3127 if (hso_net->flags & IFF_UP) {
3128 /* First transmit any lingering data,
3129 then restart the device. */
3130 if (hso_net->skb_tx_buf) {
3131 dev_dbg(&iface->dev,
3132 "Transmitting"
3133 " lingering data\n");
3134 hso_net_start_xmit(hso_net->skb_tx_buf,
3135 hso_net->net);
3136 hso_net->skb_tx_buf = NULL;
3138 result = hso_start_net_device(network_table[i]);
3139 if (result)
3140 goto out;
3145 out:
3146 return result;
3149 static void reset_device(struct work_struct *data)
3151 struct hso_device *hso_dev =
3152 container_of(data, struct hso_device, reset_device);
3153 struct usb_device *usb = hso_dev->usb;
3154 int result;
3156 if (hso_dev->usb_gone) {
3157 D1("No reset during disconnect\n");
3158 } else {
3159 result = usb_lock_device_for_reset(usb, hso_dev->interface);
3160 if (result < 0)
3161 D1("unable to lock device for reset: %d\n", result);
3162 else {
3163 usb_reset_device(usb);
3164 usb_unlock_device(usb);
3169 static void hso_serial_ref_free(struct kref *ref)
3171 struct hso_device *hso_dev = container_of(ref, struct hso_device, ref);
3173 hso_free_serial_device(hso_dev);
3176 static void hso_free_interface(struct usb_interface *interface)
3178 struct hso_serial *hso_dev;
3179 struct tty_struct *tty;
3180 int i;
3182 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++) {
3183 if (serial_table[i] &&
3184 (serial_table[i]->interface == interface)) {
3185 hso_dev = dev2ser(serial_table[i]);
3186 spin_lock_irq(&hso_dev->serial_lock);
3187 tty = tty_kref_get(hso_dev->tty);
3188 spin_unlock_irq(&hso_dev->serial_lock);
3189 if (tty)
3190 tty_hangup(tty);
3191 mutex_lock(&hso_dev->parent->mutex);
3192 tty_kref_put(tty);
3193 hso_dev->parent->usb_gone = 1;
3194 mutex_unlock(&hso_dev->parent->mutex);
3195 kref_put(&serial_table[i]->ref, hso_serial_ref_free);
3199 for (i = 0; i < HSO_MAX_NET_DEVICES; i++) {
3200 if (network_table[i] &&
3201 (network_table[i]->interface == interface)) {
3202 struct rfkill *rfk = dev2net(network_table[i])->rfkill;
3203 /* hso_stop_net_device doesn't stop the net queue since
3204 * traffic needs to start it again when suspended */
3205 netif_stop_queue(dev2net(network_table[i])->net);
3206 hso_stop_net_device(network_table[i]);
3207 cancel_work_sync(&network_table[i]->async_put_intf);
3208 cancel_work_sync(&network_table[i]->async_get_intf);
3209 if (rfk) {
3210 rfkill_unregister(rfk);
3211 rfkill_destroy(rfk);
3213 hso_free_net_device(network_table[i]);
3218 /* Helper functions */
3220 /* Get the endpoint ! */
3221 static struct usb_endpoint_descriptor *hso_get_ep(struct usb_interface *intf,
3222 int type, int dir)
3224 int i;
3225 struct usb_host_interface *iface = intf->cur_altsetting;
3226 struct usb_endpoint_descriptor *endp;
3228 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3229 endp = &iface->endpoint[i].desc;
3230 if (((endp->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == dir) &&
3231 (usb_endpoint_type(endp) == type))
3232 return endp;
3235 return NULL;
3238 /* Get the byte that describes which ports are enabled */
3239 static int hso_get_mux_ports(struct usb_interface *intf, unsigned char *ports)
3241 int i;
3242 struct usb_host_interface *iface = intf->cur_altsetting;
3244 if (iface->extralen == 3) {
3245 *ports = iface->extra[2];
3246 return 0;
3249 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
3250 if (iface->endpoint[i].extralen == 3) {
3251 *ports = iface->endpoint[i].extra[2];
3252 return 0;
3256 return -1;
3259 /* interrupt urb needs to be submitted, used for serial read of muxed port */
3260 static int hso_mux_submit_intr_urb(struct hso_shared_int *shared_int,
3261 struct usb_device *usb, gfp_t gfp)
3263 int result;
3265 usb_fill_int_urb(shared_int->shared_intr_urb, usb,
3266 usb_rcvintpipe(usb,
3267 shared_int->intr_endp->bEndpointAddress & 0x7F),
3268 shared_int->shared_intr_buf,
3270 intr_callback, shared_int,
3271 shared_int->intr_endp->bInterval);
3273 result = usb_submit_urb(shared_int->shared_intr_urb, gfp);
3274 if (result)
3275 dev_warn(&usb->dev, "%s failed mux_intr_urb %d\n", __func__,
3276 result);
3278 return result;
3281 /* operations setup of the serial interface */
3282 static const struct tty_operations hso_serial_ops = {
3283 .open = hso_serial_open,
3284 .close = hso_serial_close,
3285 .write = hso_serial_write,
3286 .write_room = hso_serial_write_room,
3287 .ioctl = hso_serial_ioctl,
3288 .set_termios = hso_serial_set_termios,
3289 .chars_in_buffer = hso_serial_chars_in_buffer,
3290 .tiocmget = hso_serial_tiocmget,
3291 .tiocmset = hso_serial_tiocmset,
3292 .unthrottle = hso_unthrottle
3295 static struct usb_driver hso_driver = {
3296 .name = driver_name,
3297 .probe = hso_probe,
3298 .disconnect = hso_disconnect,
3299 .id_table = hso_ids,
3300 .suspend = hso_suspend,
3301 .resume = hso_resume,
3302 .reset_resume = hso_resume,
3303 .supports_autosuspend = 1,
3306 static int __init hso_init(void)
3308 int i;
3309 int result;
3311 /* put it in the log */
3312 printk(KERN_INFO "hso: %s\n", version);
3314 /* Initialise the serial table semaphore and table */
3315 spin_lock_init(&serial_table_lock);
3316 for (i = 0; i < HSO_SERIAL_TTY_MINORS; i++)
3317 serial_table[i] = NULL;
3319 /* allocate our driver using the proper amount of supported minors */
3320 tty_drv = alloc_tty_driver(HSO_SERIAL_TTY_MINORS);
3321 if (!tty_drv)
3322 return -ENOMEM;
3324 /* fill in all needed values */
3325 tty_drv->magic = TTY_DRIVER_MAGIC;
3326 tty_drv->owner = THIS_MODULE;
3327 tty_drv->driver_name = driver_name;
3328 tty_drv->name = tty_filename;
3330 /* if major number is provided as parameter, use that one */
3331 if (tty_major)
3332 tty_drv->major = tty_major;
3334 tty_drv->minor_start = 0;
3335 tty_drv->num = HSO_SERIAL_TTY_MINORS;
3336 tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
3337 tty_drv->subtype = SERIAL_TYPE_NORMAL;
3338 tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
3339 tty_drv->init_termios = tty_std_termios;
3340 hso_init_termios(&tty_drv->init_termios);
3341 tty_set_operations(tty_drv, &hso_serial_ops);
3343 /* register the tty driver */
3344 result = tty_register_driver(tty_drv);
3345 if (result) {
3346 printk(KERN_ERR "%s - tty_register_driver failed(%d)\n",
3347 __func__, result);
3348 return result;
3351 /* register this module as an usb driver */
3352 result = usb_register(&hso_driver);
3353 if (result) {
3354 printk(KERN_ERR "Could not register hso driver? error: %d\n",
3355 result);
3356 /* cleanup serial interface */
3357 tty_unregister_driver(tty_drv);
3358 return result;
3361 /* done */
3362 return 0;
3365 static void __exit hso_exit(void)
3367 printk(KERN_INFO "hso: unloaded\n");
3369 tty_unregister_driver(tty_drv);
3370 /* deregister the usb driver */
3371 usb_deregister(&hso_driver);
3374 /* Module definitions */
3375 module_init(hso_init);
3376 module_exit(hso_exit);
3378 MODULE_AUTHOR(MOD_AUTHOR);
3379 MODULE_DESCRIPTION(MOD_DESCRIPTION);
3380 MODULE_LICENSE(MOD_LICENSE);
3382 /* change the debug level (eg: insmod hso.ko debug=0x04) */
3383 MODULE_PARM_DESC(debug, "Level of debug [0x01 | 0x02 | 0x04 | 0x08 | 0x10]");
3384 module_param(debug, int, S_IRUGO | S_IWUSR);
3386 /* set the major tty number (eg: insmod hso.ko tty_major=245) */
3387 MODULE_PARM_DESC(tty_major, "Set the major tty number");
3388 module_param(tty_major, int, S_IRUGO | S_IWUSR);
3390 /* disable network interface (eg: insmod hso.ko disable_net=1) */
3391 MODULE_PARM_DESC(disable_net, "Disable the network interface");
3392 module_param(disable_net, int, S_IRUGO | S_IWUSR);