Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 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 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 12 | #include <linux/poll.h> |
| 13 | #include <linux/fs.h> |
| 14 | #include <linux/device.h> |
| 15 | #include <linux/mutex.h> |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 16 | #include <linux/videodev2.h> |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 17 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 18 | #define VIDEO_MAJOR 81 |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame^] | 19 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 20 | /* Minor device allocation */ |
| 21 | #define MINOR_VFL_TYPE_GRABBER_MIN 0 |
| 22 | #define MINOR_VFL_TYPE_GRABBER_MAX 63 |
| 23 | #define MINOR_VFL_TYPE_RADIO_MIN 64 |
| 24 | #define MINOR_VFL_TYPE_RADIO_MAX 127 |
| 25 | #define MINOR_VFL_TYPE_VTX_MIN 192 |
| 26 | #define MINOR_VFL_TYPE_VTX_MAX 223 |
| 27 | #define MINOR_VFL_TYPE_VBI_MIN 224 |
| 28 | #define MINOR_VFL_TYPE_VBI_MAX 255 |
| 29 | |
| 30 | #define VFL_TYPE_GRABBER 0 |
| 31 | #define VFL_TYPE_VBI 1 |
| 32 | #define VFL_TYPE_RADIO 2 |
| 33 | #define VFL_TYPE_VTX 3 |
| 34 | |
Hans Verkuil | a399810 | 2008-07-21 02:57:38 -0300 | [diff] [blame] | 35 | struct v4l2_ioctl_callbacks; |
| 36 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 37 | /* |
| 38 | * Newer version of video_device, handled by videodev2.c |
| 39 | * This version moves redundant code from video device code to |
| 40 | * the common handler |
| 41 | */ |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 42 | |
| 43 | struct video_device |
| 44 | { |
| 45 | /* device ops */ |
Mauro Carvalho Chehab | 5e87efa | 2006-06-05 10:26:32 -0300 | [diff] [blame] | 46 | const struct file_operations *fops; |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 47 | |
Kay Sievers | 54bd5b6 | 2007-10-08 16:26:13 -0300 | [diff] [blame] | 48 | /* sysfs */ |
Hans Verkuil | 22a04f1 | 2008-07-20 06:35:02 -0300 | [diff] [blame] | 49 | struct device dev; /* v4l device */ |
Hans Verkuil | 5e85e73 | 2008-07-20 06:31:39 -0300 | [diff] [blame] | 50 | struct device *parent; /* device parent */ |
Kay Sievers | 54bd5b6 | 2007-10-08 16:26:13 -0300 | [diff] [blame] | 51 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 52 | /* device info */ |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 53 | char name[32]; |
Hans Verkuil | 0ea6bc8 | 2008-07-26 08:26:43 -0300 | [diff] [blame] | 54 | int vfl_type; |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 55 | int minor; |
Hans Verkuil | de1e575 | 2008-07-26 08:37:58 -0300 | [diff] [blame] | 56 | /* attribute to differentiate multiple indices on one physical device */ |
brandon@ifup.org | 539a755 | 2008-06-20 22:58:53 -0300 | [diff] [blame] | 57 | int index; |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 58 | |
Hans Verkuil | 22a04f1 | 2008-07-20 06:35:02 -0300 | [diff] [blame] | 59 | int debug; /* Activates debug level*/ |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 60 | |
| 61 | /* Video standard vars */ |
Mauro Carvalho Chehab | e75f9ce | 2006-11-20 13:19:20 -0300 | [diff] [blame] | 62 | v4l2_std_id tvnorms; /* Supported tv norms */ |
| 63 | v4l2_std_id current_norm; /* Current tvnorm */ |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 64 | |
| 65 | /* callbacks */ |
| 66 | void (*release)(struct video_device *vfd); |
| 67 | |
| 68 | /* ioctl callbacks */ |
Hans Verkuil | a399810 | 2008-07-21 02:57:38 -0300 | [diff] [blame] | 69 | const struct v4l2_ioctl_ops *ioctl_ops; |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 70 | }; |
| 71 | |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame^] | 72 | /* dev to video-device */ |
Hans Verkuil | 22a04f1 | 2008-07-20 06:35:02 -0300 | [diff] [blame] | 73 | #define to_video_device(cd) container_of(cd, struct video_device, dev) |
Linus Torvalds | e90ff92 | 2007-09-13 21:09:01 -0300 | [diff] [blame] | 74 | |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame^] | 75 | /* Register and unregister devices. Note that if video_register_device fails, |
| 76 | the release() callback of the video_device structure is *not* called, so |
| 77 | the caller is responsible for freeing any data. Usually that means that |
| 78 | you call video_device_release() on failure. */ |
Hans Verkuil | e138c59 | 2008-08-23 06:38:11 -0300 | [diff] [blame] | 79 | int __must_check video_register_device(struct video_device *vfd, int type, int nr); |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame^] | 80 | int __must_check video_register_device_index(struct video_device *vfd, |
| 81 | int type, int nr, int index); |
| 82 | void video_unregister_device(struct video_device *vfd); |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 83 | |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame^] | 84 | /* helper functions to alloc/release struct video_device, the |
| 85 | latter can also be used for video_device->release(). */ |
Hans Verkuil | e138c59 | 2008-08-23 06:38:11 -0300 | [diff] [blame] | 86 | struct video_device * __must_check video_device_alloc(void); |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame^] | 87 | |
Hans Verkuil | f9e86b5 | 2008-08-23 05:47:41 -0300 | [diff] [blame] | 88 | /* this release function frees the vfd pointer */ |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 89 | void video_device_release(struct video_device *vfd); |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame^] | 90 | |
Hans Verkuil | f9e86b5 | 2008-08-23 05:47:41 -0300 | [diff] [blame] | 91 | /* this release function does nothing, use when the video_device is a |
| 92 | static global struct. Note that having a static video_device is |
| 93 | a dubious construction at best. */ |
| 94 | void video_device_release_empty(struct video_device *vfd); |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 95 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 96 | /* helper functions to access driver private data. */ |
| 97 | static inline void *video_get_drvdata(struct video_device *dev) |
| 98 | { |
Hans Verkuil | 601e944 | 2008-08-23 07:24:07 -0300 | [diff] [blame] | 99 | return dev_get_drvdata(&dev->dev); |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | static inline void video_set_drvdata(struct video_device *dev, void *data) |
| 103 | { |
Hans Verkuil | 601e944 | 2008-08-23 07:24:07 -0300 | [diff] [blame] | 104 | dev_set_drvdata(&dev->dev, data); |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 105 | } |
Mauro Carvalho Chehab | 38ee04f | 2006-08-08 09:10:01 -0300 | [diff] [blame] | 106 | |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame^] | 107 | struct video_device *video_devdata(struct file *file); |
| 108 | |
| 109 | /* Combine video_get_drvdata and video_devdata as this is |
| 110 | used very often. */ |
| 111 | static inline void *video_drvdata(struct file *file) |
| 112 | { |
| 113 | return video_get_drvdata(video_devdata(file)); |
| 114 | } |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 115 | |
| 116 | #endif /* _V4L2_DEV_H */ |