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