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 /* These printk constructs can be used with v4l2_device and v4l2_subdev */ 61 #define v4l2_printk(level, dev, fmt, arg...) \ 62 printk(level "%s: " fmt, (dev)->name , ## arg) 63 64 #define v4l2_err(dev, fmt, arg...) \ 65 v4l2_printk(KERN_ERR, dev, fmt , ## arg) 66 67 #define v4l2_warn(dev, fmt, arg...) \ 68 v4l2_printk(KERN_WARNING, dev, fmt , ## arg) 69 70 #define v4l2_info(dev, fmt, arg...) \ 71 v4l2_printk(KERN_INFO, dev, fmt , ## arg) 72 73 /* These three macros assume that the debug level is set with a module 74 parameter called 'debug'. */ 75 #define v4l2_dbg(level, debug, dev, fmt, arg...) \ 76 do { \ 77 if (debug >= (level)) \ 78 v4l2_printk(KERN_DEBUG, dev, fmt , ## arg); \ 79 } while (0) 80 81 /* ------------------------------------------------------------------------- */ 82 83 /* Control helper functions */ 84 85 int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl, 86 const char * const *menu_items); 87 const char *v4l2_ctrl_get_name(u32 id); 88 const char * const *v4l2_ctrl_get_menu(u32 id); 89 int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def); 90 int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu, 91 struct v4l2_queryctrl *qctrl, const char * const *menu_items); 92 #define V4L2_CTRL_MENU_IDS_END (0xffffffff) 93 int v4l2_ctrl_query_menu_valid_items(struct v4l2_querymenu *qmenu, const u32 *ids); 94 95 /* Note: ctrl_classes points to an array of u32 pointers. Each u32 array is a 96 0-terminated array of control IDs. Each array must be sorted low to high 97 and belong to the same control class. The array of u32 pointers must also 98 be sorted, from low class IDs to high class IDs. */ 99 u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id); 100 101 /* ------------------------------------------------------------------------- */ 102 103 /* Register/chip ident helper function */ 104 105 struct i2c_client; /* forward reference */ 106 int v4l2_chip_match_i2c_client(struct i2c_client *c, const struct v4l2_dbg_match *match); 107 int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_dbg_chip_ident *chip, 108 u32 ident, u32 revision); 109 int v4l2_chip_match_host(const struct v4l2_dbg_match *match); 110 111 /* ------------------------------------------------------------------------- */ 112 113 /* I2C Helper functions */ 114 115 struct i2c_driver; 116 struct i2c_adapter; 117 struct i2c_client; 118 struct i2c_device_id; 119 struct v4l2_device; 120 struct v4l2_subdev; 121 struct v4l2_subdev_ops; 122 123 124 /* Load an i2c module and return an initialized v4l2_subdev struct. 125 The client_type argument is the name of the chip that's on the adapter. */ 126 struct v4l2_subdev *v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev, 127 struct i2c_adapter *adapter, const char *client_type, 128 u8 addr, const unsigned short *probe_addrs); 129 130 struct i2c_board_info; 131 132 struct v4l2_subdev *v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev, 133 struct i2c_adapter *adapter, struct i2c_board_info *info, 134 const unsigned short *probe_addrs); 135 136 /* Initialize a v4l2_subdev with data from an i2c_client struct */ 137 void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client, 138 const struct v4l2_subdev_ops *ops); 139 /* Return i2c client address of v4l2_subdev. */ 140 unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd); 141 142 enum v4l2_i2c_tuner_type { 143 ADDRS_RADIO, /* Radio tuner addresses */ 144 ADDRS_DEMOD, /* Demod tuner addresses */ 145 ADDRS_TV, /* TV tuner addresses */ 146 /* TV tuner addresses if demod is present, this excludes 147 addresses used by the demodulator from the list of 148 candidates. */ 149 ADDRS_TV_WITH_DEMOD, 150 }; 151 /* Return a list of I2C tuner addresses to probe. Use only if the tuner 152 addresses are unknown. */ 153 const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type); 154 155 /* ------------------------------------------------------------------------- */ 156 157 /* SPI Helper functions */ 158 #if defined(CONFIG_SPI) 159 160 #include <linux/spi/spi.h> 161 162 struct spi_device; 163 164 /* Load an spi module and return an initialized v4l2_subdev struct. 165 The client_type argument is the name of the chip that's on the adapter. */ 166 struct v4l2_subdev *v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev, 167 struct spi_master *master, struct spi_board_info *info); 168 169 /* Initialize a v4l2_subdev with data from an spi_device struct */ 170 void v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi, 171 const struct v4l2_subdev_ops *ops); 172 #endif 173 174 /* ------------------------------------------------------------------------- */ 175 176 /* Note: these remaining ioctls/structs should be removed as well, but they are 177 still used in tuner-simple.c (TUNER_SET_CONFIG), cx18/ivtv (RESET) and 178 v4l2-int-device.h (v4l2_routing). To remove these ioctls some more cleanup 179 is needed in those modules. */ 180 181 /* s_config */ 182 struct v4l2_priv_tun_config { 183 int tuner; 184 void *priv; 185 }; 186 #define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config) 187 188 #define VIDIOC_INT_RESET _IOW ('d', 102, u32) 189 190 struct v4l2_routing { 191 u32 input; 192 u32 output; 193 }; 194 195 /* ------------------------------------------------------------------------- */ 196 197 /* Miscellaneous helper functions */ 198 199 void v4l_bound_align_image(unsigned int *w, unsigned int wmin, 200 unsigned int wmax, unsigned int walign, 201 unsigned int *h, unsigned int hmin, 202 unsigned int hmax, unsigned int halign, 203 unsigned int salign); 204 int v4l_fill_dv_preset_info(u32 preset, struct v4l2_dv_enum_preset *info); 205 206 struct v4l2_discrete_probe { 207 const struct v4l2_frmsize_discrete *sizes; 208 int num_sizes; 209 }; 210 211 const struct v4l2_frmsize_discrete *v4l2_find_nearest_format( 212 const struct v4l2_discrete_probe *probe, 213 s32 width, s32 height); 214 215 bool v4l_match_dv_timings(const struct v4l2_dv_timings *t1, 216 const struct v4l2_dv_timings *t2, 217 unsigned pclock_delta); 218 219 bool v4l2_detect_cvt(unsigned frame_height, unsigned hfreq, unsigned vsync, 220 u32 polarities, struct v4l2_dv_timings *fmt); 221 222 bool v4l2_detect_gtf(unsigned frame_height, unsigned hfreq, unsigned vsync, 223 u32 polarities, struct v4l2_fract aspect, 224 struct v4l2_dv_timings *fmt); 225 226 struct v4l2_fract v4l2_calc_aspect_ratio(u8 hor_landscape, u8 vert_portrait); 227 228 #endif /* V4L2_COMMON_H_ */ 229