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(
144 p_buffer + bytes_parsed, /* p_buffer */
145 buffer_size - bytes_parsed, /* buffer size */
146 &bytes_used); /* bytes used to get SAV/EAV */
148 bytes_parsed += bytes_used;
151 if (sav_eav && (bytes_parsed < buffer_size)) {
152 bytes_parsed += cx231xx_get_vbi_line(dev,
153 dma_q, sav_eav, /* SAV/EAV */
154 p_buffer+bytes_parsed, /* p_buffer */
155 buffer_size-bytes_parsed);/*buf size*/
159 /* Save the last four bytes of the buffer so we can
160 check the buffer boundary condition next time */
161 memcpy(dma_q->partial_buf, p_buffer + buffer_size - 4, 4);
168 /* ------------------------------------------------------------------
170 ------------------------------------------------------------------*/
173 vbi_buffer_setup(struct videobuf_queue *vq, unsigned int *count,
176 struct cx231xx_fh *fh = vq->priv_data;
177 struct cx231xx *dev = fh->dev;
180 height = ((dev->norm & V4L2_STD_625_50) ?
181 PAL_VBI_LINES : NTSC_VBI_LINES);
183 *size = (dev->width * height * 2);
185 *count = CX231XX_DEF_VBI_BUF;
187 if (*count < CX231XX_MIN_BUF)
188 *count = CX231XX_MIN_BUF;
190 /* call VBI setup if required */
191 /* cx231xx_i2c_call_clients(&dev->i2c_bus[1], VIDIOC_S_FREQUENCY, &f);
197 /* This is called *without* dev->slock held; please keep it that way */
198 static void free_buffer(struct videobuf_queue *vq, struct cx231xx_buffer *buf)
200 struct cx231xx_fh *fh = vq->priv_data;
201 struct cx231xx *dev = fh->dev;
202 unsigned long flags = 0;
206 /* We used to wait for the buffer to finish here, but this didn't work
207 because, as we were keeping the state as VIDEOBUF_QUEUED,
208 videobuf_queue_cancel marked it as finished for us.
209 (Also, it could wedge forever if the hardware was misconfigured.)
211 This should be safe; by the time we get here, the buffer isn't
212 queued anymore. If we ever start marking the buffers as
213 VIDEOBUF_ACTIVE, it won't be, though.
215 spin_lock_irqsave(&dev->vbi_mode.slock, flags);
216 if (dev->vbi_mode.isoc_ctl.buf == buf)
217 dev->vbi_mode.isoc_ctl.buf = NULL;
218 spin_unlock_irqrestore(&dev->vbi_mode.slock, flags);
220 videobuf_vmalloc_free(&buf->vb);
221 buf->vb.state = VIDEOBUF_NEEDS_INIT;
225 vbi_buffer_prepare(struct videobuf_queue *vq, struct videobuf_buffer *vb,
226 enum v4l2_field field)
228 struct cx231xx_fh *fh = vq->priv_data;
229 struct cx231xx_buffer *buf =
230 container_of(vb, struct cx231xx_buffer, vb);
231 struct cx231xx *dev = fh->dev;
232 int rc = 0, urb_init = 0;
235 height = ((dev->norm & V4L2_STD_625_50) ?
236 PAL_VBI_LINES : NTSC_VBI_LINES);
237 buf->vb.size = ((dev->width << 1) * height);
239 if (0 != buf->vb.baddr && buf->vb.bsize < buf->vb.size)
242 buf->vb.width = dev->width;
243 buf->vb.height = height;
244 buf->vb.field = field;
245 buf->vb.field = V4L2_FIELD_SEQ_TB;
247 if (VIDEOBUF_NEEDS_INIT == buf->vb.state) {
248 rc = videobuf_iolock(vq, &buf->vb, NULL);
253 if (!dev->vbi_mode.isoc_ctl.num_bufs)
257 rc = cx231xx_init_vbi_isoc(dev, CX231XX_NUM_VBI_PACKETS,
258 CX231XX_NUM_VBI_BUFS,
259 dev->vbi_mode.alt_max_pkt_size[0],
260 cx231xx_isoc_vbi_copy);
265 buf->vb.state = VIDEOBUF_PREPARED;
269 free_buffer(vq, buf);
274 vbi_buffer_queue(struct videobuf_queue *vq, struct videobuf_buffer *vb)
276 struct cx231xx_buffer *buf =
277 container_of(vb, struct cx231xx_buffer, vb);
278 struct cx231xx_fh *fh = vq->priv_data;
279 struct cx231xx *dev = fh->dev;
280 struct cx231xx_dmaqueue *vidq = &dev->vbi_mode.vidq;
282 buf->vb.state = VIDEOBUF_QUEUED;
283 list_add_tail(&buf->vb.queue, &vidq->active);
287 static void vbi_buffer_release(struct videobuf_queue *vq,
288 struct videobuf_buffer *vb)
290 struct cx231xx_buffer *buf =
291 container_of(vb, struct cx231xx_buffer, vb);
294 free_buffer(vq, buf);
297 struct videobuf_queue_ops cx231xx_vbi_qops = {
298 .buf_setup = vbi_buffer_setup,
299 .buf_prepare = vbi_buffer_prepare,
300 .buf_queue = vbi_buffer_queue,
301 .buf_release = vbi_buffer_release,
304 /* ------------------------------------------------------------------
306 ------------------------------------------------------------------*/
309 * IRQ callback, called by URB callback
311 static void cx231xx_irq_vbi_callback(struct urb *urb)
313 struct cx231xx_dmaqueue *dma_q = urb->context;
314 struct cx231xx_video_mode *vmode =
315 container_of(dma_q, struct cx231xx_video_mode, vidq);
316 struct cx231xx *dev = container_of(vmode, struct cx231xx, vbi_mode);
319 switch (urb->status) {
320 case 0: /* success */
321 case -ETIMEDOUT: /* NAK */
323 case -ECONNRESET: /* kill */
328 cx231xx_err(DRIVER_NAME "urb completition error %d.\n",
333 /* Copy data from URB */
334 spin_lock(&dev->vbi_mode.slock);
335 rc = dev->vbi_mode.isoc_ctl.isoc_copy(dev, urb);
336 spin_unlock(&dev->vbi_mode.slock);
341 urb->status = usb_submit_urb(urb, GFP_ATOMIC);
343 cx231xx_err(DRIVER_NAME "urb resubmit failed (error=%i)\n",
349 * Stop and Deallocate URBs
351 void cx231xx_uninit_vbi_isoc(struct cx231xx *dev)
356 cx231xx_info(DRIVER_NAME "cx231xx: called cx231xx_uninit_vbi_isoc\n");
358 dev->vbi_mode.isoc_ctl.nfields = -1;
359 for (i = 0; i < dev->vbi_mode.isoc_ctl.num_bufs; i++) {
360 urb = dev->vbi_mode.isoc_ctl.urb[i];
362 if (!irqs_disabled())
367 if (dev->vbi_mode.isoc_ctl.transfer_buffer[i]) {
369 kfree(dev->vbi_mode.isoc_ctl.
371 dev->vbi_mode.isoc_ctl.transfer_buffer[i] =
375 dev->vbi_mode.isoc_ctl.urb[i] = NULL;
377 dev->vbi_mode.isoc_ctl.transfer_buffer[i] = NULL;
380 kfree(dev->vbi_mode.isoc_ctl.urb);
381 kfree(dev->vbi_mode.isoc_ctl.transfer_buffer);
383 dev->vbi_mode.isoc_ctl.urb = NULL;
384 dev->vbi_mode.isoc_ctl.transfer_buffer = NULL;
385 dev->vbi_mode.isoc_ctl.num_bufs = 0;
387 cx231xx_capture_start(dev, 0, Vbi);
389 EXPORT_SYMBOL_GPL(cx231xx_uninit_vbi_isoc);
392 * Allocate URBs and start IRQ
394 int cx231xx_init_vbi_isoc(struct cx231xx *dev, int max_packets,
395 int num_bufs, int max_pkt_size,
396 int (*isoc_copy) (struct cx231xx *dev,
399 struct cx231xx_dmaqueue *dma_q = &dev->vbi_mode.vidq;
405 cx231xx_info(DRIVER_NAME "cx231xx: called cx231xx_prepare_isoc\n");
407 /* De-allocates all pending stuff */
408 cx231xx_uninit_vbi_isoc(dev);
410 /* clear if any halt */
411 usb_clear_halt(dev->udev,
412 usb_rcvbulkpipe(dev->udev,
413 dev->vbi_mode.end_point_addr));
415 dev->vbi_mode.isoc_ctl.isoc_copy = isoc_copy;
416 dev->vbi_mode.isoc_ctl.num_bufs = num_bufs;
418 dma_q->is_partial_line = 0;
420 dma_q->current_field = -1;
421 dma_q->bytes_left_in_line = dev->width << 1;
422 dma_q->lines_per_field = ((dev->norm & V4L2_STD_625_50) ?
423 PAL_VBI_LINES : NTSC_VBI_LINES);
424 dma_q->lines_completed = 0;
425 for (i = 0; i < 8; i++)
426 dma_q->partial_buf[i] = 0;
428 dev->vbi_mode.isoc_ctl.urb = kzalloc(sizeof(void *) * num_bufs,
430 if (!dev->vbi_mode.isoc_ctl.urb) {
431 cx231xx_errdev("cannot alloc memory for usb buffers\n");
435 dev->vbi_mode.isoc_ctl.transfer_buffer =
436 kzalloc(sizeof(void *) * num_bufs, GFP_KERNEL);
437 if (!dev->vbi_mode.isoc_ctl.transfer_buffer) {
438 cx231xx_errdev("cannot allocate memory for usbtransfer\n");
439 kfree(dev->vbi_mode.isoc_ctl.urb);
443 dev->vbi_mode.isoc_ctl.max_pkt_size = max_pkt_size;
444 dev->vbi_mode.isoc_ctl.buf = NULL;
446 sb_size = max_packets * dev->vbi_mode.isoc_ctl.max_pkt_size;
448 /* allocate urbs and transfer buffers */
449 for (i = 0; i < dev->vbi_mode.isoc_ctl.num_bufs; i++) {
451 urb = usb_alloc_urb(0, GFP_KERNEL);
453 cx231xx_err(DRIVER_NAME
454 ": cannot alloc isoc_ctl.urb %i\n", i);
455 cx231xx_uninit_vbi_isoc(dev);
458 dev->vbi_mode.isoc_ctl.urb[i] = urb;
459 urb->transfer_flags = 0;
461 dev->vbi_mode.isoc_ctl.transfer_buffer[i] =
462 kzalloc(sb_size, GFP_KERNEL);
463 if (!dev->vbi_mode.isoc_ctl.transfer_buffer[i]) {
464 cx231xx_err(DRIVER_NAME
465 ": unable to allocate %i bytes for transfer"
466 " buffer %i%s\n", sb_size, i,
467 in_interrupt() ? " while in int" : "");
468 cx231xx_uninit_vbi_isoc(dev);
472 pipe = usb_rcvbulkpipe(dev->udev, dev->vbi_mode.end_point_addr);
473 usb_fill_bulk_urb(urb, dev->udev, pipe,
474 dev->vbi_mode.isoc_ctl.transfer_buffer[i],
475 sb_size, cx231xx_irq_vbi_callback, dma_q);
478 init_waitqueue_head(&dma_q->wq);
480 /* submit urbs and enables IRQ */
481 for (i = 0; i < dev->vbi_mode.isoc_ctl.num_bufs; i++) {
482 rc = usb_submit_urb(dev->vbi_mode.isoc_ctl.urb[i], GFP_ATOMIC);
484 cx231xx_err(DRIVER_NAME
485 ": submit of urb %i failed (error=%i)\n", i,
487 cx231xx_uninit_vbi_isoc(dev);
492 cx231xx_capture_start(dev, 1, Vbi);
496 EXPORT_SYMBOL_GPL(cx231xx_init_vbi_isoc);
498 u32 cx231xx_get_vbi_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
499 u8 sav_eav, u8 *p_buffer, u32 buffer_size)
501 u32 bytes_copied = 0;
502 int current_field = -1;
517 if (current_field < 0)
520 dma_q->last_sav = sav_eav;
523 cx231xx_copy_vbi_line(dev, dma_q, p_buffer, buffer_size,
530 * Announces that a buffer were filled and request the next
532 static inline void vbi_buffer_filled(struct cx231xx *dev,
533 struct cx231xx_dmaqueue *dma_q,
534 struct cx231xx_buffer *buf)
536 /* Advice that buffer was filled */
537 /* cx231xx_info(DRIVER_NAME "[%p/%d] wakeup\n", buf, buf->vb.i); */
539 buf->vb.state = VIDEOBUF_DONE;
540 buf->vb.field_count++;
541 do_gettimeofday(&buf->vb.ts);
543 dev->vbi_mode.isoc_ctl.buf = NULL;
545 list_del(&buf->vb.queue);
546 wake_up(&buf->vb.done);
549 u32 cx231xx_copy_vbi_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
550 u8 *p_line, u32 length, int field_number)
553 struct cx231xx_buffer *buf;
554 u32 _line_size = dev->width * 2;
556 if (dma_q->current_field != field_number)
557 cx231xx_reset_vbi_buffer(dev, dma_q);
559 /* get the buffer pointer */
560 buf = dev->vbi_mode.isoc_ctl.buf;
562 /* Remember the field number for next time */
563 dma_q->current_field = field_number;
565 bytes_to_copy = dma_q->bytes_left_in_line;
566 if (bytes_to_copy > length)
567 bytes_to_copy = length;
569 if (dma_q->lines_completed >= dma_q->lines_per_field) {
570 dma_q->bytes_left_in_line -= bytes_to_copy;
571 dma_q->is_partial_line =
572 (dma_q->bytes_left_in_line == 0) ? 0 : 1;
576 dma_q->is_partial_line = 1;
578 /* If we don't have a buffer, just return the number of bytes we would
579 have copied if we had a buffer. */
581 dma_q->bytes_left_in_line -= bytes_to_copy;
582 dma_q->is_partial_line =
583 (dma_q->bytes_left_in_line == 0) ? 0 : 1;
584 return bytes_to_copy;
587 /* copy the data to video buffer */
588 cx231xx_do_vbi_copy(dev, dma_q, p_line, bytes_to_copy);
590 dma_q->pos += bytes_to_copy;
591 dma_q->bytes_left_in_line -= bytes_to_copy;
593 if (dma_q->bytes_left_in_line == 0) {
595 dma_q->bytes_left_in_line = _line_size;
596 dma_q->lines_completed++;
597 dma_q->is_partial_line = 0;
599 if (cx231xx_is_vbi_buffer_done(dev, dma_q) && buf) {
601 vbi_buffer_filled(dev, dma_q, buf);
605 dma_q->lines_completed = 0;
609 return bytes_to_copy;
613 * video-buf generic routine to get the next available buffer
615 static inline void get_next_vbi_buf(struct cx231xx_dmaqueue *dma_q,
616 struct cx231xx_buffer **buf)
618 struct cx231xx_video_mode *vmode =
619 container_of(dma_q, struct cx231xx_video_mode, vidq);
620 struct cx231xx *dev = container_of(vmode, struct cx231xx, vbi_mode);
623 if (list_empty(&dma_q->active)) {
624 cx231xx_err(DRIVER_NAME ": No active queue to serve\n");
625 dev->vbi_mode.isoc_ctl.buf = NULL;
630 /* Get the next buffer */
631 *buf = list_entry(dma_q->active.next, struct cx231xx_buffer, vb.queue);
633 /* Cleans up buffer - Usefull for testing for frame/URB loss */
634 outp = videobuf_to_vmalloc(&(*buf)->vb);
635 memset(outp, 0, (*buf)->vb.size);
637 dev->vbi_mode.isoc_ctl.buf = *buf;
642 void cx231xx_reset_vbi_buffer(struct cx231xx *dev,
643 struct cx231xx_dmaqueue *dma_q)
645 struct cx231xx_buffer *buf;
647 buf = dev->vbi_mode.isoc_ctl.buf;
650 /* first try to get the buffer */
651 get_next_vbi_buf(dma_q, &buf);
654 dma_q->current_field = -1;
657 dma_q->bytes_left_in_line = dev->width << 1;
658 dma_q->lines_completed = 0;
661 int cx231xx_do_vbi_copy(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
662 u8 *p_buffer, u32 bytes_to_copy)
664 u8 *p_out_buffer = NULL;
665 u32 current_line_bytes_copied = 0;
666 struct cx231xx_buffer *buf;
667 u32 _line_size = dev->width << 1;
671 buf = dev->vbi_mode.isoc_ctl.buf;
676 p_out_buffer = videobuf_to_vmalloc(&buf->vb);
678 if (dma_q->bytes_left_in_line != _line_size) {
679 current_line_bytes_copied =
680 _line_size - dma_q->bytes_left_in_line;
683 offset = (dma_q->lines_completed * _line_size) +
684 current_line_bytes_copied;
686 /* prepare destination address */
687 startwrite = p_out_buffer + offset;
689 lencopy = dma_q->bytes_left_in_line > bytes_to_copy ?
690 bytes_to_copy : dma_q->bytes_left_in_line;
692 memcpy(startwrite, p_buffer, lencopy);
697 u8 cx231xx_is_vbi_buffer_done(struct cx231xx *dev,
698 struct cx231xx_dmaqueue *dma_q)
702 height = ((dev->norm & V4L2_STD_625_50) ?
703 PAL_VBI_LINES : NTSC_VBI_LINES);
704 return (dma_q->lines_completed == height) ? 1 : 0;