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