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