1 /* 2 v4l2 common internal API header 3 4 This header contains internal shared ioctl definitions for use by the 5 internal low-level v4l2 drivers. 6 Each ioctl begins with VIDIOC_INT_ to clearly mark that it is an internal 7 define, 8 9 Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl> 10 11 This program is free software; you can redistribute it and/or modify 12 it under the terms of the GNU General Public License as published by 13 the Free Software Foundation; either version 2 of the License, or 14 (at your option) any later version. 15 16 This program is distributed in the hope that it will be useful, 17 but WITHOUT ANY WARRANTY; without even the implied warranty of 18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 GNU General Public License for more details. 20 21 You should have received a copy of the GNU General Public License 22 along with this program; if not, write to the Free Software 23 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 24 */ 25 26 #ifndef V4L2_COMMON_H_ 27 #define V4L2_COMMON_H_ 28 29 #include <media/v4l2-dev.h> 30 31 /* Common printk constucts for v4l-i2c drivers. These macros create a unique 32 prefix consisting of the driver name, the adapter number and the i2c 33 address. */ 34 #define v4l_printk(level, name, adapter, addr, fmt, arg...) \ 35 printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg) 36 37 #define v4l_client_printk(level, client, fmt, arg...) \ 38 v4l_printk(level, (client)->driver->driver.name, (client)->adapter, \ 39 (client)->addr, fmt , ## arg) 40 41 #define v4l_err(client, fmt, arg...) \ 42 v4l_client_printk(KERN_ERR, client, fmt , ## arg) 43 44 #define v4l_warn(client, fmt, arg...) \ 45 v4l_client_printk(KERN_WARNING, client, fmt , ## arg) 46 47 #define v4l_info(client, fmt, arg...) \ 48 v4l_client_printk(KERN_INFO, client, fmt , ## arg) 49 50 /* These three macros assume that the debug level is set with a module 51 parameter called 'debug'. */ 52 #define v4l_dbg(level, debug, client, fmt, arg...) \ 53 do { \ 54 if (debug >= (level)) \ 55 v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \ 56 } while (0) 57 58 /* ------------------------------------------------------------------------- */ 59 60 /* Priority helper functions */ 61 62 struct v4l2_prio_state { 63 atomic_t prios[4]; 64 }; 65 int v4l2_prio_init(struct v4l2_prio_state *global); 66 int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local, 67 enum v4l2_priority new); 68 int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local); 69 int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local); 70 enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global); 71 int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local); 72 73 /* ------------------------------------------------------------------------- */ 74 75 /* Control helper functions */ 76 77 int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl, 78 const char **menu_items); 79 const char *v4l2_ctrl_get_name(u32 id); 80 const char **v4l2_ctrl_get_menu(u32 id); 81 int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def); 82 int v4l2_ctrl_query_fill_std(struct v4l2_queryctrl *qctrl); 83 int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu, 84 struct v4l2_queryctrl *qctrl, const char **menu_items); 85 #define V4L2_CTRL_MENU_IDS_END (0xffffffff) 86 int v4l2_ctrl_query_menu_valid_items(struct v4l2_querymenu *qmenu, const u32 *ids); 87 u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id); 88 89 /* ------------------------------------------------------------------------- */ 90 91 /* Register/chip ident helper function */ 92 93 struct i2c_client; /* forward reference */ 94 int v4l2_chip_match_i2c_client(struct i2c_client *c, u32 id_type, u32 chip_id); 95 int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_chip_ident *chip, 96 u32 ident, u32 revision); 97 int v4l2_chip_match_host(u32 id_type, u32 chip_id); 98 99 /* ------------------------------------------------------------------------- */ 100 101 /* Helper function for I2C legacy drivers */ 102 103 struct i2c_driver; 104 struct i2c_adapter; 105 struct i2c_client; 106 struct i2c_device_id; 107 108 int v4l2_i2c_attach(struct i2c_adapter *adapter, int address, struct i2c_driver *driver, 109 const char *name, 110 int (*probe)(struct i2c_client *, const struct i2c_device_id *)); 111 112 /* ------------------------------------------------------------------------- */ 113 114 /* Internal ioctls */ 115 116 /* VIDIOC_INT_DECODE_VBI_LINE */ 117 struct v4l2_decode_vbi_line { 118 u32 is_second_field; /* Set to 0 for the first (odd) field, 119 set to 1 for the second (even) field. */ 120 u8 *p; /* Pointer to the sliced VBI data from the decoder. 121 On exit points to the start of the payload. */ 122 u32 line; /* Line number of the sliced VBI data (1-23) */ 123 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */ 124 }; 125 126 struct v4l2_priv_tun_config { 127 int tuner; 128 void *priv; 129 }; 130 131 /* audio ioctls */ 132 133 /* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */ 134 #define AUDC_SET_RADIO _IO('d',88) 135 136 /* tuner ioctls */ 137 138 /* Sets tuner type and its I2C addr */ 139 #define TUNER_SET_TYPE_ADDR _IOW('d', 90, int) 140 141 /* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced 142 by VIDIOC_INT_S_STANDBY. */ 143 #define TUNER_SET_STANDBY _IOW('d', 91, int) 144 145 /* Sets tda9887 specific stuff, like port1, port2 and qss */ 146 #define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config) 147 148 /* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */ 149 #define VIDIOC_INT_S_TUNER_MODE _IOW('d', 93, enum v4l2_tuner_type) 150 151 /* Generic standby command. Passing -1 (all bits set to 1) will put the whole 152 chip into standby mode, value 0 will make the chip fully active. Specific 153 bits can be used by certain chips to enable/disable specific subsystems. 154 Replacement of TUNER_SET_STANDBY. */ 155 #define VIDIOC_INT_S_STANDBY _IOW('d', 94, u32) 156 157 /* 100, 101 used by VIDIOC_DBG_[SG]_REGISTER */ 158 159 /* Generic reset command. The argument selects which subsystems to reset. 160 Passing 0 will always reset the whole chip. */ 161 #define VIDIOC_INT_RESET _IOW ('d', 102, u32) 162 163 /* Set the frequency (in Hz) of the audio clock output. 164 Used to slave an audio processor to the video decoder, ensuring that audio 165 and video remain synchronized. 166 Usual values for the frequency are 48000, 44100 or 32000 Hz. 167 If the frequency is not supported, then -EINVAL is returned. */ 168 #define VIDIOC_INT_AUDIO_CLOCK_FREQ _IOW ('d', 103, u32) 169 170 /* Video decoders that support sliced VBI need to implement this ioctl. 171 Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI 172 data that was generated by the decoder. The driver then parses the sliced 173 VBI data and sets the other fields in the struct accordingly. The pointer p 174 is updated to point to the start of the payload which can be copied 175 verbatim into the data field of the v4l2_sliced_vbi_data struct. If no 176 valid VBI data was found, then the type field is set to 0 on return. */ 177 #define VIDIOC_INT_DECODE_VBI_LINE _IOWR('d', 104, struct v4l2_decode_vbi_line) 178 179 /* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is 180 filled with the data packets that should be output. Note that if you set 181 the line field to 0, then that VBI signal is disabled. If no 182 valid VBI data was found, then the type field is set to 0 on return. */ 183 #define VIDIOC_INT_S_VBI_DATA _IOW ('d', 105, struct v4l2_sliced_vbi_data) 184 185 /* Used to obtain the sliced VBI packet from a readback register. Not all 186 video decoders support this. If no data is available because the readback 187 register contains invalid or erroneous data -EIO is returned. Note that 188 you must fill in the 'id' member and the 'field' member (to determine 189 whether CC data from the first or second field should be obtained). */ 190 #define VIDIOC_INT_G_VBI_DATA _IOWR('d', 106, struct v4l2_sliced_vbi_data) 191 192 /* Sets I2S speed in bps. This is used to provide a standard way to select I2S 193 clock used by driving digital audio streams at some board designs. 194 Usual values for the frequency are 1024000 and 2048000. 195 If the frequency is not supported, then -EINVAL is returned. */ 196 #define VIDIOC_INT_I2S_CLOCK_FREQ _IOW ('d', 108, u32) 197 198 /* Routing definition, device dependent. It specifies which inputs (if any) 199 should be routed to which outputs (if any). */ 200 struct v4l2_routing { 201 u32 input; 202 u32 output; 203 }; 204 205 /* These internal commands should be used to define the inputs and outputs 206 of an audio/video chip. They will replace the v4l2 API commands 207 VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT 208 that are meant to be used by the user. 209 The internal commands should be used to switch inputs/outputs 210 because only the driver knows how to map a 'Television' input to the precise 211 input/output routing of an A/D converter, or a DSP, or a video digitizer. 212 These four commands should only be sent directly to an i2c device, they 213 should not be broadcast as the routing is very device specific. */ 214 #define VIDIOC_INT_S_AUDIO_ROUTING _IOW ('d', 109, struct v4l2_routing) 215 #define VIDIOC_INT_G_AUDIO_ROUTING _IOR ('d', 110, struct v4l2_routing) 216 #define VIDIOC_INT_S_VIDEO_ROUTING _IOW ('d', 111, struct v4l2_routing) 217 #define VIDIOC_INT_G_VIDEO_ROUTING _IOR ('d', 112, struct v4l2_routing) 218 219 struct v4l2_crystal_freq { 220 u32 freq; /* frequency in Hz of the crystal */ 221 u32 flags; /* device specific flags */ 222 }; 223 224 /* Sets the frequency of the crystal used to generate the clocks. 225 An extra flags field allows device specific configuration regarding 226 clock frequency dividers, etc. If not used, then set flags to 0. 227 If the frequency is not supported, then -EINVAL is returned. */ 228 #define VIDIOC_INT_S_CRYSTAL_FREQ _IOW('d', 113, struct v4l2_crystal_freq) 229 230 /* Initialize the sensor registors to some sort of reasonable 231 default values. */ 232 #define VIDIOC_INT_INIT _IOW('d', 114, u32) 233 234 /* Set v4l2_std_id for video OUTPUT devices. This is ignored by 235 video input devices. */ 236 #define VIDIOC_INT_S_STD_OUTPUT _IOW('d', 115, v4l2_std_id) 237 238 /* Get v4l2_std_id for video OUTPUT devices. This is ignored by 239 video input devices. */ 240 #define VIDIOC_INT_G_STD_OUTPUT _IOW('d', 116, v4l2_std_id) 241 242 /* Set GPIO pins. Very simple right now, might need to be extended with 243 a v4l2_gpio struct if a direction is also needed. */ 244 #define VIDIOC_INT_S_GPIO _IOW('d', 117, u32) 245 246 #endif /* V4L2_COMMON_H_ */ 247