2 * USB Empeg empeg-car player driver
4 * Copyright (C) 2000, 2001
5 * Gary Brubaker (xavyer@ix.netcom.com)
7 * Copyright (C) 1999 - 2001
8 * Greg Kroah-Hartman (greg@kroah.com)
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License, as published by
12 * the Free Software Foundation, version 2.
14 * See Documentation/usb/usb-serial.txt for more information on using this driver
17 * remove unused code in empeg_close() (thanks to Oliver Neukum for pointing this
18 * out) and rewrote empeg_set_termios().
21 * switched from using spinlock to a semaphore, which fixes lots of problems.
24 * Identify version on module load.
27 * Added write_room() and chars_in_buffer() support.
30 * Moved termio stuff inside the port->active check.
31 * Moved MOD_DEC_USE_COUNT to end of empeg_close().
34 * Added port->tty->ldisc.set_termios(port->tty, NULL) to empeg_open()
35 * This notifies the tty driver that the termios have changed.
38 * Moved tty->low_latency = 1 from empeg_read_bulk_callback() to empeg_open()
39 * (It only needs to be set once - Doh!)
42 * Updated to work with id_table structure.
45 * Forked this from visor.c, and hacked it up to work with an
46 * Empeg ltd. empeg-car player. Constructive criticism welcomed.
47 * I would like to say, 'Thank You' to Greg Kroah-Hartman for the
48 * use of his code, and for his guidance, advice and patience. :)
49 * A 'Thank You' is in order for John Ripley of Empeg ltd for his
50 * advice, and patience too.
54 #include <linux/config.h>
55 #include <linux/kernel.h>
56 #include <linux/errno.h>
57 #include <linux/init.h>
58 #include <linux/slab.h>
59 #include <linux/tty.h>
60 #include <linux/tty_driver.h>
61 #include <linux/tty_flip.h>
62 #include <linux/module.h>
63 #include <linux/spinlock.h>
64 #include <asm/uaccess.h>
65 #include <linux/usb.h>
66 #include "usb-serial.h"
73 #define DRIVER_VERSION "v1.2"
74 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Gary Brubaker <xavyer@ix.netcom.com>"
75 #define DRIVER_DESC "USB Empeg Mark I/II Driver"
77 #define EMPEG_VENDOR_ID 0x084f
78 #define EMPEG_PRODUCT_ID 0x0001
80 /* function prototypes for an empeg-car player */
81 static int empeg_open (struct usb_serial_port
*port
, struct file
*filp
);
82 static void empeg_close (struct usb_serial_port
*port
, struct file
*filp
);
83 static int empeg_write (struct usb_serial_port
*port
,
84 const unsigned char *buf
,
86 static int empeg_write_room (struct usb_serial_port
*port
);
87 static int empeg_chars_in_buffer (struct usb_serial_port
*port
);
88 static void empeg_throttle (struct usb_serial_port
*port
);
89 static void empeg_unthrottle (struct usb_serial_port
*port
);
90 static int empeg_startup (struct usb_serial
*serial
);
91 static void empeg_shutdown (struct usb_serial
*serial
);
92 static int empeg_ioctl (struct usb_serial_port
*port
,
96 static void empeg_set_termios (struct usb_serial_port
*port
, struct termios
*old_termios
);
97 static void empeg_write_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
);
98 static void empeg_read_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
);
100 static struct usb_device_id id_table
[] = {
101 { USB_DEVICE(EMPEG_VENDOR_ID
, EMPEG_PRODUCT_ID
) },
102 { } /* Terminating entry */
105 MODULE_DEVICE_TABLE (usb
, id_table
);
107 static struct usb_driver empeg_driver
= {
109 .probe
= usb_serial_probe
,
110 .disconnect
= usb_serial_disconnect
,
111 .id_table
= id_table
,
115 static struct usb_serial_driver empeg_device
= {
117 .owner
= THIS_MODULE
,
120 .id_table
= id_table
,
121 .num_interrupt_in
= 0,
126 .close
= empeg_close
,
127 .throttle
= empeg_throttle
,
128 .unthrottle
= empeg_unthrottle
,
129 .attach
= empeg_startup
,
130 .shutdown
= empeg_shutdown
,
131 .ioctl
= empeg_ioctl
,
132 .set_termios
= empeg_set_termios
,
133 .write
= empeg_write
,
134 .write_room
= empeg_write_room
,
135 .chars_in_buffer
= empeg_chars_in_buffer
,
136 .write_bulk_callback
= empeg_write_bulk_callback
,
137 .read_bulk_callback
= empeg_read_bulk_callback
,
141 #define URB_TRANSFER_BUFFER_SIZE 4096
143 static struct urb
*write_urb_pool
[NUM_URBS
];
144 static spinlock_t write_urb_pool_lock
;
146 static int bytes_out
;
148 /******************************************************************************
149 * Empeg specific driver functions
150 ******************************************************************************/
151 static int empeg_open (struct usb_serial_port
*port
, struct file
*filp
)
153 struct usb_serial
*serial
= port
->serial
;
156 dbg("%s - port %d", __FUNCTION__
, port
->number
);
158 /* Force default termio settings */
159 empeg_set_termios (port
, NULL
) ;
164 /* Start reading from the device */
168 usb_rcvbulkpipe(serial
->dev
,
169 port
->bulk_in_endpointAddress
),
170 port
->read_urb
->transfer_buffer
,
171 port
->read_urb
->transfer_buffer_length
,
172 empeg_read_bulk_callback
,
175 result
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
178 dev_err(&port
->dev
, "%s - failed submitting read urb, error %d\n", __FUNCTION__
, result
);
184 static void empeg_close (struct usb_serial_port
*port
, struct file
* filp
)
186 dbg("%s - port %d", __FUNCTION__
, port
->number
);
188 /* shutdown our bulk read */
189 usb_kill_urb(port
->read_urb
);
190 /* Uncomment the following line if you want to see some statistics in your syslog */
191 /* dev_info (&port->dev, "Bytes In = %d Bytes Out = %d\n", bytes_in, bytes_out); */
195 static int empeg_write (struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
197 struct usb_serial
*serial
= port
->serial
;
199 const unsigned char *current_position
= buf
;
206 dbg("%s - port %d", __FUNCTION__
, port
->number
);
210 /* try to find a free urb in our list of them */
213 spin_lock_irqsave (&write_urb_pool_lock
, flags
);
215 for (i
= 0; i
< NUM_URBS
; ++i
) {
216 if (write_urb_pool
[i
]->status
!= -EINPROGRESS
) {
217 urb
= write_urb_pool
[i
];
222 spin_unlock_irqrestore (&write_urb_pool_lock
, flags
);
225 dbg("%s - no more free urbs", __FUNCTION__
);
229 if (urb
->transfer_buffer
== NULL
) {
230 urb
->transfer_buffer
= kmalloc (URB_TRANSFER_BUFFER_SIZE
, GFP_ATOMIC
);
231 if (urb
->transfer_buffer
== NULL
) {
232 dev_err(&port
->dev
, "%s no more kernel memory...\n", __FUNCTION__
);
237 transfer_size
= min (count
, URB_TRANSFER_BUFFER_SIZE
);
239 memcpy (urb
->transfer_buffer
, current_position
, transfer_size
);
241 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, transfer_size
, urb
->transfer_buffer
);
243 /* build up our urb */
247 usb_sndbulkpipe(serial
->dev
,
248 port
->bulk_out_endpointAddress
),
249 urb
->transfer_buffer
,
251 empeg_write_bulk_callback
,
254 /* send it down the pipe */
255 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
257 dev_err(&port
->dev
, "%s - usb_submit_urb(write bulk) failed with status = %d\n", __FUNCTION__
, status
);
262 current_position
+= transfer_size
;
263 bytes_sent
+= transfer_size
;
264 count
-= transfer_size
;
265 bytes_out
+= transfer_size
;
275 static int empeg_write_room (struct usb_serial_port
*port
)
281 dbg("%s - port %d", __FUNCTION__
, port
->number
);
283 spin_lock_irqsave (&write_urb_pool_lock
, flags
);
285 /* tally up the number of bytes available */
286 for (i
= 0; i
< NUM_URBS
; ++i
) {
287 if (write_urb_pool
[i
]->status
!= -EINPROGRESS
) {
288 room
+= URB_TRANSFER_BUFFER_SIZE
;
292 spin_unlock_irqrestore (&write_urb_pool_lock
, flags
);
294 dbg("%s - returns %d", __FUNCTION__
, room
);
301 static int empeg_chars_in_buffer (struct usb_serial_port
*port
)
307 dbg("%s - port %d", __FUNCTION__
, port
->number
);
309 spin_lock_irqsave (&write_urb_pool_lock
, flags
);
311 /* tally up the number of bytes waiting */
312 for (i
= 0; i
< NUM_URBS
; ++i
) {
313 if (write_urb_pool
[i
]->status
== -EINPROGRESS
) {
314 chars
+= URB_TRANSFER_BUFFER_SIZE
;
318 spin_unlock_irqrestore (&write_urb_pool_lock
, flags
);
320 dbg("%s - returns %d", __FUNCTION__
, chars
);
327 static void empeg_write_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
)
329 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
331 dbg("%s - port %d", __FUNCTION__
, port
->number
);
334 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__
, urb
->status
);
338 schedule_work(&port
->work
);
342 static void empeg_read_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
)
344 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
345 struct tty_struct
*tty
;
346 unsigned char *data
= urb
->transfer_buffer
;
350 dbg("%s - port %d", __FUNCTION__
, port
->number
);
353 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__
, urb
->status
);
357 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, urb
->actual_length
, data
);
361 if (urb
->actual_length
) {
362 for (i
= 0; i
< urb
->actual_length
; ++i
) {
364 * If we insert too many characters we'll overflow the buffer.
365 * This means we'll lose bytes - Decidedly bad.
367 if(tty
->flip
.count
>= TTY_FLIPBUF_SIZE
) {
368 tty_flip_buffer_push(tty
);
370 tty_insert_flip_char(tty
, data
[i
], 0);
373 * Goes straight through instead of scheduling - if tty->low_latency is set.
375 tty_flip_buffer_push(tty
);
376 bytes_in
+= urb
->actual_length
;
379 /* Continue trying to always read */
383 usb_rcvbulkpipe(port
->serial
->dev
,
384 port
->bulk_in_endpointAddress
),
385 port
->read_urb
->transfer_buffer
,
386 port
->read_urb
->transfer_buffer_length
,
387 empeg_read_bulk_callback
,
390 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
393 dev_err(&urb
->dev
->dev
, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__
, result
);
400 static void empeg_throttle (struct usb_serial_port
*port
)
402 dbg("%s - port %d", __FUNCTION__
, port
->number
);
403 usb_kill_urb(port
->read_urb
);
407 static void empeg_unthrottle (struct usb_serial_port
*port
)
411 dbg("%s - port %d", __FUNCTION__
, port
->number
);
413 port
->read_urb
->dev
= port
->serial
->dev
;
415 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
418 dev_err(&port
->dev
, "%s - failed submitting read urb, error %d\n", __FUNCTION__
, result
);
424 static int empeg_startup (struct usb_serial
*serial
)
428 dbg("%s", __FUNCTION__
);
430 if (serial
->dev
->actconfig
->desc
.bConfigurationValue
!= 1) {
431 err("active config #%d != 1 ??",
432 serial
->dev
->actconfig
->desc
.bConfigurationValue
);
435 dbg("%s - reset config", __FUNCTION__
);
436 r
= usb_reset_configuration (serial
->dev
);
438 /* continue on with initialization */
444 static void empeg_shutdown (struct usb_serial
*serial
)
446 dbg ("%s", __FUNCTION__
);
450 static int empeg_ioctl (struct usb_serial_port
*port
, struct file
* file
, unsigned int cmd
, unsigned long arg
)
452 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__
, port
->number
, cmd
);
458 static void empeg_set_termios (struct usb_serial_port
*port
, struct termios
*old_termios
)
461 dbg("%s - port %d", __FUNCTION__
, port
->number
);
463 if ((!port
->tty
) || (!port
->tty
->termios
)) {
464 dbg("%s - no tty structures", __FUNCTION__
);
469 * The empeg-car player wants these particular tty settings.
470 * You could, for example, change the baud rate, however the
471 * player only supports 115200 (currently), so there is really
472 * no point in support for changes to the tty settings.
475 * The default requirements for this device are:
477 port
->tty
->termios
->c_iflag
478 &= ~(IGNBRK
/* disable ignore break */
479 | BRKINT
/* disable break causes interrupt */
480 | PARMRK
/* disable mark parity errors */
481 | ISTRIP
/* disable clear high bit of input characters */
482 | INLCR
/* disable translate NL to CR */
483 | IGNCR
/* disable ignore CR */
484 | ICRNL
/* disable translate CR to NL */
485 | IXON
); /* disable enable XON/XOFF flow control */
487 port
->tty
->termios
->c_oflag
488 &= ~OPOST
; /* disable postprocess output characters */
490 port
->tty
->termios
->c_lflag
491 &= ~(ECHO
/* disable echo input characters */
492 | ECHONL
/* disable echo new line */
493 | ICANON
/* disable erase, kill, werase, and rprnt special characters */
494 | ISIG
/* disable interrupt, quit, and suspend special characters */
495 | IEXTEN
); /* disable non-POSIX special characters */
497 port
->tty
->termios
->c_cflag
498 &= ~(CSIZE
/* no size */
499 | PARENB
/* disable parity bit */
500 | CBAUD
); /* clear current baud rate */
502 port
->tty
->termios
->c_cflag
503 |= (CS8
/* character size 8 bits */
504 | B115200
); /* baud rate 115200 */
507 * Force low_latency on; otherwise the pushes are scheduled;
508 * this is bad as it opens up the possibility of dropping bytes
509 * on the floor. We don't want to drop bytes on the floor. :)
511 port
->tty
->low_latency
= 1;
517 static int __init
empeg_init (void)
522 /* create our write urb pool and transfer buffers */
523 spin_lock_init (&write_urb_pool_lock
);
524 for (i
= 0; i
< NUM_URBS
; ++i
) {
525 urb
= usb_alloc_urb(0, GFP_KERNEL
);
526 write_urb_pool
[i
] = urb
;
528 err("No more urbs???");
532 urb
->transfer_buffer
= kmalloc (URB_TRANSFER_BUFFER_SIZE
, GFP_KERNEL
);
533 if (!urb
->transfer_buffer
) {
534 err("%s - out of memory for urb buffers.",
540 retval
= usb_serial_register(&empeg_device
);
542 goto failed_usb_serial_register
;
543 retval
= usb_register(&empeg_driver
);
545 goto failed_usb_register
;
547 info(DRIVER_VERSION
":" DRIVER_DESC
);
551 usb_serial_deregister(&empeg_device
);
552 failed_usb_serial_register
:
553 for (i
= 0; i
< NUM_URBS
; ++i
) {
554 if (write_urb_pool
[i
]) {
555 kfree(write_urb_pool
[i
]->transfer_buffer
);
556 usb_free_urb(write_urb_pool
[i
]);
563 static void __exit
empeg_exit (void)
568 usb_deregister(&empeg_driver
);
569 usb_serial_deregister (&empeg_device
);
571 spin_lock_irqsave (&write_urb_pool_lock
, flags
);
573 for (i
= 0; i
< NUM_URBS
; ++i
) {
574 if (write_urb_pool
[i
]) {
575 /* FIXME - uncomment the following usb_kill_urb call when
576 * the host controllers get fixed to set urb->dev = NULL after
577 * the urb is finished. Otherwise this call oopses. */
578 /* usb_kill_urb(write_urb_pool[i]); */
579 kfree(write_urb_pool
[i
]->transfer_buffer
);
580 usb_free_urb (write_urb_pool
[i
]);
584 spin_unlock_irqrestore (&write_urb_pool_lock
, flags
);
588 module_init(empeg_init
);
589 module_exit(empeg_exit
);
591 MODULE_AUTHOR( DRIVER_AUTHOR
);
592 MODULE_DESCRIPTION( DRIVER_DESC
);
593 MODULE_LICENSE("GPL");
595 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
596 MODULE_PARM_DESC(debug
, "Debug enabled or not");