v4l2-dev.h 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. /*
  2. *
  3. * V 4 L 2 D R I V E R H E L P E R A P I
  4. *
  5. * Moved from videodev2.h
  6. *
  7. * Some commonly needed functions for drivers (v4l2-common.o module)
  8. */
  9. #ifndef _V4L2_DEV_H
  10. #define _V4L2_DEV_H
  11. #include <linux/poll.h>
  12. #include <linux/fs.h>
  13. #include <linux/device.h>
  14. #include <linux/cdev.h>
  15. #include <linux/mutex.h>
  16. #include <linux/videodev2.h>
  17. #include <media/media-entity.h>
  18. #define VIDEO_MAJOR 81
  19. #define VFL_TYPE_GRABBER 0
  20. #define VFL_TYPE_VBI 1
  21. #define VFL_TYPE_RADIO 2
  22. #define VFL_TYPE_SUBDEV 3
  23. #define VFL_TYPE_MAX 4
  24. /* Is this a receiver, transmitter or mem-to-mem? */
  25. /* Ignored for VFL_TYPE_SUBDEV. */
  26. #define VFL_DIR_RX 0
  27. #define VFL_DIR_TX 1
  28. #define VFL_DIR_M2M 2
  29. struct v4l2_ioctl_callbacks;
  30. struct video_device;
  31. struct v4l2_device;
  32. struct v4l2_ctrl_handler;
  33. /* Flag to mark the video_device struct as registered.
  34. Drivers can clear this flag if they want to block all future
  35. device access. It is cleared by video_unregister_device. */
  36. #define V4L2_FL_REGISTERED (0)
  37. /* file->private_data points to struct v4l2_fh */
  38. #define V4L2_FL_USES_V4L2_FH (1)
  39. /* Use the prio field of v4l2_fh for core priority checking */
  40. #define V4L2_FL_USE_FH_PRIO (2)
  41. /* Priority helper functions */
  42. struct v4l2_prio_state {
  43. atomic_t prios[4];
  44. };
  45. void v4l2_prio_init(struct v4l2_prio_state *global);
  46. int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
  47. enum v4l2_priority new);
  48. void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
  49. void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local);
  50. enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
  51. int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local);
  52. struct v4l2_file_operations {
  53. struct module *owner;
  54. ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
  55. ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
  56. unsigned int (*poll) (struct file *, struct poll_table_struct *);
  57. long (*ioctl) (struct file *, unsigned int, unsigned long);
  58. long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
  59. #ifdef CONFIG_COMPAT
  60. long (*compat_ioctl32) (struct file *, unsigned int, unsigned long);
  61. #endif
  62. unsigned long (*get_unmapped_area) (struct file *, unsigned long,
  63. unsigned long, unsigned long, unsigned long);
  64. int (*mmap) (struct file *, struct vm_area_struct *);
  65. int (*open) (struct file *);
  66. int (*release) (struct file *);
  67. };
  68. /*
  69. * Newer version of video_device, handled by videodev2.c
  70. * This version moves redundant code from video device code to
  71. * the common handler
  72. */
  73. struct video_device
  74. {
  75. #if defined(CONFIG_MEDIA_CONTROLLER)
  76. struct media_entity entity;
  77. #endif
  78. /* device ops */
  79. const struct v4l2_file_operations *fops;
  80. /* sysfs */
  81. struct device dev; /* v4l device */
  82. struct cdev *cdev; /* character device */
  83. struct v4l2_device *v4l2_dev; /* v4l2_device parent */
  84. /* Only set parent if that can't be deduced from v4l2_dev */
  85. struct device *dev_parent; /* device parent */
  86. /* Control handler associated with this device node. May be NULL. */
  87. struct v4l2_ctrl_handler *ctrl_handler;
  88. /* vb2_queue associated with this device node. May be NULL. */
  89. struct vb2_queue *queue;
  90. /* Priority state. If NULL, then v4l2_dev->prio will be used. */
  91. struct v4l2_prio_state *prio;
  92. /* device info */
  93. char name[32];
  94. int vfl_type; /* device type */
  95. int vfl_dir; /* receiver, transmitter or m2m */
  96. /* 'minor' is set to -1 if the registration failed */
  97. int minor;
  98. u16 num;
  99. /* use bitops to set/clear/test flags */
  100. unsigned long flags;
  101. /* attribute to differentiate multiple indices on one physical device */
  102. int index;
  103. /* V4L2 file handles */
  104. spinlock_t fh_lock; /* Lock for all v4l2_fhs */
  105. struct list_head fh_list; /* List of struct v4l2_fh */
  106. int debug; /* Activates debug level*/
  107. /* Video standard vars */
  108. v4l2_std_id tvnorms; /* Supported tv norms */
  109. /* callbacks */
  110. void (*release)(struct video_device *vdev);
  111. /* ioctl callbacks */
  112. const struct v4l2_ioctl_ops *ioctl_ops;
  113. DECLARE_BITMAP(valid_ioctls, BASE_VIDIOC_PRIVATE);
  114. /* serialization lock */
  115. DECLARE_BITMAP(disable_locking, BASE_VIDIOC_PRIVATE);
  116. struct mutex *lock;
  117. };
  118. #define media_entity_to_video_device(__e) \
  119. container_of(__e, struct video_device, entity)
  120. /* dev to video-device */
  121. #define to_video_device(cd) container_of(cd, struct video_device, dev)
  122. int __must_check __video_register_device(struct video_device *vdev, int type,
  123. int nr, int warn_if_nr_in_use, struct module *owner);
  124. /* Register video devices. Note that if video_register_device fails,
  125. the release() callback of the video_device structure is *not* called, so
  126. the caller is responsible for freeing any data. Usually that means that
  127. you call video_device_release() on failure. */
  128. static inline int __must_check video_register_device(struct video_device *vdev,
  129. int type, int nr)
  130. {
  131. return __video_register_device(vdev, type, nr, 1, vdev->fops->owner);
  132. }
  133. /* Same as video_register_device, but no warning is issued if the desired
  134. device node number was already in use. */
  135. static inline int __must_check video_register_device_no_warn(
  136. struct video_device *vdev, int type, int nr)
  137. {
  138. return __video_register_device(vdev, type, nr, 0, vdev->fops->owner);
  139. }
  140. /* Unregister video devices. Will do nothing if vdev == NULL or
  141. video_is_registered() returns false. */
  142. void video_unregister_device(struct video_device *vdev);
  143. /* helper functions to alloc/release struct video_device, the
  144. latter can also be used for video_device->release(). */
  145. struct video_device * __must_check video_device_alloc(void);
  146. /* this release function frees the vdev pointer */
  147. void video_device_release(struct video_device *vdev);
  148. /* this release function does nothing, use when the video_device is a
  149. static global struct. Note that having a static video_device is
  150. a dubious construction at best. */
  151. void video_device_release_empty(struct video_device *vdev);
  152. /* returns true if cmd is a known V4L2 ioctl */
  153. bool v4l2_is_known_ioctl(unsigned int cmd);
  154. /* mark that this command shouldn't use core locking */
  155. static inline void v4l2_disable_ioctl_locking(struct video_device *vdev, unsigned int cmd)
  156. {
  157. if (_IOC_NR(cmd) < BASE_VIDIOC_PRIVATE)
  158. set_bit(_IOC_NR(cmd), vdev->disable_locking);
  159. }
  160. /* Mark that this command isn't implemented. This must be called before
  161. video_device_register. See also the comments in determine_valid_ioctls().
  162. This function allows drivers to provide just one v4l2_ioctl_ops struct, but
  163. disable ioctls based on the specific card that is actually found. */
  164. static inline void v4l2_disable_ioctl(struct video_device *vdev, unsigned int cmd)
  165. {
  166. if (_IOC_NR(cmd) < BASE_VIDIOC_PRIVATE)
  167. set_bit(_IOC_NR(cmd), vdev->valid_ioctls);
  168. }
  169. /* helper functions to access driver private data. */
  170. static inline void *video_get_drvdata(struct video_device *vdev)
  171. {
  172. return dev_get_drvdata(&vdev->dev);
  173. }
  174. static inline void video_set_drvdata(struct video_device *vdev, void *data)
  175. {
  176. dev_set_drvdata(&vdev->dev, data);
  177. }
  178. struct video_device *video_devdata(struct file *file);
  179. /* Combine video_get_drvdata and video_devdata as this is
  180. used very often. */
  181. static inline void *video_drvdata(struct file *file)
  182. {
  183. return video_get_drvdata(video_devdata(file));
  184. }
  185. static inline const char *video_device_node_name(struct video_device *vdev)
  186. {
  187. return dev_name(&vdev->dev);
  188. }
  189. static inline int video_is_registered(struct video_device *vdev)
  190. {
  191. return test_bit(V4L2_FL_REGISTERED, &vdev->flags);
  192. }
  193. #endif /* _V4L2_DEV_H */