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