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 Protocol 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/wait.h>
98 #include <linux/mutex.h>
100 #include <linux/usb.h>
101 #include <linux/fs.h>
104 * Version Information
106 #define DRIVER_VERSION "v0.7.5 (30/10/2000)"
107 #define DRIVER_AUTHOR "Henning Zabel <henning@uni-paderborn.de>"
108 #define DRIVER_DESC "USB Driver for Mustek MDC800 Digital Camera"
110 /* Vendor and Product Information */
111 #define MDC800_VENDOR_ID 0x055f
112 #define MDC800_PRODUCT_ID 0xa800
114 /* Timeouts (msec) */
115 #define TO_DOWNLOAD_GET_READY 1500
116 #define TO_DOWNLOAD_GET_BUSY 1500
117 #define TO_WRITE_GET_READY 1000
118 #define TO_DEFAULT_COMMAND 5000
119 #define TO_READ_FROM_IRQ TO_DEFAULT_COMMAND
120 #define TO_GET_READY TO_DEFAULT_COMMAND
122 /* Minor Number of the device (create with mknod /dev/mustek c 180 32) */
123 #define MDC800_DEVICE_MINOR_BASE 32
126 /**************************************************************************
128 ***************************************************************************/
132 NOT_CONNECTED, READY, WORKING, DOWNLOAD
136 /* Data for the driver */
139 struct usb_device * dev; // Device Data
142 unsigned int endpoint [4];
144 struct urb * irq_urb;
145 wait_queue_head_t irq_wait;
147 char* irq_urb_buffer;
149 int camera_busy; // is camera busy ?
150 int camera_request_ready; // Status to synchronize with irq
151 char camera_response [8]; // last Bytes send after busy
153 struct urb * write_urb;
154 char* write_urb_buffer;
155 wait_queue_head_t write_wait;
159 struct urb * download_urb;
160 char* download_urb_buffer;
161 wait_queue_head_t download_wait;
163 int download_left; // Bytes left to download ?
167 char out [64]; // Answer Buffer
168 int out_ptr; // Index to the first not readen byte
169 int out_count; // Bytes in the buffer
171 int open; // Camera device open ?
172 struct mutex io_lock; // IO -lock
174 char in [8]; // Command Input Buffer
177 int pic_index; // Cache for the Imagesize (-1 for nothing cached )
183 /* Specification of the Endpoints */
184 static struct usb_endpoint_descriptor mdc800_ed [4] =
188 .bDescriptorType = 0,
189 .bEndpointAddress = 0x01,
190 .bmAttributes = 0x02,
191 .wMaxPacketSize = __constant_cpu_to_le16(8),
198 .bDescriptorType = 0,
199 .bEndpointAddress = 0x82,
200 .bmAttributes = 0x03,
201 .wMaxPacketSize = __constant_cpu_to_le16(8),
208 .bDescriptorType = 0,
209 .bEndpointAddress = 0x03,
210 .bmAttributes = 0x02,
211 .wMaxPacketSize = __constant_cpu_to_le16(64),
218 .bDescriptorType = 0,
219 .bEndpointAddress = 0x84,
220 .bmAttributes = 0x02,
221 .wMaxPacketSize = __constant_cpu_to_le16(64),
228 /* The Variable used by the driver */
229 static struct mdc800_data* mdc800;
232 /***************************************************************************
233 The USB Part of the driver
234 ****************************************************************************/
236 static int mdc800_endpoint_equals (struct usb_endpoint_descriptor *a,struct usb_endpoint_descriptor *b)
239 ( a->bEndpointAddress == b->bEndpointAddress )
240 && ( a->bmAttributes == b->bmAttributes )
241 && ( a->wMaxPacketSize == b->wMaxPacketSize )
247 * Checks whether the camera responds busy
249 static int mdc800_isBusy (char* ch)
254 if (ch [i] != (char)0x99)
263 * Checks whether the Camera is ready
265 static int mdc800_isReady (char *ch)
270 if (ch [i] != (char)0xbb)
280 * USB IRQ Handler for InputLine
282 static void mdc800_usb_irq (struct urb *urb)
284 int data_received=0, wake_up;
285 unsigned char* b=urb->transfer_buffer;
286 struct mdc800_data* mdc800=urb->context;
287 int status = urb->status;
291 //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]);
293 if (mdc800_isBusy (b))
295 if (!mdc800->camera_busy)
297 mdc800->camera_busy=1;
303 if (mdc800->camera_busy && mdc800_isReady (b))
305 mdc800->camera_busy=0;
309 if (!(mdc800_isBusy (b) || mdc800_isReady (b)))
311 /* Store Data in camera_answer field */
312 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]);
314 memcpy (mdc800->camera_response,b,8);
318 wake_up= ( mdc800->camera_request_ready > 0 )
321 ((mdc800->camera_request_ready == 1) && (!mdc800->camera_busy))
323 ((mdc800->camera_request_ready == 2) && data_received)
325 ((mdc800->camera_request_ready == 3) && (mdc800->camera_busy))
332 mdc800->camera_request_ready=0;
334 wake_up (&mdc800->irq_wait);
340 * Waits a while until the irq responds that camera is ready
342 * mode : 0: Wait for camera gets ready
343 * 1: Wait for receiving data
344 * 2: Wait for camera gets busy
348 static int mdc800_usb_waitForIRQ (int mode, int msec)
350 mdc800->camera_request_ready=1+mode;
352 wait_event_timeout(mdc800->irq_wait, mdc800->irq_woken, msec*HZ/1000);
353 mdc800->irq_woken = 0;
355 if (mdc800->camera_request_ready>0)
357 mdc800->camera_request_ready=0;
358 err ("timeout waiting for camera.");
362 if (mdc800->state == NOT_CONNECTED)
364 warn ("Camera gets disconnected during waiting for irq.");
365 mdc800->camera_request_ready=0;
374 * The write_urb callback function
376 static void mdc800_usb_write_notify (struct urb *urb)
378 struct mdc800_data* mdc800=urb->context;
379 int status = urb->status;
382 err ("writing command fails (status=%i)", status);
386 wake_up (&mdc800->write_wait);
391 * The download_urb callback function
393 static void mdc800_usb_download_notify (struct urb *urb)
395 struct mdc800_data* mdc800=urb->context;
396 int status = urb->status;
399 /* Fill output buffer with these data */
400 memcpy (mdc800->out, urb->transfer_buffer, 64);
401 mdc800->out_count=64;
403 mdc800->download_left-=64;
404 if (mdc800->download_left == 0)
409 err ("request bytes fails (status:%i)", status);
411 mdc800->downloaded = 1;
412 wake_up (&mdc800->download_wait);
416 /***************************************************************************
417 Probing for the Camera
418 ***************************************************************************/
420 static struct usb_driver mdc800_usb_driver;
421 static const struct file_operations mdc800_device_ops;
422 static struct usb_class_driver mdc800_class = {
424 .fops = &mdc800_device_ops,
425 .minor_base = MDC800_DEVICE_MINOR_BASE,
430 * Callback to search the Mustek MDC800 on the USB Bus
432 static int mdc800_usb_probe (struct usb_interface *intf,
433 const struct usb_device_id *id)
436 struct usb_host_interface *intf_desc;
437 struct usb_device *dev = interface_to_usbdev (intf);
441 dbg ("(mdc800_usb_probe) called.");
444 if (mdc800->dev != NULL)
446 warn ("only one Mustek MDC800 is supported.");
450 if (dev->descriptor.bNumConfigurations != 1)
452 err ("probe fails -> wrong Number of Configuration");
455 intf_desc = intf->cur_altsetting;
458 ( intf_desc->desc.bInterfaceClass != 0xff )
459 || ( intf_desc->desc.bInterfaceSubClass != 0 )
460 || ( intf_desc->desc.bInterfaceProtocol != 0 )
461 || ( intf_desc->desc.bNumEndpoints != 4)
464 err ("probe fails -> wrong Interface");
468 /* Check the Endpoints */
471 mdc800->endpoint[i]=-1;
474 if (mdc800_endpoint_equals (&intf_desc->endpoint [j].desc,&mdc800_ed [i]))
476 mdc800->endpoint[i]=intf_desc->endpoint [j].desc.bEndpointAddress ;
479 irq_interval=intf_desc->endpoint [j].desc.bInterval;
485 if (mdc800->endpoint[i] == -1)
487 err ("probe fails -> Wrong Endpoints.");
493 info ("Found Mustek MDC800 on USB.");
495 mutex_lock(&mdc800->io_lock);
497 retval = usb_register_dev(intf, &mdc800_class);
499 err ("Not able to get a minor for this device.");
506 /* Setup URB Structs */
510 usb_rcvintpipe (mdc800->dev,mdc800->endpoint [1]),
511 mdc800->irq_urb_buffer,
521 usb_sndbulkpipe (mdc800->dev, mdc800->endpoint[0]),
522 mdc800->write_urb_buffer,
524 mdc800_usb_write_notify,
529 mdc800->download_urb,
531 usb_rcvbulkpipe (mdc800->dev, mdc800->endpoint [3]),
532 mdc800->download_urb_buffer,
534 mdc800_usb_download_notify,
540 mutex_unlock(&mdc800->io_lock);
542 usb_set_intfdata(intf, mdc800);
548 * Disconnect USB device (maybe the MDC800)
550 static void mdc800_usb_disconnect (struct usb_interface *intf)
552 struct mdc800_data* mdc800 = usb_get_intfdata(intf);
554 dbg ("(mdc800_usb_disconnect) called");
557 if (mdc800->state == NOT_CONNECTED)
560 usb_deregister_dev(intf, &mdc800_class);
562 /* must be under lock to make sure no URB
563 is submitted after usb_kill_urb() */
564 mutex_lock(&mdc800->io_lock);
565 mdc800->state=NOT_CONNECTED;
567 usb_kill_urb(mdc800->irq_urb);
568 usb_kill_urb(mdc800->write_urb);
569 usb_kill_urb(mdc800->download_urb);
570 mutex_unlock(&mdc800->io_lock);
573 usb_set_intfdata(intf, NULL);
575 info ("Mustek MDC800 disconnected from USB.");
579 /***************************************************************************
580 The Misc device Part (file_operations)
581 ****************************************************************************/
584 * This Function calc the Answersize for a command.
586 static int mdc800_getAnswerSize (char command)
588 switch ((unsigned char) command)
603 return mdc800->pic_len;
615 * Init the device: (1) alloc mem (2) Increase MOD Count ..
617 static int mdc800_device_open (struct inode* inode, struct file *file)
622 mutex_lock(&mdc800->io_lock);
624 if (mdc800->state == NOT_CONNECTED)
640 mdc800->download_left=0;
642 mdc800->camera_busy=0;
643 mdc800->camera_request_ready=0;
646 mdc800->irq_urb->dev = mdc800->dev;
647 retval = usb_submit_urb (mdc800->irq_urb, GFP_KERNEL);
649 err ("request USB irq fails (submit_retval=%i).", retval);
655 dbg ("Mustek MDC800 device opened.");
658 mutex_unlock(&mdc800->io_lock);
664 * Close the Camera and release Memory
666 static int mdc800_device_release (struct inode* inode, struct file *file)
669 dbg ("Mustek MDC800 device closed.");
671 mutex_lock(&mdc800->io_lock);
672 if (mdc800->open && (mdc800->state != NOT_CONNECTED))
674 usb_kill_urb(mdc800->irq_urb);
675 usb_kill_urb(mdc800->write_urb);
676 usb_kill_urb(mdc800->download_urb);
684 mutex_unlock(&mdc800->io_lock);
690 * The Device read callback Function
692 static ssize_t mdc800_device_read (struct file *file, char __user *buf, size_t len, loff_t *pos)
694 size_t left=len, sts=len; /* single transfer size */
695 char __user *ptr = buf;
698 mutex_lock(&mdc800->io_lock);
699 if (mdc800->state == NOT_CONNECTED)
701 mutex_unlock(&mdc800->io_lock);
704 if (mdc800->state == WORKING)
706 warn ("Illegal State \"working\" reached during read ?!");
707 mutex_unlock(&mdc800->io_lock);
712 mutex_unlock(&mdc800->io_lock);
718 if (signal_pending (current))
720 mutex_unlock(&mdc800->io_lock);
724 sts=left > (mdc800->out_count-mdc800->out_ptr)?mdc800->out_count-mdc800->out_ptr:left;
728 /* Too less Data in buffer */
729 if (mdc800->state == DOWNLOAD)
734 /* Download -> Request new bytes */
735 mdc800->download_urb->dev = mdc800->dev;
736 retval = usb_submit_urb (mdc800->download_urb, GFP_KERNEL);
738 err ("Can't submit download urb (retval=%i)",retval);
739 mutex_unlock(&mdc800->io_lock);
742 wait_event_timeout(mdc800->download_wait, mdc800->downloaded,
743 TO_DOWNLOAD_GET_READY*HZ/1000);
744 mdc800->downloaded = 0;
745 if (mdc800->download_urb->status != 0)
747 err ("request download-bytes fails (status=%i)",mdc800->download_urb->status);
748 mutex_unlock(&mdc800->io_lock);
754 /* No more bytes -> that's an error*/
755 mutex_unlock(&mdc800->io_lock);
762 if (copy_to_user(ptr, &mdc800->out [mdc800->out_ptr],
764 mutex_unlock(&mdc800->io_lock);
769 mdc800->out_ptr+=sts;
773 mutex_unlock(&mdc800->io_lock);
779 * The Device write callback Function
780 * If a 8Byte Command is received, it will be send to the camera.
781 * After this the driver initiates the request for the answer or
782 * just waits until the camera becomes ready.
784 static ssize_t mdc800_device_write (struct file *file, const char __user *buf, size_t len, loff_t *pos)
789 mutex_lock(&mdc800->io_lock);
790 if (mdc800->state != READY)
792 mutex_unlock(&mdc800->io_lock);
797 mutex_unlock(&mdc800->io_lock);
804 if (signal_pending (current))
806 mutex_unlock(&mdc800->io_lock);
810 if(get_user(c, buf+i))
812 mutex_unlock(&mdc800->io_lock);
816 /* check for command start */
822 mdc800->download_left=0;
825 /* save command byte */
826 if (mdc800->in_count < 8)
828 mdc800->in[mdc800->in_count] = c;
833 mutex_unlock(&mdc800->io_lock);
837 /* Command Buffer full ? -> send it to camera */
838 if (mdc800->in_count == 8)
842 if (mdc800_usb_waitForIRQ (0,TO_GET_READY))
844 err ("Camera didn't get ready.\n");
845 mutex_unlock(&mdc800->io_lock);
849 answersize=mdc800_getAnswerSize (mdc800->in[1]);
851 mdc800->state=WORKING;
852 memcpy (mdc800->write_urb->transfer_buffer, mdc800->in,8);
853 mdc800->write_urb->dev = mdc800->dev;
854 retval = usb_submit_urb (mdc800->write_urb, GFP_KERNEL);
856 err ("submitting write urb fails (retval=%i)", retval);
857 mutex_unlock(&mdc800->io_lock);
860 wait_event_timeout(mdc800->write_wait, mdc800->written, TO_WRITE_GET_READY*HZ/1000);
862 if (mdc800->state == WORKING)
864 usb_kill_urb(mdc800->write_urb);
865 mutex_unlock(&mdc800->io_lock);
869 switch ((unsigned char) mdc800->in[1])
871 case 0x05: /* Download Image */
872 case 0x3e: /* Take shot in Fine Mode (WCam Mode) */
873 if (mdc800->pic_len < 0)
875 err ("call 0x07 before 0x05,0x3e");
877 mutex_unlock(&mdc800->io_lock);
882 case 0x09: /* Download Thumbnail */
883 mdc800->download_left=answersize+64;
884 mdc800->state=DOWNLOAD;
885 mdc800_usb_waitForIRQ (0,TO_DOWNLOAD_GET_BUSY);
893 if (mdc800_usb_waitForIRQ (1,TO_READ_FROM_IRQ))
895 err ("requesting answer from irq fails");
896 mutex_unlock(&mdc800->io_lock);
900 /* Write dummy data, (this is ugly but part of the USB Protocol */
901 /* if you use endpoint 1 as bulk and not as irq) */
902 memcpy (mdc800->out, mdc800->camera_response,8);
904 /* This is the interpreted answer */
905 memcpy (&mdc800->out[8], mdc800->camera_response,8);
908 mdc800->out_count=16;
910 /* Cache the Imagesize, if command was getImageSize */
911 if (mdc800->in [1] == (char) 0x07)
913 mdc800->pic_len=(int) 65536*(unsigned char) mdc800->camera_response[0]+256*(unsigned char) mdc800->camera_response[1]+(unsigned char) mdc800->camera_response[2];
915 dbg ("cached imagesize = %i",mdc800->pic_len);
921 if (mdc800_usb_waitForIRQ (0,TO_DEFAULT_COMMAND))
923 err ("Command Timeout.");
924 mutex_unlock(&mdc800->io_lock);
934 mutex_unlock(&mdc800->io_lock);
939 /***************************************************************************
940 Init and Cleanup this driver (Structs and types)
941 ****************************************************************************/
943 /* File Operations of this drivers */
944 static const struct file_operations mdc800_device_ops =
946 .owner = THIS_MODULE,
947 .read = mdc800_device_read,
948 .write = mdc800_device_write,
949 .open = mdc800_device_open,
950 .release = mdc800_device_release,
955 static struct usb_device_id mdc800_table [] = {
956 { USB_DEVICE(MDC800_VENDOR_ID, MDC800_PRODUCT_ID) },
957 { } /* Terminating entry */
960 MODULE_DEVICE_TABLE (usb, mdc800_table);
962 * USB Driver Struct for this device
964 static struct usb_driver mdc800_usb_driver =
967 .probe = mdc800_usb_probe,
968 .disconnect = mdc800_usb_disconnect,
969 .id_table = mdc800_table
974 /************************************************************************
975 Init and Cleanup this driver (Main Functions)
976 *************************************************************************/
978 static int __init usb_mdc800_init (void)
980 int retval = -ENODEV;
981 /* Allocate Memory */
982 mdc800=kzalloc (sizeof (struct mdc800_data), GFP_KERNEL);
984 goto cleanup_on_fail;
987 mdc800->state=NOT_CONNECTED;
988 mutex_init (&mdc800->io_lock);
990 init_waitqueue_head (&mdc800->irq_wait);
991 init_waitqueue_head (&mdc800->write_wait);
992 init_waitqueue_head (&mdc800->download_wait);
994 mdc800->irq_woken = 0;
995 mdc800->downloaded = 0;
998 mdc800->irq_urb_buffer=kmalloc (8, GFP_KERNEL);
999 if (!mdc800->irq_urb_buffer)
1000 goto cleanup_on_fail;
1001 mdc800->write_urb_buffer=kmalloc (8, GFP_KERNEL);
1002 if (!mdc800->write_urb_buffer)
1003 goto cleanup_on_fail;
1004 mdc800->download_urb_buffer=kmalloc (64, GFP_KERNEL);
1005 if (!mdc800->download_urb_buffer)
1006 goto cleanup_on_fail;
1008 mdc800->irq_urb=usb_alloc_urb (0, GFP_KERNEL);
1009 if (!mdc800->irq_urb)
1010 goto cleanup_on_fail;
1011 mdc800->download_urb=usb_alloc_urb (0, GFP_KERNEL);
1012 if (!mdc800->download_urb)
1013 goto cleanup_on_fail;
1014 mdc800->write_urb=usb_alloc_urb (0, GFP_KERNEL);
1015 if (!mdc800->write_urb)
1016 goto cleanup_on_fail;
1018 /* Register the driver */
1019 retval = usb_register(&mdc800_usb_driver);
1021 goto cleanup_on_fail;
1023 info (DRIVER_VERSION ":" DRIVER_DESC);
1027 /* Clean driver up, when something fails */
1033 err ("can't alloc memory!");
1035 kfree(mdc800->download_urb_buffer);
1036 kfree(mdc800->write_urb_buffer);
1037 kfree(mdc800->irq_urb_buffer);
1039 usb_free_urb(mdc800->write_urb);
1040 usb_free_urb(mdc800->download_urb);
1041 usb_free_urb(mdc800->irq_urb);
1050 static void __exit usb_mdc800_cleanup (void)
1052 usb_deregister (&mdc800_usb_driver);
1054 usb_free_urb (mdc800->irq_urb);
1055 usb_free_urb (mdc800->download_urb);
1056 usb_free_urb (mdc800->write_urb);
1058 kfree (mdc800->irq_urb_buffer);
1059 kfree (mdc800->write_urb_buffer);
1060 kfree (mdc800->download_urb_buffer);
1066 module_init (usb_mdc800_init);
1067 module_exit (usb_mdc800_cleanup);
1069 MODULE_AUTHOR( DRIVER_AUTHOR );
1070 MODULE_DESCRIPTION( DRIVER_DESC );
1071 MODULE_LICENSE("GPL");