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-ctrls.h>
  23 #include <media/v4l2-device.h>
  24
  25 struct file;
  26 struct soc_camera_desc;
  27
  28 struct soc_camera_device {
  29         struct list_head list;          /* list of all registered devices */
  30         struct soc_camera_desc *sdesc;
  31         struct device *pdev;            /* Platform device */
  32         struct device *parent;          /* Camera host device */
  33         struct device *control;         /* E.g., the i2c client */
  34         s32 user_width;
  35         s32 user_height;
  36         u32 bytesperline;               /* for padding, zero if unused */
  37         u32 sizeimage;
  38         enum v4l2_colorspace colorspace;
  39         unsigned char iface;            /* Host number */
  40         unsigned char devnum;           /* Device number per host */
  41         struct soc_camera_sense *sense; /* See comment in struct definition */
  42         struct video_device *vdev;
  43         struct v4l2_ctrl_handler ctrl_handler;
  44         const struct soc_camera_format_xlate *current_fmt;
  45         struct soc_camera_format_xlate *user_formats;
  46         int num_user_formats;
  47         enum v4l2_field field;          /* Preserve field over close() */
  48         void *host_priv;                /* Per-device host private data */
  49         /* soc_camera.c private count. Only accessed with .host_lock held */
  50         int use_count;
  51         struct file *streamer;          /* stream owner */
  52         union {
  53                 struct videobuf_queue vb_vidq;
  54                 struct vb2_queue vb2_vidq;
  55         };
  56 };
  57
  58 /* Host supports programmable stride */
  59 #define SOCAM_HOST_CAP_STRIDE           (1 << 0)
  60
  61 struct soc_camera_host {
  62         struct v4l2_device v4l2_dev;
  63         struct list_head list;
  64         struct mutex host_lock;         /* Protect pipeline modifications */
  65         unsigned char nr;               /* Host number */
  66         u32 capabilities;
  67         struct soc_camera_device *icd;  /* Currently attached client */
  68         void *priv;
  69         const char *drv_name;
  70         struct soc_camera_host_ops *ops;
  71 };
  72
  73 struct soc_camera_host_ops {
  74         struct module *owner;
  75         int (*add)(struct soc_camera_device *);
  76         void (*remove)(struct soc_camera_device *);
  77         /*
  78          * .get_formats() is called for each client device format, but
  79          * .put_formats() is only called once. Further, if any of the calls to
  80          * .get_formats() fail, .put_formats() will not be called at all, the
  81          * failing .get_formats() must then clean up internally.
  82          */
  83         int (*get_formats)(struct soc_camera_device *, unsigned int,
  84                            struct soc_camera_format_xlate *);
  85         void (*put_formats)(struct soc_camera_device *);
  86         int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
  87         int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
  88         int (*set_crop)(struct soc_camera_device *, const struct v4l2_crop *);
  89         int (*get_selection)(struct soc_camera_device *, struct v4l2_selection *);
  90         int (*set_selection)(struct soc_camera_device *, struct v4l2_selection *);
  91         /*
  92          * The difference to .set_crop() is, that .set_livecrop is not allowed
  93          * to change the output sizes
  94          */
  95         int (*set_livecrop)(struct soc_camera_device *, const struct v4l2_crop *);
  96         int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
  97         int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
  98         void (*init_videobuf)(struct videobuf_queue *,
  99                               struct soc_camera_device *);
 100         int (*init_videobuf2)(struct vb2_queue *,
 101                               struct soc_camera_device *);
 102         int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
 103         int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
 104         int (*set_bus_param)(struct soc_camera_device *);
 105         int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
 106         int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
 107         int (*enum_framesizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
 108         unsigned int (*poll)(struct file *, poll_table *);
 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
 117 struct i2c_board_info;
 118 struct regulator_bulk_data;
 119
 120 struct soc_camera_subdev_desc {
 121         /* Per camera SOCAM_SENSOR_* bus flags */
 122         unsigned long flags;
 123
 124         /* sensor driver private platform data */
 125         void *drv_priv;
 126
 127         /* Optional regulators that have to be managed on power on/off events */
 128         struct regulator_bulk_data *regulators;
 129         int num_regulators;
 130
 131         /* Optional callbacks to power on or off and reset the sensor */
 132         int (*power)(struct device *, int);
 133         int (*reset)(struct device *);
 134
 135         /*
 136          * some platforms may support different data widths than the sensors
 137          * native ones due to different data line routing. Let the board code
 138          * overwrite the width flags.
 139          */
 140         int (*set_bus_param)(struct soc_camera_subdev_desc *, unsigned long flags);
 141         unsigned long (*query_bus_param)(struct soc_camera_subdev_desc *);
 142         void (*free_bus)(struct soc_camera_subdev_desc *);
 143 };
 144
 145 struct soc_camera_host_desc {
 146         /* Camera bus id, used to match a camera and a bus */
 147         int bus_id;
 148         int i2c_adapter_id;
 149         struct i2c_board_info *board_info;
 150         const char *module_name;
 151
 152         /*
 153          * For non-I2C devices platform has to provide methods to add a device
 154          * to the system and to remove it
 155          */
 156         int (*add_device)(struct soc_camera_device *);
 157         void (*del_device)(struct soc_camera_device *);
 158 };
 159
 160 /*
 161  * This MUST be kept binary-identical to struct soc_camera_link below, until
 162  * it is completely replaced by this one, after which we can split it into its
 163  * two components.
 164  */
 165 struct soc_camera_desc {
 166         struct soc_camera_subdev_desc subdev_desc;
 167         struct soc_camera_host_desc host_desc;
 168 };
 169
 170 /* Prepare to replace this struct: don't change its layout any more! */
 171 struct soc_camera_link {
 172         /*
 173          * Subdevice part - keep at top and compatible to
 174          * struct soc_camera_subdev_desc
 175          */
 176
 177         /* Per camera SOCAM_SENSOR_* bus flags */
 178         unsigned long flags;
 179
 180         void *priv;
 181
 182         /* Optional regulators that have to be managed on power on/off events */
 183         struct regulator_bulk_data *regulators;
 184         int num_regulators;
 185
 186         /* Optional callbacks to power on or off and reset the sensor */
 187         int (*power)(struct device *, int);
 188         int (*reset)(struct device *);
 189         /*
 190          * some platforms may support different data widths than the sensors
 191          * native ones due to different data line routing. Let the board code
 192          * overwrite the width flags.
 193          */
 194         int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
 195         unsigned long (*query_bus_param)(struct soc_camera_link *);
 196         void (*free_bus)(struct soc_camera_link *);
 197
 198         /*
 199          * Host part - keep at bottom and compatible to
 200          * struct soc_camera_host_desc
 201          */
 202
 203         /* Camera bus id, used to match a camera and a bus */
 204         int bus_id;
 205         int i2c_adapter_id;
 206         struct i2c_board_info *board_info;
 207         const char *module_name;
 208
 209         /*
 210          * For non-I2C devices platform has to provide methods to add a device
 211          * to the system and to remove it
 212          */
 213         int (*add_device)(struct soc_camera_device *);
 214         void (*del_device)(struct soc_camera_device *);
 215 };
 216
 217 static inline struct soc_camera_host *to_soc_camera_host(
 218         const struct device *dev)
 219 {
 220         struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
 221
 222         return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
 223 }
 224
 225 static inline struct soc_camera_desc *to_soc_camera_desc(
 226         const struct soc_camera_device *icd)
 227 {
 228         return icd->sdesc;
 229 }
 230
 231 static inline struct device *to_soc_camera_control(
 232         const struct soc_camera_device *icd)
 233 {
 234         return icd->control;
 235 }
 236
 237 static inline struct v4l2_subdev *soc_camera_to_subdev(
 238         const struct soc_camera_device *icd)
 239 {
 240         struct device *control = to_soc_camera_control(icd);
 241         return dev_get_drvdata(control);
 242 }
 243
 244 int soc_camera_host_register(struct soc_camera_host *ici);
 245 void soc_camera_host_unregister(struct soc_camera_host *ici);
 246
 247 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
 248         struct soc_camera_device *icd, unsigned int fourcc);
 249
 250 /**
 251  * struct soc_camera_format_xlate - match between host and sensor formats
 252  * @code: code of a sensor provided format
 253  * @host_fmt: host format after host translation from code
 254  *
 255  * Host and sensor translation structure. Used in table of host and sensor
 256  * formats matchings in soc_camera_device. A host can override the generic list
 257  * generation by implementing get_formats(), and use it for format checks and
 258  * format setup.
 259  */
 260 struct soc_camera_format_xlate {
 261         enum v4l2_mbus_pixelcode code;
 262         const struct soc_mbus_pixelfmt *host_fmt;
 263 };
 264
 265 #define SOCAM_SENSE_PCLK_CHANGED        (1 << 0)
 266
 267 /**
 268  * This struct can be attached to struct soc_camera_device by the host driver
 269  * to request sense from the camera, for example, when calling .set_fmt(). The
 270  * host then can check which flags are set and verify respective values if any.
 271  * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
 272  * changed during this operation. After completion the host should detach sense.
 273  *
 274  * @flags               ored SOCAM_SENSE_* flags
 275  * @master_clock        if the host wants to be informed about pixel-clock
 276  *                      change, it better set master_clock.
 277  * @pixel_clock_max     maximum pixel clock frequency supported by the host,
 278  *                      camera is not allowed to exceed this.
 279  * @pixel_clock         if the camera driver changed pixel clock during this
 280  *                      operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
 281  *                      master_clock to calculate the new pixel-clock and
 282  *                      sets this field.
 283  */
 284 struct soc_camera_sense {
 285         unsigned long flags;
 286         unsigned long master_clock;
 287         unsigned long pixel_clock_max;
 288         unsigned long pixel_clock;
 289 };
 290
 291 #define SOCAM_DATAWIDTH(x)      BIT((x) - 1)
 292 #define SOCAM_DATAWIDTH_4       SOCAM_DATAWIDTH(4)
 293 #define SOCAM_DATAWIDTH_8       SOCAM_DATAWIDTH(8)
 294 #define SOCAM_DATAWIDTH_9       SOCAM_DATAWIDTH(9)
 295 #define SOCAM_DATAWIDTH_10      SOCAM_DATAWIDTH(10)
 296 #define SOCAM_DATAWIDTH_12      SOCAM_DATAWIDTH(12)
 297 #define SOCAM_DATAWIDTH_15      SOCAM_DATAWIDTH(15)
 298 #define SOCAM_DATAWIDTH_16      SOCAM_DATAWIDTH(16)
 299 #define SOCAM_DATAWIDTH_18      SOCAM_DATAWIDTH(18)
 300 #define SOCAM_DATAWIDTH_24      SOCAM_DATAWIDTH(24)
 301
 302 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
 303                               SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
 304                               SOCAM_DATAWIDTH_12 | SOCAM_DATAWIDTH_15 | \
 305                               SOCAM_DATAWIDTH_16 | SOCAM_DATAWIDTH_18 | \
 306                               SOCAM_DATAWIDTH_24)
 307
 308 static inline void soc_camera_limit_side(int *start, int *length,
 309                 unsigned int start_min,
 310                 unsigned int length_min, unsigned int length_max)
 311 {
 312         if (*length < length_min)
 313                 *length = length_min;
 314         else if (*length > length_max)
 315                 *length = length_max;
 316
 317         if (*start < start_min)
 318                 *start = start_min;
 319         else if (*start > start_min + length_max - *length)
 320                 *start = start_min + length_max - *length;
 321 }
 322
 323 unsigned long soc_camera_apply_board_flags(struct soc_camera_subdev_desc *ssdd,
 324                                            const struct v4l2_mbus_config *cfg);
 325
 326 int soc_camera_power_on(struct device *dev, struct soc_camera_subdev_desc *ssdd);
 327 int soc_camera_power_off(struct device *dev, struct soc_camera_subdev_desc *ssdd);
 328
 329 static inline int soc_camera_set_power(struct device *dev,
 330                                 struct soc_camera_subdev_desc *ssdd, bool on)
 331 {
 332         return on ? soc_camera_power_on(dev, ssdd)
 333                   : soc_camera_power_off(dev, ssdd);
 334 }
 335
 336 /* This is only temporary here - until v4l2-subdev begins to link to video_device */
 337 #include <linux/i2c.h>
 338 static inline struct video_device *soc_camera_i2c_to_vdev(const struct i2c_client *client)
 339 {
 340         struct v4l2_subdev *sd = i2c_get_clientdata(client);
 341         struct soc_camera_device *icd = v4l2_get_subdev_hostdata(sd);
 342         return icd ? icd->vdev : NULL;
 343 }
 344
 345 static inline struct soc_camera_subdev_desc *soc_camera_i2c_to_desc(const struct i2c_client *client)
 346 {
 347         return client->dev.platform_data;
 348 }
 349
 350 static inline struct v4l2_subdev *soc_camera_vdev_to_subdev(struct video_device *vdev)
 351 {
 352         struct soc_camera_device *icd = video_get_drvdata(vdev);
 353         return soc_camera_to_subdev(icd);
 354 }
 355
 356 static inline struct soc_camera_device *soc_camera_from_vb2q(const struct vb2_queue *vq)
 357 {
 358         return container_of(vq, struct soc_camera_device, vb2_vidq);
 359 }
 360
 361 static inline struct soc_camera_device *soc_camera_from_vbq(const struct videobuf_queue *vq)
 362 {
 363         return container_of(vq, struct soc_camera_device, vb_vidq);
 364 }
 365
 366 static inline u32 soc_camera_grp_id(const struct soc_camera_device *icd)
 367 {
 368         return (icd->iface << 8) | (icd->devnum + 1);
 369 }
 370
 371 void soc_camera_lock(struct vb2_queue *vq);
 372 void soc_camera_unlock(struct vb2_queue *vq);
 373
 374 #endif