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