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 /* s_config: if set, then it is always called by the v4l2_i2c_new_subdev*
94 functions after the v4l2_subdev was registered. It is used to pass
95 platform data to the subdev which can be used during initialization.
97 init: initialize the sensor registors to some sort of reasonable default
98 values. Do not use for new drivers and should be removed in existing
101 load_fw: load firmware.
103 reset: generic reset command. The argument selects which subsystems to
104 reset. Passing 0 will always reset the whole chip. Do not use for new
105 drivers without discussing this first on the linux-media mailinglist.
106 There should be no reason normally to reset a device.
108 s_gpio: set GPIO pins. Very simple right now, might need to be extended with
109 a direction argument if needed.
111 s_power: puts subdevice in power saving mode (on == 0) or normal operation
114 struct v4l2_subdev_core_ops {
115 int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
116 int (*log_status)(struct v4l2_subdev *sd);
117 int (*s_config)(struct v4l2_subdev *sd, int irq, void *platform_data);
118 int (*init)(struct v4l2_subdev *sd, u32 val);
119 int (*load_fw)(struct v4l2_subdev *sd);
120 int (*reset)(struct v4l2_subdev *sd, u32 val);
121 int (*s_gpio)(struct v4l2_subdev *sd, u32 val);
122 int (*queryctrl)(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
123 int (*g_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
124 int (*s_ctrl)(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
125 int (*g_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
126 int (*s_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
127 int (*try_ext_ctrls)(struct v4l2_subdev *sd, struct v4l2_ext_controls *ctrls);
128 int (*querymenu)(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
129 int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm);
130 long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg);
131 #ifdef CONFIG_VIDEO_ADV_DEBUG
132 int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
133 int (*s_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg);
135 int (*s_power)(struct v4l2_subdev *sd, int on);
138 /* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
140 s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
142 s_type_addr: sets tuner type and its I2C addr.
144 s_config: sets tda9887 specific stuff, like port1, port2 and qss
146 struct v4l2_subdev_tuner_ops {
147 int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type);
148 int (*s_radio)(struct v4l2_subdev *sd);
149 int (*s_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
150 int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq);
151 int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
152 int (*s_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt);
153 int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
154 int (*s_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm);
155 int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type);
156 int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
159 /* s_clock_freq: set the frequency (in Hz) of the audio clock output.
160 Used to slave an audio processor to the video decoder, ensuring that
161 audio and video remain synchronized. Usual values for the frequency
162 are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
165 s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
166 way to select I2S clock used by driving digital audio streams at some
167 board designs. Usual values for the frequency are 1024000 and 2048000.
168 If the frequency is not supported, then -EINVAL is returned.
170 s_routing: used to define the input and/or output pins of an audio chip,
171 and any additional configuration data.
172 Never attempt to use user-level input IDs (e.g. Composite, S-Video,
173 Tuner) at this level. An i2c device shouldn't know about whether an
174 input pin is connected to a Composite connector, become on another
175 board or platform it might be connected to something else entirely.
176 The calling driver is responsible for mapping a user-level input to
177 the right pins on the i2c device.
179 struct v4l2_subdev_audio_ops {
180 int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
181 int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
182 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
183 int (*s_stream)(struct v4l2_subdev *sd, int enable);
187 s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
190 s_crystal_freq: sets the frequency of the crystal used to generate the
191 clocks in Hz. An extra flags field allows device specific configuration
192 regarding clock frequency dividers, etc. If not used, then set flags
193 to 0. If the frequency is not supported, then -EINVAL is returned.
195 g_input_status: get input status. Same as the status field in the v4l2_input
198 s_routing: see s_routing in audio_ops, except this version is for video
201 s_dv_preset: set dv (Digital Video) preset in the sub device. Similar to
204 query_dv_preset: query dv preset in the sub device. This is similar to
207 s_dv_timings(): Set custom dv timings in the sub device. This is used
208 when sub device is capable of setting detailed timing information
209 in the hardware to generate/detect the video signal.
211 g_dv_timings(): Get custom dv timings in the sub device.
213 enum_mbus_fmt: enumerate pixel formats, provided by a video data source
215 g_mbus_fmt: get the current pixel format, provided by a video data source
217 try_mbus_fmt: try to set a pixel format on a video data source
219 s_mbus_fmt: set a pixel format on a video data source
221 struct v4l2_subdev_video_ops {
222 int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config);
223 int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags);
224 int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std);
225 int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std);
226 int (*g_input_status)(struct v4l2_subdev *sd, u32 *status);
227 int (*s_stream)(struct v4l2_subdev *sd, int enable);
228 int (*enum_fmt)(struct v4l2_subdev *sd, struct v4l2_fmtdesc *fmtdesc);
229 int (*g_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
230 int (*try_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
231 int (*s_fmt)(struct v4l2_subdev *sd, struct v4l2_format *fmt);
232 int (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
233 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
234 int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
235 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
236 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
237 int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
238 int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
239 int (*s_dv_preset)(struct v4l2_subdev *sd,
240 struct v4l2_dv_preset *preset);
241 int (*query_dv_preset)(struct v4l2_subdev *sd,
242 struct v4l2_dv_preset *preset);
243 int (*s_dv_timings)(struct v4l2_subdev *sd,
244 struct v4l2_dv_timings *timings);
245 int (*g_dv_timings)(struct v4l2_subdev *sd,
246 struct v4l2_dv_timings *timings);
247 int (*enum_mbus_fmt)(struct v4l2_subdev *sd, int index,
248 enum v4l2_mbus_pixelcode *code);
249 int (*g_mbus_fmt)(struct v4l2_subdev *sd,
250 struct v4l2_mbus_framefmt *fmt);
251 int (*try_mbus_fmt)(struct v4l2_subdev *sd,
252 struct v4l2_mbus_framefmt *fmt);
253 int (*s_mbus_fmt)(struct v4l2_subdev *sd,
254 struct v4l2_mbus_framefmt *fmt);
258 decode_vbi_line: video decoders that support sliced VBI need to implement
259 this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
260 start of the VBI data that was generated by the decoder. The driver
261 then parses the sliced VBI data and sets the other fields in the
262 struct accordingly. The pointer p is updated to point to the start of
263 the payload which can be copied verbatim into the data field of the
264 v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
265 type field is set to 0 on return.
267 s_vbi_data: used to generate VBI signals on a video signal.
268 v4l2_sliced_vbi_data is filled with the data packets that should be
269 output. Note that if you set the line field to 0, then that VBI signal
270 is disabled. If no valid VBI data was found, then the type field is
273 g_vbi_data: used to obtain the sliced VBI packet from a readback register.
274 Not all video decoders support this. If no data is available because
275 the readback register contains invalid or erroneous data -EIO is
276 returned. Note that you must fill in the 'id' member and the 'field'
277 member (to determine whether CC data from the first or second field
280 s_raw_fmt: setup the video encoder/decoder for raw VBI.
282 g_sliced_fmt: retrieve the current sliced VBI settings.
284 s_sliced_fmt: setup the sliced VBI settings.
286 struct v4l2_subdev_vbi_ops {
287 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
288 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
289 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
290 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
291 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
292 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
293 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
297 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
298 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
299 * This is needed for some sensors, which always corrupt
300 * several top lines of the output image, or which send their
303 struct v4l2_subdev_sensor_ops {
304 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
308 interrupt_service_routine: Called by the bridge chip's interrupt service
309 handler, when an IR interrupt status has be raised due to this subdev,
310 so that this subdev can handle the details. It may schedule work to be
311 performed later. It must not sleep. *Called from an IRQ context*.
313 [rt]x_g_parameters: Get the current operating parameters and state of the
314 the IR receiver or transmitter.
316 [rt]x_s_parameters: Set the current operating parameters and state of the
317 the IR receiver or transmitter. It is recommended to call
318 [rt]x_g_parameters first to fill out the current state, and only change
319 the fields that need to be changed. Upon return, the actual device
320 operating parameters and state will be returned. Note that hardware
321 limitations may prevent the actual settings from matching the requested
322 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
323 was requested. An exception is when the shutdown parameter is true.
324 The last used operational parameters will be returned, but the actual
325 state of the hardware be different to minimize power consumption and
326 processing when shutdown is true.
328 rx_read: Reads received codes or pulse width data.
329 The semantics are similar to a non-blocking read() call.
331 tx_write: Writes codes or pulse width data for transmission.
332 The semantics are similar to a non-blocking write() call.
335 enum v4l2_subdev_ir_mode {
336 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* space & mark widths in nanosecs */
339 /* Data format of data read or written for V4L2_SUBDEV_IR_MODE_PULSE_WIDTH */
340 #define V4L2_SUBDEV_IR_PULSE_MAX_WIDTH_NS 0x7fffffff
341 #define V4L2_SUBDEV_IR_PULSE_LEVEL_MASK 0x80000000
342 #define V4L2_SUBDEV_IR_PULSE_RX_SEQ_END 0xffffffff
344 struct v4l2_subdev_ir_parameters {
345 /* Either Rx or Tx */
346 unsigned int bytes_per_data_element; /* of data in read or write call */
347 enum v4l2_subdev_ir_mode mode;
350 bool interrupt_enable;
351 bool shutdown; /* true: set hardware to low/no power, false: normal */
353 bool modulation; /* true: uses carrier, false: baseband */
354 u32 max_pulse_width; /* ns, valid only for baseband signal */
355 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/
356 unsigned int duty_cycle; /* percent, valid only for modulated signal*/
357 bool invert; /* logically invert sense of mark/space */
360 u32 noise_filter_min_width; /* ns, min time of a valid pulse */
361 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
362 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
363 u32 resolution; /* ns */
366 struct v4l2_subdev_ir_ops {
367 /* Common to receiver and transmitter */
368 int (*interrupt_service_routine)(struct v4l2_subdev *sd,
369 u32 status, bool *handled);
372 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
375 int (*rx_g_parameters)(struct v4l2_subdev *sd,
376 struct v4l2_subdev_ir_parameters *params);
377 int (*rx_s_parameters)(struct v4l2_subdev *sd,
378 struct v4l2_subdev_ir_parameters *params);
381 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
384 int (*tx_g_parameters)(struct v4l2_subdev *sd,
385 struct v4l2_subdev_ir_parameters *params);
386 int (*tx_s_parameters)(struct v4l2_subdev *sd,
387 struct v4l2_subdev_ir_parameters *params);
390 struct v4l2_subdev_ops {
391 const struct v4l2_subdev_core_ops *core;
392 const struct v4l2_subdev_tuner_ops *tuner;
393 const struct v4l2_subdev_audio_ops *audio;
394 const struct v4l2_subdev_video_ops *video;
395 const struct v4l2_subdev_vbi_ops *vbi;
396 const struct v4l2_subdev_ir_ops *ir;
397 const struct v4l2_subdev_sensor_ops *sensor;
400 #define V4L2_SUBDEV_NAME_SIZE 32
402 /* Set this flag if this subdev is a i2c device. */
403 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
404 /* Set this flag if this subdev is a spi device. */
405 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
407 /* Each instance of a subdev driver should create this struct, either
408 stand-alone or embedded in a larger struct.
411 struct list_head list;
412 struct module *owner;
414 struct v4l2_device *v4l2_dev;
415 const struct v4l2_subdev_ops *ops;
416 /* name must be unique */
417 char name[V4L2_SUBDEV_NAME_SIZE];
418 /* can be used to group similar subdevs, value is driver-specific */
420 /* pointer to private data */
424 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
429 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
434 static inline void v4l2_subdev_init(struct v4l2_subdev *sd,
435 const struct v4l2_subdev_ops *ops)
437 INIT_LIST_HEAD(&sd->list);
438 /* ops->core MUST be set */
439 BUG_ON(!ops || !ops->core);
448 /* Call an ops of a v4l2_subdev, doing the right checks against
451 Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
453 #define v4l2_subdev_call(sd, o, f, args...) \
454 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
455 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
457 /* Send a notification to v4l2_device. */
458 #define v4l2_subdev_notify(sd, notification, arg) \
459 ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
460 (sd)->v4l2_dev->notify((sd), (notification), (arg)))