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/videodev2.h>
  16 #include <media/videobuf-core.h>
  17 #include <linux/pm.h>
  18
  19 struct soc_camera_device {
  20         struct list_head list;
  21         struct device dev;
  22         struct device *control;
  23         unsigned short width;           /* Current window */
  24         unsigned short height;          /* sizes */
  25         unsigned short x_min;           /* Camera capabilities */
  26         unsigned short y_min;
  27         unsigned short x_current;       /* Current window location */
  28         unsigned short y_current;
  29         unsigned short width_min;
  30         unsigned short width_max;
  31         unsigned short height_min;
  32         unsigned short height_max;
  33         unsigned short y_skip_top;      /* Lines to skip at the top */
  34         unsigned short gain;
  35         unsigned short exposure;
  36         unsigned char iface;            /* Host number */
  37         unsigned char devnum;           /* Device number per host */
  38         unsigned char buswidth;         /* See comment in .c */
  39         struct soc_camera_ops *ops;
  40         struct video_device *vdev;
  41         const struct soc_camera_data_format *current_fmt;
  42         const struct soc_camera_data_format *formats;
  43         int num_formats;
  44         struct soc_camera_format_xlate *user_formats;
  45         int num_user_formats;
  46         struct module *owner;
  47         void *host_priv;                /* per-device host private data */
  48         /* soc_camera.c private count. Only accessed with video_lock held */
  49         int use_count;
  50 };
  51
  52 struct soc_camera_file {
  53         struct soc_camera_device *icd;
  54         struct videobuf_queue vb_vidq;
  55 };
  56
  57 struct soc_camera_host {
  58         struct list_head list;
  59         struct device dev;
  60         unsigned char nr;                               /* Host number */
  61         void *priv;
  62         const char *drv_name;
  63         struct soc_camera_host_ops *ops;
  64 };
  65
  66 struct soc_camera_host_ops {
  67         struct module *owner;
  68         int (*add)(struct soc_camera_device *);
  69         void (*remove)(struct soc_camera_device *);
  70         int (*suspend)(struct soc_camera_device *, pm_message_t);
  71         int (*resume)(struct soc_camera_device *);
  72         int (*get_formats)(struct soc_camera_device *, int,
  73                            struct soc_camera_format_xlate *);
  74         int (*set_fmt)(struct soc_camera_device *, __u32, struct v4l2_rect *);
  75         int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
  76         void (*init_videobuf)(struct videobuf_queue *,
  77                               struct soc_camera_device *);
  78         int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
  79         int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
  80         int (*set_bus_param)(struct soc_camera_device *, __u32);
  81         unsigned int (*poll)(struct file *, poll_table *);
  82 };
  83
  84 #define SOCAM_SENSOR_INVERT_PCLK        (1 << 0)
  85 #define SOCAM_SENSOR_INVERT_MCLK        (1 << 1)
  86 #define SOCAM_SENSOR_INVERT_HSYNC       (1 << 2)
  87 #define SOCAM_SENSOR_INVERT_VSYNC       (1 << 3)
  88 #define SOCAM_SENSOR_INVERT_DATA        (1 << 4)
  89
  90 struct soc_camera_link {
  91         /* Camera bus id, used to match a camera and a bus */
  92         int bus_id;
  93         /* GPIO number to switch between 8 and 10 bit modes */
  94         unsigned int gpio;
  95         /* Per camera SOCAM_SENSOR_* bus flags */
  96         unsigned long flags;
  97         /* Optional callbacks to power on or off and reset the sensor */
  98         int (*power)(struct device *, int);
  99         int (*reset)(struct device *);
 100 };
 101
 102 static inline struct soc_camera_device *to_soc_camera_dev(struct device *dev)
 103 {
 104         return container_of(dev, struct soc_camera_device, dev);
 105 }
 106
 107 static inline struct soc_camera_host *to_soc_camera_host(struct device *dev)
 108 {
 109         return container_of(dev, struct soc_camera_host, dev);
 110 }
 111
 112 extern int soc_camera_host_register(struct soc_camera_host *ici);
 113 extern void soc_camera_host_unregister(struct soc_camera_host *ici);
 114 extern int soc_camera_device_register(struct soc_camera_device *icd);
 115 extern void soc_camera_device_unregister(struct soc_camera_device *icd);
 116
 117 extern int soc_camera_video_start(struct soc_camera_device *icd);
 118 extern void soc_camera_video_stop(struct soc_camera_device *icd);
 119
 120 extern const struct soc_camera_data_format *soc_camera_format_by_fourcc(
 121         struct soc_camera_device *icd, unsigned int fourcc);
 122 extern const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
 123         struct soc_camera_device *icd, unsigned int fourcc);
 124
 125 struct soc_camera_data_format {
 126         const char *name;
 127         unsigned int depth;
 128         __u32 fourcc;
 129         enum v4l2_colorspace colorspace;
 130 };
 131
 132 /**
 133  * struct soc_camera_format_xlate - match between host and sensor formats
 134  * @cam_fmt: sensor format provided by the sensor
 135  * @host_fmt: host format after host translation from cam_fmt
 136  * @buswidth: bus width for this format
 137  *
 138  * Host and sensor translation structure. Used in table of host and sensor
 139  * formats matchings in soc_camera_device. A host can override the generic list
 140  * generation by implementing get_formats(), and use it for format checks and
 141  * format setup.
 142  */
 143 struct soc_camera_format_xlate {
 144         const struct soc_camera_data_format *cam_fmt;
 145         const struct soc_camera_data_format *host_fmt;
 146         unsigned char buswidth;
 147 };
 148
 149 struct soc_camera_ops {
 150         struct module *owner;
 151         int (*probe)(struct soc_camera_device *);
 152         void (*remove)(struct soc_camera_device *);
 153         int (*suspend)(struct soc_camera_device *, pm_message_t state);
 154         int (*resume)(struct soc_camera_device *);
 155         int (*init)(struct soc_camera_device *);
 156         int (*release)(struct soc_camera_device *);
 157         int (*start_capture)(struct soc_camera_device *);
 158         int (*stop_capture)(struct soc_camera_device *);
 159         int (*set_fmt)(struct soc_camera_device *, __u32, struct v4l2_rect *);
 160         int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
 161         unsigned long (*query_bus_param)(struct soc_camera_device *);
 162         int (*set_bus_param)(struct soc_camera_device *, unsigned long);
 163         int (*get_chip_id)(struct soc_camera_device *,
 164                            struct v4l2_chip_ident *);
 165 #ifdef CONFIG_VIDEO_ADV_DEBUG
 166         int (*get_register)(struct soc_camera_device *, struct v4l2_register *);
 167         int (*set_register)(struct soc_camera_device *, struct v4l2_register *);
 168 #endif
 169         int (*get_control)(struct soc_camera_device *, struct v4l2_control *);
 170         int (*set_control)(struct soc_camera_device *, struct v4l2_control *);
 171         const struct v4l2_queryctrl *controls;
 172         int num_controls;
 173 };
 174
 175 static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
 176         struct soc_camera_ops *ops, int id)
 177 {
 178         int i;
 179
 180         for (i = 0; i < ops->num_controls; i++)
 181                 if (ops->controls[i].id == id)
 182                         return &ops->controls[i];
 183
 184         return NULL;
 185 }
 186
 187 #define SOCAM_MASTER                    (1 << 0)
 188 #define SOCAM_SLAVE                     (1 << 1)
 189 #define SOCAM_HSYNC_ACTIVE_HIGH         (1 << 2)
 190 #define SOCAM_HSYNC_ACTIVE_LOW          (1 << 3)
 191 #define SOCAM_VSYNC_ACTIVE_HIGH         (1 << 4)
 192 #define SOCAM_VSYNC_ACTIVE_LOW          (1 << 5)
 193 #define SOCAM_DATAWIDTH_8               (1 << 6)
 194 #define SOCAM_DATAWIDTH_9               (1 << 7)
 195 #define SOCAM_DATAWIDTH_10              (1 << 8)
 196 #define SOCAM_DATAWIDTH_16              (1 << 9)
 197 #define SOCAM_PCLK_SAMPLE_RISING        (1 << 10)
 198 #define SOCAM_PCLK_SAMPLE_FALLING       (1 << 11)
 199
 200 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_8 | SOCAM_DATAWIDTH_9 | \
 201                               SOCAM_DATAWIDTH_10 | SOCAM_DATAWIDTH_16)
 202
 203 static inline unsigned long soc_camera_bus_param_compatible(
 204                         unsigned long camera_flags, unsigned long bus_flags)
 205 {
 206         unsigned long common_flags, hsync, vsync, pclk;
 207
 208         common_flags = camera_flags & bus_flags;
 209
 210         hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
 211         vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
 212         pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
 213
 214         return (!hsync || !vsync || !pclk) ? 0 : common_flags;
 215 }
 216
 217 extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
 218                                                    unsigned long flags);
 219
 220 #endif