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