Committer: Michael Beasley <mike@snafu.setup>
[mikesnafu-overlay.git] / drivers / media / video / usbvision / usbvision-core.c
blob56775ab8b75d386809183403b492dd05671d03ae
1 /*
2 * usbvision-core.c - driver for NT100x USB video capture devices
5 * Copyright (c) 1999-2005 Joerg Heckenbach <joerg@heckenbach-aw.de>
6 * Dwaine Garden <dwainegarden@rogers.com>
8 * This module is part of usbvision driver project.
9 * Updates to driver completed by Dwaine P. Garden
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include <linux/kernel.h>
27 #include <linux/list.h>
28 #include <linux/timer.h>
29 #include <linux/slab.h>
30 #include <linux/mm.h>
31 #include <linux/utsname.h>
32 #include <linux/highmem.h>
33 #include <linux/videodev.h>
34 #include <linux/vmalloc.h>
35 #include <linux/module.h>
36 #include <linux/init.h>
37 #include <linux/spinlock.h>
38 #include <asm/io.h>
39 #include <linux/videodev2.h>
40 #include <linux/video_decoder.h>
41 #include <linux/i2c.h>
43 #include <media/saa7115.h>
44 #include <media/v4l2-common.h>
45 #include <media/tuner.h>
46 #include <media/audiochip.h>
48 #include <linux/workqueue.h>
50 #ifdef CONFIG_KMOD
51 #include <linux/kmod.h>
52 #endif
54 #include "usbvision.h"
56 static unsigned int core_debug = 0;
57 module_param(core_debug,int,0644);
58 MODULE_PARM_DESC(core_debug,"enable debug messages [core]");
60 static unsigned int force_testpattern = 0;
61 module_param(force_testpattern,int,0644);
62 MODULE_PARM_DESC(force_testpattern,"enable test pattern display [core]");
64 static int adjustCompression = 1; // Set the compression to be adaptive
65 module_param(adjustCompression, int, 0444);
66 MODULE_PARM_DESC(adjustCompression, " Set the ADPCM compression for the device. Default: 1 (On)");
68 static int SwitchSVideoInput = 0; // To help people with Black and White output with using s-video input. Some cables and input device are wired differently.
69 module_param(SwitchSVideoInput, int, 0444);
70 MODULE_PARM_DESC(SwitchSVideoInput, " Set the S-Video input. Some cables and input device are wired differently. Default: 0 (Off)");
72 static unsigned int adjust_X_Offset = -1;
73 module_param(adjust_X_Offset, int, 0644);
74 MODULE_PARM_DESC(adjust_X_Offset, "adjust X offset display [core]");
76 static unsigned int adjust_Y_Offset = -1;
77 module_param(adjust_Y_Offset, int, 0644);
78 MODULE_PARM_DESC(adjust_Y_Offset, "adjust Y offset display [core]");
81 #define ENABLE_HEXDUMP 0 /* Enable if you need it */
84 #ifdef USBVISION_DEBUG
85 #define PDEBUG(level, fmt, args...) \
86 if (core_debug & (level)) info("[%s:%d] " fmt, __PRETTY_FUNCTION__, __LINE__ , ## args)
87 #else
88 #define PDEBUG(level, fmt, args...) do {} while(0)
89 #endif
91 #define DBG_HEADER 1<<0
92 #define DBG_IRQ 1<<1
93 #define DBG_ISOC 1<<2
94 #define DBG_PARSE 1<<3
95 #define DBG_SCRATCH 1<<4
96 #define DBG_FUNC 1<<5
98 static const int max_imgwidth = MAX_FRAME_WIDTH;
99 static const int max_imgheight = MAX_FRAME_HEIGHT;
100 static const int min_imgwidth = MIN_FRAME_WIDTH;
101 static const int min_imgheight = MIN_FRAME_HEIGHT;
103 /* The value of 'scratch_buf_size' affects quality of the picture
104 * in many ways. Shorter buffers may cause loss of data when client
105 * is too slow. Larger buffers are memory-consuming and take longer
106 * to work with. This setting can be adjusted, but the default value
107 * should be OK for most desktop users.
109 #define DEFAULT_SCRATCH_BUF_SIZE (0x20000) // 128kB memory scratch buffer
110 static const int scratch_buf_size = DEFAULT_SCRATCH_BUF_SIZE;
112 // Function prototypes
113 static int usbvision_request_intra (struct usb_usbvision *usbvision);
114 static int usbvision_unrequest_intra (struct usb_usbvision *usbvision);
115 static int usbvision_adjust_compression (struct usb_usbvision *usbvision);
116 static int usbvision_measure_bandwidth (struct usb_usbvision *usbvision);
118 /*******************************/
119 /* Memory management functions */
120 /*******************************/
123 * Here we want the physical address of the memory.
124 * This is used when initializing the contents of the area.
127 static void *usbvision_rvmalloc(unsigned long size)
129 void *mem;
130 unsigned long adr;
132 size = PAGE_ALIGN(size);
133 mem = vmalloc_32(size);
134 if (!mem)
135 return NULL;
137 memset(mem, 0, size); /* Clear the ram out, no junk to the user */
138 adr = (unsigned long) mem;
139 while (size > 0) {
140 SetPageReserved(vmalloc_to_page((void *)adr));
141 adr += PAGE_SIZE;
142 size -= PAGE_SIZE;
145 return mem;
148 static void usbvision_rvfree(void *mem, unsigned long size)
150 unsigned long adr;
152 if (!mem)
153 return;
155 size = PAGE_ALIGN(size);
157 adr = (unsigned long) mem;
158 while ((long) size > 0) {
159 ClearPageReserved(vmalloc_to_page((void *)adr));
160 adr += PAGE_SIZE;
161 size -= PAGE_SIZE;
164 vfree(mem);
169 #if ENABLE_HEXDUMP
170 static void usbvision_hexdump(const unsigned char *data, int len)
172 char tmp[80];
173 int i, k;
175 for (i = k = 0; len > 0; i++, len--) {
176 if (i > 0 && (i % 16 == 0)) {
177 printk("%s\n", tmp);
178 k = 0;
180 k += sprintf(&tmp[k], "%02x ", data[i]);
182 if (k > 0)
183 printk("%s\n", tmp);
185 #endif
187 /********************************
188 * scratch ring buffer handling
189 ********************************/
190 static int scratch_len(struct usb_usbvision *usbvision) /*This returns the amount of data actually in the buffer */
192 int len = usbvision->scratch_write_ptr - usbvision->scratch_read_ptr;
193 if (len < 0) {
194 len += scratch_buf_size;
196 PDEBUG(DBG_SCRATCH, "scratch_len() = %d\n", len);
198 return len;
202 /* This returns the free space left in the buffer */
203 static int scratch_free(struct usb_usbvision *usbvision)
205 int free = usbvision->scratch_read_ptr - usbvision->scratch_write_ptr;
206 if (free <= 0) {
207 free += scratch_buf_size;
209 if (free) {
210 free -= 1; /* at least one byte in the buffer must */
211 /* left blank, otherwise there is no chance to differ between full and empty */
213 PDEBUG(DBG_SCRATCH, "return %d\n", free);
215 return free;
219 /* This puts data into the buffer */
220 static int scratch_put(struct usb_usbvision *usbvision, unsigned char *data,
221 int len)
223 int len_part;
225 if (usbvision->scratch_write_ptr + len < scratch_buf_size) {
226 memcpy(usbvision->scratch + usbvision->scratch_write_ptr, data, len);
227 usbvision->scratch_write_ptr += len;
229 else {
230 len_part = scratch_buf_size - usbvision->scratch_write_ptr;
231 memcpy(usbvision->scratch + usbvision->scratch_write_ptr, data, len_part);
232 if (len == len_part) {
233 usbvision->scratch_write_ptr = 0; /* just set write_ptr to zero */
235 else {
236 memcpy(usbvision->scratch, data + len_part, len - len_part);
237 usbvision->scratch_write_ptr = len - len_part;
241 PDEBUG(DBG_SCRATCH, "len=%d, new write_ptr=%d\n", len, usbvision->scratch_write_ptr);
243 return len;
246 /* This marks the write_ptr as position of new frame header */
247 static void scratch_mark_header(struct usb_usbvision *usbvision)
249 PDEBUG(DBG_SCRATCH, "header at write_ptr=%d\n", usbvision->scratch_headermarker_write_ptr);
251 usbvision->scratch_headermarker[usbvision->scratch_headermarker_write_ptr] =
252 usbvision->scratch_write_ptr;
253 usbvision->scratch_headermarker_write_ptr += 1;
254 usbvision->scratch_headermarker_write_ptr %= USBVISION_NUM_HEADERMARKER;
257 /* This gets data from the buffer at the given "ptr" position */
258 static int scratch_get_extra(struct usb_usbvision *usbvision,
259 unsigned char *data, int *ptr, int len)
261 int len_part;
262 if (*ptr + len < scratch_buf_size) {
263 memcpy(data, usbvision->scratch + *ptr, len);
264 *ptr += len;
266 else {
267 len_part = scratch_buf_size - *ptr;
268 memcpy(data, usbvision->scratch + *ptr, len_part);
269 if (len == len_part) {
270 *ptr = 0; /* just set the y_ptr to zero */
272 else {
273 memcpy(data + len_part, usbvision->scratch, len - len_part);
274 *ptr = len - len_part;
278 PDEBUG(DBG_SCRATCH, "len=%d, new ptr=%d\n", len, *ptr);
280 return len;
284 /* This sets the scratch extra read pointer */
285 static void scratch_set_extra_ptr(struct usb_usbvision *usbvision, int *ptr,
286 int len)
288 *ptr = (usbvision->scratch_read_ptr + len)%scratch_buf_size;
290 PDEBUG(DBG_SCRATCH, "ptr=%d\n", *ptr);
294 /*This increments the scratch extra read pointer */
295 static void scratch_inc_extra_ptr(int *ptr, int len)
297 *ptr = (*ptr + len) % scratch_buf_size;
299 PDEBUG(DBG_SCRATCH, "ptr=%d\n", *ptr);
303 /* This gets data from the buffer */
304 static int scratch_get(struct usb_usbvision *usbvision, unsigned char *data,
305 int len)
307 int len_part;
308 if (usbvision->scratch_read_ptr + len < scratch_buf_size) {
309 memcpy(data, usbvision->scratch + usbvision->scratch_read_ptr, len);
310 usbvision->scratch_read_ptr += len;
312 else {
313 len_part = scratch_buf_size - usbvision->scratch_read_ptr;
314 memcpy(data, usbvision->scratch + usbvision->scratch_read_ptr, len_part);
315 if (len == len_part) {
316 usbvision->scratch_read_ptr = 0; /* just set the read_ptr to zero */
318 else {
319 memcpy(data + len_part, usbvision->scratch, len - len_part);
320 usbvision->scratch_read_ptr = len - len_part;
324 PDEBUG(DBG_SCRATCH, "len=%d, new read_ptr=%d\n", len, usbvision->scratch_read_ptr);
326 return len;
330 /* This sets read pointer to next header and returns it */
331 static int scratch_get_header(struct usb_usbvision *usbvision,
332 struct usbvision_frame_header *header)
334 int errCode = 0;
336 PDEBUG(DBG_SCRATCH, "from read_ptr=%d", usbvision->scratch_headermarker_read_ptr);
338 while (usbvision->scratch_headermarker_write_ptr -
339 usbvision->scratch_headermarker_read_ptr != 0) {
340 usbvision->scratch_read_ptr =
341 usbvision->scratch_headermarker[usbvision->scratch_headermarker_read_ptr];
342 usbvision->scratch_headermarker_read_ptr += 1;
343 usbvision->scratch_headermarker_read_ptr %= USBVISION_NUM_HEADERMARKER;
344 scratch_get(usbvision, (unsigned char *)header, USBVISION_HEADER_LENGTH);
345 if ((header->magic_1 == USBVISION_MAGIC_1)
346 && (header->magic_2 == USBVISION_MAGIC_2)
347 && (header->headerLength == USBVISION_HEADER_LENGTH)) {
348 errCode = USBVISION_HEADER_LENGTH;
349 header->frameWidth = header->frameWidthLo + (header->frameWidthHi << 8);
350 header->frameHeight = header->frameHeightLo + (header->frameHeightHi << 8);
351 break;
355 return errCode;
359 /*This removes len bytes of old data from the buffer */
360 static void scratch_rm_old(struct usb_usbvision *usbvision, int len)
363 usbvision->scratch_read_ptr += len;
364 usbvision->scratch_read_ptr %= scratch_buf_size;
365 PDEBUG(DBG_SCRATCH, "read_ptr is now %d\n", usbvision->scratch_read_ptr);
369 /*This resets the buffer - kills all data in it too */
370 static void scratch_reset(struct usb_usbvision *usbvision)
372 PDEBUG(DBG_SCRATCH, "\n");
374 usbvision->scratch_read_ptr = 0;
375 usbvision->scratch_write_ptr = 0;
376 usbvision->scratch_headermarker_read_ptr = 0;
377 usbvision->scratch_headermarker_write_ptr = 0;
378 usbvision->isocstate = IsocState_NoFrame;
381 int usbvision_scratch_alloc(struct usb_usbvision *usbvision)
383 usbvision->scratch = vmalloc_32(scratch_buf_size);
384 scratch_reset(usbvision);
385 if(usbvision->scratch == NULL) {
386 err("%s: unable to allocate %d bytes for scratch",
387 __FUNCTION__, scratch_buf_size);
388 return -ENOMEM;
390 return 0;
393 void usbvision_scratch_free(struct usb_usbvision *usbvision)
395 if (usbvision->scratch != NULL) {
396 vfree(usbvision->scratch);
397 usbvision->scratch = NULL;
402 * usbvision_testpattern()
404 * Procedure forms a test pattern (yellow grid on blue background).
406 * Parameters:
407 * fullframe: if TRUE then entire frame is filled, otherwise the procedure
408 * continues from the current scanline.
409 * pmode 0: fill the frame with solid blue color (like on VCR or TV)
410 * 1: Draw a colored grid
413 static void usbvision_testpattern(struct usb_usbvision *usbvision,
414 int fullframe, int pmode)
416 static const char proc[] = "usbvision_testpattern";
417 struct usbvision_frame *frame;
418 unsigned char *f;
419 int num_cell = 0;
420 int scan_length = 0;
421 static int num_pass = 0;
423 if (usbvision == NULL) {
424 printk(KERN_ERR "%s: usbvision == NULL\n", proc);
425 return;
427 if (usbvision->curFrame == NULL) {
428 printk(KERN_ERR "%s: usbvision->curFrame is NULL.\n", proc);
429 return;
432 /* Grab the current frame */
433 frame = usbvision->curFrame;
435 /* Optionally start at the beginning */
436 if (fullframe) {
437 frame->curline = 0;
438 frame->scanlength = 0;
441 /* Form every scan line */
442 for (; frame->curline < frame->frmheight; frame->curline++) {
443 int i;
445 f = frame->data + (usbvision->curwidth * 3 * frame->curline);
446 for (i = 0; i < usbvision->curwidth; i++) {
447 unsigned char cb = 0x80;
448 unsigned char cg = 0;
449 unsigned char cr = 0;
451 if (pmode == 1) {
452 if (frame->curline % 32 == 0)
453 cb = 0, cg = cr = 0xFF;
454 else if (i % 32 == 0) {
455 if (frame->curline % 32 == 1)
456 num_cell++;
457 cb = 0, cg = cr = 0xFF;
458 } else {
459 cb =
460 ((num_cell * 7) +
461 num_pass) & 0xFF;
462 cg =
463 ((num_cell * 5) +
464 num_pass * 2) & 0xFF;
465 cr =
466 ((num_cell * 3) +
467 num_pass * 3) & 0xFF;
469 } else {
470 /* Just the blue screen */
473 *f++ = cb;
474 *f++ = cg;
475 *f++ = cr;
476 scan_length += 3;
480 frame->grabstate = FrameState_Done;
481 frame->scanlength += scan_length;
482 ++num_pass;
487 * usbvision_decompress_alloc()
489 * allocates intermediate buffer for decompression
491 int usbvision_decompress_alloc(struct usb_usbvision *usbvision)
493 int IFB_size = MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT * 3 / 2;
494 usbvision->IntraFrameBuffer = vmalloc_32(IFB_size);
495 if (usbvision->IntraFrameBuffer == NULL) {
496 err("%s: unable to allocate %d for compr. frame buffer", __FUNCTION__, IFB_size);
497 return -ENOMEM;
499 return 0;
503 * usbvision_decompress_free()
505 * frees intermediate buffer for decompression
507 void usbvision_decompress_free(struct usb_usbvision *usbvision)
509 if (usbvision->IntraFrameBuffer != NULL) {
510 vfree(usbvision->IntraFrameBuffer);
511 usbvision->IntraFrameBuffer = NULL;
515 /************************************************************
516 * Here comes the data parsing stuff that is run as interrupt
517 ************************************************************/
519 * usbvision_find_header()
521 * Locate one of supported header markers in the scratch buffer.
523 static enum ParseState usbvision_find_header(struct usb_usbvision *usbvision)
525 struct usbvision_frame *frame;
526 int foundHeader = 0;
528 frame = usbvision->curFrame;
530 while (scratch_get_header(usbvision, &frame->isocHeader) == USBVISION_HEADER_LENGTH) {
531 // found header in scratch
532 PDEBUG(DBG_HEADER, "found header: 0x%02x%02x %d %d %d %d %#x 0x%02x %u %u",
533 frame->isocHeader.magic_2,
534 frame->isocHeader.magic_1,
535 frame->isocHeader.headerLength,
536 frame->isocHeader.frameNum,
537 frame->isocHeader.framePhase,
538 frame->isocHeader.frameLatency,
539 frame->isocHeader.dataFormat,
540 frame->isocHeader.formatParam,
541 frame->isocHeader.frameWidth,
542 frame->isocHeader.frameHeight);
544 if (usbvision->requestIntra) {
545 if (frame->isocHeader.formatParam & 0x80) {
546 foundHeader = 1;
547 usbvision->lastIsocFrameNum = -1; // do not check for lost frames this time
548 usbvision_unrequest_intra(usbvision);
549 break;
552 else {
553 foundHeader = 1;
554 break;
558 if (foundHeader) {
559 frame->frmwidth = frame->isocHeader.frameWidth * usbvision->stretch_width;
560 frame->frmheight = frame->isocHeader.frameHeight * usbvision->stretch_height;
561 frame->v4l2_linesize = (frame->frmwidth * frame->v4l2_format.depth)>> 3;
563 else { // no header found
564 PDEBUG(DBG_HEADER, "skipping scratch data, no header");
565 scratch_reset(usbvision);
566 return ParseState_EndParse;
569 // found header
570 if (frame->isocHeader.dataFormat==ISOC_MODE_COMPRESS) {
571 //check isocHeader.frameNum for lost frames
572 if (usbvision->lastIsocFrameNum >= 0) {
573 if (((usbvision->lastIsocFrameNum + 1) % 32) != frame->isocHeader.frameNum) {
574 // unexpected frame drop: need to request new intra frame
575 PDEBUG(DBG_HEADER, "Lost frame before %d on USB", frame->isocHeader.frameNum);
576 usbvision_request_intra(usbvision);
577 return ParseState_NextFrame;
580 usbvision->lastIsocFrameNum = frame->isocHeader.frameNum;
582 usbvision->header_count++;
583 frame->scanstate = ScanState_Lines;
584 frame->curline = 0;
586 if (force_testpattern) {
587 usbvision_testpattern(usbvision, 1, 1);
588 return ParseState_NextFrame;
590 return ParseState_Continue;
593 static enum ParseState usbvision_parse_lines_422(struct usb_usbvision *usbvision,
594 long *pcopylen)
596 volatile struct usbvision_frame *frame;
597 unsigned char *f;
598 int len;
599 int i;
600 unsigned char yuyv[4]={180, 128, 10, 128}; // YUV components
601 unsigned char rv, gv, bv; // RGB components
602 int clipmask_index, bytes_per_pixel;
603 int stretch_bytes, clipmask_add;
605 frame = usbvision->curFrame;
606 f = frame->data + (frame->v4l2_linesize * frame->curline);
608 /* Make sure there's enough data for the entire line */
609 len = (frame->isocHeader.frameWidth * 2)+5;
610 if (scratch_len(usbvision) < len) {
611 PDEBUG(DBG_PARSE, "out of data in line %d, need %u.\n", frame->curline, len);
612 return ParseState_Out;
615 if ((frame->curline + 1) >= frame->frmheight) {
616 return ParseState_NextFrame;
619 bytes_per_pixel = frame->v4l2_format.bytes_per_pixel;
620 stretch_bytes = (usbvision->stretch_width - 1) * bytes_per_pixel;
621 clipmask_index = frame->curline * MAX_FRAME_WIDTH;
622 clipmask_add = usbvision->stretch_width;
624 for (i = 0; i < frame->frmwidth; i+=(2 * usbvision->stretch_width)) {
626 scratch_get(usbvision, &yuyv[0], 4);
628 if (frame->v4l2_format.format == V4L2_PIX_FMT_YUYV) {
629 *f++ = yuyv[0]; // Y
630 *f++ = yuyv[3]; // U
632 else {
634 YUV_TO_RGB_BY_THE_BOOK(yuyv[0], yuyv[1], yuyv[3], rv, gv, bv);
635 switch (frame->v4l2_format.format) {
636 case V4L2_PIX_FMT_RGB565:
637 *f++ = (0x1F & rv) |
638 (0xE0 & (gv << 5));
639 *f++ = (0x07 & (gv >> 3)) |
640 (0xF8 & bv);
641 break;
642 case V4L2_PIX_FMT_RGB24:
643 *f++ = rv;
644 *f++ = gv;
645 *f++ = bv;
646 break;
647 case V4L2_PIX_FMT_RGB32:
648 *f++ = rv;
649 *f++ = gv;
650 *f++ = bv;
651 f++;
652 break;
653 case V4L2_PIX_FMT_RGB555:
654 *f++ = (0x1F & rv) |
655 (0xE0 & (gv << 5));
656 *f++ = (0x03 & (gv >> 3)) |
657 (0x7C & (bv << 2));
658 break;
661 clipmask_index += clipmask_add;
662 f += stretch_bytes;
664 if (frame->v4l2_format.format == V4L2_PIX_FMT_YUYV) {
665 *f++ = yuyv[2]; // Y
666 *f++ = yuyv[1]; // V
668 else {
670 YUV_TO_RGB_BY_THE_BOOK(yuyv[2], yuyv[1], yuyv[3], rv, gv, bv);
671 switch (frame->v4l2_format.format) {
672 case V4L2_PIX_FMT_RGB565:
673 *f++ = (0x1F & rv) |
674 (0xE0 & (gv << 5));
675 *f++ = (0x07 & (gv >> 3)) |
676 (0xF8 & bv);
677 break;
678 case V4L2_PIX_FMT_RGB24:
679 *f++ = rv;
680 *f++ = gv;
681 *f++ = bv;
682 break;
683 case V4L2_PIX_FMT_RGB32:
684 *f++ = rv;
685 *f++ = gv;
686 *f++ = bv;
687 f++;
688 break;
689 case V4L2_PIX_FMT_RGB555:
690 *f++ = (0x1F & rv) |
691 (0xE0 & (gv << 5));
692 *f++ = (0x03 & (gv >> 3)) |
693 (0x7C & (bv << 2));
694 break;
697 clipmask_index += clipmask_add;
698 f += stretch_bytes;
701 frame->curline += usbvision->stretch_height;
702 *pcopylen += frame->v4l2_linesize * usbvision->stretch_height;
704 if (frame->curline >= frame->frmheight) {
705 return ParseState_NextFrame;
707 else {
708 return ParseState_Continue;
712 /* The decompression routine */
713 static int usbvision_decompress(struct usb_usbvision *usbvision,unsigned char *Compressed,
714 unsigned char *Decompressed, int *StartPos,
715 int *BlockTypeStartPos, int Len)
717 int RestPixel, Idx, MaxPos, Pos, ExtraPos, BlockLen, BlockTypePos, BlockTypeLen;
718 unsigned char BlockByte, BlockCode, BlockType, BlockTypeByte, Integrator;
720 Integrator = 0;
721 Pos = *StartPos;
722 BlockTypePos = *BlockTypeStartPos;
723 MaxPos = 396; //Pos + Len;
724 ExtraPos = Pos;
725 BlockLen = 0;
726 BlockByte = 0;
727 BlockCode = 0;
728 BlockType = 0;
729 BlockTypeByte = 0;
730 BlockTypeLen = 0;
731 RestPixel = Len;
733 for (Idx = 0; Idx < Len; Idx++) {
735 if (BlockLen == 0) {
736 if (BlockTypeLen==0) {
737 BlockTypeByte = Compressed[BlockTypePos];
738 BlockTypePos++;
739 BlockTypeLen = 4;
741 BlockType = (BlockTypeByte & 0xC0) >> 6;
743 //statistic:
744 usbvision->ComprBlockTypes[BlockType]++;
746 Pos = ExtraPos;
747 if (BlockType == 0) {
748 if(RestPixel >= 24) {
749 Idx += 23;
750 RestPixel -= 24;
751 Integrator = Decompressed[Idx];
752 } else {
753 Idx += RestPixel - 1;
754 RestPixel = 0;
756 } else {
757 BlockCode = Compressed[Pos];
758 Pos++;
759 if (RestPixel >= 24) {
760 BlockLen = 24;
761 } else {
762 BlockLen = RestPixel;
764 RestPixel -= BlockLen;
765 ExtraPos = Pos + (BlockLen / 4);
767 BlockTypeByte <<= 2;
768 BlockTypeLen -= 1;
770 if (BlockLen > 0) {
771 if ((BlockLen%4) == 0) {
772 BlockByte = Compressed[Pos];
773 Pos++;
775 if (BlockType == 1) { //inter Block
776 Integrator = Decompressed[Idx];
778 switch (BlockByte & 0xC0) {
779 case 0x03<<6:
780 Integrator += Compressed[ExtraPos];
781 ExtraPos++;
782 break;
783 case 0x02<<6:
784 Integrator += BlockCode;
785 break;
786 case 0x00:
787 Integrator -= BlockCode;
788 break;
790 Decompressed[Idx] = Integrator;
791 BlockByte <<= 2;
792 BlockLen -= 1;
795 *StartPos = ExtraPos;
796 *BlockTypeStartPos = BlockTypePos;
797 return Idx;
802 * usbvision_parse_compress()
804 * Parse compressed frame from the scratch buffer, put
805 * decoded RGB value into the current frame buffer and add the written
806 * number of bytes (RGB) to the *pcopylen.
809 static enum ParseState usbvision_parse_compress(struct usb_usbvision *usbvision,
810 long *pcopylen)
812 #define USBVISION_STRIP_MAGIC 0x5A
813 #define USBVISION_STRIP_LEN_MAX 400
814 #define USBVISION_STRIP_HEADER_LEN 3
816 struct usbvision_frame *frame;
817 unsigned char *f,*u = NULL ,*v = NULL;
818 unsigned char StripData[USBVISION_STRIP_LEN_MAX];
819 unsigned char StripHeader[USBVISION_STRIP_HEADER_LEN];
820 int Idx, IdxEnd, StripLen, StripPtr, StartBlockPos, BlockPos, BlockTypePos;
821 int clipmask_index, bytes_per_pixel, rc;
822 int imageSize;
823 unsigned char rv, gv, bv;
824 static unsigned char *Y, *U, *V;
826 frame = usbvision->curFrame;
827 imageSize = frame->frmwidth * frame->frmheight;
828 if ( (frame->v4l2_format.format == V4L2_PIX_FMT_YUV422P) ||
829 (frame->v4l2_format.format == V4L2_PIX_FMT_YVU420) ) { // this is a planar format
830 //... v4l2_linesize not used here.
831 f = frame->data + (frame->width * frame->curline);
832 } else
833 f = frame->data + (frame->v4l2_linesize * frame->curline);
835 if (frame->v4l2_format.format == V4L2_PIX_FMT_YUYV){ //initialise u and v pointers
836 // get base of u and b planes add halfoffset
838 u = frame->data
839 + imageSize
840 + (frame->frmwidth >>1) * frame->curline ;
841 v = u + (imageSize >>1 );
843 } else if (frame->v4l2_format.format == V4L2_PIX_FMT_YVU420){
845 v = frame->data + imageSize + ((frame->curline* (frame->width))>>2) ;
846 u = v + (imageSize >>2) ;
849 if (frame->curline == 0) {
850 usbvision_adjust_compression(usbvision);
853 if (scratch_len(usbvision) < USBVISION_STRIP_HEADER_LEN) {
854 return ParseState_Out;
857 //get strip header without changing the scratch_read_ptr
858 scratch_set_extra_ptr(usbvision, &StripPtr, 0);
859 scratch_get_extra(usbvision, &StripHeader[0], &StripPtr,
860 USBVISION_STRIP_HEADER_LEN);
862 if (StripHeader[0] != USBVISION_STRIP_MAGIC) {
863 // wrong strip magic
864 usbvision->stripMagicErrors++;
865 return ParseState_NextFrame;
868 if (frame->curline != (int)StripHeader[2]) {
869 //line number missmatch error
870 usbvision->stripLineNumberErrors++;
873 StripLen = 2 * (unsigned int)StripHeader[1];
874 if (StripLen > USBVISION_STRIP_LEN_MAX) {
875 // strip overrun
876 // I think this never happens
877 usbvision_request_intra(usbvision);
880 if (scratch_len(usbvision) < StripLen) {
881 //there is not enough data for the strip
882 return ParseState_Out;
885 if (usbvision->IntraFrameBuffer) {
886 Y = usbvision->IntraFrameBuffer + frame->frmwidth * frame->curline;
887 U = usbvision->IntraFrameBuffer + imageSize + (frame->frmwidth / 2) * (frame->curline / 2);
888 V = usbvision->IntraFrameBuffer + imageSize / 4 * 5 + (frame->frmwidth / 2) * (frame->curline / 2);
890 else {
891 return ParseState_NextFrame;
894 bytes_per_pixel = frame->v4l2_format.bytes_per_pixel;
895 clipmask_index = frame->curline * MAX_FRAME_WIDTH;
897 scratch_get(usbvision, StripData, StripLen);
899 IdxEnd = frame->frmwidth;
900 BlockTypePos = USBVISION_STRIP_HEADER_LEN;
901 StartBlockPos = BlockTypePos + (IdxEnd - 1) / 96 + (IdxEnd / 2 - 1) / 96 + 2;
902 BlockPos = StartBlockPos;
904 usbvision->BlockPos = BlockPos;
906 if ((rc = usbvision_decompress(usbvision, StripData, Y, &BlockPos, &BlockTypePos, IdxEnd)) != IdxEnd) {
907 //return ParseState_Continue;
909 if (StripLen > usbvision->maxStripLen) {
910 usbvision->maxStripLen = StripLen;
913 if (frame->curline%2) {
914 if ((rc = usbvision_decompress(usbvision, StripData, V, &BlockPos, &BlockTypePos, IdxEnd/2)) != IdxEnd/2) {
915 //return ParseState_Continue;
918 else {
919 if ((rc = usbvision_decompress(usbvision, StripData, U, &BlockPos, &BlockTypePos, IdxEnd/2)) != IdxEnd/2) {
920 //return ParseState_Continue;
924 if (BlockPos > usbvision->comprBlockPos) {
925 usbvision->comprBlockPos = BlockPos;
927 if (BlockPos > StripLen) {
928 usbvision->stripLenErrors++;
931 for (Idx = 0; Idx < IdxEnd; Idx++) {
932 if(frame->v4l2_format.format == V4L2_PIX_FMT_YUYV) {
933 *f++ = Y[Idx];
934 *f++ = Idx & 0x01 ? U[Idx/2] : V[Idx/2];
936 else if(frame->v4l2_format.format == V4L2_PIX_FMT_YUV422P) {
937 *f++ = Y[Idx];
938 if ( Idx & 0x01)
939 *u++ = U[Idx>>1] ;
940 else
941 *v++ = V[Idx>>1];
943 else if (frame->v4l2_format.format == V4L2_PIX_FMT_YVU420) {
944 *f++ = Y [Idx];
945 if ( !(( Idx & 0x01 ) | ( frame->curline & 0x01 )) ){
947 /* only need do this for 1 in 4 pixels */
948 /* intraframe buffer is YUV420 format */
950 *u++ = U[Idx >>1];
951 *v++ = V[Idx >>1];
955 else {
956 YUV_TO_RGB_BY_THE_BOOK(Y[Idx], U[Idx/2], V[Idx/2], rv, gv, bv);
957 switch (frame->v4l2_format.format) {
958 case V4L2_PIX_FMT_GREY:
959 *f++ = Y[Idx];
960 break;
961 case V4L2_PIX_FMT_RGB555:
962 *f++ = (0x1F & rv) |
963 (0xE0 & (gv << 5));
964 *f++ = (0x03 & (gv >> 3)) |
965 (0x7C & (bv << 2));
966 break;
967 case V4L2_PIX_FMT_RGB565:
968 *f++ = (0x1F & rv) |
969 (0xE0 & (gv << 5));
970 *f++ = (0x07 & (gv >> 3)) |
971 (0xF8 & bv);
972 break;
973 case V4L2_PIX_FMT_RGB24:
974 *f++ = rv;
975 *f++ = gv;
976 *f++ = bv;
977 break;
978 case V4L2_PIX_FMT_RGB32:
979 *f++ = rv;
980 *f++ = gv;
981 *f++ = bv;
982 f++;
983 break;
986 clipmask_index++;
988 /* Deal with non-integer no. of bytes for YUV420P */
989 if (frame->v4l2_format.format != V4L2_PIX_FMT_YVU420 )
990 *pcopylen += frame->v4l2_linesize;
991 else
992 *pcopylen += frame->curline & 0x01 ? frame->v4l2_linesize : frame->v4l2_linesize << 1;
994 frame->curline += 1;
996 if (frame->curline >= frame->frmheight) {
997 return ParseState_NextFrame;
999 else {
1000 return ParseState_Continue;
1007 * usbvision_parse_lines_420()
1009 * Parse two lines from the scratch buffer, put
1010 * decoded RGB value into the current frame buffer and add the written
1011 * number of bytes (RGB) to the *pcopylen.
1014 static enum ParseState usbvision_parse_lines_420(struct usb_usbvision *usbvision,
1015 long *pcopylen)
1017 struct usbvision_frame *frame;
1018 unsigned char *f_even = NULL, *f_odd = NULL;
1019 unsigned int pixel_per_line, block;
1020 int pixel, block_split;
1021 int y_ptr, u_ptr, v_ptr, y_odd_offset;
1022 const int y_block_size = 128;
1023 const int uv_block_size = 64;
1024 const int sub_block_size = 32;
1025 const int y_step[] = { 0, 0, 0, 2 }, y_step_size = 4;
1026 const int uv_step[]= { 0, 0, 0, 4 }, uv_step_size = 4;
1027 unsigned char y[2], u, v; /* YUV components */
1028 int y_, u_, v_, vb, uvg, ur;
1029 int r_, g_, b_; /* RGB components */
1030 unsigned char g;
1031 int clipmask_even_index, clipmask_odd_index, bytes_per_pixel;
1032 int clipmask_add, stretch_bytes;
1034 frame = usbvision->curFrame;
1035 f_even = frame->data + (frame->v4l2_linesize * frame->curline);
1036 f_odd = f_even + frame->v4l2_linesize * usbvision->stretch_height;
1038 /* Make sure there's enough data for the entire line */
1039 /* In this mode usbvision transfer 3 bytes for every 2 pixels */
1040 /* I need two lines to decode the color */
1041 bytes_per_pixel = frame->v4l2_format.bytes_per_pixel;
1042 stretch_bytes = (usbvision->stretch_width - 1) * bytes_per_pixel;
1043 clipmask_even_index = frame->curline * MAX_FRAME_WIDTH;
1044 clipmask_odd_index = clipmask_even_index + MAX_FRAME_WIDTH;
1045 clipmask_add = usbvision->stretch_width;
1046 pixel_per_line = frame->isocHeader.frameWidth;
1048 if (scratch_len(usbvision) < (int)pixel_per_line * 3) {
1049 //printk(KERN_DEBUG "out of data, need %d\n", len);
1050 return ParseState_Out;
1053 if ((frame->curline + 1) >= frame->frmheight) {
1054 return ParseState_NextFrame;
1057 block_split = (pixel_per_line%y_block_size) ? 1 : 0; //are some blocks splitted into different lines?
1059 y_odd_offset = (pixel_per_line / y_block_size) * (y_block_size + uv_block_size)
1060 + block_split * uv_block_size;
1062 scratch_set_extra_ptr(usbvision, &y_ptr, y_odd_offset);
1063 scratch_set_extra_ptr(usbvision, &u_ptr, y_block_size);
1064 scratch_set_extra_ptr(usbvision, &v_ptr, y_odd_offset
1065 + (4 - block_split) * sub_block_size);
1067 for (block = 0; block < (pixel_per_line / sub_block_size);
1068 block++) {
1071 for (pixel = 0; pixel < sub_block_size; pixel +=2) {
1072 scratch_get(usbvision, &y[0], 2);
1073 scratch_get_extra(usbvision, &u, &u_ptr, 1);
1074 scratch_get_extra(usbvision, &v, &v_ptr, 1);
1076 //I don't use the YUV_TO_RGB macro for better performance
1077 v_ = v - 128;
1078 u_ = u - 128;
1079 vb = 132252 * v_;
1080 uvg= -53281 * u_ - 25625 * v_;
1081 ur = 104595 * u_;
1083 if(frame->v4l2_format.format == V4L2_PIX_FMT_YUYV) {
1084 *f_even++ = y[0];
1085 *f_even++ = v;
1087 else {
1088 y_ = 76284 * (y[0] - 16);
1090 b_ = (y_ + vb) >> 16;
1091 g_ = (y_ + uvg)>> 16;
1092 r_ = (y_ + ur) >> 16;
1094 switch (frame->v4l2_format.format) {
1095 case V4L2_PIX_FMT_RGB565:
1096 g = LIMIT_RGB(g_);
1097 *f_even++ =
1098 (0x1F & LIMIT_RGB(r_)) |
1099 (0xE0 & (g << 5));
1100 *f_even++ =
1101 (0x07 & (g >> 3)) |
1102 (0xF8 & LIMIT_RGB(b_));
1103 break;
1104 case V4L2_PIX_FMT_RGB24:
1105 *f_even++ = LIMIT_RGB(r_);
1106 *f_even++ = LIMIT_RGB(g_);
1107 *f_even++ = LIMIT_RGB(b_);
1108 break;
1109 case V4L2_PIX_FMT_RGB32:
1110 *f_even++ = LIMIT_RGB(r_);
1111 *f_even++ = LIMIT_RGB(g_);
1112 *f_even++ = LIMIT_RGB(b_);
1113 f_even++;
1114 break;
1115 case V4L2_PIX_FMT_RGB555:
1116 g = LIMIT_RGB(g_);
1117 *f_even++ = (0x1F & LIMIT_RGB(r_)) |
1118 (0xE0 & (g << 5));
1119 *f_even++ = (0x03 & (g >> 3)) |
1120 (0x7C & (LIMIT_RGB(b_) << 2));
1121 break;
1124 clipmask_even_index += clipmask_add;
1125 f_even += stretch_bytes;
1127 if(frame->v4l2_format.format == V4L2_PIX_FMT_YUYV) {
1128 *f_even++ = y[1];
1129 *f_even++ = u;
1131 else {
1132 y_ = 76284 * (y[1] - 16);
1134 b_ = (y_ + vb) >> 16;
1135 g_ = (y_ + uvg)>> 16;
1136 r_ = (y_ + ur) >> 16;
1138 switch (frame->v4l2_format.format) {
1139 case V4L2_PIX_FMT_RGB565:
1140 g = LIMIT_RGB(g_);
1141 *f_even++ =
1142 (0x1F & LIMIT_RGB(r_)) |
1143 (0xE0 & (g << 5));
1144 *f_even++ =
1145 (0x07 & (g >> 3)) |
1146 (0xF8 & LIMIT_RGB(b_));
1147 break;
1148 case V4L2_PIX_FMT_RGB24:
1149 *f_even++ = LIMIT_RGB(r_);
1150 *f_even++ = LIMIT_RGB(g_);
1151 *f_even++ = LIMIT_RGB(b_);
1152 break;
1153 case V4L2_PIX_FMT_RGB32:
1154 *f_even++ = LIMIT_RGB(r_);
1155 *f_even++ = LIMIT_RGB(g_);
1156 *f_even++ = LIMIT_RGB(b_);
1157 f_even++;
1158 break;
1159 case V4L2_PIX_FMT_RGB555:
1160 g = LIMIT_RGB(g_);
1161 *f_even++ = (0x1F & LIMIT_RGB(r_)) |
1162 (0xE0 & (g << 5));
1163 *f_even++ = (0x03 & (g >> 3)) |
1164 (0x7C & (LIMIT_RGB(b_) << 2));
1165 break;
1168 clipmask_even_index += clipmask_add;
1169 f_even += stretch_bytes;
1171 scratch_get_extra(usbvision, &y[0], &y_ptr, 2);
1173 if(frame->v4l2_format.format == V4L2_PIX_FMT_YUYV) {
1174 *f_odd++ = y[0];
1175 *f_odd++ = v;
1177 else {
1178 y_ = 76284 * (y[0] - 16);
1180 b_ = (y_ + vb) >> 16;
1181 g_ = (y_ + uvg)>> 16;
1182 r_ = (y_ + ur) >> 16;
1184 switch (frame->v4l2_format.format) {
1185 case V4L2_PIX_FMT_RGB565:
1186 g = LIMIT_RGB(g_);
1187 *f_odd++ =
1188 (0x1F & LIMIT_RGB(r_)) |
1189 (0xE0 & (g << 5));
1190 *f_odd++ =
1191 (0x07 & (g >> 3)) |
1192 (0xF8 & LIMIT_RGB(b_));
1193 break;
1194 case V4L2_PIX_FMT_RGB24:
1195 *f_odd++ = LIMIT_RGB(r_);
1196 *f_odd++ = LIMIT_RGB(g_);
1197 *f_odd++ = LIMIT_RGB(b_);
1198 break;
1199 case V4L2_PIX_FMT_RGB32:
1200 *f_odd++ = LIMIT_RGB(r_);
1201 *f_odd++ = LIMIT_RGB(g_);
1202 *f_odd++ = LIMIT_RGB(b_);
1203 f_odd++;
1204 break;
1205 case V4L2_PIX_FMT_RGB555:
1206 g = LIMIT_RGB(g_);
1207 *f_odd++ = (0x1F & LIMIT_RGB(r_)) |
1208 (0xE0 & (g << 5));
1209 *f_odd++ = (0x03 & (g >> 3)) |
1210 (0x7C & (LIMIT_RGB(b_) << 2));
1211 break;
1214 clipmask_odd_index += clipmask_add;
1215 f_odd += stretch_bytes;
1217 if(frame->v4l2_format.format == V4L2_PIX_FMT_YUYV) {
1218 *f_odd++ = y[1];
1219 *f_odd++ = u;
1221 else {
1222 y_ = 76284 * (y[1] - 16);
1224 b_ = (y_ + vb) >> 16;
1225 g_ = (y_ + uvg)>> 16;
1226 r_ = (y_ + ur) >> 16;
1228 switch (frame->v4l2_format.format) {
1229 case V4L2_PIX_FMT_RGB565:
1230 g = LIMIT_RGB(g_);
1231 *f_odd++ =
1232 (0x1F & LIMIT_RGB(r_)) |
1233 (0xE0 & (g << 5));
1234 *f_odd++ =
1235 (0x07 & (g >> 3)) |
1236 (0xF8 & LIMIT_RGB(b_));
1237 break;
1238 case V4L2_PIX_FMT_RGB24:
1239 *f_odd++ = LIMIT_RGB(r_);
1240 *f_odd++ = LIMIT_RGB(g_);
1241 *f_odd++ = LIMIT_RGB(b_);
1242 break;
1243 case V4L2_PIX_FMT_RGB32:
1244 *f_odd++ = LIMIT_RGB(r_);
1245 *f_odd++ = LIMIT_RGB(g_);
1246 *f_odd++ = LIMIT_RGB(b_);
1247 f_odd++;
1248 break;
1249 case V4L2_PIX_FMT_RGB555:
1250 g = LIMIT_RGB(g_);
1251 *f_odd++ = (0x1F & LIMIT_RGB(r_)) |
1252 (0xE0 & (g << 5));
1253 *f_odd++ = (0x03 & (g >> 3)) |
1254 (0x7C & (LIMIT_RGB(b_) << 2));
1255 break;
1258 clipmask_odd_index += clipmask_add;
1259 f_odd += stretch_bytes;
1262 scratch_rm_old(usbvision,y_step[block % y_step_size] * sub_block_size);
1263 scratch_inc_extra_ptr(&y_ptr, y_step[(block + 2 * block_split) % y_step_size]
1264 * sub_block_size);
1265 scratch_inc_extra_ptr(&u_ptr, uv_step[block % uv_step_size]
1266 * sub_block_size);
1267 scratch_inc_extra_ptr(&v_ptr, uv_step[(block + 2 * block_split) % uv_step_size]
1268 * sub_block_size);
1271 scratch_rm_old(usbvision, pixel_per_line * 3 / 2
1272 + block_split * sub_block_size);
1274 frame->curline += 2 * usbvision->stretch_height;
1275 *pcopylen += frame->v4l2_linesize * 2 * usbvision->stretch_height;
1277 if (frame->curline >= frame->frmheight)
1278 return ParseState_NextFrame;
1279 else
1280 return ParseState_Continue;
1284 * usbvision_parse_data()
1286 * Generic routine to parse the scratch buffer. It employs either
1287 * usbvision_find_header() or usbvision_parse_lines() to do most
1288 * of work.
1291 static void usbvision_parse_data(struct usb_usbvision *usbvision)
1293 struct usbvision_frame *frame;
1294 enum ParseState newstate;
1295 long copylen = 0;
1296 unsigned long lock_flags;
1298 frame = usbvision->curFrame;
1300 PDEBUG(DBG_PARSE, "parsing len=%d\n", scratch_len(usbvision));
1302 while (1) {
1304 newstate = ParseState_Out;
1305 if (scratch_len(usbvision)) {
1306 if (frame->scanstate == ScanState_Scanning) {
1307 newstate = usbvision_find_header(usbvision);
1309 else if (frame->scanstate == ScanState_Lines) {
1310 if (usbvision->isocMode == ISOC_MODE_YUV420) {
1311 newstate = usbvision_parse_lines_420(usbvision, &copylen);
1313 else if (usbvision->isocMode == ISOC_MODE_YUV422) {
1314 newstate = usbvision_parse_lines_422(usbvision, &copylen);
1316 else if (usbvision->isocMode == ISOC_MODE_COMPRESS) {
1317 newstate = usbvision_parse_compress(usbvision, &copylen);
1322 if (newstate == ParseState_Continue) {
1323 continue;
1325 else if ((newstate == ParseState_NextFrame) || (newstate == ParseState_Out)) {
1326 break;
1328 else {
1329 return; /* ParseState_EndParse */
1333 if (newstate == ParseState_NextFrame) {
1334 frame->grabstate = FrameState_Done;
1335 do_gettimeofday(&(frame->timestamp));
1336 frame->sequence = usbvision->frame_num;
1338 spin_lock_irqsave(&usbvision->queue_lock, lock_flags);
1339 list_move_tail(&(frame->frame), &usbvision->outqueue);
1340 usbvision->curFrame = NULL;
1341 spin_unlock_irqrestore(&usbvision->queue_lock, lock_flags);
1343 usbvision->frame_num++;
1345 /* This will cause the process to request another frame. */
1346 if (waitqueue_active(&usbvision->wait_frame)) {
1347 PDEBUG(DBG_PARSE, "Wake up !");
1348 wake_up_interruptible(&usbvision->wait_frame);
1351 else
1352 frame->grabstate = FrameState_Grabbing;
1355 /* Update the frame's uncompressed length. */
1356 frame->scanlength += copylen;
1361 * Make all of the blocks of data contiguous
1363 static int usbvision_compress_isochronous(struct usb_usbvision *usbvision,
1364 struct urb *urb)
1366 unsigned char *packet_data;
1367 int i, totlen = 0;
1369 for (i = 0; i < urb->number_of_packets; i++) {
1370 int packet_len = urb->iso_frame_desc[i].actual_length;
1371 int packet_stat = urb->iso_frame_desc[i].status;
1373 packet_data = urb->transfer_buffer + urb->iso_frame_desc[i].offset;
1375 /* Detect and ignore errored packets */
1376 if (packet_stat) { // packet_stat != 0 ?????????????
1377 PDEBUG(DBG_ISOC, "data error: [%d] len=%d, status=%X", i, packet_len, packet_stat);
1378 usbvision->isocErrCount++;
1379 continue;
1382 /* Detect and ignore empty packets */
1383 if (packet_len < 0) {
1384 PDEBUG(DBG_ISOC, "error packet [%d]", i);
1385 usbvision->isocSkipCount++;
1386 continue;
1388 else if (packet_len == 0) { /* Frame end ????? */
1389 PDEBUG(DBG_ISOC, "null packet [%d]", i);
1390 usbvision->isocstate=IsocState_NoFrame;
1391 usbvision->isocSkipCount++;
1392 continue;
1394 else if (packet_len > usbvision->isocPacketSize) {
1395 PDEBUG(DBG_ISOC, "packet[%d] > isocPacketSize", i);
1396 usbvision->isocSkipCount++;
1397 continue;
1400 PDEBUG(DBG_ISOC, "packet ok [%d] len=%d", i, packet_len);
1402 if (usbvision->isocstate==IsocState_NoFrame) { //new frame begins
1403 usbvision->isocstate=IsocState_InFrame;
1404 scratch_mark_header(usbvision);
1405 usbvision_measure_bandwidth(usbvision);
1406 PDEBUG(DBG_ISOC, "packet with header");
1410 * If usbvision continues to feed us with data but there is no
1411 * consumption (if, for example, V4L client fell asleep) we
1412 * may overflow the buffer. We have to move old data over to
1413 * free room for new data. This is bad for old data. If we
1414 * just drop new data then it's bad for new data... choose
1415 * your favorite evil here.
1417 if (scratch_free(usbvision) < packet_len) {
1419 usbvision->scratch_ovf_count++;
1420 PDEBUG(DBG_ISOC, "scratch buf overflow! scr_len: %d, n: %d",
1421 scratch_len(usbvision), packet_len);
1422 scratch_rm_old(usbvision, packet_len - scratch_free(usbvision));
1425 /* Now we know that there is enough room in scratch buffer */
1426 scratch_put(usbvision, packet_data, packet_len);
1427 totlen += packet_len;
1428 usbvision->isocDataCount += packet_len;
1429 usbvision->isocPacketCount++;
1431 #if ENABLE_HEXDUMP
1432 if (totlen > 0) {
1433 static int foo = 0;
1434 if (foo < 1) {
1435 printk(KERN_DEBUG "+%d.\n", usbvision->scratchlen);
1436 usbvision_hexdump(data0, (totlen > 64) ? 64 : totlen);
1437 ++foo;
1440 #endif
1441 return totlen;
1444 static void usbvision_isocIrq(struct urb *urb)
1446 int errCode = 0;
1447 int len;
1448 struct usb_usbvision *usbvision = urb->context;
1449 int i;
1450 unsigned long startTime = jiffies;
1451 struct usbvision_frame **f;
1453 /* We don't want to do anything if we are about to be removed! */
1454 if (!USBVISION_IS_OPERATIONAL(usbvision))
1455 return;
1457 /* any urb with wrong status is ignored without acknowledgement */
1458 if (urb->status == -ENOENT) {
1459 return;
1462 f = &usbvision->curFrame;
1464 /* Manage streaming interruption */
1465 if (usbvision->streaming == Stream_Interrupt) {
1466 usbvision->streaming = Stream_Idle;
1467 if ((*f)) {
1468 (*f)->grabstate = FrameState_Ready;
1469 (*f)->scanstate = ScanState_Scanning;
1471 PDEBUG(DBG_IRQ, "stream interrupted");
1472 wake_up_interruptible(&usbvision->wait_stream);
1475 /* Copy the data received into our scratch buffer */
1476 len = usbvision_compress_isochronous(usbvision, urb);
1478 usbvision->isocUrbCount++;
1479 usbvision->urb_length = len;
1481 if (usbvision->streaming == Stream_On) {
1483 /* If we collected enough data let's parse! */
1484 if ((scratch_len(usbvision) > USBVISION_HEADER_LENGTH) &&
1485 (!list_empty(&(usbvision->inqueue))) ) {
1486 if (!(*f)) {
1487 (*f) = list_entry(usbvision->inqueue.next,
1488 struct usbvision_frame,
1489 frame);
1491 usbvision_parse_data(usbvision);
1493 else {
1494 /*If we don't have a frame
1495 we're current working on, complain */
1496 PDEBUG(DBG_IRQ,
1497 "received data, but no one needs it");
1498 scratch_reset(usbvision);
1501 else {
1502 PDEBUG(DBG_IRQ, "received data, but no one needs it");
1503 scratch_reset(usbvision);
1506 usbvision->timeInIrq += jiffies - startTime;
1508 for (i = 0; i < USBVISION_URB_FRAMES; i++) {
1509 urb->iso_frame_desc[i].status = 0;
1510 urb->iso_frame_desc[i].actual_length = 0;
1513 urb->status = 0;
1514 urb->dev = usbvision->dev;
1515 errCode = usb_submit_urb (urb, GFP_ATOMIC);
1517 if(errCode) {
1518 err("%s: usb_submit_urb failed: error %d",
1519 __FUNCTION__, errCode);
1522 return;
1525 /*************************************/
1526 /* Low level usbvision access functions */
1527 /*************************************/
1530 * usbvision_read_reg()
1532 * return < 0 -> Error
1533 * >= 0 -> Data
1536 int usbvision_read_reg(struct usb_usbvision *usbvision, unsigned char reg)
1538 int errCode = 0;
1539 unsigned char buffer[1];
1541 if (!USBVISION_IS_OPERATIONAL(usbvision))
1542 return -1;
1544 errCode = usb_control_msg(usbvision->dev, usb_rcvctrlpipe(usbvision->dev, 1),
1545 USBVISION_OP_CODE,
1546 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT,
1547 0, (__u16) reg, buffer, 1, HZ);
1549 if (errCode < 0) {
1550 err("%s: failed: error %d", __FUNCTION__, errCode);
1551 return errCode;
1553 return buffer[0];
1557 * usbvision_write_reg()
1559 * return 1 -> Reg written
1560 * 0 -> usbvision is not yet ready
1561 * -1 -> Something went wrong
1564 int usbvision_write_reg(struct usb_usbvision *usbvision, unsigned char reg,
1565 unsigned char value)
1567 int errCode = 0;
1569 if (!USBVISION_IS_OPERATIONAL(usbvision))
1570 return 0;
1572 errCode = usb_control_msg(usbvision->dev, usb_sndctrlpipe(usbvision->dev, 1),
1573 USBVISION_OP_CODE,
1574 USB_DIR_OUT | USB_TYPE_VENDOR |
1575 USB_RECIP_ENDPOINT, 0, (__u16) reg, &value, 1, HZ);
1577 if (errCode < 0) {
1578 err("%s: failed: error %d", __FUNCTION__, errCode);
1580 return errCode;
1584 static void usbvision_ctrlUrb_complete(struct urb *urb)
1586 struct usb_usbvision *usbvision = (struct usb_usbvision *)urb->context;
1588 PDEBUG(DBG_IRQ, "");
1589 usbvision->ctrlUrbBusy = 0;
1590 if (waitqueue_active(&usbvision->ctrlUrb_wq)) {
1591 wake_up_interruptible(&usbvision->ctrlUrb_wq);
1596 static int usbvision_write_reg_irq(struct usb_usbvision *usbvision,int address,
1597 unsigned char *data, int len)
1599 int errCode = 0;
1601 PDEBUG(DBG_IRQ, "");
1602 if (len > 8) {
1603 return -EFAULT;
1605 if (usbvision->ctrlUrbBusy) {
1606 return -EBUSY;
1608 usbvision->ctrlUrbBusy = 1;
1610 usbvision->ctrlUrbSetup.bRequestType = USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT;
1611 usbvision->ctrlUrbSetup.bRequest = USBVISION_OP_CODE;
1612 usbvision->ctrlUrbSetup.wValue = 0;
1613 usbvision->ctrlUrbSetup.wIndex = cpu_to_le16(address);
1614 usbvision->ctrlUrbSetup.wLength = cpu_to_le16(len);
1615 usb_fill_control_urb (usbvision->ctrlUrb, usbvision->dev,
1616 usb_sndctrlpipe(usbvision->dev, 1),
1617 (unsigned char *)&usbvision->ctrlUrbSetup,
1618 (void *)usbvision->ctrlUrbBuffer, len,
1619 usbvision_ctrlUrb_complete,
1620 (void *)usbvision);
1622 memcpy(usbvision->ctrlUrbBuffer, data, len);
1624 errCode = usb_submit_urb(usbvision->ctrlUrb, GFP_ATOMIC);
1625 if (errCode < 0) {
1626 // error in usb_submit_urb()
1627 usbvision->ctrlUrbBusy = 0;
1629 PDEBUG(DBG_IRQ, "submit %d byte: error %d", len, errCode);
1630 return errCode;
1634 static int usbvision_init_compression(struct usb_usbvision *usbvision)
1636 int errCode = 0;
1638 usbvision->lastIsocFrameNum = -1;
1639 usbvision->isocDataCount = 0;
1640 usbvision->isocPacketCount = 0;
1641 usbvision->isocSkipCount = 0;
1642 usbvision->comprLevel = 50;
1643 usbvision->lastComprLevel = -1;
1644 usbvision->isocUrbCount = 0;
1645 usbvision->requestIntra = 1;
1646 usbvision->isocMeasureBandwidthCount = 0;
1648 return errCode;
1651 /* this function measures the used bandwidth since last call
1652 * return: 0 : no error
1653 * sets usedBandwidth to 1-100 : 1-100% of full bandwidth resp. to isocPacketSize
1655 static int usbvision_measure_bandwidth (struct usb_usbvision *usbvision)
1657 int errCode = 0;
1659 if (usbvision->isocMeasureBandwidthCount < 2) { // this gives an average bandwidth of 3 frames
1660 usbvision->isocMeasureBandwidthCount++;
1661 return errCode;
1663 if ((usbvision->isocPacketSize > 0) && (usbvision->isocPacketCount > 0)) {
1664 usbvision->usedBandwidth = usbvision->isocDataCount /
1665 (usbvision->isocPacketCount + usbvision->isocSkipCount) *
1666 100 / usbvision->isocPacketSize;
1668 usbvision->isocMeasureBandwidthCount = 0;
1669 usbvision->isocDataCount = 0;
1670 usbvision->isocPacketCount = 0;
1671 usbvision->isocSkipCount = 0;
1672 return errCode;
1675 static int usbvision_adjust_compression (struct usb_usbvision *usbvision)
1677 int errCode = 0;
1678 unsigned char buffer[6];
1680 PDEBUG(DBG_IRQ, "");
1681 if ((adjustCompression) && (usbvision->usedBandwidth > 0)) {
1682 usbvision->comprLevel += (usbvision->usedBandwidth - 90) / 2;
1683 RESTRICT_TO_RANGE(usbvision->comprLevel, 0, 100);
1684 if (usbvision->comprLevel != usbvision->lastComprLevel) {
1685 int distorsion;
1686 if (usbvision->bridgeType == BRIDGE_NT1004 || usbvision->bridgeType == BRIDGE_NT1005) {
1687 buffer[0] = (unsigned char)(4 + 16 * usbvision->comprLevel / 100); // PCM Threshold 1
1688 buffer[1] = (unsigned char)(4 + 8 * usbvision->comprLevel / 100); // PCM Threshold 2
1689 distorsion = 7 + 248 * usbvision->comprLevel / 100;
1690 buffer[2] = (unsigned char)(distorsion & 0xFF); // Average distorsion Threshold (inter)
1691 buffer[3] = (unsigned char)(distorsion & 0xFF); // Average distorsion Threshold (intra)
1692 distorsion = 1 + 42 * usbvision->comprLevel / 100;
1693 buffer[4] = (unsigned char)(distorsion & 0xFF); // Maximum distorsion Threshold (inter)
1694 buffer[5] = (unsigned char)(distorsion & 0xFF); // Maximum distorsion Threshold (intra)
1696 else { //BRIDGE_NT1003
1697 buffer[0] = (unsigned char)(4 + 16 * usbvision->comprLevel / 100); // PCM threshold 1
1698 buffer[1] = (unsigned char)(4 + 8 * usbvision->comprLevel / 100); // PCM threshold 2
1699 distorsion = 2 + 253 * usbvision->comprLevel / 100;
1700 buffer[2] = (unsigned char)(distorsion & 0xFF); // distorsion threshold bit0-7
1701 buffer[3] = 0; //(unsigned char)((distorsion >> 8) & 0x0F); // distorsion threshold bit 8-11
1702 distorsion = 0 + 43 * usbvision->comprLevel / 100;
1703 buffer[4] = (unsigned char)(distorsion & 0xFF); // maximum distorsion bit0-7
1704 buffer[5] = 0; //(unsigned char)((distorsion >> 8) & 0x01); // maximum distorsion bit 8
1706 errCode = usbvision_write_reg_irq(usbvision, USBVISION_PCM_THR1, buffer, 6);
1707 if (errCode == 0){
1708 PDEBUG(DBG_IRQ, "new compr params %#02x %#02x %#02x %#02x %#02x %#02x", buffer[0],
1709 buffer[1], buffer[2], buffer[3], buffer[4], buffer[5]);
1710 usbvision->lastComprLevel = usbvision->comprLevel;
1714 return errCode;
1717 static int usbvision_request_intra (struct usb_usbvision *usbvision)
1719 int errCode = 0;
1720 unsigned char buffer[1];
1722 PDEBUG(DBG_IRQ, "");
1723 usbvision->requestIntra = 1;
1724 buffer[0] = 1;
1725 usbvision_write_reg_irq(usbvision, USBVISION_FORCE_INTRA, buffer, 1);
1726 return errCode;
1729 static int usbvision_unrequest_intra (struct usb_usbvision *usbvision)
1731 int errCode = 0;
1732 unsigned char buffer[1];
1734 PDEBUG(DBG_IRQ, "");
1735 usbvision->requestIntra = 0;
1736 buffer[0] = 0;
1737 usbvision_write_reg_irq(usbvision, USBVISION_FORCE_INTRA, buffer, 1);
1738 return errCode;
1741 /*******************************
1742 * usbvision utility functions
1743 *******************************/
1745 int usbvision_power_off(struct usb_usbvision *usbvision)
1747 int errCode = 0;
1749 PDEBUG(DBG_FUNC, "");
1751 errCode = usbvision_write_reg(usbvision, USBVISION_PWR_REG, USBVISION_SSPND_EN);
1752 if (errCode == 1) {
1753 usbvision->power = 0;
1755 PDEBUG(DBG_FUNC, "%s: errCode %d", (errCode!=1)?"ERROR":"power is off", errCode);
1756 return errCode;
1760 * usbvision_set_video_format()
1763 static int usbvision_set_video_format(struct usb_usbvision *usbvision, int format)
1765 static const char proc[] = "usbvision_set_video_format";
1766 int rc;
1767 unsigned char value[2];
1769 if (!USBVISION_IS_OPERATIONAL(usbvision))
1770 return 0;
1772 PDEBUG(DBG_FUNC, "isocMode %#02x", format);
1774 if ((format != ISOC_MODE_YUV422)
1775 && (format != ISOC_MODE_YUV420)
1776 && (format != ISOC_MODE_COMPRESS)) {
1777 printk(KERN_ERR "usbvision: unknown video format %02x, using default YUV420",
1778 format);
1779 format = ISOC_MODE_YUV420;
1781 value[0] = 0x0A; //TODO: See the effect of the filter
1782 value[1] = format; // Sets the VO_MODE register which follows FILT_CONT
1783 rc = usb_control_msg(usbvision->dev, usb_sndctrlpipe(usbvision->dev, 1),
1784 USBVISION_OP_CODE,
1785 USB_DIR_OUT | USB_TYPE_VENDOR |
1786 USB_RECIP_ENDPOINT, 0,
1787 (__u16) USBVISION_FILT_CONT, value, 2, HZ);
1789 if (rc < 0) {
1790 printk(KERN_ERR "%s: ERROR=%d. USBVISION stopped - "
1791 "reconnect or reload driver.\n", proc, rc);
1793 usbvision->isocMode = format;
1794 return rc;
1798 * usbvision_set_output()
1802 int usbvision_set_output(struct usb_usbvision *usbvision, int width,
1803 int height)
1805 int errCode = 0;
1806 int UsbWidth, UsbHeight;
1807 unsigned int frameRate=0, frameDrop=0;
1808 unsigned char value[4];
1810 if (!USBVISION_IS_OPERATIONAL(usbvision)) {
1811 return 0;
1814 if (width > MAX_USB_WIDTH) {
1815 UsbWidth = width / 2;
1816 usbvision->stretch_width = 2;
1818 else {
1819 UsbWidth = width;
1820 usbvision->stretch_width = 1;
1823 if (height > MAX_USB_HEIGHT) {
1824 UsbHeight = height / 2;
1825 usbvision->stretch_height = 2;
1827 else {
1828 UsbHeight = height;
1829 usbvision->stretch_height = 1;
1832 RESTRICT_TO_RANGE(UsbWidth, MIN_FRAME_WIDTH, MAX_USB_WIDTH);
1833 UsbWidth &= ~(MIN_FRAME_WIDTH-1);
1834 RESTRICT_TO_RANGE(UsbHeight, MIN_FRAME_HEIGHT, MAX_USB_HEIGHT);
1835 UsbHeight &= ~(1);
1837 PDEBUG(DBG_FUNC, "usb %dx%d; screen %dx%d; stretch %dx%d",
1838 UsbWidth, UsbHeight, width, height,
1839 usbvision->stretch_width, usbvision->stretch_height);
1841 /* I'll not rewrite the same values */
1842 if ((UsbWidth != usbvision->curwidth) || (UsbHeight != usbvision->curheight)) {
1843 value[0] = UsbWidth & 0xff; //LSB
1844 value[1] = (UsbWidth >> 8) & 0x03; //MSB
1845 value[2] = UsbHeight & 0xff; //LSB
1846 value[3] = (UsbHeight >> 8) & 0x03; //MSB
1848 errCode = usb_control_msg(usbvision->dev, usb_sndctrlpipe(usbvision->dev, 1),
1849 USBVISION_OP_CODE,
1850 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT,
1851 0, (__u16) USBVISION_LXSIZE_O, value, 4, HZ);
1853 if (errCode < 0) {
1854 err("%s failed: error %d", __FUNCTION__, errCode);
1855 return errCode;
1857 usbvision->curwidth = usbvision->stretch_width * UsbWidth;
1858 usbvision->curheight = usbvision->stretch_height * UsbHeight;
1861 if (usbvision->isocMode == ISOC_MODE_YUV422) {
1862 frameRate = (usbvision->isocPacketSize * 1000) / (UsbWidth * UsbHeight * 2);
1864 else if (usbvision->isocMode == ISOC_MODE_YUV420) {
1865 frameRate = (usbvision->isocPacketSize * 1000) / ((UsbWidth * UsbHeight * 12) / 8);
1867 else {
1868 frameRate = FRAMERATE_MAX;
1871 if (usbvision->tvnormId & V4L2_STD_625_50) {
1872 frameDrop = frameRate * 32 / 25 - 1;
1874 else if (usbvision->tvnormId & V4L2_STD_525_60) {
1875 frameDrop = frameRate * 32 / 30 - 1;
1878 RESTRICT_TO_RANGE(frameDrop, FRAMERATE_MIN, FRAMERATE_MAX);
1880 PDEBUG(DBG_FUNC, "frameRate %d fps, frameDrop %d", frameRate, frameDrop);
1882 frameDrop = FRAMERATE_MAX; // We can allow the maximum here, because dropping is controlled
1884 /* frameDrop = 7; => framePhase = 1, 5, 9, 13, 17, 21, 25, 0, 4, 8, ...
1885 => frameSkip = 4;
1886 => frameRate = (7 + 1) * 25 / 32 = 200 / 32 = 6.25;
1888 frameDrop = 9; => framePhase = 1, 5, 8, 11, 14, 17, 21, 24, 27, 1, 4, 8, ...
1889 => frameSkip = 4, 3, 3, 3, 3, 4, 3, 3, 3, 3, 4, ...
1890 => frameRate = (9 + 1) * 25 / 32 = 250 / 32 = 7.8125;
1892 errCode = usbvision_write_reg(usbvision, USBVISION_FRM_RATE, frameDrop);
1893 return errCode;
1898 * usbvision_frames_alloc
1899 * allocate the required frames
1901 int usbvision_frames_alloc(struct usb_usbvision *usbvision, int number_of_frames)
1903 int i;
1905 /*needs to be page aligned cause the buffers can be mapped individually! */
1906 usbvision->max_frame_size = PAGE_ALIGN(usbvision->curwidth *
1907 usbvision->curheight *
1908 usbvision->palette.bytes_per_pixel);
1910 /* Try to do my best to allocate the frames the user want in the remaining memory */
1911 usbvision->num_frames = number_of_frames;
1912 while (usbvision->num_frames > 0) {
1913 usbvision->fbuf_size = usbvision->num_frames * usbvision->max_frame_size;
1914 if((usbvision->fbuf = usbvision_rvmalloc(usbvision->fbuf_size))) {
1915 break;
1917 usbvision->num_frames--;
1920 spin_lock_init(&usbvision->queue_lock);
1921 init_waitqueue_head(&usbvision->wait_frame);
1922 init_waitqueue_head(&usbvision->wait_stream);
1924 /* Allocate all buffers */
1925 for (i = 0; i < usbvision->num_frames; i++) {
1926 usbvision->frame[i].index = i;
1927 usbvision->frame[i].grabstate = FrameState_Unused;
1928 usbvision->frame[i].data = usbvision->fbuf +
1929 i * usbvision->max_frame_size;
1931 * Set default sizes for read operation.
1933 usbvision->stretch_width = 1;
1934 usbvision->stretch_height = 1;
1935 usbvision->frame[i].width = usbvision->curwidth;
1936 usbvision->frame[i].height = usbvision->curheight;
1937 usbvision->frame[i].bytes_read = 0;
1939 PDEBUG(DBG_FUNC, "allocated %d frames (%d bytes per frame)",usbvision->num_frames,usbvision->max_frame_size);
1940 return usbvision->num_frames;
1944 * usbvision_frames_free
1945 * frees memory allocated for the frames
1947 void usbvision_frames_free(struct usb_usbvision *usbvision)
1949 /* Have to free all that memory */
1950 PDEBUG(DBG_FUNC, "free %d frames",usbvision->num_frames);
1952 if (usbvision->fbuf != NULL) {
1953 usbvision_rvfree(usbvision->fbuf, usbvision->fbuf_size);
1954 usbvision->fbuf = NULL;
1956 usbvision->num_frames = 0;
1960 * usbvision_empty_framequeues()
1961 * prepare queues for incoming and outgoing frames
1963 void usbvision_empty_framequeues(struct usb_usbvision *usbvision)
1965 u32 i;
1967 INIT_LIST_HEAD(&(usbvision->inqueue));
1968 INIT_LIST_HEAD(&(usbvision->outqueue));
1970 for (i = 0; i < USBVISION_NUMFRAMES; i++) {
1971 usbvision->frame[i].grabstate = FrameState_Unused;
1972 usbvision->frame[i].bytes_read = 0;
1977 * usbvision_stream_interrupt()
1978 * stops streaming
1980 int usbvision_stream_interrupt(struct usb_usbvision *usbvision)
1982 int ret = 0;
1984 /* stop reading from the device */
1986 usbvision->streaming = Stream_Interrupt;
1987 ret = wait_event_timeout(usbvision->wait_stream,
1988 (usbvision->streaming == Stream_Idle),
1989 msecs_to_jiffies(USBVISION_NUMSBUF*USBVISION_URB_FRAMES));
1990 return ret;
1994 * usbvision_set_compress_params()
1998 static int usbvision_set_compress_params(struct usb_usbvision *usbvision)
2000 static const char proc[] = "usbvision_set_compresion_params: ";
2001 int rc;
2002 unsigned char value[6];
2004 value[0] = 0x0F; // Intra-Compression cycle
2005 value[1] = 0x01; // Reg.45 one line per strip
2006 value[2] = 0x00; // Reg.46 Force intra mode on all new frames
2007 value[3] = 0x00; // Reg.47 FORCE_UP <- 0 normal operation (not force)
2008 value[4] = 0xA2; // Reg.48 BUF_THR I'm not sure if this does something in not compressed mode.
2009 value[5] = 0x00; // Reg.49 DVI_YUV This has nothing to do with compression
2011 //catched values for NT1004
2012 // value[0] = 0xFF; // Never apply intra mode automatically
2013 // value[1] = 0xF1; // Use full frame height for virtual strip width; One line per strip
2014 // value[2] = 0x01; // Force intra mode on all new frames
2015 // value[3] = 0x00; // Strip size 400 Bytes; do not force up
2016 // value[4] = 0xA2; //
2017 if (!USBVISION_IS_OPERATIONAL(usbvision))
2018 return 0;
2020 rc = usb_control_msg(usbvision->dev, usb_sndctrlpipe(usbvision->dev, 1),
2021 USBVISION_OP_CODE,
2022 USB_DIR_OUT | USB_TYPE_VENDOR |
2023 USB_RECIP_ENDPOINT, 0,
2024 (__u16) USBVISION_INTRA_CYC, value, 5, HZ);
2026 if (rc < 0) {
2027 printk(KERN_ERR "%sERROR=%d. USBVISION stopped - "
2028 "reconnect or reload driver.\n", proc, rc);
2029 return rc;
2032 if (usbvision->bridgeType == BRIDGE_NT1004) {
2033 value[0] = 20; // PCM Threshold 1
2034 value[1] = 12; // PCM Threshold 2
2035 value[2] = 255; // Distorsion Threshold inter
2036 value[3] = 255; // Distorsion Threshold intra
2037 value[4] = 43; // Max Distorsion inter
2038 value[5] = 43; // Max Distorsion intra
2040 else {
2041 value[0] = 20; // PCM Threshold 1
2042 value[1] = 12; // PCM Threshold 2
2043 value[2] = 255; // Distorsion Threshold d7-d0
2044 value[3] = 0; // Distorsion Threshold d11-d8
2045 value[4] = 43; // Max Distorsion d7-d0
2046 value[5] = 0; // Max Distorsion d8
2049 if (!USBVISION_IS_OPERATIONAL(usbvision))
2050 return 0;
2052 rc = usb_control_msg(usbvision->dev, usb_sndctrlpipe(usbvision->dev, 1),
2053 USBVISION_OP_CODE,
2054 USB_DIR_OUT | USB_TYPE_VENDOR |
2055 USB_RECIP_ENDPOINT, 0,
2056 (__u16) USBVISION_PCM_THR1, value, 6, HZ);
2058 if (rc < 0) {
2059 printk(KERN_ERR "%sERROR=%d. USBVISION stopped - "
2060 "reconnect or reload driver.\n", proc, rc);
2061 return rc;
2065 return rc;
2070 * usbvision_set_input()
2072 * Set the input (saa711x, ...) size x y and other misc input params
2073 * I've no idea if this parameters are right
2076 int usbvision_set_input(struct usb_usbvision *usbvision)
2078 static const char proc[] = "usbvision_set_input: ";
2079 int rc;
2080 unsigned char value[8];
2081 unsigned char dvi_yuv_value;
2083 if (!USBVISION_IS_OPERATIONAL(usbvision))
2084 return 0;
2086 /* Set input format expected from decoder*/
2087 if (usbvision_device_data[usbvision->DevModel].Vin_Reg1_override) {
2088 value[0] = usbvision_device_data[usbvision->DevModel].Vin_Reg1;
2089 } else if(usbvision_device_data[usbvision->DevModel].Codec == CODEC_SAA7113) {
2090 /* SAA7113 uses 8 bit output */
2091 value[0] = USBVISION_8_422_SYNC;
2092 } else {
2093 /* I'm sure only about d2-d0 [010] 16 bit 4:2:2 usin sync pulses
2094 * as that is how saa7111 is configured */
2095 value[0] = USBVISION_16_422_SYNC;
2096 /* | USBVISION_VSNC_POL | USBVISION_VCLK_POL);*/
2099 rc = usbvision_write_reg(usbvision, USBVISION_VIN_REG1, value[0]);
2100 if (rc < 0) {
2101 printk(KERN_ERR "%sERROR=%d. USBVISION stopped - "
2102 "reconnect or reload driver.\n", proc, rc);
2103 return rc;
2107 if (usbvision->tvnormId & V4L2_STD_PAL) {
2108 value[0] = 0xC0;
2109 value[1] = 0x02; //0x02C0 -> 704 Input video line length
2110 value[2] = 0x20;
2111 value[3] = 0x01; //0x0120 -> 288 Input video n. of lines
2112 value[4] = 0x60;
2113 value[5] = 0x00; //0x0060 -> 96 Input video h offset
2114 value[6] = 0x16;
2115 value[7] = 0x00; //0x0016 -> 22 Input video v offset
2116 } else if (usbvision->tvnormId & V4L2_STD_SECAM) {
2117 value[0] = 0xC0;
2118 value[1] = 0x02; //0x02C0 -> 704 Input video line length
2119 value[2] = 0x20;
2120 value[3] = 0x01; //0x0120 -> 288 Input video n. of lines
2121 value[4] = 0x01;
2122 value[5] = 0x00; //0x0001 -> 01 Input video h offset
2123 value[6] = 0x01;
2124 value[7] = 0x00; //0x0001 -> 01 Input video v offset
2125 } else { /* V4L2_STD_NTSC */
2126 value[0] = 0xD0;
2127 value[1] = 0x02; //0x02D0 -> 720 Input video line length
2128 value[2] = 0xF0;
2129 value[3] = 0x00; //0x00F0 -> 240 Input video number of lines
2130 value[4] = 0x50;
2131 value[5] = 0x00; //0x0050 -> 80 Input video h offset
2132 value[6] = 0x10;
2133 value[7] = 0x00; //0x0010 -> 16 Input video v offset
2136 if (usbvision_device_data[usbvision->DevModel].X_Offset >= 0) {
2137 value[4]=usbvision_device_data[usbvision->DevModel].X_Offset & 0xff;
2138 value[5]=(usbvision_device_data[usbvision->DevModel].X_Offset & 0x0300) >> 8;
2141 if (adjust_X_Offset != -1) {
2142 value[4] = adjust_X_Offset & 0xff;
2143 value[5] = (adjust_X_Offset & 0x0300) >> 8;
2146 if (usbvision_device_data[usbvision->DevModel].Y_Offset >= 0) {
2147 value[6]=usbvision_device_data[usbvision->DevModel].Y_Offset & 0xff;
2148 value[7]=(usbvision_device_data[usbvision->DevModel].Y_Offset & 0x0300) >> 8;
2151 if (adjust_Y_Offset != -1) {
2152 value[6] = adjust_Y_Offset & 0xff;
2153 value[7] = (adjust_Y_Offset & 0x0300) >> 8;
2156 rc = usb_control_msg(usbvision->dev, usb_sndctrlpipe(usbvision->dev, 1),
2157 USBVISION_OP_CODE, /* USBVISION specific code */
2158 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT, 0,
2159 (__u16) USBVISION_LXSIZE_I, value, 8, HZ);
2160 if (rc < 0) {
2161 printk(KERN_ERR "%sERROR=%d. USBVISION stopped - "
2162 "reconnect or reload driver.\n", proc, rc);
2163 return rc;
2167 dvi_yuv_value = 0x00; /* U comes after V, Ya comes after U/V, Yb comes after Yb */
2169 if(usbvision_device_data[usbvision->DevModel].Dvi_yuv_override){
2170 dvi_yuv_value = usbvision_device_data[usbvision->DevModel].Dvi_yuv;
2172 else if(usbvision_device_data[usbvision->DevModel].Codec == CODEC_SAA7113) {
2173 /* This changes as the fine sync control changes. Further investigation necessary */
2174 dvi_yuv_value = 0x06;
2177 return (usbvision_write_reg(usbvision, USBVISION_DVI_YUV, dvi_yuv_value));
2182 * usbvision_set_dram_settings()
2184 * Set the buffer address needed by the usbvision dram to operate
2185 * This values has been taken with usbsnoop.
2189 static int usbvision_set_dram_settings(struct usb_usbvision *usbvision)
2191 int rc;
2192 unsigned char value[8];
2194 if (usbvision->isocMode == ISOC_MODE_COMPRESS) {
2195 value[0] = 0x42;
2196 value[1] = 0x71;
2197 value[2] = 0xff;
2198 value[3] = 0x00;
2199 value[4] = 0x98;
2200 value[5] = 0xe0;
2201 value[6] = 0x71;
2202 value[7] = 0xff;
2203 // UR: 0x0E200-0x3FFFF = 204288 Words (1 Word = 2 Byte)
2204 // FDL: 0x00000-0x0E099 = 57498 Words
2205 // VDW: 0x0E3FF-0x3FFFF
2207 else {
2208 value[0] = 0x42;
2209 value[1] = 0x00;
2210 value[2] = 0xff;
2211 value[3] = 0x00;
2212 value[4] = 0x00;
2213 value[5] = 0x00;
2214 value[6] = 0x00;
2215 value[7] = 0xff;
2217 /* These are the values of the address of the video buffer,
2218 * they have to be loaded into the USBVISION_DRM_PRM1-8
2220 * Start address of video output buffer for read: drm_prm1-2 -> 0x00000
2221 * End address of video output buffer for read: drm_prm1-3 -> 0x1ffff
2222 * Start address of video frame delay buffer: drm_prm1-4 -> 0x20000
2223 * Only used in compressed mode
2224 * End address of video frame delay buffer: drm_prm1-5-6 -> 0x3ffff
2225 * Only used in compressed mode
2226 * Start address of video output buffer for write: drm_prm1-7 -> 0x00000
2227 * End address of video output buffer for write: drm_prm1-8 -> 0x1ffff
2230 if (!USBVISION_IS_OPERATIONAL(usbvision))
2231 return 0;
2233 rc = usb_control_msg(usbvision->dev, usb_sndctrlpipe(usbvision->dev, 1),
2234 USBVISION_OP_CODE, /* USBVISION specific code */
2235 USB_DIR_OUT | USB_TYPE_VENDOR |
2236 USB_RECIP_ENDPOINT, 0,
2237 (__u16) USBVISION_DRM_PRM1, value, 8, HZ);
2239 if (rc < 0) {
2240 err("%sERROR=%d", __FUNCTION__, rc);
2241 return rc;
2244 /* Restart the video buffer logic */
2245 if ((rc = usbvision_write_reg(usbvision, USBVISION_DRM_CONT, USBVISION_RES_UR |
2246 USBVISION_RES_FDL | USBVISION_RES_VDW)) < 0)
2247 return rc;
2248 rc = usbvision_write_reg(usbvision, USBVISION_DRM_CONT, 0x00);
2250 return rc;
2254 * ()
2256 * Power on the device, enables suspend-resume logic
2257 * & reset the isoc End-Point
2261 int usbvision_power_on(struct usb_usbvision *usbvision)
2263 int errCode = 0;
2265 PDEBUG(DBG_FUNC, "");
2267 usbvision_write_reg(usbvision, USBVISION_PWR_REG, USBVISION_SSPND_EN);
2268 usbvision_write_reg(usbvision, USBVISION_PWR_REG,
2269 USBVISION_SSPND_EN | USBVISION_RES2);
2271 usbvision_write_reg(usbvision, USBVISION_PWR_REG,
2272 USBVISION_SSPND_EN | USBVISION_PWR_VID);
2273 errCode = usbvision_write_reg(usbvision, USBVISION_PWR_REG,
2274 USBVISION_SSPND_EN | USBVISION_PWR_VID | USBVISION_RES2);
2275 if (errCode == 1) {
2276 usbvision->power = 1;
2278 PDEBUG(DBG_FUNC, "%s: errCode %d", (errCode<0)?"ERROR":"power is on", errCode);
2279 return errCode;
2284 * usbvision timer stuff
2287 // to call usbvision_power_off from task queue
2288 static void call_usbvision_power_off(struct work_struct *work)
2290 struct usb_usbvision *usbvision = container_of(work, struct usb_usbvision, powerOffWork);
2292 PDEBUG(DBG_FUNC, "");
2293 if(mutex_lock_interruptible(&usbvision->lock)) {
2294 return;
2298 if(usbvision->user == 0) {
2299 usbvision_i2c_unregister(usbvision);
2301 usbvision_power_off(usbvision);
2302 usbvision->initialized = 0;
2304 mutex_unlock(&usbvision->lock);
2307 static void usbvision_powerOffTimer(unsigned long data)
2309 struct usb_usbvision *usbvision = (void *) data;
2311 PDEBUG(DBG_FUNC, "");
2312 del_timer(&usbvision->powerOffTimer);
2313 INIT_WORK(&usbvision->powerOffWork, call_usbvision_power_off);
2314 (void) schedule_work(&usbvision->powerOffWork);
2318 void usbvision_init_powerOffTimer(struct usb_usbvision *usbvision)
2320 init_timer(&usbvision->powerOffTimer);
2321 usbvision->powerOffTimer.data = (long) usbvision;
2322 usbvision->powerOffTimer.function = usbvision_powerOffTimer;
2325 void usbvision_set_powerOffTimer(struct usb_usbvision *usbvision)
2327 mod_timer(&usbvision->powerOffTimer, jiffies + USBVISION_POWEROFF_TIME);
2330 void usbvision_reset_powerOffTimer(struct usb_usbvision *usbvision)
2332 if (timer_pending(&usbvision->powerOffTimer)) {
2333 del_timer(&usbvision->powerOffTimer);
2338 * usbvision_begin_streaming()
2339 * Sure you have to put bit 7 to 0, if not incoming frames are droped, but no
2340 * idea about the rest
2342 int usbvision_begin_streaming(struct usb_usbvision *usbvision)
2344 int errCode = 0;
2346 if (usbvision->isocMode == ISOC_MODE_COMPRESS) {
2347 usbvision_init_compression(usbvision);
2349 errCode = usbvision_write_reg(usbvision, USBVISION_VIN_REG2, USBVISION_NOHVALID |
2350 usbvision->Vin_Reg2_Preset);
2351 return errCode;
2355 * usbvision_restart_isoc()
2356 * Not sure yet if touching here PWR_REG make loose the config
2359 int usbvision_restart_isoc(struct usb_usbvision *usbvision)
2361 int ret;
2363 if (
2364 (ret =
2365 usbvision_write_reg(usbvision, USBVISION_PWR_REG,
2366 USBVISION_SSPND_EN | USBVISION_PWR_VID)) < 0)
2367 return ret;
2368 if (
2369 (ret =
2370 usbvision_write_reg(usbvision, USBVISION_PWR_REG,
2371 USBVISION_SSPND_EN | USBVISION_PWR_VID |
2372 USBVISION_RES2)) < 0)
2373 return ret;
2374 if (
2375 (ret =
2376 usbvision_write_reg(usbvision, USBVISION_VIN_REG2,
2377 USBVISION_KEEP_BLANK | USBVISION_NOHVALID |
2378 usbvision->Vin_Reg2_Preset)) < 0) return ret;
2380 /* TODO: schedule timeout */
2381 while ((usbvision_read_reg(usbvision, USBVISION_STATUS_REG) & 0x01) != 1);
2383 return 0;
2386 int usbvision_audio_off(struct usb_usbvision *usbvision)
2388 if (usbvision_write_reg(usbvision, USBVISION_IOPIN_REG, USBVISION_AUDIO_MUTE) < 0) {
2389 printk(KERN_ERR "usbvision_audio_off: can't wirte reg\n");
2390 return -1;
2392 usbvision->AudioMute = 0;
2393 usbvision->AudioChannel = USBVISION_AUDIO_MUTE;
2394 return 0;
2397 int usbvision_set_audio(struct usb_usbvision *usbvision, int AudioChannel)
2399 if (!usbvision->AudioMute) {
2400 if (usbvision_write_reg(usbvision, USBVISION_IOPIN_REG, AudioChannel) < 0) {
2401 printk(KERN_ERR "usbvision_set_audio: can't write iopin register for audio switching\n");
2402 return -1;
2405 usbvision->AudioChannel = AudioChannel;
2406 return 0;
2409 int usbvision_setup(struct usb_usbvision *usbvision,int format)
2411 usbvision_set_video_format(usbvision, format);
2412 usbvision_set_dram_settings(usbvision);
2413 usbvision_set_compress_params(usbvision);
2414 usbvision_set_input(usbvision);
2415 usbvision_set_output(usbvision, MAX_USB_WIDTH, MAX_USB_HEIGHT);
2416 usbvision_restart_isoc(usbvision);
2418 /* cosas del PCM */
2419 return USBVISION_IS_OPERATIONAL(usbvision);
2422 int usbvision_set_alternate(struct usb_usbvision *dev)
2424 int errCode, prev_alt = dev->ifaceAlt;
2425 int i;
2427 dev->ifaceAlt=0;
2428 for(i=0;i< dev->num_alt; i++)
2429 if(dev->alt_max_pkt_size[i]>dev->alt_max_pkt_size[dev->ifaceAlt])
2430 dev->ifaceAlt=i;
2432 if (dev->ifaceAlt != prev_alt) {
2433 dev->isocPacketSize = dev->alt_max_pkt_size[dev->ifaceAlt];
2434 PDEBUG(DBG_FUNC,"setting alternate %d with wMaxPacketSize=%u", dev->ifaceAlt,dev->isocPacketSize);
2435 errCode = usb_set_interface(dev->dev, dev->iface, dev->ifaceAlt);
2436 if (errCode < 0) {
2437 err ("cannot change alternate number to %d (error=%i)",
2438 dev->ifaceAlt, errCode);
2439 return errCode;
2443 PDEBUG(DBG_ISOC, "ISO Packet Length:%d", dev->isocPacketSize);
2445 return 0;
2449 * usbvision_init_isoc()
2452 int usbvision_init_isoc(struct usb_usbvision *usbvision)
2454 struct usb_device *dev = usbvision->dev;
2455 int bufIdx, errCode, regValue;
2456 int sb_size;
2458 if (!USBVISION_IS_OPERATIONAL(usbvision))
2459 return -EFAULT;
2461 usbvision->curFrame = NULL;
2462 scratch_reset(usbvision);
2464 /* Alternate interface 1 is is the biggest frame size */
2465 errCode = usbvision_set_alternate(usbvision);
2466 if (errCode < 0) {
2467 usbvision->last_error = errCode;
2468 return -EBUSY;
2470 sb_size = USBVISION_URB_FRAMES * usbvision->isocPacketSize;
2472 regValue = (16 - usbvision_read_reg(usbvision,
2473 USBVISION_ALTER_REG)) & 0x0F;
2475 usbvision->usb_bandwidth = regValue >> 1;
2476 PDEBUG(DBG_ISOC, "USB Bandwidth Usage: %dMbit/Sec",
2477 usbvision->usb_bandwidth);
2481 /* We double buffer the Iso lists */
2483 for (bufIdx = 0; bufIdx < USBVISION_NUMSBUF; bufIdx++) {
2484 int j, k;
2485 struct urb *urb;
2487 urb = usb_alloc_urb(USBVISION_URB_FRAMES, GFP_KERNEL);
2488 if (urb == NULL) {
2489 err("%s: usb_alloc_urb() failed", __FUNCTION__);
2490 return -ENOMEM;
2492 usbvision->sbuf[bufIdx].urb = urb;
2493 usbvision->sbuf[bufIdx].data =
2494 usb_buffer_alloc(usbvision->dev,
2495 sb_size,
2496 GFP_KERNEL,
2497 &urb->transfer_dma);
2498 urb->dev = dev;
2499 urb->context = usbvision;
2500 urb->pipe = usb_rcvisocpipe(dev, usbvision->video_endp);
2501 urb->transfer_flags = URB_ISO_ASAP;
2502 urb->interval = 1;
2503 urb->transfer_buffer = usbvision->sbuf[bufIdx].data;
2504 urb->complete = usbvision_isocIrq;
2505 urb->number_of_packets = USBVISION_URB_FRAMES;
2506 urb->transfer_buffer_length =
2507 usbvision->isocPacketSize * USBVISION_URB_FRAMES;
2508 for (j = k = 0; j < USBVISION_URB_FRAMES; j++,
2509 k += usbvision->isocPacketSize) {
2510 urb->iso_frame_desc[j].offset = k;
2511 urb->iso_frame_desc[j].length =
2512 usbvision->isocPacketSize;
2517 /* Submit all URBs */
2518 for (bufIdx = 0; bufIdx < USBVISION_NUMSBUF; bufIdx++) {
2519 errCode = usb_submit_urb(usbvision->sbuf[bufIdx].urb,
2520 GFP_KERNEL);
2521 if (errCode) {
2522 err("%s: usb_submit_urb(%d) failed: error %d",
2523 __FUNCTION__, bufIdx, errCode);
2527 usbvision->streaming = Stream_Idle;
2528 PDEBUG(DBG_ISOC, "%s: streaming=1 usbvision->video_endp=$%02x",
2529 __FUNCTION__,
2530 usbvision->video_endp);
2531 return 0;
2535 * usbvision_stop_isoc()
2537 * This procedure stops streaming and deallocates URBs. Then it
2538 * activates zero-bandwidth alt. setting of the video interface.
2541 void usbvision_stop_isoc(struct usb_usbvision *usbvision)
2543 int bufIdx, errCode, regValue;
2544 int sb_size = USBVISION_URB_FRAMES * usbvision->isocPacketSize;
2546 if ((usbvision->streaming == Stream_Off) || (usbvision->dev == NULL))
2547 return;
2549 /* Unschedule all of the iso td's */
2550 for (bufIdx = 0; bufIdx < USBVISION_NUMSBUF; bufIdx++) {
2551 usb_kill_urb(usbvision->sbuf[bufIdx].urb);
2552 if (usbvision->sbuf[bufIdx].data){
2553 usb_buffer_free(usbvision->dev,
2554 sb_size,
2555 usbvision->sbuf[bufIdx].data,
2556 usbvision->sbuf[bufIdx].urb->transfer_dma);
2558 usb_free_urb(usbvision->sbuf[bufIdx].urb);
2559 usbvision->sbuf[bufIdx].urb = NULL;
2563 PDEBUG(DBG_ISOC, "%s: streaming=Stream_Off\n", __FUNCTION__);
2564 usbvision->streaming = Stream_Off;
2566 if (!usbvision->remove_pending) {
2568 /* Set packet size to 0 */
2569 usbvision->ifaceAlt=0;
2570 errCode = usb_set_interface(usbvision->dev, usbvision->iface,
2571 usbvision->ifaceAlt);
2572 if (errCode < 0) {
2573 err("%s: usb_set_interface() failed: error %d",
2574 __FUNCTION__, errCode);
2575 usbvision->last_error = errCode;
2577 regValue = (16-usbvision_read_reg(usbvision, USBVISION_ALTER_REG)) & 0x0F;
2578 usbvision->isocPacketSize =
2579 (regValue == 0) ? 0 : (regValue * 64) - 1;
2580 PDEBUG(DBG_ISOC, "ISO Packet Length:%d",
2581 usbvision->isocPacketSize);
2583 usbvision->usb_bandwidth = regValue >> 1;
2584 PDEBUG(DBG_ISOC, "USB Bandwidth Usage: %dMbit/Sec",
2585 usbvision->usb_bandwidth);
2589 int usbvision_muxsel(struct usb_usbvision *usbvision, int channel)
2591 /* inputs #0 and #3 are constant for every SAA711x. */
2592 /* inputs #1 and #2 are variable for SAA7111 and SAA7113 */
2593 int mode[4]= {SAA7115_COMPOSITE0, 0, 0, SAA7115_COMPOSITE3};
2594 int audio[]= {1, 0, 0, 0};
2595 struct v4l2_routing route;
2596 //channel 0 is TV with audiochannel 1 (tuner mono)
2597 //channel 1 is Composite with audio channel 0 (line in)
2598 //channel 2 is S-Video with audio channel 0 (line in)
2599 //channel 3 is additional video inputs to the device with audio channel 0 (line in)
2601 RESTRICT_TO_RANGE(channel, 0, usbvision->video_inputs);
2602 usbvision->ctl_input = channel;
2604 // set the new channel
2605 // Regular USB TV Tuners -> channel: 0 = Television, 1 = Composite, 2 = S-Video
2606 // Four video input devices -> channel: 0 = Chan White, 1 = Chan Green, 2 = Chan Yellow, 3 = Chan Red
2608 switch (usbvision_device_data[usbvision->DevModel].Codec) {
2609 case CODEC_SAA7113:
2610 mode[1] = SAA7115_COMPOSITE2;
2611 if (SwitchSVideoInput) {
2612 /* To handle problems with S-Video Input for
2613 * some devices. Use SwitchSVideoInput
2614 * parameter when loading the module.*/
2615 mode[2] = SAA7115_COMPOSITE1;
2617 else {
2618 mode[2] = SAA7115_SVIDEO1;
2620 break;
2621 case CODEC_SAA7111:
2622 default:
2623 /* modes for saa7111 */
2624 mode[1] = SAA7115_COMPOSITE1;
2625 mode[2] = SAA7115_SVIDEO1;
2626 break;
2628 route.input = mode[channel];
2629 route.output = 0;
2630 call_i2c_clients(usbvision, VIDIOC_INT_S_VIDEO_ROUTING,&route);
2631 usbvision_set_audio(usbvision, audio[channel]);
2632 return 0;
2636 * Overrides for Emacs so that we follow Linus's tabbing style.
2637 * ---------------------------------------------------------------------------
2638 * Local variables:
2639 * c-basic-offset: 8
2640 * End: