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,
43 int packet, int status)
45 char *errmsg = "Unknown";
49 errmsg = "unlinked synchronuously";
52 errmsg = "unlinked asynchronuously";
55 errmsg = "Buffer error (overrun)";
58 errmsg = "Stalled (device not responding)";
61 errmsg = "Babble (bad cable?)";
64 errmsg = "Bit-stuff error (bad cable?)";
67 errmsg = "CRC/Timeout (could be anything)";
70 errmsg = "Device does not respond";
74 cx231xx_err(DRIVER_NAME "URB status %d [%s].\n", status, errmsg);
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 */
120 sav_eav = cx231xx_find_boundary_SAV_EAV(p_buffer, dma_q->partial_buf, &bytes_parsed);
124 /* Get the first line if we have some portion of an SAV/EAV from the last buffer
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)
140 sav_eav = cx231xx_find_next_SAV_EAV(
141 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))
150 bytes_parsed += cx231xx_get_vbi_line(dev, dma_q,
151 sav_eav, /* SAV/EAV */
152 p_buffer + bytes_parsed, /* p_buffer */
153 buffer_size - bytes_parsed); /* buffer size */
157 /* Save the last four bytes of the buffer so we can check the buffer boundary
158 condition next time */
159 memcpy(dma_q->partial_buf, p_buffer + buffer_size - 4, 4);
166 /* ------------------------------------------------------------------
168 ------------------------------------------------------------------*/
171 vbi_buffer_setup(struct videobuf_queue *vq, unsigned int *count, unsigned int *size)
173 struct cx231xx_fh *fh = vq->priv_data;
174 struct cx231xx *dev = fh->dev;
177 height = ((dev->norm & V4L2_STD_625_50) ?
178 PAL_VBI_LINES : NTSC_VBI_LINES) ;
180 *size = ( dev->width * height * 2);
182 *count = CX231XX_DEF_VBI_BUF;
184 if (*count < CX231XX_MIN_BUF)
185 *count = CX231XX_MIN_BUF;
187 /* call VBI setup if required */
188 /* cx231xx_i2c_call_clients(&dev->i2c_bus[1], VIDIOC_S_FREQUENCY, &f);
194 /* This is called *without* dev->slock held; please keep it that way */
195 static void free_buffer(struct videobuf_queue *vq, struct cx231xx_buffer *buf)
197 struct cx231xx_fh *fh = vq->priv_data;
198 struct cx231xx *dev = fh->dev;
199 unsigned long flags = 0;
203 /* We used to wait for the buffer to finish here, but this didn't work
204 because, as we were keeping the state as VIDEOBUF_QUEUED,
205 videobuf_queue_cancel marked it as finished for us.
206 (Also, it could wedge forever if the hardware was misconfigured.)
208 This should be safe; by the time we get here, the buffer isn't
209 queued anymore. If we ever start marking the buffers as
210 VIDEOBUF_ACTIVE, it won't be, though.
212 spin_lock_irqsave(&dev->vbi_mode.slock, flags);
213 if (dev->vbi_mode.isoc_ctl.buf == buf)
214 dev->vbi_mode.isoc_ctl.buf = NULL;
215 spin_unlock_irqrestore(&dev->vbi_mode.slock, flags);
217 videobuf_vmalloc_free(&buf->vb);
218 buf->vb.state = VIDEOBUF_NEEDS_INIT;
222 vbi_buffer_prepare(struct videobuf_queue *vq, struct videobuf_buffer *vb,
223 enum v4l2_field field)
225 struct cx231xx_fh *fh = vq->priv_data;
226 struct cx231xx_buffer *buf = 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, dev->vbi_mode.alt_max_pkt_size[0],
255 cx231xx_isoc_vbi_copy);
260 buf->vb.state = VIDEOBUF_PREPARED;
264 free_buffer(vq, buf);
269 vbi_buffer_queue(struct videobuf_queue *vq, struct videobuf_buffer *vb)
271 struct cx231xx_buffer *buf = container_of(vb, struct cx231xx_buffer, vb);
272 struct cx231xx_fh *fh = vq->priv_data;
273 struct cx231xx *dev = fh->dev;
274 struct cx231xx_dmaqueue *vidq = &dev->vbi_mode.vidq;
276 buf->vb.state = VIDEOBUF_QUEUED;
277 list_add_tail(&buf->vb.queue, &vidq->active);
281 static void vbi_buffer_release(struct videobuf_queue *vq,
282 struct videobuf_buffer *vb)
284 struct cx231xx_buffer *buf = container_of(vb, struct cx231xx_buffer, vb);
286 struct cx231xx_fh *fh = vq->priv_data;
287 struct cx231xx *dev = (struct cx231xx *)fh->dev;
289 cx231xx_info(DRIVER_NAME "cx231xx: called vbi_buffer_release\n");
292 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,
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 = container_of(dma_q, struct cx231xx_video_mode, vidq);
316 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", urb->status);
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.transfer_buffer[i]);
370 dev->vbi_mode.isoc_ctl.transfer_buffer[i] = NULL;
373 dev->vbi_mode.isoc_ctl.urb[i] = NULL;
375 dev->vbi_mode.isoc_ctl.transfer_buffer[i] = NULL;
378 kfree(dev->vbi_mode.isoc_ctl.urb);
379 kfree(dev->vbi_mode.isoc_ctl.transfer_buffer);
381 dev->vbi_mode.isoc_ctl.urb = NULL;
382 dev->vbi_mode.isoc_ctl.transfer_buffer = NULL;
383 dev->vbi_mode.isoc_ctl.num_bufs = 0;
385 cx231xx_capture_start(dev, 0, Vbi);
387 EXPORT_SYMBOL_GPL(cx231xx_uninit_vbi_isoc);
390 * Allocate URBs and start IRQ
392 int cx231xx_init_vbi_isoc(struct cx231xx *dev, int max_packets,
393 int num_bufs, int max_pkt_size,
394 int (*isoc_copy) (struct cx231xx *dev, struct urb *urb))
396 struct cx231xx_dmaqueue *dma_q = &dev->vbi_mode.vidq;
402 cx231xx_info(DRIVER_NAME "cx231xx: called cx231xx_prepare_isoc\n");
404 /* De-allocates all pending stuff */
405 cx231xx_uninit_vbi_isoc(dev);
407 /* clear if any halt */
408 usb_clear_halt(dev->udev, usb_rcvbulkpipe(dev->udev, dev->vbi_mode.end_point_addr));
411 dev->vbi_mode.isoc_ctl.isoc_copy = isoc_copy;
412 dev->vbi_mode.isoc_ctl.num_bufs = num_bufs;
414 dma_q->is_partial_line = 0;
416 dma_q->current_field = -1;
417 dma_q->bytes_left_in_line = dev->width << 1;
418 dma_q->lines_per_field = ((dev->norm & V4L2_STD_625_50) ?
419 PAL_VBI_LINES : NTSC_VBI_LINES) ;
420 dma_q->lines_completed = 0;
421 for(i = 0; i < 8 ; i++)
422 dma_q->partial_buf[i] = 0;
424 dev->vbi_mode.isoc_ctl.urb = kzalloc(sizeof(void *)*num_bufs, GFP_KERNEL);
425 if (!dev->vbi_mode.isoc_ctl.urb) {
426 cx231xx_errdev("cannot alloc memory for usb buffers\n");
430 dev->vbi_mode.isoc_ctl.transfer_buffer = kzalloc(sizeof(void *)*num_bufs,
432 if (!dev->vbi_mode.isoc_ctl.transfer_buffer) {
433 cx231xx_errdev("cannot allocate memory for usbtransfer\n");
434 kfree(dev->vbi_mode.isoc_ctl.urb);
438 dev->vbi_mode.isoc_ctl.max_pkt_size = max_pkt_size;
439 dev->vbi_mode.isoc_ctl.buf = NULL;
441 sb_size = max_packets * dev->vbi_mode.isoc_ctl.max_pkt_size;
443 /* allocate urbs and transfer buffers */
444 for (i = 0; i < dev->vbi_mode.isoc_ctl.num_bufs; i++) {
446 urb = usb_alloc_urb(0, GFP_KERNEL);
448 cx231xx_err(DRIVER_NAME ": cannot alloc isoc_ctl.urb %i\n", i);
449 cx231xx_uninit_vbi_isoc(dev);
452 dev->vbi_mode.isoc_ctl.urb[i] = urb;
453 urb->transfer_flags = 0;
455 dev->vbi_mode.isoc_ctl.transfer_buffer[i] = kzalloc(sb_size, GFP_KERNEL);
456 if (!dev->vbi_mode.isoc_ctl.transfer_buffer[i]) {
457 cx231xx_err(DRIVER_NAME ": unable to allocate %i bytes for transfer"
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.isoc_ctl.transfer_buffer[i], sb_size,
468 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.isoc_ctl.num_bufs; i++) {
475 rc = usb_submit_urb(dev->vbi_mode.isoc_ctl.urb[i], GFP_ATOMIC);
477 cx231xx_err(DRIVER_NAME ": submit of urb %i failed (error=%i)\n", i,
479 cx231xx_uninit_vbi_isoc(dev);
484 cx231xx_capture_start(dev, 1, Vbi);
488 EXPORT_SYMBOL_GPL(cx231xx_init_vbi_isoc);
491 u32 cx231xx_get_vbi_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
492 u8 sav_eav, u8 *p_buffer, u32 buffer_size)
494 u32 bytes_copied = 0;
495 int current_field = -1;
510 if(current_field < 0 )
513 dma_q->last_sav = sav_eav;
515 bytes_copied = cx231xx_copy_vbi_line(dev, dma_q, p_buffer, buffer_size, current_field);
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 /* cx231xx_info(DRIVER_NAME "[%p/%d] wakeup\n", buf, buf->vb.i); */
530 buf->vb.state = VIDEOBUF_DONE;
531 buf->vb.field_count++;
532 do_gettimeofday(&buf->vb.ts);
534 dev->vbi_mode.isoc_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 != field_number ) {
548 cx231xx_reset_vbi_buffer(dev, dma_q);
551 /* get the buffer pointer */
552 buf = dev->vbi_mode.isoc_ctl.buf;
554 /* Remember the field number for next time */
555 dma_q->current_field = field_number;
557 bytes_to_copy = dma_q->bytes_left_in_line;
558 if(bytes_to_copy > length)
559 bytes_to_copy = length;
561 if(dma_q->lines_completed >= dma_q->lines_per_field) {
562 dma_q->bytes_left_in_line -= bytes_to_copy;
563 dma_q->is_partial_line = (dma_q->bytes_left_in_line == 0) ? 0 : 1;
567 dma_q->is_partial_line = 1;
569 /* If we don't have a buffer, just return the number of bytes we would
570 have copied if we had a buffer. */
572 dma_q->bytes_left_in_line -= bytes_to_copy;
573 dma_q->is_partial_line = (dma_q->bytes_left_in_line == 0) ? 0 : 1;
574 return bytes_to_copy;
577 /* copy the data to video buffer */
578 cx231xx_do_vbi_copy(dev, dma_q, p_line, bytes_to_copy);
580 dma_q->pos += bytes_to_copy;
581 dma_q->bytes_left_in_line -= bytes_to_copy;
583 if(dma_q->bytes_left_in_line == 0) {
585 dma_q->bytes_left_in_line = _line_size;
586 dma_q->lines_completed++;
587 dma_q->is_partial_line = 0;
589 if(cx231xx_is_vbi_buffer_done(dev, dma_q) && buf ) {
591 vbi_buffer_filled(dev, dma_q, buf);
595 dma_q->lines_completed = 0;
599 return bytes_to_copy;
603 * video-buf generic routine to get the next available buffer
605 static inline void get_next_vbi_buf(struct cx231xx_dmaqueue *dma_q,
606 struct cx231xx_buffer **buf)
608 struct cx231xx_video_mode *vmode = container_of(dma_q, struct cx231xx_video_mode, vidq);
609 struct cx231xx *dev = container_of(vmode, struct cx231xx, vbi_mode);
612 if (list_empty(&dma_q->active)) {
613 cx231xx_err(DRIVER_NAME ": No active queue to serve\n");
614 dev->vbi_mode.isoc_ctl.buf = NULL;
619 /* Get the next buffer */
620 *buf = list_entry(dma_q->active.next, struct cx231xx_buffer, vb.queue);
622 /* Cleans up buffer - Usefull for testing for frame/URB loss */
623 outp = videobuf_to_vmalloc(&(*buf)->vb);
624 memset(outp, 0, (*buf)->vb.size);
626 dev->vbi_mode.isoc_ctl.buf = *buf;
632 void cx231xx_reset_vbi_buffer(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q)
634 struct cx231xx_buffer *buf;
636 buf = dev->vbi_mode.isoc_ctl.buf;
640 /* first try to get the buffer */
641 get_next_vbi_buf(dma_q, &buf);
644 dma_q->current_field = -1;
647 dma_q->bytes_left_in_line = dev->width << 1;
648 dma_q->lines_completed = 0;
651 int cx231xx_do_vbi_copy(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
652 u8 *p_buffer, u32 bytes_to_copy)
654 u8 *p_out_buffer = NULL;
655 u32 current_line_bytes_copied = 0;
656 struct cx231xx_buffer *buf;
657 u32 _line_size = dev->width << 1;
661 buf = dev->vbi_mode.isoc_ctl.buf;
667 p_out_buffer = videobuf_to_vmalloc(&buf->vb);
669 if(dma_q->bytes_left_in_line != _line_size ) {
670 current_line_bytes_copied = _line_size - dma_q->bytes_left_in_line;
673 offset = ( dma_q->lines_completed * _line_size ) + current_line_bytes_copied;
675 /* prepare destination address */
676 startwrite = p_out_buffer + offset;
678 lencopy = dma_q->bytes_left_in_line > bytes_to_copy ? bytes_to_copy : dma_q->bytes_left_in_line;
680 memcpy(startwrite, p_buffer, lencopy);
686 u8 cx231xx_is_vbi_buffer_done(struct cx231xx *dev,struct cx231xx_dmaqueue *dma_q)
690 height = ((dev->norm & V4L2_STD_625_50) ?
691 PAL_VBI_LINES : NTSC_VBI_LINES) ;
692 return (dma_q->lines_completed == height)?1:0;