LXR linux/include/media/soc

   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
  25struct file;
  26struct soc_camera_link;
  27
  28struct soc_camera_device {
  29        struct list_head list;          /* list of all registered devices */
  30        struct soc_camera_link *link;
  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 .video_lock held */
  50        int use_count;
  51        struct mutex video_lock;        /* Protects device data */
  52        struct file *streamer;          /* stream owner */
  53        union {
  54                struct videobuf_queue vb_vidq;
  55                struct vb2_queue vb2_vidq;
  56        };
  57};
  58
  59/* Host supports programmable stride */
  60#define SOCAM_HOST_CAP_STRIDE           (1 << 0)
  61
  62struct soc_camera_host {
  63        struct v4l2_device v4l2_dev;
  64        struct list_head list;
  65        struct mutex host_lock;         /* Protect during probing */
  66        unsigned char nr;               /* Host number */
  67        u32 capabilities;
  68        void *priv;
  69        const char *drv_name;
  70        struct soc_camera_host_ops *ops;
  71};
  72
  73struct 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
 117struct i2c_board_info;
 118struct regulator_bulk_data;
 119
 120struct soc_camera_link {
 121        /* Camera bus id, used to match a camera and a bus */
 122        int bus_id;
 123        /* Per camera SOCAM_SENSOR_* bus flags */
 124        unsigned long flags;
 125        int i2c_adapter_id;
 126        struct i2c_board_info *board_info;
 127        const char *module_name;
 128        void *priv;
 129
 130        /* Optional regulators that have to be managed on power on/off events */
 131        struct regulator_bulk_data *regulators;
 132        int num_regulators;
 133
 134        /*
 135         * For non-I2C devices platform has to provide methods to add a device
 136         * to the system and to remove it
 137         */
 138        int (*add_device)(struct soc_camera_device *);
 139        void (*del_device)(struct soc_camera_device *);
 140        /* Optional callbacks to power on or off and reset the sensor */
 141        int (*power)(struct device *, int);
 142        int (*reset)(struct device *);
 143        /*
 144         * some platforms may support different data widths than the sensors
 145         * native ones due to different data line routing. Let the board code
 146         * overwrite the width flags.
 147         */
 148        int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
 149        unsigned long (*query_bus_param)(struct soc_camera_link *);
 150        void (*free_bus)(struct soc_camera_link *);
 151};
 152
 153static inline struct soc_camera_host *to_soc_camera_host(
 154        const struct device *dev)
 155{
 156        struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
 157
 158        return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
 159}
 160
 161static inline struct soc_camera_link *to_soc_camera_link(
 162        const struct soc_camera_device *icd)
 163{
 164        return icd->link;
 165}
 166
 167static inline struct device *to_soc_camera_control(
 168        const struct soc_camera_device *icd)
 169{
 170        return icd->control;
 171}
 172
 173static inline struct v4l2_subdev *soc_camera_to_subdev(
 174        const struct soc_camera_device *icd)
 175{
 176        struct device *control = to_soc_camera_control(icd);
 177        return dev_get_drvdata(control);
 178}
 179
 180int soc_camera_host_register(struct soc_camera_host *ici);
 181void soc_camera_host_unregister(struct soc_camera_host *ici);
 182
 183const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
 184        struct soc_camera_device *icd, unsigned int fourcc);
 185
 186/**
 187 * struct soc_camera_format_xlate - match between host and sensor formats
 188 * @code: code of a sensor provided format
 189 * @host_fmt: host format after host translation from code
 190 *
 191 * Host and sensor translation structure. Used in table of host and sensor
 192 * formats matchings in soc_camera_device. A host can override the generic list
 193 * generation by implementing get_formats(), and use it for format checks and
 194 * format setup.
 195 */
 196struct soc_camera_format_xlate {
 197        enum v4l2_mbus_pixelcode code;
 198        const struct soc_mbus_pixelfmt *host_fmt;
 199};
 200
 201#define SOCAM_SENSE_PCLK_CHANGED        (1 << 0)
 202
 203/**
 204 * This struct can be attached to struct soc_camera_device by the host driver
 205 * to request sense from the camera, for example, when calling .set_fmt(). The
 206 * host then can check which flags are set and verify respective values if any.
 207 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
 208 * changed during this operation. After completion the host should detach sense.
 209 *
 210 * @flags               ored SOCAM_SENSE_* flags
 211 * @master_clock        if the host wants to be informed about pixel-clock
 212 *                      change, it better set master_clock.
 213 * @pixel_clock_max     maximum pixel clock frequency supported by the host,
 214 *                      camera is not allowed to exceed this.
 215 * @pixel_clock         if the camera driver changed pixel clock during this
 216 *                      operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
 217 *                      master_clock to calculate the new pixel-clock and
 218 *                      sets this field.
 219 */
 220struct soc_camera_sense {
 221        unsigned long flags;
 222        unsigned long master_clock;
 223        unsigned long pixel_clock_max;
 224        unsigned long pixel_clock;
 225};
 226
 227#define SOCAM_DATAWIDTH(x)      BIT((x) - 1)
 228#define SOCAM_DATAWIDTH_4       SOCAM_DATAWIDTH(4)
 229#define SOCAM_DATAWIDTH_8       SOCAM_DATAWIDTH(8)
 230#define SOCAM_DATAWIDTH_9       SOCAM_DATAWIDTH(9)
 231#define SOCAM_DATAWIDTH_10      SOCAM_DATAWIDTH(10)
 232#define SOCAM_DATAWIDTH_15      SOCAM_DATAWIDTH(15)
 233#define SOCAM_DATAWIDTH_16      SOCAM_DATAWIDTH(16)
 234
 235#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
 236                              SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
 237                              SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
 238
 239static inline void soc_camera_limit_side(int *start, int *length,
 240                unsigned int start_min,
 241                unsigned int length_min, unsigned int length_max)
 242{
 243        if (*length < length_min)
 244                *length = length_min;
 245        else if (*length > length_max)
 246                *length = length_max;
 247
 248        if (*start < start_min)
 249                *start = start_min;
 250        else if (*start > start_min + length_max - *length)
 251                *start = start_min + length_max - *length;
 252}
 253
 254unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
 255                                            unsigned long flags);
 256unsigned long soc_camera_apply_board_flags(struct soc_camera_link *icl,
 257                                           const struct v4l2_mbus_config *cfg);
 258
 259int soc_camera_power_on(struct device *dev, struct soc_camera_link *icl);
 260int soc_camera_power_off(struct device *dev, struct soc_camera_link *icl);
 261
 262static inline int soc_camera_set_power(struct device *dev,
 263                                       struct soc_camera_link *icl, bool on)
 264{
 265        return on ? soc_camera_power_on(dev, icl)
 266                  : soc_camera_power_off(dev, icl);
 267}
 268
 269/* This is only temporary here - until v4l2-subdev begins to link to video_device */
 270#include <linux/i2c.h>
 271static inline struct video_device *soc_camera_i2c_to_vdev(const struct i2c_client *client)
 272{
 273        struct v4l2_subdev *sd = i2c_get_clientdata(client);
 274        struct soc_camera_device *icd = v4l2_get_subdev_hostdata(sd);
 275        return icd ? icd->vdev : NULL;
 276}
 277
 278static inline struct soc_camera_link *soc_camera_i2c_to_link(const struct i2c_client *client)
 279{
 280        return client->dev.platform_data;
 281}
 282
 283static inline struct v4l2_subdev *soc_camera_vdev_to_subdev(const struct video_device *vdev)
 284{
 285        struct soc_camera_device *icd = dev_get_drvdata(vdev->parent);
 286        return soc_camera_to_subdev(icd);
 287}
 288
 289static inline struct soc_camera_device *soc_camera_from_vb2q(const struct vb2_queue *vq)
 290{
 291        return container_of(vq, struct soc_camera_device, vb2_vidq);
 292}
 293
 294static inline struct soc_camera_device *soc_camera_from_vbq(const struct videobuf_queue *vq)
 295{
 296        return container_of(vq, struct soc_camera_device, vb_vidq);
 297}
 298
 299static inline u32 soc_camera_grp_id(const struct soc_camera_device *icd)
 300{
 301        return (icd->iface << 8) | (icd->devnum + 1);
 302}
 303
 304void soc_camera_lock(struct vb2_queue *vq);
 305void soc_camera_unlock(struct vb2_queue *vq);
 306
 307#endif
 308