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 <media/v4l2-common.h> 25 #include <media/v4l2-mediabus.h> 26 27 /* generic v4l2_device notify callback notification values */ 28 #define V4L2_SUBDEV_IR_RX_NOTIFY _IOW('v', 0, u32) 29 #define V4L2_SUBDEV_IR_RX_FIFO_SERVICE_REQ 0x00000001 30 #define V4L2_SUBDEV_IR_RX_END_OF_RX_DETECTED 0x00000002 31 #define V4L2_SUBDEV_IR_RX_HW_FIFO_OVERRUN 0x00000004 32 #define V4L2_SUBDEV_IR_RX_SW_FIFO_OVERRUN 0x00000008 33 34 #define V4L2_SUBDEV_IR_TX_NOTIFY _IOW('v', 1, u32) 35 #define V4L2_SUBDEV_IR_TX_FIFO_SERVICE_REQ 0x00000001 36 37 struct v4l2_device; 38 struct v4l2_ctrl_handler; 39 struct v4l2_subdev; 40 struct tuner_setup; 41 42 /* decode_vbi_line */ 43 struct v4l2_decode_vbi_line { 44 u32 is_second_field; /* Set to 0 for the first (odd) field, 45 set to 1 for the second (even) field. */ 46 u8 *p; /* Pointer to the sliced VBI data from the decoder. 47 On exit points to the start of the payload. */ 48 u32 line; /* Line number of the sliced VBI data (1-23) */ 49 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */ 50 }; 51 52 /* Sub-devices are devices that are connected somehow to the main bridge 53 device. These devices are usually audio/video muxers/encoders/decoders or 54 sensors and webcam controllers. 55 56 Usually these devices are controlled through an i2c bus, but other busses 57 may also be used. 58 59 The v4l2_subdev struct provides a way of accessing these devices in a 60 generic manner. Most operations that these sub-devices support fall in 61 a few categories: core ops, audio ops, video ops and tuner ops. 62 63 More categories can be added if needed, although this should remain a 64 limited set (no more than approx. 8 categories). 65 66 Each category has its own set of ops that subdev drivers can implement. 67 68 A subdev driver can leave the pointer to the category ops NULL if 69 it does not implement them (e.g. an audio subdev will generally not 70 implement the video category ops). The exception is the core category: 71 this must always be present. 72 73 These ops are all used internally so it is no problem to change, remove 74 or add ops or move ops from one to another category. Currently these 75 ops are based on the original ioctls, but since ops are not limited to 76 one argument there is room for improvement here once all i2c subdev 77 drivers are converted to use these ops. 78 */ 79 80 /* Core ops: it is highly recommended to implement at least these ops: 81 82 g_chip_ident 83 log_status 84 g_register 85 s_register 86 87 This provides basic debugging support. 88 89 The ioctl ops is meant for generic ioctl-like commands. Depending on 90 the use-case it might be better to use subdev-specific ops (currently 91 not yet implemented) since ops provide proper type-checking. 92 */ 93 94 /* Subdevice external IO pin configuration */ 95 #define V4L2_SUBDEV_IO_PIN_DISABLE (1 << 0) /* ENABLE assumed */ 96 #define V4L2_SUBDEV_IO_PIN_OUTPUT (1 << 1) 97 #define V4L2_SUBDEV_IO_PIN_INPUT (1 << 2) 98 #define V4L2_SUBDEV_IO_PIN_SET_VALUE (1 << 3) /* Set output value */ 99 #define V4L2_SUBDEV_IO_PIN_ACTIVE_LOW (1 << 4) /* ACTIVE HIGH assumed */ 100 101 struct v4l2_subdev_io_pin_config { 102 u32 flags; /* V4L2_SUBDEV_IO_PIN_* flags for this pin's config */ 103 u8 pin; /* Chip external IO pin to configure */ 104 u8 function; /* Internal signal pad/function to route to IO pin */ 105 u8 value; /* Initial value for pin - e.g. GPIO output value */ 106 u8 strength; /* Pin drive strength */ 107 }; 108 109 /* s_config: if set, then it is always called by the v4l2_i2c_new_subdev* 110 functions after the v4l2_subdev was registered. It is used to pass 111 platform data to the subdev which can be used during initialization. 112 113 s_io_pin_config: configure one or more chip I/O pins for chips that 114 multiplex different internal signal pads out to IO pins. This function 115 takes a pointer to an array of 'n' pin configuration entries, one for 116 each pin being configured. This function could be called at times 117 other than just subdevice initialization. 118 119 init: initialize the sensor registors to some sort of reasonable default 120 values. Do not use for new drivers and should be removed in existing 121 drivers. 122 123 load_fw: load firmware. 124 125 reset: generic reset command. The argument selects which subsystems to 126 reset. Passing 0 will always reset the whole chip. Do not use for new 127 drivers without discussing this first on the linux-media mailinglist. 128 There should be no reason normally to reset a device. 129 130 s_gpio: set GPIO pins. Very simple right now, might need to be extended with 131 a direction argument if needed. 132 133 s_power: puts subdevice in power saving mode (on == 0) or normal operation 134 mode (on == 1). 135 136 interrupt_service_routine: Called by the bridge chip's interrupt service 137 handler, when an interrupt status has be raised due to this subdev, 138 so that this subdev can handle the details. It may schedule work to be 139 performed later. It must not sleep. *Called from an IRQ context*. 140 */ 141 struct v4l2_subdev_core_ops { 142 int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip); 143 int (*log_status)(struct v4l2_subdev *sd); 144 int (*s_config)(struct v4l2_subdev *sd, int irq, void *platform_data); 145 int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n, 146 struct v4l2_subdev_io_pin_config *pincfg); 147 int (*init)(struct v4l2_subdev *sd, u32 val); 148 int (*load_fw)(struct v4l2_subdev *sd); 149 int (*reset)(struct v4l2_subdev *sd, u32 val); 150 int (*s_gpio)(struct v4l2_subdev *sd, u32 val); 151 int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc); 152 int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl); 153 int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl); 154 int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); 155 int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); 156 int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls); 157 int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm); 158 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm); 159 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); 160 #ifdef CONFIG_VIDEO_ADV_DEBUG 161 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); 162 int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); 163 #endif 164 int (*s_power)(struct v4l2_subdev *sd, int on); 165 int (*interrupt_service_routine)(struct v4l2_subdev *sd, 166 u32 status, bool *handled); 167 }; 168 169 /* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio. 170 171 s_radio: v4l device was opened in Radio mode, to be replaced by s_mode. 172 173 s_type_addr: sets tuner type and its I2C addr. 174 175 s_config: sets tda9887 specific stuff, like port1, port2 and qss 176 */ 177 struct v4l2_subdev_tuner_ops { 178 int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type); 179 int (*s_radio)(struct v4l2_subdev *sd); 180 int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); 181 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); 182 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); 183 int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); 184 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm); 185 int (*s_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm); 186 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type); 187 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config); 188 }; 189 190 /* s_clock_freq: set the frequency (in Hz) of the audio clock output. 191 Used to slave an audio processor to the video decoder, ensuring that 192 audio and video remain synchronized. Usual values for the frequency 193 are 48000, 44100 or 32000 Hz. If the frequency is not supported, then 194 -EINVAL is returned. 195 196 s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard 197 way to select I2S clock used by driving digital audio streams at some 198 board designs. Usual values for the frequency are 1024000 and 2048000. 199 If the frequency is not supported, then -EINVAL is returned. 200 201 s_routing: used to define the input and/or output pins of an audio chip, 202 and any additional configuration data. 203 Never attempt to use user-level input IDs (e.g. Composite, S-Video, 204 Tuner) at this level. An i2c device shouldn't know about whether an 205 input pin is connected to a Composite connector, become on another 206 board or platform it might be connected to something else entirely. 207 The calling driver is responsible for mapping a user-level input to 208 the right pins on the i2c device. 209 */ 210 struct v4l2_subdev_audio_ops { 211 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq); 212 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq); 213 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); 214 int (*s_stream)(struct v4l2_subdev *sd, int enable); 215 }; 216 217 /* 218 s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by 219 video input devices. 220 221 s_crystal_freq: sets the frequency of the crystal used to generate the 222 clocks in Hz. An extra flags field allows device specific configuration 223 regarding clock frequency dividers, etc. If not used, then set flags 224 to 0. If the frequency is not supported, then -EINVAL is returned. 225 226 g_input_status: get input status. Same as the status field in the v4l2_input 227 struct. 228 229 s_routing: see s_routing in audio_ops, except this version is for video 230 devices. 231 232 s_dv_preset: set dv (Digital Video) preset in the sub device. Similar to 233 s_std() 234 235 query_dv_preset: query dv preset in the sub device. This is similar to 236 querystd() 237 238 s_dv_timings(): Set custom dv timings in the sub device. This is used 239 when sub device is capable of setting detailed timing information 240 in the hardware to generate/detect the video signal. 241 242 g_dv_timings(): Get custom dv timings in the sub device. 243 244 enum_mbus_fmt: enumerate pixel formats, provided by a video data source 245 246 g_mbus_fmt: get the current pixel format, provided by a video data source 247 248 try_mbus_fmt: try to set a pixel format on a video data source 249 250 s_mbus_fmt: set a pixel format on a video data source 251 */ 252 struct v4l2_subdev_video_ops { 253 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); 254 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags); 255 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std); 256 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std); 257 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status); 258 int (*s_stream)(struct v4l2_subdev *sd, int enable); 259 int (*enum_fmt)(struct v4l2_subdev *sd, struct v4l2_fmtdesc *fmtdesc); 260 int (*g_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt); 261 int (*try_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt); 262 int (*s_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt); 263 int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc); 264 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop); 265 int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop); 266 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); 267 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); 268 int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize); 269 int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival); 270 int (*enum_dv_presets) (struct v4l2_subdev *sd, 271 struct v4l2_dv_enum_preset *preset); 272 int (*s_dv_preset)(struct v4l2_subdev *sd, 273 struct v4l2_dv_preset *preset); 274 int (*query_dv_preset)(struct v4l2_subdev *sd, 275 struct v4l2_dv_preset *preset); 276 int (*s_dv_timings)(struct v4l2_subdev *sd, 277 struct v4l2_dv_timings *timings); 278 int (*g_dv_timings)(struct v4l2_subdev *sd, 279 struct v4l2_dv_timings *timings); 280 int (*enum_mbus_fmt)(struct v4l2_subdev *sd, unsigned int index, 281 enum v4l2_mbus_pixelcode *code); 282 int (*g_mbus_fmt)(struct v4l2_subdev *sd, 283 struct v4l2_mbus_framefmt *fmt); 284 int (*try_mbus_fmt)(struct v4l2_subdev *sd, 285 struct v4l2_mbus_framefmt *fmt); 286 int (*s_mbus_fmt)(struct v4l2_subdev *sd, 287 struct v4l2_mbus_framefmt *fmt); 288 }; 289 290 /* 291 decode_vbi_line: video decoders that support sliced VBI need to implement 292 this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the 293 start of the VBI data that was generated by the decoder. The driver 294 then parses the sliced VBI data and sets the other fields in the 295 struct accordingly. The pointer p is updated to point to the start of 296 the payload which can be copied verbatim into the data field of the 297 v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the 298 type field is set to 0 on return. 299 300 s_vbi_data: used to generate VBI signals on a video signal. 301 v4l2_sliced_vbi_data is filled with the data packets that should be 302 output. Note that if you set the line field to 0, then that VBI signal 303 is disabled. If no valid VBI data was found, then the type field is 304 set to 0 on return. 305 306 g_vbi_data: used to obtain the sliced VBI packet from a readback register. 307 Not all video decoders support this. If no data is available because 308 the readback register contains invalid or erroneous data -EIO is 309 returned. Note that you must fill in the 'id' member and the 'field' 310 member (to determine whether CC data from the first or second field 311 should be obtained). 312 313 s_raw_fmt: setup the video encoder/decoder for raw VBI. 314 315 g_sliced_fmt: retrieve the current sliced VBI settings. 316 317 s_sliced_fmt: setup the sliced VBI settings. 318 */ 319 struct v4l2_subdev_vbi_ops { 320 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line); 321 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data); 322 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data); 323 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap); 324 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt); 325 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); 326 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); 327 }; 328 329 /** 330 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations 331 * @g_skip_top_lines: number of lines at the top of the image to be skipped. 332 * This is needed for some sensors, which always corrupt 333 * several top lines of the output image, or which send their 334 * metadata in them. 335 */ 336 struct v4l2_subdev_sensor_ops { 337 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines); 338 }; 339 340 /* 341 [rt]x_g_parameters: Get the current operating parameters and state of the 342 the IR receiver or transmitter. 343 344 [rt]x_s_parameters: Set the current operating parameters and state of the 345 the IR receiver or transmitter. It is recommended to call 346 [rt]x_g_parameters first to fill out the current state, and only change 347 the fields that need to be changed. Upon return, the actual device 348 operating parameters and state will be returned. Note that hardware 349 limitations may prevent the actual settings from matching the requested 350 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz 351 was requested. An exception is when the shutdown parameter is true. 352 The last used operational parameters will be returned, but the actual 353 state of the hardware be different to minimize power consumption and 354 processing when shutdown is true. 355 356 rx_read: Reads received codes or pulse width data. 357 The semantics are similar to a non-blocking read() call. 358 359 tx_write: Writes codes or pulse width data for transmission. 360 The semantics are similar to a non-blocking write() call. 361 */ 362 363 enum v4l2_subdev_ir_mode { 364 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */ 365 }; 366 367 struct v4l2_subdev_ir_parameters { 368 /* Either Rx or Tx */ 369 unsigned int bytes_per_data_element; /* of data in read or write call */ 370 enum v4l2_subdev_ir_mode mode; 371 372 bool enable; 373 bool interrupt_enable; 374 bool shutdown; /* true: set hardware to low/no power, false: normal */ 375 376 bool modulation; /* true: uses carrier, false: baseband */ 377 u32 max_pulse_width; /* ns, valid only for baseband signal */ 378 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/ 379 unsigned int duty_cycle; /* percent, valid only for modulated signal*/ 380 bool invert_level; /* invert signal level */ 381 382 /* Tx only */ 383 bool invert_carrier_sense; /* Send 0/space as a carrier burst */ 384 385 /* Rx only */ 386 u32 noise_filter_min_width; /* ns, min time of a valid pulse */ 387 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */ 388 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */ 389 u32 resolution; /* ns */ 390 }; 391 392 struct v4l2_subdev_ir_ops { 393 /* Receiver */ 394 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count, 395 ssize_t *num); 396 397 int (*rx_g_parameters)(struct v4l2_subdev *sd, 398 struct v4l2_subdev_ir_parameters *params); 399 int (*rx_s_parameters)(struct v4l2_subdev *sd, 400 struct v4l2_subdev_ir_parameters *params); 401 402 /* Transmitter */ 403 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count, 404 ssize_t *num); 405 406 int (*tx_g_parameters)(struct v4l2_subdev *sd, 407 struct v4l2_subdev_ir_parameters *params); 408 int (*tx_s_parameters)(struct v4l2_subdev *sd, 409 struct v4l2_subdev_ir_parameters *params); 410 }; 411 412 struct v4l2_subdev_ops { 413 const struct v4l2_subdev_core_ops *core; 414 const struct v4l2_subdev_tuner_ops *tuner; 415 const struct v4l2_subdev_audio_ops *audio; 416 const struct v4l2_subdev_video_ops *video; 417 const struct v4l2_subdev_vbi_ops *vbi; 418 const struct v4l2_subdev_ir_ops *ir; 419 const struct v4l2_subdev_sensor_ops *sensor; 420 }; 421 422 #define V4L2_SUBDEV_NAME_SIZE 32 423 424 /* Set this flag if this subdev is a i2c device. */ 425 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0) 426 /* Set this flag if this subdev is a spi device. */ 427 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1) 428 429 /* Each instance of a subdev driver should create this struct, either 430 stand-alone or embedded in a larger struct. 431 */ 432 struct v4l2_subdev { 433 struct list_head list; 434 struct module *owner; 435 u32 flags; 436 struct v4l2_device *v4l2_dev; 437 const struct v4l2_subdev_ops *ops; 438 /* The control handler of this subdev. May be NULL. */ 439 struct v4l2_ctrl_handler *ctrl_handler; 440 /* name must be unique */ 441 char name[V4L2_SUBDEV_NAME_SIZE]; 442 /* can be used to group similar subdevs, value is driver-specific */ 443 u32 grp_id; 444 /* pointer to private data */ 445 void *priv; 446 }; 447 448 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p) 449 { 450 sd->priv = p; 451 } 452 453 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd) 454 { 455 return sd->priv; 456 } 457 458 static inline void v4l2_subdev_init(struct v4l2_subdev *sd, 459 const struct v4l2_subdev_ops *ops) 460 { 461 INIT_LIST_HEAD(&sd->list); 462 /* ops->core MUST be set */ 463 BUG_ON(!ops || !ops->core); 464 sd->ops = ops; 465 sd->v4l2_dev = NULL; 466 sd->flags = 0; 467 sd->name[0] = '\0'; 468 sd->grp_id = 0; 469 sd->priv = NULL; 470 } 471 472 /* Call an ops of a v4l2_subdev, doing the right checks against 473 NULL pointers. 474 475 Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip); 476 */ 477 #define v4l2_subdev_call(sd, o, f, args...) \ 478 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \ 479 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD)) 480 481 /* Send a notification to v4l2_device. */ 482 #define v4l2_subdev_notify(sd, notification, arg) \ 483 ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \ 484 (sd)->v4l2_dev->notify((sd), (notification), (arg))) 485 486 #endif 487