Commit | Line | Data |
---|---|---|
2a1fcdf0 | 1 | /* |
21c29de1 MCC |
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. | |
2a1fcdf0 HV |
15 | */ |
16 | ||
17 | #ifndef _V4L2_SUBDEV_H | |
18 | #define _V4L2_SUBDEV_H | |
19 | ||
29103119 | 20 | #include <linux/types.h> |
333c8b97 | 21 | #include <linux/v4l2-subdev.h> |
61f5db54 | 22 | #include <media/media-entity.h> |
e9e31049 | 23 | #include <media/v4l2-async.h> |
2a1fcdf0 | 24 | #include <media/v4l2-common.h> |
2096a5dc | 25 | #include <media/v4l2-dev.h> |
7cd5a16b | 26 | #include <media/v4l2-fh.h> |
9a74251d | 27 | #include <media/v4l2-mediabus.h> |
2a1fcdf0 | 28 | |
1d986add AW |
29 | /* generic v4l2_device notify callback notification values */ |
30 | #define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32) | |
31 | #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001 | |
32 | #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002 | |
33 | #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004 | |
34 | #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008 | |
35 | ||
36 | #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32) | |
37 | #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001 | |
38 | ||
17e48468 | 39 | #define V4L2_DEVICE_NOTIFY_EVENT _IOW('v', 2, struct v4l2_event) |
40 | ||
2a1fcdf0 | 41 | struct v4l2_device; |
0996517c | 42 | struct v4l2_ctrl_handler; |
8ae5640f | 43 | struct v4l2_event; |
02adb1cc SA |
44 | struct v4l2_event_subscription; |
45 | struct v4l2_fh; | |
2a1fcdf0 | 46 | struct v4l2_subdev; |
f0beea8f | 47 | struct v4l2_subdev_fh; |
2a1fcdf0 | 48 | struct tuner_setup; |
29103119 | 49 | struct v4l2_mbus_frame_desc; |
2a1fcdf0 | 50 | |
21c29de1 MCC |
51 | /** |
52 | * struct v4l2_decode_vbi_line - used to decode_vbi_line | |
53 | * | |
54 | * @is_second_field: Set to 0 for the first (odd) field; | |
55 | * set to 1 for the second (even) field. | |
56 | * @p: Pointer to the sliced VBI data from the decoder. On exit, points to | |
57 | * the start of the payload. | |
58 | * @line: Line number of the sliced VBI data (1-23) | |
59 | * @type: VBI service type (V4L2_SLICED_*). 0 if no service found | |
60 | */ | |
78a3b4db | 61 | struct v4l2_decode_vbi_line { |
21c29de1 MCC |
62 | u32 is_second_field; |
63 | u8 *p; | |
64 | u32 line; | |
65 | u32 type; | |
78a3b4db HV |
66 | }; |
67 | ||
21c29de1 MCC |
68 | /* |
69 | * Sub-devices are devices that are connected somehow to the main bridge | |
70 | * device. These devices are usually audio/video muxers/encoders/decoders or | |
71 | * sensors and webcam controllers. | |
72 | * | |
73 | * Usually these devices are controlled through an i2c bus, but other busses | |
74 | * may also be used. | |
75 | * | |
76 | * The v4l2_subdev struct provides a way of accessing these devices in a | |
77 | * generic manner. Most operations that these sub-devices support fall in | |
78 | * a few categories: core ops, audio ops, video ops and tuner ops. | |
79 | * | |
80 | * More categories can be added if needed, although this should remain a | |
81 | * limited set (no more than approx. 8 categories). | |
82 | * | |
83 | * Each category has its own set of ops that subdev drivers can implement. | |
84 | * | |
85 | * A subdev driver can leave the pointer to the category ops NULL if | |
86 | * it does not implement them (e.g. an audio subdev will generally not | |
87 | * implement the video category ops). The exception is the core category: | |
88 | * this must always be present. | |
89 | * | |
90 | * These ops are all used internally so it is no problem to change, remove | |
91 | * or add ops or move ops from one to another category. Currently these | |
92 | * ops are based on the original ioctls, but since ops are not limited to | |
93 | * one argument there is room for improvement here once all i2c subdev | |
94 | * drivers are converted to use these ops. | |
2a1fcdf0 HV |
95 | */ |
96 | ||
21c29de1 MCC |
97 | /* |
98 | * Core ops: it is highly recommended to implement at least these ops: | |
99 | * | |
100 | * log_status | |
101 | * g_register | |
102 | * s_register | |
103 | * | |
104 | * This provides basic debugging support. | |
105 | * | |
106 | * The ioctl ops is meant for generic ioctl-like commands. Depending on | |
107 | * the use-case it might be better to use subdev-specific ops (currently | |
108 | * not yet implemented) since ops provide proper type-checking. | |
2a1fcdf0 | 109 | */ |
78a3b4db | 110 | |
66752f83 AW |
111 | /* Subdevice external IO pin configuration */ |
112 | #define V4L2_SUBDEV_IO_PIN_DISABLE (1 << 0) /* ENABLE assumed */ | |
113 | #define V4L2_SUBDEV_IO_PIN_OUTPUT (1 << 1) | |
114 | #define V4L2_SUBDEV_IO_PIN_INPUT (1 << 2) | |
115 | #define V4L2_SUBDEV_IO_PIN_SET_VALUE (1 << 3) /* Set output value */ | |
116 | #define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW (1 << 4) /* ACTIVE HIGH assumed */ | |
117 | ||
21c29de1 MCC |
118 | /** |
119 | * struct v4l2_subdev_io_pin_config - Subdevice external IO pin configuration | |
120 | * | |
121 | * @flags: bitmask with flags for this pin's config: | |
122 | * %V4L2_SUBDEV_IO_PIN_DISABLE - disables a pin config, | |
123 | * %V4L2_SUBDEV_IO_PIN_OUTPUT - if pin is an output, | |
124 | * %V4L2_SUBDEV_IO_PIN_INPUT - if pin is an input, | |
125 | * %V4L2_SUBDEV_IO_PIN_SET_VALUE - to set the output value via @value | |
126 | * and %V4L2_SUBDEV_IO_PIN_ACTIVE_LOW - if active is 0. | |
127 | * @pin: Chip external IO pin to configure | |
128 | * @function: Internal signal pad/function to route to IO pin | |
129 | * @value: Initial value for pin - e.g. GPIO output value | |
130 | * @strength: Pin drive strength | |
131 | */ | |
66752f83 | 132 | struct v4l2_subdev_io_pin_config { |
21c29de1 MCC |
133 | u32 flags; |
134 | u8 pin; | |
135 | u8 function; | |
136 | u8 value; | |
137 | u8 strength; | |
66752f83 AW |
138 | }; |
139 | ||
5c662984 | 140 | /** |
783001ad MCC |
141 | * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs |
142 | * | |
3fb558f6 | 143 | * @log_status: callback for VIDIOC_LOG_STATUS() ioctl handler code. |
5c662984 MCC |
144 | * |
145 | * @s_io_pin_config: configure one or more chip I/O pins for chips that | |
146 | * multiplex different internal signal pads out to IO pins. This function | |
147 | * takes a pointer to an array of 'n' pin configuration entries, one for | |
148 | * each pin being configured. This function could be called at times | |
149 | * other than just subdevice initialization. | |
150 | * | |
151 | * @init: initialize the sensor registers to some sort of reasonable default | |
152 | * values. Do not use for new drivers and should be removed in existing | |
153 | * drivers. | |
154 | * | |
155 | * @load_fw: load firmware. | |
156 | * | |
157 | * @reset: generic reset command. The argument selects which subsystems to | |
158 | * reset. Passing 0 will always reset the whole chip. Do not use for new | |
159 | * drivers without discussing this first on the linux-media mailinglist. | |
160 | * There should be no reason normally to reset a device. | |
161 | * | |
162 | * @s_gpio: set GPIO pins. Very simple right now, might need to be extended with | |
163 | * a direction argument if needed. | |
164 | * | |
1d8955b2 MCC |
165 | * @ioctl: called at the end of ioctl() syscall handler at the V4L2 core. |
166 | * used to provide support for private ioctls used on the driver. | |
167 | * | |
168 | * @compat_ioctl32: called when a 32 bits application uses a 64 bits Kernel, | |
169 | * in order to fix data passed from/to userspace. | |
170 | * | |
3fb558f6 | 171 | * @g_register: callback for VIDIOC_DBG_G_REGISTER() ioctl handler code. |
783001ad | 172 | * |
3fb558f6 | 173 | * @s_register: callback for VIDIOC_DBG_S_REGISTER() ioctl handler code. |
783001ad | 174 | * |
5c662984 MCC |
175 | * @s_power: puts subdevice in power saving mode (on == 0) or normal operation |
176 | * mode (on == 1). | |
177 | * | |
178 | * @interrupt_service_routine: Called by the bridge chip's interrupt service | |
179 | * handler, when an interrupt status has be raised due to this subdev, | |
180 | * so that this subdev can handle the details. It may schedule work to be | |
21c29de1 | 181 | * performed later. It must not sleep. **Called from an IRQ context**. |
1d8955b2 MCC |
182 | * |
183 | * @subscribe_event: used by the drivers to request the control framework that | |
184 | * for it to be warned when the value of a control changes. | |
185 | * | |
186 | * @unsubscribe_event: remove event subscription from the control framework. | |
78a3b4db | 187 | */ |
2a1fcdf0 | 188 | struct v4l2_subdev_core_ops { |
2a1fcdf0 | 189 | int (*log_status)(struct v4l2_subdev *sd); |
66752f83 AW |
190 | int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n, |
191 | struct v4l2_subdev_io_pin_config *pincfg); | |
2a1fcdf0 | 192 | int (*init)(struct v4l2_subdev *sd, u32 val); |
cc26b076 | 193 | int (*load_fw)(struct v4l2_subdev *sd); |
2a1fcdf0 HV |
194 | int (*reset)(struct v4l2_subdev *sd, u32 val); |
195 | int (*s_gpio)(struct v4l2_subdev *sd, u32 val); | |
069b7479 | 196 | long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); |
ab58a301 HV |
197 | #ifdef CONFIG_COMPAT |
198 | long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd, | |
199 | unsigned long arg); | |
200 | #endif | |
2a1fcdf0 | 201 | #ifdef CONFIG_VIDEO_ADV_DEBUG |
aecde8b5 | 202 | int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); |
977ba3b1 | 203 | int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg); |
2a1fcdf0 | 204 | #endif |
622b828a | 205 | int (*s_power)(struct v4l2_subdev *sd, int on); |
260e689b AW |
206 | int (*interrupt_service_routine)(struct v4l2_subdev *sd, |
207 | u32 status, bool *handled); | |
02adb1cc SA |
208 | int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, |
209 | struct v4l2_event_subscription *sub); | |
210 | int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, | |
211 | struct v4l2_event_subscription *sub); | |
2a1fcdf0 HV |
212 | }; |
213 | ||
5c662984 | 214 | /** |
e383ce07 MCC |
215 | * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened |
216 | * in radio mode. | |
5c662984 | 217 | * |
07bf9355 MCC |
218 | * @s_radio: callback that switches the tuner to radio mode. |
219 | * drivers should explicitly call it when a tuner ops should | |
220 | * operate on radio mode, before being able to handle it. | |
221 | * Used on devices that have both AM/FM radio receiver and TV. | |
91963aae | 222 | * |
3fb558f6 | 223 | * @s_frequency: callback for VIDIOC_S_FREQUENCY() ioctl handler code. |
91963aae | 224 | * |
3fb558f6 | 225 | * @g_frequency: callback for VIDIOC_G_FREQUENCY() ioctl handler code. |
21c29de1 | 226 | * freq->type must be filled in. Normally done by video_ioctl2() |
89cb3ddb | 227 | * or the bridge driver. |
91963aae | 228 | * |
3fb558f6 | 229 | * @enum_freq_bands: callback for VIDIOC_ENUM_FREQ_BANDS() ioctl handler code. |
91963aae | 230 | * |
3fb558f6 | 231 | * @g_tuner: callback for VIDIOC_G_TUNER() ioctl handler code. |
91963aae | 232 | * |
3fb558f6 | 233 | * @s_tuner: callback for VIDIOC_S_TUNER() ioctl handler code. @vt->type must be |
91963aae | 234 | * filled in. Normally done by video_ioctl2 or the |
89cb3ddb | 235 | * bridge driver. |
5c662984 | 236 | * |
3fb558f6 | 237 | * @g_modulator: callback for VIDIOC_G_MODULATOR() ioctl handler code. |
91963aae | 238 | * |
3fb558f6 | 239 | * @s_modulator: callback for VIDIOC_S_MODULATOR() ioctl handler code. |
91963aae | 240 | * |
5c662984 | 241 | * @s_type_addr: sets tuner type and its I2C addr. |
91963aae | 242 | * |
5c662984 | 243 | * @s_config: sets tda9887 specific stuff, like port1, port2 and qss |
07bf9355 MCC |
244 | * |
245 | * .. note:: | |
246 | * | |
247 | * On devices that have both AM/FM and TV, it is up to the driver | |
248 | * to explicitly call s_radio when the tuner should be switched to | |
249 | * radio mode, before handling other &struct v4l2_subdev_tuner_ops | |
250 | * that would require it. An example of such usage is:: | |
251 | * | |
252 | * static void s_frequency(void *priv, const struct v4l2_frequency *f) | |
253 | * { | |
254 | * ... | |
255 | * if (f.type == V4L2_TUNER_RADIO) | |
256 | * v4l2_device_call_all(v4l2_dev, 0, tuner, s_radio); | |
257 | * ... | |
258 | * v4l2_device_call_all(v4l2_dev, 0, tuner, s_frequency); | |
259 | * } | |
78a3b4db | 260 | */ |
2a1fcdf0 | 261 | struct v4l2_subdev_tuner_ops { |
2a1fcdf0 | 262 | int (*s_radio)(struct v4l2_subdev *sd); |
b530a447 | 263 | int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq); |
2a1fcdf0 | 264 | int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); |
c58d1de5 | 265 | int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band); |
2a1fcdf0 | 266 | int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); |
2f73c7c5 | 267 | int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt); |
d6bacea6 | 268 | int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm); |
3f70e1f5 | 269 | int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm); |
2a1fcdf0 HV |
270 | int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type); |
271 | int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config); | |
272 | }; | |
273 | ||
5c662984 MCC |
274 | /** |
275 | * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings | |
276 | * | |
277 | * @s_clock_freq: set the frequency (in Hz) of the audio clock output. | |
278 | * Used to slave an audio processor to the video decoder, ensuring that | |
279 | * audio and video remain synchronized. Usual values for the frequency | |
280 | * are 48000, 44100 or 32000 Hz. If the frequency is not supported, then | |
281 | * -EINVAL is returned. | |
282 | * | |
283 | * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard | |
284 | * way to select I2S clock used by driving digital audio streams at some | |
285 | * board designs. Usual values for the frequency are 1024000 and 2048000. | |
21c29de1 | 286 | * If the frequency is not supported, then %-EINVAL is returned. |
5c662984 MCC |
287 | * |
288 | * @s_routing: used to define the input and/or output pins of an audio chip, | |
289 | * and any additional configuration data. | |
290 | * Never attempt to use user-level input IDs (e.g. Composite, S-Video, | |
291 | * Tuner) at this level. An i2c device shouldn't know about whether an | |
292 | * input pin is connected to a Composite connector, become on another | |
293 | * board or platform it might be connected to something else entirely. | |
294 | * The calling driver is responsible for mapping a user-level input to | |
295 | * the right pins on the i2c device. | |
1d8955b2 MCC |
296 | * |
297 | * @s_stream: used to notify the audio code that stream will start or has | |
298 | * stopped. | |
78a3b4db | 299 | */ |
2a1fcdf0 HV |
300 | struct v4l2_subdev_audio_ops { |
301 | int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq); | |
302 | int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq); | |
5325b427 | 303 | int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); |
3ccc646b | 304 | int (*s_stream)(struct v4l2_subdev *sd, int enable); |
2a1fcdf0 HV |
305 | }; |
306 | ||
29103119 SN |
307 | /* Indicates the @length field specifies maximum data length. */ |
308 | #define V4L2_MBUS_FRAME_DESC_FL_LEN_MAX (1U << 0) | |
174d6a39 SA |
309 | /* |
310 | * Indicates that the format does not have line offsets, i.e. the | |
311 | * receiver should use 1D DMA. | |
312 | */ | |
29103119 SN |
313 | #define V4L2_MBUS_FRAME_DESC_FL_BLOB (1U << 1) |
314 | ||
315 | /** | |
316 | * struct v4l2_mbus_frame_desc_entry - media bus frame description structure | |
5c662984 | 317 | * |
21c29de1 MCC |
318 | * @flags: bitmask flags: %V4L2_MBUS_FRAME_DESC_FL_LEN_MAX and |
319 | * %V4L2_MBUS_FRAME_DESC_FL_BLOB. | |
29103119 | 320 | * @pixelcode: media bus pixel code, valid if FRAME_DESC_FL_BLOB is not set |
174d6a39 SA |
321 | * @length: number of octets per frame, valid if V4L2_MBUS_FRAME_DESC_FL_BLOB |
322 | * is set | |
29103119 SN |
323 | */ |
324 | struct v4l2_mbus_frame_desc_entry { | |
325 | u16 flags; | |
326 | u32 pixelcode; | |
327 | u32 length; | |
328 | }; | |
329 | ||
330 | #define V4L2_FRAME_DESC_ENTRY_MAX 4 | |
331 | ||
332 | /** | |
333 | * struct v4l2_mbus_frame_desc - media bus data frame description | |
334 | * @entry: frame descriptors array | |
335 | * @num_entries: number of entries in @entry array | |
336 | */ | |
337 | struct v4l2_mbus_frame_desc { | |
338 | struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX]; | |
339 | unsigned short num_entries; | |
340 | }; | |
341 | ||
5c662984 MCC |
342 | /** |
343 | * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened | |
21c29de1 | 344 | * in video mode. |
b84aeb03 MCC |
345 | * |
346 | * @s_routing: see s_routing in audio_ops, except this version is for video | |
347 | * devices. | |
348 | * | |
349 | * @s_crystal_freq: sets the frequency of the crystal used to generate the | |
350 | * clocks in Hz. An extra flags field allows device specific configuration | |
351 | * regarding clock frequency dividers, etc. If not used, then set flags | |
352 | * to 0. If the frequency is not supported, then -EINVAL is returned. | |
353 | * | |
3fb558f6 | 354 | * @g_std: callback for VIDIOC_G_STD() ioctl handler code. |
914728ab | 355 | * |
3fb558f6 | 356 | * @s_std: callback for VIDIOC_S_STD() ioctl handler code. |
914728ab | 357 | * |
5c662984 MCC |
358 | * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by |
359 | * video input devices. | |
360 | * | |
361 | * @g_std_output: get current standard for video OUTPUT devices. This is ignored | |
362 | * by video input devices. | |
363 | * | |
3fb558f6 | 364 | * @querystd: callback for VIDIOC_QUERYSTD() ioctl handler code. |
914728ab | 365 | * |
21c29de1 | 366 | * @g_tvnorms: get &v4l2_std_id with all standards supported by the video |
5c662984 MCC |
367 | * CAPTURE device. This is ignored by video output devices. |
368 | * | |
369 | * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video | |
370 | * OUTPUT device. This is ignored by video capture devices. | |
371 | * | |
21c29de1 MCC |
372 | * @g_input_status: get input status. Same as the status field in the |
373 | * &struct &v4l2_input | |
5c662984 | 374 | * |
1d8955b2 MCC |
375 | * @s_stream: used to notify the driver that a video stream will start or has |
376 | * stopped. | |
377 | * | |
ecf37493 | 378 | * @g_pixelaspect: callback to return the pixelaspect ratio. |
914728ab | 379 | * |
3fb558f6 | 380 | * @g_parm: callback for VIDIOC_G_PARM() ioctl handler code. |
914728ab | 381 | * |
3fb558f6 | 382 | * @s_parm: callback for VIDIOC_S_PARM() ioctl handler code. |
914728ab | 383 | * |
3fb558f6 MCC |
384 | * @g_frame_interval: callback for VIDIOC_SUBDEV_G_FRAME_INTERVAL() |
385 | * ioctl handler code. | |
914728ab | 386 | * |
3fb558f6 MCC |
387 | * @s_frame_interval: callback for VIDIOC_SUBDEV_S_FRAME_INTERVAL() |
388 | * ioctl handler code. | |
914728ab MCC |
389 | * |
390 | * @s_dv_timings: Set custom dv timings in the sub device. This is used | |
5c662984 MCC |
391 | * when sub device is capable of setting detailed timing information |
392 | * in the hardware to generate/detect the video signal. | |
393 | * | |
914728ab MCC |
394 | * @g_dv_timings: Get custom dv timings in the sub device. |
395 | * | |
3fb558f6 | 396 | * @query_dv_timings: callback for VIDIOC_QUERY_DV_TIMINGS() ioctl handler code. |
b84aeb03 | 397 | * |
5c662984 MCC |
398 | * @g_mbus_config: get supported mediabus configurations |
399 | * | |
400 | * @s_mbus_config: set a certain mediabus configuration. This operation is added | |
401 | * for compatibility with soc-camera drivers and should not be used by new | |
402 | * software. | |
403 | * | |
404 | * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev | |
405 | * can adjust @size to a lower value and must not write more data to the | |
406 | * buffer starting at @data than the original value of @size. | |
78a3b4db | 407 | */ |
2a1fcdf0 | 408 | struct v4l2_subdev_video_ops { |
5325b427 | 409 | int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); |
3ff4ad81 | 410 | int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags); |
8774bed9 LP |
411 | int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm); |
412 | int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm); | |
2a1fcdf0 | 413 | int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std); |
5930ab2b | 414 | int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std); |
1b6f1d96 | 415 | int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std); |
48353863 | 416 | int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std); |
839cf813 | 417 | int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std); |
1b6f1d96 | 418 | int (*g_input_status)(struct v4l2_subdev *sd, u32 *status); |
2a1fcdf0 | 419 | int (*s_stream)(struct v4l2_subdev *sd, int enable); |
ecf37493 | 420 | int (*g_pixelaspect)(struct v4l2_subdev *sd, struct v4l2_fract *aspect); |
2da9479a HV |
421 | int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); |
422 | int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); | |
35c3017a LP |
423 | int (*g_frame_interval)(struct v4l2_subdev *sd, |
424 | struct v4l2_subdev_frame_interval *interval); | |
425 | int (*s_frame_interval)(struct v4l2_subdev *sd, | |
426 | struct v4l2_subdev_frame_interval *interval); | |
b6456c0c MK |
427 | int (*s_dv_timings)(struct v4l2_subdev *sd, |
428 | struct v4l2_dv_timings *timings); | |
429 | int (*g_dv_timings)(struct v4l2_subdev *sd, | |
430 | struct v4l2_dv_timings *timings); | |
5d7758ee HV |
431 | int (*query_dv_timings)(struct v4l2_subdev *sd, |
432 | struct v4l2_dv_timings *timings); | |
91c79530 GL |
433 | int (*g_mbus_config)(struct v4l2_subdev *sd, |
434 | struct v4l2_mbus_config *cfg); | |
435 | int (*s_mbus_config)(struct v4l2_subdev *sd, | |
436 | const struct v4l2_mbus_config *cfg); | |
a375e1df SN |
437 | int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf, |
438 | unsigned int *size); | |
2a1fcdf0 HV |
439 | }; |
440 | ||
5c662984 MCC |
441 | /** |
442 | * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened | |
21c29de1 | 443 | * in video mode via the vbi device node. |
5c662984 MCC |
444 | * |
445 | * @decode_vbi_line: video decoders that support sliced VBI need to implement | |
9ef0b3f3 | 446 | * this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the |
5c662984 MCC |
447 | * start of the VBI data that was generated by the decoder. The driver |
448 | * then parses the sliced VBI data and sets the other fields in the | |
449 | * struct accordingly. The pointer p is updated to point to the start of | |
450 | * the payload which can be copied verbatim into the data field of the | |
21c29de1 | 451 | * &struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the |
5c662984 MCC |
452 | * type field is set to 0 on return. |
453 | * | |
454 | * @s_vbi_data: used to generate VBI signals on a video signal. | |
21c29de1 MCC |
455 | * &struct v4l2_sliced_vbi_data is filled with the data packets that |
456 | * should be output. Note that if you set the line field to 0, then that | |
457 | * VBI signal is disabled. If no valid VBI data was found, then the type | |
458 | * field is set to 0 on return. | |
5c662984 MCC |
459 | * |
460 | * @g_vbi_data: used to obtain the sliced VBI packet from a readback register. | |
461 | * Not all video decoders support this. If no data is available because | |
21c29de1 | 462 | * the readback register contains invalid or erroneous data %-EIO is |
5c662984 MCC |
463 | * returned. Note that you must fill in the 'id' member and the 'field' |
464 | * member (to determine whether CC data from the first or second field | |
465 | * should be obtained). | |
466 | * | |
3fb558f6 MCC |
467 | * @g_sliced_vbi_cap: callback for VIDIOC_G_SLICED_VBI_CAP() ioctl handler |
468 | * code. | |
e44cc20a | 469 | * |
5c662984 MCC |
470 | * @s_raw_fmt: setup the video encoder/decoder for raw VBI. |
471 | * | |
472 | * @g_sliced_fmt: retrieve the current sliced VBI settings. | |
473 | * | |
474 | * @s_sliced_fmt: setup the sliced VBI settings. | |
32cd527f HV |
475 | */ |
476 | struct v4l2_subdev_vbi_ops { | |
477 | int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line); | |
478 | int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data); | |
479 | int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data); | |
480 | int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap); | |
54aefafb HV |
481 | int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt); |
482 | int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); | |
483 | int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); | |
32cd527f HV |
484 | }; |
485 | ||
32536108 GL |
486 | /** |
487 | * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations | |
488 | * @g_skip_top_lines: number of lines at the top of the image to be skipped. | |
489 | * This is needed for some sensors, which always corrupt | |
490 | * several top lines of the output image, or which send their | |
491 | * metadata in them. | |
f80a3ab0 LP |
492 | * @g_skip_frames: number of frames to skip at stream start. This is needed for |
493 | * buggy sensors that generate faulty frames when they are | |
494 | * turned on. | |
32536108 GL |
495 | */ |
496 | struct v4l2_subdev_sensor_ops { | |
497 | int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines); | |
f80a3ab0 | 498 | int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames); |
32536108 GL |
499 | }; |
500 | ||
21c29de1 MCC |
501 | /** |
502 | * enum v4l2_subdev_ir_mode- describes the type of IR supported | |
503 | * | |
504 | * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records | |
1d986add | 505 | */ |
1d986add | 506 | enum v4l2_subdev_ir_mode { |
21c29de1 | 507 | V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, |
1d986add AW |
508 | }; |
509 | ||
21c29de1 MCC |
510 | /** |
511 | * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX | |
512 | * | |
513 | * @bytes_per_data_element: bytes per data element of data in read or | |
514 | * write call. | |
515 | * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode. | |
516 | * @enable: device is active if true | |
517 | * @interrupt_enable: IR interrupts are enabled if true | |
518 | * @shutdown: if true: set hardware to low/no power, false: normal mode | |
519 | * | |
520 | * @modulation: if true, it uses carrier, if false: baseband | |
521 | * @max_pulse_width: maximum pulse width in ns, valid only for baseband signal | |
522 | * @carrier_freq: carrier frequency in Hz, valid only for modulated signal | |
523 | * @duty_cycle: duty cycle percentage, valid only for modulated signal | |
524 | * @invert_level: invert signal level | |
525 | * | |
526 | * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX. | |
527 | * | |
528 | * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX. | |
529 | * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated | |
530 | * signal. Used only for RX. | |
531 | * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated | |
532 | * signal. Used only for RX. | |
533 | * @resolution: The receive resolution, in ns . Used only for RX. | |
534 | */ | |
1d986add | 535 | struct v4l2_subdev_ir_parameters { |
21c29de1 | 536 | unsigned int bytes_per_data_element; |
1d986add AW |
537 | enum v4l2_subdev_ir_mode mode; |
538 | ||
539 | bool enable; | |
540 | bool interrupt_enable; | |
21c29de1 | 541 | bool shutdown; |
1d986add | 542 | |
21c29de1 MCC |
543 | bool modulation; |
544 | u32 max_pulse_width; | |
545 | unsigned int carrier_freq; | |
546 | unsigned int duty_cycle; | |
547 | bool invert_level; | |
5a28d9a3 AW |
548 | |
549 | /* Tx only */ | |
21c29de1 | 550 | bool invert_carrier_sense; |
1d986add AW |
551 | |
552 | /* Rx only */ | |
21c29de1 MCC |
553 | u32 noise_filter_min_width; |
554 | unsigned int carrier_range_lower; | |
555 | unsigned int carrier_range_upper; | |
556 | u32 resolution; | |
1d986add AW |
557 | }; |
558 | ||
21c29de1 MCC |
559 | /** |
560 | * struct v4l2_subdev_ir_ops - operations for IR subdevices | |
561 | * | |
562 | * @rx_read: Reads received codes or pulse width data. | |
563 | * The semantics are similar to a non-blocking read() call. | |
564 | * @rx_g_parameters: Get the current operating parameters and state of the | |
565 | * the IR receiver. | |
566 | * @rx_s_parameters: Set the current operating parameters and state of the | |
567 | * the IR receiver. It is recommended to call | |
568 | * [rt]x_g_parameters first to fill out the current state, and only change | |
569 | * the fields that need to be changed. Upon return, the actual device | |
570 | * operating parameters and state will be returned. Note that hardware | |
571 | * limitations may prevent the actual settings from matching the requested | |
572 | * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz | |
573 | * was requested. An exception is when the shutdown parameter is true. | |
574 | * The last used operational parameters will be returned, but the actual | |
575 | * state of the hardware be different to minimize power consumption and | |
576 | * processing when shutdown is true. | |
577 | * | |
578 | * @tx_write: Writes codes or pulse width data for transmission. | |
579 | * The semantics are similar to a non-blocking write() call. | |
580 | * @tx_g_parameters: Get the current operating parameters and state of the | |
581 | * the IR transmitter. | |
582 | * @tx_s_parameters: Set the current operating parameters and state of the | |
583 | * the IR transmitter. It is recommended to call | |
584 | * [rt]x_g_parameters first to fill out the current state, and only change | |
585 | * the fields that need to be changed. Upon return, the actual device | |
586 | * operating parameters and state will be returned. Note that hardware | |
587 | * limitations may prevent the actual settings from matching the requested | |
588 | * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz | |
589 | * was requested. An exception is when the shutdown parameter is true. | |
590 | * The last used operational parameters will be returned, but the actual | |
591 | * state of the hardware be different to minimize power consumption and | |
592 | * processing when shutdown is true. | |
593 | */ | |
1d986add | 594 | struct v4l2_subdev_ir_ops { |
1d986add AW |
595 | /* Receiver */ |
596 | int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count, | |
597 | ssize_t *num); | |
598 | ||
599 | int (*rx_g_parameters)(struct v4l2_subdev *sd, | |
600 | struct v4l2_subdev_ir_parameters *params); | |
601 | int (*rx_s_parameters)(struct v4l2_subdev *sd, | |
602 | struct v4l2_subdev_ir_parameters *params); | |
603 | ||
604 | /* Transmitter */ | |
605 | int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count, | |
606 | ssize_t *num); | |
607 | ||
608 | int (*tx_g_parameters)(struct v4l2_subdev *sd, | |
609 | struct v4l2_subdev_ir_parameters *params); | |
610 | int (*tx_s_parameters)(struct v4l2_subdev *sd, | |
611 | struct v4l2_subdev_ir_parameters *params); | |
612 | }; | |
613 | ||
21c29de1 MCC |
614 | /** |
615 | * struct v4l2_subdev_pad_config - Used for storing subdev pad information. | |
616 | * | |
1059b687 BS |
617 | * @try_fmt: &struct v4l2_mbus_framefmt |
618 | * @try_crop: &struct v4l2_rect to be used for crop | |
619 | * @try_compose: &struct v4l2_rect to be used for compose | |
21c29de1 MCC |
620 | * |
621 | * This structure only needs to be passed to the pad op if the 'which' field | |
622 | * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For | |
623 | * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL. | |
f7234138 HV |
624 | */ |
625 | struct v4l2_subdev_pad_config { | |
626 | struct v4l2_mbus_framefmt try_fmt; | |
627 | struct v4l2_rect try_crop; | |
628 | struct v4l2_rect try_compose; | |
629 | }; | |
630 | ||
29103119 SN |
631 | /** |
632 | * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations | |
e44cc20a | 633 | * |
9b02cbb3 | 634 | * @init_cfg: initialize the pad config to default values |
3fb558f6 | 635 | * @enum_mbus_code: callback for VIDIOC_SUBDEV_ENUM_MBUS_CODE() ioctl handler |
e44cc20a | 636 | * code. |
3fb558f6 | 637 | * @enum_frame_size: callback for VIDIOC_SUBDEV_ENUM_FRAME_SIZE() ioctl handler |
e44cc20a MCC |
638 | * code. |
639 | * | |
3fb558f6 | 640 | * @enum_frame_interval: callback for VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL() ioctl |
e44cc20a MCC |
641 | * handler code. |
642 | * | |
3fb558f6 | 643 | * @get_fmt: callback for VIDIOC_SUBDEV_G_FMT() ioctl handler code. |
e44cc20a | 644 | * |
3fb558f6 | 645 | * @set_fmt: callback for VIDIOC_SUBDEV_S_FMT() ioctl handler code. |
e44cc20a | 646 | * |
3fb558f6 | 647 | * @get_selection: callback for VIDIOC_SUBDEV_G_SELECTION() ioctl handler code. |
e44cc20a | 648 | * |
3fb558f6 | 649 | * @set_selection: callback for VIDIOC_SUBDEV_S_SELECTION() ioctl handler code. |
e44cc20a | 650 | * |
3fb558f6 | 651 | * @get_edid: callback for VIDIOC_SUBDEV_G_EDID() ioctl handler code. |
e44cc20a | 652 | * |
3fb558f6 | 653 | * @set_edid: callback for VIDIOC_SUBDEV_S_EDID() ioctl handler code. |
e44cc20a | 654 | * |
3fb558f6 | 655 | * @dv_timings_cap: callback for VIDIOC_SUBDEV_DV_TIMINGS_CAP() ioctl handler |
e44cc20a MCC |
656 | * code. |
657 | * | |
3fb558f6 | 658 | * @enum_dv_timings: callback for VIDIOC_SUBDEV_ENUM_DV_TIMINGS() ioctl handler |
e44cc20a MCC |
659 | * code. |
660 | * | |
1d8955b2 MCC |
661 | * @link_validate: used by the media controller code to check if the links |
662 | * that belongs to a pipeline can be used for stream. | |
663 | * | |
29103119 | 664 | * @get_frame_desc: get the current low level media bus frame parameters. |
e44cc20a | 665 | * |
1d8955b2 | 666 | * @set_frame_desc: set the low level media bus frame parameters, @fd array |
29103119 SN |
667 | * may be adjusted by the subdev driver to device capabilities. |
668 | */ | |
eb08f354 | 669 | struct v4l2_subdev_pad_ops { |
9b02cbb3 LP |
670 | int (*init_cfg)(struct v4l2_subdev *sd, |
671 | struct v4l2_subdev_pad_config *cfg); | |
f7234138 HV |
672 | int (*enum_mbus_code)(struct v4l2_subdev *sd, |
673 | struct v4l2_subdev_pad_config *cfg, | |
333c8b97 LP |
674 | struct v4l2_subdev_mbus_code_enum *code); |
675 | int (*enum_frame_size)(struct v4l2_subdev *sd, | |
f7234138 | 676 | struct v4l2_subdev_pad_config *cfg, |
333c8b97 | 677 | struct v4l2_subdev_frame_size_enum *fse); |
35c3017a | 678 | int (*enum_frame_interval)(struct v4l2_subdev *sd, |
f7234138 | 679 | struct v4l2_subdev_pad_config *cfg, |
35c3017a | 680 | struct v4l2_subdev_frame_interval_enum *fie); |
f7234138 HV |
681 | int (*get_fmt)(struct v4l2_subdev *sd, |
682 | struct v4l2_subdev_pad_config *cfg, | |
333c8b97 | 683 | struct v4l2_subdev_format *format); |
f7234138 HV |
684 | int (*set_fmt)(struct v4l2_subdev *sd, |
685 | struct v4l2_subdev_pad_config *cfg, | |
333c8b97 | 686 | struct v4l2_subdev_format *format); |
f7234138 HV |
687 | int (*get_selection)(struct v4l2_subdev *sd, |
688 | struct v4l2_subdev_pad_config *cfg, | |
ae184cda | 689 | struct v4l2_subdev_selection *sel); |
f7234138 HV |
690 | int (*set_selection)(struct v4l2_subdev *sd, |
691 | struct v4l2_subdev_pad_config *cfg, | |
ae184cda | 692 | struct v4l2_subdev_selection *sel); |
dd519bb3 HV |
693 | int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); |
694 | int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); | |
0349f6a5 LP |
695 | int (*dv_timings_cap)(struct v4l2_subdev *sd, |
696 | struct v4l2_dv_timings_cap *cap); | |
697 | int (*enum_dv_timings)(struct v4l2_subdev *sd, | |
698 | struct v4l2_enum_dv_timings *timings); | |
8227c92b SA |
699 | #ifdef CONFIG_MEDIA_CONTROLLER |
700 | int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link, | |
701 | struct v4l2_subdev_format *source_fmt, | |
702 | struct v4l2_subdev_format *sink_fmt); | |
703 | #endif /* CONFIG_MEDIA_CONTROLLER */ | |
29103119 SN |
704 | int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, |
705 | struct v4l2_mbus_frame_desc *fd); | |
706 | int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, | |
707 | struct v4l2_mbus_frame_desc *fd); | |
eb08f354 LP |
708 | }; |
709 | ||
21c29de1 MCC |
710 | /** |
711 | * struct v4l2_subdev_ops - Subdev operations | |
712 | * | |
713 | * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL | |
714 | * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL | |
715 | * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL | |
716 | * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL | |
717 | * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL | |
718 | * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL | |
719 | * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL | |
720 | * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL | |
721 | */ | |
2a1fcdf0 | 722 | struct v4l2_subdev_ops { |
32536108 GL |
723 | const struct v4l2_subdev_core_ops *core; |
724 | const struct v4l2_subdev_tuner_ops *tuner; | |
725 | const struct v4l2_subdev_audio_ops *audio; | |
726 | const struct v4l2_subdev_video_ops *video; | |
32cd527f | 727 | const struct v4l2_subdev_vbi_ops *vbi; |
32536108 GL |
728 | const struct v4l2_subdev_ir_ops *ir; |
729 | const struct v4l2_subdev_sensor_ops *sensor; | |
eb08f354 | 730 | const struct v4l2_subdev_pad_ops *pad; |
2a1fcdf0 HV |
731 | }; |
732 | ||
21c29de1 MCC |
733 | /** |
734 | * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops | |
45f6f84a | 735 | * |
21c29de1 | 736 | * @registered: called when this subdev is registered. When called the v4l2_dev |
45f6f84a HV |
737 | * field is set to the correct v4l2_device. |
738 | * | |
21c29de1 | 739 | * @unregistered: called when this subdev is unregistered. When called the |
45f6f84a | 740 | * v4l2_dev field is still set to the correct v4l2_device. |
f0beea8f | 741 | * |
21c29de1 | 742 | * @open: called when the subdev device node is opened by an application. |
f0beea8f | 743 | * |
21c29de1 MCC |
744 | * @close: called when the subdev device node is closed. |
745 | * | |
746 | * .. note:: | |
747 | * Never call this from drivers, only the v4l2 framework can call | |
748 | * these ops. | |
45f6f84a HV |
749 | */ |
750 | struct v4l2_subdev_internal_ops { | |
751 | int (*registered)(struct v4l2_subdev *sd); | |
752 | void (*unregistered)(struct v4l2_subdev *sd); | |
f0beea8f LP |
753 | int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); |
754 | int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); | |
45f6f84a HV |
755 | }; |
756 | ||
2a1fcdf0 HV |
757 | #define V4L2_SUBDEV_NAME_SIZE 32 |
758 | ||
b5b2b7ed | 759 | /* Set this flag if this subdev is a i2c device. */ |
2096a5dc | 760 | #define V4L2_SUBDEV_FL_IS_I2C (1U << 0) |
85e09219 | 761 | /* Set this flag if this subdev is a spi device. */ |
2096a5dc LP |
762 | #define V4L2_SUBDEV_FL_IS_SPI (1U << 1) |
763 | /* Set this flag if this subdev needs a device node. */ | |
764 | #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2) | |
02adb1cc SA |
765 | /* Set this flag if this subdev generates events. */ |
766 | #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3) | |
b5b2b7ed | 767 | |
b1cbab05 GL |
768 | struct regulator_bulk_data; |
769 | ||
21c29de1 MCC |
770 | /** |
771 | * struct v4l2_subdev_platform_data - regulators config struct | |
772 | * | |
773 | * @regulators: Optional regulators used to power on/off the subdevice | |
774 | * @num_regulators: Number of regululators | |
775 | * @host_priv: Per-subdevice data, specific for a certain video host device | |
776 | */ | |
b1cbab05 | 777 | struct v4l2_subdev_platform_data { |
b1cbab05 GL |
778 | struct regulator_bulk_data *regulators; |
779 | int num_regulators; | |
780 | ||
b1cbab05 GL |
781 | void *host_priv; |
782 | }; | |
783 | ||
21c29de1 MCC |
784 | /** |
785 | * struct v4l2_subdev - describes a V4L2 sub-device | |
786 | * | |
787 | * @entity: pointer to &struct media_entity | |
788 | * @list: List of sub-devices | |
789 | * @owner: The owner is the same as the driver's &struct device owner. | |
cb8d67cf | 790 | * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev |
0722ef82 | 791 | * owner. Initialized by v4l2_device_register_subdev(). |
21c29de1 MCC |
792 | * @flags: subdev flags. Can be: |
793 | * %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device; | |
794 | * %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device; | |
795 | * %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a | |
796 | * device node; | |
797 | * %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates | |
798 | * events. | |
799 | * | |
cb8d67cf MCC |
800 | * @v4l2_dev: pointer to struct &v4l2_device |
801 | * @ops: pointer to struct &v4l2_subdev_ops | |
802 | * @internal_ops: pointer to struct &v4l2_subdev_internal_ops. | |
21c29de1 MCC |
803 | * Never call these internal ops from within a driver! |
804 | * @ctrl_handler: The control handler of this subdev. May be NULL. | |
805 | * @name: Name of the sub-device. Please notice that the name must be unique. | |
806 | * @grp_id: can be used to group similar subdevs. Value is driver-specific | |
807 | * @dev_priv: pointer to private data | |
808 | * @host_priv: pointer to private data used by the device where the subdev | |
809 | * is attached. | |
810 | * @devnode: subdev device node | |
811 | * @dev: pointer to the physical device, if any | |
ecdf0cfe SA |
812 | * @fwnode: The fwnode_handle of the subdev, usually the same as |
813 | * either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL). | |
21c29de1 MCC |
814 | * @async_list: Links this subdev to a global subdev_list or @notifier->done |
815 | * list. | |
816 | * @asd: Pointer to respective &struct v4l2_async_subdev. | |
817 | * @notifier: Pointer to the managing notifier. | |
aef69d54 SA |
818 | * @subdev_notifier: A sub-device notifier implicitly registered for the sub- |
819 | * device using v4l2_device_register_sensor_subdev(). | |
21c29de1 MCC |
820 | * @pdata: common part of subdevice platform data |
821 | * | |
822 | * Each instance of a subdev driver should create this struct, either | |
823 | * stand-alone or embedded in a larger struct. | |
824 | * | |
825 | * This structure should be initialized by v4l2_subdev_init() or one of | |
826 | * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init(). | |
2a1fcdf0 HV |
827 | */ |
828 | struct v4l2_subdev { | |
61f5db54 LP |
829 | #if defined(CONFIG_MEDIA_CONTROLLER) |
830 | struct media_entity entity; | |
831 | #endif | |
2a1fcdf0 HV |
832 | struct list_head list; |
833 | struct module *owner; | |
b2a06aec | 834 | bool owner_v4l2_dev; |
b5b2b7ed | 835 | u32 flags; |
b0167600 | 836 | struct v4l2_device *v4l2_dev; |
2a1fcdf0 | 837 | const struct v4l2_subdev_ops *ops; |
45f6f84a | 838 | const struct v4l2_subdev_internal_ops *internal_ops; |
0996517c | 839 | struct v4l2_ctrl_handler *ctrl_handler; |
2a1fcdf0 | 840 | char name[V4L2_SUBDEV_NAME_SIZE]; |
2a1fcdf0 | 841 | u32 grp_id; |
692d5522 LP |
842 | void *dev_priv; |
843 | void *host_priv; | |
3e0ec41c | 844 | struct video_device *devnode; |
668773b8 | 845 | struct device *dev; |
ecdf0cfe | 846 | struct fwnode_handle *fwnode; |
b426b3a6 | 847 | struct list_head async_list; |
b426b3a6 | 848 | struct v4l2_async_subdev *asd; |
b426b3a6 | 849 | struct v4l2_async_notifier *notifier; |
aef69d54 | 850 | struct v4l2_async_notifier *subdev_notifier; |
b1cbab05 | 851 | struct v4l2_subdev_platform_data *pdata; |
2a1fcdf0 HV |
852 | }; |
853 | ||
47f910f0 KB |
854 | #define media_entity_to_v4l2_subdev(ent) \ |
855 | ({ \ | |
856 | typeof(ent) __me_sd_ent = (ent); \ | |
857 | \ | |
858 | __me_sd_ent ? \ | |
859 | container_of(__me_sd_ent, struct v4l2_subdev, entity) : \ | |
860 | NULL; \ | |
861 | }) | |
862 | ||
2096a5dc | 863 | #define vdev_to_v4l2_subdev(vdev) \ |
c5a766ce | 864 | ((struct v4l2_subdev *)video_get_drvdata(vdev)) |
2096a5dc | 865 | |
21c29de1 MCC |
866 | /** |
867 | * struct v4l2_subdev_fh - Used for storing subdev information per file handle | |
868 | * | |
869 | * @vfh: pointer to struct v4l2_fh | |
870 | * @pad: pointer to v4l2_subdev_pad_config | |
7cd5a16b SV |
871 | */ |
872 | struct v4l2_subdev_fh { | |
873 | struct v4l2_fh vfh; | |
874 | #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) | |
f7234138 | 875 | struct v4l2_subdev_pad_config *pad; |
7cd5a16b SV |
876 | #endif |
877 | }; | |
878 | ||
879 | #define to_v4l2_subdev_fh(fh) \ | |
880 | container_of(fh, struct v4l2_subdev_fh, vfh) | |
881 | ||
882 | #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) | |
5e6ff7c1 SA |
883 | #define __V4L2_SUBDEV_MK_GET_TRY(rtype, fun_name, field_name) \ |
884 | static inline struct rtype * \ | |
f7234138 HV |
885 | fun_name(struct v4l2_subdev *sd, \ |
886 | struct v4l2_subdev_pad_config *cfg, \ | |
887 | unsigned int pad) \ | |
5e6ff7c1 | 888 | { \ |
f7234138 HV |
889 | BUG_ON(pad >= sd->entity.num_pads); \ |
890 | return &cfg[pad].field_name; \ | |
5e6ff7c1 SA |
891 | } |
892 | ||
f7234138 HV |
893 | __V4L2_SUBDEV_MK_GET_TRY(v4l2_mbus_framefmt, v4l2_subdev_get_try_format, try_fmt) |
894 | __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_crop, try_crop) | |
895 | __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_compose, try_compose) | |
7cd5a16b SV |
896 | #endif |
897 | ||
2096a5dc LP |
898 | extern const struct v4l2_file_operations v4l2_subdev_fops; |
899 | ||
21c29de1 MCC |
900 | /** |
901 | * v4l2_set_subdevdata - Sets V4L2 dev private device data | |
902 | * | |
903 | * @sd: pointer to &struct v4l2_subdev | |
904 | * @p: pointer to the private device data to be stored. | |
905 | */ | |
2a1fcdf0 HV |
906 | static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p) |
907 | { | |
692d5522 | 908 | sd->dev_priv = p; |
2a1fcdf0 HV |
909 | } |
910 | ||
21c29de1 MCC |
911 | /** |
912 | * v4l2_get_subdevdata - Gets V4L2 dev private device data | |
913 | * | |
914 | * @sd: pointer to &struct v4l2_subdev | |
915 | * | |
916 | * Returns the pointer to the private device data to be stored. | |
917 | */ | |
2a1fcdf0 HV |
918 | static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd) |
919 | { | |
692d5522 LP |
920 | return sd->dev_priv; |
921 | } | |
922 | ||
21c29de1 | 923 | /** |
e383ce07 | 924 | * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data |
21c29de1 MCC |
925 | * |
926 | * @sd: pointer to &struct v4l2_subdev | |
927 | * @p: pointer to the private data to be stored. | |
928 | */ | |
692d5522 LP |
929 | static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p) |
930 | { | |
931 | sd->host_priv = p; | |
932 | } | |
933 | ||
21c29de1 | 934 | /** |
e383ce07 | 935 | * v4l2_get_subdev_hostdata - Gets V4L2 dev private data |
21c29de1 MCC |
936 | * |
937 | * @sd: pointer to &struct v4l2_subdev | |
938 | * | |
939 | * Returns the pointer to the private host data to be stored. | |
940 | */ | |
692d5522 LP |
941 | static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd) |
942 | { | |
943 | return sd->host_priv; | |
2a1fcdf0 HV |
944 | } |
945 | ||
8227c92b | 946 | #ifdef CONFIG_MEDIA_CONTROLLER |
21c29de1 MCC |
947 | |
948 | /** | |
949 | * v4l2_subdev_link_validate_default - validates a media link | |
950 | * | |
951 | * @sd: pointer to &struct v4l2_subdev | |
952 | * @link: pointer to &struct media_link | |
953 | * @source_fmt: pointer to &struct v4l2_subdev_format | |
954 | * @sink_fmt: pointer to &struct v4l2_subdev_format | |
955 | * | |
956 | * This function ensures that width, height and the media bus pixel | |
957 | * code are equal on both source and sink of the link. | |
958 | */ | |
8227c92b SA |
959 | int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd, |
960 | struct media_link *link, | |
961 | struct v4l2_subdev_format *source_fmt, | |
962 | struct v4l2_subdev_format *sink_fmt); | |
21c29de1 MCC |
963 | |
964 | /** | |
965 | * v4l2_subdev_link_validate - validates a media link | |
966 | * | |
967 | * @link: pointer to &struct media_link | |
968 | * | |
969 | * This function calls the subdev's link_validate ops to validate | |
970 | * if a media link is valid for streaming. It also internally | |
971 | * calls v4l2_subdev_link_validate_default() to ensure that | |
972 | * width, height and the media bus pixel code are equal on both | |
973 | * source and sink of the link. | |
974 | */ | |
8227c92b | 975 | int v4l2_subdev_link_validate(struct media_link *link); |
9b02cbb3 | 976 | |
21c29de1 MCC |
977 | /** |
978 | * v4l2_subdev_alloc_pad_config - Allocates memory for pad config | |
979 | * | |
980 | * @sd: pointer to struct v4l2_subdev | |
981 | */ | |
982 | struct | |
983 | v4l2_subdev_pad_config *v4l2_subdev_alloc_pad_config(struct v4l2_subdev *sd); | |
984 | ||
985 | /** | |
986 | * v4l2_subdev_free_pad_config - Frees memory allocated by | |
987 | * v4l2_subdev_alloc_pad_config(). | |
988 | * | |
989 | * @cfg: pointer to &struct v4l2_subdev_pad_config | |
990 | */ | |
9b02cbb3 | 991 | void v4l2_subdev_free_pad_config(struct v4l2_subdev_pad_config *cfg); |
8227c92b | 992 | #endif /* CONFIG_MEDIA_CONTROLLER */ |
9b02cbb3 | 993 | |
21c29de1 MCC |
994 | /** |
995 | * v4l2_subdev_init - initializes the sub-device struct | |
996 | * | |
997 | * @sd: pointer to the &struct v4l2_subdev to be initialized | |
998 | * @ops: pointer to &struct v4l2_subdev_ops. | |
999 | */ | |
3dd5ee08 LP |
1000 | void v4l2_subdev_init(struct v4l2_subdev *sd, |
1001 | const struct v4l2_subdev_ops *ops); | |
2a1fcdf0 | 1002 | |
21c29de1 MCC |
1003 | /* |
1004 | * Call an ops of a v4l2_subdev, doing the right checks against | |
1005 | * NULL pointers. | |
1006 | * | |
1007 | * Example: err = v4l2_subdev_call(sd, video, s_std, norm); | |
2a1fcdf0 HV |
1008 | */ |
1009 | #define v4l2_subdev_call(sd, o, f, args...) \ | |
da48c948 AB |
1010 | ({ \ |
1011 | int __result; \ | |
1012 | if (!(sd)) \ | |
1013 | __result = -ENODEV; \ | |
1014 | else if (!((sd)->ops->o && (sd)->ops->o->f)) \ | |
1015 | __result = -ENOIOCTLCMD; \ | |
1016 | else \ | |
1017 | __result = (sd)->ops->o->f((sd), ##args); \ | |
1018 | __result; \ | |
1019 | }) | |
2a1fcdf0 | 1020 | |
2180f92d HV |
1021 | #define v4l2_subdev_has_op(sd, o, f) \ |
1022 | ((sd)->ops->o && (sd)->ops->o->f) | |
1023 | ||
21c29de1 MCC |
1024 | /** |
1025 | * v4l2_subdev_notify_event() - Delivers event notification for subdevice | |
1026 | * @sd: The subdev for which to deliver the event | |
1027 | * @ev: The event to deliver | |
1028 | * | |
1029 | * Will deliver the specified event to all userspace event listeners which are | |
1030 | * subscribed to the v42l subdev event queue as well as to the bridge driver | |
1031 | * using the notify callback. The notification type for the notify callback | |
1032 | * will be %V4L2_DEVICE_NOTIFY_EVENT. | |
1033 | */ | |
8ae5640f LPC |
1034 | void v4l2_subdev_notify_event(struct v4l2_subdev *sd, |
1035 | const struct v4l2_event *ev); | |
1036 | ||
2a1fcdf0 | 1037 | #endif |