Merge branch 'master' of /pub/scm/linux/kernel/git/torvalds/linux-2.6
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / include / media / v4l2-subdev.h
blobb0316a7cf08d21f2ac68f1dc452894441948c155
1 /*
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
37 struct v4l2_device;
38 struct v4l2_ctrl_handler;
39 struct v4l2_subdev;
40 struct tuner_setup;
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 */
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.
56 Usually these devices are controlled through an i2c bus, but other busses
57 may also be used.
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.
63 More categories can be added if needed, although this should remain a
64 limited set (no more than approx. 8 categories).
66 Each category has its own set of ops that subdev drivers can implement.
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.
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.
80 /* Core ops: it is highly recommended to implement at least these ops:
82 g_chip_ident
83 log_status
84 g_register
85 s_register
87 This provides basic debugging support.
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.
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 */
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 */
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.
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.
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.
123 load_fw: load firmware.
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.
130 s_gpio: set GPIO pins. Very simple right now, might need to be extended with
131 a direction argument if needed.
133 s_power: puts subdevice in power saving mode (on == 0) or normal operation
134 mode (on == 1).
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*.
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);
169 /* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
171 s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
173 s_type_addr: sets tuner type and its I2C addr.
175 s_config: sets tda9887 specific stuff, like port1, port2 and qss
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);
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.
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.
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.
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);
218 s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
219 video input devices.
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.
226 g_input_status: get input status. Same as the status field in the v4l2_input
227 struct.
229 s_routing: see s_routing in audio_ops, except this version is for video
230 devices.
232 s_dv_preset: set dv (Digital Video) preset in the sub device. Similar to
233 s_std()
235 query_dv_preset: query dv preset in the sub device. This is similar to
236 querystd()
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.
242 g_dv_timings(): Get custom dv timings in the sub device.
244 enum_mbus_fmt: enumerate pixel formats, provided by a video data source
246 g_mbus_fmt: get the current pixel format, provided by a video data source
248 try_mbus_fmt: try to set a pixel format on a video data source
250 s_mbus_fmt: set a pixel format on a video data source
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 (*cropcap)(struct v4l2_subdev *sd, struct v4l2_cropcap *cc);
260 int (*g_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
261 int (*s_crop)(struct v4l2_subdev *sd, struct v4l2_crop *crop);
262 int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
263 int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param);
264 int (*enum_framesizes)(struct v4l2_subdev *sd, struct v4l2_frmsizeenum *fsize);
265 int (*enum_frameintervals)(struct v4l2_subdev *sd, struct v4l2_frmivalenum *fival);
266 int (*enum_dv_presets) (struct v4l2_subdev *sd,
267 struct v4l2_dv_enum_preset *preset);
268 int (*s_dv_preset)(struct v4l2_subdev *sd,
269 struct v4l2_dv_preset *preset);
270 int (*query_dv_preset)(struct v4l2_subdev *sd,
271 struct v4l2_dv_preset *preset);
272 int (*s_dv_timings)(struct v4l2_subdev *sd,
273 struct v4l2_dv_timings *timings);
274 int (*g_dv_timings)(struct v4l2_subdev *sd,
275 struct v4l2_dv_timings *timings);
276 int (*enum_mbus_fmt)(struct v4l2_subdev *sd, unsigned int index,
277 enum v4l2_mbus_pixelcode *code);
278 int (*g_mbus_fmt)(struct v4l2_subdev *sd,
279 struct v4l2_mbus_framefmt *fmt);
280 int (*try_mbus_fmt)(struct v4l2_subdev *sd,
281 struct v4l2_mbus_framefmt *fmt);
282 int (*s_mbus_fmt)(struct v4l2_subdev *sd,
283 struct v4l2_mbus_framefmt *fmt);
287 decode_vbi_line: video decoders that support sliced VBI need to implement
288 this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
289 start of the VBI data that was generated by the decoder. The driver
290 then parses the sliced VBI data and sets the other fields in the
291 struct accordingly. The pointer p is updated to point to the start of
292 the payload which can be copied verbatim into the data field of the
293 v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
294 type field is set to 0 on return.
296 s_vbi_data: used to generate VBI signals on a video signal.
297 v4l2_sliced_vbi_data is filled with the data packets that should be
298 output. Note that if you set the line field to 0, then that VBI signal
299 is disabled. If no valid VBI data was found, then the type field is
300 set to 0 on return.
302 g_vbi_data: used to obtain the sliced VBI packet from a readback register.
303 Not all video decoders support this. If no data is available because
304 the readback register contains invalid or erroneous data -EIO is
305 returned. Note that you must fill in the 'id' member and the 'field'
306 member (to determine whether CC data from the first or second field
307 should be obtained).
309 s_raw_fmt: setup the video encoder/decoder for raw VBI.
311 g_sliced_fmt: retrieve the current sliced VBI settings.
313 s_sliced_fmt: setup the sliced VBI settings.
315 struct v4l2_subdev_vbi_ops {
316 int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line);
317 int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data);
318 int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data);
319 int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap);
320 int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
321 int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
322 int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
326 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
327 * @g_skip_top_lines: number of lines at the top of the image to be skipped.
328 * This is needed for some sensors, which always corrupt
329 * several top lines of the output image, or which send their
330 * metadata in them.
332 struct v4l2_subdev_sensor_ops {
333 int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines);
337 [rt]x_g_parameters: Get the current operating parameters and state of the
338 the IR receiver or transmitter.
340 [rt]x_s_parameters: Set the current operating parameters and state of the
341 the IR receiver or transmitter. It is recommended to call
342 [rt]x_g_parameters first to fill out the current state, and only change
343 the fields that need to be changed. Upon return, the actual device
344 operating parameters and state will be returned. Note that hardware
345 limitations may prevent the actual settings from matching the requested
346 settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
347 was requested. An exception is when the shutdown parameter is true.
348 The last used operational parameters will be returned, but the actual
349 state of the hardware be different to minimize power consumption and
350 processing when shutdown is true.
352 rx_read: Reads received codes or pulse width data.
353 The semantics are similar to a non-blocking read() call.
355 tx_write: Writes codes or pulse width data for transmission.
356 The semantics are similar to a non-blocking write() call.
359 enum v4l2_subdev_ir_mode {
360 V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, /* uses struct ir_raw_event records */
363 struct v4l2_subdev_ir_parameters {
364 /* Either Rx or Tx */
365 unsigned int bytes_per_data_element; /* of data in read or write call */
366 enum v4l2_subdev_ir_mode mode;
368 bool enable;
369 bool interrupt_enable;
370 bool shutdown; /* true: set hardware to low/no power, false: normal */
372 bool modulation; /* true: uses carrier, false: baseband */
373 u32 max_pulse_width; /* ns, valid only for baseband signal */
374 unsigned int carrier_freq; /* Hz, valid only for modulated signal*/
375 unsigned int duty_cycle; /* percent, valid only for modulated signal*/
376 bool invert_level; /* invert signal level */
378 /* Tx only */
379 bool invert_carrier_sense; /* Send 0/space as a carrier burst */
381 /* Rx only */
382 u32 noise_filter_min_width; /* ns, min time of a valid pulse */
383 unsigned int carrier_range_lower; /* Hz, valid only for modulated sig */
384 unsigned int carrier_range_upper; /* Hz, valid only for modulated sig */
385 u32 resolution; /* ns */
388 struct v4l2_subdev_ir_ops {
389 /* Receiver */
390 int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count,
391 ssize_t *num);
393 int (*rx_g_parameters)(struct v4l2_subdev *sd,
394 struct v4l2_subdev_ir_parameters *params);
395 int (*rx_s_parameters)(struct v4l2_subdev *sd,
396 struct v4l2_subdev_ir_parameters *params);
398 /* Transmitter */
399 int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count,
400 ssize_t *num);
402 int (*tx_g_parameters)(struct v4l2_subdev *sd,
403 struct v4l2_subdev_ir_parameters *params);
404 int (*tx_s_parameters)(struct v4l2_subdev *sd,
405 struct v4l2_subdev_ir_parameters *params);
408 struct v4l2_subdev_ops {
409 const struct v4l2_subdev_core_ops *core;
410 const struct v4l2_subdev_tuner_ops *tuner;
411 const struct v4l2_subdev_audio_ops *audio;
412 const struct v4l2_subdev_video_ops *video;
413 const struct v4l2_subdev_vbi_ops *vbi;
414 const struct v4l2_subdev_ir_ops *ir;
415 const struct v4l2_subdev_sensor_ops *sensor;
418 #define V4L2_SUBDEV_NAME_SIZE 32
420 /* Set this flag if this subdev is a i2c device. */
421 #define V4L2_SUBDEV_FL_IS_I2C (1U << 0)
422 /* Set this flag if this subdev is a spi device. */
423 #define V4L2_SUBDEV_FL_IS_SPI (1U << 1)
425 /* Each instance of a subdev driver should create this struct, either
426 stand-alone or embedded in a larger struct.
428 struct v4l2_subdev {
429 struct list_head list;
430 struct module *owner;
431 u32 flags;
432 struct v4l2_device *v4l2_dev;
433 const struct v4l2_subdev_ops *ops;
434 /* The control handler of this subdev. May be NULL. */
435 struct v4l2_ctrl_handler *ctrl_handler;
436 /* name must be unique */
437 char name[V4L2_SUBDEV_NAME_SIZE];
438 /* can be used to group similar subdevs, value is driver-specific */
439 u32 grp_id;
440 /* pointer to private data */
441 void *dev_priv;
442 void *host_priv;
445 static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p)
447 sd->dev_priv = p;
450 static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
452 return sd->dev_priv;
455 static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p)
457 sd->host_priv = p;
460 static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd)
462 return sd->host_priv;
465 static inline void v4l2_subdev_init(struct v4l2_subdev *sd,
466 const struct v4l2_subdev_ops *ops)
468 INIT_LIST_HEAD(&sd->list);
469 /* ops->core MUST be set */
470 BUG_ON(!ops || !ops->core);
471 sd->ops = ops;
472 sd->v4l2_dev = NULL;
473 sd->flags = 0;
474 sd->name[0] = '\0';
475 sd->grp_id = 0;
476 sd->dev_priv = NULL;
477 sd->host_priv = NULL;
480 /* Call an ops of a v4l2_subdev, doing the right checks against
481 NULL pointers.
483 Example: err = v4l2_subdev_call(sd, core, g_chip_ident, &chip);
485 #define v4l2_subdev_call(sd, o, f, args...) \
486 (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \
487 (sd)->ops->o->f((sd) , ##args) : -ENOIOCTLCMD))
489 /* Send a notification to v4l2_device. */
490 #define v4l2_subdev_notify(sd, notification, arg) \
491 ((!(sd) || !(sd)->v4l2_dev || !(sd)->v4l2_dev->notify) ? -ENODEV : \
492 (sd)->v4l2_dev->notify((sd), (notification), (arg)))
494 #endif