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;
195 BUG_ON(in_interrupt());
197 /* We used to wait for the buffer to finish here, but this didn't work
198 because, as we were keeping the state as VIDEOBUF_QUEUED,
199 videobuf_queue_cancel marked it as finished for us.
200 (Also, it could wedge forever if the hardware was misconfigured.)
202 This should be safe; by the time we get here, the buffer isn't
203 queued anymore. If we ever start marking the buffers as
204 VIDEOBUF_ACTIVE, it won't be, though.
206 spin_lock_irqsave(&dev->vbi_mode.slock, flags);
207 if (dev->vbi_mode.bulk_ctl.buf == buf)
208 dev->vbi_mode.bulk_ctl.buf = NULL;
209 spin_unlock_irqrestore(&dev->vbi_mode.slock, flags);
211 videobuf_vmalloc_free(&buf->vb);
212 buf->vb.state = VIDEOBUF_NEEDS_INIT;
216 vbi_buffer_prepare(struct videobuf_queue *vq, struct videobuf_buffer *vb,
217 enum v4l2_field field)
219 struct cx231xx_fh *fh = vq->priv_data;
220 struct cx231xx_buffer *buf =
221 container_of(vb, struct cx231xx_buffer, vb);
222 struct cx231xx *dev = fh->dev;
223 int rc = 0, urb_init = 0;
226 height = ((dev->norm & V4L2_STD_625_50) ?
227 PAL_VBI_LINES : NTSC_VBI_LINES);
228 buf->vb.size = ((dev->width << 1) * height * 2);
230 if (0 != buf->vb.baddr && buf->vb.bsize < buf->vb.size)
233 buf->vb.width = dev->width;
234 buf->vb.height = height;
235 buf->vb.field = field;
236 buf->vb.field = V4L2_FIELD_SEQ_TB;
238 if (VIDEOBUF_NEEDS_INIT == buf->vb.state) {
239 rc = videobuf_iolock(vq, &buf->vb, NULL);
244 if (!dev->vbi_mode.bulk_ctl.num_bufs)
248 rc = cx231xx_init_vbi_isoc(dev, CX231XX_NUM_VBI_PACKETS,
249 CX231XX_NUM_VBI_BUFS,
250 dev->vbi_mode.alt_max_pkt_size[0],
251 cx231xx_isoc_vbi_copy);
256 buf->vb.state = VIDEOBUF_PREPARED;
260 free_buffer(vq, buf);
265 vbi_buffer_queue(struct videobuf_queue *vq, struct videobuf_buffer *vb)
267 struct cx231xx_buffer *buf =
268 container_of(vb, struct cx231xx_buffer, vb);
269 struct cx231xx_fh *fh = vq->priv_data;
270 struct cx231xx *dev = fh->dev;
271 struct cx231xx_dmaqueue *vidq = &dev->vbi_mode.vidq;
273 buf->vb.state = VIDEOBUF_QUEUED;
274 list_add_tail(&buf->vb.queue, &vidq->active);
278 static void vbi_buffer_release(struct videobuf_queue *vq,
279 struct videobuf_buffer *vb)
281 struct cx231xx_buffer *buf =
282 container_of(vb, struct cx231xx_buffer, vb);
285 free_buffer(vq, buf);
288 struct videobuf_queue_ops cx231xx_vbi_qops = {
289 .buf_setup = vbi_buffer_setup,
290 .buf_prepare = vbi_buffer_prepare,
291 .buf_queue = vbi_buffer_queue,
292 .buf_release = vbi_buffer_release,
295 /* ------------------------------------------------------------------
297 ------------------------------------------------------------------*/
300 * IRQ callback, called by URB callback
302 static void cx231xx_irq_vbi_callback(struct urb *urb)
304 struct cx231xx_dmaqueue *dma_q = urb->context;
305 struct cx231xx_video_mode *vmode =
306 container_of(dma_q, struct cx231xx_video_mode, vidq);
307 struct cx231xx *dev = container_of(vmode, struct cx231xx, vbi_mode);
309 switch (urb->status) {
310 case 0: /* success */
311 case -ETIMEDOUT: /* NAK */
313 case -ECONNRESET: /* kill */
319 "urb completition error %d.\n", urb->status);
323 /* Copy data from URB */
324 spin_lock(&dev->vbi_mode.slock);
325 dev->vbi_mode.bulk_ctl.bulk_copy(dev, urb);
326 spin_unlock(&dev->vbi_mode.slock);
331 urb->status = usb_submit_urb(urb, GFP_ATOMIC);
333 dev_err(dev->dev, "urb resubmit failed (error=%i)\n",
339 * Stop and Deallocate URBs
341 void cx231xx_uninit_vbi_isoc(struct cx231xx *dev)
346 dev_dbg(dev->dev, "called cx231xx_uninit_vbi_isoc\n");
348 dev->vbi_mode.bulk_ctl.nfields = -1;
349 for (i = 0; i < dev->vbi_mode.bulk_ctl.num_bufs; i++) {
350 urb = dev->vbi_mode.bulk_ctl.urb[i];
352 if (!irqs_disabled())
357 if (dev->vbi_mode.bulk_ctl.transfer_buffer[i]) {
359 kfree(dev->vbi_mode.bulk_ctl.
361 dev->vbi_mode.bulk_ctl.transfer_buffer[i] =
365 dev->vbi_mode.bulk_ctl.urb[i] = NULL;
367 dev->vbi_mode.bulk_ctl.transfer_buffer[i] = NULL;
370 kfree(dev->vbi_mode.bulk_ctl.urb);
371 kfree(dev->vbi_mode.bulk_ctl.transfer_buffer);
373 dev->vbi_mode.bulk_ctl.urb = NULL;
374 dev->vbi_mode.bulk_ctl.transfer_buffer = NULL;
375 dev->vbi_mode.bulk_ctl.num_bufs = 0;
377 cx231xx_capture_start(dev, 0, Vbi);
379 EXPORT_SYMBOL_GPL(cx231xx_uninit_vbi_isoc);
382 * Allocate URBs and start IRQ
384 int cx231xx_init_vbi_isoc(struct cx231xx *dev, int max_packets,
385 int num_bufs, int max_pkt_size,
386 int (*bulk_copy) (struct cx231xx *dev,
389 struct cx231xx_dmaqueue *dma_q = &dev->vbi_mode.vidq;
395 dev_dbg(dev->dev, "called cx231xx_vbi_isoc\n");
397 /* De-allocates all pending stuff */
398 cx231xx_uninit_vbi_isoc(dev);
400 /* clear if any halt */
401 usb_clear_halt(dev->udev,
402 usb_rcvbulkpipe(dev->udev,
403 dev->vbi_mode.end_point_addr));
405 dev->vbi_mode.bulk_ctl.bulk_copy = bulk_copy;
406 dev->vbi_mode.bulk_ctl.num_bufs = num_bufs;
408 dma_q->is_partial_line = 0;
410 dma_q->current_field = -1;
411 dma_q->bytes_left_in_line = dev->width << 1;
412 dma_q->lines_per_field = ((dev->norm & V4L2_STD_625_50) ?
413 PAL_VBI_LINES : NTSC_VBI_LINES);
414 dma_q->lines_completed = 0;
415 for (i = 0; i < 8; i++)
416 dma_q->partial_buf[i] = 0;
418 dev->vbi_mode.bulk_ctl.urb = kzalloc(sizeof(void *) * num_bufs,
420 if (!dev->vbi_mode.bulk_ctl.urb) {
422 "cannot alloc memory for usb buffers\n");
426 dev->vbi_mode.bulk_ctl.transfer_buffer =
427 kzalloc(sizeof(void *) * num_bufs, GFP_KERNEL);
428 if (!dev->vbi_mode.bulk_ctl.transfer_buffer) {
430 "cannot allocate memory for usbtransfer\n");
431 kfree(dev->vbi_mode.bulk_ctl.urb);
435 dev->vbi_mode.bulk_ctl.max_pkt_size = max_pkt_size;
436 dev->vbi_mode.bulk_ctl.buf = NULL;
438 sb_size = max_packets * dev->vbi_mode.bulk_ctl.max_pkt_size;
440 /* allocate urbs and transfer buffers */
441 for (i = 0; i < dev->vbi_mode.bulk_ctl.num_bufs; i++) {
443 urb = usb_alloc_urb(0, GFP_KERNEL);
446 "cannot alloc bulk_ctl.urb %i\n", i);
447 cx231xx_uninit_vbi_isoc(dev);
450 dev->vbi_mode.bulk_ctl.urb[i] = urb;
451 urb->transfer_flags = 0;
453 dev->vbi_mode.bulk_ctl.transfer_buffer[i] =
454 kzalloc(sb_size, GFP_KERNEL);
455 if (!dev->vbi_mode.bulk_ctl.transfer_buffer[i]) {
457 "unable to allocate %i bytes for transfer buffer %i%s\n",
459 in_interrupt() ? " while in int" : "");
460 cx231xx_uninit_vbi_isoc(dev);
464 pipe = usb_rcvbulkpipe(dev->udev, dev->vbi_mode.end_point_addr);
465 usb_fill_bulk_urb(urb, dev->udev, pipe,
466 dev->vbi_mode.bulk_ctl.transfer_buffer[i],
467 sb_size, cx231xx_irq_vbi_callback, dma_q);
470 init_waitqueue_head(&dma_q->wq);
472 /* submit urbs and enables IRQ */
473 for (i = 0; i < dev->vbi_mode.bulk_ctl.num_bufs; i++) {
474 rc = usb_submit_urb(dev->vbi_mode.bulk_ctl.urb[i], GFP_ATOMIC);
477 "submit of urb %i failed (error=%i)\n", i, rc);
478 cx231xx_uninit_vbi_isoc(dev);
483 cx231xx_capture_start(dev, 1, Vbi);
487 EXPORT_SYMBOL_GPL(cx231xx_init_vbi_isoc);
489 u32 cx231xx_get_vbi_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
490 u8 sav_eav, u8 *p_buffer, u32 buffer_size)
492 u32 bytes_copied = 0;
493 int current_field = -1;
508 if (current_field < 0)
511 dma_q->last_sav = sav_eav;
514 cx231xx_copy_vbi_line(dev, dma_q, p_buffer, buffer_size,
521 * Announces that a buffer were filled and request the next
523 static inline void vbi_buffer_filled(struct cx231xx *dev,
524 struct cx231xx_dmaqueue *dma_q,
525 struct cx231xx_buffer *buf)
527 /* Advice that buffer was filled */
528 /* dev_dbg(dev->dev, "[%p/%d] wakeup\n", buf, buf->vb.i); */
530 buf->vb.state = VIDEOBUF_DONE;
531 buf->vb.field_count++;
532 v4l2_get_timestamp(&buf->vb.ts);
534 dev->vbi_mode.bulk_ctl.buf = NULL;
536 list_del(&buf->vb.queue);
537 wake_up(&buf->vb.done);
540 u32 cx231xx_copy_vbi_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
541 u8 *p_line, u32 length, int field_number)
544 struct cx231xx_buffer *buf;
545 u32 _line_size = dev->width * 2;
547 if (dma_q->current_field == -1) {
548 /* Just starting up */
549 cx231xx_reset_vbi_buffer(dev, dma_q);
552 if (dma_q->current_field != field_number)
553 dma_q->lines_completed = 0;
555 /* get the buffer pointer */
556 buf = dev->vbi_mode.bulk_ctl.buf;
558 /* Remember the field number for next time */
559 dma_q->current_field = field_number;
561 bytes_to_copy = dma_q->bytes_left_in_line;
562 if (bytes_to_copy > length)
563 bytes_to_copy = length;
565 if (dma_q->lines_completed >= dma_q->lines_per_field) {
566 dma_q->bytes_left_in_line -= bytes_to_copy;
567 dma_q->is_partial_line =
568 (dma_q->bytes_left_in_line == 0) ? 0 : 1;
572 dma_q->is_partial_line = 1;
574 /* If we don't have a buffer, just return the number of bytes we would
575 have copied if we had a buffer. */
577 dma_q->bytes_left_in_line -= bytes_to_copy;
578 dma_q->is_partial_line =
579 (dma_q->bytes_left_in_line == 0) ? 0 : 1;
580 return bytes_to_copy;
583 /* copy the data to video buffer */
584 cx231xx_do_vbi_copy(dev, dma_q, p_line, bytes_to_copy);
586 dma_q->pos += bytes_to_copy;
587 dma_q->bytes_left_in_line -= bytes_to_copy;
589 if (dma_q->bytes_left_in_line == 0) {
591 dma_q->bytes_left_in_line = _line_size;
592 dma_q->lines_completed++;
593 dma_q->is_partial_line = 0;
595 if (cx231xx_is_vbi_buffer_done(dev, dma_q) && buf) {
597 vbi_buffer_filled(dev, dma_q, buf);
600 dma_q->lines_completed = 0;
601 cx231xx_reset_vbi_buffer(dev, dma_q);
605 return bytes_to_copy;
609 * video-buf generic routine to get the next available buffer
611 static inline void get_next_vbi_buf(struct cx231xx_dmaqueue *dma_q,
612 struct cx231xx_buffer **buf)
614 struct cx231xx_video_mode *vmode =
615 container_of(dma_q, struct cx231xx_video_mode, vidq);
616 struct cx231xx *dev = container_of(vmode, struct cx231xx, vbi_mode);
619 if (list_empty(&dma_q->active)) {
620 dev_err(dev->dev, "No active queue to serve\n");
621 dev->vbi_mode.bulk_ctl.buf = NULL;
626 /* Get the next buffer */
627 *buf = list_entry(dma_q->active.next, struct cx231xx_buffer, vb.queue);
629 /* Cleans up buffer - Useful for testing for frame/URB loss */
630 outp = videobuf_to_vmalloc(&(*buf)->vb);
631 memset(outp, 0, (*buf)->vb.size);
633 dev->vbi_mode.bulk_ctl.buf = *buf;
638 void cx231xx_reset_vbi_buffer(struct cx231xx *dev,
639 struct cx231xx_dmaqueue *dma_q)
641 struct cx231xx_buffer *buf;
643 buf = dev->vbi_mode.bulk_ctl.buf;
646 /* first try to get the buffer */
647 get_next_vbi_buf(dma_q, &buf);
650 dma_q->current_field = -1;
653 dma_q->bytes_left_in_line = dev->width << 1;
654 dma_q->lines_completed = 0;
657 int cx231xx_do_vbi_copy(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
658 u8 *p_buffer, u32 bytes_to_copy)
660 u8 *p_out_buffer = NULL;
661 u32 current_line_bytes_copied = 0;
662 struct cx231xx_buffer *buf;
663 u32 _line_size = dev->width << 1;
667 buf = dev->vbi_mode.bulk_ctl.buf;
672 p_out_buffer = videobuf_to_vmalloc(&buf->vb);
674 if (dma_q->bytes_left_in_line != _line_size) {
675 current_line_bytes_copied =
676 _line_size - dma_q->bytes_left_in_line;
679 offset = (dma_q->lines_completed * _line_size) +
680 current_line_bytes_copied;
682 if (dma_q->current_field == 2) {
683 /* Populate the second half of the frame */
684 offset += (dev->width * 2 * dma_q->lines_per_field);
687 /* prepare destination address */
688 startwrite = p_out_buffer + offset;
690 lencopy = dma_q->bytes_left_in_line > bytes_to_copy ?
691 bytes_to_copy : dma_q->bytes_left_in_line;
693 memcpy(startwrite, p_buffer, lencopy);
698 u8 cx231xx_is_vbi_buffer_done(struct cx231xx *dev,
699 struct cx231xx_dmaqueue *dma_q)
703 height = ((dev->norm & V4L2_STD_625_50) ?
704 PAL_VBI_LINES : NTSC_VBI_LINES);
705 if (dma_q->lines_completed == height && dma_q->current_field == 2)