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