[media] v4l: Fix media_entity_to_video_device macro argument name
[linux-2.6.git] / include / media / v4l2-dev.h
index 4c5d66e..c7c40f1 100644 (file)
@@ -9,71 +9,65 @@
 #ifndef _V4L2_DEV_H
 #define _V4L2_DEV_H
 
-#define OBSOLETE_OWNER   1 /* to be removed soon */
-#define OBSOLETE_DEVDATA 1 /* to be removed soon */
-
 #include <linux/poll.h>
 #include <linux/fs.h>
 #include <linux/device.h>
+#include <linux/cdev.h>
 #include <linux/mutex.h>
-#include <linux/compiler.h> /* need __user */
-#ifdef CONFIG_VIDEO_V4L1_COMPAT
-#include <linux/videodev.h>
-#else
 #include <linux/videodev2.h>
-#endif
+
+#include <media/media-entity.h>
 
 #define VIDEO_MAJOR    81
-/* Minor device allocation */
-#define MINOR_VFL_TYPE_GRABBER_MIN   0
-#define MINOR_VFL_TYPE_GRABBER_MAX  63
-#define MINOR_VFL_TYPE_RADIO_MIN    64
-#define MINOR_VFL_TYPE_RADIO_MAX   127
-#define MINOR_VFL_TYPE_VTX_MIN     192
-#define MINOR_VFL_TYPE_VTX_MAX     223
-#define MINOR_VFL_TYPE_VBI_MIN     224
-#define MINOR_VFL_TYPE_VBI_MAX     255
 
 #define VFL_TYPE_GRABBER       0
 #define VFL_TYPE_VBI           1
 #define VFL_TYPE_RADIO         2
-#define VFL_TYPE_VTX           3
+#define VFL_TYPE_SUBDEV                3
+#define VFL_TYPE_MAX           4
+
+struct v4l2_ioctl_callbacks;
+struct video_device;
+struct v4l2_device;
+struct v4l2_ctrl_handler;
+
+/* Flag to mark the video_device struct as registered.
+   Drivers can clear this flag if they want to block all future
+   device access. It is cleared by video_unregister_device. */
+#define V4L2_FL_REGISTERED     (0)
+/* file->private_data points to struct v4l2_fh */
+#define V4L2_FL_USES_V4L2_FH   (1)
+/* Use the prio field of v4l2_fh for core priority checking */
+#define V4L2_FL_USE_FH_PRIO    (2)
 
-/*  Video standard functions  */
-extern unsigned int v4l2_video_std_fps(struct v4l2_standard *vs);
-extern char *v4l2_norm_to_name(v4l2_std_id id);
-extern int v4l2_video_std_construct(struct v4l2_standard *vs,
-                                   int id, char *name);
+/* Priority helper functions */
 
-/* prority handling */
 struct v4l2_prio_state {
        atomic_t prios[4];
 };
-int v4l2_prio_init(struct v4l2_prio_state *global);
+
+void v4l2_prio_init(struct v4l2_prio_state *global);
 int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
                     enum v4l2_priority new);
-int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
-int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local);
+void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
+void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local);
 enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
-int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local);
-
-/* names for fancy debug output */
-extern char *v4l2_field_names[];
-extern char *v4l2_type_names[];
-
-/*  Compatibility layer interface  --  v4l1-compat module */
-typedef int (*v4l2_kioctl)(struct inode *inode, struct file *file,
-                          unsigned int cmd, void *arg);
-#ifdef CONFIG_VIDEO_V4L1_COMPAT
-int v4l_compat_translate_ioctl(struct inode *inode, struct file *file,
-                              int cmd, void *arg, v4l2_kioctl driver_ioctl);
-#else
-#define v4l_compat_translate_ioctl(inode,file,cmd,arg,ioctl) -EINVAL
-#endif
-
-/* 32 Bits compatibility layer for 64 bits processors */
-extern long v4l_compat_ioctl32(struct file *file, unsigned int cmd,
-                               unsigned long arg);
+int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local);
+
+
+struct v4l2_file_operations {
+       struct module *owner;
+       ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
+       ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
+       unsigned int (*poll) (struct file *, struct poll_table_struct *);
+       long (*ioctl) (struct file *, unsigned int, unsigned long);
+       long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
+       unsigned long (*get_unmapped_area) (struct file *, unsigned long,
+                               unsigned long, unsigned long, unsigned long);
+       int (*mmap) (struct file *, struct vm_area_struct *);
+       int (*open) (struct file *);
+       int (*release) (struct file *);
+};
 
 /*
  * Newer version of video_device, handled by videodev2.c
@@ -83,319 +77,127 @@ extern long v4l_compat_ioctl32(struct file *file, unsigned int cmd,
 
 struct video_device
 {
+#if defined(CONFIG_MEDIA_CONTROLLER)
+       struct media_entity entity;
+#endif
        /* device ops */
