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