Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 1 | /* |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 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. |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 15 | */ |
| 16 | |
| 17 | #ifndef _V4L2_SUBDEV_H |
| 18 | #define _V4L2_SUBDEV_H |
| 19 | |
Sylwester Nawrocki | 2910311 | 2012-05-17 14:33:30 -0300 | [diff] [blame] | 20 | #include <linux/types.h> |
Laurent Pinchart | 333c8b9 | 2010-03-15 20:26:04 -0300 | [diff] [blame] | 21 | #include <linux/v4l2-subdev.h> |
Laurent Pinchart | 61f5db5 | 2009-12-09 08:40:08 -0300 | [diff] [blame] | 22 | #include <media/media-entity.h> |
Guennadi Liakhovetski | e9e3104 | 2013-01-08 07:06:31 -0300 | [diff] [blame] | 23 | #include <media/v4l2-async.h> |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 24 | #include <media/v4l2-common.h> |
Laurent Pinchart | 2096a5d | 2009-12-09 08:38:49 -0300 | [diff] [blame] | 25 | #include <media/v4l2-dev.h> |
Stanimir Varbanov | 7cd5a16 | 2010-05-21 06:04:24 -0300 | [diff] [blame] | 26 | #include <media/v4l2-fh.h> |
Guennadi Liakhovetski | 9a74251 | 2009-12-11 11:41:28 -0300 | [diff] [blame] | 27 | #include <media/v4l2-mediabus.h> |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 28 | |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 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 | |
jean-michel.hautbois@vodalys.com | 17e4846 | 2015-03-18 07:21:47 -0300 | [diff] [blame] | 39 | #define V4L2_DEVICE_NOTIFY_EVENT _IOW('v', 2, struct v4l2_event) |
| 40 | |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 41 | struct v4l2_device; |
Hans Verkuil | 0996517 | 2010-08-01 14:32:42 -0300 | [diff] [blame] | 42 | struct v4l2_ctrl_handler; |
Lars-Peter Clausen | 8ae5640 | 2015-06-24 13:50:29 -0300 | [diff] [blame] | 43 | struct v4l2_event; |
Sakari Ailus | 02adb1c | 2010-03-03 12:49:38 -0300 | [diff] [blame] | 44 | struct v4l2_event_subscription; |
| 45 | struct v4l2_fh; |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 46 | struct v4l2_subdev; |
Laurent Pinchart | f0beea8 | 2010-08-01 19:05:09 -0300 | [diff] [blame] | 47 | struct v4l2_subdev_fh; |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 48 | struct tuner_setup; |
Sylwester Nawrocki | 2910311 | 2012-05-17 14:33:30 -0300 | [diff] [blame] | 49 | struct v4l2_mbus_frame_desc; |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 50 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 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 | */ |
Hans Verkuil | 78a3b4d | 2009-04-01 03:41:09 -0300 | [diff] [blame] | 61 | struct v4l2_decode_vbi_line { |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 62 | u32 is_second_field; |
| 63 | u8 *p; |
| 64 | u32 line; |
| 65 | u32 type; |
Hans Verkuil | 78a3b4d | 2009-04-01 03:41:09 -0300 | [diff] [blame] | 66 | }; |
| 67 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 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. |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 95 | */ |
| 96 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 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. |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 109 | */ |
Hans Verkuil | 78a3b4d | 2009-04-01 03:41:09 -0300 | [diff] [blame] | 110 | |
Andy Walls | 66752f8 | 2010-07-18 18:51:10 -0300 | [diff] [blame] | 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 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 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 | */ |
Andy Walls | 66752f8 | 2010-07-18 18:51:10 -0300 | [diff] [blame] | 132 | struct v4l2_subdev_io_pin_config { |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 133 | u32 flags; |
| 134 | u8 pin; |
| 135 | u8 function; |
| 136 | u8 value; |
| 137 | u8 strength; |
Andy Walls | 66752f8 | 2010-07-18 18:51:10 -0300 | [diff] [blame] | 138 | }; |
| 139 | |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 140 | /** |
Mauro Carvalho Chehab | 783001a | 2015-08-22 06:00:22 -0300 | [diff] [blame] | 141 | * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs |
| 142 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 143 | * @log_status: callback for %VIDIOC_LOG_STATUS ioctl handler code. |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 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 | * |
Mauro Carvalho Chehab | 1d8955b | 2015-08-22 06:59:26 -0300 | [diff] [blame] | 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 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 171 | * @g_register: callback for %VIDIOC_G_REGISTER ioctl handler code. |
Mauro Carvalho Chehab | 783001a | 2015-08-22 06:00:22 -0300 | [diff] [blame] | 172 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 173 | * @s_register: callback for %VIDIOC_G_REGISTER ioctl handler code. |
Mauro Carvalho Chehab | 783001a | 2015-08-22 06:00:22 -0300 | [diff] [blame] | 174 | * |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 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 |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 181 | * performed later. It must not sleep. **Called from an IRQ context**. |
Mauro Carvalho Chehab | 1d8955b | 2015-08-22 06:59:26 -0300 | [diff] [blame] | 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. |
Hans Verkuil | 78a3b4d | 2009-04-01 03:41:09 -0300 | [diff] [blame] | 187 | */ |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 188 | struct v4l2_subdev_core_ops { |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 189 | int (*log_status)(struct v4l2_subdev *sd); |
Andy Walls | 66752f8 | 2010-07-18 18:51:10 -0300 | [diff] [blame] | 190 | int (*s_io_pin_config)(struct v4l2_subdev *sd, size_t n, |
| 191 | struct v4l2_subdev_io_pin_config *pincfg); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 192 | int (*init)(struct v4l2_subdev *sd, u32 val); |
Hans Verkuil | cc26b07 | 2009-03-29 19:20:26 -0300 | [diff] [blame] | 193 | int (*load_fw)(struct v4l2_subdev *sd); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 194 | int (*reset)(struct v4l2_subdev *sd, u32 val); |
| 195 | int (*s_gpio)(struct v4l2_subdev *sd, u32 val); |
Hans Verkuil | 069b747 | 2008-12-30 07:04:34 -0300 | [diff] [blame] | 196 | long (*ioctl)(struct v4l2_subdev *sd, unsigned int cmd, void *arg); |
Hans Verkuil | ab58a30 | 2014-02-10 08:08:44 -0300 | [diff] [blame] | 197 | #ifdef CONFIG_COMPAT |
| 198 | long (*compat_ioctl32)(struct v4l2_subdev *sd, unsigned int cmd, |
| 199 | unsigned long arg); |
| 200 | #endif |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 201 | #ifdef CONFIG_VIDEO_ADV_DEBUG |
Hans Verkuil | aecde8b5 | 2008-12-30 07:14:19 -0300 | [diff] [blame] | 202 | int (*g_register)(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg); |
Hans Verkuil | 977ba3b | 2013-03-24 08:28:46 -0300 | [diff] [blame] | 203 | int (*s_register)(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 204 | #endif |
Laurent Pinchart | 622b828 | 2009-10-05 10:48:17 -0300 | [diff] [blame] | 205 | int (*s_power)(struct v4l2_subdev *sd, int on); |
Andy Walls | 260e689b | 2010-07-18 20:54:52 -0300 | [diff] [blame] | 206 | int (*interrupt_service_routine)(struct v4l2_subdev *sd, |
| 207 | u32 status, bool *handled); |
Sakari Ailus | 02adb1c | 2010-03-03 12:49:38 -0300 | [diff] [blame] | 208 | int (*subscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, |
| 209 | struct v4l2_event_subscription *sub); |
| 210 | int (*unsubscribe_event)(struct v4l2_subdev *sd, struct v4l2_fh *fh, |
| 211 | struct v4l2_event_subscription *sub); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 212 | }; |
| 213 | |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 214 | /** |
| 215 | * struct s_radio - Callbacks used when v4l device was opened in radio mode. |
| 216 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 217 | * @s_radio: callback for %VIDIOC_S_RADIO ioctl handler code. |
Mauro Carvalho Chehab | 91963aa | 2015-08-22 06:07:29 -0300 | [diff] [blame] | 218 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 219 | * @s_frequency: callback for %VIDIOC_S_FREQUENCY ioctl handler code. |
Mauro Carvalho Chehab | 91963aa | 2015-08-22 06:07:29 -0300 | [diff] [blame] | 220 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 221 | * @g_frequency: callback for %VIDIOC_G_FREQUENCY ioctl handler code. |
| 222 | * freq->type must be filled in. Normally done by video_ioctl2() |
Mauro Carvalho Chehab | 89cb3dd | 2016-07-17 08:44:08 -0300 | [diff] [blame] | 223 | * or the bridge driver. |
Mauro Carvalho Chehab | 91963aa | 2015-08-22 06:07:29 -0300 | [diff] [blame] | 224 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 225 | * @enum_freq_bands: callback for %VIDIOC_ENUM_FREQ_BANDS ioctl handler code. |
Mauro Carvalho Chehab | 91963aa | 2015-08-22 06:07:29 -0300 | [diff] [blame] | 226 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 227 | * @g_tuner: callback for %VIDIOC_G_TUNER ioctl handler code. |
Mauro Carvalho Chehab | 91963aa | 2015-08-22 06:07:29 -0300 | [diff] [blame] | 228 | * |
Mauro Carvalho Chehab | 59d44bb | 2016-08-30 21:08:17 -0300 | [diff] [blame] | 229 | * @s_tuner: callback for %VIDIOC_S_TUNER ioctl handler code. @vt->type must be |
Mauro Carvalho Chehab | 91963aa | 2015-08-22 06:07:29 -0300 | [diff] [blame] | 230 | * filled in. Normally done by video_ioctl2 or the |
Mauro Carvalho Chehab | 89cb3dd | 2016-07-17 08:44:08 -0300 | [diff] [blame] | 231 | * bridge driver. |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 232 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 233 | * @g_modulator: callback for %VIDIOC_G_MODULATOR ioctl handler code. |
Mauro Carvalho Chehab | 91963aa | 2015-08-22 06:07:29 -0300 | [diff] [blame] | 234 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 235 | * @s_modulator: callback for %VIDIOC_S_MODULATOR ioctl handler code. |
Mauro Carvalho Chehab | 91963aa | 2015-08-22 06:07:29 -0300 | [diff] [blame] | 236 | * |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 237 | * @s_type_addr: sets tuner type and its I2C addr. |
Mauro Carvalho Chehab | 91963aa | 2015-08-22 06:07:29 -0300 | [diff] [blame] | 238 | * |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 239 | * @s_config: sets tda9887 specific stuff, like port1, port2 and qss |
Hans Verkuil | 78a3b4d | 2009-04-01 03:41:09 -0300 | [diff] [blame] | 240 | */ |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 241 | struct v4l2_subdev_tuner_ops { |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 242 | int (*s_radio)(struct v4l2_subdev *sd); |
Hans Verkuil | b530a44 | 2013-03-19 04:09:26 -0300 | [diff] [blame] | 243 | int (*s_frequency)(struct v4l2_subdev *sd, const struct v4l2_frequency *freq); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 244 | int (*g_frequency)(struct v4l2_subdev *sd, struct v4l2_frequency *freq); |
Antti Palosaari | c58d1de | 2014-02-05 02:24:35 -0300 | [diff] [blame] | 245 | int (*enum_freq_bands)(struct v4l2_subdev *sd, struct v4l2_frequency_band *band); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 246 | int (*g_tuner)(struct v4l2_subdev *sd, struct v4l2_tuner *vt); |
Hans Verkuil | 2f73c7c | 2013-03-15 06:10:06 -0300 | [diff] [blame] | 247 | int (*s_tuner)(struct v4l2_subdev *sd, const struct v4l2_tuner *vt); |
Eduardo Valentin | d6bacea | 2009-08-08 08:34:18 -0300 | [diff] [blame] | 248 | int (*g_modulator)(struct v4l2_subdev *sd, struct v4l2_modulator *vm); |
Hans Verkuil | 3f70e1f5 | 2012-09-04 12:08:47 -0300 | [diff] [blame] | 249 | int (*s_modulator)(struct v4l2_subdev *sd, const struct v4l2_modulator *vm); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 250 | int (*s_type_addr)(struct v4l2_subdev *sd, struct tuner_setup *type); |
| 251 | int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config); |
| 252 | }; |
| 253 | |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 254 | /** |
| 255 | * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings |
| 256 | * |
| 257 | * @s_clock_freq: set the frequency (in Hz) of the audio clock output. |
| 258 | * Used to slave an audio processor to the video decoder, ensuring that |
| 259 | * audio and video remain synchronized. Usual values for the frequency |
| 260 | * are 48000, 44100 or 32000 Hz. If the frequency is not supported, then |
| 261 | * -EINVAL is returned. |
| 262 | * |
| 263 | * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard |
| 264 | * way to select I2S clock used by driving digital audio streams at some |
| 265 | * board designs. Usual values for the frequency are 1024000 and 2048000. |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 266 | * If the frequency is not supported, then %-EINVAL is returned. |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 267 | * |
| 268 | * @s_routing: used to define the input and/or output pins of an audio chip, |
| 269 | * and any additional configuration data. |
| 270 | * Never attempt to use user-level input IDs (e.g. Composite, S-Video, |
| 271 | * Tuner) at this level. An i2c device shouldn't know about whether an |
| 272 | * input pin is connected to a Composite connector, become on another |
| 273 | * board or platform it might be connected to something else entirely. |
| 274 | * The calling driver is responsible for mapping a user-level input to |
| 275 | * the right pins on the i2c device. |
Mauro Carvalho Chehab | 1d8955b | 2015-08-22 06:59:26 -0300 | [diff] [blame] | 276 | * |
| 277 | * @s_stream: used to notify the audio code that stream will start or has |
| 278 | * stopped. |
Hans Verkuil | 78a3b4d | 2009-04-01 03:41:09 -0300 | [diff] [blame] | 279 | */ |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 280 | struct v4l2_subdev_audio_ops { |
| 281 | int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq); |
| 282 | int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq); |
Hans Verkuil | 5325b42 | 2009-04-02 11:26:22 -0300 | [diff] [blame] | 283 | int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); |
Andy Walls | 3ccc646 | 2009-12-24 13:06:08 -0300 | [diff] [blame] | 284 | int (*s_stream)(struct v4l2_subdev *sd, int enable); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 285 | }; |
| 286 | |
Sylwester Nawrocki | 2910311 | 2012-05-17 14:33:30 -0300 | [diff] [blame] | 287 | /* Indicates the @length field specifies maximum data length. */ |
| 288 | #define V4L2_MBUS_FRAME_DESC_FL_LEN_MAX (1U << 0) |
Sakari Ailus | 174d6a3 | 2013-12-18 08:40:28 -0300 | [diff] [blame] | 289 | /* |
| 290 | * Indicates that the format does not have line offsets, i.e. the |
| 291 | * receiver should use 1D DMA. |
| 292 | */ |
Sylwester Nawrocki | 2910311 | 2012-05-17 14:33:30 -0300 | [diff] [blame] | 293 | #define V4L2_MBUS_FRAME_DESC_FL_BLOB (1U << 1) |
| 294 | |
| 295 | /** |
| 296 | * struct v4l2_mbus_frame_desc_entry - media bus frame description structure |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 297 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 298 | * @flags: bitmask flags: %V4L2_MBUS_FRAME_DESC_FL_LEN_MAX and |
| 299 | * %V4L2_MBUS_FRAME_DESC_FL_BLOB. |
Sylwester Nawrocki | 2910311 | 2012-05-17 14:33:30 -0300 | [diff] [blame] | 300 | * @pixelcode: media bus pixel code, valid if FRAME_DESC_FL_BLOB is not set |
Sakari Ailus | 174d6a3 | 2013-12-18 08:40:28 -0300 | [diff] [blame] | 301 | * @length: number of octets per frame, valid if V4L2_MBUS_FRAME_DESC_FL_BLOB |
| 302 | * is set |
Sylwester Nawrocki | 2910311 | 2012-05-17 14:33:30 -0300 | [diff] [blame] | 303 | */ |
| 304 | struct v4l2_mbus_frame_desc_entry { |
| 305 | u16 flags; |
| 306 | u32 pixelcode; |
| 307 | u32 length; |
| 308 | }; |
| 309 | |
| 310 | #define V4L2_FRAME_DESC_ENTRY_MAX 4 |
| 311 | |
| 312 | /** |
| 313 | * struct v4l2_mbus_frame_desc - media bus data frame description |
| 314 | * @entry: frame descriptors array |
| 315 | * @num_entries: number of entries in @entry array |
| 316 | */ |
| 317 | struct v4l2_mbus_frame_desc { |
| 318 | struct v4l2_mbus_frame_desc_entry entry[V4L2_FRAME_DESC_ENTRY_MAX]; |
| 319 | unsigned short num_entries; |
| 320 | }; |
| 321 | |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 322 | /** |
| 323 | * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 324 | * in video mode. |
Mauro Carvalho Chehab | b84aeb0 | 2015-08-22 06:12:35 -0300 | [diff] [blame] | 325 | * |
| 326 | * @s_routing: see s_routing in audio_ops, except this version is for video |
| 327 | * devices. |
| 328 | * |
| 329 | * @s_crystal_freq: sets the frequency of the crystal used to generate the |
| 330 | * clocks in Hz. An extra flags field allows device specific configuration |
| 331 | * regarding clock frequency dividers, etc. If not used, then set flags |
| 332 | * to 0. If the frequency is not supported, then -EINVAL is returned. |
| 333 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 334 | * @g_std: callback for %VIDIOC_G_STD ioctl handler code. |
Mauro Carvalho Chehab | 914728a | 2015-08-22 06:18:13 -0300 | [diff] [blame] | 335 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 336 | * @s_std: callback for %VIDIOC_S_STD ioctl handler code. |
Mauro Carvalho Chehab | 914728a | 2015-08-22 06:18:13 -0300 | [diff] [blame] | 337 | * |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 338 | * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by |
| 339 | * video input devices. |
| 340 | * |
| 341 | * @g_std_output: get current standard for video OUTPUT devices. This is ignored |
| 342 | * by video input devices. |
| 343 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 344 | * @querystd: callback for %VIDIOC_QUERYSTD ioctl handler code. |
Mauro Carvalho Chehab | 914728a | 2015-08-22 06:18:13 -0300 | [diff] [blame] | 345 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 346 | * @g_tvnorms: get &v4l2_std_id with all standards supported by the video |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 347 | * CAPTURE device. This is ignored by video output devices. |
| 348 | * |
| 349 | * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video |
| 350 | * OUTPUT device. This is ignored by video capture devices. |
| 351 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 352 | * @g_input_status: get input status. Same as the status field in the |
| 353 | * &struct &v4l2_input |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 354 | * |
Mauro Carvalho Chehab | 1d8955b | 2015-08-22 06:59:26 -0300 | [diff] [blame] | 355 | * @s_stream: used to notify the driver that a video stream will start or has |
| 356 | * stopped. |
| 357 | * |
Hans Verkuil | ecf3749 | 2016-07-04 05:08:01 -0300 | [diff] [blame] | 358 | * @g_pixelaspect: callback to return the pixelaspect ratio. |
Mauro Carvalho Chehab | 914728a | 2015-08-22 06:18:13 -0300 | [diff] [blame] | 359 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 360 | * @g_parm: callback for %VIDIOC_G_PARM ioctl handler code. |
Mauro Carvalho Chehab | 914728a | 2015-08-22 06:18:13 -0300 | [diff] [blame] | 361 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 362 | * @s_parm: callback for %VIDIOC_S_PARM ioctl handler code. |
Mauro Carvalho Chehab | 914728a | 2015-08-22 06:18:13 -0300 | [diff] [blame] | 363 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 364 | * @g_frame_interval: callback for %VIDIOC_G_FRAMEINTERVAL ioctl handler code. |
Mauro Carvalho Chehab | 914728a | 2015-08-22 06:18:13 -0300 | [diff] [blame] | 365 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 366 | * @s_frame_interval: callback for %VIDIOC_S_FRAMEINTERVAL ioctl handler code. |
Mauro Carvalho Chehab | 914728a | 2015-08-22 06:18:13 -0300 | [diff] [blame] | 367 | * |
| 368 | * @s_dv_timings: Set custom dv timings in the sub device. This is used |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 369 | * when sub device is capable of setting detailed timing information |
| 370 | * in the hardware to generate/detect the video signal. |
| 371 | * |
Mauro Carvalho Chehab | 914728a | 2015-08-22 06:18:13 -0300 | [diff] [blame] | 372 | * @g_dv_timings: Get custom dv timings in the sub device. |
| 373 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 374 | * @query_dv_timings: callback for %VIDIOC_QUERY_DV_TIMINGS ioctl handler code. |
Mauro Carvalho Chehab | b84aeb0 | 2015-08-22 06:12:35 -0300 | [diff] [blame] | 375 | * |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 376 | * @g_mbus_config: get supported mediabus configurations |
| 377 | * |
| 378 | * @s_mbus_config: set a certain mediabus configuration. This operation is added |
| 379 | * for compatibility with soc-camera drivers and should not be used by new |
| 380 | * software. |
| 381 | * |
| 382 | * @s_rx_buffer: set a host allocated memory buffer for the subdev. The subdev |
| 383 | * can adjust @size to a lower value and must not write more data to the |
| 384 | * buffer starting at @data than the original value of @size. |
Hans Verkuil | 78a3b4d | 2009-04-01 03:41:09 -0300 | [diff] [blame] | 385 | */ |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 386 | struct v4l2_subdev_video_ops { |
Hans Verkuil | 5325b42 | 2009-04-02 11:26:22 -0300 | [diff] [blame] | 387 | int (*s_routing)(struct v4l2_subdev *sd, u32 input, u32 output, u32 config); |
Hans Verkuil | 3ff4ad8 | 2009-04-01 03:15:52 -0300 | [diff] [blame] | 388 | int (*s_crystal_freq)(struct v4l2_subdev *sd, u32 freq, u32 flags); |
Laurent Pinchart | 8774bed | 2014-04-28 16:53:01 -0300 | [diff] [blame] | 389 | int (*g_std)(struct v4l2_subdev *sd, v4l2_std_id *norm); |
| 390 | int (*s_std)(struct v4l2_subdev *sd, v4l2_std_id norm); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 391 | int (*s_std_output)(struct v4l2_subdev *sd, v4l2_std_id std); |
Tomasz Stanislawski | 5930ab2 | 2011-06-29 07:16:15 -0300 | [diff] [blame] | 392 | int (*g_std_output)(struct v4l2_subdev *sd, v4l2_std_id *std); |
Hans Verkuil | 1b6f1d9 | 2009-02-13 07:48:21 -0300 | [diff] [blame] | 393 | int (*querystd)(struct v4l2_subdev *sd, v4l2_std_id *std); |
Hans Verkuil | 4835386 | 2014-02-17 08:44:12 -0300 | [diff] [blame] | 394 | int (*g_tvnorms)(struct v4l2_subdev *sd, v4l2_std_id *std); |
Tomasz Stanislawski | 839cf81 | 2011-03-02 13:16:37 -0300 | [diff] [blame] | 395 | int (*g_tvnorms_output)(struct v4l2_subdev *sd, v4l2_std_id *std); |
Hans Verkuil | 1b6f1d9 | 2009-02-13 07:48:21 -0300 | [diff] [blame] | 396 | int (*g_input_status)(struct v4l2_subdev *sd, u32 *status); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 397 | int (*s_stream)(struct v4l2_subdev *sd, int enable); |
Hans Verkuil | ecf3749 | 2016-07-04 05:08:01 -0300 | [diff] [blame] | 398 | int (*g_pixelaspect)(struct v4l2_subdev *sd, struct v4l2_fract *aspect); |
Hans Verkuil | 2da9479 | 2009-02-06 18:59:35 -0300 | [diff] [blame] | 399 | int (*g_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); |
| 400 | int (*s_parm)(struct v4l2_subdev *sd, struct v4l2_streamparm *param); |
Laurent Pinchart | 35c3017 | 2010-05-05 11:38:35 -0300 | [diff] [blame] | 401 | int (*g_frame_interval)(struct v4l2_subdev *sd, |
| 402 | struct v4l2_subdev_frame_interval *interval); |
| 403 | int (*s_frame_interval)(struct v4l2_subdev *sd, |
| 404 | struct v4l2_subdev_frame_interval *interval); |
Muralidharan Karicheri | b6456c0 | 2009-11-19 12:00:31 -0300 | [diff] [blame] | 405 | int (*s_dv_timings)(struct v4l2_subdev *sd, |
| 406 | struct v4l2_dv_timings *timings); |
| 407 | int (*g_dv_timings)(struct v4l2_subdev *sd, |
| 408 | struct v4l2_dv_timings *timings); |
Hans Verkuil | 5d7758e | 2012-05-15 08:06:44 -0300 | [diff] [blame] | 409 | int (*query_dv_timings)(struct v4l2_subdev *sd, |
| 410 | struct v4l2_dv_timings *timings); |
Guennadi Liakhovetski | 91c7953 | 2011-07-01 14:31:17 -0300 | [diff] [blame] | 411 | int (*g_mbus_config)(struct v4l2_subdev *sd, |
| 412 | struct v4l2_mbus_config *cfg); |
| 413 | int (*s_mbus_config)(struct v4l2_subdev *sd, |
| 414 | const struct v4l2_mbus_config *cfg); |
Sylwester Nawrocki | a375e1d | 2012-09-13 13:08:19 -0300 | [diff] [blame] | 415 | int (*s_rx_buffer)(struct v4l2_subdev *sd, void *buf, |
| 416 | unsigned int *size); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 417 | }; |
| 418 | |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 419 | /** |
| 420 | * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 421 | * in video mode via the vbi device node. |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 422 | * |
| 423 | * @decode_vbi_line: video decoders that support sliced VBI need to implement |
Mauro Carvalho Chehab | 9ef0b3f | 2016-09-09 08:40:15 -0300 | [diff] [blame] | 424 | * this ioctl. Field p of the &struct v4l2_decode_vbi_line is set to the |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 425 | * start of the VBI data that was generated by the decoder. The driver |
| 426 | * then parses the sliced VBI data and sets the other fields in the |
| 427 | * struct accordingly. The pointer p is updated to point to the start of |
| 428 | * the payload which can be copied verbatim into the data field of the |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 429 | * &struct v4l2_sliced_vbi_data. If no valid VBI data was found, then the |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 430 | * type field is set to 0 on return. |
| 431 | * |
| 432 | * @s_vbi_data: used to generate VBI signals on a video signal. |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 433 | * &struct v4l2_sliced_vbi_data is filled with the data packets that |
| 434 | * should be output. Note that if you set the line field to 0, then that |
| 435 | * VBI signal is disabled. If no valid VBI data was found, then the type |
| 436 | * field is set to 0 on return. |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 437 | * |
| 438 | * @g_vbi_data: used to obtain the sliced VBI packet from a readback register. |
| 439 | * Not all video decoders support this. If no data is available because |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 440 | * the readback register contains invalid or erroneous data %-EIO is |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 441 | * returned. Note that you must fill in the 'id' member and the 'field' |
| 442 | * member (to determine whether CC data from the first or second field |
| 443 | * should be obtained). |
| 444 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 445 | * @g_sliced_vbi_cap: callback for %VIDIOC_SLICED_VBI_CAP ioctl handler code. |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 446 | * |
Mauro Carvalho Chehab | 5c66298 | 2015-08-22 05:40:29 -0300 | [diff] [blame] | 447 | * @s_raw_fmt: setup the video encoder/decoder for raw VBI. |
| 448 | * |
| 449 | * @g_sliced_fmt: retrieve the current sliced VBI settings. |
| 450 | * |
| 451 | * @s_sliced_fmt: setup the sliced VBI settings. |
Hans Verkuil | 32cd527 | 2010-03-14 09:57:30 -0300 | [diff] [blame] | 452 | */ |
| 453 | struct v4l2_subdev_vbi_ops { |
| 454 | int (*decode_vbi_line)(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi_line); |
| 455 | int (*s_vbi_data)(struct v4l2_subdev *sd, const struct v4l2_sliced_vbi_data *vbi_data); |
| 456 | int (*g_vbi_data)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_data *vbi_data); |
| 457 | int (*g_sliced_vbi_cap)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_cap *cap); |
Hans Verkuil | 54aefaf | 2010-03-14 10:02:50 -0300 | [diff] [blame] | 458 | int (*s_raw_fmt)(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt); |
| 459 | int (*g_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); |
| 460 | int (*s_sliced_fmt)(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt); |
Hans Verkuil | 32cd527 | 2010-03-14 09:57:30 -0300 | [diff] [blame] | 461 | }; |
| 462 | |
Guennadi Liakhovetski | 3253610 | 2009-12-11 11:14:46 -0300 | [diff] [blame] | 463 | /** |
| 464 | * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations |
| 465 | * @g_skip_top_lines: number of lines at the top of the image to be skipped. |
| 466 | * This is needed for some sensors, which always corrupt |
| 467 | * several top lines of the output image, or which send their |
| 468 | * metadata in them. |
Laurent Pinchart | f80a3ab | 2010-11-16 01:21:06 -0300 | [diff] [blame] | 469 | * @g_skip_frames: number of frames to skip at stream start. This is needed for |
| 470 | * buggy sensors that generate faulty frames when they are |
| 471 | * turned on. |
Guennadi Liakhovetski | 3253610 | 2009-12-11 11:14:46 -0300 | [diff] [blame] | 472 | */ |
| 473 | struct v4l2_subdev_sensor_ops { |
| 474 | int (*g_skip_top_lines)(struct v4l2_subdev *sd, u32 *lines); |
Laurent Pinchart | f80a3ab | 2010-11-16 01:21:06 -0300 | [diff] [blame] | 475 | int (*g_skip_frames)(struct v4l2_subdev *sd, u32 *frames); |
Guennadi Liakhovetski | 3253610 | 2009-12-11 11:14:46 -0300 | [diff] [blame] | 476 | }; |
| 477 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 478 | /** |
| 479 | * enum v4l2_subdev_ir_mode- describes the type of IR supported |
| 480 | * |
| 481 | * @V4L2_SUBDEV_IR_MODE_PULSE_WIDTH: IR uses struct ir_raw_event records |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 482 | */ |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 483 | enum v4l2_subdev_ir_mode { |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 484 | V4L2_SUBDEV_IR_MODE_PULSE_WIDTH, |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 485 | }; |
| 486 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 487 | /** |
| 488 | * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX |
| 489 | * |
| 490 | * @bytes_per_data_element: bytes per data element of data in read or |
| 491 | * write call. |
| 492 | * @mode: IR mode as defined by &enum v4l2_subdev_ir_mode. |
| 493 | * @enable: device is active if true |
| 494 | * @interrupt_enable: IR interrupts are enabled if true |
| 495 | * @shutdown: if true: set hardware to low/no power, false: normal mode |
| 496 | * |
| 497 | * @modulation: if true, it uses carrier, if false: baseband |
| 498 | * @max_pulse_width: maximum pulse width in ns, valid only for baseband signal |
| 499 | * @carrier_freq: carrier frequency in Hz, valid only for modulated signal |
| 500 | * @duty_cycle: duty cycle percentage, valid only for modulated signal |
| 501 | * @invert_level: invert signal level |
| 502 | * |
| 503 | * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX. |
| 504 | * |
| 505 | * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX. |
| 506 | * @carrier_range_lower: Lower carrier range, in Hz, valid only for modulated |
| 507 | * signal. Used only for RX. |
| 508 | * @carrier_range_upper: Upper carrier range, in Hz, valid only for modulated |
| 509 | * signal. Used only for RX. |
| 510 | * @resolution: The receive resolution, in ns . Used only for RX. |
| 511 | */ |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 512 | struct v4l2_subdev_ir_parameters { |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 513 | unsigned int bytes_per_data_element; |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 514 | enum v4l2_subdev_ir_mode mode; |
| 515 | |
| 516 | bool enable; |
| 517 | bool interrupt_enable; |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 518 | bool shutdown; |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 519 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 520 | bool modulation; |
| 521 | u32 max_pulse_width; |
| 522 | unsigned int carrier_freq; |
| 523 | unsigned int duty_cycle; |
| 524 | bool invert_level; |
Andy Walls | 5a28d9a | 2010-07-18 19:57:25 -0300 | [diff] [blame] | 525 | |
| 526 | /* Tx only */ |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 527 | bool invert_carrier_sense; |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 528 | |
| 529 | /* Rx only */ |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 530 | u32 noise_filter_min_width; |
| 531 | unsigned int carrier_range_lower; |
| 532 | unsigned int carrier_range_upper; |
| 533 | u32 resolution; |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 534 | }; |
| 535 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 536 | /** |
| 537 | * struct v4l2_subdev_ir_ops - operations for IR subdevices |
| 538 | * |
| 539 | * @rx_read: Reads received codes or pulse width data. |
| 540 | * The semantics are similar to a non-blocking read() call. |
| 541 | * @rx_g_parameters: Get the current operating parameters and state of the |
| 542 | * the IR receiver. |
| 543 | * @rx_s_parameters: Set the current operating parameters and state of the |
| 544 | * the IR receiver. It is recommended to call |
| 545 | * [rt]x_g_parameters first to fill out the current state, and only change |
| 546 | * the fields that need to be changed. Upon return, the actual device |
| 547 | * operating parameters and state will be returned. Note that hardware |
| 548 | * limitations may prevent the actual settings from matching the requested |
| 549 | * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz |
| 550 | * was requested. An exception is when the shutdown parameter is true. |
| 551 | * The last used operational parameters will be returned, but the actual |
| 552 | * state of the hardware be different to minimize power consumption and |
| 553 | * processing when shutdown is true. |
| 554 | * |
| 555 | * @tx_write: Writes codes or pulse width data for transmission. |
| 556 | * The semantics are similar to a non-blocking write() call. |
| 557 | * @tx_g_parameters: Get the current operating parameters and state of the |
| 558 | * the IR transmitter. |
| 559 | * @tx_s_parameters: Set the current operating parameters and state of the |
| 560 | * the IR transmitter. It is recommended to call |
| 561 | * [rt]x_g_parameters first to fill out the current state, and only change |
| 562 | * the fields that need to be changed. Upon return, the actual device |
| 563 | * operating parameters and state will be returned. Note that hardware |
| 564 | * limitations may prevent the actual settings from matching the requested |
| 565 | * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz |
| 566 | * was requested. An exception is when the shutdown parameter is true. |
| 567 | * The last used operational parameters will be returned, but the actual |
| 568 | * state of the hardware be different to minimize power consumption and |
| 569 | * processing when shutdown is true. |
| 570 | */ |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 571 | struct v4l2_subdev_ir_ops { |
Andy Walls | 1d986ad | 2009-09-27 17:50:04 -0300 | [diff] [blame] | 572 | /* Receiver */ |
| 573 | int (*rx_read)(struct v4l2_subdev *sd, u8 *buf, size_t count, |
| 574 | ssize_t *num); |
| 575 | |
| 576 | int (*rx_g_parameters)(struct v4l2_subdev *sd, |
| 577 | struct v4l2_subdev_ir_parameters *params); |
| 578 | int (*rx_s_parameters)(struct v4l2_subdev *sd, |
| 579 | struct v4l2_subdev_ir_parameters *params); |
| 580 | |
| 581 | /* Transmitter */ |
| 582 | int (*tx_write)(struct v4l2_subdev *sd, u8 *buf, size_t count, |
| 583 | ssize_t *num); |
| 584 | |
| 585 | int (*tx_g_parameters)(struct v4l2_subdev *sd, |
| 586 | struct v4l2_subdev_ir_parameters *params); |
| 587 | int (*tx_s_parameters)(struct v4l2_subdev *sd, |
| 588 | struct v4l2_subdev_ir_parameters *params); |
| 589 | }; |
| 590 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 591 | /** |
| 592 | * struct v4l2_subdev_pad_config - Used for storing subdev pad information. |
| 593 | * |
| 594 | * @try_fmt: pointer to &struct v4l2_mbus_framefmt |
| 595 | * @try_crop: pointer to &struct v4l2_rect to be used for crop |
| 596 | * @try_compose: pointer to &struct v4l2_rect to be used for compose |
| 597 | * |
| 598 | * This structure only needs to be passed to the pad op if the 'which' field |
| 599 | * of the main argument is set to %V4L2_SUBDEV_FORMAT_TRY. For |
| 600 | * %V4L2_SUBDEV_FORMAT_ACTIVE it is safe to pass %NULL. |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 601 | */ |
| 602 | struct v4l2_subdev_pad_config { |
| 603 | struct v4l2_mbus_framefmt try_fmt; |
| 604 | struct v4l2_rect try_crop; |
| 605 | struct v4l2_rect try_compose; |
| 606 | }; |
| 607 | |
Sylwester Nawrocki | 2910311 | 2012-05-17 14:33:30 -0300 | [diff] [blame] | 608 | /** |
| 609 | * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 610 | * |
Laurent Pinchart | 9b02cbb | 2015-04-24 20:06:31 -0300 | [diff] [blame] | 611 | * @init_cfg: initialize the pad config to default values |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 612 | * @enum_mbus_code: callback for %VIDIOC_SUBDEV_ENUM_MBUS_CODE ioctl handler |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 613 | * code. |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 614 | * @enum_frame_size: callback for %VIDIOC_SUBDEV_ENUM_FRAME_SIZE ioctl handler |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 615 | * code. |
| 616 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 617 | * @enum_frame_interval: callback for %VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL ioctl |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 618 | * handler code. |
| 619 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 620 | * @get_fmt: callback for %VIDIOC_SUBDEV_G_FMT ioctl handler code. |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 621 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 622 | * @set_fmt: callback for %VIDIOC_SUBDEV_S_FMT ioctl handler code. |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 623 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 624 | * @get_selection: callback for %VIDIOC_SUBDEV_G_SELECTION ioctl handler code. |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 625 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 626 | * @set_selection: callback for %VIDIOC_SUBDEV_S_SELECTION ioctl handler code. |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 627 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 628 | * @get_edid: callback for %VIDIOC_SUBDEV_G_EDID ioctl handler code. |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 629 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 630 | * @set_edid: callback for %VIDIOC_SUBDEV_S_EDID ioctl handler code. |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 631 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 632 | * @dv_timings_cap: callback for %VIDIOC_SUBDEV_DV_TIMINGS_CAP ioctl handler |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 633 | * code. |
| 634 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 635 | * @enum_dv_timings: callback for %VIDIOC_SUBDEV_ENUM_DV_TIMINGS ioctl handler |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 636 | * code. |
| 637 | * |
Mauro Carvalho Chehab | 1d8955b | 2015-08-22 06:59:26 -0300 | [diff] [blame] | 638 | * @link_validate: used by the media controller code to check if the links |
| 639 | * that belongs to a pipeline can be used for stream. |
| 640 | * |
Sylwester Nawrocki | 2910311 | 2012-05-17 14:33:30 -0300 | [diff] [blame] | 641 | * @get_frame_desc: get the current low level media bus frame parameters. |
Mauro Carvalho Chehab | e44cc20 | 2015-08-22 06:34:06 -0300 | [diff] [blame] | 642 | * |
Mauro Carvalho Chehab | 1d8955b | 2015-08-22 06:59:26 -0300 | [diff] [blame] | 643 | * @set_frame_desc: set the low level media bus frame parameters, @fd array |
Sylwester Nawrocki | 2910311 | 2012-05-17 14:33:30 -0300 | [diff] [blame] | 644 | * may be adjusted by the subdev driver to device capabilities. |
| 645 | */ |
Laurent Pinchart | eb08f35 | 2009-12-09 08:39:52 -0300 | [diff] [blame] | 646 | struct v4l2_subdev_pad_ops { |
Laurent Pinchart | 9b02cbb | 2015-04-24 20:06:31 -0300 | [diff] [blame] | 647 | int (*init_cfg)(struct v4l2_subdev *sd, |
| 648 | struct v4l2_subdev_pad_config *cfg); |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 649 | int (*enum_mbus_code)(struct v4l2_subdev *sd, |
| 650 | struct v4l2_subdev_pad_config *cfg, |
Laurent Pinchart | 333c8b9 | 2010-03-15 20:26:04 -0300 | [diff] [blame] | 651 | struct v4l2_subdev_mbus_code_enum *code); |
| 652 | int (*enum_frame_size)(struct v4l2_subdev *sd, |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 653 | struct v4l2_subdev_pad_config *cfg, |
Laurent Pinchart | 333c8b9 | 2010-03-15 20:26:04 -0300 | [diff] [blame] | 654 | struct v4l2_subdev_frame_size_enum *fse); |
Laurent Pinchart | 35c3017 | 2010-05-05 11:38:35 -0300 | [diff] [blame] | 655 | int (*enum_frame_interval)(struct v4l2_subdev *sd, |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 656 | struct v4l2_subdev_pad_config *cfg, |
Laurent Pinchart | 35c3017 | 2010-05-05 11:38:35 -0300 | [diff] [blame] | 657 | struct v4l2_subdev_frame_interval_enum *fie); |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 658 | int (*get_fmt)(struct v4l2_subdev *sd, |
| 659 | struct v4l2_subdev_pad_config *cfg, |
Laurent Pinchart | 333c8b9 | 2010-03-15 20:26:04 -0300 | [diff] [blame] | 660 | struct v4l2_subdev_format *format); |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 661 | int (*set_fmt)(struct v4l2_subdev *sd, |
| 662 | struct v4l2_subdev_pad_config *cfg, |
Laurent Pinchart | 333c8b9 | 2010-03-15 20:26:04 -0300 | [diff] [blame] | 663 | struct v4l2_subdev_format *format); |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 664 | int (*get_selection)(struct v4l2_subdev *sd, |
| 665 | struct v4l2_subdev_pad_config *cfg, |
Sakari Ailus | ae184cd | 2011-10-14 14:14:26 -0300 | [diff] [blame] | 666 | struct v4l2_subdev_selection *sel); |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 667 | int (*set_selection)(struct v4l2_subdev *sd, |
| 668 | struct v4l2_subdev_pad_config *cfg, |
Sakari Ailus | ae184cd | 2011-10-14 14:14:26 -0300 | [diff] [blame] | 669 | struct v4l2_subdev_selection *sel); |
Hans Verkuil | dd519bb | 2014-03-07 07:18:37 -0300 | [diff] [blame] | 670 | int (*get_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); |
| 671 | int (*set_edid)(struct v4l2_subdev *sd, struct v4l2_edid *edid); |
Laurent Pinchart | 0349f6a | 2014-01-29 10:05:10 -0300 | [diff] [blame] | 672 | int (*dv_timings_cap)(struct v4l2_subdev *sd, |
| 673 | struct v4l2_dv_timings_cap *cap); |
| 674 | int (*enum_dv_timings)(struct v4l2_subdev *sd, |
| 675 | struct v4l2_enum_dv_timings *timings); |
Sakari Ailus | 8227c92 | 2011-10-10 17:01:25 -0300 | [diff] [blame] | 676 | #ifdef CONFIG_MEDIA_CONTROLLER |
| 677 | int (*link_validate)(struct v4l2_subdev *sd, struct media_link *link, |
| 678 | struct v4l2_subdev_format *source_fmt, |
| 679 | struct v4l2_subdev_format *sink_fmt); |
| 680 | #endif /* CONFIG_MEDIA_CONTROLLER */ |
Sylwester Nawrocki | 2910311 | 2012-05-17 14:33:30 -0300 | [diff] [blame] | 681 | int (*get_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, |
| 682 | struct v4l2_mbus_frame_desc *fd); |
| 683 | int (*set_frame_desc)(struct v4l2_subdev *sd, unsigned int pad, |
| 684 | struct v4l2_mbus_frame_desc *fd); |
Laurent Pinchart | eb08f35 | 2009-12-09 08:39:52 -0300 | [diff] [blame] | 685 | }; |
| 686 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 687 | /** |
| 688 | * struct v4l2_subdev_ops - Subdev operations |
| 689 | * |
| 690 | * @core: pointer to &struct v4l2_subdev_core_ops. Can be %NULL |
| 691 | * @tuner: pointer to &struct v4l2_subdev_tuner_ops. Can be %NULL |
| 692 | * @audio: pointer to &struct v4l2_subdev_audio_ops. Can be %NULL |
| 693 | * @video: pointer to &struct v4l2_subdev_video_ops. Can be %NULL |
| 694 | * @vbi: pointer to &struct v4l2_subdev_vbi_ops. Can be %NULL |
| 695 | * @ir: pointer to &struct v4l2_subdev_ir_ops. Can be %NULL |
| 696 | * @sensor: pointer to &struct v4l2_subdev_sensor_ops. Can be %NULL |
| 697 | * @pad: pointer to &struct v4l2_subdev_pad_ops. Can be %NULL |
| 698 | */ |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 699 | struct v4l2_subdev_ops { |
Guennadi Liakhovetski | 3253610 | 2009-12-11 11:14:46 -0300 | [diff] [blame] | 700 | const struct v4l2_subdev_core_ops *core; |
| 701 | const struct v4l2_subdev_tuner_ops *tuner; |
| 702 | const struct v4l2_subdev_audio_ops *audio; |
| 703 | const struct v4l2_subdev_video_ops *video; |
Hans Verkuil | 32cd527 | 2010-03-14 09:57:30 -0300 | [diff] [blame] | 704 | const struct v4l2_subdev_vbi_ops *vbi; |
Guennadi Liakhovetski | 3253610 | 2009-12-11 11:14:46 -0300 | [diff] [blame] | 705 | const struct v4l2_subdev_ir_ops *ir; |
| 706 | const struct v4l2_subdev_sensor_ops *sensor; |
Laurent Pinchart | eb08f35 | 2009-12-09 08:39:52 -0300 | [diff] [blame] | 707 | const struct v4l2_subdev_pad_ops *pad; |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 708 | }; |
| 709 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 710 | /** |
| 711 | * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops |
Hans Verkuil | 45f6f84 | 2011-01-08 07:15:53 -0300 | [diff] [blame] | 712 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 713 | * @registered: called when this subdev is registered. When called the v4l2_dev |
Hans Verkuil | 45f6f84 | 2011-01-08 07:15:53 -0300 | [diff] [blame] | 714 | * field is set to the correct v4l2_device. |
| 715 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 716 | * @unregistered: called when this subdev is unregistered. When called the |
Hans Verkuil | 45f6f84 | 2011-01-08 07:15:53 -0300 | [diff] [blame] | 717 | * v4l2_dev field is still set to the correct v4l2_device. |
Laurent Pinchart | f0beea8 | 2010-08-01 19:05:09 -0300 | [diff] [blame] | 718 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 719 | * @open: called when the subdev device node is opened by an application. |
Laurent Pinchart | f0beea8 | 2010-08-01 19:05:09 -0300 | [diff] [blame] | 720 | * |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 721 | * @close: called when the subdev device node is closed. |
| 722 | * |
| 723 | * .. note:: |
| 724 | * Never call this from drivers, only the v4l2 framework can call |
| 725 | * these ops. |
Hans Verkuil | 45f6f84 | 2011-01-08 07:15:53 -0300 | [diff] [blame] | 726 | */ |
| 727 | struct v4l2_subdev_internal_ops { |
| 728 | int (*registered)(struct v4l2_subdev *sd); |
| 729 | void (*unregistered)(struct v4l2_subdev *sd); |
Laurent Pinchart | f0beea8 | 2010-08-01 19:05:09 -0300 | [diff] [blame] | 730 | int (*open)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); |
| 731 | int (*close)(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh); |
Hans Verkuil | 45f6f84 | 2011-01-08 07:15:53 -0300 | [diff] [blame] | 732 | }; |
| 733 | |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 734 | #define V4L2_SUBDEV_NAME_SIZE 32 |
| 735 | |
Hans Verkuil | b5b2b7e | 2009-05-02 10:58:51 -0300 | [diff] [blame] | 736 | /* Set this flag if this subdev is a i2c device. */ |
Laurent Pinchart | 2096a5d | 2009-12-09 08:38:49 -0300 | [diff] [blame] | 737 | #define V4L2_SUBDEV_FL_IS_I2C (1U << 0) |
Dmitri Belimov | 85e0921 | 2010-03-23 11:23:29 -0300 | [diff] [blame] | 738 | /* Set this flag if this subdev is a spi device. */ |
Laurent Pinchart | 2096a5d | 2009-12-09 08:38:49 -0300 | [diff] [blame] | 739 | #define V4L2_SUBDEV_FL_IS_SPI (1U << 1) |
| 740 | /* Set this flag if this subdev needs a device node. */ |
| 741 | #define V4L2_SUBDEV_FL_HAS_DEVNODE (1U << 2) |
Sakari Ailus | 02adb1c | 2010-03-03 12:49:38 -0300 | [diff] [blame] | 742 | /* Set this flag if this subdev generates events. */ |
| 743 | #define V4L2_SUBDEV_FL_HAS_EVENTS (1U << 3) |
Hans Verkuil | b5b2b7e | 2009-05-02 10:58:51 -0300 | [diff] [blame] | 744 | |
Guennadi Liakhovetski | b1cbab0 | 2013-04-18 18:35:27 -0300 | [diff] [blame] | 745 | struct regulator_bulk_data; |
| 746 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 747 | /** |
| 748 | * struct v4l2_subdev_platform_data - regulators config struct |
| 749 | * |
| 750 | * @regulators: Optional regulators used to power on/off the subdevice |
| 751 | * @num_regulators: Number of regululators |
| 752 | * @host_priv: Per-subdevice data, specific for a certain video host device |
| 753 | */ |
Guennadi Liakhovetski | b1cbab0 | 2013-04-18 18:35:27 -0300 | [diff] [blame] | 754 | struct v4l2_subdev_platform_data { |
Guennadi Liakhovetski | b1cbab0 | 2013-04-18 18:35:27 -0300 | [diff] [blame] | 755 | struct regulator_bulk_data *regulators; |
| 756 | int num_regulators; |
| 757 | |
Guennadi Liakhovetski | b1cbab0 | 2013-04-18 18:35:27 -0300 | [diff] [blame] | 758 | void *host_priv; |
| 759 | }; |
| 760 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 761 | /** |
| 762 | * struct v4l2_subdev - describes a V4L2 sub-device |
| 763 | * |
| 764 | * @entity: pointer to &struct media_entity |
| 765 | * @list: List of sub-devices |
| 766 | * @owner: The owner is the same as the driver's &struct device owner. |
Mauro Carvalho Chehab | cb8d67c | 2016-09-08 18:31:17 -0300 | [diff] [blame] | 767 | * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 768 | * ownner. Initialized by v4l2_device_register_subdev(). |
| 769 | * @flags: subdev flags. Can be: |
| 770 | * %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device; |
| 771 | * %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device; |
| 772 | * %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a |
| 773 | * device node; |
| 774 | * %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates |
| 775 | * events. |
| 776 | * |
Mauro Carvalho Chehab | cb8d67c | 2016-09-08 18:31:17 -0300 | [diff] [blame] | 777 | * @v4l2_dev: pointer to struct &v4l2_device |
| 778 | * @ops: pointer to struct &v4l2_subdev_ops |
| 779 | * @internal_ops: pointer to struct &v4l2_subdev_internal_ops. |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 780 | * Never call these internal ops from within a driver! |
| 781 | * @ctrl_handler: The control handler of this subdev. May be NULL. |
| 782 | * @name: Name of the sub-device. Please notice that the name must be unique. |
| 783 | * @grp_id: can be used to group similar subdevs. Value is driver-specific |
| 784 | * @dev_priv: pointer to private data |
| 785 | * @host_priv: pointer to private data used by the device where the subdev |
| 786 | * is attached. |
| 787 | * @devnode: subdev device node |
| 788 | * @dev: pointer to the physical device, if any |
| 789 | * @of_node: The device_node of the subdev, usually the same as dev->of_node. |
| 790 | * @async_list: Links this subdev to a global subdev_list or @notifier->done |
| 791 | * list. |
| 792 | * @asd: Pointer to respective &struct v4l2_async_subdev. |
| 793 | * @notifier: Pointer to the managing notifier. |
| 794 | * @pdata: common part of subdevice platform data |
| 795 | * |
| 796 | * Each instance of a subdev driver should create this struct, either |
| 797 | * stand-alone or embedded in a larger struct. |
| 798 | * |
| 799 | * This structure should be initialized by v4l2_subdev_init() or one of |
| 800 | * its variants: v4l2_spi_subdev_init(), v4l2_i2c_subdev_init(). |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 801 | */ |
| 802 | struct v4l2_subdev { |
Laurent Pinchart | 61f5db5 | 2009-12-09 08:40:08 -0300 | [diff] [blame] | 803 | #if defined(CONFIG_MEDIA_CONTROLLER) |
| 804 | struct media_entity entity; |
| 805 | #endif |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 806 | struct list_head list; |
| 807 | struct module *owner; |
Sakari Ailus | b2a06ae | 2013-12-12 09:36:46 -0300 | [diff] [blame] | 808 | bool owner_v4l2_dev; |
Hans Verkuil | b5b2b7e | 2009-05-02 10:58:51 -0300 | [diff] [blame] | 809 | u32 flags; |
Hans Verkuil | b016760 | 2009-02-14 12:00:53 -0300 | [diff] [blame] | 810 | struct v4l2_device *v4l2_dev; |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 811 | const struct v4l2_subdev_ops *ops; |
Hans Verkuil | 45f6f84 | 2011-01-08 07:15:53 -0300 | [diff] [blame] | 812 | const struct v4l2_subdev_internal_ops *internal_ops; |
Hans Verkuil | 0996517 | 2010-08-01 14:32:42 -0300 | [diff] [blame] | 813 | struct v4l2_ctrl_handler *ctrl_handler; |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 814 | char name[V4L2_SUBDEV_NAME_SIZE]; |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 815 | u32 grp_id; |
Laurent Pinchart | 692d5522 | 2010-07-30 17:24:55 -0300 | [diff] [blame] | 816 | void *dev_priv; |
| 817 | void *host_priv; |
Guennadi Liakhovetski | 3e0ec41 | 2011-09-13 08:07:55 -0300 | [diff] [blame] | 818 | struct video_device *devnode; |
Guennadi Liakhovetski | 668773b | 2013-06-10 15:07:35 -0300 | [diff] [blame] | 819 | struct device *dev; |
Sakari Ailus | 8621765 | 2015-06-11 12:18:01 -0700 | [diff] [blame] | 820 | struct device_node *of_node; |
Sylwester Nawrocki | b426b3a | 2013-07-22 08:01:33 -0300 | [diff] [blame] | 821 | struct list_head async_list; |
Sylwester Nawrocki | b426b3a | 2013-07-22 08:01:33 -0300 | [diff] [blame] | 822 | struct v4l2_async_subdev *asd; |
Sylwester Nawrocki | b426b3a | 2013-07-22 08:01:33 -0300 | [diff] [blame] | 823 | struct v4l2_async_notifier *notifier; |
Guennadi Liakhovetski | b1cbab0 | 2013-04-18 18:35:27 -0300 | [diff] [blame] | 824 | struct v4l2_subdev_platform_data *pdata; |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 825 | }; |
| 826 | |
Laurent Pinchart | 61f5db5 | 2009-12-09 08:40:08 -0300 | [diff] [blame] | 827 | #define media_entity_to_v4l2_subdev(ent) \ |
| 828 | container_of(ent, struct v4l2_subdev, entity) |
Laurent Pinchart | 2096a5d | 2009-12-09 08:38:49 -0300 | [diff] [blame] | 829 | #define vdev_to_v4l2_subdev(vdev) \ |
Sakari Ailus | c5a766c | 2012-02-15 22:58:12 -0300 | [diff] [blame] | 830 | ((struct v4l2_subdev *)video_get_drvdata(vdev)) |
Laurent Pinchart | 2096a5d | 2009-12-09 08:38:49 -0300 | [diff] [blame] | 831 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 832 | /** |
| 833 | * struct v4l2_subdev_fh - Used for storing subdev information per file handle |
| 834 | * |
| 835 | * @vfh: pointer to struct v4l2_fh |
| 836 | * @pad: pointer to v4l2_subdev_pad_config |
Stanimir Varbanov | 7cd5a16 | 2010-05-21 06:04:24 -0300 | [diff] [blame] | 837 | */ |
| 838 | struct v4l2_subdev_fh { |
| 839 | struct v4l2_fh vfh; |
| 840 | #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 841 | struct v4l2_subdev_pad_config *pad; |
Stanimir Varbanov | 7cd5a16 | 2010-05-21 06:04:24 -0300 | [diff] [blame] | 842 | #endif |
| 843 | }; |
| 844 | |
| 845 | #define to_v4l2_subdev_fh(fh) \ |
| 846 | container_of(fh, struct v4l2_subdev_fh, vfh) |
| 847 | |
| 848 | #if defined(CONFIG_VIDEO_V4L2_SUBDEV_API) |
Sakari Ailus | 5e6ff7c | 2012-02-15 22:57:22 -0300 | [diff] [blame] | 849 | #define __V4L2_SUBDEV_MK_GET_TRY(rtype, fun_name, field_name) \ |
| 850 | static inline struct rtype * \ |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 851 | fun_name(struct v4l2_subdev *sd, \ |
| 852 | struct v4l2_subdev_pad_config *cfg, \ |
| 853 | unsigned int pad) \ |
Sakari Ailus | 5e6ff7c | 2012-02-15 22:57:22 -0300 | [diff] [blame] | 854 | { \ |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 855 | BUG_ON(pad >= sd->entity.num_pads); \ |
| 856 | return &cfg[pad].field_name; \ |
Sakari Ailus | 5e6ff7c | 2012-02-15 22:57:22 -0300 | [diff] [blame] | 857 | } |
Stanimir Varbanov | 7cd5a16 | 2010-05-21 06:04:24 -0300 | [diff] [blame] | 858 | |
Hans Verkuil | f723413 | 2015-03-04 01:47:54 -0800 | [diff] [blame] | 859 | __V4L2_SUBDEV_MK_GET_TRY(v4l2_mbus_framefmt, v4l2_subdev_get_try_format, try_fmt) |
| 860 | __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_crop, try_crop) |
| 861 | __V4L2_SUBDEV_MK_GET_TRY(v4l2_rect, v4l2_subdev_get_try_compose, try_compose) |
Stanimir Varbanov | 7cd5a16 | 2010-05-21 06:04:24 -0300 | [diff] [blame] | 862 | #endif |
| 863 | |
Laurent Pinchart | 2096a5d | 2009-12-09 08:38:49 -0300 | [diff] [blame] | 864 | extern const struct v4l2_file_operations v4l2_subdev_fops; |
| 865 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 866 | /** |
| 867 | * v4l2_set_subdevdata - Sets V4L2 dev private device data |
| 868 | * |
| 869 | * @sd: pointer to &struct v4l2_subdev |
| 870 | * @p: pointer to the private device data to be stored. |
| 871 | */ |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 872 | static inline void v4l2_set_subdevdata(struct v4l2_subdev *sd, void *p) |
| 873 | { |
Laurent Pinchart | 692d5522 | 2010-07-30 17:24:55 -0300 | [diff] [blame] | 874 | sd->dev_priv = p; |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 875 | } |
| 876 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 877 | /** |
| 878 | * v4l2_get_subdevdata - Gets V4L2 dev private device data |
| 879 | * |
| 880 | * @sd: pointer to &struct v4l2_subdev |
| 881 | * |
| 882 | * Returns the pointer to the private device data to be stored. |
| 883 | */ |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 884 | static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd) |
| 885 | { |
Laurent Pinchart | 692d5522 | 2010-07-30 17:24:55 -0300 | [diff] [blame] | 886 | return sd->dev_priv; |
| 887 | } |
| 888 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 889 | /** |
| 890 | * v4l2_set_subdevdata - Sets V4L2 dev private host data |
| 891 | * |
| 892 | * @sd: pointer to &struct v4l2_subdev |
| 893 | * @p: pointer to the private data to be stored. |
| 894 | */ |
Laurent Pinchart | 692d5522 | 2010-07-30 17:24:55 -0300 | [diff] [blame] | 895 | static inline void v4l2_set_subdev_hostdata(struct v4l2_subdev *sd, void *p) |
| 896 | { |
| 897 | sd->host_priv = p; |
| 898 | } |
| 899 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 900 | /** |
| 901 | * v4l2_get_subdevdata - Gets V4L2 dev private data |
| 902 | * |
| 903 | * @sd: pointer to &struct v4l2_subdev |
| 904 | * |
| 905 | * Returns the pointer to the private host data to be stored. |
| 906 | */ |
Laurent Pinchart | 692d5522 | 2010-07-30 17:24:55 -0300 | [diff] [blame] | 907 | static inline void *v4l2_get_subdev_hostdata(const struct v4l2_subdev *sd) |
| 908 | { |
| 909 | return sd->host_priv; |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 910 | } |
| 911 | |
Sakari Ailus | 8227c92 | 2011-10-10 17:01:25 -0300 | [diff] [blame] | 912 | #ifdef CONFIG_MEDIA_CONTROLLER |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 913 | |
| 914 | /** |
| 915 | * v4l2_subdev_link_validate_default - validates a media link |
| 916 | * |
| 917 | * @sd: pointer to &struct v4l2_subdev |
| 918 | * @link: pointer to &struct media_link |
| 919 | * @source_fmt: pointer to &struct v4l2_subdev_format |
| 920 | * @sink_fmt: pointer to &struct v4l2_subdev_format |
| 921 | * |
| 922 | * This function ensures that width, height and the media bus pixel |
| 923 | * code are equal on both source and sink of the link. |
| 924 | */ |
Sakari Ailus | 8227c92 | 2011-10-10 17:01:25 -0300 | [diff] [blame] | 925 | int v4l2_subdev_link_validate_default(struct v4l2_subdev *sd, |
| 926 | struct media_link *link, |
| 927 | struct v4l2_subdev_format *source_fmt, |
| 928 | struct v4l2_subdev_format *sink_fmt); |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 929 | |
| 930 | /** |
| 931 | * v4l2_subdev_link_validate - validates a media link |
| 932 | * |
| 933 | * @link: pointer to &struct media_link |
| 934 | * |
| 935 | * This function calls the subdev's link_validate ops to validate |
| 936 | * if a media link is valid for streaming. It also internally |
| 937 | * calls v4l2_subdev_link_validate_default() to ensure that |
| 938 | * width, height and the media bus pixel code are equal on both |
| 939 | * source and sink of the link. |
| 940 | */ |
Sakari Ailus | 8227c92 | 2011-10-10 17:01:25 -0300 | [diff] [blame] | 941 | int v4l2_subdev_link_validate(struct media_link *link); |
Laurent Pinchart | 9b02cbb | 2015-04-24 20:06:31 -0300 | [diff] [blame] | 942 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 943 | /** |
| 944 | * v4l2_subdev_alloc_pad_config - Allocates memory for pad config |
| 945 | * |
| 946 | * @sd: pointer to struct v4l2_subdev |
| 947 | */ |
| 948 | struct |
| 949 | v4l2_subdev_pad_config *v4l2_subdev_alloc_pad_config(struct v4l2_subdev *sd); |
| 950 | |
| 951 | /** |
| 952 | * v4l2_subdev_free_pad_config - Frees memory allocated by |
| 953 | * v4l2_subdev_alloc_pad_config(). |
| 954 | * |
| 955 | * @cfg: pointer to &struct v4l2_subdev_pad_config |
| 956 | */ |
Laurent Pinchart | 9b02cbb | 2015-04-24 20:06:31 -0300 | [diff] [blame] | 957 | void v4l2_subdev_free_pad_config(struct v4l2_subdev_pad_config *cfg); |
Sakari Ailus | 8227c92 | 2011-10-10 17:01:25 -0300 | [diff] [blame] | 958 | #endif /* CONFIG_MEDIA_CONTROLLER */ |
Laurent Pinchart | 9b02cbb | 2015-04-24 20:06:31 -0300 | [diff] [blame] | 959 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 960 | /** |
| 961 | * v4l2_subdev_init - initializes the sub-device struct |
| 962 | * |
| 963 | * @sd: pointer to the &struct v4l2_subdev to be initialized |
| 964 | * @ops: pointer to &struct v4l2_subdev_ops. |
| 965 | */ |
Laurent Pinchart | 3dd5ee0 | 2009-12-09 08:38:52 -0300 | [diff] [blame] | 966 | void v4l2_subdev_init(struct v4l2_subdev *sd, |
| 967 | const struct v4l2_subdev_ops *ops); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 968 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 969 | /* |
| 970 | * Call an ops of a v4l2_subdev, doing the right checks against |
| 971 | * NULL pointers. |
| 972 | * |
| 973 | * Example: err = v4l2_subdev_call(sd, video, s_std, norm); |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 974 | */ |
| 975 | #define v4l2_subdev_call(sd, o, f, args...) \ |
Hans Verkuil | dbc8e34 | 2009-06-09 17:34:01 -0300 | [diff] [blame] | 976 | (!(sd) ? -ENODEV : (((sd)->ops->o && (sd)->ops->o->f) ? \ |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 977 | (sd)->ops->o->f((sd), ##args) : -ENOIOCTLCMD)) |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 978 | |
Hans Verkuil | 2180f92 | 2013-03-03 20:12:31 -0300 | [diff] [blame] | 979 | #define v4l2_subdev_has_op(sd, o, f) \ |
| 980 | ((sd)->ops->o && (sd)->ops->o->f) |
| 981 | |
Mauro Carvalho Chehab | 21c29de | 2016-07-20 14:20:26 -0300 | [diff] [blame] | 982 | /** |
| 983 | * v4l2_subdev_notify_event() - Delivers event notification for subdevice |
| 984 | * @sd: The subdev for which to deliver the event |
| 985 | * @ev: The event to deliver |
| 986 | * |
| 987 | * Will deliver the specified event to all userspace event listeners which are |
| 988 | * subscribed to the v42l subdev event queue as well as to the bridge driver |
| 989 | * using the notify callback. The notification type for the notify callback |
| 990 | * will be %V4L2_DEVICE_NOTIFY_EVENT. |
| 991 | */ |
Lars-Peter Clausen | 8ae5640 | 2015-06-24 13:50:29 -0300 | [diff] [blame] | 992 | void v4l2_subdev_notify_event(struct v4l2_subdev *sd, |
| 993 | const struct v4l2_event *ev); |
| 994 | |
Hans Verkuil | 2a1fcdf | 2008-11-29 21:36:58 -0300 | [diff] [blame] | 995 | #endif |