2 * copyright (C) 1999/2000 by Henning Zabel <henning@uni-paderborn.de>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation; either version 2 of the License, or (at your
7 * option) any later version.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * USB-Kernel Driver for the Mustek MDC800 Digital Camera
22 * (c) 1999/2000 Henning Zabel <henning@uni-paderborn.de>
25 * The driver brings the USB functions of the MDC800 to Linux.
26 * To use the Camera you must support the USB Protocoll of the camera
28 * The Driver uses a misc device Node. Create it with :
29 * mknod /dev/mustek c 180 32
31 * The driver supports only one camera.
33 * Fix: mdc800 used sleep_on and slept with io_lock held.
34 * Converted sleep_on to waitqueues with schedule_timeout and made io_lock
35 * a semaphore from a spinlock.
36 * by Oliver Neukum <oliver@neukum.name>
39 * Identify version on module load.
43 * Fixed potential SMP races with Spinlocks.
44 * Thanks to Oliver Neukum <oliver@neukum.name> who
45 * noticed the race conditions.
48 * Fixed: Setting urb->dev before submitting urb.
49 * by Greg KH <greg@kroah.com>
53 * bugfix : The mdc800->state field gets set to READY after the
54 * the diconnect function sets it to NOT_CONNECTED. This makes the
55 * driver running like the camera is connected and causes some
59 * MOD_INC and MOD_DEC are changed in usb_probe to prevent load/unload
60 * problems when compiled as Module.
63 * The mdc800 driver gets assigned the USB Minor 32-47. The Registration
64 * was updated to use these values.
67 * The Init und Exit Module Function are updated.
71 * Rewrite of the driver : The driver now uses URB's. The old stuff
75 * Rewrite of this driver: The Emulation of the rs232 protocoll
76 * has been removed from the driver. A special executeCommand function
77 * for this driver is included to gphoto.
78 * The driver supports two kind of communication to bulk endpoints.
79 * Either with the dev->bus->ops->bulk... or with callback function.
83 * first Version that gets a version number. Most of the needed
88 #include <linux/sched.h>
89 #include <linux/signal.h>
90 #include <linux/spinlock.h>
91 #include <linux/errno.h>
92 #include <linux/random.h>
93 #include <linux/poll.h>
94 #include <linux/init.h>
95 #include <linux/slab.h>
96 #include <linux/module.h>
97 #include <linux/smp_lock.h>
99 #include <linux/usb.h>
100 #include <linux/fs.h>
103 * Version Information
105 #define DRIVER_VERSION "v0.7.5 (30/10/2000)"
106 #define DRIVER_AUTHOR "Henning Zabel <henning@uni-paderborn.de>"
107 #define DRIVER_DESC "USB Driver for Mustek MDC800 Digital Camera"
109 /* Vendor and Product Information */
110 #define MDC800_VENDOR_ID 0x055f
111 #define MDC800_PRODUCT_ID 0xa800
113 /* Timeouts (msec) */
114 #define TO_DOWNLOAD_GET_READY 1500
115 #define TO_DOWNLOAD_GET_BUSY 1500
116 #define TO_WRITE_GET_READY 1000
117 #define TO_DEFAULT_COMMAND 5000
118 #define TO_READ_FROM_IRQ TO_DEFAULT_COMMAND
119 #define TO_GET_READY TO_DEFAULT_COMMAND
121 /* Minor Number of the device (create with mknod /dev/mustek c 180 32) */
122 #define MDC800_DEVICE_MINOR_BASE 32
125 /**************************************************************************
127 ***************************************************************************/
131 NOT_CONNECTED, READY, WORKING, DOWNLOAD
135 /* Data for the driver */
138 struct usb_device * dev; // Device Data
141 unsigned int endpoint [4];
143 struct urb * irq_urb;
144 wait_queue_head_t irq_wait;
146 char* irq_urb_buffer;
148 int camera_busy; // is camera busy ?
149 int camera_request_ready; // Status to synchronize with irq
150 char camera_response [8]; // last Bytes send after busy
152 struct urb * write_urb;
153 char* write_urb_buffer;
154 wait_queue_head_t write_wait;
158 struct urb * download_urb;
159 char* download_urb_buffer;
160 wait_queue_head_t download_wait;
162 int download_left; // Bytes left to download ?
166 char out [64]; // Answer Buffer
167 int out_ptr; // Index to the first not readen byte
168 int out_count; // Bytes in the buffer
170 int open; // Camera device open ?
171 struct semaphore io_lock; // IO -lock
173 char in [8]; // Command Input Buffer
176 int pic_index; // Cache for the Imagesize (-1 for nothing cached )
182 /* Specification of the Endpoints */
183 static struct usb_endpoint_descriptor mdc800_ed [4] =
185 { 0,0, 0x01, 0x02, 8, 0,0,0 },
186 { 0,0, 0x82, 0x03, 8, 0,0,0 },
187 { 0,0, 0x03, 0x02, 64, 0,0,0 },
188 { 0,0, 0x84, 0x02, 64, 0,0,0 }
192 /* The Variable used by the driver */
193 static struct mdc800_data* mdc800;
196 /***************************************************************************
197 The USB Part of the driver
198 ****************************************************************************/
200 static int mdc800_endpoint_equals (struct usb_endpoint_descriptor *a,struct usb_endpoint_descriptor *b)
203 ( a->bEndpointAddress == b->bEndpointAddress )
204 && ( a->bmAttributes == b->bmAttributes )
205 && ( a->wMaxPacketSize == b->wMaxPacketSize )
211 * Checks whether the camera responds busy
213 static int mdc800_isBusy (char* ch)
218 if (ch [i] != (char)0x99)
227 * Checks whether the Camera is ready
229 static int mdc800_isReady (char *ch)
234 if (ch [i] != (char)0xbb)
244 * USB IRQ Handler for InputLine
246 static void mdc800_usb_irq (struct urb *urb, struct pt_regs *res)
248 int data_received=0, wake_up;
249 unsigned char* b=urb->transfer_buffer;
250 struct mdc800_data* mdc800=urb->context;
252 if (urb->status >= 0)
255 //dbg ("%i %i %i %i %i %i %i %i \n",b[0],b[1],b[2],b[3],b[4],b[5],b[6],b[7]);
257 if (mdc800_isBusy (b))
259 if (!mdc800->camera_busy)
261 mdc800->camera_busy=1;
267 if (mdc800->camera_busy && mdc800_isReady (b))
269 mdc800->camera_busy=0;
273 if (!(mdc800_isBusy (b) || mdc800_isReady (b)))
275 /* Store Data in camera_answer field */
276 dbg ("%i %i %i %i %i %i %i %i ",b[0],b[1],b[2],b[3],b[4],b[5],b[6],b[7]);
278 memcpy (mdc800->camera_response,b,8);
282 wake_up= ( mdc800->camera_request_ready > 0 )
285 ((mdc800->camera_request_ready == 1) && (!mdc800->camera_busy))
287 ((mdc800->camera_request_ready == 2) && data_received)
289 ((mdc800->camera_request_ready == 3) && (mdc800->camera_busy))
296 mdc800->camera_request_ready=0;
298 wake_up_interruptible (&mdc800->irq_wait);
304 * Waits a while until the irq responds that camera is ready
306 * mode : 0: Wait for camera gets ready
307 * 1: Wait for receiving data
308 * 2: Wait for camera gets busy
312 static int mdc800_usb_waitForIRQ (int mode, int msec)
314 DECLARE_WAITQUEUE(wait, current);
317 mdc800->camera_request_ready=1+mode;
319 add_wait_queue(&mdc800->irq_wait, &wait);
320 set_current_state(TASK_INTERRUPTIBLE);
321 timeout = msec*HZ/1000;
322 while (!mdc800->irq_woken && timeout)
324 set_current_state(TASK_UNINTERRUPTIBLE);
325 timeout = schedule_timeout (timeout);
327 remove_wait_queue(&mdc800->irq_wait, &wait);
328 set_current_state(TASK_RUNNING);
329 mdc800->irq_woken = 0;
331 if (mdc800->camera_request_ready>0)
333 mdc800->camera_request_ready=0;
334 err ("timeout waiting for camera.");
338 if (mdc800->state == NOT_CONNECTED)
340 warn ("Camera gets disconnected during waiting for irq.");
341 mdc800->camera_request_ready=0;
350 * The write_urb callback function
352 static void mdc800_usb_write_notify (struct urb *urb, struct pt_regs *res)
354 struct mdc800_data* mdc800=urb->context;
356 if (urb->status != 0)
358 err ("writing command fails (status=%i)", urb->status);
365 wake_up_interruptible (&mdc800->write_wait);
370 * The download_urb callback function
372 static void mdc800_usb_download_notify (struct urb *urb, struct pt_regs *res)
374 struct mdc800_data* mdc800=urb->context;
376 if (urb->status == 0)
378 /* Fill output buffer with these data */
379 memcpy (mdc800->out, urb->transfer_buffer, 64);
380 mdc800->out_count=64;
382 mdc800->download_left-=64;
383 if (mdc800->download_left == 0)
390 err ("request bytes fails (status:%i)", urb->status);
392 mdc800->downloaded = 1;
393 wake_up_interruptible (&mdc800->download_wait);
397 /***************************************************************************
398 Probing for the Camera
399 ***************************************************************************/
401 static struct usb_driver mdc800_usb_driver;
402 static struct file_operations mdc800_device_ops;
403 static struct usb_class_driver mdc800_class = {
404 .name = "usb/mdc800%d",
405 .fops = &mdc800_device_ops,
406 .mode = S_IFCHR | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP,
407 .minor_base = MDC800_DEVICE_MINOR_BASE,
412 * Callback to search the Mustek MDC800 on the USB Bus
414 static int mdc800_usb_probe (struct usb_interface *intf,
415 const struct usb_device_id *id)
418 struct usb_host_interface *intf_desc;
419 struct usb_device *dev = interface_to_usbdev (intf);
423 dbg ("(mdc800_usb_probe) called.");
426 if (mdc800->dev != 0)
428 warn ("only one Mustek MDC800 is supported.");
432 if (dev->descriptor.bNumConfigurations != 1)
434 err ("probe fails -> wrong Number of Configuration");
437 intf_desc = intf->cur_altsetting;
440 ( intf_desc->desc.bInterfaceClass != 0xff )
441 || ( intf_desc->desc.bInterfaceSubClass != 0 )
442 || ( intf_desc->desc.bInterfaceProtocol != 0 )
443 || ( intf_desc->desc.bNumEndpoints != 4)
446 err ("probe fails -> wrong Interface");
450 /* Check the Endpoints */
453 mdc800->endpoint[i]=-1;
456 if (mdc800_endpoint_equals (&intf_desc->endpoint [j].desc,&mdc800_ed [i]))
458 mdc800->endpoint[i]=intf_desc->endpoint [j].desc.bEndpointAddress ;
461 irq_interval=intf_desc->endpoint [j].desc.bInterval;
467 if (mdc800->endpoint[i] == -1)
469 err ("probe fails -> Wrong Endpoints.");
475 info ("Found Mustek MDC800 on USB.");
477 down (&mdc800->io_lock);
479 retval = usb_register_dev(intf, &mdc800_class);
481 err ("Not able to get a minor for this device.");
488 /* Setup URB Structs */
492 usb_rcvintpipe (mdc800->dev,mdc800->endpoint [1]),
493 mdc800->irq_urb_buffer,
503 usb_sndbulkpipe (mdc800->dev, mdc800->endpoint[0]),
504 mdc800->write_urb_buffer,
506 mdc800_usb_write_notify,
511 mdc800->download_urb,
513 usb_rcvbulkpipe (mdc800->dev, mdc800->endpoint [3]),
514 mdc800->download_urb_buffer,
516 mdc800_usb_download_notify,
522 up (&mdc800->io_lock);
524 usb_set_intfdata(intf, mdc800);
530 * Disconnect USB device (maybe the MDC800)
532 static void mdc800_usb_disconnect (struct usb_interface *intf)
534 struct mdc800_data* mdc800 = usb_get_intfdata(intf);
536 dbg ("(mdc800_usb_disconnect) called");
539 if (mdc800->state == NOT_CONNECTED)
542 usb_deregister_dev(intf, &mdc800_class);
544 mdc800->state=NOT_CONNECTED;
546 usb_unlink_urb (mdc800->irq_urb);
547 usb_unlink_urb (mdc800->write_urb);
548 usb_unlink_urb (mdc800->download_urb);
551 usb_set_intfdata(intf, NULL);
553 info ("Mustek MDC800 disconnected from USB.");
557 /***************************************************************************
558 The Misc device Part (file_operations)
559 ****************************************************************************/
562 * This Function calc the Answersize for a command.
564 static int mdc800_getAnswerSize (char command)
566 switch ((unsigned char) command)
581 return mdc800->pic_len;
593 * Init the device: (1) alloc mem (2) Increase MOD Count ..
595 static int mdc800_device_open (struct inode* inode, struct file *file)
600 down (&mdc800->io_lock);
602 if (mdc800->state == NOT_CONNECTED)
618 mdc800->download_left=0;
620 mdc800->camera_busy=0;
621 mdc800->camera_request_ready=0;
624 mdc800->irq_urb->dev = mdc800->dev;
625 if (usb_submit_urb (mdc800->irq_urb, GFP_KERNEL))
627 err ("request USB irq fails (submit_retval=%i urb_status=%i).",retval, mdc800->irq_urb->status);
633 dbg ("Mustek MDC800 device opened.");
636 up (&mdc800->io_lock);
642 * Close the Camera and release Memory
644 static int mdc800_device_release (struct inode* inode, struct file *file)
647 dbg ("Mustek MDC800 device closed.");
649 down (&mdc800->io_lock);
650 if (mdc800->open && (mdc800->state != NOT_CONNECTED))
652 usb_unlink_urb (mdc800->irq_urb);
653 usb_unlink_urb (mdc800->write_urb);
654 usb_unlink_urb (mdc800->download_urb);
662 up(&mdc800->io_lock);
668 * The Device read callback Function
670 static ssize_t mdc800_device_read (struct file *file, char __user *buf, size_t len, loff_t *pos)
672 size_t left=len, sts=len; /* single transfer size */
673 char __user *ptr = buf;
675 DECLARE_WAITQUEUE(wait, current);
677 down (&mdc800->io_lock);
678 if (mdc800->state == NOT_CONNECTED)
680 up (&mdc800->io_lock);
683 if (mdc800->state == WORKING)
685 warn ("Illegal State \"working\" reached during read ?!");
686 up (&mdc800->io_lock);
691 up (&mdc800->io_lock);
697 if (signal_pending (current))
699 up (&mdc800->io_lock);
703 sts=left > (mdc800->out_count-mdc800->out_ptr)?mdc800->out_count-mdc800->out_ptr:left;
707 /* Too less Data in buffer */
708 if (mdc800->state == DOWNLOAD)
713 /* Download -> Request new bytes */
714 mdc800->download_urb->dev = mdc800->dev;
715 if (usb_submit_urb (mdc800->download_urb, GFP_KERNEL))
717 err ("Can't submit download urb (status=%i)",mdc800->download_urb->status);
718 up (&mdc800->io_lock);
721 add_wait_queue(&mdc800->download_wait, &wait);
722 timeout = TO_DOWNLOAD_GET_READY*HZ/1000;
723 while (!mdc800->downloaded && timeout)
725 set_current_state(TASK_UNINTERRUPTIBLE);
726 timeout = schedule_timeout (timeout);
728 set_current_state(TASK_RUNNING);
729 remove_wait_queue(&mdc800->download_wait, &wait);
730 mdc800->downloaded = 0;
731 if (mdc800->download_urb->status != 0)
733 err ("request download-bytes fails (status=%i)",mdc800->download_urb->status);
734 up (&mdc800->io_lock);
740 /* No more bytes -> that's an error*/
741 up (&mdc800->io_lock);
748 if (copy_to_user(ptr, &mdc800->out [mdc800->out_ptr],
750 up(&mdc800->io_lock);
755 mdc800->out_ptr+=sts;
759 up (&mdc800->io_lock);
765 * The Device write callback Function
766 * If a 8Byte Command is received, it will be send to the camera.
767 * After this the driver initiates the request for the answer or
768 * just waits until the camera becomes ready.
770 static ssize_t mdc800_device_write (struct file *file, const char __user *buf, size_t len, loff_t *pos)
773 DECLARE_WAITQUEUE(wait, current);
775 down (&mdc800->io_lock);
776 if (mdc800->state != READY)
778 up (&mdc800->io_lock);
783 up (&mdc800->io_lock);
790 if (signal_pending (current))
792 up (&mdc800->io_lock);
796 if(get_user(c, buf+i))
798 up(&mdc800->io_lock);
802 /* check for command start */
808 mdc800->download_left=0;
811 /* save command byte */
812 if (mdc800->in_count < 8)
814 mdc800->in[mdc800->in_count] = c;
819 up (&mdc800->io_lock);
823 /* Command Buffer full ? -> send it to camera */
824 if (mdc800->in_count == 8)
829 if (mdc800_usb_waitForIRQ (0,TO_GET_READY))
831 err ("Camera didn't get ready.\n");
832 up (&mdc800->io_lock);
836 answersize=mdc800_getAnswerSize (mdc800->in[1]);
838 mdc800->state=WORKING;
839 memcpy (mdc800->write_urb->transfer_buffer, mdc800->in,8);
840 mdc800->write_urb->dev = mdc800->dev;
841 if (usb_submit_urb (mdc800->write_urb, GFP_KERNEL))
843 err ("submitting write urb fails (status=%i)", mdc800->write_urb->status);
844 up (&mdc800->io_lock);
847 add_wait_queue(&mdc800->write_wait, &wait);
848 timeout = TO_WRITE_GET_READY*HZ/1000;
849 while (!mdc800->written && timeout)
851 set_current_state(TASK_UNINTERRUPTIBLE);
852 timeout = schedule_timeout (timeout);
854 set_current_state(TASK_RUNNING);
855 remove_wait_queue(&mdc800->write_wait, &wait);
857 if (mdc800->state == WORKING)
859 usb_unlink_urb (mdc800->write_urb);
860 up (&mdc800->io_lock);
864 switch ((unsigned char) mdc800->in[1])
866 case 0x05: /* Download Image */
867 case 0x3e: /* Take shot in Fine Mode (WCam Mode) */
868 if (mdc800->pic_len < 0)
870 err ("call 0x07 before 0x05,0x3e");
872 up (&mdc800->io_lock);
877 case 0x09: /* Download Thumbnail */
878 mdc800->download_left=answersize+64;
879 mdc800->state=DOWNLOAD;
880 mdc800_usb_waitForIRQ (0,TO_DOWNLOAD_GET_BUSY);
888 if (mdc800_usb_waitForIRQ (1,TO_READ_FROM_IRQ))
890 err ("requesting answer from irq fails");
891 up (&mdc800->io_lock);
895 /* Write dummy data, (this is ugly but part of the USB Protocol */
896 /* if you use endpoint 1 as bulk and not as irq) */
897 memcpy (mdc800->out, mdc800->camera_response,8);
899 /* This is the interpreted answer */
900 memcpy (&mdc800->out[8], mdc800->camera_response,8);
903 mdc800->out_count=16;
905 /* Cache the Imagesize, if command was getImageSize */
906 if (mdc800->in [1] == (char) 0x07)
908 mdc800->pic_len=(int) 65536*(unsigned char) mdc800->camera_response[0]+256*(unsigned char) mdc800->camera_response[1]+(unsigned char) mdc800->camera_response[2];
910 dbg ("cached imagesize = %i",mdc800->pic_len);
916 if (mdc800_usb_waitForIRQ (0,TO_DEFAULT_COMMAND))
918 err ("Command Timeout.");
919 up (&mdc800->io_lock);
929 up (&mdc800->io_lock);
934 /***************************************************************************
935 Init and Cleanup this driver (Structs and types)
936 ****************************************************************************/
938 /* File Operations of this drivers */
939 static struct file_operations mdc800_device_ops =
941 .owner = THIS_MODULE,
942 .read = mdc800_device_read,
943 .write = mdc800_device_write,
944 .open = mdc800_device_open,
945 .release = mdc800_device_release,
950 static struct usb_device_id mdc800_table [] = {
951 { USB_DEVICE(MDC800_VENDOR_ID, MDC800_PRODUCT_ID) },
952 { } /* Terminating entry */
955 MODULE_DEVICE_TABLE (usb, mdc800_table);
957 * USB Driver Struct for this device
959 static struct usb_driver mdc800_usb_driver =
961 .owner = THIS_MODULE,
963 .probe = mdc800_usb_probe,
964 .disconnect = mdc800_usb_disconnect,
965 .id_table = mdc800_table
970 /************************************************************************
971 Init and Cleanup this driver (Main Functions)
972 *************************************************************************/
974 #define try(A) if (!(A)) goto cleanup_on_fail;
976 static int __init usb_mdc800_init (void)
978 int retval = -ENODEV;
979 /* Allocate Memory */
980 try (mdc800=kmalloc (sizeof (struct mdc800_data), GFP_KERNEL));
982 memset(mdc800, 0, sizeof(struct mdc800_data));
985 mdc800->state=NOT_CONNECTED;
986 init_MUTEX (&mdc800->io_lock);
988 init_waitqueue_head (&mdc800->irq_wait);
989 init_waitqueue_head (&mdc800->write_wait);
990 init_waitqueue_head (&mdc800->download_wait);
992 mdc800->irq_woken = 0;
993 mdc800->downloaded = 0;
996 try (mdc800->irq_urb_buffer=kmalloc (8, GFP_KERNEL));
997 try (mdc800->write_urb_buffer=kmalloc (8, GFP_KERNEL));
998 try (mdc800->download_urb_buffer=kmalloc (64, GFP_KERNEL));
1000 try (mdc800->irq_urb=usb_alloc_urb (0, GFP_KERNEL));
1001 try (mdc800->download_urb=usb_alloc_urb (0, GFP_KERNEL));
1002 try (mdc800->write_urb=usb_alloc_urb (0, GFP_KERNEL));
1004 /* Register the driver */
1005 retval = usb_register(&mdc800_usb_driver);
1007 goto cleanup_on_fail;
1009 info (DRIVER_VERSION ":" DRIVER_DESC);
1013 /* Clean driver up, when something fails */
1019 err ("can't alloc memory!");
1021 kfree(mdc800->download_urb_buffer);
1022 kfree(mdc800->write_urb_buffer);
1023 kfree(mdc800->irq_urb_buffer);
1025 usb_free_urb(mdc800->write_urb);
1026 usb_free_urb(mdc800->download_urb);
1027 usb_free_urb(mdc800->irq_urb);
1036 static void __exit usb_mdc800_cleanup (void)
1038 usb_deregister (&mdc800_usb_driver);
1040 usb_free_urb (mdc800->irq_urb);
1041 usb_free_urb (mdc800->download_urb);
1042 usb_free_urb (mdc800->write_urb);
1044 kfree (mdc800->irq_urb_buffer);
1045 kfree (mdc800->write_urb_buffer);
1046 kfree (mdc800->download_urb_buffer);
1052 module_init (usb_mdc800_init);
1053 module_exit (usb_mdc800_cleanup);
1055 MODULE_AUTHOR( DRIVER_AUTHOR );
1056 MODULE_DESCRIPTION( DRIVER_DESC );
1057 MODULE_LICENSE("GPL");