Hans Verkuil | b2f0648 | 2005-11-13 16:07:55 -0800 | [diff] [blame] | 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 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 29 | #include <media/v4l2-dev.h> |
| 30 | |
Hans Verkuil | 7e8b09e | 2006-01-09 15:32:40 -0200 | [diff] [blame] | 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 | |
Mauro Carvalho Chehab | cab462f | 2006-01-09 15:53:26 -0200 | [diff] [blame] | 37 | #define v4l_client_printk(level, client, fmt, arg...) \ |
Hans Verkuil | 7e8b09e | 2006-01-09 15:32:40 -0200 | [diff] [blame] | 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'. */ |
Mauro Carvalho Chehab | f167cb4e | 2006-01-11 19:41:49 -0200 | [diff] [blame] | 52 | #define v4l_dbg(level, debug, client, fmt, arg...) \ |
Hans Verkuil | 7e8b09e | 2006-01-09 15:32:40 -0200 | [diff] [blame] | 53 | do { \ |
| 54 | if (debug >= (level)) \ |
| 55 | v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \ |
| 56 | } while (0) |
| 57 | |
Hans Verkuil | 7e8b09e | 2006-01-09 15:32:40 -0200 | [diff] [blame] | 58 | /* ------------------------------------------------------------------------- */ |
| 59 | |
Hans Verkuil | dd99120 | 2008-11-23 12:19:45 -0300 | [diff] [blame] | 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 | |
Hans Verkuil | 9cb2318 | 2006-06-18 14:11:08 -0300 | [diff] [blame] | 83 | /* Control helper functions */ |
| 84 | |
| 85 | int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl, |
Hans Verkuil | 513521e | 2010-12-29 14:25:52 -0300 | [diff] [blame] | 86 | const char * const *menu_items); |
Hans Verkuil | 69028d7 | 2008-08-08 07:55:00 -0300 | [diff] [blame] | 87 | const char *v4l2_ctrl_get_name(u32 id); |
Hans Verkuil | 513521e | 2010-12-29 14:25:52 -0300 | [diff] [blame] | 88 | const char * const *v4l2_ctrl_get_menu(u32 id); |
Hans Verkuil | 9cb2318 | 2006-06-18 14:11:08 -0300 | [diff] [blame] | 89 | int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def); |
Hans Verkuil | 9cb2318 | 2006-06-18 14:11:08 -0300 | [diff] [blame] | 90 | int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu, |
Hans Verkuil | 513521e | 2010-12-29 14:25:52 -0300 | [diff] [blame] | 91 | struct v4l2_queryctrl *qctrl, const char * const *menu_items); |
Hans Verkuil | 1e55126 | 2008-08-08 08:34:19 -0300 | [diff] [blame] | 92 | #define V4L2_CTRL_MENU_IDS_END (0xffffffff) |
| 93 | int v4l2_ctrl_query_menu_valid_items(struct v4l2_querymenu *qmenu, const u32 *ids); |
Hans Verkuil | 2ba5889 | 2009-02-13 10:57:48 -0300 | [diff] [blame] | 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. */ |
Hans Verkuil | 9cb2318 | 2006-06-18 14:11:08 -0300 | [diff] [blame] | 99 | u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id); |
| 100 | |
| 101 | /* ------------------------------------------------------------------------- */ |
| 102 | |
Hans Verkuil | f3d092b | 2007-02-23 20:55:14 -0300 | [diff] [blame] | 103 | /* Register/chip ident helper function */ |
| 104 | |
| 105 | struct i2c_client; /* forward reference */ |
Hans Verkuil | aecde8b5 | 2008-12-30 07:14:19 -0300 | [diff] [blame] | 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, |
Hans Verkuil | 3434eb7 | 2007-04-27 12:31:08 -0300 | [diff] [blame] | 108 | u32 ident, u32 revision); |
Hans Verkuil | aecde8b5 | 2008-12-30 07:14:19 -0300 | [diff] [blame] | 109 | int v4l2_chip_match_host(const struct v4l2_dbg_match *match); |
Hans Verkuil | f3d092b | 2007-02-23 20:55:14 -0300 | [diff] [blame] | 110 | |
| 111 | /* ------------------------------------------------------------------------- */ |
| 112 | |
Hans Verkuil | 78a3b4d | 2009-04-01 03:41:09 -0300 | [diff] [blame] | 113 | /* I2C Helper functions */ |
Hans Verkuil | 8ffbc65 | 2007-09-12 08:32:50 -0300 | [diff] [blame] | 114 | |
| 115 | struct i2c_driver; |
| 116 | struct i2c_adapter; |
| 117 | struct i2c_client; |
Jean Delvare | d2653e9 | 2008-04-29 23:11:39 +0200 | [diff] [blame] | 118 | struct i2c_device_id; |
Hans Verkuil | dd99120 | 2008-11-23 12:19:45 -0300 | [diff] [blame] | 119 | struct v4l2_device; |
| 120 | struct v4l2_subdev; |
| 121 | struct v4l2_subdev_ops; |
Hans Verkuil | 8ffbc65 | 2007-09-12 08:32:50 -0300 | [diff] [blame] | 122 | |
Hans Verkuil | 8ffbc65 | 2007-09-12 08:32:50 -0300 | [diff] [blame] | 123 | |
Hans Verkuil | dd99120 | 2008-11-23 12:19:45 -0300 | [diff] [blame] | 124 | /* Load an i2c module and return an initialized v4l2_subdev struct. |
Hans Verkuil | dd99120 | 2008-11-23 12:19:45 -0300 | [diff] [blame] | 125 | The client_type argument is the name of the chip that's on the adapter. */ |
Hans Verkuil | 3c7c937 | 2011-01-08 07:08:02 -0300 | [diff] [blame] | 126 | struct v4l2_subdev *v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev, |
Laurent Pinchart | 9a1f8b3 | 2010-09-24 10:16:44 -0300 | [diff] [blame] | 127 | struct i2c_adapter *adapter, const char *client_type, |
Hans Verkuil | f0222c7 | 2009-06-09 17:12:33 -0300 | [diff] [blame] | 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, |
Laurent Pinchart | 9a1f8b3 | 2010-09-24 10:16:44 -0300 | [diff] [blame] | 133 | struct i2c_adapter *adapter, struct i2c_board_info *info, |
| 134 | const unsigned short *probe_addrs); |
Hans Verkuil | f0222c7 | 2009-06-09 17:12:33 -0300 | [diff] [blame] | 135 | |
Michael Jones | 9d380ad | 2012-07-26 10:48:25 -0300 | [diff] [blame] | 136 | /* Initialize a v4l2_subdev with data from an i2c_client struct */ |
Hans Verkuil | dd99120 | 2008-11-23 12:19:45 -0300 | [diff] [blame] | 137 | void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client, |
| 138 | const struct v4l2_subdev_ops *ops); |
Hans Verkuil | ab373190 | 2009-02-21 18:08:41 -0300 | [diff] [blame] | 139 | /* Return i2c client address of v4l2_subdev. */ |
| 140 | unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd); |
Hans Verkuil | dd99120 | 2008-11-23 12:19:45 -0300 | [diff] [blame] | 141 | |
Hans Verkuil | c7d29e2 | 2009-01-18 19:37:59 -0300 | [diff] [blame] | 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 | |
Hans Verkuil | 8ffbc65 | 2007-09-12 08:32:50 -0300 | [diff] [blame] | 155 | /* ------------------------------------------------------------------------- */ |
| 156 | |
Dmitri Belimov | 85e0921 | 2010-03-23 11:23:29 -0300 | [diff] [blame] | 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 | |
Michael Jones | 9d380ad | 2012-07-26 10:48:25 -0300 | [diff] [blame] | 169 | /* Initialize a v4l2_subdev with data from an spi_device struct */ |
Dmitri Belimov | 85e0921 | 2010-03-23 11:23:29 -0300 | [diff] [blame] | 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 | |
Hans Verkuil | 6c31e59 | 2009-04-02 11:37:41 -0300 | [diff] [blame] | 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. */ |
Hans Verkuil | 7e8b09e | 2006-01-09 15:32:40 -0200 | [diff] [blame] | 180 | |
Hans Verkuil | 78a3b4d | 2009-04-01 03:41:09 -0300 | [diff] [blame] | 181 | /* s_config */ |
Mauro Carvalho Chehab | 7f17112 | 2007-10-18 19:56:47 -0300 | [diff] [blame] | 182 | struct v4l2_priv_tun_config { |
| 183 | int tuner; |
| 184 | void *priv; |
| 185 | }; |
Mauro Carvalho Chehab | 7f17112 | 2007-10-18 19:56:47 -0300 | [diff] [blame] | 186 | #define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config) |
Hans Verkuil | 757d250 | 2006-01-23 17:11:10 -0200 | [diff] [blame] | 187 | |
Hans Verkuil | 6c31e59 | 2009-04-02 11:37:41 -0300 | [diff] [blame] | 188 | #define VIDIOC_INT_RESET _IOW ('d', 102, u32) |
| 189 | |
Hans Verkuil | 757d250 | 2006-01-23 17:11:10 -0200 | [diff] [blame] | 190 | struct v4l2_routing { |
| 191 | u32 input; |
| 192 | u32 output; |
| 193 | }; |
Hans Verkuil | 1b6f1d9 | 2009-02-13 07:48:21 -0300 | [diff] [blame] | 194 | |
Trent Piepho | b0d3159 | 2009-05-30 21:45:46 -0300 | [diff] [blame] | 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); |
Muralidharan Karicheri | 2e535ed | 2009-12-10 04:39:47 -0300 | [diff] [blame] | 204 | int v4l_fill_dv_preset_info(u32 preset, struct v4l2_dv_enum_preset *info); |
Hans Verkuil | 3fd8e64 | 2010-09-30 09:29:37 -0300 | [diff] [blame] | 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 | |
Hans Verkuil | c2a667f | 2012-08-10 06:09:26 -0300 | [diff] [blame] | 215 | bool v4l_match_dv_timings(const struct v4l2_dv_timings *t1, |
| 216 | const struct v4l2_dv_timings *t2, |
| 217 | unsigned pclock_delta); |
| 218 | |
Hans Verkuil | c61bd6a | 2012-08-10 06:11:12 -0300 | [diff] [blame] | 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 | |
Hans Verkuil | b2f0648 | 2005-11-13 16:07:55 -0800 | [diff] [blame] | 228 | #endif /* V4L2_COMMON_H_ */ |