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 timeout = msec*HZ/1000;
321 while (!mdc800->irq_woken && timeout)
323 set_current_state(TASK_UNINTERRUPTIBLE);
324 timeout = schedule_timeout (timeout);
326 remove_wait_queue(&mdc800->irq_wait, &wait);
327 mdc800->irq_woken = 0;
329 if (mdc800->camera_request_ready>0)
331 mdc800->camera_request_ready=0;
332 err ("timeout waiting for camera.");
336 if (mdc800->state == NOT_CONNECTED)
338 warn ("Camera gets disconnected during waiting for irq.");
339 mdc800->camera_request_ready=0;
348 * The write_urb callback function
350 static void mdc800_usb_write_notify (struct urb *urb, struct pt_regs *res)
352 struct mdc800_data* mdc800=urb->context;
354 if (urb->status != 0)
356 err ("writing command fails (status=%i)", urb->status);
363 wake_up_interruptible (&mdc800->write_wait);
368 * The download_urb callback function
370 static void mdc800_usb_download_notify (struct urb *urb, struct pt_regs *res)
372 struct mdc800_data* mdc800=urb->context;
374 if (urb->status == 0)
376 /* Fill output buffer with these data */
377 memcpy (mdc800->out, urb->transfer_buffer, 64);
378 mdc800->out_count=64;
380 mdc800->download_left-=64;
381 if (mdc800->download_left == 0)
388 err ("request bytes fails (status:%i)", urb->status);
390 mdc800->downloaded = 1;
391 wake_up_interruptible (&mdc800->download_wait);
395 /***************************************************************************
396 Probing for the Camera
397 ***************************************************************************/
399 static struct usb_driver mdc800_usb_driver;
400 static struct file_operations mdc800_device_ops;
401 static struct usb_class_driver mdc800_class = {
402 .name = "usb/mdc800%d",
403 .fops = &mdc800_device_ops,
404 .mode = S_IFCHR | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP,
405 .minor_base = MDC800_DEVICE_MINOR_BASE,
410 * Callback to search the Mustek MDC800 on the USB Bus
412 static int mdc800_usb_probe (struct usb_interface *intf,
413 const struct usb_device_id *id)
416 struct usb_host_interface *intf_desc;
417 struct usb_device *dev = interface_to_usbdev (intf);
421 dbg ("(mdc800_usb_probe) called.");
424 if (mdc800->dev != 0)
426 warn ("only one Mustek MDC800 is supported.");
430 if (dev->descriptor.bNumConfigurations != 1)
432 err ("probe fails -> wrong Number of Configuration");
435 intf_desc = intf->cur_altsetting;
438 ( intf_desc->desc.bInterfaceClass != 0xff )
439 || ( intf_desc->desc.bInterfaceSubClass != 0 )
440 || ( intf_desc->desc.bInterfaceProtocol != 0 )
441 || ( intf_desc->desc.bNumEndpoints != 4)
444 err ("probe fails -> wrong Interface");
448 /* Check the Endpoints */
451 mdc800->endpoint[i]=-1;
454 if (mdc800_endpoint_equals (&intf_desc->endpoint [j].desc,&mdc800_ed [i]))
456 mdc800->endpoint[i]=intf_desc->endpoint [j].desc.bEndpointAddress ;
459 irq_interval=intf_desc->endpoint [j].desc.bInterval;
465 if (mdc800->endpoint[i] == -1)
467 err ("probe fails -> Wrong Endpoints.");
473 info ("Found Mustek MDC800 on USB.");
475 down (&mdc800->io_lock);
477 retval = usb_register_dev(intf, &mdc800_class);
479 err ("Not able to get a minor for this device.");
486 /* Setup URB Structs */
490 usb_rcvintpipe (mdc800->dev,mdc800->endpoint [1]),
491 mdc800->irq_urb_buffer,
501 usb_sndbulkpipe (mdc800->dev, mdc800->endpoint[0]),
502 mdc800->write_urb_buffer,
504 mdc800_usb_write_notify,
509 mdc800->download_urb,
511 usb_rcvbulkpipe (mdc800->dev, mdc800->endpoint [3]),
512 mdc800->download_urb_buffer,
514 mdc800_usb_download_notify,
520 up (&mdc800->io_lock);
522 usb_set_intfdata(intf, mdc800);
528 * Disconnect USB device (maybe the MDC800)
530 static void mdc800_usb_disconnect (struct usb_interface *intf)
532 struct mdc800_data* mdc800 = usb_get_intfdata(intf);
534 dbg ("(mdc800_usb_disconnect) called");
537 if (mdc800->state == NOT_CONNECTED)
540 usb_deregister_dev(intf, &mdc800_class);
542 mdc800->state=NOT_CONNECTED;
544 usb_kill_urb(mdc800->irq_urb);
545 usb_kill_urb(mdc800->write_urb);
546 usb_kill_urb(mdc800->download_urb);
549 usb_set_intfdata(intf, NULL);
551 info ("Mustek MDC800 disconnected from USB.");
555 /***************************************************************************
556 The Misc device Part (file_operations)
557 ****************************************************************************/
560 * This Function calc the Answersize for a command.
562 static int mdc800_getAnswerSize (char command)
564 switch ((unsigned char) command)
579 return mdc800->pic_len;
591 * Init the device: (1) alloc mem (2) Increase MOD Count ..
593 static int mdc800_device_open (struct inode* inode, struct file *file)
598 down (&mdc800->io_lock);
600 if (mdc800->state == NOT_CONNECTED)
616 mdc800->download_left=0;
618 mdc800->camera_busy=0;
619 mdc800->camera_request_ready=0;
622 mdc800->irq_urb->dev = mdc800->dev;
623 if (usb_submit_urb (mdc800->irq_urb, GFP_KERNEL))
625 err ("request USB irq fails (submit_retval=%i urb_status=%i).",retval, mdc800->irq_urb->status);
631 dbg ("Mustek MDC800 device opened.");
634 up (&mdc800->io_lock);
640 * Close the Camera and release Memory
642 static int mdc800_device_release (struct inode* inode, struct file *file)
645 dbg ("Mustek MDC800 device closed.");
647 down (&mdc800->io_lock);
648 if (mdc800->open && (mdc800->state != NOT_CONNECTED))
650 usb_kill_urb(mdc800->irq_urb);
651 usb_kill_urb(mdc800->write_urb);
652 usb_kill_urb(mdc800->download_urb);
660 up(&mdc800->io_lock);
666 * The Device read callback Function
668 static ssize_t mdc800_device_read (struct file *file, char __user *buf, size_t len, loff_t *pos)
670 size_t left=len, sts=len; /* single transfer size */
671 char __user *ptr = buf;
673 DECLARE_WAITQUEUE(wait, current);
675 down (&mdc800->io_lock);
676 if (mdc800->state == NOT_CONNECTED)
678 up (&mdc800->io_lock);
681 if (mdc800->state == WORKING)
683 warn ("Illegal State \"working\" reached during read ?!");
684 up (&mdc800->io_lock);
689 up (&mdc800->io_lock);
695 if (signal_pending (current))
697 up (&mdc800->io_lock);
701 sts=left > (mdc800->out_count-mdc800->out_ptr)?mdc800->out_count-mdc800->out_ptr:left;
705 /* Too less Data in buffer */
706 if (mdc800->state == DOWNLOAD)
711 /* Download -> Request new bytes */
712 mdc800->download_urb->dev = mdc800->dev;
713 if (usb_submit_urb (mdc800->download_urb, GFP_KERNEL))
715 err ("Can't submit download urb (status=%i)",mdc800->download_urb->status);
716 up (&mdc800->io_lock);
719 add_wait_queue(&mdc800->download_wait, &wait);
720 timeout = TO_DOWNLOAD_GET_READY*HZ/1000;
721 while (!mdc800->downloaded && timeout)
723 set_current_state(TASK_UNINTERRUPTIBLE);
724 timeout = schedule_timeout (timeout);
726 remove_wait_queue(&mdc800->download_wait, &wait);
727 mdc800->downloaded = 0;
728 if (mdc800->download_urb->status != 0)
730 err ("request download-bytes fails (status=%i)",mdc800->download_urb->status);
731 up (&mdc800->io_lock);
737 /* No more bytes -> that's an error*/
738 up (&mdc800->io_lock);
745 if (copy_to_user(ptr, &mdc800->out [mdc800->out_ptr],
747 up(&mdc800->io_lock);
752 mdc800->out_ptr+=sts;
756 up (&mdc800->io_lock);
762 * The Device write callback Function
763 * If a 8Byte Command is received, it will be send to the camera.
764 * After this the driver initiates the request for the answer or
765 * just waits until the camera becomes ready.
767 static ssize_t mdc800_device_write (struct file *file, const char __user *buf, size_t len, loff_t *pos)
770 DECLARE_WAITQUEUE(wait, current);
772 down (&mdc800->io_lock);
773 if (mdc800->state != READY)
775 up (&mdc800->io_lock);
780 up (&mdc800->io_lock);
787 if (signal_pending (current))
789 up (&mdc800->io_lock);
793 if(get_user(c, buf+i))
795 up(&mdc800->io_lock);
799 /* check for command start */
805 mdc800->download_left=0;
808 /* save command byte */
809 if (mdc800->in_count < 8)
811 mdc800->in[mdc800->in_count] = c;
816 up (&mdc800->io_lock);
820 /* Command Buffer full ? -> send it to camera */
821 if (mdc800->in_count == 8)
826 if (mdc800_usb_waitForIRQ (0,TO_GET_READY))
828 err ("Camera didn't get ready.\n");
829 up (&mdc800->io_lock);
833 answersize=mdc800_getAnswerSize (mdc800->in[1]);
835 mdc800->state=WORKING;
836 memcpy (mdc800->write_urb->transfer_buffer, mdc800->in,8);
837 mdc800->write_urb->dev = mdc800->dev;
838 if (usb_submit_urb (mdc800->write_urb, GFP_KERNEL))
840 err ("submitting write urb fails (status=%i)", mdc800->write_urb->status);
841 up (&mdc800->io_lock);
844 add_wait_queue(&mdc800->write_wait, &wait);
845 timeout = TO_WRITE_GET_READY*HZ/1000;
846 while (!mdc800->written && timeout)
848 set_current_state(TASK_UNINTERRUPTIBLE);
849 timeout = schedule_timeout (timeout);
851 remove_wait_queue(&mdc800->write_wait, &wait);
853 if (mdc800->state == WORKING)
855 usb_kill_urb(mdc800->write_urb);
856 up (&mdc800->io_lock);
860 switch ((unsigned char) mdc800->in[1])
862 case 0x05: /* Download Image */
863 case 0x3e: /* Take shot in Fine Mode (WCam Mode) */
864 if (mdc800->pic_len < 0)
866 err ("call 0x07 before 0x05,0x3e");
868 up (&mdc800->io_lock);
873 case 0x09: /* Download Thumbnail */
874 mdc800->download_left=answersize+64;
875 mdc800->state=DOWNLOAD;
876 mdc800_usb_waitForIRQ (0,TO_DOWNLOAD_GET_BUSY);
884 if (mdc800_usb_waitForIRQ (1,TO_READ_FROM_IRQ))
886 err ("requesting answer from irq fails");
887 up (&mdc800->io_lock);
891 /* Write dummy data, (this is ugly but part of the USB Protocol */
892 /* if you use endpoint 1 as bulk and not as irq) */
893 memcpy (mdc800->out, mdc800->camera_response,8);
895 /* This is the interpreted answer */
896 memcpy (&mdc800->out[8], mdc800->camera_response,8);
899 mdc800->out_count=16;
901 /* Cache the Imagesize, if command was getImageSize */
902 if (mdc800->in [1] == (char) 0x07)
904 mdc800->pic_len=(int) 65536*(unsigned char) mdc800->camera_response[0]+256*(unsigned char) mdc800->camera_response[1]+(unsigned char) mdc800->camera_response[2];
906 dbg ("cached imagesize = %i",mdc800->pic_len);
912 if (mdc800_usb_waitForIRQ (0,TO_DEFAULT_COMMAND))
914 err ("Command Timeout.");
915 up (&mdc800->io_lock);
925 up (&mdc800->io_lock);
930 /***************************************************************************
931 Init and Cleanup this driver (Structs and types)
932 ****************************************************************************/
934 /* File Operations of this drivers */
935 static struct file_operations mdc800_device_ops =
937 .owner = THIS_MODULE,
938 .read = mdc800_device_read,
939 .write = mdc800_device_write,
940 .open = mdc800_device_open,
941 .release = mdc800_device_release,
946 static struct usb_device_id mdc800_table [] = {
947 { USB_DEVICE(MDC800_VENDOR_ID, MDC800_PRODUCT_ID) },
948 { } /* Terminating entry */
951 MODULE_DEVICE_TABLE (usb, mdc800_table);
953 * USB Driver Struct for this device
955 static struct usb_driver mdc800_usb_driver =
957 .owner = THIS_MODULE,
959 .probe = mdc800_usb_probe,
960 .disconnect = mdc800_usb_disconnect,
961 .id_table = mdc800_table
966 /************************************************************************
967 Init and Cleanup this driver (Main Functions)
968 *************************************************************************/
970 #define try(A) if (!(A)) goto cleanup_on_fail;
972 static int __init usb_mdc800_init (void)
974 int retval = -ENODEV;
975 /* Allocate Memory */
976 try (mdc800=kmalloc (sizeof (struct mdc800_data), GFP_KERNEL));
978 memset(mdc800, 0, sizeof(struct mdc800_data));
981 mdc800->state=NOT_CONNECTED;
982 init_MUTEX (&mdc800->io_lock);
984 init_waitqueue_head (&mdc800->irq_wait);
985 init_waitqueue_head (&mdc800->write_wait);
986 init_waitqueue_head (&mdc800->download_wait);
988 mdc800->irq_woken = 0;
989 mdc800->downloaded = 0;
992 try (mdc800->irq_urb_buffer=kmalloc (8, GFP_KERNEL));
993 try (mdc800->write_urb_buffer=kmalloc (8, GFP_KERNEL));
994 try (mdc800->download_urb_buffer=kmalloc (64, GFP_KERNEL));
996 try (mdc800->irq_urb=usb_alloc_urb (0, GFP_KERNEL));
997 try (mdc800->download_urb=usb_alloc_urb (0, GFP_KERNEL));
998 try (mdc800->write_urb=usb_alloc_urb (0, GFP_KERNEL));
1000 /* Register the driver */
1001 retval = usb_register(&mdc800_usb_driver);
1003 goto cleanup_on_fail;
1005 info (DRIVER_VERSION ":" DRIVER_DESC);
1009 /* Clean driver up, when something fails */
1015 err ("can't alloc memory!");
1017 kfree(mdc800->download_urb_buffer);
1018 kfree(mdc800->write_urb_buffer);
1019 kfree(mdc800->irq_urb_buffer);
1021 usb_free_urb(mdc800->write_urb);
1022 usb_free_urb(mdc800->download_urb);
1023 usb_free_urb(mdc800->irq_urb);
1032 static void __exit usb_mdc800_cleanup (void)
1034 usb_deregister (&mdc800_usb_driver);
1036 usb_free_urb (mdc800->irq_urb);
1037 usb_free_urb (mdc800->download_urb);
1038 usb_free_urb (mdc800->write_urb);
1040 kfree (mdc800->irq_urb_buffer);
1041 kfree (mdc800->write_urb_buffer);
1042 kfree (mdc800->download_urb_buffer);
1048 module_init (usb_mdc800_init);
1049 module_exit (usb_mdc800_cleanup);
1051 MODULE_AUTHOR( DRIVER_AUTHOR );
1052 MODULE_DESCRIPTION( DRIVER_DESC );
1053 MODULE_LICENSE("GPL");