Documentation/video4linux/v4l2-pci-skeleton.c

   1 /*
   2  * This is a V4L2 PCI Skeleton Driver. It gives an initial skeleton source
   3  * for use with other PCI drivers.
   4  *
   5  * This skeleton PCI driver assumes that the card has an S-Video connector as
   6  * input 0 and an HDMI connector as input 1.
   7  *
   8  * Copyright 2014 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
   9  *
  10  * This program is free software; you may redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; version 2 of the License.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  18  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  19  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #include <linux/types.h>
  25 #include <linux/kernel.h>
  26 #include <linux/module.h>
  27 #include <linux/init.h>
  28 #include <linux/kmod.h>
  29 #include <linux/mutex.h>
  30 #include <linux/pci.h>
  31 #include <linux/interrupt.h>
  32 #include <linux/videodev2.h>
  33 #include <linux/v4l2-dv-timings.h>
  34 #include <media/v4l2-device.h>
  35 #include <media/v4l2-dev.h>
  36 #include <media/v4l2-ioctl.h>
  37 #include <media/v4l2-dv-timings.h>
  38 #include <media/v4l2-ctrls.h>
  39 #include <media/v4l2-event.h>
  40 #include <media/videobuf2-dma-contig.h>
  41
  42 MODULE_DESCRIPTION("V4L2 PCI Skeleton Driver");
  43 MODULE_AUTHOR("Hans Verkuil");
  44 MODULE_LICENSE("GPL v2");
  45 MODULE_DEVICE_TABLE(pci, skeleton_pci_tbl);
  46
  47 /**
  48  * struct skeleton - All internal data for one instance of device
  49  * @pdev: PCI device
  50  * @v4l2_dev: top-level v4l2 device struct
  51  * @vdev: video node structure
  52  * @ctrl_handler: control handler structure
  53  * @lock: ioctl serialization mutex
  54  * @std: current SDTV standard
  55  * @timings: current HDTV timings
  56  * @format: current pix format
  57  * @input: current video input (0 = SDTV, 1 = HDTV)
  58  * @queue: vb2 video capture queue
  59  * @alloc_ctx: vb2 contiguous DMA context
  60  * @qlock: spinlock controlling access to buf_list and sequence
  61  * @buf_list: list of buffers queued for DMA
  62  * @sequence: frame sequence counter
  63  */
  64 struct skeleton {
  65         struct pci_dev *pdev;
  66         struct v4l2_device v4l2_dev;
  67         struct video_device vdev;
  68         struct v4l2_ctrl_handler ctrl_handler;
  69         struct mutex lock;
  70         v4l2_std_id std;
  71         struct v4l2_dv_timings timings;
  72         struct v4l2_pix_format format;
  73         unsigned input;
  74
  75         struct vb2_queue queue;
  76         struct vb2_alloc_ctx *alloc_ctx;
  77
  78         spinlock_t qlock;
  79         struct list_head buf_list;
  80         unsigned field;
  81         unsigned sequence;
  82 };
  83
  84 struct skel_buffer {
  85         struct vb2_buffer vb;
  86         struct list_head list;
  87 };
  88
  89 static inline struct skel_buffer *to_skel_buffer(struct vb2_buffer *vb2)
  90 {
  91         return container_of(vb2, struct skel_buffer, vb);
  92 }
  93
  94 static const struct pci_device_id skeleton_pci_tbl[] = {
  95         /* { PCI_DEVICE(PCI_VENDOR_ID_, PCI_DEVICE_ID_) }, */
  96         { 0, }
  97 };
  98
  99 /*
 100  * HDTV: this structure has the capabilities of the HDTV receiver.
 101  * It is used to constrain the huge list of possible formats based
 102  * upon the hardware capabilities.
 103  */
 104 static const struct v4l2_dv_timings_cap skel_timings_cap = {
 105         .type = V4L2_DV_BT_656_1120,
 106         /* keep this initialization for compatibility with GCC < 4.4.6 */
 107         .reserved = { 0 },
 108         V4L2_INIT_BT_TIMINGS(
 109                 720, 1920,              /* min/max width */
 110                 480, 1080,              /* min/max height */
 111                 27000000, 74250000,     /* min/max pixelclock*/
 112                 V4L2_DV_BT_STD_CEA861,  /* Supported standards */
 113                 /* capabilities */
 114                 V4L2_DV_BT_CAP_INTERLACED | V4L2_DV_BT_CAP_PROGRESSIVE
 115         )
 116 };
 117
 118 /*
 119  * Supported SDTV standards. This does the same job as skel_timings_cap, but
 120  * for standard TV formats.
 121  */
 122 #define SKEL_TVNORMS V4L2_STD_ALL
 123
 124 /*
 125  * Interrupt handler: typically interrupts happen after a new frame has been
 126  * captured. It is the job of the handler to remove the new frame from the
 127  * internal list and give it back to the vb2 framework, updating the sequence
 128  * counter, field and timestamp at the same time.
 129  */
 130 static irqreturn_t skeleton_irq(int irq, void *dev_id)
 131 {
 132 #ifdef TODO
 133         struct skeleton *skel = dev_id;
 134
 135         /* handle interrupt */
 136
 137         /* Once a new frame has been captured, mark it as done like this: */
 138         if (captured_new_frame) {
 139                 ...
 140                 spin_lock(&skel->qlock);
 141                 list_del(&new_buf->list);
 142                 spin_unlock(&skel->qlock);
 143                 v4l2_get_timestamp(&new_buf->vb.v4l2_buf.timestamp);
 144                 new_buf->vb.v4l2_buf.sequence = skel->sequence++;
 145                 new_buf->vb.v4l2_buf.field = skel->field;
 146                 if (skel->format.field == V4L2_FIELD_ALTERNATE) {
 147                         if (skel->field == V4L2_FIELD_BOTTOM)
 148                                 skel->field = V4L2_FIELD_TOP;
 149                         else if (skel->field == V4L2_FIELD_TOP)
 150                                 skel->field = V4L2_FIELD_BOTTOM;
 151                 }
 152                 vb2_buffer_done(&new_buf->vb, VB2_BUF_STATE_DONE);
 153         }
 154 #endif
 155         return IRQ_HANDLED;
 156 }
 157
 158 /*
 159  * Setup the constraints of the queue: besides setting the number of planes
 160  * per buffer and the size and allocation context of each plane, it also
 161  * checks if sufficient buffers have been allocated. Usually 3 is a good
 162  * minimum number: many DMA engines need a minimum of 2 buffers in the
 163  * queue and you need to have another available for userspace processing.
 164  */
 165 static int queue_setup(struct vb2_queue *vq, const struct v4l2_format *fmt,
 166                        unsigned int *nbuffers, unsigned int *nplanes,
 167                        unsigned int sizes[], void *alloc_ctxs[])
 168 {
 169         struct skeleton *skel = vb2_get_drv_priv(vq);
 170
 171         skel->field = skel->format.field;
 172         if (skel->field == V4L2_FIELD_ALTERNATE) {
 173                 /*
 174                  * You cannot use read() with FIELD_ALTERNATE since the field
 175                  * information (TOP/BOTTOM) cannot be passed back to the user.
 176                  */
 177                 if (vb2_fileio_is_active(q))
 178                         return -EINVAL;
 179                 skel->field = V4L2_FIELD_TOP;
 180         }
 181
 182         if (vq->num_buffers + *nbuffers < 3)
 183                 *nbuffers = 3 - vq->num_buffers;
 184
 185         if (fmt && fmt->fmt.pix.sizeimage < skel->format.sizeimage)
 186                 return -EINVAL;
 187         *nplanes = 1;
 188         sizes[0] = fmt ? fmt->fmt.pix.sizeimage : skel->format.sizeimage;
 189         alloc_ctxs[0] = skel->alloc_ctx;
 190         return 0;
 191 }
 192
 193 /*
 194  * Prepare the buffer for queueing to the DMA engine: check and set the
 195  * payload size.
 196  */
 197 static int buffer_prepare(struct vb2_buffer *vb)
 198 {
 199         struct skeleton *skel = vb2_get_drv_priv(vb->vb2_queue);
 200         unsigned long size = skel->format.sizeimage;
 201
 202         if (vb2_plane_size(vb, 0) < size) {
 203                 dev_err(&skel->pdev->dev, "buffer too small (%lu < %lu)\n",
 204                          vb2_plane_size(vb, 0), size);
 205                 return -EINVAL;
 206         }
 207
 208         vb2_set_plane_payload(vb, 0, size);
 209         return 0;
 210 }
 211
 212 /*
 213  * Queue this buffer to the DMA engine.
 214  */
 215 static void buffer_queue(struct vb2_buffer *vb)
 216 {
 217         struct skeleton *skel = vb2_get_drv_priv(vb->vb2_queue);
 218         struct skel_buffer *buf = to_skel_buffer(vb);
 219         unsigned long flags;
 220
 221         spin_lock_irqsave(&skel->qlock, flags);
 222         list_add_tail(&buf->list, &skel->buf_list);
 223
 224         /* TODO: Update any DMA pointers if necessary */
 225
 226         spin_unlock_irqrestore(&skel->qlock, flags);
 227 }
 228
 229 static void return_all_buffers(struct skeleton *skel,
 230                                enum vb2_buffer_state state)
 231 {
 232         struct skel_buffer *buf, *node;
 233         unsigned long flags;
 234
 235         spin_lock_irqsave(&skel->qlock, flags);
 236         list_for_each_entry_safe(buf, node, &skel->buf_list, list) {
 237                 vb2_buffer_done(&buf->vb, state);
 238                 list_del(&buf->list);
 239         }
 240         spin_unlock_irqrestore(&skel->qlock, flags);
 241 }
 242
 243 /*
 244  * Start streaming. First check if the minimum number of buffers have been
 245  * queued. If not, then return -ENOBUFS and the vb2 framework will call
 246  * this function again the next time a buffer has been queued until enough
 247  * buffers are available to actually start the DMA engine.
 248  */
 249 static int start_streaming(struct vb2_queue *vq, unsigned int count)
 250 {
 251         struct skeleton *skel = vb2_get_drv_priv(vq);
 252         int ret = 0;
 253
 254         skel->sequence = 0;
 255
 256         /* TODO: start DMA */
 257
 258         if (ret) {
 259                 /*
 260                  * In case of an error, return all active buffers to the
 261                  * QUEUED state
 262                  */
 263                 return_all_buffers(skel, VB2_BUF_STATE_QUEUED);
 264         }
 265         return ret;
 266 }
 267
 268 /*
 269  * Stop the DMA engine. Any remaining buffers in the DMA queue are dequeued
 270  * and passed on to the vb2 framework marked as STATE_ERROR.
 271  */
 272 static int stop_streaming(struct vb2_queue *vq)
 273 {
 274         struct skeleton *skel = vb2_get_drv_priv(vq);
 275
 276         /* TODO: stop DMA */
 277
 278         /* Release all active buffers */
 279         return_all_buffers(skel, VB2_BUF_STATE_ERROR);
 280         return 0;
 281 }
 282
 283 /*
 284  * The vb2 queue ops. Note that since q->lock is set we can use the standard
 285  * vb2_ops_wait_prepare/finish helper functions. If q->lock would be NULL,
 286  * then this driver would have to provide these ops.
 287  */
 288 static struct vb2_ops skel_qops = {
 289         .queue_setup            = queue_setup,
 290         .buf_prepare            = buffer_prepare,
 291         .buf_queue              = buffer_queue,
 292         .start_streaming        = start_streaming,
 293         .stop_streaming         = stop_streaming,
 294         .wait_prepare           = vb2_ops_wait_prepare,
 295         .wait_finish            = vb2_ops_wait_finish,
 296 };
 297
 298 /*
 299  * Required ioctl querycap. Note that the version field is prefilled with
 300  * the version of the kernel.
 301  */
 302 static int skeleton_querycap(struct file *file, void *priv,
 303                              struct v4l2_capability *cap)
 304 {
 305         struct skeleton *skel = video_drvdata(file);
 306
 307         strlcpy(cap->driver, KBUILD_MODNAME, sizeof(cap->driver));
 308         strlcpy(cap->card, "V4L2 PCI Skeleton", sizeof(cap->card));
 309         snprintf(cap->bus_info, sizeof(cap->bus_info), "PCI:%s",
 310                  pci_name(skel->pdev));
 311         cap->device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_READWRITE |
 312                            V4L2_CAP_STREAMING;
 313         cap->capabilities = cap->device_caps | V4L2_CAP_DEVICE_CAPS;
 314         return 0;
 315 }
 316
 317 /*
 318  * Helper function to check and correct struct v4l2_pix_format. It's used
 319  * not only in VIDIOC_TRY/S_FMT, but also elsewhere if changes to the SDTV
 320  * standard, HDTV timings or the video input would require updating the
 321  * current format.
 322  */
 323 static void skeleton_fill_pix_format(struct skeleton *skel,
 324                                      struct v4l2_pix_format *pix)
 325 {
 326         pix->pixelformat = V4L2_PIX_FMT_YUYV;
 327         if (skel->input == 0) {
 328                 /* S-Video input */
 329                 pix->width = 720;
 330                 pix->height = (skel->std & V4L2_STD_525_60) ? 480 : 576;
 331                 pix->field = V4L2_FIELD_INTERLACED;
 332                 pix->colorspace = V4L2_COLORSPACE_SMPTE170M;
 333         } else {
 334                 /* HDMI input */
 335                 pix->width = skel->timings.bt.width;
 336                 pix->height = skel->timings.bt.height;
 337                 if (skel->timings.bt.interlaced) {
 338                         pix->field = V4L2_FIELD_ALTERNATE;
 339                         pix->height /= 2;
 340                 } else {
 341                         pix->field = V4L2_FIELD_NONE;
 342                 }
 343                 pix->colorspace = V4L2_COLORSPACE_REC709;
 344         }
 345
 346         /*
 347          * The YUYV format is four bytes for every two pixels, so bytesperline
 348          * is width * 2.
 349          */
 350         pix->bytesperline = pix->width * 2;
 351         pix->sizeimage = pix->bytesperline * pix->height;
 352         pix->priv = 0;
 353 }
 354
 355 static int skeleton_try_fmt_vid_cap(struct file *file, void *priv,
 356                                     struct v4l2_format *f)
 357 {
 358         struct skeleton *skel = video_drvdata(file);
 359         struct v4l2_pix_format *pix = &f->fmt.pix;
 360
 361         /*
 362          * Due to historical reasons providing try_fmt with an unsupported
 363          * pixelformat will return -EINVAL for video receivers. Webcam drivers,
 364          * however, will silently correct the pixelformat. Some video capture
 365          * applications rely on this behavior...
 366          */
 367         if (pix->pixelformat != V4L2_PIX_FMT_YUYV)
 368                 return -EINVAL;
 369         skeleton_fill_pix_format(skel, pix);
 370         return 0;
 371 }
 372
 373 static int skeleton_s_fmt_vid_cap(struct file *file, void *priv,
 374                                   struct v4l2_format *f)
 375 {
 376         struct skeleton *skel = video_drvdata(file);
 377         int ret;
 378
 379         ret = skeleton_try_fmt_vid_cap(file, priv, f);
 380         if (ret)
 381                 return ret;
 382
 383         /*
 384          * It is not allowed to change the format while buffers for use with
 385          * streaming have already been allocated.
 386          */
 387         if (vb2_is_busy(&skel->queue))
 388                 return -EBUSY;
 389
 390         /* TODO: change format */
 391         skel->format = f->fmt.pix;
 392         return 0;
 393 }
 394
 395 static int skeleton_g_fmt_vid_cap(struct file *file, void *priv,
 396                                   struct v4l2_format *f)
 397 {
 398         struct skeleton *skel = video_drvdata(file);
 399
 400         f->fmt.pix = skel->format;
 401         return 0;
 402 }
 403
 404 static int skeleton_enum_fmt_vid_cap(struct file *file, void *priv,
 405                                      struct v4l2_fmtdesc *f)
 406 {
 407         if (f->index != 0)
 408                 return -EINVAL;
 409
 410         strlcpy(f->description, "4:2:2, packed, YUYV", sizeof(f->description));
 411         f->pixelformat = V4L2_PIX_FMT_YUYV;
 412         f->flags = 0;
 413         return 0;
 414 }
 415
 416 static int skeleton_s_std(struct file *file, void *priv, v4l2_std_id std)
 417 {
 418         struct skeleton *skel = video_drvdata(file);
 419
 420         /* S_STD is not supported on the HDMI input */
 421         if (skel->input)
 422                 return -ENODATA;
 423
 424         /*
 425          * No change, so just return. Some applications call S_STD again after
 426          * the buffers for streaming have been set up, so we have to allow for
 427          * this behavior.
 428          */
 429         if (std == skel->std)
 430                 return 0;
 431
 432         /*
 433          * Changing the standard implies a format change, which is not allowed
 434          * while buffers for use with streaming have already been allocated.
 435          */
 436         if (vb2_is_busy(&skel->queue))
 437                 return -EBUSY;
 438
 439         /* TODO: handle changing std */
 440
 441         skel->std = std;
 442
 443         /* Update the internal format */
 444         skeleton_fill_pix_format(skel, &skel->format);
 445         return 0;
 446 }
 447
 448 static int skeleton_g_std(struct file *file, void *priv, v4l2_std_id *std)
 449 {
 450         struct skeleton *skel = video_drvdata(file);
 451
 452         /* G_STD is not supported on the HDMI input */
 453         if (skel->input)
 454                 return -ENODATA;
 455
 456         *std = skel->std;
 457         return 0;
 458 }
 459
 460 /*
 461  * Query the current standard as seen by the hardware. This function shall
 462  * never actually change the standard, it just detects and reports.
 463  * The framework will initially set *std to tvnorms (i.e. the set of
 464  * supported standards by this input), and this function should just AND
 465  * this value. If there is no signal, then *std should be set to 0.
 466  */
 467 static int skeleton_querystd(struct file *file, void *priv, v4l2_std_id *std)
 468 {
 469         struct skeleton *skel = video_drvdata(file);
 470
 471         /* QUERY_STD is not supported on the HDMI input */
 472         if (skel->input)
 473                 return -ENODATA;
 474
 475 #ifdef TODO
 476         /*
 477          * Query currently seen standard. Initial value of *std is
 478          * V4L2_STD_ALL. This function should look something like this:
 479          */
 480         get_signal_info();
 481         if (no_signal) {
 482                 *std = 0;
 483                 return 0;
 484         }
 485         /* Use signal information to reduce the number of possible standards */
 486         if (signal_has_525_lines)
 487                 *std &= V4L2_STD_525_60;
 488         else
 489                 *std &= V4L2_STD_625_50;
 490 #endif
 491         return 0;
 492 }
 493
 494 static int skeleton_s_dv_timings(struct file *file, void *_fh,
 495                                  struct v4l2_dv_timings *timings)
 496 {
 497         struct skeleton *skel = video_drvdata(file);
 498
 499         /* S_DV_TIMINGS is not supported on the S-Video input */
 500         if (skel->input == 0)
 501                 return -ENODATA;
 502
 503         /* Quick sanity check */
 504         if (!v4l2_valid_dv_timings(timings, &skel_timings_cap, NULL, NULL))
 505                 return -EINVAL;
 506
 507         /* Check if the timings are part of the CEA-861 timings. */
 508         if (!v4l2_find_dv_timings_cap(timings, &skel_timings_cap,
 509                                       0, NULL, NULL))
 510                 return -EINVAL;
 511
 512         /* Return 0 if the new timings are the same as the current timings. */
 513         if (v4l2_match_dv_timings(timings, &skel->timings, 0))
 514                 return 0;
 515
 516         /*
 517          * Changing the timings implies a format change, which is not allowed
 518          * while buffers for use with streaming have already been allocated.
 519          */
 520         if (vb2_is_busy(&skel->queue))
 521                 return -EBUSY;
 522
 523         /* TODO: Configure new timings */
 524
 525         /* Save timings */
 526         skel->timings = *timings;
 527
 528         /* Update the internal format */
 529         skeleton_fill_pix_format(skel, &skel->format);
 530         return 0;
 531 }
 532
 533 static int skeleton_g_dv_timings(struct file *file, void *_fh,
 534                                  struct v4l2_dv_timings *timings)
 535 {
 536         struct skeleton *skel = video_drvdata(file);
 537
 538         /* G_DV_TIMINGS is not supported on the S-Video input */
 539         if (skel->input == 0)
 540                 return -ENODATA;
 541
 542         *timings = skel->timings;
 543         return 0;
 544 }
 545
 546 static int skeleton_enum_dv_timings(struct file *file, void *_fh,
 547                                     struct v4l2_enum_dv_timings *timings)
 548 {
 549         struct skeleton *skel = video_drvdata(file);
 550
 551         /* ENUM_DV_TIMINGS is not supported on the S-Video input */
 552         if (skel->input == 0)
 553                 return -ENODATA;
 554
 555         return v4l2_enum_dv_timings_cap(timings, &skel_timings_cap,
 556                                         NULL, NULL);
 557 }
 558
 559 /*
 560  * Query the current timings as seen by the hardware. This function shall
 561  * never actually change the timings, it just detects and reports.
 562  * If no signal is detected, then return -ENOLINK. If the hardware cannot
 563  * lock to the signal, then return -ENOLCK. If the signal is out of range
 564  * of the capabilities of the system (e.g., it is possible that the receiver
 565  * can lock but that the DMA engine it is connected to cannot handle
 566  * pixelclocks above a certain frequency), then -ERANGE is returned.
 567  */
 568 static int skeleton_query_dv_timings(struct file *file, void *_fh,
 569                                      struct v4l2_dv_timings *timings)
 570 {
 571         struct skeleton *skel = video_drvdata(file);
 572
 573         /* QUERY_DV_TIMINGS is not supported on the S-Video input */
 574         if (skel->input == 0)
 575                 return -ENODATA;
 576
 577 #ifdef TODO
 578         /*
 579          * Query currently seen timings. This function should look
 580          * something like this:
 581          */
 582         detect_timings();
 583         if (no_signal)
 584                 return -ENOLINK;
 585         if (cannot_lock_to_signal)
 586                 return -ENOLCK;
 587         if (signal_out_of_range_of_capabilities)
 588                 return -ERANGE;
 589
 590         /* Useful for debugging */
 591         v4l2_print_dv_timings(skel->v4l2_dev.name, "query_dv_timings:",
 592                         timings, true);
 593 #endif
 594         return 0;
 595 }
 596
 597 static int skeleton_dv_timings_cap(struct file *file, void *fh,
 598                                    struct v4l2_dv_timings_cap *cap)
 599 {
 600         struct skeleton *skel = video_drvdata(file);
 601
 602         /* DV_TIMINGS_CAP is not supported on the S-Video input */
 603         if (skel->input == 0)
 604                 return -ENODATA;
 605         *cap = skel_timings_cap;
 606         return 0;
 607 }
 608
 609 static int skeleton_enum_input(struct file *file, void *priv,
 610                                struct v4l2_input *i)
 611 {
 612         if (i->index > 1)
 613                 return -EINVAL;
 614
 615         i->type = V4L2_INPUT_TYPE_CAMERA;
 616         if (i->index == 0) {
 617                 i->std = SKEL_TVNORMS;
 618                 strlcpy(i->name, "S-Video", sizeof(i->name));
 619                 i->capabilities = V4L2_IN_CAP_STD;
 620         } else {
 621                 i->std = 0;
 622                 strlcpy(i->name, "HDMI", sizeof(i->name));
 623                 i->capabilities = V4L2_IN_CAP_DV_TIMINGS;
 624         }
 625         return 0;
 626 }
 627
 628 static int skeleton_s_input(struct file *file, void *priv, unsigned int i)
 629 {
 630         struct skeleton *skel = video_drvdata(file);
 631
 632         if (i > 1)
 633                 return -EINVAL;
 634
 635         /*
 636          * Changing the input implies a format change, which is not allowed
 637          * while buffers for use with streaming have already been allocated.
 638          */
 639         if (vb2_is_busy(&skel->queue))
 640                 return -EBUSY;
 641
 642         skel->input = i;
 643         /*
 644          * Update tvnorms. The tvnorms value is used by the core to implement
 645          * VIDIOC_ENUMSTD so it has to be correct. If tvnorms == 0, then
 646          * ENUMSTD will return -ENODATA.
 647          */
 648         skel->vdev.tvnorms = i ? 0 : SKEL_TVNORMS;
 649
 650         /* Update the internal format */
 651         skeleton_fill_pix_format(skel, &skel->format);
 652         return 0;
 653 }
 654
 655 static int skeleton_g_input(struct file *file, void *priv, unsigned int *i)
 656 {
 657         struct skeleton *skel = video_drvdata(file);
 658
 659         *i = skel->input;
 660         return 0;
 661 }
 662
 663 /* The control handler. */
 664 static int skeleton_s_ctrl(struct v4l2_ctrl *ctrl)
 665 {
 666         /*struct skeleton *skel =
 667                 container_of(ctrl->handler, struct skeleton, ctrl_handler);*/
 668
 669         switch (ctrl->id) {
 670         case V4L2_CID_BRIGHTNESS:
 671                 /* TODO: set brightness to ctrl->val */
 672                 break;
 673         case V4L2_CID_CONTRAST:
 674                 /* TODO: set contrast to ctrl->val */
 675                 break;
 676         case V4L2_CID_SATURATION:
 677                 /* TODO: set saturation to ctrl->val */
 678                 break;
 679         case V4L2_CID_HUE:
 680                 /* TODO: set hue to ctrl->val */
 681                 break;
 682         default:
 683                 return -EINVAL;
 684         }
 685         return 0;
 686 }
 687
 688 /* ------------------------------------------------------------------
 689         File operations for the device
 690    ------------------------------------------------------------------*/
 691
 692 static const struct v4l2_ctrl_ops skel_ctrl_ops = {
 693         .s_ctrl = skeleton_s_ctrl,
 694 };
 695
 696 /*
 697  * The set of all supported ioctls. Note that all the streaming ioctls
 698  * use the vb2 helper functions that take care of all the locking and
 699  * that also do ownership tracking (i.e. only the filehandle that requested
 700  * the buffers can call the streaming ioctls, all other filehandles will
 701  * receive -EBUSY if they attempt to call the same streaming ioctls).
 702  *
 703  * The last three ioctls also use standard helper functions: these implement
 704  * standard behavior for drivers with controls.
 705  */
 706 static const struct v4l2_ioctl_ops skel_ioctl_ops = {
 707         .vidioc_querycap = skeleton_querycap,
 708         .vidioc_try_fmt_vid_cap = skeleton_try_fmt_vid_cap,
 709         .vidioc_s_fmt_vid_cap = skeleton_s_fmt_vid_cap,
 710         .vidioc_g_fmt_vid_cap = skeleton_g_fmt_vid_cap,
 711         .vidioc_enum_fmt_vid_cap = skeleton_enum_fmt_vid_cap,
 712
 713         .vidioc_g_std = skeleton_g_std,
 714         .vidioc_s_std = skeleton_s_std,
 715         .vidioc_querystd = skeleton_querystd,
 716
 717         .vidioc_s_dv_timings = skeleton_s_dv_timings,
 718         .vidioc_g_dv_timings = skeleton_g_dv_timings,
 719         .vidioc_enum_dv_timings = skeleton_enum_dv_timings,
 720         .vidioc_query_dv_timings = skeleton_query_dv_timings,
 721         .vidioc_dv_timings_cap = skeleton_dv_timings_cap,
 722
 723         .vidioc_enum_input = skeleton_enum_input,
 724         .vidioc_g_input = skeleton_g_input,
 725         .vidioc_s_input = skeleton_s_input,
 726
 727         .vidioc_reqbufs = vb2_ioctl_reqbufs,
 728         .vidioc_create_bufs = vb2_ioctl_create_bufs,
 729         .vidioc_querybuf = vb2_ioctl_querybuf,
 730         .vidioc_qbuf = vb2_ioctl_qbuf,
 731         .vidioc_dqbuf = vb2_ioctl_dqbuf,
 732         .vidioc_expbuf = vb2_ioctl_expbuf,
 733         .vidioc_streamon = vb2_ioctl_streamon,
 734         .vidioc_streamoff = vb2_ioctl_streamoff,
 735
 736         .vidioc_log_status = v4l2_ctrl_log_status,
 737         .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
 738         .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
 739 };
 740
 741 /*
 742  * The set of file operations. Note that all these ops are standard core
 743  * helper functions.
 744  */
 745 static const struct v4l2_file_operations skel_fops = {
 746         .owner = THIS_MODULE,
 747         .open = v4l2_fh_open,
 748         .release = vb2_fop_release,
 749         .unlocked_ioctl = video_ioctl2,
 750         .read = vb2_fop_read,
 751         .mmap = vb2_fop_mmap,
 752         .poll = vb2_fop_poll,
 753 };
 754
 755 /*
 756  * The initial setup of this device instance. Note that the initial state of
 757  * the driver should be complete. So the initial format, standard, timings
 758  * and video input should all be initialized to some reasonable value.
 759  */
 760 static int skeleton_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 761 {
 762         /* The initial timings are chosen to be 720p60. */
 763         static const struct v4l2_dv_timings timings_def =
 764                 V4L2_DV_BT_CEA_1280X720P60;
 765         struct skeleton *skel;
 766         struct video_device *vdev;
 767         struct v4l2_ctrl_handler *hdl;
 768         struct vb2_queue *q;
 769         int ret;
 770
 771         /* Enable PCI */
 772         ret = pci_enable_device(pdev);
 773         if (ret)
 774                 return ret;
 775         ret = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
 776         if (ret) {
 777                 dev_err(&pdev->dev, "no suitable DMA available.\n");
 778                 goto disable_pci;
 779         }
 780
 781         /* Allocate a new instance */
 782         skel = devm_kzalloc(&pdev->dev, sizeof(struct skeleton), GFP_KERNEL);
 783         if (!skel)
 784                 return -ENOMEM;
 785
 786         /* Allocate the interrupt */
 787         ret = devm_request_irq(&pdev->dev, pdev->irq,
 788                                skeleton_irq, 0, KBUILD_MODNAME, skel);
 789         if (ret) {
 790                 dev_err(&pdev->dev, "request_irq failed\n");
 791                 goto disable_pci;
 792         }
 793         skel->pdev = pdev;
 794
 795         /* Fill in the initial format-related settings */
 796         skel->timings = timings_def;
 797         skel->std = V4L2_STD_625_50;
 798         skeleton_fill_pix_format(skel, &skel->format);
 799
 800         /* Initialize the top-level structure */
 801         ret = v4l2_device_register(&pdev->dev, &skel->v4l2_dev);
 802         if (ret)
 803                 goto disable_pci;
 804
 805         mutex_init(&skel->lock);
 806
 807         /* Add the controls */
 808         hdl = &skel->ctrl_handler;
 809         v4l2_ctrl_handler_init(hdl, 4);
 810         v4l2_ctrl_new_std(hdl, &skel_ctrl_ops,
 811                           V4L2_CID_BRIGHTNESS, 0, 255, 1, 127);
 812         v4l2_ctrl_new_std(hdl, &skel_ctrl_ops,
 813                           V4L2_CID_CONTRAST, 0, 255, 1, 16);
 814         v4l2_ctrl_new_std(hdl, &skel_ctrl_ops,
 815                           V4L2_CID_SATURATION, 0, 255, 1, 127);
 816         v4l2_ctrl_new_std(hdl, &skel_ctrl_ops,
 817                           V4L2_CID_HUE, -128, 127, 1, 0);
 818         if (hdl->error) {
 819                 ret = hdl->error;
 820                 goto free_hdl;
 821         }
 822         skel->v4l2_dev.ctrl_handler = hdl;
 823
 824         /* Initialize the vb2 queue */
 825         q = &skel->queue;
 826         q->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
 827         q->io_modes = VB2_MMAP | VB2_DMABUF | VB2_READ;
 828         q->drv_priv = skel;
 829         q->buf_struct_size = sizeof(struct skel_buffer);
 830         q->ops = &skel_qops;
 831         q->mem_ops = &vb2_dma_contig_memops;
 832         q->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
 833         /*
 834          * Assume that this DMA engine needs to have at least two buffers
 835          * available before it can be started. The start_streaming() op
 836          * won't be called until at least this many buffers are queued up.
 837          */
 838         q->min_buffers_needed = 2;
 839         /*
 840          * The serialization lock for the streaming ioctls. This is the same
 841          * as the main serialization lock, but if some of the non-streaming
 842          * ioctls could take a long time to execute, then you might want to
 843          * have a different lock here to prevent VIDIOC_DQBUF from being
 844          * blocked while waiting for another action to finish. This is
 845          * generally not needed for PCI devices, but USB devices usually do
 846          * want a separate lock here.
 847          */
 848         q->lock = &skel->lock;
 849         /*
 850          * Since this driver can only do 32-bit DMA we must make sure that
 851          * the vb2 core will allocate the buffers in 32-bit DMA memory.
 852          */
 853         q->gfp_flags = GFP_DMA32;
 854         ret = vb2_queue_init(q);
 855         if (ret)
 856                 goto free_hdl;
 857
 858         skel->alloc_ctx = vb2_dma_contig_init_ctx(&pdev->dev);
 859         if (IS_ERR(skel->alloc_ctx)) {
 860                 dev_err(&pdev->dev, "Can't allocate buffer context");
 861                 ret = PTR_ERR(skel->alloc_ctx);
 862                 goto free_hdl;
 863         }
 864         INIT_LIST_HEAD(&skel->buf_list);
 865         spin_lock_init(&skel->qlock);
 866
 867         /* Initialize the video_device structure */
 868         vdev = &skel->vdev;
 869         strlcpy(vdev->name, KBUILD_MODNAME, sizeof(vdev->name));
 870         /*
 871          * There is nothing to clean up, so release is set to an empty release
 872          * function. The release callback must be non-NULL.
 873          */
 874         vdev->release = video_device_release_empty;
 875         vdev->fops = &skel_fops,
 876         vdev->ioctl_ops = &skel_ioctl_ops,
 877         /*
 878          * The main serialization lock. All ioctls are serialized by this
 879          * lock. Exception: if q->lock is set, then the streaming ioctls
 880          * are serialized by that separate lock.
 881          */
 882         vdev->lock = &skel->lock;
 883         vdev->queue = q;
 884         vdev->v4l2_dev = &skel->v4l2_dev;
 885         /* Supported SDTV standards, if any */
 886         vdev->tvnorms = SKEL_TVNORMS;
 887         /* If this bit is set, then the v4l2 core will provide the support
 888          * for the VIDIOC_G/S_PRIORITY ioctls. This flag will eventually
 889          * go away once all drivers have been converted to use struct v4l2_fh.
 890          */
 891         set_bit(V4L2_FL_USE_FH_PRIO, &vdev->flags);
 892         video_set_drvdata(vdev, skel);
 893
 894         ret = video_register_device(vdev, VFL_TYPE_GRABBER, -1);
 895         if (ret)
 896                 goto free_ctx;
 897
 898         dev_info(&pdev->dev, "V4L2 PCI Skeleton Driver loaded\n");
 899         return 0;
 900
 901 free_ctx:
 902         vb2_dma_contig_cleanup_ctx(skel->alloc_ctx);
 903 free_hdl:
 904         v4l2_ctrl_handler_free(&skel->ctrl_handler);
 905         v4l2_device_unregister(&skel->v4l2_dev);
 906 disable_pci:
 907         pci_disable_device(pdev);
 908         return ret;
 909 }
 910
 911 static void skeleton_remove(struct pci_dev *pdev)
 912 {
 913         struct v4l2_device *v4l2_dev = pci_get_drvdata(pdev);
 914         struct skeleton *skel = container_of(v4l2_dev, struct skeleton, v4l2_dev);
 915
 916         video_unregister_device(&skel->vdev);
 917         v4l2_ctrl_handler_free(&skel->ctrl_handler);
 918         vb2_dma_contig_cleanup_ctx(skel->alloc_ctx);
 919         v4l2_device_unregister(&skel->v4l2_dev);
 920         pci_disable_device(skel->pdev);
 921 }
 922
 923 static struct pci_driver skeleton_driver = {
 924         .name = KBUILD_MODNAME,
 925         .probe = skeleton_probe,
 926         .remove = skeleton_remove,
 927         .id_table = skeleton_pci_tbl,
 928 };
 929
 930 module_pci_driver(skeleton_driver);