2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2, or (at your option)
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 #include <linux/kernel.h>
18 #include <linux/sched.h>
19 #include <linux/list.h>
20 #include <linux/slab.h>
21 #include <linux/module.h>
23 #include <linux/smp_lock.h>
24 #include <linux/vmalloc.h>
25 #include <linux/init.h>
26 #include <linux/spinlock.h>
33 #define virt_to_page(v) MAP_NR(v) /* Kernels 2.2.x */
36 static int video_nr
= -1;
37 module_param(video_nr
, int, 0);
42 static void usbvideo_Disconnect(struct usb_interface
*intf
);
43 static void usbvideo_CameraRelease(struct uvd
*uvd
);
45 static int usbvideo_v4l_ioctl(struct inode
*inode
, struct file
*file
,
46 unsigned int cmd
, unsigned long arg
);
47 static int usbvideo_v4l_mmap(struct file
*file
, struct vm_area_struct
*vma
);
48 static int usbvideo_v4l_open(struct inode
*inode
, struct file
*file
);
49 static ssize_t
usbvideo_v4l_read(struct file
*file
, char __user
*buf
,
50 size_t count
, loff_t
*ppos
);
51 static int usbvideo_v4l_close(struct inode
*inode
, struct file
*file
);
53 static int usbvideo_StartDataPump(struct uvd
*uvd
);
54 static void usbvideo_StopDataPump(struct uvd
*uvd
);
55 static int usbvideo_GetFrame(struct uvd
*uvd
, int frameNum
);
56 static int usbvideo_NewFrame(struct uvd
*uvd
, int framenum
);
57 static void usbvideo_SoftwareContrastAdjustment(struct uvd
*uvd
,
58 struct usbvideo_frame
*frame
);
60 /*******************************/
61 /* Memory management functions */
62 /*******************************/
63 static void *usbvideo_rvmalloc(unsigned long size
)
68 size
= PAGE_ALIGN(size
);
69 mem
= vmalloc_32(size
);
73 memset(mem
, 0, size
); /* Clear the ram out, no junk to the user */
74 adr
= (unsigned long) mem
;
76 SetPageReserved(vmalloc_to_page((void *)adr
));
84 static void usbvideo_rvfree(void *mem
, unsigned long size
)
91 adr
= (unsigned long) mem
;
92 while ((long) size
> 0) {
93 ClearPageReserved(vmalloc_to_page((void *)adr
));
100 static void RingQueue_Initialize(struct RingQueue
*rq
)
103 init_waitqueue_head(&rq
->wqh
);
106 static void RingQueue_Allocate(struct RingQueue
*rq
, int rqLen
)
108 /* Make sure the requested size is a power of 2 and
109 round up if necessary. This allows index wrapping
110 using masks rather than modulo */
118 if(rqLen
!= 1 << (i
-1))
123 rq
->queue
= usbvideo_rvmalloc(rq
->length
);
124 assert(rq
->queue
!= NULL
);
127 static int RingQueue_IsAllocated(const struct RingQueue
*rq
)
131 return (rq
->queue
!= NULL
) && (rq
->length
> 0);
134 static void RingQueue_Free(struct RingQueue
*rq
)
137 if (RingQueue_IsAllocated(rq
)) {
138 usbvideo_rvfree(rq
->queue
, rq
->length
);
144 int RingQueue_Dequeue(struct RingQueue
*rq
, unsigned char *dst
, int len
)
151 rql
= RingQueue_GetLength(rq
);
155 /* Clip requested length to available data */
160 if(rq
->ri
> rq
->wi
) {
161 /* Read data from tail */
162 int read
= (toread
< (rq
->length
- rq
->ri
)) ? toread
: rq
->length
- rq
->ri
;
163 memcpy(dst
, rq
->queue
+ rq
->ri
, read
);
166 rq
->ri
= (rq
->ri
+ read
) & (rq
->length
-1);
169 /* Read data from head */
170 memcpy(dst
, rq
->queue
+ rq
->ri
, toread
);
171 rq
->ri
= (rq
->ri
+ toread
) & (rq
->length
-1);
176 EXPORT_SYMBOL(RingQueue_Dequeue
);
178 int RingQueue_Enqueue(struct RingQueue
*rq
, const unsigned char *cdata
, int n
)
183 assert(cdata
!= NULL
);
184 assert(rq
->length
> 0);
188 /* Calculate the largest chunk that fits the tail of the ring */
189 q_avail
= rq
->length
- rq
->wi
;
192 q_avail
= rq
->length
;
199 memcpy(rq
->queue
+ rq
->wi
, cdata
, m
);
200 RING_QUEUE_ADVANCE_INDEX(rq
, wi
, m
);
208 EXPORT_SYMBOL(RingQueue_Enqueue
);
210 static void RingQueue_InterruptibleSleepOn(struct RingQueue
*rq
)
213 interruptible_sleep_on(&rq
->wqh
);
216 void RingQueue_WakeUpInterruptible(struct RingQueue
*rq
)
219 if (waitqueue_active(&rq
->wqh
))
220 wake_up_interruptible(&rq
->wqh
);
223 EXPORT_SYMBOL(RingQueue_WakeUpInterruptible
);
225 void RingQueue_Flush(struct RingQueue
*rq
)
232 EXPORT_SYMBOL(RingQueue_Flush
);
236 * usbvideo_VideosizeToString()
238 * This procedure converts given videosize value to readable string.
241 * 07-Aug-2000 Created.
242 * 19-Oct-2000 Reworked for usbvideo module.
244 static void usbvideo_VideosizeToString(char *buf
, int bufLen
, videosize_t vs
)
249 n
= 1 + sprintf(tmp
, "%ldx%ld", VIDEOSIZE_X(vs
), VIDEOSIZE_Y(vs
));
250 assert(n
< sizeof(tmp
));
251 if ((buf
== NULL
) || (bufLen
< n
))
252 err("usbvideo_VideosizeToString: buffer is too small.");
254 memmove(buf
, tmp
, n
);
258 * usbvideo_OverlayChar()
261 * 01-Feb-2000 Created.
263 static void usbvideo_OverlayChar(struct uvd
*uvd
, struct usbvideo_frame
*frame
,
264 int x
, int y
, int ch
)
266 static const unsigned short digits
[16] = {
284 unsigned short digit
;
287 if ((uvd
== NULL
) || (frame
== NULL
))
290 if (ch
>= '0' && ch
<= '9')
292 else if (ch
>= 'A' && ch
<= 'F')
293 ch
= 10 + (ch
- 'A');
294 else if (ch
>= 'a' && ch
<= 'f')
295 ch
= 10 + (ch
- 'a');
300 for (iy
=0; iy
< 5; iy
++) {
301 for (ix
=0; ix
< 3; ix
++) {
302 if (digit
& 0x8000) {
303 if (uvd
->paletteBits
& (1L << VIDEO_PALETTE_RGB24
)) {
304 /* TODO */ RGB24_PUTPIXEL(frame
, x
+ix
, y
+iy
, 0xFF, 0xFF, 0xFF);
313 * usbvideo_OverlayString()
316 * 01-Feb-2000 Created.
318 static void usbvideo_OverlayString(struct uvd
*uvd
, struct usbvideo_frame
*frame
,
319 int x
, int y
, const char *str
)
322 usbvideo_OverlayChar(uvd
, frame
, x
, y
, *str
);
324 x
+= 4; /* 3 pixels character + 1 space */
329 * usbvideo_OverlayStats()
331 * Overlays important debugging information.
334 * 01-Feb-2000 Created.
336 static void usbvideo_OverlayStats(struct uvd
*uvd
, struct usbvideo_frame
*frame
)
338 const int y_diff
= 8;
341 long i
, j
, barLength
;
342 const int qi_x1
= 60, qi_y1
= 10;
343 const int qi_x2
= VIDEOSIZE_X(frame
->request
) - 10, qi_h
= 10;
345 /* Call the user callback, see if we may proceed after that */
346 if (VALID_CALLBACK(uvd
, overlayHook
)) {
347 if (GET_CALLBACK(uvd
, overlayHook
)(uvd
, frame
) < 0)
352 * We draw a (mostly) hollow rectangle with qi_xxx coordinates.
353 * Left edge symbolizes the queue index 0; right edge symbolizes
354 * the full capacity of the queue.
356 barLength
= qi_x2
- qi_x1
- 2;
357 if ((barLength
> 10) && (uvd
->paletteBits
& (1L << VIDEO_PALETTE_RGB24
))) {
358 /* TODO */ long u_lo
, u_hi
, q_used
;
359 long m_ri
, m_wi
, m_lo
, m_hi
;
362 * Determine fill zones (used areas of the queue):
363 * 0 xxxxxxx u_lo ...... uvd->dp.ri xxxxxxxx u_hi ..... uvd->dp.length
365 * if u_lo < 0 then there is no first filler.
368 q_used
= RingQueue_GetLength(&uvd
->dp
);
369 if ((uvd
->dp
.ri
+ q_used
) >= uvd
->dp
.length
) {
370 u_hi
= uvd
->dp
.length
;
371 u_lo
= (q_used
+ uvd
->dp
.ri
) & (uvd
->dp
.length
-1);
373 u_hi
= (q_used
+ uvd
->dp
.ri
);
377 /* Convert byte indices into screen units */
378 m_ri
= qi_x1
+ ((barLength
* uvd
->dp
.ri
) / uvd
->dp
.length
);
379 m_wi
= qi_x1
+ ((barLength
* uvd
->dp
.wi
) / uvd
->dp
.length
);
380 m_lo
= (u_lo
> 0) ? (qi_x1
+ ((barLength
* u_lo
) / uvd
->dp
.length
)) : -1;
381 m_hi
= qi_x1
+ ((barLength
* u_hi
) / uvd
->dp
.length
);
383 for (j
=qi_y1
; j
< (qi_y1
+ qi_h
); j
++) {
384 for (i
=qi_x1
; i
< qi_x2
; i
++) {
385 /* Draw border lines */
386 if ((j
== qi_y1
) || (j
== (qi_y1
+ qi_h
- 1)) ||
387 (i
== qi_x1
) || (i
== (qi_x2
- 1))) {
388 RGB24_PUTPIXEL(frame
, i
, j
, 0xFF, 0xFF, 0xFF);
391 /* For all other points the Y coordinate does not matter */
392 if ((i
>= m_ri
) && (i
<= (m_ri
+ 3))) {
393 RGB24_PUTPIXEL(frame
, i
, j
, 0x00, 0xFF, 0x00);
394 } else if ((i
>= m_wi
) && (i
<= (m_wi
+ 3))) {
395 RGB24_PUTPIXEL(frame
, i
, j
, 0xFF, 0x00, 0x00);
396 } else if ((i
< m_lo
) || ((i
> m_ri
) && (i
< m_hi
)))
397 RGB24_PUTPIXEL(frame
, i
, j
, 0x00, 0x00, 0xFF);
402 sprintf(tmp
, "%8lx", uvd
->stats
.frame_num
);
403 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
406 sprintf(tmp
, "%8lx", uvd
->stats
.urb_count
);
407 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
410 sprintf(tmp
, "%8lx", uvd
->stats
.urb_length
);
411 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
414 sprintf(tmp
, "%8lx", uvd
->stats
.data_count
);
415 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
418 sprintf(tmp
, "%8lx", uvd
->stats
.header_count
);
419 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
422 sprintf(tmp
, "%8lx", uvd
->stats
.iso_skip_count
);
423 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
426 sprintf(tmp
, "%8lx", uvd
->stats
.iso_err_count
);
427 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
430 sprintf(tmp
, "%8x", uvd
->vpic
.colour
);
431 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
434 sprintf(tmp
, "%8x", uvd
->vpic
.hue
);
435 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
438 sprintf(tmp
, "%8x", uvd
->vpic
.brightness
>> 8);
439 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
442 sprintf(tmp
, "%8x", uvd
->vpic
.contrast
>> 12);
443 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
446 sprintf(tmp
, "%8d", uvd
->vpic
.whiteness
>> 8);
447 usbvideo_OverlayString(uvd
, frame
, x
, y
, tmp
);
452 * usbvideo_ReportStatistics()
454 * This procedure prints packet and transfer statistics.
457 * 14-Jan-2000 Corrected default multiplier.
459 static void usbvideo_ReportStatistics(const struct uvd
*uvd
)
461 if ((uvd
!= NULL
) && (uvd
->stats
.urb_count
> 0)) {
462 unsigned long allPackets
, badPackets
, goodPackets
, percent
;
463 allPackets
= uvd
->stats
.urb_count
* CAMERA_URB_FRAMES
;
464 badPackets
= uvd
->stats
.iso_skip_count
+ uvd
->stats
.iso_err_count
;
465 goodPackets
= allPackets
- badPackets
;
466 /* Calculate percentage wisely, remember integer limits */
467 assert(allPackets
!= 0);
468 if (goodPackets
< (((unsigned long)-1)/100))
469 percent
= (100 * goodPackets
) / allPackets
;
471 percent
= goodPackets
/ (allPackets
/ 100);
472 info("Packet Statistics: Total=%lu. Empty=%lu. Usage=%lu%%",
473 allPackets
, badPackets
, percent
);
474 if (uvd
->iso_packet_len
> 0) {
475 unsigned long allBytes
, xferBytes
;
476 char multiplier
= ' ';
477 allBytes
= allPackets
* uvd
->iso_packet_len
;
478 xferBytes
= uvd
->stats
.data_count
;
479 assert(allBytes
!= 0);
480 if (xferBytes
< (((unsigned long)-1)/100))
481 percent
= (100 * xferBytes
) / allBytes
;
483 percent
= xferBytes
/ (allBytes
/ 100);
484 /* Scale xferBytes for easy reading */
485 if (xferBytes
> 10*1024) {
488 if (xferBytes
> 10*1024) {
491 if (xferBytes
> 10*1024) {
494 if (xferBytes
> 10*1024) {
501 info("Transfer Statistics: Transferred=%lu%cB Usage=%lu%%",
502 xferBytes
, multiplier
, percent
);
508 * usbvideo_TestPattern()
510 * Procedure forms a test pattern (yellow grid on blue background).
513 * fullframe: if TRUE then entire frame is filled, otherwise the procedure
514 * continues from the current scanline.
515 * pmode 0: fill the frame with solid blue color (like on VCR or TV)
516 * 1: Draw a colored grid
519 * 01-Feb-2000 Created.
521 void usbvideo_TestPattern(struct uvd
*uvd
, int fullframe
, int pmode
)
523 struct usbvideo_frame
*frame
;
526 static int num_pass
= 0;
529 err("%s: uvd == NULL", __FUNCTION__
);
532 if ((uvd
->curframe
< 0) || (uvd
->curframe
>= USBVIDEO_NUMFRAMES
)) {
533 err("%s: uvd->curframe=%d.", __FUNCTION__
, uvd
->curframe
);
537 /* Grab the current frame */
538 frame
= &uvd
->frame
[uvd
->curframe
];
540 /* Optionally start at the beginning */
543 frame
->seqRead_Length
= 0;
546 { /* For debugging purposes only */
548 usbvideo_VideosizeToString(tmp
, sizeof(tmp
), frame
->request
);
549 info("testpattern: frame=%s", tmp
);
552 /* Form every scan line */
553 for (; frame
->curline
< VIDEOSIZE_Y(frame
->request
); frame
->curline
++) {
555 unsigned char *f
= frame
->data
+
556 (VIDEOSIZE_X(frame
->request
) * V4L_BYTES_PER_PIXEL
* frame
->curline
);
557 for (i
=0; i
< VIDEOSIZE_X(frame
->request
); i
++) {
558 unsigned char cb
=0x80;
559 unsigned char cg
= 0;
560 unsigned char cr
= 0;
563 if (frame
->curline
% 32 == 0)
564 cb
= 0, cg
= cr
= 0xFF;
565 else if (i
% 32 == 0) {
566 if (frame
->curline
% 32 == 1)
568 cb
= 0, cg
= cr
= 0xFF;
570 cb
= ((num_cell
*7) + num_pass
) & 0xFF;
571 cg
= ((num_cell
*5) + num_pass
*2) & 0xFF;
572 cr
= ((num_cell
*3) + num_pass
*3) & 0xFF;
575 /* Just the blue screen */
585 frame
->frameState
= FrameState_Done
;
586 frame
->seqRead_Length
+= scan_length
;
589 /* We do this unconditionally, regardless of FLAGS_OVERLAY_STATS */
590 usbvideo_OverlayStats(uvd
, frame
);
593 EXPORT_SYMBOL(usbvideo_TestPattern
);
600 * A debugging tool. Prints hex dumps.
603 * 29-Jul-2000 Added printing of offsets.
605 void usbvideo_HexDump(const unsigned char *data
, int len
)
607 const int bytes_per_line
= 32;
608 char tmp
[128]; /* 32*3 + 5 */
611 for (i
=k
=0; len
> 0; i
++, len
--) {
612 if (i
> 0 && ((i
% bytes_per_line
) == 0)) {
616 if ((i
% bytes_per_line
) == 0)
617 k
+= sprintf(&tmp
[k
], "%04x: ", i
);
618 k
+= sprintf(&tmp
[k
], "%02x ", data
[i
]);
624 EXPORT_SYMBOL(usbvideo_HexDump
);
628 /* ******************************************************************** */
630 /* XXX: this piece of crap really wants some error handling.. */
631 static void usbvideo_ClientIncModCount(struct uvd
*uvd
)
634 err("%s: uvd == NULL", __FUNCTION__
);
637 if (uvd
->handle
== NULL
) {
638 err("%s: uvd->handle == NULL", __FUNCTION__
);
641 if (uvd
->handle
->md_module
== NULL
) {
642 err("%s: uvd->handle->md_module == NULL", __FUNCTION__
);
645 if (!try_module_get(uvd
->handle
->md_module
)) {
646 err("%s: try_module_get() == 0", __FUNCTION__
);
651 static void usbvideo_ClientDecModCount(struct uvd
*uvd
)
654 err("%s: uvd == NULL", __FUNCTION__
);
657 if (uvd
->handle
== NULL
) {
658 err("%s: uvd->handle == NULL", __FUNCTION__
);
661 if (uvd
->handle
->md_module
== NULL
) {
662 err("%s: uvd->handle->md_module == NULL", __FUNCTION__
);
665 module_put(uvd
->handle
->md_module
);
668 int usbvideo_register(
669 struct usbvideo
**pCams
,
672 const char *driverName
,
673 const struct usbvideo_cb
*cbTbl
,
675 const struct usb_device_id
*id_table
)
677 struct usbvideo
*cams
;
678 int i
, base_size
, result
;
680 /* Check parameters for sanity */
681 if ((num_cams
<= 0) || (pCams
== NULL
) || (cbTbl
== NULL
)) {
682 err("%s: Illegal call", __FUNCTION__
);
686 /* Check registration callback - must be set! */
687 if (cbTbl
->probe
== NULL
) {
688 err("%s: probe() is required!", __FUNCTION__
);
692 base_size
= num_cams
* sizeof(struct uvd
) + sizeof(struct usbvideo
);
693 cams
= (struct usbvideo
*) kmalloc(base_size
, GFP_KERNEL
);
695 err("Failed to allocate %d. bytes for usbvideo struct", base_size
);
698 dbg("%s: Allocated $%p (%d. bytes) for %d. cameras",
699 __FUNCTION__
, cams
, base_size
, num_cams
);
700 memset(cams
, 0, base_size
);
702 /* Copy callbacks, apply defaults for those that are not set */
703 memmove(&cams
->cb
, cbTbl
, sizeof(cams
->cb
));
704 if (cams
->cb
.getFrame
== NULL
)
705 cams
->cb
.getFrame
= usbvideo_GetFrame
;
706 if (cams
->cb
.disconnect
== NULL
)
707 cams
->cb
.disconnect
= usbvideo_Disconnect
;
708 if (cams
->cb
.startDataPump
== NULL
)
709 cams
->cb
.startDataPump
= usbvideo_StartDataPump
;
710 if (cams
->cb
.stopDataPump
== NULL
)
711 cams
->cb
.stopDataPump
= usbvideo_StopDataPump
;
713 cams
->num_cameras
= num_cams
;
714 cams
->cam
= (struct uvd
*) &cams
[1];
715 cams
->md_module
= md
;
716 if (cams
->md_module
== NULL
)
717 warn("%s: module == NULL!", __FUNCTION__
);
718 init_MUTEX(&cams
->lock
); /* to 1 == available */
720 for (i
= 0; i
< num_cams
; i
++) {
721 struct uvd
*up
= &cams
->cam
[i
];
725 /* Allocate user_data separately because of kmalloc's limits */
727 up
->user_size
= num_cams
* num_extra
;
728 up
->user_data
= (char *) kmalloc(up
->user_size
, GFP_KERNEL
);
729 if (up
->user_data
== NULL
) {
730 err("%s: Failed to allocate user_data (%d. bytes)",
731 __FUNCTION__
, up
->user_size
);
733 up
= &cams
->cam
[--i
];
734 kfree(up
->user_data
);
739 dbg("%s: Allocated cams[%d].user_data=$%p (%d. bytes)",
740 __FUNCTION__
, i
, up
->user_data
, up
->user_size
);
745 * Register ourselves with USB stack.
747 strcpy(cams
->drvName
, (driverName
!= NULL
) ? driverName
: "Unknown");
748 cams
->usbdrv
.name
= cams
->drvName
;
749 cams
->usbdrv
.probe
= cams
->cb
.probe
;
750 cams
->usbdrv
.disconnect
= cams
->cb
.disconnect
;
751 cams
->usbdrv
.id_table
= id_table
;
754 * Update global handle to usbvideo. This is very important
755 * because probe() can be called before usb_register() returns.
756 * If the handle is not yet updated then the probe() will fail.
759 result
= usb_register(&cams
->usbdrv
);
761 for (i
= 0; i
< num_cams
; i
++) {
762 struct uvd
*up
= &cams
->cam
[i
];
763 kfree(up
->user_data
);
771 EXPORT_SYMBOL(usbvideo_register
);
774 * usbvideo_Deregister()
776 * Procedure frees all usbvideo and user data structures. Be warned that
777 * if you had some dynamically allocated components in ->user field then
778 * you should free them before calling here.
780 void usbvideo_Deregister(struct usbvideo
**pCams
)
782 struct usbvideo
*cams
;
786 err("%s: pCams == NULL", __FUNCTION__
);
791 err("%s: cams == NULL", __FUNCTION__
);
795 dbg("%s: Deregistering %s driver.", __FUNCTION__
, cams
->drvName
);
796 usb_deregister(&cams
->usbdrv
);
798 dbg("%s: Deallocating cams=$%p (%d. cameras)", __FUNCTION__
, cams
, cams
->num_cameras
);
799 for (i
=0; i
< cams
->num_cameras
; i
++) {
800 struct uvd
*up
= &cams
->cam
[i
];
803 if (up
->user_data
!= NULL
) {
804 if (up
->user_size
<= 0)
807 if (up
->user_size
> 0)
811 err("%s: Warning: user_data=$%p user_size=%d.",
812 __FUNCTION__
, up
->user_data
, up
->user_size
);
814 dbg("%s: Freeing %d. $%p->user_data=$%p",
815 __FUNCTION__
, i
, up
, up
->user_data
);
816 kfree(up
->user_data
);
819 /* Whole array was allocated in one chunk */
820 dbg("%s: Freed %d uvd structures",
821 __FUNCTION__
, cams
->num_cameras
);
826 EXPORT_SYMBOL(usbvideo_Deregister
);
829 * usbvideo_Disconnect()
831 * This procedure stops all driver activity. Deallocation of
832 * the interface-private structure (pointed by 'ptr') is done now
833 * (if we don't have any open files) or later, when those files
834 * are closed. After that driver should be removable.
836 * This code handles surprise removal. The uvd->user is a counter which
837 * increments on open() and decrements on close(). If we see here that
838 * this counter is not 0 then we have a client who still has us opened.
839 * We set uvd->remove_pending flag as early as possible, and after that
840 * all access to the camera will gracefully fail. These failures should
841 * prompt client to (eventually) close the video device, and then - in
842 * usbvideo_v4l_close() - we decrement uvd->uvd_used and usage counter.
845 * 22-Jan-2000 Added polling of MOD_IN_USE to delay removal until all users gone.
846 * 27-Jan-2000 Reworked to allow pending disconnects; see xxx_close()
847 * 24-May-2000 Corrected to prevent race condition (MOD_xxx_USE_COUNT).
848 * 19-Oct-2000 Moved to usbvideo module.
850 static void usbvideo_Disconnect(struct usb_interface
*intf
)
852 struct uvd
*uvd
= usb_get_intfdata (intf
);
856 err("%s($%p): Illegal call.", __FUNCTION__
, intf
);
860 usb_set_intfdata (intf
, NULL
);
862 usbvideo_ClientIncModCount(uvd
);
864 info("%s(%p.)", __FUNCTION__
, intf
);
867 uvd
->remove_pending
= 1; /* Now all ISO data will be ignored */
869 /* At this time we ask to cancel outstanding URBs */
870 GET_CALLBACK(uvd
, stopDataPump
)(uvd
);
872 for (i
=0; i
< USBVIDEO_NUMSBUF
; i
++)
873 usb_free_urb(uvd
->sbuf
[i
].urb
);
875 usb_put_dev(uvd
->dev
);
876 uvd
->dev
= NULL
; /* USB device is no more */
878 video_unregister_device(&uvd
->vdev
);
880 info("%s: Video unregistered.", __FUNCTION__
);
883 info("%s: In use, disconnect pending.", __FUNCTION__
);
885 usbvideo_CameraRelease(uvd
);
887 info("USB camera disconnected.");
889 usbvideo_ClientDecModCount(uvd
);
893 * usbvideo_CameraRelease()
895 * This code does final release of uvd. This happens
896 * after the device is disconnected -and- all clients
897 * closed their files.
900 * 27-Jan-2000 Created.
902 static void usbvideo_CameraRelease(struct uvd
*uvd
)
905 err("%s: Illegal call", __FUNCTION__
);
909 RingQueue_Free(&uvd
->dp
);
910 if (VALID_CALLBACK(uvd
, userFree
))
911 GET_CALLBACK(uvd
, userFree
)(uvd
);
912 uvd
->uvd_used
= 0; /* This is atomic, no need to take mutex */
916 * usbvideo_find_struct()
918 * This code searches the array of preallocated (static) structures
919 * and returns index of the first one that isn't in use. Returns -1
920 * if there are no free structures.
923 * 27-Jan-2000 Created.
925 static int usbvideo_find_struct(struct usbvideo
*cams
)
930 err("No usbvideo handle?");
934 for (u
= 0; u
< cams
->num_cameras
; u
++) {
935 struct uvd
*uvd
= &cams
->cam
[u
];
936 if (!uvd
->uvd_used
) /* This one is free */
938 uvd
->uvd_used
= 1; /* In use now */
939 init_MUTEX(&uvd
->lock
); /* to 1 == available */
949 static struct file_operations usbvideo_fops
= {
950 .owner
= THIS_MODULE
,
951 .open
= usbvideo_v4l_open
,
952 .release
=usbvideo_v4l_close
,
953 .read
= usbvideo_v4l_read
,
954 .mmap
= usbvideo_v4l_mmap
,
955 .ioctl
= usbvideo_v4l_ioctl
,
958 static struct video_device usbvideo_template
= {
959 .owner
= THIS_MODULE
,
960 .type
= VID_TYPE_CAPTURE
,
961 .hardware
= VID_HARDWARE_CPIA
,
962 .fops
= &usbvideo_fops
,
965 struct uvd
*usbvideo_AllocateDevice(struct usbvideo
*cams
)
968 struct uvd
*uvd
= NULL
;
971 err("No usbvideo handle?");
975 devnum
= usbvideo_find_struct(cams
);
977 err("IBM USB camera driver: Too many devices!");
980 uvd
= &cams
->cam
[devnum
];
981 dbg("Device entry #%d. at $%p", devnum
, uvd
);
983 /* Not relying upon caller we increase module counter ourselves */
984 usbvideo_ClientIncModCount(uvd
);
987 for (i
=0; i
< USBVIDEO_NUMSBUF
; i
++) {
988 uvd
->sbuf
[i
].urb
= usb_alloc_urb(FRAMES_PER_DESC
, GFP_KERNEL
);
989 if (uvd
->sbuf
[i
].urb
== NULL
) {
990 err("usb_alloc_urb(%d.) failed.", FRAMES_PER_DESC
);
997 uvd
->remove_pending
= 0;
999 RingQueue_Initialize(&uvd
->dp
);
1001 /* Initialize video device structure */
1002 uvd
->vdev
= usbvideo_template
;
1003 sprintf(uvd
->vdev
.name
, "%.20s USB Camera", cams
->drvName
);
1005 * The client is free to overwrite those because we
1006 * return control to the client's probe function right now.
1010 usbvideo_ClientDecModCount(uvd
);
1014 EXPORT_SYMBOL(usbvideo_AllocateDevice
);
1016 int usbvideo_RegisterVideoDevice(struct uvd
*uvd
)
1018 char tmp1
[20], tmp2
[20]; /* Buffers for printing */
1021 err("%s: Illegal call.", __FUNCTION__
);
1024 if (uvd
->video_endp
== 0) {
1025 info("%s: No video endpoint specified; data pump disabled.", __FUNCTION__
);
1027 if (uvd
->paletteBits
== 0) {
1028 err("%s: No palettes specified!", __FUNCTION__
);
1031 if (uvd
->defaultPalette
== 0) {
1032 info("%s: No default palette!", __FUNCTION__
);
1035 uvd
->max_frame_size
= VIDEOSIZE_X(uvd
->canvas
) *
1036 VIDEOSIZE_Y(uvd
->canvas
) * V4L_BYTES_PER_PIXEL
;
1037 usbvideo_VideosizeToString(tmp1
, sizeof(tmp1
), uvd
->videosize
);
1038 usbvideo_VideosizeToString(tmp2
, sizeof(tmp2
), uvd
->canvas
);
1040 if (uvd
->debug
> 0) {
1041 info("%s: iface=%d. endpoint=$%02x paletteBits=$%08lx",
1042 __FUNCTION__
, uvd
->iface
, uvd
->video_endp
, uvd
->paletteBits
);
1044 if (video_register_device(&uvd
->vdev
, VFL_TYPE_GRABBER
, video_nr
) == -1) {
1045 err("%s: video_register_device failed", __FUNCTION__
);
1048 if (uvd
->debug
> 1) {
1049 info("%s: video_register_device() successful", __FUNCTION__
);
1051 if (uvd
->dev
== NULL
) {
1052 err("%s: uvd->dev == NULL", __FUNCTION__
);
1056 info("%s on /dev/video%d: canvas=%s videosize=%s",
1057 (uvd
->handle
!= NULL
) ? uvd
->handle
->drvName
: "???",
1058 uvd
->vdev
.minor
, tmp2
, tmp1
);
1060 usb_get_dev(uvd
->dev
);
1064 EXPORT_SYMBOL(usbvideo_RegisterVideoDevice
);
1066 /* ******************************************************************** */
1068 static int usbvideo_v4l_mmap(struct file
*file
, struct vm_area_struct
*vma
)
1070 struct uvd
*uvd
= file
->private_data
;
1071 unsigned long start
= vma
->vm_start
;
1072 unsigned long size
= vma
->vm_end
-vma
->vm_start
;
1073 unsigned long page
, pos
;
1075 if (!CAMERA_IS_OPERATIONAL(uvd
))
1078 if (size
> (((USBVIDEO_NUMFRAMES
* uvd
->max_frame_size
) + PAGE_SIZE
- 1) & ~(PAGE_SIZE
- 1)))
1081 pos
= (unsigned long) uvd
->fbuf
;
1083 page
= vmalloc_to_pfn((void *)pos
);
1084 if (remap_pfn_range(vma
, start
, page
, PAGE_SIZE
, PAGE_SHARED
))
1089 if (size
> PAGE_SIZE
)
1099 * usbvideo_v4l_open()
1101 * This is part of Video 4 Linux API. The driver can be opened by one
1102 * client only (checks internal counter 'uvdser'). The procedure
1103 * then allocates buffers needed for video processing.
1106 * 22-Jan-2000 Rewrote, moved scratch buffer allocation here. Now the
1107 * camera is also initialized here (once per connect), at
1108 * expense of V4L client (it waits on open() call).
1109 * 27-Jan-2000 Used USBVIDEO_NUMSBUF as number of URB buffers.
1110 * 24-May-2000 Corrected to prevent race condition (MOD_xxx_USE_COUNT).
1112 static int usbvideo_v4l_open(struct inode
*inode
, struct file
*file
)
1114 struct video_device
*dev
= video_devdata(file
);
1115 struct uvd
*uvd
= (struct uvd
*) dev
;
1116 const int sb_size
= FRAMES_PER_DESC
* uvd
->iso_packet_len
;
1120 info("%s($%p)", __FUNCTION__
, dev
);
1122 usbvideo_ClientIncModCount(uvd
);
1126 err("%s: Someone tried to open an already opened device!", __FUNCTION__
);
1129 /* Clear statistics */
1130 memset(&uvd
->stats
, 0, sizeof(uvd
->stats
));
1132 /* Clean pointers so we know if we allocated something */
1133 for (i
=0; i
< USBVIDEO_NUMSBUF
; i
++)
1134 uvd
->sbuf
[i
].data
= NULL
;
1136 /* Allocate memory for the frame buffers */
1137 uvd
->fbuf_size
= USBVIDEO_NUMFRAMES
* uvd
->max_frame_size
;
1138 uvd
->fbuf
= usbvideo_rvmalloc(uvd
->fbuf_size
);
1139 RingQueue_Allocate(&uvd
->dp
, RING_QUEUE_SIZE
);
1140 if ((uvd
->fbuf
== NULL
) ||
1141 (!RingQueue_IsAllocated(&uvd
->dp
))) {
1142 err("%s: Failed to allocate fbuf or dp", __FUNCTION__
);
1145 /* Allocate all buffers */
1146 for (i
=0; i
< USBVIDEO_NUMFRAMES
; i
++) {
1147 uvd
->frame
[i
].frameState
= FrameState_Unused
;
1148 uvd
->frame
[i
].data
= uvd
->fbuf
+ i
*(uvd
->max_frame_size
);
1150 * Set default sizes in case IOCTL (VIDIOCMCAPTURE)
1151 * is not used (using read() instead).
1153 uvd
->frame
[i
].canvas
= uvd
->canvas
;
1154 uvd
->frame
[i
].seqRead_Index
= 0;
1156 for (i
=0; i
< USBVIDEO_NUMSBUF
; i
++) {
1157 uvd
->sbuf
[i
].data
= kmalloc(sb_size
, GFP_KERNEL
);
1158 if (uvd
->sbuf
[i
].data
== NULL
) {
1165 /* Have to free all that memory */
1166 if (uvd
->fbuf
!= NULL
) {
1167 usbvideo_rvfree(uvd
->fbuf
, uvd
->fbuf_size
);
1170 RingQueue_Free(&uvd
->dp
);
1171 for (i
=0; i
< USBVIDEO_NUMSBUF
; i
++) {
1172 kfree(uvd
->sbuf
[i
].data
);
1173 uvd
->sbuf
[i
].data
= NULL
;
1178 /* If so far no errors then we shall start the camera */
1180 /* Start data pump if we have valid endpoint */
1181 if (uvd
->video_endp
!= 0)
1182 errCode
= GET_CALLBACK(uvd
, startDataPump
)(uvd
);
1184 if (VALID_CALLBACK(uvd
, setupOnOpen
)) {
1186 info("%s: setupOnOpen callback", __FUNCTION__
);
1187 errCode
= GET_CALLBACK(uvd
, setupOnOpen
)(uvd
);
1189 err("%s: setupOnOpen callback failed (%d.).",
1190 __FUNCTION__
, errCode
);
1191 } else if (uvd
->debug
> 1) {
1192 info("%s: setupOnOpen callback successful", __FUNCTION__
);
1196 uvd
->settingsAdjusted
= 0;
1198 info("%s: Open succeeded.", __FUNCTION__
);
1200 file
->private_data
= uvd
;
1206 usbvideo_ClientDecModCount(uvd
);
1208 info("%s: Returning %d.", __FUNCTION__
, errCode
);
1213 * usbvideo_v4l_close()
1215 * This is part of Video 4 Linux API. The procedure
1216 * stops streaming and deallocates all buffers that were earlier
1217 * allocated in usbvideo_v4l_open().
1220 * 22-Jan-2000 Moved scratch buffer deallocation here.
1221 * 27-Jan-2000 Used USBVIDEO_NUMSBUF as number of URB buffers.
1222 * 24-May-2000 Moved MOD_DEC_USE_COUNT outside of code that can sleep.
1224 static int usbvideo_v4l_close(struct inode
*inode
, struct file
*file
)
1226 struct video_device
*dev
= file
->private_data
;
1227 struct uvd
*uvd
= (struct uvd
*) dev
;
1231 info("%s($%p)", __FUNCTION__
, dev
);
1234 GET_CALLBACK(uvd
, stopDataPump
)(uvd
);
1235 usbvideo_rvfree(uvd
->fbuf
, uvd
->fbuf_size
);
1237 RingQueue_Free(&uvd
->dp
);
1239 for (i
=0; i
< USBVIDEO_NUMSBUF
; i
++) {
1240 kfree(uvd
->sbuf
[i
].data
);
1241 uvd
->sbuf
[i
].data
= NULL
;
1244 #if USBVIDEO_REPORT_STATS
1245 usbvideo_ReportStatistics(uvd
);
1249 if (uvd
->remove_pending
) {
1251 info("usbvideo_v4l_close: Final disconnect.");
1252 usbvideo_CameraRelease(uvd
);
1255 usbvideo_ClientDecModCount(uvd
);
1258 info("%s: Completed.", __FUNCTION__
);
1259 file
->private_data
= NULL
;
1264 * usbvideo_v4l_ioctl()
1266 * This is part of Video 4 Linux API. The procedure handles ioctl() calls.
1269 * 22-Jan-2000 Corrected VIDIOCSPICT to reject unsupported settings.
1271 static int usbvideo_v4l_do_ioctl(struct inode
*inode
, struct file
*file
,
1272 unsigned int cmd
, void *arg
)
1274 struct uvd
*uvd
= file
->private_data
;
1276 if (!CAMERA_IS_OPERATIONAL(uvd
))
1282 struct video_capability
*b
= arg
;
1288 struct video_channel
*v
= arg
;
1294 struct video_channel
*v
= arg
;
1295 if (v
->channel
!= 0)
1301 struct video_picture
*pic
= arg
;
1307 struct video_picture
*pic
= arg
;
1309 * Use temporary 'video_picture' structure to preserve our
1310 * own settings (such as color depth, palette) that we
1311 * aren't allowing everyone (V4L client) to change.
1313 uvd
->vpic
.brightness
= pic
->brightness
;
1314 uvd
->vpic
.hue
= pic
->hue
;
1315 uvd
->vpic
.colour
= pic
->colour
;
1316 uvd
->vpic
.contrast
= pic
->contrast
;
1317 uvd
->settingsAdjusted
= 0; /* Will force new settings */
1322 struct video_window
*vw
= arg
;
1324 if(VALID_CALLBACK(uvd
, setVideoMode
)) {
1325 return GET_CALLBACK(uvd
, setVideoMode
)(uvd
, vw
);
1332 if (vw
->width
!= VIDEOSIZE_X(uvd
->canvas
))
1334 if (vw
->height
!= VIDEOSIZE_Y(uvd
->canvas
))
1341 struct video_window
*vw
= arg
;
1345 vw
->width
= VIDEOSIZE_X(uvd
->videosize
);
1346 vw
->height
= VIDEOSIZE_Y(uvd
->videosize
);
1348 if (VALID_CALLBACK(uvd
, getFPS
))
1349 vw
->flags
= GET_CALLBACK(uvd
, getFPS
)(uvd
);
1351 vw
->flags
= 10; /* FIXME: do better! */
1356 struct video_mbuf
*vm
= arg
;
1359 memset(vm
, 0, sizeof(*vm
));
1360 vm
->size
= uvd
->max_frame_size
* USBVIDEO_NUMFRAMES
;
1361 vm
->frames
= USBVIDEO_NUMFRAMES
;
1362 for(i
= 0; i
< USBVIDEO_NUMFRAMES
; i
++)
1363 vm
->offsets
[i
] = i
* uvd
->max_frame_size
;
1367 case VIDIOCMCAPTURE
:
1369 struct video_mmap
*vm
= arg
;
1371 if (uvd
->debug
>= 1) {
1372 info("VIDIOCMCAPTURE: frame=%d. size=%dx%d, format=%d.",
1373 vm
->frame
, vm
->width
, vm
->height
, vm
->format
);
1376 * Check if the requested size is supported. If the requestor
1377 * requests too big a frame then we may be tricked into accessing
1378 * outside of own preallocated frame buffer (in uvd->frame).
1379 * This will cause oops or a security hole. Theoretically, we
1380 * could only clamp the size down to acceptable bounds, but then
1381 * we'd need to figure out how to insert our smaller buffer into
1382 * larger caller's buffer... this is not an easy question. So we
1383 * here just flatly reject too large requests, assuming that the
1384 * caller will resubmit with smaller size. Callers should know
1385 * what size we support (returned by VIDIOCGCAP). However vidcat,
1386 * for one, does not care and allows to ask for any size.
1388 if ((vm
->width
> VIDEOSIZE_X(uvd
->canvas
)) ||
1389 (vm
->height
> VIDEOSIZE_Y(uvd
->canvas
))) {
1390 if (uvd
->debug
> 0) {
1391 info("VIDIOCMCAPTURE: Size=%dx%d too large; "
1392 "allowed only up to %ldx%ld", vm
->width
, vm
->height
,
1393 VIDEOSIZE_X(uvd
->canvas
), VIDEOSIZE_Y(uvd
->canvas
));
1397 /* Check if the palette is supported */
1398 if (((1L << vm
->format
) & uvd
->paletteBits
) == 0) {
1399 if (uvd
->debug
> 0) {
1400 info("VIDIOCMCAPTURE: format=%d. not supported"
1401 " (paletteBits=$%08lx)",
1402 vm
->format
, uvd
->paletteBits
);
1406 if ((vm
->frame
< 0) || (vm
->frame
>= USBVIDEO_NUMFRAMES
)) {
1407 err("VIDIOCMCAPTURE: vm.frame=%d. !E [0-%d]", vm
->frame
, USBVIDEO_NUMFRAMES
-1);
1410 if (uvd
->frame
[vm
->frame
].frameState
== FrameState_Grabbing
) {
1411 /* Not an error - can happen */
1413 uvd
->frame
[vm
->frame
].request
= VIDEOSIZE(vm
->width
, vm
->height
);
1414 uvd
->frame
[vm
->frame
].palette
= vm
->format
;
1416 /* Mark it as ready */
1417 uvd
->frame
[vm
->frame
].frameState
= FrameState_Ready
;
1419 return usbvideo_NewFrame(uvd
, vm
->frame
);
1423 int *frameNum
= arg
;
1426 if (*frameNum
< 0 || *frameNum
>= USBVIDEO_NUMFRAMES
)
1429 if (uvd
->debug
>= 1)
1430 info("VIDIOCSYNC: syncing to frame %d.", *frameNum
);
1431 if (uvd
->flags
& FLAGS_NO_DECODING
)
1432 ret
= usbvideo_GetFrame(uvd
, *frameNum
);
1433 else if (VALID_CALLBACK(uvd
, getFrame
)) {
1434 ret
= GET_CALLBACK(uvd
, getFrame
)(uvd
, *frameNum
);
1435 if ((ret
< 0) && (uvd
->debug
>= 1)) {
1436 err("VIDIOCSYNC: getFrame() returned %d.", ret
);
1439 err("VIDIOCSYNC: getFrame is not set");
1444 * The frame is in FrameState_Done_Hold state. Release it
1445 * right now because its data is already mapped into
1446 * the user space and it's up to the application to
1447 * make use of it until it asks for another frame.
1449 uvd
->frame
[*frameNum
].frameState
= FrameState_Unused
;
1454 struct video_buffer
*vb
= arg
;
1456 memset(vb
, 0, sizeof(*vb
));
1478 return -ENOIOCTLCMD
;
1483 static int usbvideo_v4l_ioctl(struct inode
*inode
, struct file
*file
,
1484 unsigned int cmd
, unsigned long arg
)
1486 return video_usercopy(inode
, file
, cmd
, arg
, usbvideo_v4l_do_ioctl
);
1490 * usbvideo_v4l_read()
1492 * This is mostly boring stuff. We simply ask for a frame and when it
1493 * arrives copy all the video data from it into user space. There is
1494 * no obvious need to override this method.
1497 * 20-Oct-2000 Created.
1498 * 01-Nov-2000 Added mutex (uvd->lock).
1500 static ssize_t
usbvideo_v4l_read(struct file
*file
, char __user
*buf
,
1501 size_t count
, loff_t
*ppos
)
1503 struct uvd
*uvd
= file
->private_data
;
1504 int noblock
= file
->f_flags
& O_NONBLOCK
;
1506 struct usbvideo_frame
*frame
;
1508 if (!CAMERA_IS_OPERATIONAL(uvd
) || (buf
== NULL
))
1511 if (uvd
->debug
>= 1)
1512 info("%s: %Zd. bytes, noblock=%d.", __FUNCTION__
, count
, noblock
);
1516 /* See if a frame is completed, then use it. */
1517 for(i
= 0; i
< USBVIDEO_NUMFRAMES
; i
++) {
1518 if ((uvd
->frame
[i
].frameState
== FrameState_Done
) ||
1519 (uvd
->frame
[i
].frameState
== FrameState_Done_Hold
) ||
1520 (uvd
->frame
[i
].frameState
== FrameState_Error
)) {
1526 /* FIXME: If we don't start a frame here then who ever does? */
1527 if (noblock
&& (frmx
== -1)) {
1533 * If no FrameState_Done, look for a FrameState_Grabbing state.
1534 * See if a frame is in process (grabbing), then use it.
1535 * We will need to wait until it becomes cooked, of course.
1538 for(i
= 0; i
< USBVIDEO_NUMFRAMES
; i
++) {
1539 if (uvd
->frame
[i
].frameState
== FrameState_Grabbing
) {
1547 * If no frame is active, start one. We don't care which one
1548 * it will be, so #0 is as good as any.
1549 * In read access mode we don't have convenience of VIDIOCMCAPTURE
1550 * to specify the requested palette (video format) on per-frame
1551 * basis. This means that we have to return data in -some- format
1552 * and just hope that the client knows what to do with it.
1553 * The default format is configured in uvd->defaultPalette field
1554 * as one of VIDEO_PALETTE_xxx values. We stuff it into the new
1555 * frame and initiate the frame filling process.
1558 if (uvd
->defaultPalette
== 0) {
1559 err("%s: No default palette; don't know what to do!", __FUNCTION__
);
1565 * We have no per-frame control over video size.
1566 * Therefore we only can use whatever size was
1567 * specified as default.
1569 uvd
->frame
[frmx
].request
= uvd
->videosize
;
1570 uvd
->frame
[frmx
].palette
= uvd
->defaultPalette
;
1571 uvd
->frame
[frmx
].frameState
= FrameState_Ready
;
1572 usbvideo_NewFrame(uvd
, frmx
);
1573 /* Now frame 0 is supposed to start filling... */
1577 * Get a pointer to the active frame. It is either previously
1578 * completed frame or frame in progress but not completed yet.
1580 frame
= &uvd
->frame
[frmx
];
1583 * Sit back & wait until the frame gets filled and postprocessed.
1584 * If we fail to get the picture [in time] then return the error.
1585 * In this call we specify that we want the frame to be waited for,
1586 * postprocessed and switched into FrameState_Done_Hold state. This
1587 * state is used to hold the frame as "fully completed" between
1588 * subsequent partial reads of the same frame.
1590 if (frame
->frameState
!= FrameState_Done_Hold
) {
1592 if (uvd
->flags
& FLAGS_NO_DECODING
)
1593 rv
= usbvideo_GetFrame(uvd
, frmx
);
1594 else if (VALID_CALLBACK(uvd
, getFrame
))
1595 rv
= GET_CALLBACK(uvd
, getFrame
)(uvd
, frmx
);
1597 err("getFrame is not set");
1598 if ((rv
!= 0) || (frame
->frameState
!= FrameState_Done_Hold
)) {
1605 * Copy bytes to user space. We allow for partial reads, which
1606 * means that the user application can request read less than
1607 * the full frame size. It is up to the application to issue
1608 * subsequent calls until entire frame is read.
1610 * First things first, make sure we don't copy more than we
1611 * have - even if the application wants more. That would be
1612 * a big security embarassment!
1614 if ((count
+ frame
->seqRead_Index
) > frame
->seqRead_Length
)
1615 count
= frame
->seqRead_Length
- frame
->seqRead_Index
;
1618 * Copy requested amount of data to user space. We start
1619 * copying from the position where we last left it, which
1620 * will be zero for a new frame (not read before).
1622 if (copy_to_user(buf
, frame
->data
+ frame
->seqRead_Index
, count
)) {
1627 /* Update last read position */
1628 frame
->seqRead_Index
+= count
;
1629 if (uvd
->debug
>= 1) {
1630 err("%s: {copy} count used=%Zd, new seqRead_Index=%ld",
1631 __FUNCTION__
, count
, frame
->seqRead_Index
);
1634 /* Finally check if the frame is done with and "release" it */
1635 if (frame
->seqRead_Index
>= frame
->seqRead_Length
) {
1636 /* All data has been read */
1637 frame
->seqRead_Index
= 0;
1639 /* Mark it as available to be used again. */
1640 uvd
->frame
[frmx
].frameState
= FrameState_Unused
;
1641 if (usbvideo_NewFrame(uvd
, (frmx
+ 1) % USBVIDEO_NUMFRAMES
)) {
1642 err("%s: usbvideo_NewFrame failed.", __FUNCTION__
);
1651 * Make all of the blocks of data contiguous
1653 static int usbvideo_CompressIsochronous(struct uvd
*uvd
, struct urb
*urb
)
1658 for (i
= 0; i
< urb
->number_of_packets
; i
++) {
1659 int n
= urb
->iso_frame_desc
[i
].actual_length
;
1660 int st
= urb
->iso_frame_desc
[i
].status
;
1662 cdata
= urb
->transfer_buffer
+ urb
->iso_frame_desc
[i
].offset
;
1664 /* Detect and ignore errored packets */
1666 if (uvd
->debug
>= 1)
1667 err("Data error: packet=%d. len=%d. status=%d.", i
, n
, st
);
1668 uvd
->stats
.iso_err_count
++;
1672 /* Detect and ignore empty packets */
1674 uvd
->stats
.iso_skip_count
++;
1677 totlen
+= n
; /* Little local accounting */
1678 RingQueue_Enqueue(&uvd
->dp
, cdata
, n
);
1683 static void usbvideo_IsocIrq(struct urb
*urb
, struct pt_regs
*regs
)
1686 struct uvd
*uvd
= urb
->context
;
1688 /* We don't want to do anything if we are about to be removed! */
1689 if (!CAMERA_IS_OPERATIONAL(uvd
))
1692 if (urb
->actual_length
> 0) {
1693 info("urb=$%p status=%d. errcount=%d. length=%d.",
1694 urb
, urb
->status
, urb
->error_count
, urb
->actual_length
);
1698 info("No Isoc data");
1702 if (!uvd
->streaming
) {
1703 if (uvd
->debug
>= 1)
1704 info("Not streaming, but interrupt!");
1708 uvd
->stats
.urb_count
++;
1709 if (urb
->actual_length
<= 0)
1712 /* Copy the data received into ring queue */
1713 len
= usbvideo_CompressIsochronous(uvd
, urb
);
1714 uvd
->stats
.urb_length
= len
;
1718 /* Here we got some data */
1719 uvd
->stats
.data_count
+= len
;
1720 RingQueue_WakeUpInterruptible(&uvd
->dp
);
1723 for (i
= 0; i
< FRAMES_PER_DESC
; i
++) {
1724 urb
->iso_frame_desc
[i
].status
= 0;
1725 urb
->iso_frame_desc
[i
].actual_length
= 0;
1728 urb
->dev
= uvd
->dev
;
1729 ret
= usb_submit_urb (urb
, GFP_KERNEL
);
1731 err("usb_submit_urb error (%d)", ret
);
1736 * usbvideo_StartDataPump()
1739 * 27-Jan-2000 Used ibmcam->iface, ibmcam->ifaceAltActive instead
1740 * of hardcoded values. Simplified by using for loop,
1741 * allowed any number of URBs.
1743 static int usbvideo_StartDataPump(struct uvd
*uvd
)
1745 struct usb_device
*dev
= uvd
->dev
;
1749 info("%s($%p)", __FUNCTION__
, uvd
);
1751 if (!CAMERA_IS_OPERATIONAL(uvd
)) {
1752 err("%s: Camera is not operational", __FUNCTION__
);
1757 /* Alternate interface 1 is is the biggest frame size */
1758 i
= usb_set_interface(dev
, uvd
->iface
, uvd
->ifaceAltActive
);
1760 err("%s: usb_set_interface error", __FUNCTION__
);
1761 uvd
->last_error
= i
;
1764 if (VALID_CALLBACK(uvd
, videoStart
))
1765 GET_CALLBACK(uvd
, videoStart
)(uvd
);
1767 err("%s: videoStart not set", __FUNCTION__
);
1769 /* We double buffer the Iso lists */
1770 for (i
=0; i
< USBVIDEO_NUMSBUF
; i
++) {
1772 struct urb
*urb
= uvd
->sbuf
[i
].urb
;
1775 urb
->pipe
= usb_rcvisocpipe(dev
, uvd
->video_endp
);
1777 urb
->transfer_flags
= URB_ISO_ASAP
;
1778 urb
->transfer_buffer
= uvd
->sbuf
[i
].data
;
1779 urb
->complete
= usbvideo_IsocIrq
;
1780 urb
->number_of_packets
= FRAMES_PER_DESC
;
1781 urb
->transfer_buffer_length
= uvd
->iso_packet_len
* FRAMES_PER_DESC
;
1782 for (j
=k
=0; j
< FRAMES_PER_DESC
; j
++, k
+= uvd
->iso_packet_len
) {
1783 urb
->iso_frame_desc
[j
].offset
= k
;
1784 urb
->iso_frame_desc
[j
].length
= uvd
->iso_packet_len
;
1788 /* Submit all URBs */
1789 for (i
=0; i
< USBVIDEO_NUMSBUF
; i
++) {
1790 errFlag
= usb_submit_urb(uvd
->sbuf
[i
].urb
, GFP_KERNEL
);
1792 err("%s: usb_submit_isoc(%d) ret %d", __FUNCTION__
, i
, errFlag
);
1797 info("%s: streaming=1 video_endp=$%02x", __FUNCTION__
, uvd
->video_endp
);
1802 * usbvideo_StopDataPump()
1804 * This procedure stops streaming and deallocates URBs. Then it
1805 * activates zero-bandwidth alt. setting of the video interface.
1808 * 22-Jan-2000 Corrected order of actions to work after surprise removal.
1809 * 27-Jan-2000 Used uvd->iface, uvd->ifaceAltInactive instead of hardcoded values.
1811 static void usbvideo_StopDataPump(struct uvd
*uvd
)
1815 if ((uvd
== NULL
) || (!uvd
->streaming
) || (uvd
->dev
== NULL
))
1819 info("%s($%p)", __FUNCTION__
, uvd
);
1821 /* Unschedule all of the iso td's */
1822 for (i
=0; i
< USBVIDEO_NUMSBUF
; i
++) {
1823 usb_kill_urb(uvd
->sbuf
[i
].urb
);
1826 info("%s: streaming=0", __FUNCTION__
);
1829 if (!uvd
->remove_pending
) {
1830 /* Invoke minidriver's magic to stop the camera */
1831 if (VALID_CALLBACK(uvd
, videoStop
))
1832 GET_CALLBACK(uvd
, videoStop
)(uvd
);
1834 err("%s: videoStop not set", __FUNCTION__
);
1836 /* Set packet size to 0 */
1837 j
= usb_set_interface(uvd
->dev
, uvd
->iface
, uvd
->ifaceAltInactive
);
1839 err("%s: usb_set_interface() error %d.", __FUNCTION__
, j
);
1840 uvd
->last_error
= j
;
1846 * usbvideo_NewFrame()
1849 * 29-Mar-00 Added copying of previous frame into the current one.
1850 * 6-Aug-00 Added model 3 video sizes, removed redundant width, height.
1852 static int usbvideo_NewFrame(struct uvd
*uvd
, int framenum
)
1854 struct usbvideo_frame
*frame
;
1858 info("usbvideo_NewFrame($%p,%d.)", uvd
, framenum
);
1860 /* If we're not grabbing a frame right now and the other frame is */
1861 /* ready to be grabbed into, then use it instead */
1862 if (uvd
->curframe
!= -1)
1865 /* If necessary we adjust picture settings between frames */
1866 if (!uvd
->settingsAdjusted
) {
1867 if (VALID_CALLBACK(uvd
, adjustPicture
))
1868 GET_CALLBACK(uvd
, adjustPicture
)(uvd
);
1869 uvd
->settingsAdjusted
= 1;
1872 n
= (framenum
+ 1) % USBVIDEO_NUMFRAMES
;
1873 if (uvd
->frame
[n
].frameState
== FrameState_Ready
)
1876 frame
= &uvd
->frame
[framenum
];
1878 frame
->frameState
= FrameState_Grabbing
;
1879 frame
->scanstate
= ScanState_Scanning
;
1880 frame
->seqRead_Length
= 0; /* Accumulated in xxx_parse_data() */
1881 frame
->deinterlace
= Deinterlace_None
;
1882 frame
->flags
= 0; /* No flags yet, up to minidriver (or us) to set them */
1883 uvd
->curframe
= framenum
;
1886 * Normally we would want to copy previous frame into the current one
1887 * before we even start filling it with data; this allows us to stop
1888 * filling at any moment; top portion of the frame will be new and
1889 * bottom portion will stay as it was in previous frame. If we don't
1890 * do that then missing chunks of video stream will result in flickering
1891 * portions of old data whatever it was before.
1893 * If we choose not to copy previous frame (to, for example, save few
1894 * bus cycles - the frame can be pretty large!) then we have an option
1895 * to clear the frame before using. If we experience losses in this
1896 * mode then missing picture will be black (no flickering).
1898 * Finally, if user chooses not to clean the current frame before
1899 * filling it with data then the old data will be visible if we fail
1900 * to refill entire frame with new data.
1902 if (!(uvd
->flags
& FLAGS_SEPARATE_FRAMES
)) {
1903 /* This copies previous frame into this one to mask losses */
1904 int prev
= (framenum
- 1 + USBVIDEO_NUMFRAMES
) % USBVIDEO_NUMFRAMES
;
1905 memmove(frame
->data
, uvd
->frame
[prev
].data
, uvd
->max_frame_size
);
1907 if (uvd
->flags
& FLAGS_CLEAN_FRAMES
) {
1908 /* This provides a "clean" frame but slows things down */
1909 memset(frame
->data
, 0, uvd
->max_frame_size
);
1916 * usbvideo_CollectRawData()
1918 * This procedure can be used instead of 'processData' callback if you
1919 * only want to dump the raw data from the camera into the output
1920 * device (frame buffer). You can look at it with V4L client, but the
1921 * image will be unwatchable. The main purpose of this code and of the
1922 * mode FLAGS_NO_DECODING is debugging and capturing of datastreams from
1923 * new, unknown cameras. This procedure will be automatically invoked
1924 * instead of the specified callback handler when uvd->flags has bit
1925 * FLAGS_NO_DECODING set. Therefore, any regular build of any driver
1926 * based on usbvideo can use this feature at any time.
1928 static void usbvideo_CollectRawData(struct uvd
*uvd
, struct usbvideo_frame
*frame
)
1932 assert(uvd
!= NULL
);
1933 assert(frame
!= NULL
);
1935 /* Try to move data from queue into frame buffer */
1936 n
= RingQueue_GetLength(&uvd
->dp
);
1939 /* See how much space we have left */
1940 m
= uvd
->max_frame_size
- frame
->seqRead_Length
;
1943 /* Now move that much data into frame buffer */
1946 frame
->data
+ frame
->seqRead_Length
,
1948 frame
->seqRead_Length
+= m
;
1950 /* See if we filled the frame */
1951 if (frame
->seqRead_Length
>= uvd
->max_frame_size
) {
1952 frame
->frameState
= FrameState_Done
;
1954 uvd
->stats
.frame_num
++;
1958 static int usbvideo_GetFrame(struct uvd
*uvd
, int frameNum
)
1960 struct usbvideo_frame
*frame
= &uvd
->frame
[frameNum
];
1962 if (uvd
->debug
>= 2)
1963 info("%s($%p,%d.)", __FUNCTION__
, uvd
, frameNum
);
1965 switch (frame
->frameState
) {
1966 case FrameState_Unused
:
1967 if (uvd
->debug
>= 2)
1968 info("%s: FrameState_Unused", __FUNCTION__
);
1970 case FrameState_Ready
:
1971 case FrameState_Grabbing
:
1972 case FrameState_Error
:
1974 int ntries
, signalPending
;
1976 if (!CAMERA_IS_OPERATIONAL(uvd
)) {
1977 if (uvd
->debug
>= 2)
1978 info("%s: Camera is not operational (1)", __FUNCTION__
);
1983 RingQueue_InterruptibleSleepOn(&uvd
->dp
);
1984 signalPending
= signal_pending(current
);
1985 if (!CAMERA_IS_OPERATIONAL(uvd
)) {
1986 if (uvd
->debug
>= 2)
1987 info("%s: Camera is not operational (2)", __FUNCTION__
);
1990 assert(uvd
->fbuf
!= NULL
);
1991 if (signalPending
) {
1992 if (uvd
->debug
>= 2)
1993 info("%s: Signal=$%08x", __FUNCTION__
, signalPending
);
1994 if (uvd
->flags
& FLAGS_RETRY_VIDIOCSYNC
) {
1995 usbvideo_TestPattern(uvd
, 1, 0);
1997 uvd
->stats
.frame_num
++;
1998 if (uvd
->debug
>= 2)
1999 info("%s: Forced test pattern screen", __FUNCTION__
);
2002 /* Standard answer: Interrupted! */
2003 if (uvd
->debug
>= 2)
2004 info("%s: Interrupted!", __FUNCTION__
);
2008 /* No signals - we just got new data in dp queue */
2009 if (uvd
->flags
& FLAGS_NO_DECODING
)
2010 usbvideo_CollectRawData(uvd
, frame
);
2011 else if (VALID_CALLBACK(uvd
, processData
))
2012 GET_CALLBACK(uvd
, processData
)(uvd
, frame
);
2014 err("%s: processData not set", __FUNCTION__
);
2016 } while (frame
->frameState
== FrameState_Grabbing
);
2017 if (uvd
->debug
>= 2) {
2018 info("%s: Grabbing done; state=%d. (%lu. bytes)",
2019 __FUNCTION__
, frame
->frameState
, frame
->seqRead_Length
);
2021 if (frame
->frameState
== FrameState_Error
) {
2022 int ret
= usbvideo_NewFrame(uvd
, frameNum
);
2024 err("%s: usbvideo_NewFrame() failed (%d.)", __FUNCTION__
, ret
);
2029 /* Note that we fall through to meet our destiny below */
2031 case FrameState_Done
:
2033 * Do all necessary postprocessing of data prepared in
2034 * "interrupt" code and the collecting code above. The
2035 * frame gets marked as FrameState_Done by queue parsing code.
2036 * This status means that we collected enough data and
2037 * most likely processed it as we went through. However
2038 * the data may need postprocessing, such as deinterlacing
2039 * or picture adjustments implemented in software (horror!)
2041 * As soon as the frame becomes "final" it gets promoted to
2042 * FrameState_Done_Hold status where it will remain until the
2043 * caller consumed all the video data from the frame. Then
2044 * the empty shell of ex-frame is thrown out for dogs to eat.
2045 * But we, worried about pets, will recycle the frame!
2047 uvd
->stats
.frame_num
++;
2048 if ((uvd
->flags
& FLAGS_NO_DECODING
) == 0) {
2049 if (VALID_CALLBACK(uvd
, postProcess
))
2050 GET_CALLBACK(uvd
, postProcess
)(uvd
, frame
);
2051 if (frame
->flags
& USBVIDEO_FRAME_FLAG_SOFTWARE_CONTRAST
)
2052 usbvideo_SoftwareContrastAdjustment(uvd
, frame
);
2054 frame
->frameState
= FrameState_Done_Hold
;
2055 if (uvd
->debug
>= 2)
2056 info("%s: Entered FrameState_Done_Hold state.", __FUNCTION__
);
2059 case FrameState_Done_Hold
:
2061 * We stay in this state indefinitely until someone external,
2062 * like ioctl() or read() call finishes digesting the frame
2063 * data. Then it will mark the frame as FrameState_Unused and
2064 * it will be released back into the wild to roam freely.
2066 if (uvd
->debug
>= 2)
2067 info("%s: FrameState_Done_Hold state.", __FUNCTION__
);
2071 /* Catch-all for other cases. We shall not be here. */
2072 err("%s: Invalid state %d.", __FUNCTION__
, frame
->frameState
);
2073 frame
->frameState
= FrameState_Unused
;
2078 * usbvideo_DeinterlaceFrame()
2080 * This procedure deinterlaces the given frame. Some cameras produce
2081 * only half of scanlines - sometimes only even lines, sometimes only
2082 * odd lines. The deinterlacing method is stored in frame->deinterlace
2085 * Here we scan the frame vertically and replace missing scanlines with
2086 * average between surrounding ones - before and after. If we have no
2087 * line above then we just copy next line. Similarly, if we need to
2088 * create a last line then preceding line is used.
2090 void usbvideo_DeinterlaceFrame(struct uvd
*uvd
, struct usbvideo_frame
*frame
)
2092 if ((uvd
== NULL
) || (frame
== NULL
))
2095 if ((frame
->deinterlace
== Deinterlace_FillEvenLines
) ||
2096 (frame
->deinterlace
== Deinterlace_FillOddLines
))
2098 const int v4l_linesize
= VIDEOSIZE_X(frame
->request
) * V4L_BYTES_PER_PIXEL
;
2099 int i
= (frame
->deinterlace
== Deinterlace_FillEvenLines
) ? 0 : 1;
2101 for (; i
< VIDEOSIZE_Y(frame
->request
); i
+= 2) {
2102 const unsigned char *fs1
, *fs2
;
2104 int ip
, in
, j
; /* Previous and next lines */
2107 * Need to average lines before and after 'i'.
2108 * If we go out of bounds seeking those lines then
2109 * we point back to existing line.
2111 ip
= i
- 1; /* First, get rough numbers */
2117 if (in
>= VIDEOSIZE_Y(frame
->request
))
2121 if ((ip
< 0) || (in
< 0) ||
2122 (ip
>= VIDEOSIZE_Y(frame
->request
)) ||
2123 (in
>= VIDEOSIZE_Y(frame
->request
)))
2125 err("Error: ip=%d. in=%d. req.height=%ld.",
2126 ip
, in
, VIDEOSIZE_Y(frame
->request
));
2130 /* Now we need to average lines 'ip' and 'in' to produce line 'i' */
2131 fs1
= frame
->data
+ (v4l_linesize
* ip
);
2132 fs2
= frame
->data
+ (v4l_linesize
* in
);
2133 fd
= frame
->data
+ (v4l_linesize
* i
);
2135 /* Average lines around destination */
2136 for (j
=0; j
< v4l_linesize
; j
++) {
2137 fd
[j
] = (unsigned char)((((unsigned) fs1
[j
]) +
2138 ((unsigned)fs2
[j
])) >> 1);
2143 /* Optionally display statistics on the screen */
2144 if (uvd
->flags
& FLAGS_OVERLAY_STATS
)
2145 usbvideo_OverlayStats(uvd
, frame
);
2148 EXPORT_SYMBOL(usbvideo_DeinterlaceFrame
);
2151 * usbvideo_SoftwareContrastAdjustment()
2153 * This code adjusts the contrast of the frame, assuming RGB24 format.
2154 * As most software image processing, this job is CPU-intensive.
2155 * Get a camera that supports hardware adjustment!
2158 * 09-Feb-2001 Created.
2160 static void usbvideo_SoftwareContrastAdjustment(struct uvd
*uvd
,
2161 struct usbvideo_frame
*frame
)
2163 int i
, j
, v4l_linesize
;
2165 const int ccm
= 128; /* Color correction median - see below */
2167 if ((uvd
== NULL
) || (frame
== NULL
)) {
2168 err("%s: Illegal call.", __FUNCTION__
);
2171 adj
= (uvd
->vpic
.contrast
- 0x8000) >> 8; /* -128..+127 = -ccm..+(ccm-1)*/
2172 RESTRICT_TO_RANGE(adj
, -ccm
, ccm
+1);
2174 /* In rare case of no adjustment */
2177 v4l_linesize
= VIDEOSIZE_X(frame
->request
) * V4L_BYTES_PER_PIXEL
;
2178 for (i
=0; i
< VIDEOSIZE_Y(frame
->request
); i
++) {
2179 unsigned char *fd
= frame
->data
+ (v4l_linesize
* i
);
2180 for (j
=0; j
< v4l_linesize
; j
++) {
2181 signed long v
= (signed long) fd
[j
];
2182 /* Magnify up to 2 times, reduce down to zero */
2183 v
= 128 + ((ccm
+ adj
) * (v
- 128)) / ccm
;
2184 RESTRICT_TO_RANGE(v
, 0, 0xFF); /* Must flatten tails */
2185 fd
[j
] = (unsigned char) v
;
2190 MODULE_LICENSE("GPL");