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