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) {
115 if (dma_q->is_partial_line) {
116 /* Handle the case where we were working on a partial line */
117 sav_eav = dma_q->last_sav;
119 /* Check for a SAV/EAV overlapping the buffer boundary */
121 cx231xx_find_boundary_SAV_EAV(p_buffer,
127 /* Get the first line if we have some portion of an SAV/EAV from the last buffer
130 bytes_parsed += cx231xx_get_vbi_line(dev, dma_q, sav_eav, /* SAV/EAV */
131 p_buffer + bytes_parsed, /* p_buffer */
132 buffer_size - bytes_parsed); /* buffer size */
135 /* Now parse data that is completely in this buffer */
136 dma_q->is_partial_line = 0;
138 while (bytes_parsed < buffer_size) {
141 sav_eav = cx231xx_find_next_SAV_EAV(p_buffer + bytes_parsed, /* p_buffer */
142 buffer_size - bytes_parsed, /* buffer size */
143 &bytes_used); /* Receives bytes used to get SAV/EAV */
145 bytes_parsed += bytes_used;
148 if (sav_eav && (bytes_parsed < buffer_size)) {
149 bytes_parsed += cx231xx_get_vbi_line(dev, dma_q, sav_eav, /* SAV/EAV */
150 p_buffer + bytes_parsed, /* p_buffer */
151 buffer_size - bytes_parsed); /* buffer size */
155 /* Save the last four bytes of the buffer so we can check the buffer boundary
156 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);
181 *count = CX231XX_DEF_VBI_BUF;
183 if (*count < CX231XX_MIN_BUF)
184 *count = CX231XX_MIN_BUF;
186 /* call VBI setup if required */
187 /* cx231xx_i2c_call_clients(&dev->i2c_bus[1], VIDIOC_S_FREQUENCY, &f);
193 /* This is called *without* dev->slock held; please keep it that way */
194 static void free_buffer(struct videobuf_queue *vq, struct cx231xx_buffer *buf)
196 struct cx231xx_fh *fh = vq->priv_data;
197 struct cx231xx *dev = fh->dev;
198 unsigned long flags = 0;
202 /* We used to wait for the buffer to finish here, but this didn't work
203 because, as we were keeping the state as VIDEOBUF_QUEUED,
204 videobuf_queue_cancel marked it as finished for us.
205 (Also, it could wedge forever if the hardware was misconfigured.)
207 This should be safe; by the time we get here, the buffer isn't
208 queued anymore. If we ever start marking the buffers as
209 VIDEOBUF_ACTIVE, it won't be, though.
211 spin_lock_irqsave(&dev->vbi_mode.slock, flags);
212 if (dev->vbi_mode.isoc_ctl.buf == buf)
213 dev->vbi_mode.isoc_ctl.buf = NULL;
214 spin_unlock_irqrestore(&dev->vbi_mode.slock, flags);
216 videobuf_vmalloc_free(&buf->vb);
217 buf->vb.state = VIDEOBUF_NEEDS_INIT;
221 vbi_buffer_prepare(struct videobuf_queue *vq, struct videobuf_buffer *vb,
222 enum v4l2_field field)
224 struct cx231xx_fh *fh = vq->priv_data;
225 struct cx231xx_buffer *buf =
226 container_of(vb, struct cx231xx_buffer, vb);
227 struct cx231xx *dev = fh->dev;
228 int rc = 0, urb_init = 0;
231 height = ((dev->norm & V4L2_STD_625_50) ?
232 PAL_VBI_LINES : NTSC_VBI_LINES);
233 buf->vb.size = ((dev->width << 1) * height);
235 if (0 != buf->vb.baddr && buf->vb.bsize < buf->vb.size)
238 buf->vb.width = dev->width;
239 buf->vb.height = height;
240 buf->vb.field = field;
241 buf->vb.field = V4L2_FIELD_SEQ_TB;
243 if (VIDEOBUF_NEEDS_INIT == buf->vb.state) {
244 rc = videobuf_iolock(vq, &buf->vb, NULL);
249 if (!dev->vbi_mode.isoc_ctl.num_bufs)
253 rc = cx231xx_init_vbi_isoc(dev, CX231XX_NUM_VBI_PACKETS,
254 CX231XX_NUM_VBI_BUFS,
255 dev->vbi_mode.alt_max_pkt_size[0],
256 cx231xx_isoc_vbi_copy);
261 buf->vb.state = VIDEOBUF_PREPARED;
265 free_buffer(vq, buf);
270 vbi_buffer_queue(struct videobuf_queue *vq, struct videobuf_buffer *vb)
272 struct cx231xx_buffer *buf =
273 container_of(vb, struct cx231xx_buffer, vb);
274 struct cx231xx_fh *fh = vq->priv_data;
275 struct cx231xx *dev = fh->dev;
276 struct cx231xx_dmaqueue *vidq = &dev->vbi_mode.vidq;
278 buf->vb.state = VIDEOBUF_QUEUED;
279 list_add_tail(&buf->vb.queue, &vidq->active);
283 static void vbi_buffer_release(struct videobuf_queue *vq,
284 struct videobuf_buffer *vb)
286 struct cx231xx_buffer *buf =
287 container_of(vb, struct cx231xx_buffer, vb);
289 struct cx231xx_fh *fh = vq->priv_data;
290 struct cx231xx *dev = (struct cx231xx *)fh->dev;
292 cx231xx_info(DRIVER_NAME "cx231xx: called vbi_buffer_release\n");
295 free_buffer(vq, buf);
298 struct videobuf_queue_ops cx231xx_vbi_qops = {
299 .buf_setup = vbi_buffer_setup,
300 .buf_prepare = vbi_buffer_prepare,
301 .buf_queue = vbi_buffer_queue,
302 .buf_release = vbi_buffer_release,
305 /* ------------------------------------------------------------------
307 ------------------------------------------------------------------*/
310 * IRQ callback, called by URB callback
312 static void cx231xx_irq_vbi_callback(struct urb *urb)
314 struct cx231xx_dmaqueue *dma_q = urb->context;
315 struct cx231xx_video_mode *vmode =
316 container_of(dma_q, struct cx231xx_video_mode, vidq);
317 struct cx231xx *dev = container_of(vmode, struct cx231xx, vbi_mode);
320 switch (urb->status) {
321 case 0: /* success */
322 case -ETIMEDOUT: /* NAK */
324 case -ECONNRESET: /* kill */
329 cx231xx_err(DRIVER_NAME "urb completition error %d.\n",
334 /* Copy data from URB */
335 spin_lock(&dev->vbi_mode.slock);
336 rc = dev->vbi_mode.isoc_ctl.isoc_copy(dev, urb);
337 spin_unlock(&dev->vbi_mode.slock);
342 urb->status = usb_submit_urb(urb, GFP_ATOMIC);
344 cx231xx_err(DRIVER_NAME "urb resubmit failed (error=%i)\n",
350 * Stop and Deallocate URBs
352 void cx231xx_uninit_vbi_isoc(struct cx231xx *dev)
357 cx231xx_info(DRIVER_NAME "cx231xx: called cx231xx_uninit_vbi_isoc\n");
359 dev->vbi_mode.isoc_ctl.nfields = -1;
360 for (i = 0; i < dev->vbi_mode.isoc_ctl.num_bufs; i++) {
361 urb = dev->vbi_mode.isoc_ctl.urb[i];
363 if (!irqs_disabled())
368 if (dev->vbi_mode.isoc_ctl.transfer_buffer[i]) {
370 kfree(dev->vbi_mode.isoc_ctl.
372 dev->vbi_mode.isoc_ctl.transfer_buffer[i] =
376 dev->vbi_mode.isoc_ctl.urb[i] = NULL;
378 dev->vbi_mode.isoc_ctl.transfer_buffer[i] = NULL;
381 kfree(dev->vbi_mode.isoc_ctl.urb);
382 kfree(dev->vbi_mode.isoc_ctl.transfer_buffer);
384 dev->vbi_mode.isoc_ctl.urb = NULL;
385 dev->vbi_mode.isoc_ctl.transfer_buffer = NULL;
386 dev->vbi_mode.isoc_ctl.num_bufs = 0;
388 cx231xx_capture_start(dev, 0, Vbi);
391 EXPORT_SYMBOL_GPL(cx231xx_uninit_vbi_isoc);
394 * Allocate URBs and start IRQ
396 int cx231xx_init_vbi_isoc(struct cx231xx *dev, int max_packets,
397 int num_bufs, int max_pkt_size,
398 int (*isoc_copy) (struct cx231xx * dev,
401 struct cx231xx_dmaqueue *dma_q = &dev->vbi_mode.vidq;
407 cx231xx_info(DRIVER_NAME "cx231xx: called cx231xx_prepare_isoc\n");
409 /* De-allocates all pending stuff */
410 cx231xx_uninit_vbi_isoc(dev);
412 /* clear if any halt */
413 usb_clear_halt(dev->udev,
414 usb_rcvbulkpipe(dev->udev,
415 dev->vbi_mode.end_point_addr));
417 dev->vbi_mode.isoc_ctl.isoc_copy = isoc_copy;
418 dev->vbi_mode.isoc_ctl.num_bufs = num_bufs;
420 dma_q->is_partial_line = 0;
422 dma_q->current_field = -1;
423 dma_q->bytes_left_in_line = dev->width << 1;
424 dma_q->lines_per_field = ((dev->norm & V4L2_STD_625_50) ?
425 PAL_VBI_LINES : NTSC_VBI_LINES);
426 dma_q->lines_completed = 0;
427 for (i = 0; i < 8; i++)
428 dma_q->partial_buf[i] = 0;
430 dev->vbi_mode.isoc_ctl.urb =
431 kzalloc(sizeof(void *) * num_bufs, GFP_KERNEL);
432 if (!dev->vbi_mode.isoc_ctl.urb) {
433 cx231xx_errdev("cannot alloc memory for usb buffers\n");
437 dev->vbi_mode.isoc_ctl.transfer_buffer =
438 kzalloc(sizeof(void *) * num_bufs, GFP_KERNEL);
439 if (!dev->vbi_mode.isoc_ctl.transfer_buffer) {
440 cx231xx_errdev("cannot allocate memory for usbtransfer\n");
441 kfree(dev->vbi_mode.isoc_ctl.urb);
445 dev->vbi_mode.isoc_ctl.max_pkt_size = max_pkt_size;
446 dev->vbi_mode.isoc_ctl.buf = NULL;
448 sb_size = max_packets * dev->vbi_mode.isoc_ctl.max_pkt_size;
450 /* allocate urbs and transfer buffers */
451 for (i = 0; i < dev->vbi_mode.isoc_ctl.num_bufs; i++) {
453 urb = usb_alloc_urb(0, GFP_KERNEL);
455 cx231xx_err(DRIVER_NAME
456 ": cannot alloc isoc_ctl.urb %i\n", i);
457 cx231xx_uninit_vbi_isoc(dev);
460 dev->vbi_mode.isoc_ctl.urb[i] = urb;
461 urb->transfer_flags = 0;
463 dev->vbi_mode.isoc_ctl.transfer_buffer[i] =
464 kzalloc(sb_size, GFP_KERNEL);
465 if (!dev->vbi_mode.isoc_ctl.transfer_buffer[i]) {
466 cx231xx_err(DRIVER_NAME
467 ": unable to allocate %i bytes for transfer"
468 " buffer %i%s\n", sb_size, i,
469 in_interrupt()? " while in int" : "");
470 cx231xx_uninit_vbi_isoc(dev);
474 pipe = usb_rcvbulkpipe(dev->udev, dev->vbi_mode.end_point_addr);
475 usb_fill_bulk_urb(urb, dev->udev, pipe,
476 dev->vbi_mode.isoc_ctl.transfer_buffer[i],
477 sb_size, cx231xx_irq_vbi_callback, dma_q);
480 init_waitqueue_head(&dma_q->wq);
482 /* submit urbs and enables IRQ */
483 for (i = 0; i < dev->vbi_mode.isoc_ctl.num_bufs; i++) {
484 rc = usb_submit_urb(dev->vbi_mode.isoc_ctl.urb[i], GFP_ATOMIC);
486 cx231xx_err(DRIVER_NAME
487 ": submit of urb %i failed (error=%i)\n", i,
489 cx231xx_uninit_vbi_isoc(dev);
494 cx231xx_capture_start(dev, 1, Vbi);
499 EXPORT_SYMBOL_GPL(cx231xx_init_vbi_isoc);
501 u32 cx231xx_get_vbi_line(struct cx231xx * dev, struct cx231xx_dmaqueue * dma_q,
502 u8 sav_eav, u8 * p_buffer, u32 buffer_size)
504 u32 bytes_copied = 0;
505 int current_field = -1;
520 if (current_field < 0)
523 dma_q->last_sav = sav_eav;
526 cx231xx_copy_vbi_line(dev, dma_q, p_buffer, buffer_size,
533 * Announces that a buffer were filled and request the next
535 static inline void vbi_buffer_filled(struct cx231xx *dev,
536 struct cx231xx_dmaqueue *dma_q,
537 struct cx231xx_buffer *buf)
539 /* Advice that buffer was filled */
540 /* cx231xx_info(DRIVER_NAME "[%p/%d] wakeup\n", buf, buf->vb.i); */
542 buf->vb.state = VIDEOBUF_DONE;
543 buf->vb.field_count++;
544 do_gettimeofday(&buf->vb.ts);
546 dev->vbi_mode.isoc_ctl.buf = NULL;
548 list_del(&buf->vb.queue);
549 wake_up(&buf->vb.done);
552 u32 cx231xx_copy_vbi_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
553 u8 * p_line, u32 length, int field_number)
556 struct cx231xx_buffer *buf;
557 u32 _line_size = dev->width * 2;
559 if (dma_q->current_field != field_number) {
560 cx231xx_reset_vbi_buffer(dev, dma_q);
563 /* get the buffer pointer */
564 buf = dev->vbi_mode.isoc_ctl.buf;
566 /* Remember the field number for next time */
567 dma_q->current_field = field_number;
569 bytes_to_copy = dma_q->bytes_left_in_line;
570 if (bytes_to_copy > length)
571 bytes_to_copy = length;
573 if (dma_q->lines_completed >= dma_q->lines_per_field) {
574 dma_q->bytes_left_in_line -= bytes_to_copy;
575 dma_q->is_partial_line =
576 (dma_q->bytes_left_in_line == 0) ? 0 : 1;
580 dma_q->is_partial_line = 1;
582 /* If we don't have a buffer, just return the number of bytes we would
583 have copied if we had a buffer. */
585 dma_q->bytes_left_in_line -= bytes_to_copy;
586 dma_q->is_partial_line =
587 (dma_q->bytes_left_in_line == 0) ? 0 : 1;
588 return bytes_to_copy;
591 /* copy the data to video buffer */
592 cx231xx_do_vbi_copy(dev, dma_q, p_line, bytes_to_copy);
594 dma_q->pos += bytes_to_copy;
595 dma_q->bytes_left_in_line -= bytes_to_copy;
597 if (dma_q->bytes_left_in_line == 0) {
599 dma_q->bytes_left_in_line = _line_size;
600 dma_q->lines_completed++;
601 dma_q->is_partial_line = 0;
603 if (cx231xx_is_vbi_buffer_done(dev, dma_q) && buf) {
605 vbi_buffer_filled(dev, dma_q, buf);
609 dma_q->lines_completed = 0;
613 return bytes_to_copy;
617 * video-buf generic routine to get the next available buffer
619 static inline void get_next_vbi_buf(struct cx231xx_dmaqueue *dma_q,
620 struct cx231xx_buffer **buf)
622 struct cx231xx_video_mode *vmode =
623 container_of(dma_q, struct cx231xx_video_mode, vidq);
624 struct cx231xx *dev = container_of(vmode, struct cx231xx, vbi_mode);
627 if (list_empty(&dma_q->active)) {
628 cx231xx_err(DRIVER_NAME ": No active queue to serve\n");
629 dev->vbi_mode.isoc_ctl.buf = NULL;
634 /* Get the next buffer */
635 *buf = list_entry(dma_q->active.next, struct cx231xx_buffer, vb.queue);
637 /* Cleans up buffer - Usefull for testing for frame/URB loss */
638 outp = videobuf_to_vmalloc(&(*buf)->vb);
639 memset(outp, 0, (*buf)->vb.size);
641 dev->vbi_mode.isoc_ctl.buf = *buf;
646 void cx231xx_reset_vbi_buffer(struct cx231xx *dev,
647 struct cx231xx_dmaqueue *dma_q)
649 struct cx231xx_buffer *buf;
651 buf = dev->vbi_mode.isoc_ctl.buf;
655 /* first try to get the buffer */
656 get_next_vbi_buf(dma_q, &buf);
659 dma_q->current_field = -1;
662 dma_q->bytes_left_in_line = dev->width << 1;
663 dma_q->lines_completed = 0;
666 int cx231xx_do_vbi_copy(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
667 u8 * p_buffer, u32 bytes_to_copy)
669 u8 *p_out_buffer = NULL;
670 u32 current_line_bytes_copied = 0;
671 struct cx231xx_buffer *buf;
672 u32 _line_size = dev->width << 1;
676 buf = dev->vbi_mode.isoc_ctl.buf;
682 p_out_buffer = videobuf_to_vmalloc(&buf->vb);
684 if (dma_q->bytes_left_in_line != _line_size) {
685 current_line_bytes_copied =
686 _line_size - dma_q->bytes_left_in_line;
690 (dma_q->lines_completed * _line_size) + current_line_bytes_copied;
692 /* prepare destination address */
693 startwrite = p_out_buffer + offset;
696 dma_q->bytes_left_in_line >
697 bytes_to_copy ? bytes_to_copy : dma_q->bytes_left_in_line;
699 memcpy(startwrite, p_buffer, lencopy);
704 u8 cx231xx_is_vbi_buffer_done(struct cx231xx * dev,
705 struct cx231xx_dmaqueue * dma_q)
709 height = ((dev->norm & V4L2_STD_625_50) ?
710 PAL_VBI_LINES : NTSC_VBI_LINES);
711 return (dma_q->lines_completed == height) ? 1 : 0;