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