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/device.h>
  16 #include <linux/mutex.h>
  17 #include <linux/pm.h>
  18 #include <linux/videodev2.h>
  19 #include <media/videobuf-core.h>
  20 #include <media/v4l2-device.h>
  21
  22 extern struct bus_type soc_camera_bus_type;
  23
  24 struct soc_camera_device {
  25         struct list_head list;
  26         struct device dev;
  27         struct device *pdev;            /* Platform device */
  28         s32 user_width;
  29         s32 user_height;
  30         enum v4l2_colorspace colorspace;
  31         unsigned char iface;            /* Host number */
  32         unsigned char devnum;           /* Device number per host */
  33         struct soc_camera_sense *sense; /* See comment in struct definition */
  34         struct soc_camera_ops *ops;
  35         struct video_device *vdev;
  36         const struct soc_camera_format_xlate *current_fmt;
  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 *, unsigned 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         int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
  88         int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
  89         unsigned int (*poll)(struct file *, poll_table *);
  90         const struct v4l2_queryctrl *controls;
  91         int num_controls;
  92 };
  93
  94 #define SOCAM_SENSOR_INVERT_PCLK        (1 << 0)
  95 #define SOCAM_SENSOR_INVERT_MCLK        (1 << 1)
  96 #define SOCAM_SENSOR_INVERT_HSYNC       (1 << 2)
  97 #define SOCAM_SENSOR_INVERT_VSYNC       (1 << 3)
  98 #define SOCAM_SENSOR_INVERT_DATA        (1 << 4)
  99
 100 struct i2c_board_info;
 101
 102 struct soc_camera_link {
 103         /* Camera bus id, used to match a camera and a bus */
 104         int bus_id;
 105         /* Per camera SOCAM_SENSOR_* bus flags */
 106         unsigned long flags;
 107         int i2c_adapter_id;
 108         struct i2c_board_info *board_info;
 109         const char *module_name;
 110         void *priv;
 111
 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(
 132         const struct device *dev)
 133 {
 134         return container_of(dev, struct soc_camera_device, dev);
 135 }
 136
 137 static inline struct soc_camera_host *to_soc_camera_host(
 138         const struct device *dev)
 139 {
 140         struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
 141
 142         return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
 143 }
 144
 145 static inline struct soc_camera_link *to_soc_camera_link(
 146         const struct soc_camera_device *icd)
 147 {
 148         return icd->dev.platform_data;
 149 }
 150
 151 static inline struct device *to_soc_camera_control(
 152         const struct soc_camera_device *icd)
 153 {
 154         return dev_get_drvdata(&icd->dev);
 155 }
 156
 157 static inline struct v4l2_subdev *soc_camera_to_subdev(
 158         const struct soc_camera_device *icd)
 159 {
 160         struct device *control = to_soc_camera_control(icd);
 161         return dev_get_drvdata(control);
 162 }
 163
 164 int soc_camera_host_register(struct soc_camera_host *ici);
 165 void soc_camera_host_unregister(struct soc_camera_host *ici);
 166
 167 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
 168         struct soc_camera_device *icd, unsigned int fourcc);
 169
 170 /**
 171  * struct soc_camera_format_xlate - match between host and sensor formats
 172  * @code: code of a sensor provided format
 173  * @host_fmt: host format after host translation from code
 174  *
 175  * Host and sensor translation structure. Used in table of host and sensor
 176  * formats matchings in soc_camera_device. A host can override the generic list
 177  * generation by implementing get_formats(), and use it for format checks and
 178  * format setup.
 179  */
 180 struct soc_camera_format_xlate {
 181         enum v4l2_mbus_pixelcode code;
 182         const struct soc_mbus_pixelfmt *host_fmt;
 183 };
 184
 185 struct soc_camera_ops {
 186         int (*suspend)(struct soc_camera_device *, pm_message_t state);
 187         int (*resume)(struct soc_camera_device *);
 188         unsigned long (*query_bus_param)(struct soc_camera_device *);
 189         int (*set_bus_param)(struct soc_camera_device *, unsigned long);
 190         int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
 191         const struct v4l2_queryctrl *controls;
 192         int num_controls;
 193 };
 194
 195 #define SOCAM_SENSE_PCLK_CHANGED        (1 << 0)
 196
 197 /**
 198  * This struct can be attached to struct soc_camera_device by the host driver
 199  * to request sense from the camera, for example, when calling .set_fmt(). The
 200  * host then can check which flags are set and verify respective values if any.
 201  * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
 202  * changed during this operation. After completion the host should detach sense.
 203  *
 204  * @flags               ored SOCAM_SENSE_* flags
 205  * @master_clock        if the host wants to be informed about pixel-clock
 206  *                      change, it better set master_clock.
 207  * @pixel_clock_max     maximum pixel clock frequency supported by the host,
 208  *                      camera is not allowed to exceed this.
 209  * @pixel_clock         if the camera driver changed pixel clock during this
 210  *                      operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
 211  *                      master_clock to calculate the new pixel-clock and
 212  *                      sets this field.
 213  */
 214 struct soc_camera_sense {
 215         unsigned long flags;
 216         unsigned long master_clock;
 217         unsigned long pixel_clock_max;
 218         unsigned long pixel_clock;
 219 };
 220
 221 static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
 222         struct soc_camera_ops *ops, int id)
 223 {
 224         int i;
 225
 226         for (i = 0; i < ops->num_controls; i++)
 227                 if (ops->controls[i].id == id)
 228                         return &ops->controls[i];
 229
 230         return NULL;
 231 }
 232
 233 #define SOCAM_MASTER                    (1 << 0)
 234 #define SOCAM_SLAVE                     (1 << 1)
 235 #define SOCAM_HSYNC_ACTIVE_HIGH         (1 << 2)
 236 #define SOCAM_HSYNC_ACTIVE_LOW          (1 << 3)
 237 #define SOCAM_VSYNC_ACTIVE_HIGH         (1 << 4)
 238 #define SOCAM_VSYNC_ACTIVE_LOW          (1 << 5)
 239 #define SOCAM_DATAWIDTH_4               (1 << 6)
 240 #define SOCAM_DATAWIDTH_8               (1 << 7)
 241 #define SOCAM_DATAWIDTH_9               (1 << 8)
 242 #define SOCAM_DATAWIDTH_10              (1 << 9)
 243 #define SOCAM_DATAWIDTH_15              (1 << 10)
 244 #define SOCAM_DATAWIDTH_16              (1 << 11)
 245 #define SOCAM_PCLK_SAMPLE_RISING        (1 << 12)
 246 #define SOCAM_PCLK_SAMPLE_FALLING       (1 << 13)
 247 #define SOCAM_DATA_ACTIVE_HIGH          (1 << 14)
 248 #define SOCAM_DATA_ACTIVE_LOW           (1 << 15)
 249
 250 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
 251                               SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
 252                               SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
 253
 254 static inline unsigned long soc_camera_bus_param_compatible(
 255                         unsigned long camera_flags, unsigned long bus_flags)
 256 {
 257         unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
 258
 259         common_flags = camera_flags & bus_flags;
 260
 261         hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
 262         vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
 263         pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
 264         data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
 265         mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
 266         buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
 267
 268         return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
 269                 common_flags;
 270 }
 271
 272 static inline void soc_camera_limit_side(int *start, int *length,
 273                 unsigned int start_min,
 274                 unsigned int length_min, unsigned int length_max)
 275 {
 276         if (*length < length_min)
 277                 *length = length_min;
 278         else if (*length > length_max)
 279                 *length = length_max;
 280
 281         if (*start < start_min)
 282                 *start = start_min;
 283         else if (*start > start_min + length_max - *length)
 284                 *start = start_min + length_max - *length;
 285 }
 286
 287 extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
 288                                                    unsigned long flags);
 289
 290 /* This is only temporary here - until v4l2-subdev begins to link to video_device */
 291 #include <linux/i2c.h>
 292 static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client)
 293 {
 294         struct soc_camera_device *icd = client->dev.platform_data;
 295         return icd->vdev;
 296 }
 297
 298 #endif