-       const struct file_operations *fops;
+       const struct v4l2_file_operations *fops;
 
        /* sysfs */
-       struct device class_dev;        /* v4l device */
-       struct device *dev;             /* device parent */
+       struct device dev;              /* v4l device */
+       struct cdev *cdev;              /* character device */
+
+       /* Set either parent or v4l2_dev if your driver uses v4l2_device */
+       struct device *parent;          /* device parent */
+       struct v4l2_device *v4l2_dev;   /* v4l2_device parent */
+
+       /* Control handler associated with this device node. May be NULL. */
+       struct v4l2_ctrl_handler *ctrl_handler;
+
+       /* Priority state. If NULL, then v4l2_dev->prio will be used. */
+       struct v4l2_prio_state *prio;
 
        /* device info */
        char name[32];
-       int type;       /* v4l1 */
-       int type2;      /* v4l2 */
+       int vfl_type;
+       /* 'minor' is set to -1 if the registration failed */
        int minor;
+       u16 num;
+       /* use bitops to set/clear/test flags */
+       unsigned long flags;
+       /* attribute to differentiate multiple indices on one physical device */
+       int index;
 
-       int debug;      /* Activates debug level*/
+       /* V4L2 file handles */
+       spinlock_t              fh_lock; /* Lock for all v4l2_fhs */
+       struct list_head        fh_list; /* List of struct v4l2_fh */
+
+       int debug;                      /* Activates debug level*/
 
        /* Video standard vars */
        v4l2_std_id tvnorms;            /* Supported tv norms */
        v4l2_std_id current_norm;       /* Current tvnorm */
 
        /* callbacks */
-       void (*release)(struct video_device *vfd);
+       void (*release)(struct video_device *vdev);
 
        /* ioctl callbacks */
+       const struct v4l2_ioctl_ops *ioctl_ops;
 
