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