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