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.
23 #include <linux/init.h>
24 #include <linux/list.h>
25 #include <linux/module.h>
26 #include <linux/kernel.h>
27 #include <linux/bitmap.h>
28 #include <linux/i2c.h>
30 #include <linux/mutex.h>
31 #include <linux/slab.h>
33 #include <media/v4l2-common.h>
34 #include <media/v4l2-ioctl.h>
35 #include <media/msp3400.h>
36 #include <media/tuner.h>
38 #include "cx231xx-vbi.h"
40 static inline void print_err_status(struct cx231xx *dev, int packet, int status)
42 char *errmsg = "Unknown";
46 errmsg = "unlinked synchronuously";
49 errmsg = "unlinked asynchronuously";
52 errmsg = "Buffer error (overrun)";
55 errmsg = "Stalled (device not responding)";
58 errmsg = "Babble (bad cable?)";
61 errmsg = "Bit-stuff error (bad cable?)";
64 errmsg = "CRC/Timeout (could be anything)";
67 errmsg = "Device does not respond";
72 "URB status %d [%s].\n", status, errmsg);
75 "URB packet %d, status %d [%s].\n",
76 packet, status, errmsg);
81 * Controls the isoc copy of each urb packet
83 static inline int cx231xx_isoc_vbi_copy(struct cx231xx *dev, struct urb *urb)
85 struct cx231xx_dmaqueue *dma_q = urb->context;
87 unsigned char *p_buffer;
88 u32 bytes_parsed = 0, buffer_size = 0;
94 if (dev->state & DEV_DISCONNECTED)
97 if (urb->status < 0) {
98 print_err_status(dev, -1, urb->status);
99 if (urb->status == -ENOENT)
103 /* get buffer pointer and length */
104 p_buffer = urb->transfer_buffer;
105 buffer_size = urb->actual_length;
107 if (buffer_size > 0) {
110 if (dma_q->is_partial_line) {
111 /* Handle the case where we were working on a partial
113 sav_eav = dma_q->last_sav;
115 /* Check for a SAV/EAV overlapping the
118 sav_eav = cx231xx_find_boundary_SAV_EAV(p_buffer,
124 /* Get the first line if we have some portion of an SAV/EAV from
125 the last buffer or a partial line */
127 bytes_parsed += cx231xx_get_vbi_line(dev, dma_q,
128 sav_eav, /* SAV/EAV */
129 p_buffer + bytes_parsed, /* p_buffer */
130 buffer_size - bytes_parsed); /* buffer size */
133 /* Now parse data that is completely in this buffer */
134 dma_q->is_partial_line = 0;
136 while (bytes_parsed < buffer_size) {
139 sav_eav = cx231xx_find_next_SAV_EAV(
140 p_buffer + bytes_parsed, /* p_buffer */
141 buffer_size - bytes_parsed, /* buffer size */
142 &bytes_used); /* bytes used to get SAV/EAV */
144 bytes_parsed += bytes_used;
147 if (sav_eav && (bytes_parsed < buffer_size)) {
148 bytes_parsed += cx231xx_get_vbi_line(dev,
149 dma_q, sav_eav, /* SAV/EAV */
150 p_buffer+bytes_parsed, /* p_buffer */
151 buffer_size-bytes_parsed);/*buf size*/
155 /* Save the last four bytes of the buffer so we can
156 check the buffer boundary condition next time */
157 memcpy(dma_q->partial_buf, p_buffer + buffer_size - 4, 4);
164 /* ------------------------------------------------------------------
166 ------------------------------------------------------------------*/
169 vbi_buffer_setup(struct videobuf_queue *vq, unsigned int *count,
172 struct cx231xx_fh *fh = vq->priv_data;
173 struct cx231xx *dev = fh->dev;
176 height = ((dev->norm & V4L2_STD_625_50) ?
177 PAL_VBI_LINES : NTSC_VBI_LINES);
179 *size = (dev->width * height * 2 * 2);
181 *count = CX231XX_DEF_VBI_BUF;
183 if (*count < CX231XX_MIN_BUF)
184 *count = CX231XX_MIN_BUF;
189 /* This is called *without* dev->slock held; please keep it that way */
190 static void free_buffer(struct videobuf_queue *vq, struct cx231xx_buffer *buf)
192 struct cx231xx_fh *fh = vq->priv_data;
193 struct cx231xx *dev = fh->dev;
194 unsigned long flags = 0;
198 /* We used to wait for the buffer to finish here, but this didn't work
199 because, as we were keeping the state as VIDEOBUF_QUEUED,
200 videobuf_queue_cancel marked it as finished for us.
201 (Also, it could wedge forever if the hardware was misconfigured.)
203 This should be safe; by the time we get here, the buffer isn't
204 queued anymore. If we ever start marking the buffers as
205 VIDEOBUF_ACTIVE, it won't be, though.
207 spin_lock_irqsave(&dev->vbi_mode.slock, flags);
208 if (dev->vbi_mode.bulk_ctl.buf == buf)
209 dev->vbi_mode.bulk_ctl.buf = NULL;
210 spin_unlock_irqrestore(&dev->vbi_mode.slock, flags);
212 videobuf_vmalloc_free(&buf->vb);
213 buf->vb.state = VIDEOBUF_NEEDS_INIT;
217 vbi_buffer_prepare(struct videobuf_queue *vq, struct videobuf_buffer *vb,
218 enum v4l2_field field)
220 struct cx231xx_fh *fh = vq->priv_data;
221 struct cx231xx_buffer *buf =
222 container_of(vb, struct cx231xx_buffer, vb);
223 struct cx231xx *dev = fh->dev;
224 int rc = 0, urb_init = 0;
227 height = ((dev->norm & V4L2_STD_625_50) ?
228 PAL_VBI_LINES : NTSC_VBI_LINES);
229 buf->vb.size = ((dev->width << 1) * height * 2);
231 if (0 != buf->vb.baddr && buf->vb.bsize < buf->vb.size)
234 buf->vb.width = dev->width;
235 buf->vb.height = height;
236 buf->vb.field = field;
237 buf->vb.field = V4L2_FIELD_SEQ_TB;
239 if (VIDEOBUF_NEEDS_INIT == buf->vb.state) {
240 rc = videobuf_iolock(vq, &buf->vb, NULL);
245 if (!dev->vbi_mode.bulk_ctl.num_bufs)
249 rc = cx231xx_init_vbi_isoc(dev, CX231XX_NUM_VBI_PACKETS,
250 CX231XX_NUM_VBI_BUFS,
251 dev->vbi_mode.alt_max_pkt_size[0],
252 cx231xx_isoc_vbi_copy);
257 buf->vb.state = VIDEOBUF_PREPARED;
261 free_buffer(vq, buf);
266 vbi_buffer_queue(struct videobuf_queue *vq, struct videobuf_buffer *vb)
268 struct cx231xx_buffer *buf =
269 container_of(vb, struct cx231xx_buffer, vb);
270 struct cx231xx_fh *fh = vq->priv_data;
271 struct cx231xx *dev = fh->dev;
272 struct cx231xx_dmaqueue *vidq = &dev->vbi_mode.vidq;
274 buf->vb.state = VIDEOBUF_QUEUED;
275 list_add_tail(&buf->vb.queue, &vidq->active);
279 static void vbi_buffer_release(struct videobuf_queue *vq,
280 struct videobuf_buffer *vb)
282 struct cx231xx_buffer *buf =
283 container_of(vb, struct cx231xx_buffer, vb);
286 free_buffer(vq, buf);
289 struct videobuf_queue_ops cx231xx_vbi_qops = {
290 .buf_setup = vbi_buffer_setup,
291 .buf_prepare = vbi_buffer_prepare,
292 .buf_queue = vbi_buffer_queue,
293 .buf_release = vbi_buffer_release,
296 /* ------------------------------------------------------------------
298 ------------------------------------------------------------------*/
301 * IRQ callback, called by URB callback
303 static void cx231xx_irq_vbi_callback(struct urb *urb)
305 struct cx231xx_dmaqueue *dma_q = urb->context;
306 struct cx231xx_video_mode *vmode =
307 container_of(dma_q, struct cx231xx_video_mode, vidq);
308 struct cx231xx *dev = container_of(vmode, struct cx231xx, vbi_mode);
310 switch (urb->status) {
311 case 0: /* success */
312 case -ETIMEDOUT: /* NAK */
314 case -ECONNRESET: /* kill */
320 "urb completition error %d.\n", urb->status);
324 /* Copy data from URB */
325 spin_lock(&dev->vbi_mode.slock);
326 dev->vbi_mode.bulk_ctl.bulk_copy(dev, urb);
327 spin_unlock(&dev->vbi_mode.slock);
332 urb->status = usb_submit_urb(urb, GFP_ATOMIC);
334 dev_err(dev->dev, "urb resubmit failed (error=%i)\n",
340 * Stop and Deallocate URBs
342 void cx231xx_uninit_vbi_isoc(struct cx231xx *dev)
347 dev_dbg(dev->dev, "called cx231xx_uninit_vbi_isoc\n");
349 dev->vbi_mode.bulk_ctl.nfields = -1;
350 for (i = 0; i < dev->vbi_mode.bulk_ctl.num_bufs; i++) {
351 urb = dev->vbi_mode.bulk_ctl.urb[i];
353 if (!irqs_disabled())
358 if (dev->vbi_mode.bulk_ctl.transfer_buffer[i]) {
360 kfree(dev->vbi_mode.bulk_ctl.
362 dev->vbi_mode.bulk_ctl.transfer_buffer[i] =
366 dev->vbi_mode.bulk_ctl.urb[i] = NULL;
368 dev->vbi_mode.bulk_ctl.transfer_buffer[i] = NULL;
371 kfree(dev->vbi_mode.bulk_ctl.urb);
372 kfree(dev->vbi_mode.bulk_ctl.transfer_buffer);
374 dev->vbi_mode.bulk_ctl.urb = NULL;
375 dev->vbi_mode.bulk_ctl.transfer_buffer = NULL;
376 dev->vbi_mode.bulk_ctl.num_bufs = 0;
378 cx231xx_capture_start(dev, 0, Vbi);
380 EXPORT_SYMBOL_GPL(cx231xx_uninit_vbi_isoc);
383 * Allocate URBs and start IRQ
385 int cx231xx_init_vbi_isoc(struct cx231xx *dev, int max_packets,
386 int num_bufs, int max_pkt_size,
387 int (*bulk_copy) (struct cx231xx *dev,
390 struct cx231xx_dmaqueue *dma_q = &dev->vbi_mode.vidq;
396 dev_dbg(dev->dev, "called cx231xx_vbi_isoc\n");
398 /* De-allocates all pending stuff */
399 cx231xx_uninit_vbi_isoc(dev);
401 /* clear if any halt */
402 usb_clear_halt(dev->udev,
403 usb_rcvbulkpipe(dev->udev,
404 dev->vbi_mode.end_point_addr));
406 dev->vbi_mode.bulk_ctl.bulk_copy = bulk_copy;
407 dev->vbi_mode.bulk_ctl.num_bufs = num_bufs;
409 dma_q->is_partial_line = 0;
411 dma_q->current_field = -1;
412 dma_q->bytes_left_in_line = dev->width << 1;
413 dma_q->lines_per_field = ((dev->norm & V4L2_STD_625_50) ?
414 PAL_VBI_LINES : NTSC_VBI_LINES);
415 dma_q->lines_completed = 0;
416 for (i = 0; i < 8; i++)
417 dma_q->partial_buf[i] = 0;
419 dev->vbi_mode.bulk_ctl.urb = kzalloc(sizeof(void *) * num_bufs,
421 if (!dev->vbi_mode.bulk_ctl.urb) {
423 "cannot alloc memory for usb buffers\n");
427 dev->vbi_mode.bulk_ctl.transfer_buffer =
428 kzalloc(sizeof(void *) * num_bufs, GFP_KERNEL);
429 if (!dev->vbi_mode.bulk_ctl.transfer_buffer) {
431 "cannot allocate memory for usbtransfer\n");
432 kfree(dev->vbi_mode.bulk_ctl.urb);
436 dev->vbi_mode.bulk_ctl.max_pkt_size = max_pkt_size;
437 dev->vbi_mode.bulk_ctl.buf = NULL;
439 sb_size = max_packets * dev->vbi_mode.bulk_ctl.max_pkt_size;
441 /* allocate urbs and transfer buffers */
442 for (i = 0; i < dev->vbi_mode.bulk_ctl.num_bufs; i++) {
444 urb = usb_alloc_urb(0, GFP_KERNEL);
447 "cannot alloc bulk_ctl.urb %i\n", i);
448 cx231xx_uninit_vbi_isoc(dev);
451 dev->vbi_mode.bulk_ctl.urb[i] = urb;
452 urb->transfer_flags = 0;
454 dev->vbi_mode.bulk_ctl.transfer_buffer[i] =
455 kzalloc(sb_size, GFP_KERNEL);
456 if (!dev->vbi_mode.bulk_ctl.transfer_buffer[i]) {
458 "unable to allocate %i bytes for transfer buffer %i%s\n",
460 in_interrupt() ? " while in int" : "");
461 cx231xx_uninit_vbi_isoc(dev);
465 pipe = usb_rcvbulkpipe(dev->udev, dev->vbi_mode.end_point_addr);
466 usb_fill_bulk_urb(urb, dev->udev, pipe,
467 dev->vbi_mode.bulk_ctl.transfer_buffer[i],
468 sb_size, cx231xx_irq_vbi_callback, dma_q);
471 init_waitqueue_head(&dma_q->wq);
473 /* submit urbs and enables IRQ */
474 for (i = 0; i < dev->vbi_mode.bulk_ctl.num_bufs; i++) {
475 rc = usb_submit_urb(dev->vbi_mode.bulk_ctl.urb[i], GFP_ATOMIC);
478 "submit of urb %i failed (error=%i)\n", i, rc);
479 cx231xx_uninit_vbi_isoc(dev);
484 cx231xx_capture_start(dev, 1, Vbi);
488 EXPORT_SYMBOL_GPL(cx231xx_init_vbi_isoc);
490 u32 cx231xx_get_vbi_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
491 u8 sav_eav, u8 *p_buffer, u32 buffer_size)
493 u32 bytes_copied = 0;
494 int current_field = -1;
509 if (current_field < 0)
512 dma_q->last_sav = sav_eav;
515 cx231xx_copy_vbi_line(dev, dma_q, p_buffer, buffer_size,
522 * Announces that a buffer were filled and request the next
524 static inline void vbi_buffer_filled(struct cx231xx *dev,
525 struct cx231xx_dmaqueue *dma_q,
526 struct cx231xx_buffer *buf)
528 /* Advice that buffer was filled */
529 /* dev_dbg(dev->dev, "[%p/%d] wakeup\n", buf, buf->vb.i); */
531 buf->vb.state = VIDEOBUF_DONE;
532 buf->vb.field_count++;
533 v4l2_get_timestamp(&buf->vb.ts);
535 dev->vbi_mode.bulk_ctl.buf = NULL;
537 list_del(&buf->vb.queue);
538 wake_up(&buf->vb.done);
541 u32 cx231xx_copy_vbi_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
542 u8 *p_line, u32 length, int field_number)
545 struct cx231xx_buffer *buf;
546 u32 _line_size = dev->width * 2;
548 if (dma_q->current_field == -1) {
549 /* Just starting up */
550 cx231xx_reset_vbi_buffer(dev, dma_q);
553 if (dma_q->current_field != field_number)
554 dma_q->lines_completed = 0;
556 /* get the buffer pointer */
557 buf = dev->vbi_mode.bulk_ctl.buf;
559 /* Remember the field number for next time */
560 dma_q->current_field = field_number;
562 bytes_to_copy = dma_q->bytes_left_in_line;
563 if (bytes_to_copy > length)
564 bytes_to_copy = length;
566 if (dma_q->lines_completed >= dma_q->lines_per_field) {
567 dma_q->bytes_left_in_line -= bytes_to_copy;
568 dma_q->is_partial_line =
569 (dma_q->bytes_left_in_line == 0) ? 0 : 1;
573 dma_q->is_partial_line = 1;
575 /* If we don't have a buffer, just return the number of bytes we would
576 have copied if we had a buffer. */
578 dma_q->bytes_left_in_line -= bytes_to_copy;
579 dma_q->is_partial_line =
580 (dma_q->bytes_left_in_line == 0) ? 0 : 1;
581 return bytes_to_copy;
584 /* copy the data to video buffer */
585 cx231xx_do_vbi_copy(dev, dma_q, p_line, bytes_to_copy);
587 dma_q->pos += bytes_to_copy;
588 dma_q->bytes_left_in_line -= bytes_to_copy;
590 if (dma_q->bytes_left_in_line == 0) {
592 dma_q->bytes_left_in_line = _line_size;
593 dma_q->lines_completed++;
594 dma_q->is_partial_line = 0;
596 if (cx231xx_is_vbi_buffer_done(dev, dma_q) && buf) {
598 vbi_buffer_filled(dev, dma_q, buf);
601 dma_q->lines_completed = 0;
602 cx231xx_reset_vbi_buffer(dev, dma_q);
606 return bytes_to_copy;
610 * video-buf generic routine to get the next available buffer
612 static inline void get_next_vbi_buf(struct cx231xx_dmaqueue *dma_q,
613 struct cx231xx_buffer **buf)
615 struct cx231xx_video_mode *vmode =
616 container_of(dma_q, struct cx231xx_video_mode, vidq);
617 struct cx231xx *dev = container_of(vmode, struct cx231xx, vbi_mode);
620 if (list_empty(&dma_q->active)) {
621 dev_err(dev->dev, "No active queue to serve\n");
622 dev->vbi_mode.bulk_ctl.buf = NULL;
627 /* Get the next buffer */
628 *buf = list_entry(dma_q->active.next, struct cx231xx_buffer, vb.queue);
630 /* Cleans up buffer - Useful for testing for frame/URB loss */
631 outp = videobuf_to_vmalloc(&(*buf)->vb);
632 memset(outp, 0, (*buf)->vb.size);
634 dev->vbi_mode.bulk_ctl.buf = *buf;
639 void cx231xx_reset_vbi_buffer(struct cx231xx *dev,
640 struct cx231xx_dmaqueue *dma_q)
642 struct cx231xx_buffer *buf;
644 buf = dev->vbi_mode.bulk_ctl.buf;
647 /* first try to get the buffer */
648 get_next_vbi_buf(dma_q, &buf);
651 dma_q->current_field = -1;
654 dma_q->bytes_left_in_line = dev->width << 1;
655 dma_q->lines_completed = 0;
658 int cx231xx_do_vbi_copy(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
659 u8 *p_buffer, u32 bytes_to_copy)
661 u8 *p_out_buffer = NULL;
662 u32 current_line_bytes_copied = 0;
663 struct cx231xx_buffer *buf;
664 u32 _line_size = dev->width << 1;
668 buf = dev->vbi_mode.bulk_ctl.buf;
673 p_out_buffer = videobuf_to_vmalloc(&buf->vb);
675 if (dma_q->bytes_left_in_line != _line_size) {
676 current_line_bytes_copied =
677 _line_size - dma_q->bytes_left_in_line;
680 offset = (dma_q->lines_completed * _line_size) +
681 current_line_bytes_copied;
683 if (dma_q->current_field == 2) {
684 /* Populate the second half of the frame */
685 offset += (dev->width * 2 * dma_q->lines_per_field);
688 /* prepare destination address */
689 startwrite = p_out_buffer + offset;
691 lencopy = dma_q->bytes_left_in_line > bytes_to_copy ?
692 bytes_to_copy : dma_q->bytes_left_in_line;
694 memcpy(startwrite, p_buffer, lencopy);
699 u8 cx231xx_is_vbi_buffer_done(struct cx231xx *dev,
700 struct cx231xx_dmaqueue *dma_q)
704 height = ((dev->norm & V4L2_STD_625_50) ?
705 PAL_VBI_LINES : NTSC_VBI_LINES);
706 if (dma_q->lines_completed == height && dma_q->current_field == 2)