drivers/usb/media/sn9c102_sensor.h

   1 /***************************************************************************
   2  * API for image sensors connected to the SN9C10x PC Camera Controllers    *
   3  *                                                                         *
   4  * Copyright (C) 2004-2005 by Luca Risolia <luca.risolia@studio.unibo.it>  *
   5  *                                                                         *
   6  * This program is free software; you can redistribute it and/or modify    *
   7  * it under the terms of the GNU General Public License as published by    *
   8  * the Free Software Foundation; either version 2 of the License, or       *
   9  * (at your option) any later version.                                     *
  10  *                                                                         *
  11  * This program is distributed in the hope that it will be useful,         *
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of          *
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           *
  14  * GNU General Public License for more details.                            *
  15  *                                                                         *
  16  * You should have received a copy of the GNU General Public License       *
  17  * along with this program; if not, write to the Free Software             *
  18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.               *
  19  ***************************************************************************/
  20
  21 #ifndef _SN9C102_SENSOR_H_
  22 #define _SN9C102_SENSOR_H_
  23
  24 #include <linux/usb.h>
  25 #include <linux/videodev.h>
  26 #include <linux/device.h>
  27 #include <linux/stddef.h>
  28 #include <linux/errno.h>
  29 #include <asm/types.h>
  30
  31 struct sn9c102_device;
  32 struct sn9c102_sensor;
  33
  34 /*****************************************************************************/
  35
  36 /*
  37    OVERVIEW.
  38    This is a small interface that allows you to add support for any CCD/CMOS
  39    image sensors connected to the SN9C10X bridges. The entire API is documented
  40    below. In the most general case, to support a sensor there are three steps
  41    you have to follow:
  42    1) define the main "sn9c102_sensor" structure by setting the basic fields;
  43    2) write a probing function to be called by the core module when the USB
  44       camera is recognized, then add both the USB ids and the name of that
  45       function to the two corresponding tables SENSOR_TABLE and ID_TABLE (see
  46       below);
  47    3) implement the methods that you want/need (and fill the rest of the main
  48       structure accordingly).
  49    "sn9c102_pas106b.c" is an example of all this stuff. Remember that you do
  50    NOT need to touch the source code of the core module for the things to work
  51    properly, unless you find bugs or flaws in it. Finally, do not forget to
  52    read the V4L2 API for completeness.
  53 */
  54
  55 /*****************************************************************************/
  56
  57 /*
  58    Probing functions: on success, you must attach the sensor to the camera
  59    by calling sn9c102_attach_sensor() provided below.
  60    To enable the I2C communication, you might need to perform a really basic
  61    initialization of the SN9C10X chip by using the write function declared
  62    ahead.
  63    Functions must return 0 on success, the appropriate error otherwise.
  64 */
  65 extern int sn9c102_probe_hv7131d(struct sn9c102_device* cam);
  66 extern int sn9c102_probe_mi0343(struct sn9c102_device* cam);
  67 extern int sn9c102_probe_pas106b(struct sn9c102_device* cam);
  68 extern int sn9c102_probe_pas202bcb(struct sn9c102_device* cam);
  69 extern int sn9c102_probe_tas5110c1b(struct sn9c102_device* cam);
  70 extern int sn9c102_probe_tas5130d1b(struct sn9c102_device* cam);
  71
  72 /*
  73    Add the above entries to this table. Be sure to add the entry in the right
  74    place, since, on failure, the next probing routine is called according to
  75    the order of the list below, from top to bottom.
  76 */
  77 #define SN9C102_SENSOR_TABLE                                                  \
  78 static int (*sn9c102_sensor_table[])(struct sn9c102_device*) = {              \
  79         &sn9c102_probe_mi0343, /* strong detection based on SENSOR ids */     \
  80         &sn9c102_probe_pas106b, /* strong detection based on SENSOR ids */    \
  81         &sn9c102_probe_pas202bcb, /* strong detection based on SENSOR ids */  \
  82         &sn9c102_probe_hv7131d, /* strong detection based on SENSOR ids */    \
  83         &sn9c102_probe_tas5110c1b, /* detection based on USB pid/vid */       \
  84         &sn9c102_probe_tas5130d1b, /* detection based on USB pid/vid */       \
  85         NULL,                                                                 \
  86 };
  87
  88 /* Attach a probed sensor to the camera. */
  89 extern void
  90 sn9c102_attach_sensor(struct sn9c102_device* cam,
  91                       struct sn9c102_sensor* sensor);
  92
  93 /* Each SN9C10X camera has proper PID/VID identifiers. Add them here in case.*/
  94 #define SN9C102_ID_TABLE                                                      \
  95 static const struct usb_device_id sn9c102_id_table[] = {                      \
  96         { USB_DEVICE(0x0c45, 0x6001), }, /* TAS5110C1B */                     \
  97         { USB_DEVICE(0x0c45, 0x6005), }, /* TAS5110C1B */                     \
  98         { USB_DEVICE(0x0c45, 0x6009), }, /* PAS106B */                        \
  99         { USB_DEVICE(0x0c45, 0x600d), }, /* PAS106B */                        \
 100         { USB_DEVICE(0x0c45, 0x6024), },                                      \
 101         { USB_DEVICE(0x0c45, 0x6025), }, /* TAS5130D1B and TAS5110C1B */      \
 102         { USB_DEVICE(0x0c45, 0x6028), }, /* PAS202BCB */                      \
 103         { USB_DEVICE(0x0c45, 0x6029), }, /* PAS106B */                        \
 104         { USB_DEVICE(0x0c45, 0x602a), }, /* HV7131D */                        \
 105         { USB_DEVICE(0x0c45, 0x602b), }, /* MI-0343 */                        \
 106         { USB_DEVICE(0x0c45, 0x602c), }, /* OV7620 */                         \
 107         { USB_DEVICE(0x0c45, 0x6030), }, /* MI03x */                          \
 108         { USB_DEVICE(0x0c45, 0x6080), },                                      \
 109         { USB_DEVICE(0x0c45, 0x6082), }, /* MI0343 and MI0360 */              \
 110         { USB_DEVICE(0x0c45, 0x6083), }, /* HV7131[D|E1] */                   \
 111         { USB_DEVICE(0x0c45, 0x6088), },                                      \
 112         { USB_DEVICE(0x0c45, 0x608a), },                                      \
 113         { USB_DEVICE(0x0c45, 0x608b), },                                      \
 114         { USB_DEVICE(0x0c45, 0x608c), }, /* HV7131x */                        \
 115         { USB_DEVICE(0x0c45, 0x608e), }, /* CIS-VF10 */                       \
 116         { USB_DEVICE(0x0c45, 0x608f), }, /* OV7630 */                         \
 117         { USB_DEVICE(0x0c45, 0x60a0), },                                      \
 118         { USB_DEVICE(0x0c45, 0x60a2), },                                      \
 119         { USB_DEVICE(0x0c45, 0x60a3), },                                      \
 120         { USB_DEVICE(0x0c45, 0x60a8), }, /* PAS106B */                        \
 121         { USB_DEVICE(0x0c45, 0x60aa), }, /* TAS5130D1B */                     \
 122         { USB_DEVICE(0x0c45, 0x60ab), }, /* TAS5110C1B */                     \
 123         { USB_DEVICE(0x0c45, 0x60ac), },                                      \
 124         { USB_DEVICE(0x0c45, 0x60ae), },                                      \
 125         { USB_DEVICE(0x0c45, 0x60af), }, /* PAS202BCB */                      \
 126         { USB_DEVICE(0x0c45, 0x60b0), },                                      \
 127         { USB_DEVICE(0x0c45, 0x60b2), },                                      \
 128         { USB_DEVICE(0x0c45, 0x60b3), },                                      \
 129         { USB_DEVICE(0x0c45, 0x60b8), },                                      \
 130         { USB_DEVICE(0x0c45, 0x60ba), },                                      \
 131         { USB_DEVICE(0x0c45, 0x60bb), },                                      \
 132         { USB_DEVICE(0x0c45, 0x60bc), },                                      \
 133         { USB_DEVICE(0x0c45, 0x60be), },                                      \
 134         { }                                                                   \
 135 };
 136
 137 /*****************************************************************************/
 138
 139 /*
 140    Read/write routines: they always return -1 on error, 0 or the read value
 141    otherwise. NOTE that a real read operation is not supported by the SN9C10X
 142    chip for some of its registers. To work around this problem, a pseudo-read
 143    call is provided instead: it returns the last successfully written value
 144    on the register (0 if it has never been written), the usual -1 on error.
 145 */
 146
 147 /* The "try" I2C I/O versions are used when probing the sensor */
 148 extern int sn9c102_i2c_try_read(struct sn9c102_device*,struct sn9c102_sensor*,
 149                                 u8 address);
 150
 151 /*
 152    These must be used if and only if the sensor doesn't implement the standard
 153    I2C protocol. There are a number of good reasons why you must use the
 154    single-byte versions of these functions: do not abuse. The first function
 155    writes n bytes, from data0 to datan, to registers 0x09 - 0x09+n of SN9C10X
 156    chip. The second one programs the registers 0x09 and 0x10 with data0 and
 157    data1, and places the n bytes read from the sensor register table in the
 158    buffer pointed by 'buffer'. Both the functions return -1 on error; the write
 159    version returns 0 on success, while the read version returns the first read
 160    byte.
 161 */
 162 extern int sn9c102_i2c_try_raw_write(struct sn9c102_device* cam,
 163                                      struct sn9c102_sensor* sensor, u8 n,
 164                                      u8 data0, u8 data1, u8 data2, u8 data3,
 165                                      u8 data4, u8 data5);
 166 extern int sn9c102_i2c_try_raw_read(struct sn9c102_device* cam,
 167                                     struct sn9c102_sensor* sensor, u8 data0,
 168                                     u8 data1, u8 n, u8 buffer[]);
 169
 170 /* To be used after the sensor struct has been attached to the camera struct */
 171 extern int sn9c102_i2c_write(struct sn9c102_device*, u8 address, u8 value);
 172 extern int sn9c102_i2c_read(struct sn9c102_device*, u8 address);
 173
 174 /* I/O on registers in the bridge. Could be used by the sensor methods too */
 175 extern int sn9c102_write_reg(struct sn9c102_device*, u8 value, u16 index);
 176 extern int sn9c102_pread_reg(struct sn9c102_device*, u16 index);
 177
 178 /*
 179    NOTE: there are no exported debugging functions. To uniform the output you
 180    must use the dev_info()/dev_warn()/dev_err() macros defined in device.h,
 181    already included here, the argument being the struct device 'dev' of the
 182    sensor structure. Do NOT use these macros before the sensor is attached or
 183    the kernel will crash! However, you should not need to notify the user about
 184    common errors or other messages, since this is done by the master module.
 185 */
 186
 187 /*****************************************************************************/
 188
 189 enum sn9c102_i2c_sysfs_ops {
 190         SN9C102_I2C_READ = 0x01,
 191         SN9C102_I2C_WRITE = 0x02,
 192 };
 193
 194 enum sn9c102_i2c_frequency { /* sensors may support both the frequencies */
 195         SN9C102_I2C_100KHZ = 0x01,
 196         SN9C102_I2C_400KHZ = 0x02,
 197 };
 198
 199 enum sn9c102_i2c_interface {
 200         SN9C102_I2C_2WIRES,
 201         SN9C102_I2C_3WIRES,
 202 };
 203
 204 struct sn9c102_sensor {
 205         char name[32], /* sensor name */
 206              maintainer[64]; /* name of the mantainer <email> */
 207
 208         /* Supported operations through the 'sysfs' interface */
 209         enum sn9c102_i2c_sysfs_ops sysfs_ops;
 210
 211         /*
 212            These sensor capabilities must be provided if the SN9C10X controller
 213            needs to communicate through the sensor serial interface by using
 214            at least one of the i2c functions available.
 215         */
 216         enum sn9c102_i2c_frequency frequency;
 217         enum sn9c102_i2c_interface interface;
 218
 219         /*
 220            This identifier must be provided if the image sensor implements
 221            the standard I2C protocol.
 222         */
 223         u8 i2c_slave_id; /* reg. 0x09 */
 224
 225         /*
 226            NOTE: Where not noted,most of the functions below are not mandatory.
 227                  Set to null if you do not implement them. If implemented,
 228                  they must return 0 on success, the proper error otherwise.
 229         */
 230
 231         int (*init)(struct sn9c102_device* cam);
 232         /*
 233            This function will be called after the sensor has been attached.
 234            It should be used to initialize the sensor only, but may also
 235            configure part of the SN9C10X chip if necessary. You don't need to
 236            setup picture settings like brightness, contrast, etc.. here, if
 237            the corrisponding controls are implemented (see below), since
 238            they are adjusted in the core driver by calling the set_ctrl()
 239            method after init(), where the arguments are the default values
 240            specified in the v4l2_queryctrl list of supported controls;
 241            Same suggestions apply for other settings, _if_ the corresponding
 242            methods are present; if not, the initialization must configure the
 243            sensor according to the default configuration structures below.
 244         */
 245
 246         struct v4l2_queryctrl qctrl[V4L2_CID_LASTP1-V4L2_CID_BASE];
 247         /*
 248            Optional list of default controls, defined as indicated in the
 249            V4L2 API. Menu type controls are not handled by this interface.
 250         */
 251
 252         int (*get_ctrl)(struct sn9c102_device* cam, struct v4l2_control* ctrl);
 253         int (*set_ctrl)(struct sn9c102_device* cam,
 254                         const struct v4l2_control* ctrl);
 255         /*
 256            You must implement at least the set_ctrl method if you have defined
 257            the list above. The returned value must follow the V4L2
 258            specifications for the VIDIOC_G|C_CTRL ioctls. V4L2_CID_H|VCENTER
 259            are not supported by this driver, so do not implement them. Also,
 260            you don't have to check whether the passed values are out of bounds,
 261            given that this is done by the core module.
 262         */
 263
 264         struct v4l2_cropcap cropcap;
 265         /*
 266            Think the image sensor as a grid of R,G,B monochromatic pixels
 267            disposed according to a particular Bayer pattern, which describes
 268            the complete array of pixels, from (0,0) to (xmax, ymax). We will
 269            use this coordinate system from now on. It is assumed the sensor
 270            chip can be programmed to capture/transmit a subsection of that
 271            array of pixels: we will call this subsection "active window".
 272            It is not always true that the largest achievable active window can
 273            cover the whole array of pixels. The V4L2 API defines another
 274            area called "source rectangle", which, in turn, is a subrectangle of
 275            the active window. The SN9C10X chip is always programmed to read the
 276            source rectangle.
 277            The bounds of both the active window and the source rectangle are
 278            specified in the cropcap substructures 'bounds' and 'defrect'.
 279            By default, the source rectangle should cover the largest possible
 280            area. Again, it is not always true that the largest source rectangle
 281            can cover the entire active window, although it is a rare case for
 282            the hardware we have. The bounds of the source rectangle _must_ be
 283            multiple of 16 and must use the same coordinate system as indicated
 284            before; their centers shall align initially.
 285            If necessary, the sensor chip must be initialized during init() to
 286            set the bounds of the active sensor window; however, by default, it
 287            usually covers the largest achievable area (maxwidth x maxheight)
 288            of pixels, so no particular initialization is needed, if you have
 289            defined the correct default bounds in the structures.
 290            See the V4L2 API for further details.
 291            NOTE: once you have defined the bounds of the active window
 292                  (struct cropcap.bounds) you must not change them.anymore.
 293            Only 'bounds' and 'defrect' fields are mandatory, other fields
 294            will be ignored.
 295         */
 296
 297         int (*set_crop)(struct sn9c102_device* cam,
 298                         const struct v4l2_rect* rect);
 299         /*
 300            To be called on VIDIOC_C_SETCROP. The core module always calls a
 301            default routine which configures the appropriate SN9C10X regs (also
 302            scaling), but you may need to override/adjust specific stuff.
 303            'rect' contains width and height values that are multiple of 16: in
 304            case you override the default function, you always have to program
 305            the chip to match those values; on error return the corresponding
 306            error code without rolling back.
 307            NOTE: in case, you must program the SN9C10X chip to get rid of
 308                  blank pixels or blank lines at the _start_ of each line or
 309                  frame after each HSYNC or VSYNC, so that the image starts with
 310                  real RGB data (see regs 0x12, 0x13) (having set H_SIZE and,
 311                  V_SIZE you don't have to care about blank pixels or blank
 312                  lines at the end of each line or frame).
 313         */
 314
 315         struct v4l2_pix_format pix_format;
 316         /*
 317            What you have to define here are: 1) initial 'width' and 'height' of
 318            the target rectangle 2) the initial 'pixelformat', which can be
 319            either V4L2_PIX_FMT_SN9C10X (for compressed video) or
 320            V4L2_PIX_FMT_SBGGR8 3) 'priv', which we'll be used to indicate the
 321            number of bits per pixel for uncompressed video, 8 or 9 (despite the
 322            current value of 'pixelformat').
 323            NOTE 1: both 'width' and 'height' _must_ be either 1/1 or 1/2 or 1/4
 324                    of cropcap.defrect.width and cropcap.defrect.height. I
 325                    suggest 1/1.
 326            NOTE 2: The initial compression quality is defined by the first bit
 327                    of reg 0x17 during the initialization of the image sensor.
 328            NOTE 3: as said above, you have to program the SN9C10X chip to get
 329                    rid of any blank pixels, so that the output of the sensor
 330                    matches the RGB bayer sequence (i.e. BGBGBG...GRGRGR).
 331         */
 332
 333         int (*set_pix_format)(struct sn9c102_device* cam,
 334                               const struct v4l2_pix_format* pix);
 335         /*
 336            To be called on VIDIOC_S_FMT, when switching from the SBGGR8 to
 337            SN9C10X pixel format or viceversa. On error return the corresponding
 338            error code without rolling back.
 339         */
 340
 341         const struct device* dev;
 342         /*
 343            This is the argument for dev_err(), dev_info() and dev_warn(). It
 344            is used for debugging purposes. You must not access the struct
 345            before the sensor is attached.
 346         */
 347
 348         const struct usb_device* usbdev;
 349         /*
 350            Points to the usb_device struct after the sensor is attached.
 351            Do not touch unless you know what you are doing.
 352         */
 353
 354         /*
 355            Do NOT write to the data below, it's READ ONLY. It is used by the
 356            core module to store successfully updated values of the above
 357            settings, for rollbacks..etc..in case of errors during atomic I/O
 358         */
 359         struct v4l2_queryctrl _qctrl[V4L2_CID_LASTP1-V4L2_CID_BASE];
 360         struct v4l2_rect _rect;
 361 };
 362
 363 /*****************************************************************************/
 364
 365 /* Private ioctl's for control settings supported by some image sensors */
 366 #define SN9C102_V4L2_CID_DAC_MAGNITUDE V4L2_CID_PRIVATE_BASE
 367 #define SN9C102_V4L2_CID_GREEN_BALANCE V4L2_CID_PRIVATE_BASE + 1
 368 #define SN9C102_V4L2_CID_RESET_LEVEL V4L2_CID_PRIVATE_BASE + 2
 369 #define SN9C102_V4L2_CID_PIXEL_BIAS_VOLTAGE V4L2_CID_PRIVATE_BASE + 3
 370
 371 #endif /* _SN9C102_SENSOR_H_ */