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