-       /* VIDIOC_QUERYCAP handler */
-       int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap);
-
-       /* Priority handling */
-       int (*vidioc_g_priority)   (struct file *file, void *fh,
-                                   enum v4l2_priority *p);
-       int (*vidioc_s_priority)   (struct file *file, void *fh,
-                                   enum v4l2_priority p);
-
-       /* VIDIOC_ENUM_FMT handlers */
-       int (*vidioc_enum_fmt_cap)         (struct file *file, void *fh,
-                                           struct v4l2_fmtdesc *f);
-       int (*vidioc_enum_fmt_overlay)     (struct file *file, void *fh,
-                                           struct v4l2_fmtdesc *f);
-       int (*vidioc_enum_fmt_vbi)         (struct file *file, void *fh,
-                                           struct v4l2_fmtdesc *f);
-       int (*vidioc_enum_fmt_vbi_capture) (struct file *file, void *fh,
-                                           struct v4l2_fmtdesc *f);
-       int (*vidioc_enum_fmt_video_output)(struct file *file, void *fh,
-                                           struct v4l2_fmtdesc *f);
-       int (*vidioc_enum_fmt_output_overlay) (struct file *file, void *fh,
-                                           struct v4l2_fmtdesc *f);
-       int (*vidioc_enum_fmt_vbi_output)  (struct file *file, void *fh,
-                                           struct v4l2_fmtdesc *f);
-       int (*vidioc_enum_fmt_type_private)(struct file *file, void *fh,
-                                           struct v4l2_fmtdesc *f);
-
-       /* VIDIOC_G_FMT handlers */
-       int (*vidioc_g_fmt_cap)        (struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_g_fmt_overlay)    (struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_g_fmt_vbi)        (struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_g_fmt_vbi_output) (struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_g_fmt_vbi_capture)(struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_g_fmt_video_output)(struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_g_fmt_output_overlay) (struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_g_fmt_type_private)(struct file *file, void *fh,
-                                       struct v4l2_format *f);
-
-       /* VIDIOC_S_FMT handlers */
-       int (*vidioc_s_fmt_cap)        (struct file *file, void *fh,
-                                       struct v4l2_format *f);
-
-       int (*vidioc_s_fmt_overlay)    (struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_s_fmt_vbi)        (struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_s_fmt_vbi_output) (struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_s_fmt_vbi_capture)(struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_s_fmt_video_output)(struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_s_fmt_output_overlay) (struct file *file, void *fh,
-                                       struct v4l2_format *f);
-       int (*vidioc_s_fmt_type_private)(struct file *file, void *fh,
-                                       struct v4l2_format *f);
-
-       /* VIDIOC_TRY_FMT handlers */
-       int (*vidioc_try_fmt_cap)        (struct file *file, void *fh,
-                                         struct v4l2_format *f);
-       int (*vidioc_try_fmt_overlay)    (struct file *file, void *fh,
-                                         struct v4l2_format *f);
-       int (*vidioc_try_fmt_vbi)        (struct file *file, void *fh,
-                                         struct v4l2_format *f);
-       int (*vidioc_try_fmt_vbi_output) (struct file *file, void *fh,
-                                         struct v4l2_format *f);
-       int (*vidioc_try_fmt_vbi_capture)(struct file *file, void *fh,
-                                         struct v4l2_format *f);
-       int (*vidioc_try_fmt_video_output)(struct file *file, void *fh,
-                                         struct v4l2_format *f);
-       int (*vidioc_try_fmt_output_overlay)(struct file *file, void *fh,
-                                         struct v4l2_format *f);
-       int (*vidioc_try_fmt_type_private)(struct file *file, void *fh,
-                                         struct v4l2_format *f);
-
-       /* Buffer handlers */
-       int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b);
-       int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b);
-       int (*vidioc_qbuf)    (struct file *file, void *fh, struct v4l2_buffer *b);
-       int (*vidioc_dqbuf)   (struct file *file, void *fh, struct v4l2_buffer *b);
-
-
-       int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i);
-#ifdef CONFIG_VIDEO_V4L1_COMPAT
-                       /* buffer type is struct vidio_mbuf * */
-       int (*vidiocgmbuf)  (struct file *file, void *fh, struct video_mbuf *p);
-#endif
-       int (*vidioc_g_fbuf)   (struct file *file, void *fh,
-                               struct v4l2_framebuffer *a);
-       int (*vidioc_s_fbuf)   (struct file *file, void *fh,
-                               struct v4l2_framebuffer *a);
-
-               /* Stream on/off */
-       int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i);
-       int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i);
-
-               /* Standard handling
-                       G_STD and ENUMSTD are handled by videodev.c
-                */
-       int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id *norm);
-       int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a);
-
-               /* Input handling */
-       int (*vidioc_enum_input)(struct file *file, void *fh,
-                                struct v4l2_input *inp);
-       int (*vidioc_g_input)   (struct file *file, void *fh, unsigned int *i);
-       int (*vidioc_s_input)   (struct file *file, void *fh, unsigned int i);
-
-               /* Output handling */
-       int (*vidioc_enumoutput) (struct file *file, void *fh,
-                                 struct v4l2_output *a);
-       int (*vidioc_g_output)   (struct file *file, void *fh, unsigned int *i);
-       int (*vidioc_s_output)   (struct file *file, void *fh, unsigned int i);
-
-               /* Control handling */
-       int (*vidioc_queryctrl)        (struct file *file, void *fh,
-                                       struct v4l2_queryctrl *a);
-       int (*vidioc_g_ctrl)           (struct file *file, void *fh,
-                                       struct v4l2_control *a);
-       int (*vidioc_s_ctrl)           (struct file *file, void *fh,
-                                       struct v4l2_control *a);
-       int (*vidioc_g_ext_ctrls)      (struct file *file, void *fh,
-                                       struct v4l2_ext_controls *a);
-       int (*vidioc_s_ext_ctrls)      (struct file *file, void *fh,
-                                       struct v4l2_ext_controls *a);
-       int (*vidioc_try_ext_ctrls)    (struct file *file, void *fh,
-                                       struct v4l2_ext_controls *a);
-       int (*vidioc_querymenu)        (struct file *file, void *fh,
-                                       struct v4l2_querymenu *a);
-
-       /* Audio ioctls */
-       int (*vidioc_enumaudio)        (struct file *file, void *fh,
-                                       struct v4l2_audio *a);
-       int (*vidioc_g_audio)          (struct file *file, void *fh,
-                                       struct v4l2_audio *a);
-       int (*vidioc_s_audio)          (struct file *file, void *fh,
-                                       struct v4l2_audio *a);
-
-       /* Audio out ioctls */
-       int (*vidioc_enumaudout)       (struct file *file, void *fh,
-                                       struct v4l2_audioout *a);
-       int (*vidioc_g_audout)         (struct file *file, void *fh,
-                                       struct v4l2_audioout *a);
-       int (*vidioc_s_audout)         (struct file *file, void *fh,
-                                       struct v4l2_audioout *a);
-       int (*vidioc_g_modulator)      (struct file *file, void *fh,
-                                       struct v4l2_modulator *a);
-       int (*vidioc_s_modulator)      (struct file *file, void *fh,
-                                       struct v4l2_modulator *a);
-       /* Crop ioctls */
-       int (*vidioc_cropcap)          (struct file *file, void *fh,
-                                       struct v4l2_cropcap *a);
-       int (*vidioc_g_crop)           (struct file *file, void *fh,
-                                       struct v4l2_crop *a);
-       int (*vidioc_s_crop)           (struct file *file, void *fh,
-                                       struct v4l2_crop *a);
-       /* Compression ioctls */
-       int (*vidioc_g_mpegcomp)       (struct file *file, void *fh,
-                                       struct v4l2_mpeg_compression *a);
-       int (*vidioc_s_mpegcomp)       (struct file *file, void *fh,
-                                       struct v4l2_mpeg_compression *a);
-       int (*vidioc_g_jpegcomp)       (struct file *file, void *fh,
-                                       struct v4l2_jpegcompression *a);
-       int (*vidioc_s_jpegcomp)       (struct file *file, void *fh,
-                                       struct v4l2_jpegcompression *a);
-       int (*vidioc_g_enc_index)      (struct file *file, void *fh,
-                                       struct v4l2_enc_idx *a);
-       int (*vidioc_encoder_cmd)      (struct file *file, void *fh,
-                                       struct v4l2_encoder_cmd *a);
-       int (*vidioc_try_encoder_cmd)  (struct file *file, void *fh,
-                                       struct v4l2_encoder_cmd *a);
-
-       /* Stream type-dependent parameter ioctls */
-       int (*vidioc_g_parm)           (struct file *file, void *fh,
-                                       struct v4l2_streamparm *a);
-       int (*vidioc_s_parm)           (struct file *file, void *fh,
-                                       struct v4l2_streamparm *a);
-
-       /* Tuner ioctls */
-       int (*vidioc_g_tuner)          (struct file *file, void *fh,
-                                       struct v4l2_tuner *a);
-       int (*vidioc_s_tuner)          (struct file *file, void *fh,
-                                       struct v4l2_tuner *a);
-       int (*vidioc_g_frequency)      (struct file *file, void *fh,
-                                       struct v4l2_frequency *a);
-       int (*vidioc_s_frequency)      (struct file *file, void *fh,
-                                       struct v4l2_frequency *a);
-
-       /* Sliced VBI cap */
-       int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh,
-                                       struct v4l2_sliced_vbi_cap *a);
-
-       /* Log status ioctl */
-       int (*vidioc_log_status)       (struct file *file, void *fh);
-
-
-       /* Debugging ioctls */
-#ifdef CONFIG_VIDEO_ADV_DEBUG
-       int (*vidioc_g_register)       (struct file *file, void *fh,
-                                       struct v4l2_register *reg);
-       int (*vidioc_s_register)       (struct file *file, void *fh,
-                                       struct v4l2_register *reg);
-#endif
-       int (*vidioc_g_chip_ident)     (struct file *file, void *fh,
-                                       struct v4l2_chip_ident *chip);
-
-
-#ifdef OBSOLETE_OWNER /* to be removed soon */
-/* obsolete -- fops->owner is used instead */
-struct module *owner;
-/* dev->driver_data will be used instead some day.
-       * Use the video_{get|set}_drvdata() helper functions,
-       * so the switch over will be transparent for you.
-       * Or use {pci|usb}_{get|set}_drvdata() directly. */
-void *priv;
-#endif
-
-       /* for videodev.c intenal usage -- please don't touch */
-       int users;                     /* video_exclusive_{open|close} ... */
-       struct mutex lock;             /* ... helper function uses these   */
+       /* serialization lock */
+       struct mutex *lock;
 };
 
