drivers/media/video/usbvideo/usbvideo.c

   1 /*
   2  * This program is free software; you can redistribute it and/or modify
   3  * it under the terms of the GNU General Public License as published by
   4  * the Free Software Foundation; either version 2, or (at your option)
   5  * any later version.
   6  *
   7  * This program is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  * GNU General Public License for more details.
  11  *
  12  * You should have received a copy of the GNU General Public License
  13  * along with this program; if not, write to the Free Software
  14  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  15  */
  16
  17 #include <linux/kernel.h>
  18 #include <linux/sched.h>
  19 #include <linux/list.h>
  20 #include <linux/slab.h>
  21 #include <linux/module.h>
  22 #include <linux/mm.h>
  23 #include <linux/vmalloc.h>
  24 #include <linux/init.h>
  25 #include <linux/spinlock.h>
  26
  27 #include <asm/io.h>
  28
  29 #include "usbvideo.h"
  30
  31 #if defined(MAP_NR)
  32 #define virt_to_page(v) MAP_NR(v)       /* Kernels 2.2.x */
  33 #endif
  34
  35 static int video_nr = -1;
  36 module_param(video_nr, int, 0);
  37
  38 /*
  39  * Local prototypes.
  40  */
  41 static void usbvideo_Disconnect(struct usb_interface *intf);
  42 static void usbvideo_CameraRelease(struct uvd *uvd);
  43
  44 static int usbvideo_v4l_ioctl(struct inode *inode, struct file *file,
  45                               unsigned int cmd, unsigned long arg);
  46 static int usbvideo_v4l_mmap(struct file *file, struct vm_area_struct *vma);
  47 static int usbvideo_v4l_open(struct inode *inode, struct file *file);
  48 static ssize_t usbvideo_v4l_read(struct file *file, char __user *buf,
  49                              size_t count, loff_t *ppos);
  50 static int usbvideo_v4l_close(struct inode *inode, struct file *file);
  51
  52 static int usbvideo_StartDataPump(struct uvd *uvd);
  53 static void usbvideo_StopDataPump(struct uvd *uvd);
  54 static int usbvideo_GetFrame(struct uvd *uvd, int frameNum);
  55 static int usbvideo_NewFrame(struct uvd *uvd, int framenum);
  56 static void usbvideo_SoftwareContrastAdjustment(struct uvd *uvd,
  57                                                 struct usbvideo_frame *frame);
  58
  59 /*******************************/
  60 /* Memory management functions */
  61 /*******************************/
  62 static void *usbvideo_rvmalloc(unsigned long size)
  63 {
  64         void *mem;
  65         unsigned long adr;
  66
  67         size = PAGE_ALIGN(size);
  68         mem = vmalloc_32(size);
  69         if (!mem)
  70                 return NULL;
  71
  72         memset(mem, 0, size); /* Clear the ram out, no junk to the user */
  73         adr = (unsigned long) mem;
  74         while (size > 0) {
  75                 SetPageReserved(vmalloc_to_page((void *)adr));
  76                 adr += PAGE_SIZE;
  77                 size -= PAGE_SIZE;
  78         }
  79
  80         return mem;
  81 }
  82
  83 static void usbvideo_rvfree(void *mem, unsigned long size)
  84 {
  85         unsigned long adr;
  86
  87         if (!mem)
  88                 return;
  89
  90         adr = (unsigned long) mem;
  91         while ((long) size > 0) {
  92                 ClearPageReserved(vmalloc_to_page((void *)adr));
  93                 adr += PAGE_SIZE;
  94                 size -= PAGE_SIZE;
  95         }
  96         vfree(mem);
  97 }
  98
  99 static void RingQueue_Initialize(struct RingQueue *rq)
 100 {
 101         assert(rq != NULL);
 102         init_waitqueue_head(&rq->wqh);
 103 }
 104
 105 static void RingQueue_Allocate(struct RingQueue *rq, int rqLen)
 106 {
 107         /* Make sure the requested size is a power of 2 and
 108            round up if necessary. This allows index wrapping
 109            using masks rather than modulo */
 110
 111         int i = 1;
 112         assert(rq != NULL);
 113         assert(rqLen > 0);
 114
 115         while(rqLen >> i)
 116                 i++;
 117         if(rqLen != 1 << (i-1))
 118                 rqLen = 1 << i;
 119
 120         rq->length = rqLen;
 121         rq->ri = rq->wi = 0;
 122         rq->queue = usbvideo_rvmalloc(rq->length);
 123         assert(rq->queue != NULL);
 124 }
 125
 126 static int RingQueue_IsAllocated(const struct RingQueue *rq)
 127 {
 128         if (rq == NULL)
 129                 return 0;
 130         return (rq->queue != NULL) && (rq->length > 0);
 131 }
 132
 133 static void RingQueue_Free(struct RingQueue *rq)
 134 {
 135         assert(rq != NULL);
 136         if (RingQueue_IsAllocated(rq)) {
 137                 usbvideo_rvfree(rq->queue, rq->length);
 138                 rq->queue = NULL;
 139                 rq->length = 0;
 140         }
 141 }
 142
 143 int RingQueue_Dequeue(struct RingQueue *rq, unsigned char *dst, int len)
 144 {
 145         int rql, toread;
 146
 147         assert(rq != NULL);
 148         assert(dst != NULL);
 149
 150         rql = RingQueue_GetLength(rq);
 151         if(!rql)
 152                 return 0;
 153
 154         /* Clip requested length to available data */
 155         if(len > rql)
 156                 len = rql;
 157
 158         toread = len;
 159         if(rq->ri > rq->wi) {
 160                 /* Read data from tail */
 161                 int read = (toread < (rq->length - rq->ri)) ? toread : rq->length - rq->ri;
 162                 memcpy(dst, rq->queue + rq->ri, read);
 163                 toread -= read;
 164                 dst += read;
 165                 rq->ri = (rq->ri + read) & (rq->length-1);
 166         }
 167         if(toread) {
 168                 /* Read data from head */
 169                 memcpy(dst, rq->queue + rq->ri, toread);
 170                 rq->ri = (rq->ri + toread) & (rq->length-1);
 171         }
 172         return len;
 173 }
 174
 175 EXPORT_SYMBOL(RingQueue_Dequeue);
 176
 177 int RingQueue_Enqueue(struct RingQueue *rq, const unsigned char *cdata, int n)
 178 {
 179         int enqueued = 0;
 180
 181         assert(rq != NULL);
 182         assert(cdata != NULL);
 183         assert(rq->length > 0);
 184         while (n > 0) {
 185                 int m, q_avail;
 186
 187                 /* Calculate the largest chunk that fits the tail of the ring */
 188                 q_avail = rq->length - rq->wi;
 189                 if (q_avail <= 0) {
 190                         rq->wi = 0;
 191                         q_avail = rq->length;
 192                 }
 193                 m = n;
 194                 assert(q_avail > 0);
 195                 if (m > q_avail)
 196                         m = q_avail;
 197
 198                 memcpy(rq->queue + rq->wi, cdata, m);
 199                 RING_QUEUE_ADVANCE_INDEX(rq, wi, m);
 200                 cdata += m;
 201                 enqueued += m;
 202                 n -= m;
 203         }
 204         return enqueued;
 205 }
 206
 207 EXPORT_SYMBOL(RingQueue_Enqueue);
 208
 209 static void RingQueue_InterruptibleSleepOn(struct RingQueue *rq)
 210 {
 211         assert(rq != NULL);
 212         interruptible_sleep_on(&rq->wqh);
 213 }
 214
 215 void RingQueue_WakeUpInterruptible(struct RingQueue *rq)
 216 {
 217         assert(rq != NULL);
 218         if (waitqueue_active(&rq->wqh))
 219                 wake_up_interruptible(&rq->wqh);
 220 }
 221
 222 EXPORT_SYMBOL(RingQueue_WakeUpInterruptible);
 223
 224 void RingQueue_Flush(struct RingQueue *rq)
 225 {
 226         assert(rq != NULL);
 227         rq->ri = 0;
 228         rq->wi = 0;
 229 }
 230
 231 EXPORT_SYMBOL(RingQueue_Flush);
 232
 233
 234 /*
 235  * usbvideo_VideosizeToString()
 236  *
 237  * This procedure converts given videosize value to readable string.
 238  *
 239  * History:
 240  * 07-Aug-2000 Created.
 241  * 19-Oct-2000 Reworked for usbvideo module.
 242  */
 243 static void usbvideo_VideosizeToString(char *buf, int bufLen, videosize_t vs)
 244 {
 245         char tmp[40];
 246         int n;
 247
 248         n = 1 + sprintf(tmp, "%ldx%ld", VIDEOSIZE_X(vs), VIDEOSIZE_Y(vs));
 249         assert(n < sizeof(tmp));
 250         if ((buf == NULL) || (bufLen < n))
 251                 err("usbvideo_VideosizeToString: buffer is too small.");
 252         else
 253                 memmove(buf, tmp, n);
 254 }
 255
 256 /*
 257  * usbvideo_OverlayChar()
 258  *
 259  * History:
 260  * 01-Feb-2000 Created.
 261  */
 262 static void usbvideo_OverlayChar(struct uvd *uvd, struct usbvideo_frame *frame,
 263                                  int x, int y, int ch)
 264 {
 265         static const unsigned short digits[16] = {
 266                 0xF6DE, /* 0 */
 267                 0x2492, /* 1 */
 268                 0xE7CE, /* 2 */
 269                 0xE79E, /* 3 */
 270                 0xB792, /* 4 */
 271                 0xF39E, /* 5 */
 272                 0xF3DE, /* 6 */
 273                 0xF492, /* 7 */
 274                 0xF7DE, /* 8 */
 275                 0xF79E, /* 9 */
 276                 0x77DA, /* a */
 277                 0xD75C, /* b */
 278                 0xF24E, /* c */
 279                 0xD6DC, /* d */
 280                 0xF34E, /* e */
 281                 0xF348  /* f */
 282         };
 283         unsigned short digit;
 284         int ix, iy;
 285
 286         if ((uvd == NULL) || (frame == NULL))
 287                 return;
 288
 289         if (ch >= '0' && ch <= '9')
 290                 ch -= '0';
 291         else if (ch >= 'A' && ch <= 'F')
 292                 ch = 10 + (ch - 'A');
 293         else if (ch >= 'a' && ch <= 'f')
 294                 ch = 10 + (ch - 'a');
 295         else
 296                 return;
 297         digit = digits[ch];
 298
 299         for (iy=0; iy < 5; iy++) {
 300                 for (ix=0; ix < 3; ix++) {
 301                         if (digit & 0x8000) {
 302                                 if (uvd->paletteBits & (1L << VIDEO_PALETTE_RGB24)) {
 303 /* TODO */                              RGB24_PUTPIXEL(frame, x+ix, y+iy, 0xFF, 0xFF, 0xFF);
 304                                 }
 305                         }
 306                         digit = digit << 1;
 307                 }
 308         }
 309 }
 310
 311 /*
 312  * usbvideo_OverlayString()
 313  *
 314  * History:
 315  * 01-Feb-2000 Created.
 316  */
 317 static void usbvideo_OverlayString(struct uvd *uvd, struct usbvideo_frame *frame,
 318                                    int x, int y, const char *str)
 319 {
 320         while (*str) {
 321                 usbvideo_OverlayChar(uvd, frame, x, y, *str);
 322                 str++;
 323                 x += 4; /* 3 pixels character + 1 space */
 324         }
 325 }
 326
 327 /*
 328  * usbvideo_OverlayStats()
 329  *
 330  * Overlays important debugging information.
 331  *
 332  * History:
 333  * 01-Feb-2000 Created.
 334  */
 335 static void usbvideo_OverlayStats(struct uvd *uvd, struct usbvideo_frame *frame)
 336 {
 337         const int y_diff = 8;
 338         char tmp[16];
 339         int x = 10, y=10;
 340         long i, j, barLength;
 341         const int qi_x1 = 60, qi_y1 = 10;
 342         const int qi_x2 = VIDEOSIZE_X(frame->request) - 10, qi_h = 10;
 343
 344         /* Call the user callback, see if we may proceed after that */
 345         if (VALID_CALLBACK(uvd, overlayHook)) {
 346                 if (GET_CALLBACK(uvd, overlayHook)(uvd, frame) < 0)
 347                         return;
 348         }
 349
 350         /*
 351          * We draw a (mostly) hollow rectangle with qi_xxx coordinates.
 352          * Left edge symbolizes the queue index 0; right edge symbolizes
 353          * the full capacity of the queue.
 354          */
 355         barLength = qi_x2 - qi_x1 - 2;
 356         if ((barLength > 10) && (uvd->paletteBits & (1L << VIDEO_PALETTE_RGB24))) {
 357 /* TODO */      long u_lo, u_hi, q_used;
 358                 long m_ri, m_wi, m_lo, m_hi;
 359
 360                 /*
 361                  * Determine fill zones (used areas of the queue):
 362                  * 0 xxxxxxx u_lo ...... uvd->dp.ri xxxxxxxx u_hi ..... uvd->dp.length
 363                  *
 364                  * if u_lo < 0 then there is no first filler.
 365                  */
 366
 367                 q_used = RingQueue_GetLength(&uvd->dp);
 368                 if ((uvd->dp.ri + q_used) >= uvd->dp.length) {
 369                         u_hi = uvd->dp.length;
 370                         u_lo = (q_used + uvd->dp.ri) & (uvd->dp.length-1);
 371                 } else {
 372                         u_hi = (q_used + uvd->dp.ri);
 373                         u_lo = -1;
 374                 }
 375
 376                 /* Convert byte indices into screen units */
 377                 m_ri = qi_x1 + ((barLength * uvd->dp.ri) / uvd->dp.length);
 378                 m_wi = qi_x1 + ((barLength * uvd->dp.wi) / uvd->dp.length);
 379                 m_lo = (u_lo > 0) ? (qi_x1 + ((barLength * u_lo) / uvd->dp.length)) : -1;
 380                 m_hi = qi_x1 + ((barLength * u_hi) / uvd->dp.length);
 381
 382                 for (j=qi_y1; j < (qi_y1 + qi_h); j++) {
 383                         for (i=qi_x1; i < qi_x2; i++) {
 384                                 /* Draw border lines */
 385                                 if ((j == qi_y1) || (j == (qi_y1 + qi_h - 1)) ||
 386                                     (i == qi_x1) || (i == (qi_x2 - 1))) {
 387                                         RGB24_PUTPIXEL(frame, i, j, 0xFF, 0xFF, 0xFF);
 388                                         continue;
 389                                 }
 390                                 /* For all other points the Y coordinate does not matter */
 391                                 if ((i >= m_ri) && (i <= (m_ri + 3))) {
 392                                         RGB24_PUTPIXEL(frame, i, j, 0x00, 0xFF, 0x00);
 393                                 } else if ((i >= m_wi) && (i <= (m_wi + 3))) {
 394                                         RGB24_PUTPIXEL(frame, i, j, 0xFF, 0x00, 0x00);
 395                                 } else if ((i < m_lo) || ((i > m_ri) && (i < m_hi)))
 396                                         RGB24_PUTPIXEL(frame, i, j, 0x00, 0x00, 0xFF);
 397                         }
 398                 }
 399         }
 400
 401         sprintf(tmp, "%8lx", uvd->stats.frame_num);
 402         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 403         y += y_diff;
 404
 405         sprintf(tmp, "%8lx", uvd->stats.urb_count);
 406         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 407         y += y_diff;
 408
 409         sprintf(tmp, "%8lx", uvd->stats.urb_length);
 410         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 411         y += y_diff;
 412
 413         sprintf(tmp, "%8lx", uvd->stats.data_count);
 414         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 415         y += y_diff;
 416
 417         sprintf(tmp, "%8lx", uvd->stats.header_count);
 418         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 419         y += y_diff;
 420
 421         sprintf(tmp, "%8lx", uvd->stats.iso_skip_count);
 422         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 423         y += y_diff;
 424
 425         sprintf(tmp, "%8lx", uvd->stats.iso_err_count);
 426         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 427         y += y_diff;
 428
 429         sprintf(tmp, "%8x", uvd->vpic.colour);
 430         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 431         y += y_diff;
 432
 433         sprintf(tmp, "%8x", uvd->vpic.hue);
 434         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 435         y += y_diff;
 436
 437         sprintf(tmp, "%8x", uvd->vpic.brightness >> 8);
 438         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 439         y += y_diff;
 440
 441         sprintf(tmp, "%8x", uvd->vpic.contrast >> 12);
 442         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 443         y += y_diff;
 444
 445         sprintf(tmp, "%8d", uvd->vpic.whiteness >> 8);
 446         usbvideo_OverlayString(uvd, frame, x, y, tmp);
 447         y += y_diff;
 448 }
 449
 450 /*
 451  * usbvideo_ReportStatistics()
 452  *
 453  * This procedure prints packet and transfer statistics.
 454  *
 455  * History:
 456  * 14-Jan-2000 Corrected default multiplier.
 457  */
 458 static void usbvideo_ReportStatistics(const struct uvd *uvd)
 459 {
 460         if ((uvd != NULL) && (uvd->stats.urb_count > 0)) {
 461                 unsigned long allPackets, badPackets, goodPackets, percent;
 462                 allPackets = uvd->stats.urb_count * CAMERA_URB_FRAMES;
 463                 badPackets = uvd->stats.iso_skip_count + uvd->stats.iso_err_count;
 464                 goodPackets = allPackets - badPackets;
 465                 /* Calculate percentage wisely, remember integer limits */
 466                 assert(allPackets != 0);
 467                 if (goodPackets < (((unsigned long)-1)/100))
 468                         percent = (100 * goodPackets) / allPackets;
 469                 else
 470                         percent = goodPackets / (allPackets / 100);
 471                 info("Packet Statistics: Total=%lu. Empty=%lu. Usage=%lu%%",
 472                      allPackets, badPackets, percent);
 473                 if (uvd->iso_packet_len > 0) {
 474                         unsigned long allBytes, xferBytes;
 475                         char multiplier = ' ';
 476                         allBytes = allPackets * uvd->iso_packet_len;
 477                         xferBytes = uvd->stats.data_count;
 478                         assert(allBytes != 0);
 479                         if (xferBytes < (((unsigned long)-1)/100))
 480                                 percent = (100 * xferBytes) / allBytes;
 481                         else
 482                                 percent = xferBytes / (allBytes / 100);
 483                         /* Scale xferBytes for easy reading */
 484                         if (xferBytes > 10*1024) {
 485                                 xferBytes /= 1024;
 486                                 multiplier = 'K';
 487                                 if (xferBytes > 10*1024) {
 488                                         xferBytes /= 1024;
 489                                         multiplier = 'M';
 490                                         if (xferBytes > 10*1024) {
 491                                                 xferBytes /= 1024;
 492                                                 multiplier = 'G';
 493                                                 if (xferBytes > 10*1024) {
 494                                                         xferBytes /= 1024;
 495                                                         multiplier = 'T';
 496                                                 }
 497                                         }
 498                                 }
 499                         }
 500                         info("Transfer Statistics: Transferred=%lu%cB Usage=%lu%%",
 501                              xferBytes, multiplier, percent);
 502                 }
 503         }
 504 }
 505
 506 /*
 507  * usbvideo_TestPattern()
 508  *
 509  * Procedure forms a test pattern (yellow grid on blue background).
 510  *
 511  * Parameters:
 512  * fullframe: if TRUE then entire frame is filled, otherwise the procedure
 513  *            continues from the current scanline.
 514  * pmode      0: fill the frame with solid blue color (like on VCR or TV)
 515  *            1: Draw a colored grid
 516  *
 517  * History:
 518  * 01-Feb-2000 Created.
 519  */
 520 void usbvideo_TestPattern(struct uvd *uvd, int fullframe, int pmode)
 521 {
 522         struct usbvideo_frame *frame;
 523         int num_cell = 0;
 524         int scan_length = 0;
 525         static int num_pass;
 526
 527         if (uvd == NULL) {
 528                 err("%s: uvd == NULL", __func__);
 529                 return;
 530         }
 531         if ((uvd->curframe < 0) || (uvd->curframe >= USBVIDEO_NUMFRAMES)) {
 532                 err("%s: uvd->curframe=%d.", __func__, uvd->curframe);
 533                 return;
 534         }
 535
 536         /* Grab the current frame */
 537         frame = &uvd->frame[uvd->curframe];
 538
 539         /* Optionally start at the beginning */
 540         if (fullframe) {
 541                 frame->curline = 0;
 542                 frame->seqRead_Length = 0;
 543         }
 544 #if 0
 545         {       /* For debugging purposes only */
 546                 char tmp[20];
 547                 usbvideo_VideosizeToString(tmp, sizeof(tmp), frame->request);
 548                 info("testpattern: frame=%s", tmp);
 549         }
 550 #endif
 551         /* Form every scan line */
 552         for (; frame->curline < VIDEOSIZE_Y(frame->request); frame->curline++) {
 553                 int i;
 554                 unsigned char *f = frame->data +
 555                         (VIDEOSIZE_X(frame->request) * V4L_BYTES_PER_PIXEL * frame->curline);
 556                 for (i=0; i < VIDEOSIZE_X(frame->request); i++) {
 557                         unsigned char cb=0x80;
 558                         unsigned char cg = 0;
 559                         unsigned char cr = 0;
 560
 561                         if (pmode == 1) {
 562                                 if (frame->curline % 32 == 0)
 563                                         cb = 0, cg = cr = 0xFF;
 564                                 else if (i % 32 == 0) {
 565                                         if (frame->curline % 32 == 1)
 566                                                 num_cell++;
 567                                         cb = 0, cg = cr = 0xFF;
 568                                 } else {
 569                                         cb = ((num_cell*7) + num_pass) & 0xFF;
 570                                         cg = ((num_cell*5) + num_pass*2) & 0xFF;
 571                                         cr = ((num_cell*3) + num_pass*3) & 0xFF;
 572                                 }
 573                         } else {
 574                                 /* Just the blue screen */
 575                         }
 576
 577                         *f++ = cb;
 578                         *f++ = cg;
 579                         *f++ = cr;
 580                         scan_length += 3;
 581                 }
 582         }
 583
 584         frame->frameState = FrameState_Done;
 585         frame->seqRead_Length += scan_length;
 586         ++num_pass;
 587
 588         /* We do this unconditionally, regardless of FLAGS_OVERLAY_STATS */
 589         usbvideo_OverlayStats(uvd, frame);
 590 }
 591
 592 EXPORT_SYMBOL(usbvideo_TestPattern);
 593
 594
 595 #ifdef DEBUG
 596 /*
 597  * usbvideo_HexDump()
 598  *
 599  * A debugging tool. Prints hex dumps.
 600  *
 601  * History:
 602  * 29-Jul-2000 Added printing of offsets.
 603  */
 604 void usbvideo_HexDump(const unsigned char *data, int len)
 605 {
 606         const int bytes_per_line = 32;
 607         char tmp[128]; /* 32*3 + 5 */
 608         int i, k;
 609
 610         for (i=k=0; len > 0; i++, len--) {
 611                 if (i > 0 && ((i % bytes_per_line) == 0)) {
 612                         printk("%s\n", tmp);
 613                         k=0;
 614                 }
 615                 if ((i % bytes_per_line) == 0)
 616                         k += sprintf(&tmp[k], "%04x: ", i);
 617                 k += sprintf(&tmp[k], "%02x ", data[i]);
 618         }
 619         if (k > 0)
 620                 printk("%s\n", tmp);
 621 }
 622
 623 EXPORT_SYMBOL(usbvideo_HexDump);
 624
 625 #endif
 626
 627 /* ******************************************************************** */
 628
 629 /* XXX: this piece of crap really wants some error handling.. */
 630 static int usbvideo_ClientIncModCount(struct uvd *uvd)
 631 {
 632         if (uvd == NULL) {
 633                 err("%s: uvd == NULL", __func__);
 634                 return -EINVAL;
 635         }
 636         if (uvd->handle == NULL) {
 637                 err("%s: uvd->handle == NULL", __func__);
 638                 return -EINVAL;
 639         }
 640         if (!try_module_get(uvd->handle->md_module)) {
 641                 err("%s: try_module_get() == 0", __func__);
 642                 return -ENODEV;
 643         }
 644         return 0;
 645 }
 646
 647 static void usbvideo_ClientDecModCount(struct uvd *uvd)
 648 {
 649         if (uvd == NULL) {
 650                 err("%s: uvd == NULL", __func__);
 651                 return;
 652         }
 653         if (uvd->handle == NULL) {
 654                 err("%s: uvd->handle == NULL", __func__);
 655                 return;
 656         }
 657         if (uvd->handle->md_module == NULL) {
 658                 err("%s: uvd->handle->md_module == NULL", __func__);
 659                 return;
 660         }
 661         module_put(uvd->handle->md_module);
 662 }
 663
 664 int usbvideo_register(
 665         struct usbvideo **pCams,
 666         const int num_cams,
 667         const int num_extra,
 668         const char *driverName,
 669         const struct usbvideo_cb *cbTbl,
 670         struct module *md,
 671         const struct usb_device_id *id_table)
 672 {
 673         struct usbvideo *cams;
 674         int i, base_size, result;
 675
 676         /* Check parameters for sanity */
 677         if ((num_cams <= 0) || (pCams == NULL) || (cbTbl == NULL)) {
 678                 err("%s: Illegal call", __func__);
 679                 return -EINVAL;
 680         }
 681
 682         /* Check registration callback - must be set! */
 683         if (cbTbl->probe == NULL) {
 684                 err("%s: probe() is required!", __func__);
 685                 return -EINVAL;
 686         }
 687
 688         base_size = num_cams * sizeof(struct uvd) + sizeof(struct usbvideo);
 689         cams = kzalloc(base_size, GFP_KERNEL);
 690         if (cams == NULL) {
 691                 err("Failed to allocate %d. bytes for usbvideo struct", base_size);
 692                 return -ENOMEM;
 693         }
 694         dbg("%s: Allocated $%p (%d. bytes) for %d. cameras",
 695             __func__, cams, base_size, num_cams);
 696
 697         /* Copy callbacks, apply defaults for those that are not set */
 698         memmove(&cams->cb, cbTbl, sizeof(cams->cb));
 699         if (cams->cb.getFrame == NULL)
 700                 cams->cb.getFrame = usbvideo_GetFrame;
 701         if (cams->cb.disconnect == NULL)
 702                 cams->cb.disconnect = usbvideo_Disconnect;
 703         if (cams->cb.startDataPump == NULL)
 704                 cams->cb.startDataPump = usbvideo_StartDataPump;
 705         if (cams->cb.stopDataPump == NULL)
 706                 cams->cb.stopDataPump = usbvideo_StopDataPump;
 707
 708         cams->num_cameras = num_cams;
 709         cams->cam = (struct uvd *) &cams[1];
 710         cams->md_module = md;
 711         mutex_init(&cams->lock);        /* to 1 == available */
 712
 713         for (i = 0; i < num_cams; i++) {
 714                 struct uvd *up = &cams->cam[i];
 715
 716                 up->handle = cams;
 717
 718                 /* Allocate user_data separately because of kmalloc's limits */
 719                 if (num_extra > 0) {
 720                         up->user_size = num_cams * num_extra;
 721                         up->user_data = kmalloc(up->user_size, GFP_KERNEL);
 722                         if (up->user_data == NULL) {
 723                                 err("%s: Failed to allocate user_data (%d. bytes)",
 724                                     __func__, up->user_size);
 725                                 while (i) {
 726                                         up = &cams->cam[--i];
 727                                         kfree(up->user_data);
 728                                 }
 729                                 kfree(cams);
 730                                 return -ENOMEM;
 731                         }
 732                         dbg("%s: Allocated cams[%d].user_data=$%p (%d. bytes)",
 733                              __func__, i, up->user_data, up->user_size);
 734                 }
 735         }
 736
 737         /*
 738          * Register ourselves with USB stack.
 739          */
 740         strcpy(cams->drvName, (driverName != NULL) ? driverName : "Unknown");
 741         cams->usbdrv.name = cams->drvName;
 742         cams->usbdrv.probe = cams->cb.probe;
 743         cams->usbdrv.disconnect = cams->cb.disconnect;
 744         cams->usbdrv.id_table = id_table;
 745
 746         /*
 747          * Update global handle to usbvideo. This is very important
 748          * because probe() can be called before usb_register() returns.
 749          * If the handle is not yet updated then the probe() will fail.
 750          */
 751         *pCams = cams;
 752         result = usb_register(&cams->usbdrv);
 753         if (result) {
 754                 for (i = 0; i < num_cams; i++) {
 755                         struct uvd *up = &cams->cam[i];
 756                         kfree(up->user_data);
 757                 }
 758                 kfree(cams);
 759         }
 760
 761         return result;
 762 }
 763
 764 EXPORT_SYMBOL(usbvideo_register);
 765
 766 /*
 767  * usbvideo_Deregister()
 768  *
 769  * Procedure frees all usbvideo and user data structures. Be warned that
 770  * if you had some dynamically allocated components in ->user field then
 771  * you should free them before calling here.
 772  */
 773 void usbvideo_Deregister(struct usbvideo **pCams)
 774 {
 775         struct usbvideo *cams;
 776         int i;
 777
 778         if (pCams == NULL) {
 779                 err("%s: pCams == NULL", __func__);
 780                 return;
 781         }
 782         cams = *pCams;
 783         if (cams == NULL) {
 784                 err("%s: cams == NULL", __func__);
 785                 return;
 786         }
 787
 788         dbg("%s: Deregistering %s driver.", __func__, cams->drvName);
 789         usb_deregister(&cams->usbdrv);
 790
 791         dbg("%s: Deallocating cams=$%p (%d. cameras)", __func__, cams, cams->num_cameras);
 792         for (i=0; i < cams->num_cameras; i++) {
 793                 struct uvd *up = &cams->cam[i];
 794                 int warning = 0;
 795
 796                 if (up->user_data != NULL) {
 797                         if (up->user_size <= 0)
 798                                 ++warning;
 799                 } else {
 800                         if (up->user_size > 0)
 801                                 ++warning;
 802                 }
 803                 if (warning) {
 804                         err("%s: Warning: user_data=$%p user_size=%d.",
 805                             __func__, up->user_data, up->user_size);
 806                 } else {
 807                         dbg("%s: Freeing %d. $%p->user_data=$%p",
 808                             __func__, i, up, up->user_data);
 809                         kfree(up->user_data);
 810                 }
 811         }
 812         /* Whole array was allocated in one chunk */
 813         dbg("%s: Freed %d uvd structures",
 814             __func__, cams->num_cameras);
 815         kfree(cams);
 816         *pCams = NULL;
 817 }
 818
 819 EXPORT_SYMBOL(usbvideo_Deregister);
 820
 821 /*
 822  * usbvideo_Disconnect()
 823  *
 824  * This procedure stops all driver activity. Deallocation of
 825  * the interface-private structure (pointed by 'ptr') is done now
 826  * (if we don't have any open files) or later, when those files
 827  * are closed. After that driver should be removable.
 828  *
 829  * This code handles surprise removal. The uvd->user is a counter which
 830  * increments on open() and decrements on close(). If we see here that
 831  * this counter is not 0 then we have a client who still has us opened.
 832  * We set uvd->remove_pending flag as early as possible, and after that
 833  * all access to the camera will gracefully fail. These failures should
 834  * prompt client to (eventually) close the video device, and then - in
 835  * usbvideo_v4l_close() - we decrement uvd->uvd_used and usage counter.
 836  *
 837  * History:
 838  * 22-Jan-2000 Added polling of MOD_IN_USE to delay removal until all users gone.
 839  * 27-Jan-2000 Reworked to allow pending disconnects; see xxx_close()
 840  * 24-May-2000 Corrected to prevent race condition (MOD_xxx_USE_COUNT).
 841  * 19-Oct-2000 Moved to usbvideo module.
 842  */
 843 static void usbvideo_Disconnect(struct usb_interface *intf)
 844 {
 845         struct uvd *uvd = usb_get_intfdata (intf);
 846         int i;
 847
 848         if (uvd == NULL) {
 849                 err("%s($%p): Illegal call.", __func__, intf);
 850                 return;
 851         }
 852
 853         usb_set_intfdata (intf, NULL);
 854
 855         usbvideo_ClientIncModCount(uvd);
 856         if (uvd->debug > 0)
 857                 info("%s(%p.)", __func__, intf);
 858
 859         mutex_lock(&uvd->lock);
 860         uvd->remove_pending = 1; /* Now all ISO data will be ignored */
 861
 862         /* At this time we ask to cancel outstanding URBs */
 863         GET_CALLBACK(uvd, stopDataPump)(uvd);
 864
 865         for (i=0; i < USBVIDEO_NUMSBUF; i++)
 866                 usb_free_urb(uvd->sbuf[i].urb);
 867
 868         usb_put_dev(uvd->dev);
 869         uvd->dev = NULL;            /* USB device is no more */
 870
 871         video_unregister_device(&uvd->vdev);
 872         if (uvd->debug > 0)
 873                 info("%s: Video unregistered.", __func__);
 874
 875         if (uvd->user)
 876                 info("%s: In use, disconnect pending.", __func__);
 877         else
 878                 usbvideo_CameraRelease(uvd);
 879         mutex_unlock(&uvd->lock);
 880         info("USB camera disconnected.");
 881
 882         usbvideo_ClientDecModCount(uvd);
 883 }
 884
 885 /*
 886  * usbvideo_CameraRelease()
 887  *
 888  * This code does final release of uvd. This happens
 889  * after the device is disconnected -and- all clients
 890  * closed their files.
 891  *
 892  * History:
 893  * 27-Jan-2000 Created.
 894  */
 895 static void usbvideo_CameraRelease(struct uvd *uvd)
 896 {
 897         if (uvd == NULL) {
 898                 err("%s: Illegal call", __func__);
 899                 return;
 900         }
 901
 902         RingQueue_Free(&uvd->dp);
 903         if (VALID_CALLBACK(uvd, userFree))
 904                 GET_CALLBACK(uvd, userFree)(uvd);
 905         uvd->uvd_used = 0;      /* This is atomic, no need to take mutex */
 906 }
 907
 908 /*
 909  * usbvideo_find_struct()
 910  *
 911  * This code searches the array of preallocated (static) structures
 912  * and returns index of the first one that isn't in use. Returns -1
 913  * if there are no free structures.
 914  *
 915  * History:
 916  * 27-Jan-2000 Created.
 917  */
 918 static int usbvideo_find_struct(struct usbvideo *cams)
 919 {
 920         int u, rv = -1;
 921
 922         if (cams == NULL) {
 923                 err("No usbvideo handle?");
 924                 return -1;
 925         }
 926         mutex_lock(&cams->lock);
 927         for (u = 0; u < cams->num_cameras; u++) {
 928                 struct uvd *uvd = &cams->cam[u];
 929                 if (!uvd->uvd_used) /* This one is free */
 930                 {
 931                         uvd->uvd_used = 1;      /* In use now */
 932                         mutex_init(&uvd->lock); /* to 1 == available */
 933                         uvd->dev = NULL;
 934                         rv = u;
 935                         break;
 936                 }
 937         }
 938         mutex_unlock(&cams->lock);
 939         return rv;
 940 }
 941
 942 static const struct file_operations usbvideo_fops = {
 943         .owner =  THIS_MODULE,
 944         .open =   usbvideo_v4l_open,
 945         .release =usbvideo_v4l_close,
 946         .read =   usbvideo_v4l_read,
 947         .mmap =   usbvideo_v4l_mmap,
 948         .ioctl =  usbvideo_v4l_ioctl,
 949 #ifdef CONFIG_COMPAT
 950         .compat_ioctl = v4l_compat_ioctl32,
 951 #endif
 952         .llseek = no_llseek,
 953 };
 954 static const struct video_device usbvideo_template = {
 955         .fops =       &usbvideo_fops,
 956 };
 957
 958 struct uvd *usbvideo_AllocateDevice(struct usbvideo *cams)
 959 {
 960         int i, devnum;
 961         struct uvd *uvd = NULL;
 962
 963         if (cams == NULL) {
 964                 err("No usbvideo handle?");
 965                 return NULL;
 966         }
 967
 968         devnum = usbvideo_find_struct(cams);
 969         if (devnum == -1) {
 970                 err("IBM USB camera driver: Too many devices!");
 971                 return NULL;
 972         }
 973         uvd = &cams->cam[devnum];
 974         dbg("Device entry #%d. at $%p", devnum, uvd);
 975
 976         /* Not relying upon caller we increase module counter ourselves */
 977         usbvideo_ClientIncModCount(uvd);
 978
 979         mutex_lock(&uvd->lock);
 980         for (i=0; i < USBVIDEO_NUMSBUF; i++) {
 981                 uvd->sbuf[i].urb = usb_alloc_urb(FRAMES_PER_DESC, GFP_KERNEL);
 982                 if (uvd->sbuf[i].urb == NULL) {
 983                         err("usb_alloc_urb(%d.) failed.", FRAMES_PER_DESC);
 984                         uvd->uvd_used = 0;
 985                         uvd = NULL;
 986                         goto allocate_done;
 987                 }
 988         }
 989         uvd->user=0;
 990         uvd->remove_pending = 0;
 991         uvd->last_error = 0;
 992         RingQueue_Initialize(&uvd->dp);
 993
 994         /* Initialize video device structure */
 995         uvd->vdev = usbvideo_template;
 996         sprintf(uvd->vdev.name, "%.20s USB Camera", cams->drvName);
 997         /*
 998          * The client is free to overwrite those because we
 999          * return control to the client's probe function right now.
1000          */
1001 allocate_done:
1002         mutex_unlock(&uvd->lock);
1003         usbvideo_ClientDecModCount(uvd);
1004         return uvd;
1005 }
1006
1007 EXPORT_SYMBOL(usbvideo_AllocateDevice);
1008
1009 int usbvideo_RegisterVideoDevice(struct uvd *uvd)
1010 {
1011         char tmp1[20], tmp2[20];        /* Buffers for printing */
1012
1013         if (uvd == NULL) {
1014                 err("%s: Illegal call.", __func__);
1015                 return -EINVAL;
1016         }
1017         if (uvd->video_endp == 0) {
1018                 info("%s: No video endpoint specified; data pump disabled.", __func__);
1019         }
1020         if (uvd->paletteBits == 0) {
1021                 err("%s: No palettes specified!", __func__);
1022                 return -EINVAL;
1023         }
1024         if (uvd->defaultPalette == 0) {
1025                 info("%s: No default palette!", __func__);
1026         }
1027
1028         uvd->max_frame_size = VIDEOSIZE_X(uvd->canvas) *
1029                 VIDEOSIZE_Y(uvd->canvas) * V4L_BYTES_PER_PIXEL;
1030         usbvideo_VideosizeToString(tmp1, sizeof(tmp1), uvd->videosize);
1031         usbvideo_VideosizeToString(tmp2, sizeof(tmp2), uvd->canvas);
1032
1033         if (uvd->debug > 0) {
1034                 info("%s: iface=%d. endpoint=$%02x paletteBits=$%08lx",
1035                      __func__, uvd->iface, uvd->video_endp, uvd->paletteBits);
1036         }
1037         if (uvd->dev == NULL) {
1038                 err("%s: uvd->dev == NULL", __func__);
1039                 return -EINVAL;
1040         }
1041         uvd->vdev.parent = &uvd->dev->dev;
1042         uvd->vdev.release = video_device_release_empty;
1043         if (video_register_device(&uvd->vdev, VFL_TYPE_GRABBER, video_nr) < 0) {
1044                 err("%s: video_register_device failed", __func__);
1045                 return -EPIPE;
1046         }
1047         if (uvd->debug > 1) {
1048                 info("%s: video_register_device() successful", __func__);
1049         }
1050
1051         info("%s on /dev/video%d: canvas=%s videosize=%s",
1052              (uvd->handle != NULL) ? uvd->handle->drvName : "???",
1053              uvd->vdev.minor, tmp2, tmp1);
1054
1055         usb_get_dev(uvd->dev);
1056         return 0;
1057 }
1058
1059 EXPORT_SYMBOL(usbvideo_RegisterVideoDevice);
1060
1061 /* ******************************************************************** */
1062
1063 static int usbvideo_v4l_mmap(struct file *file, struct vm_area_struct *vma)
1064 {
1065         struct uvd *uvd = file->private_data;
1066         unsigned long start = vma->vm_start;
1067         unsigned long size  = vma->vm_end-vma->vm_start;
1068         unsigned long page, pos;
1069
1070         if (!CAMERA_IS_OPERATIONAL(uvd))
1071                 return -EFAULT;
1072
1073         if (size > (((USBVIDEO_NUMFRAMES * uvd->max_frame_size) + PAGE_SIZE - 1) & ~(PAGE_SIZE - 1)))
1074                 return -EINVAL;
1075
1076         pos = (unsigned long) uvd->fbuf;
1077         while (size > 0) {
1078                 page = vmalloc_to_pfn((void *)pos);
1079                 if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED))
1080                         return -EAGAIN;
1081
1082                 start += PAGE_SIZE;
1083                 pos += PAGE_SIZE;
1084                 if (size > PAGE_SIZE)
1085                         size -= PAGE_SIZE;
1086                 else
1087                         size = 0;
1088         }
1089
1090         return 0;
1091 }
1092
1093 /*
1094  * usbvideo_v4l_open()
1095  *
1096  * This is part of Video 4 Linux API. The driver can be opened by one
1097  * client only (checks internal counter 'uvdser'). The procedure
1098  * then allocates buffers needed for video processing.
1099  *
1100  * History:
1101  * 22-Jan-2000 Rewrote, moved scratch buffer allocation here. Now the
1102  *             camera is also initialized here (once per connect), at
1103  *             expense of V4L client (it waits on open() call).
1104  * 27-Jan-2000 Used USBVIDEO_NUMSBUF as number of URB buffers.
1105  * 24-May-2000 Corrected to prevent race condition (MOD_xxx_USE_COUNT).
1106  */
1107 static int usbvideo_v4l_open(struct inode *inode, struct file *file)
1108 {
1109         struct video_device *dev = video_devdata(file);
1110         struct uvd *uvd = (struct uvd *) dev;
1111         const int sb_size = FRAMES_PER_DESC * uvd->iso_packet_len;
1112         int i, errCode = 0;
1113
1114         if (uvd->debug > 1)
1115                 info("%s($%p)", __func__, dev);
1116
1117         if (0 < usbvideo_ClientIncModCount(uvd))
1118                 return -ENODEV;
1119         mutex_lock(&uvd->lock);
1120
1121         if (uvd->user) {
1122                 err("%s: Someone tried to open an already opened device!", __func__);
1123                 errCode = -EBUSY;
1124         } else {
1125                 /* Clear statistics */
1126                 memset(&uvd->stats, 0, sizeof(uvd->stats));
1127
1128                 /* Clean pointers so we know if we allocated something */
1129                 for (i=0; i < USBVIDEO_NUMSBUF; i++)
1130                         uvd->sbuf[i].data = NULL;
1131
1132                 /* Allocate memory for the frame buffers */
1133                 uvd->fbuf_size = USBVIDEO_NUMFRAMES * uvd->max_frame_size;
1134                 uvd->fbuf = usbvideo_rvmalloc(uvd->fbuf_size);
1135                 RingQueue_Allocate(&uvd->dp, RING_QUEUE_SIZE);
1136                 if ((uvd->fbuf == NULL) ||
1137                     (!RingQueue_IsAllocated(&uvd->dp))) {
1138                         err("%s: Failed to allocate fbuf or dp", __func__);
1139                         errCode = -ENOMEM;
1140                 } else {
1141                         /* Allocate all buffers */
1142                         for (i=0; i < USBVIDEO_NUMFRAMES; i++) {
1143                                 uvd->frame[i].frameState = FrameState_Unused;
1144                                 uvd->frame[i].data = uvd->fbuf + i*(uvd->max_frame_size);
1145                                 /*
1146                                  * Set default sizes in case IOCTL (VIDIOCMCAPTURE)
1147                                  * is not used (using read() instead).
1148                                  */
1149                                 uvd->frame[i].canvas = uvd->canvas;
1150                                 uvd->frame[i].seqRead_Index = 0;
1151                         }
1152                         for (i=0; i < USBVIDEO_NUMSBUF; i++) {
1153                                 uvd->sbuf[i].data = kmalloc(sb_size, GFP_KERNEL);
1154                                 if (uvd->sbuf[i].data == NULL) {
1155                                         errCode = -ENOMEM;
1156                                         break;
1157                                 }
1158                         }
1159                 }
1160                 if (errCode != 0) {
1161                         /* Have to free all that memory */
1162                         if (uvd->fbuf != NULL) {
1163                                 usbvideo_rvfree(uvd->fbuf, uvd->fbuf_size);
1164                                 uvd->fbuf = NULL;
1165                         }
1166                         RingQueue_Free(&uvd->dp);
1167                         for (i=0; i < USBVIDEO_NUMSBUF; i++) {
1168                                 kfree(uvd->sbuf[i].data);
1169                                 uvd->sbuf[i].data = NULL;
1170                         }
1171                 }
1172         }
1173
1174         /* If so far no errors then we shall start the camera */
1175         if (errCode == 0) {
1176                 /* Start data pump if we have valid endpoint */
1177                 if (uvd->video_endp != 0)
1178                         errCode = GET_CALLBACK(uvd, startDataPump)(uvd);
1179                 if (errCode == 0) {
1180                         if (VALID_CALLBACK(uvd, setupOnOpen)) {
1181                                 if (uvd->debug > 1)
1182                                         info("%s: setupOnOpen callback", __func__);
1183                                 errCode = GET_CALLBACK(uvd, setupOnOpen)(uvd);
1184                                 if (errCode < 0) {
1185                                         err("%s: setupOnOpen callback failed (%d.).",
1186                                             __func__, errCode);
1187                                 } else if (uvd->debug > 1) {
1188                                         info("%s: setupOnOpen callback successful", __func__);
1189                                 }
1190                         }
1191                         if (errCode == 0) {
1192                                 uvd->settingsAdjusted = 0;
1193                                 if (uvd->debug > 1)
1194                                         info("%s: Open succeeded.", __func__);
1195                                 uvd->user++;
1196                                 file->private_data = uvd;
1197                         }
1198                 }
1199         }
1200         mutex_unlock(&uvd->lock);
1201         if (errCode != 0)
1202                 usbvideo_ClientDecModCount(uvd);
1203         if (uvd->debug > 0)
1204                 info("%s: Returning %d.", __func__, errCode);
1205         return errCode;
1206 }
1207
1208 /*
1209  * usbvideo_v4l_close()
1210  *
1211  * This is part of Video 4 Linux API. The procedure
1212  * stops streaming and deallocates all buffers that were earlier
1213  * allocated in usbvideo_v4l_open().
1214  *
1215  * History:
1216  * 22-Jan-2000 Moved scratch buffer deallocation here.
1217  * 27-Jan-2000 Used USBVIDEO_NUMSBUF as number of URB buffers.
1218  * 24-May-2000 Moved MOD_DEC_USE_COUNT outside of code that can sleep.
1219  */
1220 static int usbvideo_v4l_close(struct inode *inode, struct file *file)
1221 {
1222         struct video_device *dev = file->private_data;
1223         struct uvd *uvd = (struct uvd *) dev;
1224         int i;
1225
1226         if (uvd->debug > 1)
1227                 info("%s($%p)", __func__, dev);
1228
1229         mutex_lock(&uvd->lock);
1230         GET_CALLBACK(uvd, stopDataPump)(uvd);
1231         usbvideo_rvfree(uvd->fbuf, uvd->fbuf_size);
1232         uvd->fbuf = NULL;
1233         RingQueue_Free(&uvd->dp);
1234
1235         for (i=0; i < USBVIDEO_NUMSBUF; i++) {
1236                 kfree(uvd->sbuf[i].data);
1237                 uvd->sbuf[i].data = NULL;
1238         }
1239
1240 #if USBVIDEO_REPORT_STATS
1241         usbvideo_ReportStatistics(uvd);
1242 #endif
1243
1244         uvd->user--;
1245         if (uvd->remove_pending) {
1246                 if (uvd->debug > 0)
1247                         info("usbvideo_v4l_close: Final disconnect.");
1248                 usbvideo_CameraRelease(uvd);
1249         }
1250         mutex_unlock(&uvd->lock);
1251         usbvideo_ClientDecModCount(uvd);
1252
1253         if (uvd->debug > 1)
1254                 info("%s: Completed.", __func__);
1255         file->private_data = NULL;
1256         return 0;
1257 }
1258
1259 /*
1260  * usbvideo_v4l_ioctl()
1261  *
1262  * This is part of Video 4 Linux API. The procedure handles ioctl() calls.
1263  *
1264  * History:
1265  * 22-Jan-2000 Corrected VIDIOCSPICT to reject unsupported settings.
1266  */
1267 static int usbvideo_v4l_do_ioctl(struct inode *inode, struct file *file,
1268                                  unsigned int cmd, void *arg)
1269 {
1270         struct uvd *uvd = file->private_data;
1271
1272         if (!CAMERA_IS_OPERATIONAL(uvd))
1273                 return -EIO;
1274
1275         switch (cmd) {
1276                 case VIDIOCGCAP:
1277                 {
1278                         struct video_capability *b = arg;
1279                         *b = uvd->vcap;
1280                         return 0;
1281                 }
1282                 case VIDIOCGCHAN:
1283                 {
1284                         struct video_channel *v = arg;
1285                         *v = uvd->vchan;
1286                         return 0;
1287                 }
1288                 case VIDIOCSCHAN:
1289                 {
1290                         struct video_channel *v = arg;
1291                         if (v->channel != 0)
1292                                 return -EINVAL;
1293                         return 0;
1294                 }
1295                 case VIDIOCGPICT:
1296                 {
1297                         struct video_picture *pic = arg;
1298                         *pic = uvd->vpic;
1299                         return 0;
1300                 }
1301                 case VIDIOCSPICT:
1302                 {
1303                         struct video_picture *pic = arg;
1304                         /*
1305                          * Use temporary 'video_picture' structure to preserve our
1306                          * own settings (such as color depth, palette) that we
1307                          * aren't allowing everyone (V4L client) to change.
1308                          */
1309                         uvd->vpic.brightness = pic->brightness;
1310                         uvd->vpic.hue = pic->hue;
1311                         uvd->vpic.colour = pic->colour;
1312                         uvd->vpic.contrast = pic->contrast;
1313                         uvd->settingsAdjusted = 0;      /* Will force new settings */
1314                         return 0;
1315                 }
1316                 case VIDIOCSWIN:
1317                 {
1318                         struct video_window *vw = arg;
1319
1320                         if(VALID_CALLBACK(uvd, setVideoMode)) {
1321                                 return GET_CALLBACK(uvd, setVideoMode)(uvd, vw);
1322                         }
1323
1324                         if (vw->flags)
1325                                 return -EINVAL;
1326                         if (vw->clipcount)
1327                                 return -EINVAL;
1328                         if (vw->width != VIDEOSIZE_X(uvd->canvas))
1329                                 return -EINVAL;
1330                         if (vw->height != VIDEOSIZE_Y(uvd->canvas))
1331                                 return -EINVAL;
1332
1333                         return 0;
1334                 }
1335                 case VIDIOCGWIN:
1336                 {
1337                         struct video_window *vw = arg;
1338
1339                         vw->x = 0;
1340                         vw->y = 0;
1341                         vw->width = VIDEOSIZE_X(uvd->videosize);
1342                         vw->height = VIDEOSIZE_Y(uvd->videosize);
1343                         vw->chromakey = 0;
1344                         if (VALID_CALLBACK(uvd, getFPS))
1345                                 vw->flags = GET_CALLBACK(uvd, getFPS)(uvd);
1346                         else
1347                                 vw->flags = 10; /* FIXME: do better! */
1348                         return 0;
1349                 }
1350                 case VIDIOCGMBUF:
1351                 {
1352                         struct video_mbuf *vm = arg;
1353                         int i;
1354
1355                         memset(vm, 0, sizeof(*vm));
1356                         vm->size = uvd->max_frame_size * USBVIDEO_NUMFRAMES;
1357                         vm->frames = USBVIDEO_NUMFRAMES;
1358                         for(i = 0; i < USBVIDEO_NUMFRAMES; i++)
1359                           vm->offsets[i] = i * uvd->max_frame_size;
1360
1361                         return 0;
1362                 }
1363                 case VIDIOCMCAPTURE:
1364                 {
1365                         struct video_mmap *vm = arg;
1366
1367                         if (uvd->debug >= 1) {
1368                                 info("VIDIOCMCAPTURE: frame=%d. size=%dx%d, format=%d.",
1369                                      vm->frame, vm->width, vm->height, vm->format);
1370                         }
1371                         /*
1372                          * Check if the requested size is supported. If the requestor
1373                          * requests too big a frame then we may be tricked into accessing
1374                          * outside of own preallocated frame buffer (in uvd->frame).
1375                          * This will cause oops or a security hole. Theoretically, we
1376                          * could only clamp the size down to acceptable bounds, but then
1377                          * we'd need to figure out how to insert our smaller buffer into
1378                          * larger caller's buffer... this is not an easy question. So we
1379                          * here just flatly reject too large requests, assuming that the
1380                          * caller will resubmit with smaller size. Callers should know
1381                          * what size we support (returned by VIDIOCGCAP). However vidcat,
1382                          * for one, does not care and allows to ask for any size.
1383                          */
1384                         if ((vm->width > VIDEOSIZE_X(uvd->canvas)) ||
1385                             (vm->height > VIDEOSIZE_Y(uvd->canvas))) {
1386                                 if (uvd->debug > 0) {
1387                                         info("VIDIOCMCAPTURE: Size=%dx%d too large; "
1388                                              "allowed only up to %ldx%ld", vm->width, vm->height,
1389                                              VIDEOSIZE_X(uvd->canvas), VIDEOSIZE_Y(uvd->canvas));
1390                                 }
1391                                 return -EINVAL;
1392                         }
1393                         /* Check if the palette is supported */
1394                         if (((1L << vm->format) & uvd->paletteBits) == 0) {
1395                                 if (uvd->debug > 0) {
1396                                         info("VIDIOCMCAPTURE: format=%d. not supported"
1397                                              " (paletteBits=$%08lx)",
1398                                              vm->format, uvd->paletteBits);
1399                                 }
1400                                 return -EINVAL;
1401                         }
1402                         if ((vm->frame < 0) || (vm->frame >= USBVIDEO_NUMFRAMES)) {
1403                                 err("VIDIOCMCAPTURE: vm.frame=%d. !E [0-%d]", vm->frame, USBVIDEO_NUMFRAMES-1);
1404                                 return -EINVAL;
1405                         }
1406                         if (uvd->frame[vm->frame].frameState == FrameState_Grabbing) {
1407                                 /* Not an error - can happen */
1408                         }
1409                         uvd->frame[vm->frame].request = VIDEOSIZE(vm->width, vm->height);
1410                         uvd->frame[vm->frame].palette = vm->format;
1411
1412                         /* Mark it as ready */
1413                         uvd->frame[vm->frame].frameState = FrameState_Ready;
1414
1415                         return usbvideo_NewFrame(uvd, vm->frame);
1416                 }
1417                 case VIDIOCSYNC:
1418                 {
1419                         int *frameNum = arg;
1420                         int ret;
1421
1422                         if (*frameNum < 0 || *frameNum >= USBVIDEO_NUMFRAMES)
1423                                 return -EINVAL;
1424
1425                         if (uvd->debug >= 1)
1426                                 info("VIDIOCSYNC: syncing to frame %d.", *frameNum);
1427                         if (uvd->flags & FLAGS_NO_DECODING)
1428                                 ret = usbvideo_GetFrame(uvd, *frameNum);
1429                         else if (VALID_CALLBACK(uvd, getFrame)) {
1430                                 ret = GET_CALLBACK(uvd, getFrame)(uvd, *frameNum);
1431                                 if ((ret < 0) && (uvd->debug >= 1)) {
1432                                         err("VIDIOCSYNC: getFrame() returned %d.", ret);
1433                                 }
1434                         } else {
1435                                 err("VIDIOCSYNC: getFrame is not set");
1436                                 ret = -EFAULT;
1437                         }
1438
1439                         /*
1440                          * The frame is in FrameState_Done_Hold state. Release it
1441                          * right now because its data is already mapped into
1442                          * the user space and it's up to the application to
1443                          * make use of it until it asks for another frame.
1444                          */
1445                         uvd->frame[*frameNum].frameState = FrameState_Unused;
1446                         return ret;
1447                 }
1448                 case VIDIOCGFBUF:
1449                 {
1450                         struct video_buffer *vb = arg;
1451
1452                         memset(vb, 0, sizeof(*vb));
1453                         return 0;
1454                 }
1455                 case VIDIOCKEY:
1456                         return 0;
1457
1458                 case VIDIOCCAPTURE:
1459                         return -EINVAL;
1460
1461                 case VIDIOCSFBUF:
1462
1463                 case VIDIOCGTUNER:
1464                 case VIDIOCSTUNER:
1465
1466                 case VIDIOCGFREQ:
1467                 case VIDIOCSFREQ:
1468
1469                 case VIDIOCGAUDIO:
1470                 case VIDIOCSAUDIO:
1471                         return -EINVAL;
1472
1473                 default:
1474                         return -ENOIOCTLCMD;
1475         }
1476         return 0;
1477 }
1478
1479 static int usbvideo_v4l_ioctl(struct inode *inode, struct file *file,
1480                        unsigned int cmd, unsigned long arg)
1481 {
1482         return video_usercopy(inode, file, cmd, arg, usbvideo_v4l_do_ioctl);
1483 }
1484
1485 /*
1486  * usbvideo_v4l_read()
1487  *
1488  * This is mostly boring stuff. We simply ask for a frame and when it
1489  * arrives copy all the video data from it into user space. There is
1490  * no obvious need to override this method.
1491  *
1492  * History:
1493  * 20-Oct-2000 Created.
1494  * 01-Nov-2000 Added mutex (uvd->lock).
1495  */
1496 static ssize_t usbvideo_v4l_read(struct file *file, char __user *buf,
1497                       size_t count, loff_t *ppos)
1498 {
1499         struct uvd *uvd = file->private_data;
1500         int noblock = file->f_flags & O_NONBLOCK;
1501         int frmx = -1, i;
1502         struct usbvideo_frame *frame;
1503
1504         if (!CAMERA_IS_OPERATIONAL(uvd) || (buf == NULL))
1505                 return -EFAULT;
1506
1507         if (uvd->debug >= 1)
1508                 info("%s: %Zd. bytes, noblock=%d.", __func__, count, noblock);
1509
1510         mutex_lock(&uvd->lock);
1511
1512         /* See if a frame is completed, then use it. */
1513         for(i = 0; i < USBVIDEO_NUMFRAMES; i++) {
1514                 if ((uvd->frame[i].frameState == FrameState_Done) ||
1515                     (uvd->frame[i].frameState == FrameState_Done_Hold) ||
1516                     (uvd->frame[i].frameState == FrameState_Error)) {
1517                         frmx = i;
1518                         break;
1519                 }
1520         }
1521
1522         /* FIXME: If we don't start a frame here then who ever does? */
1523         if (noblock && (frmx == -1)) {
1524                 count = -EAGAIN;
1525                 goto read_done;
1526         }
1527
1528         /*
1529          * If no FrameState_Done, look for a FrameState_Grabbing state.
1530          * See if a frame is in process (grabbing), then use it.
1531          * We will need to wait until it becomes cooked, of course.
1532          */
1533         if (frmx == -1) {
1534                 for(i = 0; i < USBVIDEO_NUMFRAMES; i++) {
1535                         if (uvd->frame[i].frameState == FrameState_Grabbing) {
1536                                 frmx = i;
1537                                 break;
1538                         }
1539                 }
1540         }
1541
1542         /*
1543          * If no frame is active, start one. We don't care which one
1544          * it will be, so #0 is as good as any.
1545          * In read access mode we don't have convenience of VIDIOCMCAPTURE
1546          * to specify the requested palette (video format) on per-frame
1547          * basis. This means that we have to return data in -some- format
1548          * and just hope that the client knows what to do with it.
1549          * The default format is configured in uvd->defaultPalette field
1550          * as one of VIDEO_PALETTE_xxx values. We stuff it into the new
1551          * frame and initiate the frame filling process.
1552          */
1553         if (frmx == -1) {
1554                 if (uvd->defaultPalette == 0) {
1555                         err("%s: No default palette; don't know what to do!", __func__);
1556                         count = -EFAULT;
1557                         goto read_done;
1558                 }
1559                 frmx = 0;
1560                 /*
1561                  * We have no per-frame control over video size.
1562                  * Therefore we only can use whatever size was
1563                  * specified as default.
1564                  */
1565                 uvd->frame[frmx].request = uvd->videosize;
1566                 uvd->frame[frmx].palette = uvd->defaultPalette;
1567                 uvd->frame[frmx].frameState = FrameState_Ready;
1568                 usbvideo_NewFrame(uvd, frmx);
1569                 /* Now frame 0 is supposed to start filling... */
1570         }
1571
1572         /*
1573          * Get a pointer to the active frame. It is either previously
1574          * completed frame or frame in progress but not completed yet.
1575          */
1576         frame = &uvd->frame[frmx];
1577
1578         /*
1579          * Sit back & wait until the frame gets filled and postprocessed.
1580          * If we fail to get the picture [in time] then return the error.
1581          * In this call we specify that we want the frame to be waited for,
1582          * postprocessed and switched into FrameState_Done_Hold state. This
1583          * state is used to hold the frame as "fully completed" between
1584          * subsequent partial reads of the same frame.
1585          */
1586         if (frame->frameState != FrameState_Done_Hold) {
1587                 long rv = -EFAULT;
1588                 if (uvd->flags & FLAGS_NO_DECODING)
1589                         rv = usbvideo_GetFrame(uvd, frmx);
1590                 else if (VALID_CALLBACK(uvd, getFrame))
1591                         rv = GET_CALLBACK(uvd, getFrame)(uvd, frmx);
1592                 else
1593                         err("getFrame is not set");
1594                 if ((rv != 0) || (frame->frameState != FrameState_Done_Hold)) {
1595                         count = rv;
1596                         goto read_done;
1597                 }
1598         }
1599
1600         /*
1601          * Copy bytes to user space. We allow for partial reads, which
1602          * means that the user application can request read less than
1603          * the full frame size. It is up to the application to issue
1604          * subsequent calls until entire frame is read.
1605          *
1606          * First things first, make sure we don't copy more than we
1607          * have - even if the application wants more. That would be
1608          * a big security embarassment!
1609          */
1610         if ((count + frame->seqRead_Index) > frame->seqRead_Length)
1611                 count = frame->seqRead_Length - frame->seqRead_Index;
1612
1613         /*
1614          * Copy requested amount of data to user space. We start
1615          * copying from the position where we last left it, which
1616          * will be zero for a new frame (not read before).
1617          */
1618         if (copy_to_user(buf, frame->data + frame->seqRead_Index, count)) {
1619                 count = -EFAULT;
1620                 goto read_done;
1621         }
1622
1623         /* Update last read position */
1624         frame->seqRead_Index += count;
1625         if (uvd->debug >= 1) {
1626                 err("%s: {copy} count used=%Zd, new seqRead_Index=%ld",
1627                         __func__, count, frame->seqRead_Index);
1628         }
1629
1630         /* Finally check if the frame is done with and "release" it */
1631         if (frame->seqRead_Index >= frame->seqRead_Length) {
1632                 /* All data has been read */
1633                 frame->seqRead_Index = 0;
1634
1635                 /* Mark it as available to be used again. */
1636                 uvd->frame[frmx].frameState = FrameState_Unused;
1637                 if (usbvideo_NewFrame(uvd, (frmx + 1) % USBVIDEO_NUMFRAMES)) {
1638                         err("%s: usbvideo_NewFrame failed.", __func__);
1639                 }
1640         }
1641 read_done:
1642         mutex_unlock(&uvd->lock);
1643         return count;
1644 }
1645
1646 /*
1647  * Make all of the blocks of data contiguous
1648  */
1649 static int usbvideo_CompressIsochronous(struct uvd *uvd, struct urb *urb)
1650 {
1651         char *cdata;
1652         int i, totlen = 0;
1653
1654         for (i = 0; i < urb->number_of_packets; i++) {
1655                 int n = urb->iso_frame_desc[i].actual_length;
1656                 int st = urb->iso_frame_desc[i].status;
1657
1658                 cdata = urb->transfer_buffer + urb->iso_frame_desc[i].offset;
1659
1660                 /* Detect and ignore errored packets */
1661                 if (st < 0) {
1662                         if (uvd->debug >= 1)
1663                                 err("Data error: packet=%d. len=%d. status=%d.", i, n, st);
1664                         uvd->stats.iso_err_count++;
1665                         continue;
1666                 }
1667
1668                 /* Detect and ignore empty packets */
1669                 if (n <= 0) {
1670                         uvd->stats.iso_skip_count++;
1671                         continue;
1672                 }
1673                 totlen += n;    /* Little local accounting */
1674                 RingQueue_Enqueue(&uvd->dp, cdata, n);
1675         }
1676         return totlen;
1677 }
1678
1679 static void usbvideo_IsocIrq(struct urb *urb)
1680 {
1681         int i, ret, len;
1682         struct uvd *uvd = urb->context;
1683
1684         /* We don't want to do anything if we are about to be removed! */
1685         if (!CAMERA_IS_OPERATIONAL(uvd))
1686                 return;
1687 #if 0
1688         if (urb->actual_length > 0) {
1689                 info("urb=$%p status=%d. errcount=%d. length=%d.",
1690                      urb, urb->status, urb->error_count, urb->actual_length);
1691         } else {
1692                 static int c = 0;
1693                 if (c++ % 100 == 0)
1694                         info("No Isoc data");
1695         }
1696 #endif
1697
1698         if (!uvd->streaming) {
1699                 if (uvd->debug >= 1)
1700                         info("Not streaming, but interrupt!");
1701                 return;
1702         }
1703
1704         uvd->stats.urb_count++;
1705         if (urb->actual_length <= 0)
1706                 goto urb_done_with;
1707
1708         /* Copy the data received into ring queue */
1709         len = usbvideo_CompressIsochronous(uvd, urb);
1710         uvd->stats.urb_length = len;
1711         if (len <= 0)
1712                 goto urb_done_with;
1713
1714         /* Here we got some data */
1715         uvd->stats.data_count += len;
1716         RingQueue_WakeUpInterruptible(&uvd->dp);
1717
1718 urb_done_with:
1719         for (i = 0; i < FRAMES_PER_DESC; i++) {
1720                 urb->iso_frame_desc[i].status = 0;
1721                 urb->iso_frame_desc[i].actual_length = 0;
1722         }
1723         urb->status = 0;
1724         urb->dev = uvd->dev;
1725         ret = usb_submit_urb (urb, GFP_KERNEL);
1726         if(ret)
1727                 err("usb_submit_urb error (%d)", ret);
1728         return;
1729 }
1730
1731 /*
1732  * usbvideo_StartDataPump()
1733  *
1734  * History:
1735  * 27-Jan-2000 Used ibmcam->iface, ibmcam->ifaceAltActive instead
1736  *             of hardcoded values. Simplified by using for loop,
1737  *             allowed any number of URBs.
1738  */
1739 static int usbvideo_StartDataPump(struct uvd *uvd)
1740 {
1741         struct usb_device *dev = uvd->dev;
1742         int i, errFlag;
1743
1744         if (uvd->debug > 1)
1745                 info("%s($%p)", __func__, uvd);
1746
1747         if (!CAMERA_IS_OPERATIONAL(uvd)) {
1748                 err("%s: Camera is not operational", __func__);
1749                 return -EFAULT;
1750         }
1751         uvd->curframe = -1;
1752
1753         /* Alternate interface 1 is is the biggest frame size */
1754         i = usb_set_interface(dev, uvd->iface, uvd->ifaceAltActive);
1755         if (i < 0) {
1756                 err("%s: usb_set_interface error", __func__);
1757                 uvd->last_error = i;
1758                 return -EBUSY;
1759         }
1760         if (VALID_CALLBACK(uvd, videoStart))
1761                 GET_CALLBACK(uvd, videoStart)(uvd);
1762         else
1763                 err("%s: videoStart not set", __func__);
1764
1765         /* We double buffer the Iso lists */
1766         for (i=0; i < USBVIDEO_NUMSBUF; i++) {
1767                 int j, k;
1768                 struct urb *urb = uvd->sbuf[i].urb;
1769                 urb->dev = dev;
1770                 urb->context = uvd;
1771                 urb->pipe = usb_rcvisocpipe(dev, uvd->video_endp);
1772                 urb->interval = 1;
1773                 urb->transfer_flags = URB_ISO_ASAP;
1774                 urb->transfer_buffer = uvd->sbuf[i].data;
1775                 urb->complete = usbvideo_IsocIrq;
1776                 urb->number_of_packets = FRAMES_PER_DESC;
1777                 urb->transfer_buffer_length = uvd->iso_packet_len * FRAMES_PER_DESC;
1778                 for (j=k=0; j < FRAMES_PER_DESC; j++, k += uvd->iso_packet_len) {
1779                         urb->iso_frame_desc[j].offset = k;
1780                         urb->iso_frame_desc[j].length = uvd->iso_packet_len;
1781                 }
1782         }
1783
1784         /* Submit all URBs */
1785         for (i=0; i < USBVIDEO_NUMSBUF; i++) {
1786                 errFlag = usb_submit_urb(uvd->sbuf[i].urb, GFP_KERNEL);
1787                 if (errFlag)
1788                         err("%s: usb_submit_isoc(%d) ret %d", __func__, i, errFlag);
1789         }
1790
1791         uvd->streaming = 1;
1792         if (uvd->debug > 1)
1793                 info("%s: streaming=1 video_endp=$%02x", __func__, uvd->video_endp);
1794         return 0;
1795 }
1796
1797 /*
1798  * usbvideo_StopDataPump()
1799  *
1800  * This procedure stops streaming and deallocates URBs. Then it
1801  * activates zero-bandwidth alt. setting of the video interface.
1802  *
1803  * History:
1804  * 22-Jan-2000 Corrected order of actions to work after surprise removal.
1805  * 27-Jan-2000 Used uvd->iface, uvd->ifaceAltInactive instead of hardcoded values.
1806  */
1807 static void usbvideo_StopDataPump(struct uvd *uvd)
1808 {
1809         int i, j;
1810
1811         if ((uvd == NULL) || (!uvd->streaming) || (uvd->dev == NULL))
1812                 return;
1813
1814         if (uvd->debug > 1)
1815                 info("%s($%p)", __func__, uvd);
1816
1817         /* Unschedule all of the iso td's */
1818         for (i=0; i < USBVIDEO_NUMSBUF; i++) {
1819                 usb_kill_urb(uvd->sbuf[i].urb);
1820         }
1821         if (uvd->debug > 1)
1822                 info("%s: streaming=0", __func__);
1823         uvd->streaming = 0;
1824
1825         if (!uvd->remove_pending) {
1826                 /* Invoke minidriver's magic to stop the camera */
1827                 if (VALID_CALLBACK(uvd, videoStop))
1828                         GET_CALLBACK(uvd, videoStop)(uvd);
1829                 else
1830                         err("%s: videoStop not set", __func__);
1831
1832                 /* Set packet size to 0 */
1833                 j = usb_set_interface(uvd->dev, uvd->iface, uvd->ifaceAltInactive);
1834                 if (j < 0) {
1835                         err("%s: usb_set_interface() error %d.", __func__, j);
1836                         uvd->last_error = j;
1837                 }
1838         }
1839 }
1840
1841 /*
1842  * usbvideo_NewFrame()
1843  *
1844  * History:
1845  * 29-Mar-00 Added copying of previous frame into the current one.
1846  * 6-Aug-00  Added model 3 video sizes, removed redundant width, height.
1847  */
1848 static int usbvideo_NewFrame(struct uvd *uvd, int framenum)
1849 {
1850         struct usbvideo_frame *frame;
1851         int n;
1852
1853         if (uvd->debug > 1)
1854                 info("usbvideo_NewFrame($%p,%d.)", uvd, framenum);
1855
1856         /* If we're not grabbing a frame right now and the other frame is */
1857         /*  ready to be grabbed into, then use it instead */
1858         if (uvd->curframe != -1)
1859                 return 0;
1860
1861         /* If necessary we adjust picture settings between frames */
1862         if (!uvd->settingsAdjusted) {
1863                 if (VALID_CALLBACK(uvd, adjustPicture))
1864                         GET_CALLBACK(uvd, adjustPicture)(uvd);
1865                 uvd->settingsAdjusted = 1;
1866         }
1867
1868         n = (framenum + 1) % USBVIDEO_NUMFRAMES;
1869         if (uvd->frame[n].frameState == FrameState_Ready)
1870                 framenum = n;
1871
1872         frame = &uvd->frame[framenum];
1873
1874         frame->frameState = FrameState_Grabbing;
1875         frame->scanstate = ScanState_Scanning;
1876         frame->seqRead_Length = 0;      /* Accumulated in xxx_parse_data() */
1877         frame->deinterlace = Deinterlace_None;
1878         frame->flags = 0; /* No flags yet, up to minidriver (or us) to set them */
1879         uvd->curframe = framenum;
1880
1881         /*
1882          * Normally we would want to copy previous frame into the current one
1883          * before we even start filling it with data; this allows us to stop
1884          * filling at any moment; top portion of the frame will be new and
1885          * bottom portion will stay as it was in previous frame. If we don't
1886          * do that then missing chunks of video stream will result in flickering
1887          * portions of old data whatever it was before.
1888          *
1889          * If we choose not to copy previous frame (to, for example, save few
1890          * bus cycles - the frame can be pretty large!) then we have an option
1891          * to clear the frame before using. If we experience losses in this
1892          * mode then missing picture will be black (no flickering).
1893          *
1894          * Finally, if user chooses not to clean the current frame before
1895          * filling it with data then the old data will be visible if we fail
1896          * to refill entire frame with new data.
1897          */
1898         if (!(uvd->flags & FLAGS_SEPARATE_FRAMES)) {
1899                 /* This copies previous frame into this one to mask losses */
1900                 int prev = (framenum - 1 + USBVIDEO_NUMFRAMES) % USBVIDEO_NUMFRAMES;
1901                 memmove(frame->data, uvd->frame[prev].data, uvd->max_frame_size);
1902         } else {
1903                 if (uvd->flags & FLAGS_CLEAN_FRAMES) {
1904                         /* This provides a "clean" frame but slows things down */
1905                         memset(frame->data, 0, uvd->max_frame_size);
1906                 }
1907         }
1908         return 0;
1909 }
1910
1911 /*
1912  * usbvideo_CollectRawData()
1913  *
1914  * This procedure can be used instead of 'processData' callback if you
1915  * only want to dump the raw data from the camera into the output
1916  * device (frame buffer). You can look at it with V4L client, but the
1917  * image will be unwatchable. The main purpose of this code and of the
1918  * mode FLAGS_NO_DECODING is debugging and capturing of datastreams from
1919  * new, unknown cameras. This procedure will be automatically invoked
1920  * instead of the specified callback handler when uvd->flags has bit
1921  * FLAGS_NO_DECODING set. Therefore, any regular build of any driver
1922  * based on usbvideo can use this feature at any time.
1923  */
1924 static void usbvideo_CollectRawData(struct uvd *uvd, struct usbvideo_frame *frame)
1925 {
1926         int n;
1927
1928         assert(uvd != NULL);
1929         assert(frame != NULL);
1930
1931         /* Try to move data from queue into frame buffer */
1932         n = RingQueue_GetLength(&uvd->dp);
1933         if (n > 0) {
1934                 int m;
1935                 /* See how much space we have left */
1936                 m = uvd->max_frame_size - frame->seqRead_Length;
1937                 if (n > m)
1938                         n = m;
1939                 /* Now move that much data into frame buffer */
1940                 RingQueue_Dequeue(
1941                         &uvd->dp,
1942                         frame->data + frame->seqRead_Length,
1943                         m);
1944                 frame->seqRead_Length += m;
1945         }
1946         /* See if we filled the frame */
1947         if (frame->seqRead_Length >= uvd->max_frame_size) {
1948                 frame->frameState = FrameState_Done;
1949                 uvd->curframe = -1;
1950                 uvd->stats.frame_num++;
1951         }
1952 }
1953
1954 static int usbvideo_GetFrame(struct uvd *uvd, int frameNum)
1955 {
1956         struct usbvideo_frame *frame = &uvd->frame[frameNum];
1957
1958         if (uvd->debug >= 2)
1959                 info("%s($%p,%d.)", __func__, uvd, frameNum);
1960
1961         switch (frame->frameState) {
1962         case FrameState_Unused:
1963                 if (uvd->debug >= 2)
1964                         info("%s: FrameState_Unused", __func__);
1965                 return -EINVAL;
1966         case FrameState_Ready:
1967         case FrameState_Grabbing:
1968         case FrameState_Error:
1969         {
1970                 int ntries, signalPending;
1971         redo:
1972                 if (!CAMERA_IS_OPERATIONAL(uvd)) {
1973                         if (uvd->debug >= 2)
1974                                 info("%s: Camera is not operational (1)", __func__);
1975                         return -EIO;
1976                 }
1977                 ntries = 0;
1978                 do {
1979                         RingQueue_InterruptibleSleepOn(&uvd->dp);
1980                         signalPending = signal_pending(current);
1981                         if (!CAMERA_IS_OPERATIONAL(uvd)) {
1982                                 if (uvd->debug >= 2)
1983                                         info("%s: Camera is not operational (2)", __func__);
1984                                 return -EIO;
1985                         }
1986                         assert(uvd->fbuf != NULL);
1987                         if (signalPending) {
1988                                 if (uvd->debug >= 2)
1989                                         info("%s: Signal=$%08x", __func__, signalPending);
1990                                 if (uvd->flags & FLAGS_RETRY_VIDIOCSYNC) {
1991                                         usbvideo_TestPattern(uvd, 1, 0);
1992                                         uvd->curframe = -1;
1993                                         uvd->stats.frame_num++;
1994                                         if (uvd->debug >= 2)
1995                                                 info("%s: Forced test pattern screen", __func__);
1996                                         return 0;
1997                                 } else {
1998                                         /* Standard answer: Interrupted! */
1999                                         if (uvd->debug >= 2)
2000                                                 info("%s: Interrupted!", __func__);
2001                                         return -EINTR;
2002                                 }
2003                         } else {
2004                                 /* No signals - we just got new data in dp queue */
2005                                 if (uvd->flags & FLAGS_NO_DECODING)
2006                                         usbvideo_CollectRawData(uvd, frame);
2007                                 else if (VALID_CALLBACK(uvd, processData))
2008                                         GET_CALLBACK(uvd, processData)(uvd, frame);
2009                                 else
2010                                         err("%s: processData not set", __func__);
2011                         }
2012                 } while (frame->frameState == FrameState_Grabbing);
2013                 if (uvd->debug >= 2) {
2014                         info("%s: Grabbing done; state=%d. (%lu. bytes)",
2015                              __func__, frame->frameState, frame->seqRead_Length);
2016                 }
2017                 if (frame->frameState == FrameState_Error) {
2018                         int ret = usbvideo_NewFrame(uvd, frameNum);
2019                         if (ret < 0) {
2020                                 err("%s: usbvideo_NewFrame() failed (%d.)", __func__, ret);
2021                                 return ret;
2022                         }
2023                         goto redo;
2024                 }
2025                 /* Note that we fall through to meet our destiny below */
2026         }
2027         case FrameState_Done:
2028                 /*
2029                  * Do all necessary postprocessing of data prepared in
2030                  * "interrupt" code and the collecting code above. The
2031                  * frame gets marked as FrameState_Done by queue parsing code.
2032                  * This status means that we collected enough data and
2033                  * most likely processed it as we went through. However
2034                  * the data may need postprocessing, such as deinterlacing
2035                  * or picture adjustments implemented in software (horror!)
2036                  *
2037                  * As soon as the frame becomes "final" it gets promoted to
2038                  * FrameState_Done_Hold status where it will remain until the
2039                  * caller consumed all the video data from the frame. Then
2040                  * the empty shell of ex-frame is thrown out for dogs to eat.
2041                  * But we, worried about pets, will recycle the frame!
2042                  */
2043                 uvd->stats.frame_num++;
2044                 if ((uvd->flags & FLAGS_NO_DECODING) == 0) {
2045                         if (VALID_CALLBACK(uvd, postProcess))
2046                                 GET_CALLBACK(uvd, postProcess)(uvd, frame);
2047                         if (frame->flags & USBVIDEO_FRAME_FLAG_SOFTWARE_CONTRAST)
2048                                 usbvideo_SoftwareContrastAdjustment(uvd, frame);
2049                 }
2050                 frame->frameState = FrameState_Done_Hold;
2051                 if (uvd->debug >= 2)
2052                         info("%s: Entered FrameState_Done_Hold state.", __func__);
2053                 return 0;
2054
2055         case FrameState_Done_Hold:
2056                 /*
2057                  * We stay in this state indefinitely until someone external,
2058                  * like ioctl() or read() call finishes digesting the frame
2059                  * data. Then it will mark the frame as FrameState_Unused and
2060                  * it will be released back into the wild to roam freely.
2061                  */
2062                 if (uvd->debug >= 2)
2063                         info("%s: FrameState_Done_Hold state.", __func__);
2064                 return 0;
2065         }
2066
2067         /* Catch-all for other cases. We shall not be here. */
2068         err("%s: Invalid state %d.", __func__, frame->frameState);
2069         frame->frameState = FrameState_Unused;
2070         return 0;
2071 }
2072
2073 /*
2074  * usbvideo_DeinterlaceFrame()
2075  *
2076  * This procedure deinterlaces the given frame. Some cameras produce
2077  * only half of scanlines - sometimes only even lines, sometimes only
2078  * odd lines. The deinterlacing method is stored in frame->deinterlace
2079  * variable.
2080  *
2081  * Here we scan the frame vertically and replace missing scanlines with
2082  * average between surrounding ones - before and after. If we have no
2083  * line above then we just copy next line. Similarly, if we need to
2084  * create a last line then preceding line is used.
2085  */
2086 void usbvideo_DeinterlaceFrame(struct uvd *uvd, struct usbvideo_frame *frame)
2087 {
2088         if ((uvd == NULL) || (frame == NULL))
2089                 return;
2090
2091         if ((frame->deinterlace == Deinterlace_FillEvenLines) ||
2092             (frame->deinterlace == Deinterlace_FillOddLines))
2093         {
2094                 const int v4l_linesize = VIDEOSIZE_X(frame->request) * V4L_BYTES_PER_PIXEL;
2095                 int i = (frame->deinterlace == Deinterlace_FillEvenLines) ? 0 : 1;
2096
2097                 for (; i < VIDEOSIZE_Y(frame->request); i += 2) {
2098                         const unsigned char *fs1, *fs2;
2099                         unsigned char *fd;
2100                         int ip, in, j;  /* Previous and next lines */
2101
2102                         /*
2103                          * Need to average lines before and after 'i'.
2104                          * If we go out of bounds seeking those lines then
2105                          * we point back to existing line.
2106                          */
2107                         ip = i - 1;     /* First, get rough numbers */
2108                         in = i + 1;
2109
2110                         /* Now validate */
2111                         if (ip < 0)
2112                                 ip = in;
2113                         if (in >= VIDEOSIZE_Y(frame->request))
2114                                 in = ip;
2115
2116                         /* Sanity check */
2117                         if ((ip < 0) || (in < 0) ||
2118                             (ip >= VIDEOSIZE_Y(frame->request)) ||
2119                             (in >= VIDEOSIZE_Y(frame->request)))
2120                         {
2121                                 err("Error: ip=%d. in=%d. req.height=%ld.",
2122                                     ip, in, VIDEOSIZE_Y(frame->request));
2123                                 break;
2124                         }
2125
2126                         /* Now we need to average lines 'ip' and 'in' to produce line 'i' */
2127                         fs1 = frame->data + (v4l_linesize * ip);
2128                         fs2 = frame->data + (v4l_linesize * in);
2129                         fd = frame->data + (v4l_linesize * i);
2130
2131                         /* Average lines around destination */
2132                         for (j=0; j < v4l_linesize; j++) {
2133                                 fd[j] = (unsigned char)((((unsigned) fs1[j]) +
2134                                                          ((unsigned)fs2[j])) >> 1);
2135                         }
2136                 }
2137         }
2138
2139         /* Optionally display statistics on the screen */
2140         if (uvd->flags & FLAGS_OVERLAY_STATS)
2141                 usbvideo_OverlayStats(uvd, frame);
2142 }
2143
2144 EXPORT_SYMBOL(usbvideo_DeinterlaceFrame);
2145
2146 /*
2147  * usbvideo_SoftwareContrastAdjustment()
2148  *
2149  * This code adjusts the contrast of the frame, assuming RGB24 format.
2150  * As most software image processing, this job is CPU-intensive.
2151  * Get a camera that supports hardware adjustment!
2152  *
2153  * History:
2154  * 09-Feb-2001  Created.
2155  */
2156 static void usbvideo_SoftwareContrastAdjustment(struct uvd *uvd,
2157                                                 struct usbvideo_frame *frame)
2158 {
2159         int i, j, v4l_linesize;
2160         signed long adj;
2161         const int ccm = 128; /* Color correction median - see below */
2162
2163         if ((uvd == NULL) || (frame == NULL)) {
2164                 err("%s: Illegal call.", __func__);
2165                 return;
2166         }
2167         adj = (uvd->vpic.contrast - 0x8000) >> 8; /* -128..+127 = -ccm..+(ccm-1)*/
2168         RESTRICT_TO_RANGE(adj, -ccm, ccm+1);
2169         if (adj == 0) {
2170                 /* In rare case of no adjustment */
2171                 return;
2172         }
2173         v4l_linesize = VIDEOSIZE_X(frame->request) * V4L_BYTES_PER_PIXEL;
2174         for (i=0; i < VIDEOSIZE_Y(frame->request); i++) {
2175                 unsigned char *fd = frame->data + (v4l_linesize * i);
2176                 for (j=0; j < v4l_linesize; j++) {
2177                         signed long v = (signed long) fd[j];
2178                         /* Magnify up to 2 times, reduce down to zero */
2179                         v = 128 + ((ccm + adj) * (v - 128)) / ccm;
2180                         RESTRICT_TO_RANGE(v, 0, 0xFF); /* Must flatten tails */
2181                         fd[j] = (unsigned char) v;
2182                 }
2183         }
2184 }
2185
2186 MODULE_LICENSE("GPL");