2 cx231xx_vbi.c - driver for Conexant Cx23100/101/102 USB video capture devices
4 Copyright (C) 2008 <srinivasa.deevi at conexant dot com>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <linux/init.h>
23 #include <linux/list.h>
24 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/bitmap.h>
27 #include <linux/usb.h>
28 #include <linux/i2c.h>
29 #include <linux/version.h>
31 #include <linux/mutex.h>
33 #include <media/v4l2-common.h>
34 #include <media/v4l2-ioctl.h>
35 #include <media/v4l2-chip-ident.h>
36 #include <media/msp3400.h>
37 #include <media/tuner.h>
40 #include "cx231xx-vbi.h"
42 static inline void print_err_status(struct cx231xx
*dev
, int packet
, int status
)
44 char *errmsg
= "Unknown";
48 errmsg
= "unlinked synchronuously";
51 errmsg
= "unlinked asynchronuously";
54 errmsg
= "Buffer error (overrun)";
57 errmsg
= "Stalled (device not responding)";
60 errmsg
= "Babble (bad cable?)";
63 errmsg
= "Bit-stuff error (bad cable?)";
66 errmsg
= "CRC/Timeout (could be anything)";
69 errmsg
= "Device does not respond";
73 cx231xx_err(DRIVER_NAME
"URB status %d [%s].\n", status
,
76 cx231xx_err(DRIVER_NAME
"URB packet %d, status %d [%s].\n",
77 packet
, status
, errmsg
);
82 * Controls the isoc copy of each urb packet
84 static inline int cx231xx_isoc_vbi_copy(struct cx231xx
*dev
, struct urb
*urb
)
86 struct cx231xx_buffer
*buf
;
87 struct cx231xx_dmaqueue
*dma_q
= urb
->context
;
89 unsigned char *p_buffer
;
90 u32 bytes_parsed
= 0, buffer_size
= 0;
96 if ((dev
->state
& DEV_DISCONNECTED
) || (dev
->state
& DEV_MISCONFIGURED
))
99 if (urb
->status
< 0) {
100 print_err_status(dev
, -1, urb
->status
);
101 if (urb
->status
== -ENOENT
)
105 buf
= dev
->vbi_mode
.isoc_ctl
.buf
;
107 /* get buffer pointer and length */
108 p_buffer
= urb
->transfer_buffer
;
109 buffer_size
= urb
->actual_length
;
111 if (buffer_size
> 0) {
114 if (dma_q
->is_partial_line
) {
115 /* Handle the case where we were working on a partial
117 sav_eav
= dma_q
->last_sav
;
119 /* Check for a SAV/EAV overlapping the
122 sav_eav
= cx231xx_find_boundary_SAV_EAV(p_buffer
,
128 /* Get the first line if we have some portion of an SAV/EAV from
129 the last buffer or a partial line */
131 bytes_parsed
+= cx231xx_get_vbi_line(dev
, dma_q
,
132 sav_eav
, /* SAV/EAV */
133 p_buffer
+ bytes_parsed
, /* p_buffer */
134 buffer_size
- bytes_parsed
); /* buffer size */
137 /* Now parse data that is completely in this buffer */
138 dma_q
->is_partial_line
= 0;
140 while (bytes_parsed
< buffer_size
) {
143 sav_eav
= cx231xx_find_next_SAV_EAV(p_buffer
+ bytes_parsed
, /* p_buffer */
144 buffer_size
- bytes_parsed
, /* buffer size */
145 &bytes_used
); /* Receives bytes used to get SAV/EAV */
147 bytes_parsed
+= bytes_used
;
150 if (sav_eav
&& (bytes_parsed
< buffer_size
)) {
151 bytes_parsed
+= cx231xx_get_vbi_line(dev
,
152 dma_q
, sav_eav
, /* SAV/EAV */
153 p_buffer
+ bytes_parsed
, /* p_buffer */
154 buffer_size
- bytes_parsed
); /* buffer size */
158 /* Save the last four bytes of the buffer so we can check the buffer boundary
159 condition next time */
160 memcpy(dma_q
->partial_buf
, p_buffer
+ buffer_size
- 4, 4);
167 /* ------------------------------------------------------------------
169 ------------------------------------------------------------------*/
172 vbi_buffer_setup(struct videobuf_queue
*vq
, unsigned int *count
,
175 struct cx231xx_fh
*fh
= vq
->priv_data
;
176 struct cx231xx
*dev
= fh
->dev
;
179 height
= ((dev
->norm
& V4L2_STD_625_50
) ?
180 PAL_VBI_LINES
: NTSC_VBI_LINES
);
182 *size
= (dev
->width
* height
* 2);
184 *count
= CX231XX_DEF_VBI_BUF
;
186 if (*count
< CX231XX_MIN_BUF
)
187 *count
= CX231XX_MIN_BUF
;
189 /* call VBI setup if required */
190 /* cx231xx_i2c_call_clients(&dev->i2c_bus[1], VIDIOC_S_FREQUENCY, &f);
196 /* This is called *without* dev->slock held; please keep it that way */
197 static void free_buffer(struct videobuf_queue
*vq
, struct cx231xx_buffer
*buf
)
199 struct cx231xx_fh
*fh
= vq
->priv_data
;
200 struct cx231xx
*dev
= fh
->dev
;
201 unsigned long flags
= 0;
205 /* We used to wait for the buffer to finish here, but this didn't work
206 because, as we were keeping the state as VIDEOBUF_QUEUED,
207 videobuf_queue_cancel marked it as finished for us.
208 (Also, it could wedge forever if the hardware was misconfigured.)
210 This should be safe; by the time we get here, the buffer isn't
211 queued anymore. If we ever start marking the buffers as
212 VIDEOBUF_ACTIVE, it won't be, though.
214 spin_lock_irqsave(&dev
->vbi_mode
.slock
, flags
);
215 if (dev
->vbi_mode
.isoc_ctl
.buf
== buf
)
216 dev
->vbi_mode
.isoc_ctl
.buf
= NULL
;
217 spin_unlock_irqrestore(&dev
->vbi_mode
.slock
, flags
);
219 videobuf_vmalloc_free(&buf
->vb
);
220 buf
->vb
.state
= VIDEOBUF_NEEDS_INIT
;
224 vbi_buffer_prepare(struct videobuf_queue
*vq
, struct videobuf_buffer
*vb
,
225 enum v4l2_field field
)
227 struct cx231xx_fh
*fh
= vq
->priv_data
;
228 struct cx231xx_buffer
*buf
=
229 container_of(vb
, struct cx231xx_buffer
, vb
);
230 struct cx231xx
*dev
= fh
->dev
;
231 int rc
= 0, urb_init
= 0;
234 height
= ((dev
->norm
& V4L2_STD_625_50
) ?
235 PAL_VBI_LINES
: NTSC_VBI_LINES
);
236 buf
->vb
.size
= ((dev
->width
<< 1) * height
);
238 if (0 != buf
->vb
.baddr
&& buf
->vb
.bsize
< buf
->vb
.size
)
241 buf
->vb
.width
= dev
->width
;
242 buf
->vb
.height
= height
;
243 buf
->vb
.field
= field
;
244 buf
->vb
.field
= V4L2_FIELD_SEQ_TB
;
246 if (VIDEOBUF_NEEDS_INIT
== buf
->vb
.state
) {
247 rc
= videobuf_iolock(vq
, &buf
->vb
, NULL
);
252 if (!dev
->vbi_mode
.isoc_ctl
.num_bufs
)
256 rc
= cx231xx_init_vbi_isoc(dev
, CX231XX_NUM_VBI_PACKETS
,
257 CX231XX_NUM_VBI_BUFS
,
258 dev
->vbi_mode
.alt_max_pkt_size
[0],
259 cx231xx_isoc_vbi_copy
);
264 buf
->vb
.state
= VIDEOBUF_PREPARED
;
268 free_buffer(vq
, buf
);
273 vbi_buffer_queue(struct videobuf_queue
*vq
, struct videobuf_buffer
*vb
)
275 struct cx231xx_buffer
*buf
=
276 container_of(vb
, struct cx231xx_buffer
, vb
);
277 struct cx231xx_fh
*fh
= vq
->priv_data
;
278 struct cx231xx
*dev
= fh
->dev
;
279 struct cx231xx_dmaqueue
*vidq
= &dev
->vbi_mode
.vidq
;
281 buf
->vb
.state
= VIDEOBUF_QUEUED
;
282 list_add_tail(&buf
->vb
.queue
, &vidq
->active
);
286 static void vbi_buffer_release(struct videobuf_queue
*vq
,
287 struct videobuf_buffer
*vb
)
289 struct cx231xx_buffer
*buf
=
290 container_of(vb
, struct cx231xx_buffer
, vb
);
293 free_buffer(vq
, buf
);
296 struct videobuf_queue_ops cx231xx_vbi_qops
= {
297 .buf_setup
= vbi_buffer_setup
,
298 .buf_prepare
= vbi_buffer_prepare
,
299 .buf_queue
= vbi_buffer_queue
,
300 .buf_release
= vbi_buffer_release
,
303 /* ------------------------------------------------------------------
305 ------------------------------------------------------------------*/
308 * IRQ callback, called by URB callback
310 static void cx231xx_irq_vbi_callback(struct urb
*urb
)
312 struct cx231xx_dmaqueue
*dma_q
= urb
->context
;
313 struct cx231xx_video_mode
*vmode
=
314 container_of(dma_q
, struct cx231xx_video_mode
, vidq
);
315 struct cx231xx
*dev
= container_of(vmode
, struct cx231xx
, vbi_mode
);
318 switch (urb
->status
) {
319 case 0: /* success */
320 case -ETIMEDOUT
: /* NAK */
322 case -ECONNRESET
: /* kill */
327 cx231xx_err(DRIVER_NAME
"urb completition error %d.\n",
332 /* Copy data from URB */
333 spin_lock(&dev
->vbi_mode
.slock
);
334 rc
= dev
->vbi_mode
.isoc_ctl
.isoc_copy(dev
, urb
);
335 spin_unlock(&dev
->vbi_mode
.slock
);
340 urb
->status
= usb_submit_urb(urb
, GFP_ATOMIC
);
342 cx231xx_err(DRIVER_NAME
"urb resubmit failed (error=%i)\n",
348 * Stop and Deallocate URBs
350 void cx231xx_uninit_vbi_isoc(struct cx231xx
*dev
)
355 cx231xx_info(DRIVER_NAME
"cx231xx: called cx231xx_uninit_vbi_isoc\n");
357 dev
->vbi_mode
.isoc_ctl
.nfields
= -1;
358 for (i
= 0; i
< dev
->vbi_mode
.isoc_ctl
.num_bufs
; i
++) {
359 urb
= dev
->vbi_mode
.isoc_ctl
.urb
[i
];
361 if (!irqs_disabled())
366 if (dev
->vbi_mode
.isoc_ctl
.transfer_buffer
[i
]) {
368 kfree(dev
->vbi_mode
.isoc_ctl
.
370 dev
->vbi_mode
.isoc_ctl
.transfer_buffer
[i
] =
374 dev
->vbi_mode
.isoc_ctl
.urb
[i
] = NULL
;
376 dev
->vbi_mode
.isoc_ctl
.transfer_buffer
[i
] = NULL
;
379 kfree(dev
->vbi_mode
.isoc_ctl
.urb
);
380 kfree(dev
->vbi_mode
.isoc_ctl
.transfer_buffer
);
382 dev
->vbi_mode
.isoc_ctl
.urb
= NULL
;
383 dev
->vbi_mode
.isoc_ctl
.transfer_buffer
= NULL
;
384 dev
->vbi_mode
.isoc_ctl
.num_bufs
= 0;
386 cx231xx_capture_start(dev
, 0, Vbi
);
388 EXPORT_SYMBOL_GPL(cx231xx_uninit_vbi_isoc
);
391 * Allocate URBs and start IRQ
393 int cx231xx_init_vbi_isoc(struct cx231xx
*dev
, int max_packets
,
394 int num_bufs
, int max_pkt_size
,
395 int (*isoc_copy
) (struct cx231xx
*dev
,
398 struct cx231xx_dmaqueue
*dma_q
= &dev
->vbi_mode
.vidq
;
404 cx231xx_info(DRIVER_NAME
"cx231xx: called cx231xx_prepare_isoc\n");
406 /* De-allocates all pending stuff */
407 cx231xx_uninit_vbi_isoc(dev
);
409 /* clear if any halt */
410 usb_clear_halt(dev
->udev
,
411 usb_rcvbulkpipe(dev
->udev
,
412 dev
->vbi_mode
.end_point_addr
));
414 dev
->vbi_mode
.isoc_ctl
.isoc_copy
= isoc_copy
;
415 dev
->vbi_mode
.isoc_ctl
.num_bufs
= num_bufs
;
417 dma_q
->is_partial_line
= 0;
419 dma_q
->current_field
= -1;
420 dma_q
->bytes_left_in_line
= dev
->width
<< 1;
421 dma_q
->lines_per_field
= ((dev
->norm
& V4L2_STD_625_50
) ?
422 PAL_VBI_LINES
: NTSC_VBI_LINES
);
423 dma_q
->lines_completed
= 0;
424 for (i
= 0; i
< 8; i
++)
425 dma_q
->partial_buf
[i
] = 0;
427 dev
->vbi_mode
.isoc_ctl
.urb
= kzalloc(sizeof(void *) * num_bufs
,
429 if (!dev
->vbi_mode
.isoc_ctl
.urb
) {
430 cx231xx_errdev("cannot alloc memory for usb buffers\n");
434 dev
->vbi_mode
.isoc_ctl
.transfer_buffer
=
435 kzalloc(sizeof(void *) * num_bufs
, GFP_KERNEL
);
436 if (!dev
->vbi_mode
.isoc_ctl
.transfer_buffer
) {
437 cx231xx_errdev("cannot allocate memory for usbtransfer\n");
438 kfree(dev
->vbi_mode
.isoc_ctl
.urb
);
442 dev
->vbi_mode
.isoc_ctl
.max_pkt_size
= max_pkt_size
;
443 dev
->vbi_mode
.isoc_ctl
.buf
= NULL
;
445 sb_size
= max_packets
* dev
->vbi_mode
.isoc_ctl
.max_pkt_size
;
447 /* allocate urbs and transfer buffers */
448 for (i
= 0; i
< dev
->vbi_mode
.isoc_ctl
.num_bufs
; i
++) {
450 urb
= usb_alloc_urb(0, GFP_KERNEL
);
452 cx231xx_err(DRIVER_NAME
453 ": cannot alloc isoc_ctl.urb %i\n", i
);
454 cx231xx_uninit_vbi_isoc(dev
);
457 dev
->vbi_mode
.isoc_ctl
.urb
[i
] = urb
;
458 urb
->transfer_flags
= 0;
460 dev
->vbi_mode
.isoc_ctl
.transfer_buffer
[i
] =
461 kzalloc(sb_size
, GFP_KERNEL
);
462 if (!dev
->vbi_mode
.isoc_ctl
.transfer_buffer
[i
]) {
463 cx231xx_err(DRIVER_NAME
464 ": unable to allocate %i bytes for transfer"
465 " buffer %i%s\n", sb_size
, i
,
466 in_interrupt() ? " while in int" : "");
467 cx231xx_uninit_vbi_isoc(dev
);
471 pipe
= usb_rcvbulkpipe(dev
->udev
, dev
->vbi_mode
.end_point_addr
);
472 usb_fill_bulk_urb(urb
, dev
->udev
, pipe
,
473 dev
->vbi_mode
.isoc_ctl
.transfer_buffer
[i
],
474 sb_size
, cx231xx_irq_vbi_callback
, dma_q
);
477 init_waitqueue_head(&dma_q
->wq
);
479 /* submit urbs and enables IRQ */
480 for (i
= 0; i
< dev
->vbi_mode
.isoc_ctl
.num_bufs
; i
++) {
481 rc
= usb_submit_urb(dev
->vbi_mode
.isoc_ctl
.urb
[i
], GFP_ATOMIC
);
483 cx231xx_err(DRIVER_NAME
484 ": submit of urb %i failed (error=%i)\n", i
,
486 cx231xx_uninit_vbi_isoc(dev
);
491 cx231xx_capture_start(dev
, 1, Vbi
);
495 EXPORT_SYMBOL_GPL(cx231xx_init_vbi_isoc
);
497 u32
cx231xx_get_vbi_line(struct cx231xx
*dev
, struct cx231xx_dmaqueue
*dma_q
,
498 u8 sav_eav
, u8
*p_buffer
, u32 buffer_size
)
500 u32 bytes_copied
= 0;
501 int current_field
= -1;
516 if (current_field
< 0)
519 dma_q
->last_sav
= sav_eav
;
522 cx231xx_copy_vbi_line(dev
, dma_q
, p_buffer
, buffer_size
,
529 * Announces that a buffer were filled and request the next
531 static inline void vbi_buffer_filled(struct cx231xx
*dev
,
532 struct cx231xx_dmaqueue
*dma_q
,
533 struct cx231xx_buffer
*buf
)
535 /* Advice that buffer was filled */
536 /* cx231xx_info(DRIVER_NAME "[%p/%d] wakeup\n", buf, buf->vb.i); */
538 buf
->vb
.state
= VIDEOBUF_DONE
;
539 buf
->vb
.field_count
++;
540 do_gettimeofday(&buf
->vb
.ts
);
542 dev
->vbi_mode
.isoc_ctl
.buf
= NULL
;
544 list_del(&buf
->vb
.queue
);
545 wake_up(&buf
->vb
.done
);
548 u32
cx231xx_copy_vbi_line(struct cx231xx
*dev
, struct cx231xx_dmaqueue
*dma_q
,
549 u8
*p_line
, u32 length
, int field_number
)
552 struct cx231xx_buffer
*buf
;
553 u32 _line_size
= dev
->width
* 2;
555 if (dma_q
->current_field
!= field_number
)
556 cx231xx_reset_vbi_buffer(dev
, dma_q
);
558 /* get the buffer pointer */
559 buf
= dev
->vbi_mode
.isoc_ctl
.buf
;
561 /* Remember the field number for next time */
562 dma_q
->current_field
= field_number
;
564 bytes_to_copy
= dma_q
->bytes_left_in_line
;
565 if (bytes_to_copy
> length
)
566 bytes_to_copy
= length
;
568 if (dma_q
->lines_completed
>= dma_q
->lines_per_field
) {
569 dma_q
->bytes_left_in_line
-= bytes_to_copy
;
570 dma_q
->is_partial_line
=
571 (dma_q
->bytes_left_in_line
== 0) ? 0 : 1;
575 dma_q
->is_partial_line
= 1;
577 /* If we don't have a buffer, just return the number of bytes we would
578 have copied if we had a buffer. */
580 dma_q
->bytes_left_in_line
-= bytes_to_copy
;
581 dma_q
->is_partial_line
=
582 (dma_q
->bytes_left_in_line
== 0) ? 0 : 1;
583 return bytes_to_copy
;
586 /* copy the data to video buffer */
587 cx231xx_do_vbi_copy(dev
, dma_q
, p_line
, bytes_to_copy
);
589 dma_q
->pos
+= bytes_to_copy
;
590 dma_q
->bytes_left_in_line
-= bytes_to_copy
;
592 if (dma_q
->bytes_left_in_line
== 0) {
594 dma_q
->bytes_left_in_line
= _line_size
;
595 dma_q
->lines_completed
++;
596 dma_q
->is_partial_line
= 0;
598 if (cx231xx_is_vbi_buffer_done(dev
, dma_q
) && buf
) {
600 vbi_buffer_filled(dev
, dma_q
, buf
);
604 dma_q
->lines_completed
= 0;
608 return bytes_to_copy
;
612 * video-buf generic routine to get the next available buffer
614 static inline void get_next_vbi_buf(struct cx231xx_dmaqueue
*dma_q
,
615 struct cx231xx_buffer
**buf
)
617 struct cx231xx_video_mode
*vmode
=
618 container_of(dma_q
, struct cx231xx_video_mode
, vidq
);
619 struct cx231xx
*dev
= container_of(vmode
, struct cx231xx
, vbi_mode
);
622 if (list_empty(&dma_q
->active
)) {
623 cx231xx_err(DRIVER_NAME
": No active queue to serve\n");
624 dev
->vbi_mode
.isoc_ctl
.buf
= NULL
;
629 /* Get the next buffer */
630 *buf
= list_entry(dma_q
->active
.next
, struct cx231xx_buffer
, vb
.queue
);
632 /* Cleans up buffer - Usefull for testing for frame/URB loss */
633 outp
= videobuf_to_vmalloc(&(*buf
)->vb
);
634 memset(outp
, 0, (*buf
)->vb
.size
);
636 dev
->vbi_mode
.isoc_ctl
.buf
= *buf
;
641 void cx231xx_reset_vbi_buffer(struct cx231xx
*dev
,
642 struct cx231xx_dmaqueue
*dma_q
)
644 struct cx231xx_buffer
*buf
;
646 buf
= dev
->vbi_mode
.isoc_ctl
.buf
;
649 /* first try to get the buffer */
650 get_next_vbi_buf(dma_q
, &buf
);
653 dma_q
->current_field
= -1;
656 dma_q
->bytes_left_in_line
= dev
->width
<< 1;
657 dma_q
->lines_completed
= 0;
660 int cx231xx_do_vbi_copy(struct cx231xx
*dev
, struct cx231xx_dmaqueue
*dma_q
,
661 u8
*p_buffer
, u32 bytes_to_copy
)
663 u8
*p_out_buffer
= NULL
;
664 u32 current_line_bytes_copied
= 0;
665 struct cx231xx_buffer
*buf
;
666 u32 _line_size
= dev
->width
<< 1;
670 buf
= dev
->vbi_mode
.isoc_ctl
.buf
;
675 p_out_buffer
= videobuf_to_vmalloc(&buf
->vb
);
677 if (dma_q
->bytes_left_in_line
!= _line_size
) {
678 current_line_bytes_copied
=
679 _line_size
- dma_q
->bytes_left_in_line
;
682 offset
= (dma_q
->lines_completed
* _line_size
) +
683 current_line_bytes_copied
;
685 /* prepare destination address */
686 startwrite
= p_out_buffer
+ offset
;
688 lencopy
= dma_q
->bytes_left_in_line
> bytes_to_copy
?
689 bytes_to_copy
: dma_q
->bytes_left_in_line
;
691 memcpy(startwrite
, p_buffer
, lencopy
);
696 u8
cx231xx_is_vbi_buffer_done(struct cx231xx
*dev
,
697 struct cx231xx_dmaqueue
*dma_q
)
701 height
= ((dev
->norm
& V4L2_STD_625_50
) ?
702 PAL_VBI_LINES
: NTSC_VBI_LINES
);
703 return (dma_q
->lines_completed
== height
) ? 1 : 0;