]>
Commit | Line | Data |
---|---|---|
2a1fcdf0 HV |
1 | /* |
2 | V4L2 sub-device support header. | |
3 | ||
4 | Copyright (C) 2008 Hans Verkuil <hverkuil@xs4all.nl> | |
5 | ||
6 | This program is free software; you can redistribute it and/or modify | |
7 | it under the terms of the GNU General Public License as published by | |
8 | the Free Software Foundation; either version 2 of the License, or | |
9 | (at your option) any later version. | |
10 | ||
11 | This program is distributed in the hope that it will be useful, | |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
17 | along with this program; if not, write to the Free Software | |
18 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
19 | */ | |
20 | ||
21 | #ifndef _V4L2_SUBDEV_H | |
22 | #define _V4L2_SUBDEV_H | |
23 | ||
24 | #include <media/v4l2-common.h> | |
25 | ||
26 | struct v4l2_device; | |
27 | struct v4l2_subdev; | |
28 | struct tuner_setup; | |
29 | ||
30 | /* Sub-devices are devices that are connected somehow to the main bridge | |
31 | device. These devices are usually audio/video muxers/encoders/decoders or | |
32 | sensors and webcam controllers. | |
33 | ||
34 | Usually these devices are controlled through an i2c bus, but other busses | |
35 | may also be used. | |
36 | ||
37 | The v4l2_subdev struct provides a way of accessing these devices in a | |
38 | generic manner. Most operations that these sub-devices support fall in | |
39 | a few categories: core ops, audio ops, video ops and tuner ops. | |
40 | ||
41 | More categories can be added if needed, although this should remain a | |
42 | limited set (no more than approx. 8 categories). | |
43 | ||
44 | Each category has its own set of ops that subdev drivers can implement. | |
45 | ||
46 | A subdev driver can leave the pointer to the category ops NULL if | |
47 | it does not implement them (e.g. an audio subdev will generally not | |
48 | implement the video category ops). The exception is the core category: | |
49 | this must always be present. | |
50 | ||
51 | These ops are all used internally so it is no problem to change, remove | |
52 | or add ops or move ops from one to another category. Currently these | |
53 | ops are based on the original ioctls, but since ops are not limited to | |
54 | one argument there is room for improvement here once all i2c subdev | |
55 | drivers are converted to use these ops. | |
56 | */ | |
57 | ||
58 | /* Core ops: it is highly recommended to implement at least these ops: | |
59 | ||
60 | g_chip_ident | |
61 | log_status | |
62 | g_register | |
63 | s_register | |
64 | ||
65 | This provides basic debugging support. | |
66 | ||
67 | The ioctl ops is meant for generic ioctl-like commands. Depending on | |
68 | the use-case it might be better to use subdev-specific ops (currently | |
69 | not yet implemented) since ops provide proper type-checking. | |
70 | */ | |
71 | struct v4l2_subdev_core_ops { | |
aecde8b5 | 72 | int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip); |
2a1fcdf0 HV |
73 | int (*log_status)(struct v4l2_subdev *sd); |
74 | int (*init)(struct v4l2_subdev *sd, u32 val); | |
75 | int (*s_standby)(struct v4l2_subdev *sd, u32 standby); | |
76 | int (*reset)(struct v4l2_subdev *sd, u32 val); | |
77 | int (*s_gpio)(struct v4l2_subdev *sd, u32 val); | |
78 | int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc); | |
79 | int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl); | |
80 | int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl); | |
952617f2 HV |
81 | int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); |
82 | int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); | |
83 | int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); | |
2a1fcdf0 | 84 | int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm); |
069b7479 | 85 | long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); |
2a1fcdf0 | 86 | #ifdef CONFIG_VIDEO_ADV_DEBUG |
aecde8b5 HV |
87 | int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); |
88 | int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); | |
2a1fcdf0 HV |
89 | #endif |
90 | }; | |
91 | ||
92 | struct v4l2_subdev_tuner_ops { | |
93 | int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type); | |
94 | int (*s_radio)(struct v4l2_subdev *sd); | |
95 | int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); | |
96 | int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); | |
97 | int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); | |
98 | int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); | |
99 | int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm); | |
100 | int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type); | |
101 | int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config); | |
102 | }; | |
103 | ||
104 | struct v4l2_subdev_audio_ops { | |
105 | int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq); | |
106 | int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq); | |
107 | int (*s_routing)(struct v4l2_subdev *sd, const struct v4l2_routing *route); | |
108 | }; | |
109 | ||
110 | struct v4l2_subdev_video_ops { | |
111 | int (*s_routing)(struct v4l2_subdev *sd, const struct v4l2_routing *route); | |
112 | int (*s_crystal_freq)(struct v4l2_subdev *sd, struct v4l2_crystal_freq *freq); | |
113 | int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line); | |
114 | int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data); | |
115 | int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data); | |
1fe2740f | 116 | int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap); |
2a1fcdf0 | 117 | int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std); |
1b6f1d96 HV |
118 | int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std); |
119 | int (*g_input_status)(struct v4l2_subdev *sd, u32 *status); | |
2a1fcdf0 HV |
120 | int (*s_stream)(struct v4l2_subdev *sd, int enable); |
121 | int (*s_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt); | |
122 | int (*g_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt); | |
123 | }; | |
124 | ||
125 | struct v4l2_subdev_ops { | |
126 | const struct v4l2_subdev_core_ops *core; | |
127 | const struct v4l2_subdev_tuner_ops *tuner; | |
128 | const struct v4l2_subdev_audio_ops *audio; | |
129 | const struct v4l2_subdev_video_ops *video; | |
130 | }; | |
131 | ||
132 | #define V4L2_SUBDEV_NAME_SIZE 32 | |
133 | ||
134 | /* Each instance of a subdev driver should create this struct, either | |
135 | stand-alone or embedded in a larger struct. | |
136 | */ | |
137 | struct v4l2_subdev { | |
138 | struct list_head list; | |
139 | struct module *owner; | |
b0167600 | 140 | struct v4l2_device *v4l2_dev; |
2a1fcdf0 HV |
141 | const struct v4l2_subdev_ops *ops; |
142 | /* name must be unique */ | |
143 | char name[V4L2_SUBDEV_NAME_SIZE]; | |
144 | /* can be used to group similar subdevs, value is driver-specific */ | |
145 | u32 grp_id; | |
146 | /* pointer to private data */ | |
147 | void *priv; | |
148 | }; | |
149 | ||
150 | static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p) | |
151 | { | |
152 | sd->priv = p; | |
153 | } | |
154 | ||
155 | static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd) | |
156 | { | |
157 | return sd->priv; | |
158 | } | |
159 | ||
160 | /* Convert an ioctl-type command to the proper v4l2_subdev_ops function call. | |
161 | This is used by subdev modules that can be called by both old-style ioctl | |
162 | commands and through the v4l2_subdev_ops. | |
163 | ||
164 | The ioctl API of the subdev driver can call this function to call the | |
165 | right ops based on the ioctl cmd and arg. | |
166 | ||
167 | Once all subdev drivers have been converted and all drivers no longer | |
168 | use the ioctl interface, then this function can be removed. | |
169 | */ | |
170 | int v4l2_subdev_command(struct v4l2_subdev *sd, unsigned cmd, void *arg); | |
171 | ||
172 | static inline void v4l2_subdev_init(struct v4l2_subdev *sd, | |
173 | const struct v4l2_subdev_ops *ops) | |
174 | { | |
175 | INIT_LIST_HEAD(&sd->list); | |
176 | /* ops->core MUST be set */ | |
177 | BUG_ON(!ops || !ops->core); | |
178 | sd->ops = ops; | |
b0167600 | 179 | sd->v4l2_dev = NULL; |
2a1fcdf0 HV |
180 | sd->name[0] = '\0'; |
181 | sd->grp_id = 0; | |
182 | sd->priv = NULL; | |
183 | } | |
184 | ||
185 | /* Call an ops of a v4l2_subdev, doing the right checks against | |
186 | NULL pointers. | |
187 | ||
188 | Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip); | |
189 | */ | |
190 | #define v4l2_subdev_call(sd, o, f, args...) \ | |
191 | (!(sd) ? -ENODEV : (((sd) && (sd)->ops->o && (sd)->ops->o->f) ? \ | |
192 | (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD)) | |
193 | ||
194 | #endif |