-/* Class-dev to video-device */
-#define to_video_device(cd) container_of(cd, struct video_device, class_dev)
+#define media_entity_to_video_device(__e) \
+       container_of(__e, struct video_device, entity)
+/* dev to video-device */
+#define to_video_device(cd) container_of(cd, struct video_device, dev)
+
+int __must_check __video_register_device(struct video_device *vdev, int type,
+               int nr, int warn_if_nr_in_use, struct module *owner);
+
+/* Register video devices. Note that if video_register_device fails,
+   the release() callback of the video_device structure is *not* called, so
+   the caller is responsible for freeing any data. Usually that means that
+   you call video_device_release() on failure. */
+static inline int __must_check video_register_device(struct video_device *vdev,
+               int type, int nr)
+{
+       return __video_register_device(vdev, type, nr, 1, vdev->fops->owner);
+}
+
+/* Same as video_register_device, but no warning is issued if the desired
+   device node number was already in use. */
+static inline int __must_check video_register_device_no_warn(
+               struct video_device *vdev, int type, int nr)
+{
+       return __video_register_device(vdev, type, nr, 0, vdev->fops->owner);
+}
 
-/* Version 2 functions */
-extern int video_register_device(struct video_device *vfd, int type, int nr);
-void video_unregister_device(struct video_device *);
-extern int video_ioctl2(struct inode *inode, struct file *file,
-                         unsigned int cmd, unsigned long arg);
+/* Unregister video devices. Will do nothing if vdev == NULL or
+   video_is_registered() returns false. */
+void video_unregister_device(struct video_device *vdev);
 
