]>
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 | ||
29103119 | 24 | #include <linux/types.h> |
333c8b97 | 25 | #include <linux/v4l2-subdev.h> |
61f5db54 | 26 | #include <media/media-entity.h> |
e9e31049 | 27 | #include <media/v4l2-async.h> |
2a1fcdf0 | 28 | #include <media/v4l2-common.h> |
2096a5dc | 29 | #include <media/v4l2-dev.h> |
7cd5a16b | 30 | #include <media/v4l2-fh.h> |
9a74251d | 31 | #include <media/v4l2-mediabus.h> |
2a1fcdf0 | 32 | |
1d986add AW |
33 | /* generic v4l2_device notify callback notification values */ |
34 | #define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32) | |
35 | #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001 | |
36 | #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002 | |
37 | #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004 | |
38 | #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008 | |
39 | ||
40 | #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32) | |
41 | #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001 | |
42 | ||
2a1fcdf0 | 43 | struct v4l2_device; |
0996517c | 44 | struct v4l2_ctrl_handler; |
02adb1cc SA |
45 | struct v4l2_event_subscription; |
46 | struct v4l2_fh; | |
2a1fcdf0 | 47 | struct v4l2_subdev; |
f0beea8f | 48 | struct v4l2_subdev_fh; |
2a1fcdf0 | 49 | struct tuner_setup; |
29103119 | 50 | struct v4l2_mbus_frame_desc; |
2a1fcdf0 | 51 | |
78a3b4db HV |
52 | /* decode_vbi_line */ |
53 | struct v4l2_decode_vbi_line { | |
54 | u32 is_second_field; /* Set to 0 for the first (odd) field, | |
55 | set to 1 for the second (even) field. */ | |
56 | u8 *p; /* Pointer to the sliced VBI data from the decoder. | |
57 | On exit points to the start of the payload. */ | |
58 | u32 line; /* Line number of the sliced VBI data (1-23) */ | |
59 | u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */ | |
60 | }; | |
61 | ||
2a1fcdf0 HV |
62 | /* Sub-devices are devices that are connected somehow to the main bridge |
63 | device. These devices are usually audio/video muxers/encoders/decoders or | |
64 | sensors and webcam controllers. | |
65 | ||
66 | Usually these devices are controlled through an i2c bus, but other busses | |
67 | may also be used. | |
68 | ||
69 | The v4l2_subdev struct provides a way of accessing these devices in a | |
70 | generic manner. Most operations that these sub-devices support fall in | |
71 | a few categories: core ops, audio ops, video ops and tuner ops. | |
72 | ||
73 | More categories can be added if needed, although this should remain a | |
74 | limited set (no more than approx. 8 categories). | |
75 | ||
76 | Each category has its own set of ops that subdev drivers can implement. | |
77 | ||
78 | A subdev driver can leave the pointer to the category ops NULL if | |
79 | it does not implement them (e.g. an audio subdev will generally not | |
80 | implement the video category ops). The exception is the core category: | |
81 | this must always be present. | |
82 | ||
83 | These ops are all used internally so it is no problem to change, remove | |
84 | or add ops or move ops from one to another category. Currently these | |
85 | ops are based on the original ioctls, but since ops are not limited to | |
86 | one argument there is room for improvement here once all i2c subdev | |
87 | drivers are converted to use these ops. | |
88 | */ | |
89 | ||
90 | /* Core ops: it is highly recommended to implement at least these ops: | |
91 | ||
2a1fcdf0 HV |
92 | log_status |
93 | g_register | |
94 | s_register | |
95 | ||
96 | This provides basic debugging support. | |
97 | ||
98 | The ioctl ops is meant for generic ioctl-like commands. Depending on | |
99 | the use-case it might be better to use subdev-specific ops (currently | |
100 | not yet implemented) since ops provide proper type-checking. | |
101 | */ | |
78a3b4db | 102 | |
66752f83 AW |
103 | /* Subdevice external IO pin configuration */ |
104 | #define V4L2_SUBDEV_IO_PIN_DISABLE (1 << 0) /* ENABLE assumed */ | |
105 | #define V4L2_SUBDEV_IO_PIN_OUTPUT (1 << 1) | |
106 | #define V4L2_SUBDEV_IO_PIN_INPUT (1 << 2) | |
107 | #define V4L2_SUBDEV_IO_PIN_SET_VALUE (1 << 3) /* Set output value */ | |
108 | #define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW (1 << 4) /* ACTIVE HIGH assumed */ | |
109 | ||
110 | struct v4l2_subdev_io_pin_config { | |
111 | u32 flags; /* V4L2_SUBDEV_IO_PIN_* flags for this pin's config */ | |
112 | u8 pin; /* Chip external IO pin to configure */ | |
113 | u8 function; /* Internal signal pad/function to route to IO pin */ | |
114 | u8 value; /* Initial value for pin - e.g. GPIO output value */ | |
115 | u8 strength; /* Pin drive strength */ | |
116 | }; | |
117 | ||
3c7c9370 | 118 | /* |
66752f83 AW |
119 | s_io_pin_config: configure one or more chip I/O pins for chips that |
120 | multiplex different internal signal pads out to IO pins. This function | |
121 | takes a pointer to an array of 'n' pin configuration entries, one for | |
122 | each pin being configured. This function could be called at times | |
123 | other than just subdevice initialization. | |
124 | ||
9d380adf | 125 | init: initialize the sensor registers to some sort of reasonable default |
78a3b4db HV |
126 | values. Do not use for new drivers and should be removed in existing |
127 | drivers. | |
128 | ||
cc26b076 HV |
129 | load_fw: load firmware. |
130 | ||
131 | reset: generic reset command. The argument selects which subsystems to | |
78a3b4db HV |
132 | reset. Passing 0 will always reset the whole chip. Do not use for new |
133 | drivers without discussing this first on the linux-media mailinglist. | |
134 | There should be no reason normally to reset a device. | |
135 | ||
136 | s_gpio: set GPIO pins. Very simple right now, might need to be extended with | |
137 | a direction argument if needed. | |
622b828a LP |
138 | |
139 | s_power: puts subdevice in power saving mode (on == 0) or normal operation | |
140 | mode (on == 1). | |
260e689b AW |
141 | |
142 | interrupt_service_routine: Called by the bridge chip's interrupt service | |
143 | handler, when an interrupt status has be raised due to this subdev, | |
144 | so that this subdev can handle the details. It may schedule work to be | |
145 | performed later. It must not sleep. *Called from an IRQ context*. | |
78a3b4db | 146 | */ |
2a1fcdf0 | 147 | struct v4l2_subdev_core_ops { |
2a1fcdf0 | 148 | int (*log_status)(struct v4l2_subdev *sd); |
66752f83 AW |
149 | int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n, |
150 | struct v4l2_subdev_io_pin_config *pincfg); | |
2a1fcdf0 | 151 | int (*init)(struct v4l2_subdev *sd, u32 val); |
cc26b076 | 152 | int (*load_fw)(struct v4l2_subdev *sd); |
2a1fcdf0 HV |
153 | int (*reset)(struct v4l2_subdev *sd, u32 val); |
154 | int (*s_gpio)(struct v4l2_subdev *sd, u32 val); | |
155 | int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc); | |
156 | int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl); | |
157 | int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl); | |
952617f2 HV |
158 | int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); |
159 | int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); | |
160 | int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); | |
2a1fcdf0 | 161 | int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm); |
1a99b972 | 162 | int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm); |
f41737ec | 163 | int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm); |
069b7479 | 164 | long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); |
ab58a301 HV |
165 | #ifdef CONFIG_COMPAT |
166 | long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd, | |
167 | unsigned long arg); | |
168 | #endif | |
2a1fcdf0 | 169 | #ifdef CONFIG_VIDEO_ADV_DEBUG |
aecde8b5 | 170 | int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); |
977ba3b1 | 171 | int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg); |
2a1fcdf0 | 172 | #endif |
622b828a | 173 | int (*s_power)(struct v4l2_subdev *sd, int on); |
260e689b AW |
174 | int (*interrupt_service_routine)(struct v4l2_subdev *sd, |
175 | u32 status, bool *handled); | |
02adb1cc SA |
176 | int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, |
177 | struct v4l2_event_subscription *sub); | |
178 | int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, | |
179 | struct v4l2_event_subscription *sub); | |
2a1fcdf0 HV |
180 | }; |
181 | ||
e206fc5e | 182 | /* s_radio: v4l device was opened in radio mode. |
78a3b4db | 183 | |
338e9e1a HV |
184 | g_frequency: freq->type must be filled in. Normally done by video_ioctl2 |
185 | or the bridge driver. | |
186 | ||
187 | g_tuner: | |
188 | s_tuner: vt->type must be filled in. Normally done by video_ioctl2 or the | |
189 | bridge driver. | |
190 | ||
78a3b4db HV |
191 | s_type_addr: sets tuner type and its I2C addr. |
192 | ||
193 | s_config: sets tda9887 specific stuff, like port1, port2 and qss | |
194 | */ | |
2a1fcdf0 | 195 | struct v4l2_subdev_tuner_ops { |
2a1fcdf0 | 196 | int (*s_radio)(struct v4l2_subdev *sd); |
b530a447 | 197 | int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq); |
2a1fcdf0 | 198 | int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); |
c58d1de5 | 199 | int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band); |
2a1fcdf0 | 200 | int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); |
2f73c7c5 | 201 | int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt); |
d6bacea6 | 202 | int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm); |
3f70e1f5 | 203 | int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm); |
2a1fcdf0 HV |
204 | int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type); |
205 | int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config); | |
206 | }; | |
207 | ||
78a3b4db HV |
208 | /* s_clock_freq: set the frequency (in Hz) of the audio clock output. |
209 | Used to slave an audio processor to the video decoder, ensuring that | |
210 | audio and video remain synchronized. Usual values for the frequency | |
211 | are 48000, 44100 or 32000 Hz. If the frequency is not supported, then | |
212 | -EINVAL is returned. | |
213 | ||
214 | s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard | |
215 | way to select I2S clock used by driving digital audio streams at some | |
216 | board designs. Usual values for the frequency are 1024000 and 2048000. | |
217 | If the frequency is not supported, then -EINVAL is returned. | |
218 | ||
5325b427 HV |
219 | s_routing: used to define the input and/or output pins of an audio chip, |
220 | and any additional configuration data. | |
78a3b4db HV |
221 | Never attempt to use user-level input IDs (e.g. Composite, S-Video, |
222 | Tuner) at this level. An i2c device shouldn't know about whether an | |
223 | input pin is connected to a Composite connector, become on another | |
224 | board or platform it might be connected to something else entirely. | |
225 | The calling driver is responsible for mapping a user-level input to | |
226 | the right pins on the i2c device. | |
227 | */ | |
2a1fcdf0 HV |
228 | struct v4l2_subdev_audio_ops { |
229 | int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq); | |
230 | int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq); | |
5325b427 | 231 | int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); |
3ccc646b | 232 | int (*s_stream)(struct v4l2_subdev *sd, int enable); |
2a1fcdf0 HV |
233 | }; |
234 | ||
29103119 SN |
235 | /* Indicates the @length field specifies maximum data length. */ |
236 | #define V4L2_MBUS_FRAME_DESC_FL_LEN_MAX (1U << 0) | |
174d6a39 SA |
237 | /* |
238 | * Indicates that the format does not have line offsets, i.e. the | |
239 | * receiver should use 1D DMA. | |
240 | */ | |
29103119 SN |
241 | #define V4L2_MBUS_FRAME_DESC_FL_BLOB (1U << 1) |
242 | ||
243 | /** | |
244 | * struct v4l2_mbus_frame_desc_entry - media bus frame description structure | |
245 | * @flags: V4L2_MBUS_FRAME_DESC_FL_* flags | |
246 | * @pixelcode: media bus pixel code, valid if FRAME_DESC_FL_BLOB is not set | |
174d6a39 SA |
247 | * @length: number of octets per frame, valid if V4L2_MBUS_FRAME_DESC_FL_BLOB |
248 | * is set | |
29103119 SN |
249 | */ |
250 | struct v4l2_mbus_frame_desc_entry { | |
251 | u16 flags; | |
252 | u32 pixelcode; | |
253 | u32 length; | |
254 | }; | |
255 | ||
256 | #define V4L2_FRAME_DESC_ENTRY_MAX 4 | |
257 | ||
258 | /** | |
259 | * struct v4l2_mbus_frame_desc - media bus data frame description | |
260 | * @entry: frame descriptors array | |
261 | * @num_entries: number of entries in @entry array | |
262 | */ | |
263 | struct v4l2_mbus_frame_desc { | |
264 | struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX]; | |
265 | unsigned short num_entries; | |
266 | }; | |
267 | ||
78a3b4db | 268 | /* |
cc26b076 | 269 | s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by |
78a3b4db HV |
270 | video input devices. |
271 | ||
5930ab2b TS |
272 | g_std_output: get current standard for video OUTPUT devices. This is ignored |
273 | by video input devices. | |
274 | ||
48353863 HV |
275 | g_tvnorms: get v4l2_std_id with all standards supported by the video |
276 | CAPTURE device. This is ignored by video output devices. | |
277 | ||
278 | g_tvnorms_output: get v4l2_std_id with all standards supported by the video | |
279 | OUTPUT device. This is ignored by video capture devices. | |
839cf813 | 280 | |
9a74251d | 281 | s_crystal_freq: sets the frequency of the crystal used to generate the |
3ff4ad81 | 282 | clocks in Hz. An extra flags field allows device specific configuration |
78a3b4db HV |
283 | regarding clock frequency dividers, etc. If not used, then set flags |
284 | to 0. If the frequency is not supported, then -EINVAL is returned. | |
285 | ||
cc26b076 | 286 | g_input_status: get input status. Same as the status field in the v4l2_input |
78a3b4db HV |
287 | struct. |
288 | ||
cc26b076 | 289 | s_routing: see s_routing in audio_ops, except this version is for video |
78a3b4db | 290 | devices. |
b6456c0c | 291 | |
b6456c0c MK |
292 | s_dv_timings(): Set custom dv timings in the sub device. This is used |
293 | when sub device is capable of setting detailed timing information | |
294 | in the hardware to generate/detect the video signal. | |
295 | ||
296 | g_dv_timings(): Get custom dv timings in the sub device. | |
297 | ||
9a74251d GL |
298 | enum_mbus_fmt: enumerate pixel formats, provided by a video data source |
299 | ||
300 | g_mbus_fmt: get the current pixel format, provided by a video data source | |
301 | ||
302 | try_mbus_fmt: try to set a pixel format on a video data source | |
303 | ||
304 | s_mbus_fmt: set a pixel format on a video data source | |
91c79530 GL |
305 | |
306 | g_mbus_config: get supported mediabus configurations | |
307 | ||
308 | s_mbus_config: set a certain mediabus configuration. This operation is added | |
309 | for compatibility with soc-camera drivers and should not be used by new | |
310 | software. | |
a375e1df SN |
311 | |
312 | s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev | |
313 | can adjust @size to a lower value and must not write more data to the | |
314 | buffer starting at @data than the original value of @size. | |
78a3b4db | 315 | */ |
2a1fcdf0 | 316 | struct v4l2_subdev_video_ops { |
5325b427 | 317 | int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); |
3ff4ad81 | 318 | int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags); |
2a1fcdf0 | 319 | int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std); |
5930ab2b | 320 | int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std); |
1b6f1d96 | 321 | int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std); |
48353863 | 322 | int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std); |
839cf813 | 323 | int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std); |
1b6f1d96 | 324 | int (*g_input_status)(struct v4l2_subdev *sd, u32 *status); |
2a1fcdf0 | 325 | int (*s_stream)(struct v4l2_subdev *sd, int enable); |
b7f2cef0 GL |
326 | int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc); |
327 | int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop); | |
4f996594 | 328 | int (*s_crop)(struct v4l2_subdev *sd, const struct v4l2_crop *crop); |
2da9479a HV |
329 | int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); |
330 | int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); | |
35c3017a LP |
331 | int (*g_frame_interval)(struct v4l2_subdev *sd, |
332 | struct v4l2_subdev_frame_interval *interval); | |
333 | int (*s_frame_interval)(struct v4l2_subdev *sd, | |
334 | struct v4l2_subdev_frame_interval *interval); | |
4b2ce11a HV |
335 | int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize); |
336 | int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival); | |
b6456c0c MK |
337 | int (*s_dv_timings)(struct v4l2_subdev *sd, |
338 | struct v4l2_dv_timings *timings); | |
339 | int (*g_dv_timings)(struct v4l2_subdev *sd, | |
340 | struct v4l2_dv_timings *timings); | |
5d7758ee HV |
341 | int (*enum_dv_timings)(struct v4l2_subdev *sd, |
342 | struct v4l2_enum_dv_timings *timings); | |
343 | int (*query_dv_timings)(struct v4l2_subdev *sd, | |
344 | struct v4l2_dv_timings *timings); | |
345 | int (*dv_timings_cap)(struct v4l2_subdev *sd, | |
346 | struct v4l2_dv_timings_cap *cap); | |
3805f201 | 347 | int (*enum_mbus_fmt)(struct v4l2_subdev *sd, unsigned int index, |
9a74251d | 348 | enum v4l2_mbus_pixelcode *code); |
03519b7e QX |
349 | int (*enum_mbus_fsizes)(struct v4l2_subdev *sd, |
350 | struct v4l2_frmsizeenum *fsize); | |
9a74251d GL |
351 | int (*g_mbus_fmt)(struct v4l2_subdev *sd, |
352 | struct v4l2_mbus_framefmt *fmt); | |
353 | int (*try_mbus_fmt)(struct v4l2_subdev *sd, | |
354 | struct v4l2_mbus_framefmt *fmt); | |
355 | int (*s_mbus_fmt)(struct v4l2_subdev *sd, | |
356 | struct v4l2_mbus_framefmt *fmt); | |
91c79530 GL |
357 | int (*g_mbus_config)(struct v4l2_subdev *sd, |
358 | struct v4l2_mbus_config *cfg); | |
359 | int (*s_mbus_config)(struct v4l2_subdev *sd, | |
360 | const struct v4l2_mbus_config *cfg); | |
a375e1df SN |
361 | int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf, |
362 | unsigned int *size); | |
2a1fcdf0 HV |
363 | }; |
364 | ||
32cd527f HV |
365 | /* |
366 | decode_vbi_line: video decoders that support sliced VBI need to implement | |
367 | this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the | |
368 | start of the VBI data that was generated by the decoder. The driver | |
369 | then parses the sliced VBI data and sets the other fields in the | |
370 | struct accordingly. The pointer p is updated to point to the start of | |
371 | the payload which can be copied verbatim into the data field of the | |
372 | v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the | |
373 | type field is set to 0 on return. | |
374 | ||
375 | s_vbi_data: used to generate VBI signals on a video signal. | |
376 | v4l2_sliced_vbi_data is filled with the data packets that should be | |
377 | output. Note that if you set the line field to 0, then that VBI signal | |
378 | is disabled. If no valid VBI data was found, then the type field is | |
379 | set to 0 on return. | |
380 | ||
381 | g_vbi_data: used to obtain the sliced VBI packet from a readback register. | |
382 | Not all video decoders support this. If no data is available because | |
383 | the readback register contains invalid or erroneous data -EIO is | |
384 | returned. Note that you must fill in the 'id' member and the 'field' | |
385 | member (to determine whether CC data from the first or second field | |
386 | should be obtained). | |
54aefafb HV |
387 | |
388 | s_raw_fmt: setup the video encoder/decoder for raw VBI. | |
389 | ||
390 | g_sliced_fmt: retrieve the current sliced VBI settings. | |
391 | ||
392 | s_sliced_fmt: setup the sliced VBI settings. | |
32cd527f HV |
393 | */ |
394 | struct v4l2_subdev_vbi_ops { | |
395 | int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line); | |
396 | int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data); | |
397 | int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data); | |
398 | int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap); | |
54aefafb HV |
399 | int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt); |
400 | int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); | |
401 | int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); | |
32cd527f HV |
402 | }; |
403 | ||
32536108 GL |
404 | /** |
405 | * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations | |
406 | * @g_skip_top_lines: number of lines at the top of the image to be skipped. | |
407 | * This is needed for some sensors, which always corrupt | |
408 | * several top lines of the output image, or which send their | |
409 | * metadata in them. | |
f80a3ab0 LP |
410 | * @g_skip_frames: number of frames to skip at stream start. This is needed for |
411 | * buggy sensors that generate faulty frames when they are | |
412 | * turned on. | |
32536108 GL |
413 | */ |
414 | struct v4l2_subdev_sensor_ops { | |
415 | int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines); | |
f80a3ab0 | 416 | int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames); |
32536108 GL |
417 | }; |
418 | ||
1d986add | 419 | /* |
1d986add AW |
420 | [rt]x_g_parameters: Get the current operating parameters and state of the |
421 | the IR receiver or transmitter. | |
422 | ||
423 | [rt]x_s_parameters: Set the current operating parameters and state of the | |
424 | the IR receiver or transmitter. It is recommended to call | |
425 | [rt]x_g_parameters first to fill out the current state, and only change | |
426 | the fields that need to be changed. Upon return, the actual device | |
427 | operating parameters and state will be returned. Note that hardware | |
428 | limitations may prevent the actual settings from matching the requested | |
429 | settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz | |
430 | was requested. An exception is when the shutdown parameter is true. | |
431 | The last used operational parameters will be returned, but the actual | |
432 | state of the hardware be different to minimize power consumption and | |
433 | processing when shutdown is true. | |
434 | ||
435 | rx_read: Reads received codes or pulse width data. | |
436 | The semantics are similar to a non-blocking read() call. | |
437 | ||
438 | tx_write: Writes codes or pulse width data for transmission. | |
439 | The semantics are similar to a non-blocking write() call. | |
440 | */ | |
441 | ||
442 | enum v4l2_subdev_ir_mode { | |
d69e85b6 | 443 | V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */ |
1d986add AW |
444 | }; |
445 | ||
1d986add AW |
446 | struct v4l2_subdev_ir_parameters { |
447 | /* Either Rx or Tx */ | |
448 | unsigned int bytes_per_data_element; /* of data in read or write call */ | |
449 | enum v4l2_subdev_ir_mode mode; | |
450 | ||
451 | bool enable; | |
452 | bool interrupt_enable; | |
453 | bool shutdown; /* true: set hardware to low/no power, false: normal */ | |
454 | ||
455 | bool modulation; /* true: uses carrier, false: baseband */ | |
456 | u32 max_pulse_width; /* ns, valid only for baseband signal */ | |
457 | unsigned int carrier_freq; /* Hz, valid only for modulated signal*/ | |
458 | unsigned int duty_cycle; /* percent, valid only for modulated signal*/ | |
5a28d9a3 AW |
459 | bool invert_level; /* invert signal level */ |
460 | ||
461 | /* Tx only */ | |
462 | bool invert_carrier_sense; /* Send 0/space as a carrier burst */ | |
1d986add AW |
463 | |
464 | /* Rx only */ | |
465 | u32 noise_filter_min_width; /* ns, min time of a valid pulse */ | |
466 | unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */ | |
467 | unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */ | |
468 | u32 resolution; /* ns */ | |
469 | }; | |
470 | ||
471 | struct v4l2_subdev_ir_ops { | |
1d986add AW |
472 | /* Receiver */ |
473 | int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count, | |
474 | ssize_t *num); | |
475 | ||
476 | int (*rx_g_parameters)(struct v4l2_subdev *sd, | |
477 | struct v4l2_subdev_ir_parameters *params); | |
478 | int (*rx_s_parameters)(struct v4l2_subdev *sd, | |
479 | struct v4l2_subdev_ir_parameters *params); | |
480 | ||
481 | /* Transmitter */ | |
482 | int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count, | |
483 | ssize_t *num); | |
484 | ||
485 | int (*tx_g_parameters)(struct v4l2_subdev *sd, | |
486 | struct v4l2_subdev_ir_parameters *params); | |
487 | int (*tx_s_parameters)(struct v4l2_subdev *sd, | |
488 | struct v4l2_subdev_ir_parameters *params); | |
489 | }; | |
490 | ||
29103119 SN |
491 | /** |
492 | * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations | |
493 | * @get_frame_desc: get the current low level media bus frame parameters. | |
494 | * @get_frame_desc: set the low level media bus frame parameters, @fd array | |
495 | * may be adjusted by the subdev driver to device capabilities. | |
496 | */ | |
eb08f354 | 497 | struct v4l2_subdev_pad_ops { |
333c8b97 LP |
498 | int (*enum_mbus_code)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, |
499 | struct v4l2_subdev_mbus_code_enum *code); | |
500 | int (*enum_frame_size)(struct v4l2_subdev *sd, | |
501 | struct v4l2_subdev_fh *fh, | |
502 | struct v4l2_subdev_frame_size_enum *fse); | |
35c3017a LP |
503 | int (*enum_frame_interval)(struct v4l2_subdev *sd, |
504 | struct v4l2_subdev_fh *fh, | |
505 | struct v4l2_subdev_frame_interval_enum *fie); | |
333c8b97 LP |
506 | int (*get_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, |
507 | struct v4l2_subdev_format *format); | |
508 | int (*set_fmt)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, | |
509 | struct v4l2_subdev_format *format); | |
f6a5cb1b AK |
510 | int (*set_crop)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, |
511 | struct v4l2_subdev_crop *crop); | |
512 | int (*get_crop)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, | |
513 | struct v4l2_subdev_crop *crop); | |
ae184cda SA |
514 | int (*get_selection)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, |
515 | struct v4l2_subdev_selection *sel); | |
516 | int (*set_selection)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh, | |
517 | struct v4l2_subdev_selection *sel); | |
dd519bb3 HV |
518 | int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); |
519 | int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); | |
8227c92b SA |
520 | #ifdef CONFIG_MEDIA_CONTROLLER |
521 | int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link, | |
522 | struct v4l2_subdev_format *source_fmt, | |
523 | struct v4l2_subdev_format *sink_fmt); | |
524 | #endif /* CONFIG_MEDIA_CONTROLLER */ | |
29103119 SN |
525 | int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, |
526 | struct v4l2_mbus_frame_desc *fd); | |
527 | int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, | |
528 | struct v4l2_mbus_frame_desc *fd); | |
eb08f354 LP |
529 | }; |
530 | ||
2a1fcdf0 | 531 | struct v4l2_subdev_ops { |
32536108 GL |
532 | const struct v4l2_subdev_core_ops *core; |
533 | const struct v4l2_subdev_tuner_ops *tuner; | |
534 | const struct v4l2_subdev_audio_ops *audio; | |
535 | const struct v4l2_subdev_video_ops *video; | |
32cd527f | 536 | const struct v4l2_subdev_vbi_ops *vbi; |
32536108 GL |
537 | const struct v4l2_subdev_ir_ops *ir; |
538 | const struct v4l2_subdev_sensor_ops *sensor; | |
eb08f354 | 539 | const struct v4l2_subdev_pad_ops *pad; |
2a1fcdf0 HV |
540 | }; |
541 | ||
45f6f84a HV |
542 | /* |
543 | * Internal ops. Never call this from drivers, only the v4l2 framework can call | |
544 | * these ops. | |
545 | * | |
546 | * registered: called when this subdev is registered. When called the v4l2_dev | |
547 | * field is set to the correct v4l2_device. | |
548 | * | |
549 | * unregistered: called when this subdev is unregistered. When called the | |
550 | * v4l2_dev field is still set to the correct v4l2_device. | |
f0beea8f LP |
551 | * |
552 | * open: called when the subdev device node is opened by an application. | |
553 | * | |
554 | * close: called when the subdev device node is closed. | |
45f6f84a HV |
555 | */ |
556 | struct v4l2_subdev_internal_ops { | |
557 | int (*registered)(struct v4l2_subdev *sd); | |
558 | void (*unregistered)(struct v4l2_subdev *sd); | |
f0beea8f LP |
559 | int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); |
560 | int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); | |
45f6f84a HV |
561 | }; |
562 | ||
2a1fcdf0 HV |
563 | #define V4L2_SUBDEV_NAME_SIZE 32 |
564 | ||
b5b2b7ed | 565 | /* Set this flag if this subdev is a i2c device. */ |
2096a5dc | 566 | #define V4L2_SUBDEV_FL_IS_I2C (1U << 0) |
85e09219 | 567 | /* Set this flag if this subdev is a spi device. */ |
2096a5dc LP |
568 | #define V4L2_SUBDEV_FL_IS_SPI (1U << 1) |
569 | /* Set this flag if this subdev needs a device node. */ | |
570 | #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2) | |
02adb1cc SA |
571 | /* Set this flag if this subdev generates events. */ |
572 | #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3) | |
b5b2b7ed | 573 | |
b1cbab05 GL |
574 | struct regulator_bulk_data; |
575 | ||
576 | struct v4l2_subdev_platform_data { | |
577 | /* Optional regulators uset to power on/off the subdevice */ | |
578 | struct regulator_bulk_data *regulators; | |
579 | int num_regulators; | |
580 | ||
581 | /* Per-subdevice data, specific for a certain video host device */ | |
582 | void *host_priv; | |
583 | }; | |
584 | ||
2a1fcdf0 HV |
585 | /* Each instance of a subdev driver should create this struct, either |
586 | stand-alone or embedded in a larger struct. | |
587 | */ | |
588 | struct v4l2_subdev { | |
61f5db54 LP |
589 | #if defined(CONFIG_MEDIA_CONTROLLER) |
590 | struct media_entity entity; | |
591 | #endif | |
2a1fcdf0 HV |
592 | struct list_head list; |
593 | struct module *owner; | |
b2a06aec | 594 | bool owner_v4l2_dev; |
b5b2b7ed | 595 | u32 flags; |
b0167600 | 596 | struct v4l2_device *v4l2_dev; |
2a1fcdf0 | 597 | const struct v4l2_subdev_ops *ops; |
45f6f84a HV |
598 | /* Never call these internal ops from within a driver! */ |
599 | const struct v4l2_subdev_internal_ops *internal_ops; | |
0996517c HV |
600 | /* The control handler of this subdev. May be NULL. */ |
601 | struct v4l2_ctrl_handler *ctrl_handler; | |
2a1fcdf0 HV |
602 | /* name must be unique */ |
603 | char name[V4L2_SUBDEV_NAME_SIZE]; | |
604 | /* can be used to group similar subdevs, value is driver-specific */ | |
605 | u32 grp_id; | |
606 | /* pointer to private data */ | |
692d5522 LP |
607 | void *dev_priv; |
608 | void *host_priv; | |
2096a5dc | 609 | /* subdev device node */ |
3e0ec41c | 610 | struct video_device *devnode; |
668773b8 GL |
611 | /* pointer to the physical device, if any */ |
612 | struct device *dev; | |
b426b3a6 SN |
613 | /* Links this subdev to a global subdev_list or @notifier->done list. */ |
614 | struct list_head async_list; | |
615 | /* Pointer to respective struct v4l2_async_subdev. */ | |
616 | struct v4l2_async_subdev *asd; | |
617 | /* Pointer to the managing notifier. */ | |
618 | struct v4l2_async_notifier *notifier; | |
b1cbab05 GL |
619 | /* common part of subdevice platform data */ |
620 | struct v4l2_subdev_platform_data *pdata; | |
2a1fcdf0 HV |
621 | }; |
622 | ||
61f5db54 LP |
623 | #define media_entity_to_v4l2_subdev(ent) \ |
624 | container_of(ent, struct v4l2_subdev, entity) | |
2096a5dc | 625 | #define vdev_to_v4l2_subdev(vdev) \ |
c5a766ce | 626 | ((struct v4l2_subdev *)video_get_drvdata(vdev)) |
2096a5dc | 627 | |
7cd5a16b SV |
628 | /* |
629 | * Used for storing subdev information per file handle | |
630 | */ | |
631 | struct v4l2_subdev_fh { | |
632 | struct v4l2_fh vfh; | |
633 | #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) | |
ae184cda SA |
634 | struct { |
635 | struct v4l2_mbus_framefmt try_fmt; | |
636 | struct v4l2_rect try_crop; | |
637 | struct v4l2_rect try_compose; | |
638 | } *pad; | |
7cd5a16b SV |
639 | #endif |
640 | }; | |
641 | ||
642 | #define to_v4l2_subdev_fh(fh) \ | |
643 | container_of(fh, struct v4l2_subdev_fh, vfh) | |
644 | ||
645 | #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) | |
5e6ff7c1 SA |
646 | #define __V4L2_SUBDEV_MK_GET_TRY(rtype, fun_name, field_name) \ |
647 | static inline struct rtype * \ | |
648 | v4l2_subdev_get_try_##fun_name(struct v4l2_subdev_fh *fh, \ | |
649 | unsigned int pad) \ | |
650 | { \ | |
1bfa6e0d GL |
651 | BUG_ON(pad >= vdev_to_v4l2_subdev( \ |
652 | fh->vfh.vdev)->entity.num_pads); \ | |
5e6ff7c1 SA |
653 | return &fh->pad[pad].field_name; \ |
654 | } | |
655 | ||
656 | __V4L2_SUBDEV_MK_GET_TRY(v4l2_mbus_framefmt, format, try_fmt) | |
769980de | 657 | __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, crop, try_crop) |
5e6ff7c1 | 658 | __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, compose, try_compose) |
7cd5a16b SV |
659 | #endif |
660 | ||
2096a5dc LP |
661 | extern const struct v4l2_file_operations v4l2_subdev_fops; |
662 | ||
2a1fcdf0 HV |
663 | static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p) |
664 | { | |
692d5522 | 665 | sd->dev_priv = p; |
2a1fcdf0 HV |
666 | } |
667 | ||
668 | static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd) | |
669 | { | |
692d5522 LP |
670 | return sd->dev_priv; |
671 | } | |
672 | ||
673 | static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p) | |
674 | { | |
675 | sd->host_priv = p; | |
676 | } | |
677 | ||
678 | static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd) | |
679 | { | |
680 | return sd->host_priv; | |
2a1fcdf0 HV |
681 | } |
682 | ||
8227c92b SA |
683 | #ifdef CONFIG_MEDIA_CONTROLLER |
684 | int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd, | |
685 | struct media_link *link, | |
686 | struct v4l2_subdev_format *source_fmt, | |
687 | struct v4l2_subdev_format *sink_fmt); | |
688 | int v4l2_subdev_link_validate(struct media_link *link); | |
689 | #endif /* CONFIG_MEDIA_CONTROLLER */ | |
3dd5ee08 LP |
690 | void v4l2_subdev_init(struct v4l2_subdev *sd, |
691 | const struct v4l2_subdev_ops *ops); | |
2a1fcdf0 HV |
692 | |
693 | /* Call an ops of a v4l2_subdev, doing the right checks against | |
694 | NULL pointers. | |
695 | ||
b71c9980 | 696 | Example: err = v4l2_subdev_call(sd, core, s_std, norm); |
2a1fcdf0 HV |
697 | */ |
698 | #define v4l2_subdev_call(sd, o, f, args...) \ | |
dbc8e34a | 699 | (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \ |
2a1fcdf0 HV |
700 | (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD)) |
701 | ||
2180f92d HV |
702 | #define v4l2_subdev_has_op(sd, o, f) \ |
703 | ((sd)->ops->o && (sd)->ops->o->f) | |
704 | ||
2a1fcdf0 | 705 | #endif |