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 dev_err(&mdc800->dev->dev, "timeout waiting for camera.\n");
362 if (mdc800->state == NOT_CONNECTED)
364 printk(KERN_WARNING "mdc800: Camera gets disconnected "
365 "during waiting for irq.\n");
366 mdc800->camera_request_ready=0;
375 * The write_urb callback function
377 static void mdc800_usb_write_notify (struct urb *urb)
379 struct mdc800_data* mdc800=urb->context;
380 int status = urb->status;
383 dev_err(&mdc800->dev->dev,
384 "writing command fails (status=%i)\n", status);
388 wake_up (&mdc800->write_wait);
393 * The download_urb callback function
395 static void mdc800_usb_download_notify (struct urb *urb)
397 struct mdc800_data* mdc800=urb->context;
398 int status = urb->status;
401 /* Fill output buffer with these data */
402 memcpy (mdc800->out, urb->transfer_buffer, 64);
403 mdc800->out_count=64;
405 mdc800->download_left-=64;
406 if (mdc800->download_left == 0)
411 dev_err(&mdc800->dev->dev,
412 "request bytes fails (status:%i)\n", status);
414 mdc800->downloaded = 1;
415 wake_up (&mdc800->download_wait);
419 /***************************************************************************
420 Probing for the Camera
421 ***************************************************************************/
423 static struct usb_driver mdc800_usb_driver;
424 static const struct file_operations mdc800_device_ops;
425 static struct usb_class_driver mdc800_class = {
427 .fops = &mdc800_device_ops,
428 .minor_base = MDC800_DEVICE_MINOR_BASE,
433 * Callback to search the Mustek MDC800 on the USB Bus
435 static int mdc800_usb_probe (struct usb_interface *intf,
436 const struct usb_device_id *id)
439 struct usb_host_interface *intf_desc;
440 struct usb_device *dev = interface_to_usbdev (intf);
444 dbg ("(mdc800_usb_probe) called.");
447 if (mdc800->dev != NULL)
449 dev_warn(&intf->dev, "only one Mustek MDC800 is supported.\n");
453 if (dev->descriptor.bNumConfigurations != 1)
456 "probe fails -> wrong Number of Configuration\n");
459 intf_desc = intf->cur_altsetting;
462 ( intf_desc->desc.bInterfaceClass != 0xff )
463 || ( intf_desc->desc.bInterfaceSubClass != 0 )
464 || ( intf_desc->desc.bInterfaceProtocol != 0 )
465 || ( intf_desc->desc.bNumEndpoints != 4)
468 dev_err(&intf->dev, "probe fails -> wrong Interface\n");
472 /* Check the Endpoints */
475 mdc800->endpoint[i]=-1;
478 if (mdc800_endpoint_equals (&intf_desc->endpoint [j].desc,&mdc800_ed [i]))
480 mdc800->endpoint[i]=intf_desc->endpoint [j].desc.bEndpointAddress ;
483 irq_interval=intf_desc->endpoint [j].desc.bInterval;
487 if (mdc800->endpoint[i] == -1)
489 dev_err(&intf->dev, "probe fails -> Wrong Endpoints.\n");
495 dev_info(&intf->dev, "Found Mustek MDC800 on USB.\n");
497 mutex_lock(&mdc800->io_lock);
499 retval = usb_register_dev(intf, &mdc800_class);
501 dev_err(&intf->dev, "Not able to get a minor for this device.\n");
508 /* Setup URB Structs */
512 usb_rcvintpipe (mdc800->dev,mdc800->endpoint [1]),
513 mdc800->irq_urb_buffer,
523 usb_sndbulkpipe (mdc800->dev, mdc800->endpoint[0]),
524 mdc800->write_urb_buffer,
526 mdc800_usb_write_notify,
531 mdc800->download_urb,
533 usb_rcvbulkpipe (mdc800->dev, mdc800->endpoint [3]),
534 mdc800->download_urb_buffer,
536 mdc800_usb_download_notify,
542 mutex_unlock(&mdc800->io_lock);
544 usb_set_intfdata(intf, mdc800);
550 * Disconnect USB device (maybe the MDC800)
552 static void mdc800_usb_disconnect (struct usb_interface *intf)
554 struct mdc800_data* mdc800 = usb_get_intfdata(intf);
556 dbg ("(mdc800_usb_disconnect) called");
559 if (mdc800->state == NOT_CONNECTED)
562 usb_deregister_dev(intf, &mdc800_class);
564 /* must be under lock to make sure no URB
565 is submitted after usb_kill_urb() */
566 mutex_lock(&mdc800->io_lock);
567 mdc800->state=NOT_CONNECTED;
569 usb_kill_urb(mdc800->irq_urb);
570 usb_kill_urb(mdc800->write_urb);
571 usb_kill_urb(mdc800->download_urb);
572 mutex_unlock(&mdc800->io_lock);
575 usb_set_intfdata(intf, NULL);
577 dev_info(&intf->dev, "Mustek MDC800 disconnected from USB.\n");
581 /***************************************************************************
582 The Misc device Part (file_operations)
583 ****************************************************************************/
586 * This Function calc the Answersize for a command.
588 static int mdc800_getAnswerSize (char command)
590 switch ((unsigned char) command)
605 return mdc800->pic_len;
617 * Init the device: (1) alloc mem (2) Increase MOD Count ..
619 static int mdc800_device_open (struct inode* inode, struct file *file)
624 mutex_lock(&mdc800->io_lock);
626 if (mdc800->state == NOT_CONNECTED)
642 mdc800->download_left=0;
644 mdc800->camera_busy=0;
645 mdc800->camera_request_ready=0;
648 mdc800->irq_urb->dev = mdc800->dev;
649 retval = usb_submit_urb (mdc800->irq_urb, GFP_KERNEL);
651 dev_err(&mdc800->dev->dev,
652 "request USB irq fails (submit_retval=%i).\n", retval);
658 dbg ("Mustek MDC800 device opened.");
661 mutex_unlock(&mdc800->io_lock);
667 * Close the Camera and release Memory
669 static int mdc800_device_release (struct inode* inode, struct file *file)
672 dbg ("Mustek MDC800 device closed.");
674 mutex_lock(&mdc800->io_lock);
675 if (mdc800->open && (mdc800->state != NOT_CONNECTED))
677 usb_kill_urb(mdc800->irq_urb);
678 usb_kill_urb(mdc800->write_urb);
679 usb_kill_urb(mdc800->download_urb);
687 mutex_unlock(&mdc800->io_lock);
693 * The Device read callback Function
695 static ssize_t mdc800_device_read (struct file *file, char __user *buf, size_t len, loff_t *pos)
697 size_t left=len, sts=len; /* single transfer size */
698 char __user *ptr = buf;
701 mutex_lock(&mdc800->io_lock);
702 if (mdc800->state == NOT_CONNECTED)
704 mutex_unlock(&mdc800->io_lock);
707 if (mdc800->state == WORKING)
709 printk(KERN_WARNING "mdc800: Illegal State \"working\""
710 "reached during read ?!\n");
711 mutex_unlock(&mdc800->io_lock);
716 mutex_unlock(&mdc800->io_lock);
722 if (signal_pending (current))
724 mutex_unlock(&mdc800->io_lock);
728 sts=left > (mdc800->out_count-mdc800->out_ptr)?mdc800->out_count-mdc800->out_ptr:left;
732 /* Too less Data in buffer */
733 if (mdc800->state == DOWNLOAD)
738 /* Download -> Request new bytes */
739 mdc800->download_urb->dev = mdc800->dev;
740 retval = usb_submit_urb (mdc800->download_urb, GFP_KERNEL);
742 dev_err(&mdc800->dev->dev,
743 "Can't submit download urb "
744 "(retval=%i)\n", retval);
745 mutex_unlock(&mdc800->io_lock);
748 wait_event_timeout(mdc800->download_wait, mdc800->downloaded,
749 TO_DOWNLOAD_GET_READY*HZ/1000);
750 mdc800->downloaded = 0;
751 if (mdc800->download_urb->status != 0)
753 dev_err(&mdc800->dev->dev,
754 "request download-bytes fails "
756 mdc800->download_urb->status);
757 mutex_unlock(&mdc800->io_lock);
763 /* No more bytes -> that's an error*/
764 mutex_unlock(&mdc800->io_lock);
771 if (copy_to_user(ptr, &mdc800->out [mdc800->out_ptr],
773 mutex_unlock(&mdc800->io_lock);
778 mdc800->out_ptr+=sts;
782 mutex_unlock(&mdc800->io_lock);
788 * The Device write callback Function
789 * If a 8Byte Command is received, it will be send to the camera.
790 * After this the driver initiates the request for the answer or
791 * just waits until the camera becomes ready.
793 static ssize_t mdc800_device_write (struct file *file, const char __user *buf, size_t len, loff_t *pos)
798 mutex_lock(&mdc800->io_lock);
799 if (mdc800->state != READY)
801 mutex_unlock(&mdc800->io_lock);
806 mutex_unlock(&mdc800->io_lock);
813 if (signal_pending (current))
815 mutex_unlock(&mdc800->io_lock);
819 if(get_user(c, buf+i))
821 mutex_unlock(&mdc800->io_lock);
825 /* check for command start */
831 mdc800->download_left=0;
834 /* save command byte */
835 if (mdc800->in_count < 8)
837 mdc800->in[mdc800->in_count] = c;
842 mutex_unlock(&mdc800->io_lock);
846 /* Command Buffer full ? -> send it to camera */
847 if (mdc800->in_count == 8)
851 if (mdc800_usb_waitForIRQ (0,TO_GET_READY))
853 dev_err(&mdc800->dev->dev,
854 "Camera didn't get ready.\n");
855 mutex_unlock(&mdc800->io_lock);
859 answersize=mdc800_getAnswerSize (mdc800->in[1]);
861 mdc800->state=WORKING;
862 memcpy (mdc800->write_urb->transfer_buffer, mdc800->in,8);
863 mdc800->write_urb->dev = mdc800->dev;
864 retval = usb_submit_urb (mdc800->write_urb, GFP_KERNEL);
866 dev_err(&mdc800->dev->dev,
867 "submitting write urb fails "
868 "(retval=%i)\n", retval);
869 mutex_unlock(&mdc800->io_lock);
872 wait_event_timeout(mdc800->write_wait, mdc800->written, TO_WRITE_GET_READY*HZ/1000);
874 if (mdc800->state == WORKING)
876 usb_kill_urb(mdc800->write_urb);
877 mutex_unlock(&mdc800->io_lock);
881 switch ((unsigned char) mdc800->in[1])
883 case 0x05: /* Download Image */
884 case 0x3e: /* Take shot in Fine Mode (WCam Mode) */
885 if (mdc800->pic_len < 0)
887 dev_err(&mdc800->dev->dev,
891 mutex_unlock(&mdc800->io_lock);
896 case 0x09: /* Download Thumbnail */
897 mdc800->download_left=answersize+64;
898 mdc800->state=DOWNLOAD;
899 mdc800_usb_waitForIRQ (0,TO_DOWNLOAD_GET_BUSY);
907 if (mdc800_usb_waitForIRQ (1,TO_READ_FROM_IRQ))
909 dev_err(&mdc800->dev->dev, "requesting answer from irq fails\n");
910 mutex_unlock(&mdc800->io_lock);
914 /* Write dummy data, (this is ugly but part of the USB Protocol */
915 /* if you use endpoint 1 as bulk and not as irq) */
916 memcpy (mdc800->out, mdc800->camera_response,8);
918 /* This is the interpreted answer */
919 memcpy (&mdc800->out[8], mdc800->camera_response,8);
922 mdc800->out_count=16;
924 /* Cache the Imagesize, if command was getImageSize */
925 if (mdc800->in [1] == (char) 0x07)
927 mdc800->pic_len=(int) 65536*(unsigned char) mdc800->camera_response[0]+256*(unsigned char) mdc800->camera_response[1]+(unsigned char) mdc800->camera_response[2];
929 dbg ("cached imagesize = %i",mdc800->pic_len);
935 if (mdc800_usb_waitForIRQ (0,TO_DEFAULT_COMMAND))
937 dev_err(&mdc800->dev->dev, "Command Timeout.\n");
938 mutex_unlock(&mdc800->io_lock);
948 mutex_unlock(&mdc800->io_lock);
953 /***************************************************************************
954 Init and Cleanup this driver (Structs and types)
955 ****************************************************************************/
957 /* File Operations of this drivers */
958 static const struct file_operations mdc800_device_ops =
960 .owner = THIS_MODULE,
961 .read = mdc800_device_read,
962 .write = mdc800_device_write,
963 .open = mdc800_device_open,
964 .release = mdc800_device_release,
969 static struct usb_device_id mdc800_table [] = {
970 { USB_DEVICE(MDC800_VENDOR_ID, MDC800_PRODUCT_ID) },
971 { } /* Terminating entry */
974 MODULE_DEVICE_TABLE (usb, mdc800_table);
976 * USB Driver Struct for this device
978 static struct usb_driver mdc800_usb_driver =
981 .probe = mdc800_usb_probe,
982 .disconnect = mdc800_usb_disconnect,
983 .id_table = mdc800_table
988 /************************************************************************
989 Init and Cleanup this driver (Main Functions)
990 *************************************************************************/
992 static int __init usb_mdc800_init (void)
994 int retval = -ENODEV;
995 /* Allocate Memory */
996 mdc800=kzalloc (sizeof (struct mdc800_data), GFP_KERNEL);
998 goto cleanup_on_fail;
1001 mdc800->state=NOT_CONNECTED;
1002 mutex_init (&mdc800->io_lock);
1004 init_waitqueue_head (&mdc800->irq_wait);
1005 init_waitqueue_head (&mdc800->write_wait);
1006 init_waitqueue_head (&mdc800->download_wait);
1008 mdc800->irq_woken = 0;
1009 mdc800->downloaded = 0;
1010 mdc800->written = 0;
1012 mdc800->irq_urb_buffer=kmalloc (8, GFP_KERNEL);
1013 if (!mdc800->irq_urb_buffer)
1014 goto cleanup_on_fail;
1015 mdc800->write_urb_buffer=kmalloc (8, GFP_KERNEL);
1016 if (!mdc800->write_urb_buffer)
1017 goto cleanup_on_fail;
1018 mdc800->download_urb_buffer=kmalloc (64, GFP_KERNEL);
1019 if (!mdc800->download_urb_buffer)
1020 goto cleanup_on_fail;
1022 mdc800->irq_urb=usb_alloc_urb (0, GFP_KERNEL);
1023 if (!mdc800->irq_urb)
1024 goto cleanup_on_fail;
1025 mdc800->download_urb=usb_alloc_urb (0, GFP_KERNEL);
1026 if (!mdc800->download_urb)
1027 goto cleanup_on_fail;
1028 mdc800->write_urb=usb_alloc_urb (0, GFP_KERNEL);
1029 if (!mdc800->write_urb)
1030 goto cleanup_on_fail;
1032 /* Register the driver */
1033 retval = usb_register(&mdc800_usb_driver);
1035 goto cleanup_on_fail;
1037 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1042 /* Clean driver up, when something fails */
1048 printk(KERN_ERR "mdc800: can't alloc memory!\n");
1050 kfree(mdc800->download_urb_buffer);
1051 kfree(mdc800->write_urb_buffer);
1052 kfree(mdc800->irq_urb_buffer);
1054 usb_free_urb(mdc800->write_urb);
1055 usb_free_urb(mdc800->download_urb);
1056 usb_free_urb(mdc800->irq_urb);
1065 static void __exit usb_mdc800_cleanup (void)
1067 usb_deregister (&mdc800_usb_driver);
1069 usb_free_urb (mdc800->irq_urb);
1070 usb_free_urb (mdc800->download_urb);
1071 usb_free_urb (mdc800->write_urb);
1073 kfree (mdc800->irq_urb_buffer);
1074 kfree (mdc800->write_urb_buffer);
1075 kfree (mdc800->download_urb_buffer);
1081 module_init (usb_mdc800_init);
1082 module_exit (usb_mdc800_cleanup);
1084 MODULE_AUTHOR( DRIVER_AUTHOR );
1085 MODULE_DESCRIPTION( DRIVER_DESC );
1086 MODULE_LICENSE("GPL");