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