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     int (*enum_frameinervals)(struct soc_camera_device *, struct v4l2_frmivalenum *);
  67         /*
  68          * .get_formats() is called for each client device format, but
  69          * .put_formats() is only called once. Further, if any of the calls to
  70          * .get_formats() fail, .put_formats() will not be called at all, the
  71          * failing .get_formats() must then clean up internally.
  72          */
  73         int (*get_formats)(struct soc_camera_device *, unsigned int,
  74                            struct soc_camera_format_xlate *);
  75         void (*put_formats)(struct soc_camera_device *);
  76         int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
  77         int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
  78         int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
  79         int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
  80         int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
  81         void (*init_videobuf)(struct videobuf_queue *,
  82                               struct soc_camera_device *);
  83         int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
  84         int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
  85         int (*set_bus_param)(struct soc_camera_device *, __u32);
  86         int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
  87         int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
  88         int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
  89         int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
  90         unsigned int (*poll)(struct file *, poll_table *);
  91         const struct v4l2_queryctrl *controls;
  92         int num_controls;
  93
  94     int (*s_stream)(struct soc_camera_device *, int enable);    /* ddl@rock-chips.com : Add stream control for host */
  95
  96 };
  97
  98 #define SOCAM_SENSOR_INVERT_PCLK        (1 << 0)
  99 #define SOCAM_SENSOR_INVERT_MCLK        (1 << 1)
 100 #define SOCAM_SENSOR_INVERT_HSYNC       (1 << 2)
 101 #define SOCAM_SENSOR_INVERT_VSYNC       (1 << 3)
 102 #define SOCAM_SENSOR_INVERT_DATA        (1 << 4)
 103
 104 struct i2c_board_info;
 105
 106 struct soc_camera_link {
 107         /* Camera bus id, used to match a camera and a bus */
 108         int bus_id;
 109         /* Per camera SOCAM_SENSOR_* bus flags */
 110         unsigned long flags;
 111         int i2c_adapter_id;
 112         struct i2c_board_info *board_info;
 113         const char *module_name;
 114         void *priv;
 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         int (*powerdown)(struct device *, int);         /* ddl@rock-chisp.com : support sensor powerdown  */
 126         /*
 127          * some platforms may support different data widths than the sensors
 128          * native ones due to different data line routing. Let the board code
 129          * overwrite the width flags.
 130          */
 131         int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
 132         unsigned long (*query_bus_param)(struct soc_camera_link *);
 133         void (*free_bus)(struct soc_camera_link *);
 134 };
 135
 136 static inline struct soc_camera_device *to_soc_camera_dev(
 137         const struct device *dev)
 138 {
 139         return container_of(dev, struct soc_camera_device, dev);
 140 }
 141
 142 static inline struct soc_camera_host *to_soc_camera_host(
 143         const struct device *dev)
 144 {
 145         struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
 146
 147         return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
 148 }
 149
 150 static inline struct soc_camera_link *to_soc_camera_link(
 151         const struct soc_camera_device *icd)
 152 {
 153         return icd->dev.platform_data;
 154 }
 155
 156 static inline struct device *to_soc_camera_control(
 157         const struct soc_camera_device *icd)
 158 {
 159         return dev_get_drvdata(&icd->dev);
 160 }
 161
 162 static inline struct v4l2_subdev *soc_camera_to_subdev(
 163         const struct soc_camera_device *icd)
 164 {
 165         struct device *control = to_soc_camera_control(icd);
 166         return dev_get_drvdata(control);
 167 }
 168
 169 int soc_camera_host_register(struct soc_camera_host *ici);
 170 void soc_camera_host_unregister(struct soc_camera_host *ici);
 171
 172 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
 173         struct soc_camera_device *icd, unsigned int fourcc);
 174
 175 /**
 176  * struct soc_camera_format_xlate - match between host and sensor formats
 177  * @code: code of a sensor provided format
 178  * @host_fmt: host format after host translation from code
 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         enum v4l2_mbus_pixelcode code;
 187         const struct soc_mbus_pixelfmt *host_fmt;
 188 };
 189
 190 struct soc_camera_ops {
 191         int (*suspend)(struct soc_camera_device *, pm_message_t state);
 192         int (*resume)(struct soc_camera_device *);
 193         unsigned long (*query_bus_param)(struct soc_camera_device *);
 194         int (*set_bus_param)(struct soc_camera_device *, unsigned long);
 195         int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
 196
 197         const struct v4l2_queryctrl *controls;
 198         const struct v4l2_querymenu *menus;                /* ddl@rock-chips.com : Add ioctrl -VIDIOC_QUERYMENU */
 199         int num_controls;
 200         int num_menus;      /* ddl@rock-chips.com : Add ioctrl -VIDIOC_QUERYMENU */
 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
 258 #define SOCAM_MCLK_24MHZ   (1<<29)                                      /* ddl@rock-chips.com : add  */
 259 #define SOCAM_MCLK_27MHZ   (1<<30)
 260 #define SOCAM_MCLK_48MHZ   (1<<31)
 261
 262 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
 263                               SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
 264                               SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
 265
 266 static inline unsigned long soc_camera_bus_param_compatible(
 267                         unsigned long camera_flags, unsigned long bus_flags)
 268 {
 269         unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
 270
 271         common_flags = camera_flags & bus_flags;
 272
 273         hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
 274         vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
 275         pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
 276         data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
 277         mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
 278         buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
 279
 280         return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
 281                 common_flags;
 282 }
 283
 284 static inline void soc_camera_limit_side(int *start, int *length,
 285                 unsigned int start_min,
 286                 unsigned int length_min, unsigned int length_max)
 287 {
 288         if (*length < length_min)
 289                 *length = length_min;
 290         else if (*length > length_max)
 291                 *length = length_max;
 292
 293         if (*start < start_min)
 294                 *start = start_min;
 295         else if (*start > start_min + length_max - *length)
 296                 *start = start_min + length_max - *length;
 297 }
 298
 299 extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
 300                                                    unsigned long flags);
 301
 302 /* This is only temporary here - until v4l2-subdev begins to link to video_device */
 303 #include <linux/i2c.h>
 304 static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client)
 305 {
 306         struct soc_camera_device *icd = client->dev.platform_data;
 307         return icd->vdev;
 308 }
 309
 310 #endif