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