-/* helper functions to alloc / release struct video_device, the
-   later can be used for video_device->release() */
-struct video_device *video_device_alloc(void);
-void video_device_release(struct video_device *vfd);
+/* helper functions to alloc/release struct video_device, the
+   latter can also be used for video_device->release(). */
+struct video_device * __must_check video_device_alloc(void);
 
-/* Include support for obsoleted stuff */
-extern int video_usercopy(struct inode *inode, struct file *file,
-                         unsigned int cmd, unsigned long arg,
-                         int (*func)(struct inode *inode, struct file *file,
-                                     unsigned int cmd, void *arg));
+/* this release function frees the vdev pointer */
+void video_device_release(struct video_device *vdev);
 
-#ifdef CONFIG_VIDEO_V4L1_COMPAT
-#include <linux/mm.h>
+/* this release function does nothing, use when the video_device is a
+   static global struct. Note that having a static video_device is
+   a dubious construction at best. */
+void video_device_release_empty(struct video_device *vdev);
 
-static inline int __must_check
-video_device_create_file(struct video_device *vfd,
-                        struct device_attribute *attr)
+/* helper functions to access driver private data. */
+static inline void *video_get_drvdata(struct video_device *vdev)
 {
-       int ret = device_create_file(&vfd->class_dev, attr);
-       if (ret < 0)
-               printk(KERN_WARNING "%s error: %d\n", __FUNCTION__, ret);
-       return ret;
+       return dev_get_drvdata(&vdev->dev);
 }
-static inline void
-video_device_remove_file(struct video_device *vfd,
-                        struct device_attribute *attr)
+
+static inline void video_set_drvdata(struct video_device *vdev, void *data)
 {
-       device_remove_file(&vfd->class_dev, attr);
+       dev_set_drvdata(&vdev->dev, data);
 }
 
-#endif /* CONFIG_VIDEO_V4L1_COMPAT */
+struct video_device *video_devdata(struct file *file);
 
-#ifdef OBSOLETE_OWNER /* to be removed soon */
-/* helper functions to access driver private data. */
-static inline void *video_get_drvdata(struct video_device *dev)
+/* Combine video_get_drvdata and video_devdata as this is
+   used very often. */
+static inline void *video_drvdata(struct file *file)
 {
-       return dev->priv;
+       return video_get_drvdata(video_devdata(file));
 }
 
-static inline void video_set_drvdata(struct video_device *dev, void *data)
+static inline const char *video_device_node_name(struct video_device *vdev)
 {
-       dev->priv = data;
+       return dev_name(&vdev->dev);
 }
 
-#endif
-
-#ifdef OBSOLETE_DEVDATA /* to be removed soon */
-/* Obsolete stuff - Still needed for radio devices and obsolete drivers */
-extern struct video_device* video_devdata(struct file*);
-extern int video_exclusive_open(struct inode *inode, struct file *file);
-extern int video_exclusive_release(struct inode *inode, struct file *file);
-#endif
+static inline int video_is_registered(struct video_device *vdev)
+{
+       return test_bit(V4L2_FL_REGISTERED, &vdev->flags);
+}
 
 #endif /* _V4L2_DEV_H */