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