SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/media/soc_camera.h

   1 /*
   2  * camera image capture (abstract) bus driver header
   3  *
   4  * Copyright (C) 2006, Sascha Hauer, Pengutronix
   5  * Copyright (C) 2008, Guennadi Liakhovetski <kernel@pengutronix.de>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11
  12 #ifndef SOC_CAMERA_H
  13 #define SOC_CAMERA_H
  14
  15 #include <linux/mutex.h>
  16 #include <linux/pm.h>
  17 #include <linux/videodev2.h>
  18 #include <media/videobuf-core.h>
  19 #include <media/v4l2-device.h>
  20
  21 struct soc_camera_device {
  22         struct list_head list;
  23         struct device dev;
  24         struct device *pdev;            /* Platform device */
  25         s32 user_width;
  26         s32 user_height;
  27         unsigned short y_skip_top;      /* Lines to skip at the top */
  28         unsigned char iface;            /* Host number */
  29         unsigned char devnum;           /* Device number per host */
  30         unsigned char buswidth;         /* See comment in .c */
  31         struct soc_camera_sense *sense; /* See comment in struct definition */
  32         struct soc_camera_ops *ops;
  33         struct video_device *vdev;
  34         const struct soc_camera_data_format *current_fmt;
  35         const struct soc_camera_data_format *formats;
  36         int num_formats;
  37         struct soc_camera_format_xlate *user_formats;
  38         int num_user_formats;
  39         enum v4l2_field field;          /* Preserve field over close() */
  40         void *host_priv;                /* Per-device host private data */
  41         /* soc_camera.c private count. Only accessed with .video_lock held */
  42         int use_count;
  43         struct mutex video_lock;        /* Protects device data */
  44 };
  45
  46 struct soc_camera_file {
  47         struct soc_camera_device *icd;
  48         struct videobuf_queue vb_vidq;
  49 };
  50
  51 struct soc_camera_host {
  52         struct v4l2_device v4l2_dev;
  53         struct list_head list;
  54         unsigned char nr;                               /* Host number */
  55         void *priv;
  56         const char *drv_name;
  57         struct soc_camera_host_ops *ops;
  58 };
  59
  60 struct soc_camera_host_ops {
  61         struct module *owner;
  62         int (*add)(struct soc_camera_device *);
  63         void (*remove)(struct soc_camera_device *);
  64         int (*suspend)(struct soc_camera_device *, pm_message_t);
  65         int (*resume)(struct soc_camera_device *);
  66         /*
  67          * .get_formats() is called for each client device format, but
  68          * .put_formats() is only called once. Further, if any of the calls to
  69          * .get_formats() fail, .put_formats() will not be called at all, the
  70          * failing .get_formats() must then clean up internally.
  71          */
  72         int (*get_formats)(struct soc_camera_device *, int,
  73                            struct soc_camera_format_xlate *);
  74         void (*put_formats)(struct soc_camera_device *);
  75         int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
  76         int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
  77         int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
  78         int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
  79         int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
  80         void (*init_videobuf)(struct videobuf_queue *,
  81                               struct soc_camera_device *);
  82         int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
  83         int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
  84         int (*set_bus_param)(struct soc_camera_device *, __u32);
  85         int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
  86         int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
  87         unsigned int (*poll)(struct file *, poll_table *);
  88         const struct v4l2_queryctrl *controls;
  89         int num_controls;
  90 };
  91
  92 #define SOCAM_SENSOR_INVERT_PCLK        (1 << 0)
  93 #define SOCAM_SENSOR_INVERT_MCLK        (1 << 1)
  94 #define SOCAM_SENSOR_INVERT_HSYNC       (1 << 2)
  95 #define SOCAM_SENSOR_INVERT_VSYNC       (1 << 3)
  96 #define SOCAM_SENSOR_INVERT_DATA        (1 << 4)
  97
  98 struct i2c_board_info;
  99
 100 struct soc_camera_link {
 101         /* Camera bus id, used to match a camera and a bus */
 102         int bus_id;
 103         /* Per camera SOCAM_SENSOR_* bus flags */
 104         unsigned long flags;
 105         int i2c_adapter_id;
 106         struct i2c_board_info *board_info;
 107         const char *module_name;
 108         /*
 109          * For non-I2C devices platform platform has to provide methods to
 110          * add a device to the system and to remove
 111          */
 112         int (*add_device)(struct soc_camera_link *, struct device *);
 113         void (*del_device)(struct soc_camera_link *);
 114         /* Optional callbacks to power on or off and reset the sensor */
 115         int (*power)(struct device *, int);
 116         int (*reset)(struct device *);
 117         /*
 118          * some platforms may support different data widths than the sensors
 119          * native ones due to different data line routing. Let the board code
 120          * overwrite the width flags.
 121          */
 122         int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
 123         unsigned long (*query_bus_param)(struct soc_camera_link *);
 124         void (*free_bus)(struct soc_camera_link *);
 125 };
 126
 127 static inline struct soc_camera_device *to_soc_camera_dev(
 128         const struct device *dev)
 129 {
 130         return container_of(dev, struct soc_camera_device, dev);
 131 }
 132
 133 static inline struct soc_camera_host *to_soc_camera_host(
 134         const struct device *dev)
 135 {
 136         struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
 137
 138         return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
 139 }
 140
 141 static inline struct soc_camera_link *to_soc_camera_link(
 142         const struct soc_camera_device *icd)
 143 {
 144         return icd->dev.platform_data;
 145 }
 146
 147 static inline struct device *to_soc_camera_control(
 148         const struct soc_camera_device *icd)
 149 {
 150         return dev_get_drvdata(&icd->dev);
 151 }
 152
 153 static inline struct v4l2_subdev *soc_camera_to_subdev(
 154         const struct soc_camera_device *icd)
 155 {
 156         struct device *control = to_soc_camera_control(icd);
 157         return dev_get_drvdata(control);
 158 }
 159
 160 int soc_camera_host_register(struct soc_camera_host *ici);
 161 void soc_camera_host_unregister(struct soc_camera_host *ici);
 162
 163 const struct soc_camera_data_format *soc_camera_format_by_fourcc(
 164         struct soc_camera_device *icd, unsigned int fourcc);
 165 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
 166         struct soc_camera_device *icd, unsigned int fourcc);
 167
 168 struct soc_camera_data_format {
 169         const char *name;
 170         unsigned int depth;
 171         __u32 fourcc;
 172         enum v4l2_colorspace colorspace;
 173 };
 174
 175 /**
 176  * struct soc_camera_format_xlate - match between host and sensor formats
 177  * @cam_fmt: sensor format provided by the sensor
 178  * @host_fmt: host format after host translation from cam_fmt
 179  * @buswidth: bus width for this format
 180  *
 181  * Host and sensor translation structure. Used in table of host and sensor
 182  * formats matchings in soc_camera_device. A host can override the generic list
 183  * generation by implementing get_formats(), and use it for format checks and
 184  * format setup.
 185  */
 186 struct soc_camera_format_xlate {
 187         const struct soc_camera_data_format *cam_fmt;
 188         const struct soc_camera_data_format *host_fmt;
 189         unsigned char buswidth;
 190 };
 191
 192 struct soc_camera_ops {
 193         int (*suspend)(struct soc_camera_device *, pm_message_t state);
 194         int (*resume)(struct soc_camera_device *);
 195         unsigned long (*query_bus_param)(struct soc_camera_device *);
 196         int (*set_bus_param)(struct soc_camera_device *, unsigned long);
 197         int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
 198         const struct v4l2_queryctrl *controls;
 199         int num_controls;
 200 };
 201
 202 #define SOCAM_SENSE_PCLK_CHANGED        (1 << 0)
 203
 204 /**
 205  * This struct can be attached to struct soc_camera_device by the host driver
 206  * to request sense from the camera, for example, when calling .set_fmt(). The
 207  * host then can check which flags are set and verify respective values if any.
 208  * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
 209  * changed during this operation. After completion the host should detach sense.
 210  *
 211  * @flags               ored SOCAM_SENSE_* flags
 212  * @master_clock        if the host wants to be informed about pixel-clock
 213  *                      change, it better set master_clock.
 214  * @pixel_clock_max     maximum pixel clock frequency supported by the host,
 215  *                      camera is not allowed to exceed this.
 216  * @pixel_clock         if the camera driver changed pixel clock during this
 217  *                      operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
 218  *                      master_clock to calculate the new pixel-clock and
 219  *                      sets this field.
 220  */
 221 struct soc_camera_sense {
 222         unsigned long flags;
 223         unsigned long master_clock;
 224         unsigned long pixel_clock_max;
 225         unsigned long pixel_clock;
 226 };
 227
 228 static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
 229         struct soc_camera_ops *ops, int id)
 230 {
 231         int i;
 232
 233         for (i = 0; i < ops->num_controls; i++)
 234                 if (ops->controls[i].id == id)
 235                         return &ops->controls[i];
 236
 237         return NULL;
 238 }
 239
 240 #define SOCAM_MASTER                    (1 << 0)
 241 #define SOCAM_SLAVE                     (1 << 1)
 242 #define SOCAM_HSYNC_ACTIVE_HIGH         (1 << 2)
 243 #define SOCAM_HSYNC_ACTIVE_LOW          (1 << 3)
 244 #define SOCAM_VSYNC_ACTIVE_HIGH         (1 << 4)
 245 #define SOCAM_VSYNC_ACTIVE_LOW          (1 << 5)
 246 #define SOCAM_DATAWIDTH_4               (1 << 6)
 247 #define SOCAM_DATAWIDTH_8               (1 << 7)
 248 #define SOCAM_DATAWIDTH_9               (1 << 8)
 249 #define SOCAM_DATAWIDTH_10              (1 << 9)
 250 #define SOCAM_DATAWIDTH_15              (1 << 10)
 251 #define SOCAM_DATAWIDTH_16              (1 << 11)
 252 #define SOCAM_PCLK_SAMPLE_RISING        (1 << 12)
 253 #define SOCAM_PCLK_SAMPLE_FALLING       (1 << 13)
 254 #define SOCAM_DATA_ACTIVE_HIGH          (1 << 14)
 255 #define SOCAM_DATA_ACTIVE_LOW           (1 << 15)
 256
 257 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
 258                               SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
 259                               SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
 260
 261 static inline unsigned long soc_camera_bus_param_compatible(
 262                         unsigned long camera_flags, unsigned long bus_flags)
 263 {
 264         unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
 265
 266         common_flags = camera_flags & bus_flags;
 267
 268         hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
 269         vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
 270         pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
 271         data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
 272         mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
 273         buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
 274
 275         return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
 276                 common_flags;
 277 }
 278
 279 static inline void soc_camera_limit_side(unsigned int *start,
 280                 unsigned int *length, unsigned int start_min,
 281                 unsigned int length_min, unsigned int length_max)
 282 {
 283         if (*length < length_min)
 284                 *length = length_min;
 285         else if (*length > length_max)
 286                 *length = length_max;
 287
 288         if (*start < start_min)
 289                 *start = start_min;
 290         else if (*start > start_min + length_max - *length)
 291                 *start = start_min + length_max - *length;
 292 }
 293
 294 extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
 295                                                    unsigned long flags);
 296
 297 #endif