2 * This is a V4L2 PCI Skeleton Driver. It gives an initial skeleton source
3 * for use with other PCI drivers.
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.
8 * Copyright 2014 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
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.
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
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>
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);
48 * struct skeleton - All internal data for one instance of 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
66 struct v4l2_device v4l2_dev;
67 struct video_device vdev;
68 struct v4l2_ctrl_handler ctrl_handler;
71 struct v4l2_dv_timings timings;
72 struct v4l2_pix_format format;
75 struct vb2_queue queue;
76 struct vb2_alloc_ctx *alloc_ctx;
79 struct list_head buf_list;
80 unsigned int sequence;
85 struct list_head list;
88 static inline struct skel_buffer *to_skel_buffer(struct vb2_buffer *vb2)
90 return container_of(vb2, struct skel_buffer, vb);
93 static const struct pci_device_id skeleton_pci_tbl[] = {
94 /* { PCI_DEVICE(PCI_VENDOR_ID_, PCI_DEVICE_ID_) }, */
99 * HDTV: this structure has the capabilities of the HDTV receiver.
100 * It is used to constrain the huge list of possible formats based
101 * upon the hardware capabilities.
103 static const struct v4l2_dv_timings_cap skel_timings_cap = {
104 .type = V4L2_DV_BT_656_1120,
105 /* keep this initialization for compatibility with GCC < 4.4.6 */
107 V4L2_INIT_BT_TIMINGS(
108 720, 1920, /* min/max width */
109 480, 1080, /* min/max height */
110 27000000, 74250000, /* min/max pixelclock*/
111 V4L2_DV_BT_STD_CEA861, /* Supported standards */
113 V4L2_DV_BT_CAP_INTERLACED | V4L2_DV_BT_CAP_PROGRESSIVE
118 * Supported SDTV standards. This does the same job as skel_timings_cap, but
119 * for standard TV formats.
121 #define SKEL_TVNORMS V4L2_STD_ALL
124 * Interrupt handler: typically interrupts happen after a new frame has been
125 * captured. It is the job of the handler to remove the new frame from the
126 * internal list and give it back to the vb2 framework, updating the sequence
127 * counter and timestamp at the same time.
129 static irqreturn_t skeleton_irq(int irq, void *dev_id)
132 struct skeleton *skel = dev_id;
134 /* handle interrupt */
136 /* Once a new frame has been captured, mark it as done like this: */
137 if (captured_new_frame) {
139 spin_lock(&skel->qlock);
140 list_del(&new_buf->list);
141 spin_unlock(&skel->qlock);
142 new_buf->vb.v4l2_buf.sequence = skel->sequence++;
143 v4l2_get_timestamp(&new_buf->vb.v4l2_buf.timestamp);
144 vb2_buffer_done(&new_buf->vb, VB2_BUF_STATE_DONE);
151 * Setup the constraints of the queue: besides setting the number of planes
152 * per buffer and the size and allocation context of each plane, it also
153 * checks if sufficient buffers have been allocated. Usually 3 is a good
154 * minimum number: many DMA engines need a minimum of 2 buffers in the
155 * queue and you need to have another available for userspace processing.
157 static int queue_setup(struct vb2_queue *vq, const struct v4l2_format *fmt,
158 unsigned int *nbuffers, unsigned int *nplanes,
159 unsigned int sizes[], void *alloc_ctxs[])
161 struct skeleton *skel = vb2_get_drv_priv(vq);
163 if (vq->num_buffers + *nbuffers < 3)
164 *nbuffers = 3 - vq->num_buffers;
166 if (fmt && fmt->fmt.pix.sizeimage < skel->format.sizeimage)
169 sizes[0] = fmt ? fmt->fmt.pix.sizeimage : skel->format.sizeimage;
170 alloc_ctxs[0] = skel->alloc_ctx;
175 * Prepare the buffer for queueing to the DMA engine: check and set the
176 * payload size and fill in the field. Note: if the format's field is
177 * V4L2_FIELD_ALTERNATE, then vb->v4l2_buf.field should be set in the
178 * interrupt handler since that's usually where you know if the TOP or
179 * BOTTOM field has been captured.
181 static int buffer_prepare(struct vb2_buffer *vb)
183 struct skeleton *skel = vb2_get_drv_priv(vb->vb2_queue);
184 unsigned long size = skel->format.sizeimage;
186 if (vb2_plane_size(vb, 0) < size) {
187 dev_err(&skel->pdev->dev, "buffer too small (%lu < %lu)\n",
188 vb2_plane_size(vb, 0), size);
192 vb2_set_plane_payload(vb, 0, size);
193 vb->v4l2_buf.field = skel->format.field;
198 * Queue this buffer to the DMA engine.
200 static void buffer_queue(struct vb2_buffer *vb)
202 struct skeleton *skel = vb2_get_drv_priv(vb->vb2_queue);
203 struct skel_buffer *buf = to_skel_buffer(vb);
206 spin_lock_irqsave(&skel->qlock, flags);
207 list_add_tail(&buf->list, &skel->buf_list);
209 /* TODO: Update any DMA pointers if necessary */
211 spin_unlock_irqrestore(&skel->qlock, flags);
214 static void return_all_buffers(struct skeleton *skel,
215 enum vb2_buffer_state state)
217 struct skel_buffer *buf, *node;
220 spin_lock_irqsave(&skel->qlock, flags);
221 list_for_each_entry_safe(buf, node, &skel->buf_list, list) {
222 vb2_buffer_done(&buf->vb, state);
223 list_del(&buf->list);
225 spin_unlock_irqrestore(&skel->qlock, flags);
229 * Start streaming. First check if the minimum number of buffers have been
230 * queued. If not, then return -ENOBUFS and the vb2 framework will call
231 * this function again the next time a buffer has been queued until enough
232 * buffers are available to actually start the DMA engine.
234 static int start_streaming(struct vb2_queue *vq, unsigned int count)
236 struct skeleton *skel = vb2_get_drv_priv(vq);
241 /* TODO: start DMA */
245 * In case of an error, return all active buffers to the
248 return_all_buffers(skel, VB2_BUF_STATE_QUEUED);
254 * Stop the DMA engine. Any remaining buffers in the DMA queue are dequeued
255 * and passed on to the vb2 framework marked as STATE_ERROR.
257 static int stop_streaming(struct vb2_queue *vq)
259 struct skeleton *skel = vb2_get_drv_priv(vq);
263 /* Release all active buffers */
264 return_all_buffers(skel, VB2_BUF_STATE_ERROR);
269 * The vb2 queue ops. Note that since q->lock is set we can use the standard
270 * vb2_ops_wait_prepare/finish helper functions. If q->lock would be NULL,
271 * then this driver would have to provide these ops.
273 static struct vb2_ops skel_qops = {
274 .queue_setup = queue_setup,
275 .buf_prepare = buffer_prepare,
276 .buf_queue = buffer_queue,
277 .start_streaming = start_streaming,
278 .stop_streaming = stop_streaming,
279 .wait_prepare = vb2_ops_wait_prepare,
280 .wait_finish = vb2_ops_wait_finish,
284 * Required ioctl querycap. Note that the version field is prefilled with
285 * the version of the kernel.
287 static int skeleton_querycap(struct file *file, void *priv,
288 struct v4l2_capability *cap)
290 struct skeleton *skel = video_drvdata(file);
292 strlcpy(cap->driver, KBUILD_MODNAME, sizeof(cap->driver));
293 strlcpy(cap->card, "V4L2 PCI Skeleton", sizeof(cap->card));
294 snprintf(cap->bus_info, sizeof(cap->bus_info), "PCI:%s",
295 pci_name(skel->pdev));
296 cap->device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_READWRITE |
298 cap->capabilities = cap->device_caps | V4L2_CAP_DEVICE_CAPS;
303 * Helper function to check and correct struct v4l2_pix_format. It's used
304 * not only in VIDIOC_TRY/S_FMT, but also elsewhere if changes to the SDTV
305 * standard, HDTV timings or the video input would require updating the
308 static void skeleton_fill_pix_format(struct skeleton *skel,
309 struct v4l2_pix_format *pix)
311 pix->pixelformat = V4L2_PIX_FMT_YUYV;
312 if (skel->input == 0) {
315 pix->height = (skel->std & V4L2_STD_525_60) ? 480 : 576;
316 pix->field = V4L2_FIELD_INTERLACED;
317 pix->colorspace = V4L2_COLORSPACE_SMPTE170M;
320 pix->width = skel->timings.bt.width;
321 pix->height = skel->timings.bt.height;
322 if (skel->timings.bt.interlaced)
323 pix->field = V4L2_FIELD_INTERLACED;
325 pix->field = V4L2_FIELD_NONE;
326 pix->colorspace = V4L2_COLORSPACE_REC709;
330 * The YUYV format is four bytes for every two pixels, so bytesperline
333 pix->bytesperline = pix->width * 2;
334 pix->sizeimage = pix->bytesperline * pix->height;
338 static int skeleton_try_fmt_vid_cap(struct file *file, void *priv,
339 struct v4l2_format *f)
341 struct skeleton *skel = video_drvdata(file);
342 struct v4l2_pix_format *pix = &f->fmt.pix;
345 * Due to historical reasons providing try_fmt with an unsupported
346 * pixelformat will return -EINVAL for video receivers. Webcam drivers,
347 * however, will silently correct the pixelformat. Some video capture
348 * applications rely on this behavior...
350 if (pix->pixelformat != V4L2_PIX_FMT_YUYV)
352 skeleton_fill_pix_format(skel, pix);
356 static int skeleton_s_fmt_vid_cap(struct file *file, void *priv,
357 struct v4l2_format *f)
359 struct skeleton *skel = video_drvdata(file);
362 ret = skeleton_try_fmt_vid_cap(file, priv, f);
367 * It is not allowed to change the format while buffers for use with
368 * streaming have already been allocated.
370 if (vb2_is_busy(&skel->queue))
373 /* TODO: change format */
374 skel->format = f->fmt.pix;
378 static int skeleton_g_fmt_vid_cap(struct file *file, void *priv,
379 struct v4l2_format *f)
381 struct skeleton *skel = video_drvdata(file);
383 f->fmt.pix = skel->format;
387 static int skeleton_enum_fmt_vid_cap(struct file *file, void *priv,
388 struct v4l2_fmtdesc *f)
393 strlcpy(f->description, "4:2:2, packed, YUYV", sizeof(f->description));
394 f->pixelformat = V4L2_PIX_FMT_YUYV;
399 static int skeleton_s_std(struct file *file, void *priv, v4l2_std_id std)
401 struct skeleton *skel = video_drvdata(file);
403 /* S_STD is not supported on the HDMI input */
408 * No change, so just return. Some applications call S_STD again after
409 * the buffers for streaming have been set up, so we have to allow for
412 if (std == skel->std)
416 * Changing the standard implies a format change, which is not allowed
417 * while buffers for use with streaming have already been allocated.
419 if (vb2_is_busy(&skel->queue))
422 /* TODO: handle changing std */
426 /* Update the internal format */
427 skeleton_fill_pix_format(skel, &skel->format);
431 static int skeleton_g_std(struct file *file, void *priv, v4l2_std_id *std)
433 struct skeleton *skel = video_drvdata(file);
435 /* G_STD is not supported on the HDMI input */
444 * Query the current standard as seen by the hardware. This function shall
445 * never actually change the standard, it just detects and reports.
446 * The framework will initially set *std to tvnorms (i.e. the set of
447 * supported standards by this input), and this function should just AND
448 * this value. If there is no signal, then *std should be set to 0.
450 static int skeleton_querystd(struct file *file, void *priv, v4l2_std_id *std)
452 struct skeleton *skel = video_drvdata(file);
454 /* QUERY_STD is not supported on the HDMI input */
460 * Query currently seen standard. Initial value of *std is
461 * V4L2_STD_ALL. This function should look something like this:
468 /* Use signal information to reduce the number of possible standards */
469 if (signal_has_525_lines)
470 *std &= V4L2_STD_525_60;
472 *std &= V4L2_STD_625_50;
477 static int skeleton_s_dv_timings(struct file *file, void *_fh,
478 struct v4l2_dv_timings *timings)
480 struct skeleton *skel = video_drvdata(file);
482 /* S_DV_TIMINGS is not supported on the S-Video input */
483 if (skel->input == 0)
486 /* Quick sanity check */
487 if (!v4l2_valid_dv_timings(timings, &skel_timings_cap, NULL, NULL))
490 /* Check if the timings are part of the CEA-861 timings. */
491 if (!v4l2_find_dv_timings_cap(timings, &skel_timings_cap,
495 /* Return 0 if the new timings are the same as the current timings. */
496 if (v4l2_match_dv_timings(timings, &skel->timings, 0))
500 * Changing the timings implies a format change, which is not allowed
501 * while buffers for use with streaming have already been allocated.
503 if (vb2_is_busy(&skel->queue))
506 /* TODO: Configure new timings */
509 skel->timings = *timings;
511 /* Update the internal format */
512 skeleton_fill_pix_format(skel, &skel->format);
516 static int skeleton_g_dv_timings(struct file *file, void *_fh,
517 struct v4l2_dv_timings *timings)
519 struct skeleton *skel = video_drvdata(file);
521 /* G_DV_TIMINGS is not supported on the S-Video input */
522 if (skel->input == 0)
525 *timings = skel->timings;
529 static int skeleton_enum_dv_timings(struct file *file, void *_fh,
530 struct v4l2_enum_dv_timings *timings)
532 struct skeleton *skel = video_drvdata(file);
534 /* ENUM_DV_TIMINGS is not supported on the S-Video input */
535 if (skel->input == 0)
538 return v4l2_enum_dv_timings_cap(timings, &skel_timings_cap,
543 * Query the current timings as seen by the hardware. This function shall
544 * never actually change the timings, it just detects and reports.
545 * If no signal is detected, then return -ENOLINK. If the hardware cannot
546 * lock to the signal, then return -ENOLCK. If the signal is out of range
547 * of the capabilities of the system (e.g., it is possible that the receiver
548 * can lock but that the DMA engine it is connected to cannot handle
549 * pixelclocks above a certain frequency), then -ERANGE is returned.
551 static int skeleton_query_dv_timings(struct file *file, void *_fh,
552 struct v4l2_dv_timings *timings)
554 struct skeleton *skel = video_drvdata(file);
556 /* QUERY_DV_TIMINGS is not supported on the S-Video input */
557 if (skel->input == 0)
562 * Query currently seen timings. This function should look
563 * something like this:
568 if (cannot_lock_to_signal)
570 if (signal_out_of_range_of_capabilities)
573 /* Useful for debugging */
574 v4l2_print_dv_timings(skel->v4l2_dev.name, "query_dv_timings:",
580 static int skeleton_dv_timings_cap(struct file *file, void *fh,
581 struct v4l2_dv_timings_cap *cap)
583 struct skeleton *skel = video_drvdata(file);
585 /* DV_TIMINGS_CAP is not supported on the S-Video input */
586 if (skel->input == 0)
588 *cap = skel_timings_cap;
592 static int skeleton_enum_input(struct file *file, void *priv,
593 struct v4l2_input *i)
598 i->type = V4L2_INPUT_TYPE_CAMERA;
600 i->std = SKEL_TVNORMS;
601 strlcpy(i->name, "S-Video", sizeof(i->name));
602 i->capabilities = V4L2_IN_CAP_STD;
605 strlcpy(i->name, "HDMI", sizeof(i->name));
606 i->capabilities = V4L2_IN_CAP_DV_TIMINGS;
611 static int skeleton_s_input(struct file *file, void *priv, unsigned int i)
613 struct skeleton *skel = video_drvdata(file);
619 * Changing the input implies a format change, which is not allowed
620 * while buffers for use with streaming have already been allocated.
622 if (vb2_is_busy(&skel->queue))
627 * Update tvnorms. The tvnorms value is used by the core to implement
628 * VIDIOC_ENUMSTD so it has to be correct. If tvnorms == 0, then
629 * ENUMSTD will return -ENODATA.
631 skel->vdev.tvnorms = i ? 0 : SKEL_TVNORMS;
633 /* Update the internal format */
634 skeleton_fill_pix_format(skel, &skel->format);
638 static int skeleton_g_input(struct file *file, void *priv, unsigned int *i)
640 struct skeleton *skel = video_drvdata(file);
646 /* The control handler. */
647 static int skeleton_s_ctrl(struct v4l2_ctrl *ctrl)
649 /*struct skeleton *skel =
650 container_of(ctrl->handler, struct skeleton, ctrl_handler);*/
653 case V4L2_CID_BRIGHTNESS:
654 /* TODO: set brightness to ctrl->val */
656 case V4L2_CID_CONTRAST:
657 /* TODO: set contrast to ctrl->val */
659 case V4L2_CID_SATURATION:
660 /* TODO: set saturation to ctrl->val */
663 /* TODO: set hue to ctrl->val */
671 /* ------------------------------------------------------------------
672 File operations for the device
673 ------------------------------------------------------------------*/
675 static const struct v4l2_ctrl_ops skel_ctrl_ops = {
676 .s_ctrl = skeleton_s_ctrl,
680 * The set of all supported ioctls. Note that all the streaming ioctls
681 * use the vb2 helper functions that take care of all the locking and
682 * that also do ownership tracking (i.e. only the filehandle that requested
683 * the buffers can call the streaming ioctls, all other filehandles will
684 * receive -EBUSY if they attempt to call the same streaming ioctls).
686 * The last three ioctls also use standard helper functions: these implement
687 * standard behavior for drivers with controls.
689 static const struct v4l2_ioctl_ops skel_ioctl_ops = {
690 .vidioc_querycap = skeleton_querycap,
691 .vidioc_try_fmt_vid_cap = skeleton_try_fmt_vid_cap,
692 .vidioc_s_fmt_vid_cap = skeleton_s_fmt_vid_cap,
693 .vidioc_g_fmt_vid_cap = skeleton_g_fmt_vid_cap,
694 .vidioc_enum_fmt_vid_cap = skeleton_enum_fmt_vid_cap,
696 .vidioc_g_std = skeleton_g_std,
697 .vidioc_s_std = skeleton_s_std,
698 .vidioc_querystd = skeleton_querystd,
700 .vidioc_s_dv_timings = skeleton_s_dv_timings,
701 .vidioc_g_dv_timings = skeleton_g_dv_timings,
702 .vidioc_enum_dv_timings = skeleton_enum_dv_timings,
703 .vidioc_query_dv_timings = skeleton_query_dv_timings,
704 .vidioc_dv_timings_cap = skeleton_dv_timings_cap,
706 .vidioc_enum_input = skeleton_enum_input,
707 .vidioc_g_input = skeleton_g_input,
708 .vidioc_s_input = skeleton_s_input,
710 .vidioc_reqbufs = vb2_ioctl_reqbufs,
711 .vidioc_create_bufs = vb2_ioctl_create_bufs,
712 .vidioc_querybuf = vb2_ioctl_querybuf,
713 .vidioc_qbuf = vb2_ioctl_qbuf,
714 .vidioc_dqbuf = vb2_ioctl_dqbuf,
715 .vidioc_expbuf = vb2_ioctl_expbuf,
716 .vidioc_streamon = vb2_ioctl_streamon,
717 .vidioc_streamoff = vb2_ioctl_streamoff,
719 .vidioc_log_status = v4l2_ctrl_log_status,
720 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
721 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
725 * The set of file operations. Note that all these ops are standard core
728 static const struct v4l2_file_operations skel_fops = {
729 .owner = THIS_MODULE,
730 .open = v4l2_fh_open,
731 .release = vb2_fop_release,
732 .unlocked_ioctl = video_ioctl2,
733 .read = vb2_fop_read,
734 .mmap = vb2_fop_mmap,
735 .poll = vb2_fop_poll,
739 * The initial setup of this device instance. Note that the initial state of
740 * the driver should be complete. So the initial format, standard, timings
741 * and video input should all be initialized to some reasonable value.
743 static int skeleton_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
745 /* The initial timings are chosen to be 720p60. */
746 static const struct v4l2_dv_timings timings_def =
747 V4L2_DV_BT_CEA_1280X720P60;
748 struct skeleton *skel;
749 struct video_device *vdev;
750 struct v4l2_ctrl_handler *hdl;
755 ret = pci_enable_device(pdev);
758 ret = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
760 dev_err(&pdev->dev, "no suitable DMA available.\n");
764 /* Allocate a new instance */
765 skel = devm_kzalloc(&pdev->dev, sizeof(struct skeleton), GFP_KERNEL);
769 /* Allocate the interrupt */
770 ret = devm_request_irq(&pdev->dev, pdev->irq,
771 skeleton_irq, 0, KBUILD_MODNAME, skel);
773 dev_err(&pdev->dev, "request_irq failed\n");
778 /* Fill in the initial format-related settings */
779 skel->timings = timings_def;
780 skel->std = V4L2_STD_625_50;
781 skeleton_fill_pix_format(skel, &skel->format);
783 /* Initialize the top-level structure */
784 ret = v4l2_device_register(&pdev->dev, &skel->v4l2_dev);
788 mutex_init(&skel->lock);
790 /* Add the controls */
791 hdl = &skel->ctrl_handler;
792 v4l2_ctrl_handler_init(hdl, 4);
793 v4l2_ctrl_new_std(hdl, &skel_ctrl_ops,
794 V4L2_CID_BRIGHTNESS, 0, 255, 1, 127);
795 v4l2_ctrl_new_std(hdl, &skel_ctrl_ops,
796 V4L2_CID_CONTRAST, 0, 255, 1, 16);
797 v4l2_ctrl_new_std(hdl, &skel_ctrl_ops,
798 V4L2_CID_SATURATION, 0, 255, 1, 127);
799 v4l2_ctrl_new_std(hdl, &skel_ctrl_ops,
800 V4L2_CID_HUE, -128, 127, 1, 0);
805 skel->v4l2_dev.ctrl_handler = hdl;
807 /* Initialize the vb2 queue */
809 q->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
810 q->io_modes = VB2_MMAP | VB2_DMABUF | VB2_READ;
812 q->buf_struct_size = sizeof(struct skel_buffer);
814 q->mem_ops = &vb2_dma_contig_memops;
815 q->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
817 * Assume that this DMA engine needs to have at least two buffers
818 * available before it can be started. The start_streaming() op
819 * won't be called until at least this many buffers are queued up.
821 q->min_buffers_needed = 2;
823 * The serialization lock for the streaming ioctls. This is the same
824 * as the main serialization lock, but if some of the non-streaming
825 * ioctls could take a long time to execute, then you might want to
826 * have a different lock here to prevent VIDIOC_DQBUF from being
827 * blocked while waiting for another action to finish. This is
828 * generally not needed for PCI devices, but USB devices usually do
829 * want a separate lock here.
831 q->lock = &skel->lock;
833 * Since this driver can only do 32-bit DMA we must make sure that
834 * the vb2 core will allocate the buffers in 32-bit DMA memory.
836 q->gfp_flags = GFP_DMA32;
837 ret = vb2_queue_init(q);
841 skel->alloc_ctx = vb2_dma_contig_init_ctx(&pdev->dev);
842 if (IS_ERR(skel->alloc_ctx)) {
843 dev_err(&pdev->dev, "Can't allocate buffer context");
844 ret = PTR_ERR(skel->alloc_ctx);
847 INIT_LIST_HEAD(&skel->buf_list);
848 spin_lock_init(&skel->qlock);
850 /* Initialize the video_device structure */
852 strlcpy(vdev->name, KBUILD_MODNAME, sizeof(vdev->name));
854 * There is nothing to clean up, so release is set to an empty release
855 * function. The release callback must be non-NULL.
857 vdev->release = video_device_release_empty;
858 vdev->fops = &skel_fops,
859 vdev->ioctl_ops = &skel_ioctl_ops,
861 * The main serialization lock. All ioctls are serialized by this
862 * lock. Exception: if q->lock is set, then the streaming ioctls
863 * are serialized by that separate lock.
865 vdev->lock = &skel->lock;
867 vdev->v4l2_dev = &skel->v4l2_dev;
868 /* Supported SDTV standards, if any */
869 vdev->tvnorms = SKEL_TVNORMS;
870 /* If this bit is set, then the v4l2 core will provide the support
871 * for the VIDIOC_G/S_PRIORITY ioctls. This flag will eventually
872 * go away once all drivers have been converted to use struct v4l2_fh.
874 set_bit(V4L2_FL_USE_FH_PRIO, &vdev->flags);
875 video_set_drvdata(vdev, skel);
877 ret = video_register_device(vdev, VFL_TYPE_GRABBER, -1);
881 dev_info(&pdev->dev, "V4L2 PCI Skeleton Driver loaded\n");
885 vb2_dma_contig_cleanup_ctx(skel->alloc_ctx);
887 v4l2_ctrl_handler_free(&skel->ctrl_handler);
888 v4l2_device_unregister(&skel->v4l2_dev);
890 pci_disable_device(pdev);
894 static void skeleton_remove(struct pci_dev *pdev)
896 struct v4l2_device *v4l2_dev = pci_get_drvdata(pdev);
897 struct skeleton *skel = container_of(v4l2_dev, struct skeleton, v4l2_dev);
899 video_unregister_device(&skel->vdev);
900 v4l2_ctrl_handler_free(&skel->ctrl_handler);
901 vb2_dma_contig_cleanup_ctx(skel->alloc_ctx);
902 v4l2_device_unregister(&skel->v4l2_dev);
903 pci_disable_device(skel->pdev);
906 static struct pci_driver skeleton_driver = {
907 .name = KBUILD_MODNAME,
908 .probe = skeleton_probe,
909 .remove = skeleton_remove,
910 .id_table = skeleton_pci_tbl,
913 module_pci_driver(skeleton_driver);