V4L/DVB (10644): v4l2-subdev: rename dev field to v4l2_dev
[safe/jmp/linux-2.6] / include / media / soc_camera.h
index 69aba71..7440d92 100644 (file)
 #ifndef SOC_CAMERA_H
 #define SOC_CAMERA_H
 
+#include <linux/mutex.h>
+#include <linux/pm.h>
 #include <linux/videodev2.h>
-#include <media/videobuf-dma-sg.h>
+#include <media/videobuf-core.h>
 
 struct soc_camera_device {
        struct list_head list;
@@ -34,13 +36,20 @@ struct soc_camera_device {
        unsigned short exposure;
        unsigned char iface;            /* Host number */
        unsigned char devnum;           /* Device number per host */
-       unsigned char cached_datawidth; /* See comment in .c */
+       unsigned char buswidth;         /* See comment in .c */
+       struct soc_camera_sense *sense; /* See comment in struct definition */
        struct soc_camera_ops *ops;
        struct video_device *vdev;
        const struct soc_camera_data_format *current_fmt;
-       int (*probe)(struct soc_camera_device *icd);
-       void (*remove)(struct soc_camera_device *icd);
+       const struct soc_camera_data_format *formats;
+       int num_formats;
+       struct soc_camera_format_xlate *user_formats;
+       int num_user_formats;
        struct module *owner;
+       void *host_priv;                /* Per-device host private data */
+       /* soc_camera.c private count. Only accessed with .video_lock held */
+       int use_count;
+       struct mutex video_lock;        /* Protects device data */
 };
 
 struct soc_camera_file {
@@ -52,26 +61,45 @@ struct soc_camera_host {
        struct list_head list;
        struct device dev;
        unsigned char nr;                               /* Host number */
-       size_t msize;
-       struct videobuf_queue_ops *vbq_ops;
-       struct module *owner;
        void *priv;
-       char *drv_name;
+       const char *drv_name;
+       struct soc_camera_host_ops *ops;
+};
+
+struct soc_camera_host_ops {
+       struct module *owner;
        int (*add)(struct soc_camera_device *);
        void (*remove)(struct soc_camera_device *);
-       int (*set_capture_format)(struct soc_camera_device *, __u32,
-                                 struct v4l2_rect *);
-       int (*try_fmt_cap)(struct soc_camera_host *, struct v4l2_format *);
+       int (*suspend)(struct soc_camera_device *, pm_message_t);
+       int (*resume)(struct soc_camera_device *);
+       int (*get_formats)(struct soc_camera_device *, int,
+                          struct soc_camera_format_xlate *);
+       int (*set_fmt)(struct soc_camera_device *, __u32, struct v4l2_rect *);
+       int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
+       void (*init_videobuf)(struct videobuf_queue *,
+                             struct soc_camera_device *);
        int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
        int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
+       int (*set_bus_param)(struct soc_camera_device *, __u32);
        unsigned int (*poll)(struct file *, poll_table *);
 };
 
+#define SOCAM_SENSOR_INVERT_PCLK       (1 << 0)
+#define SOCAM_SENSOR_INVERT_MCLK       (1 << 1)
+#define SOCAM_SENSOR_INVERT_HSYNC      (1 << 2)
+#define SOCAM_SENSOR_INVERT_VSYNC      (1 << 3)
+#define SOCAM_SENSOR_INVERT_DATA       (1 << 4)
+
 struct soc_camera_link {
        /* Camera bus id, used to match a camera and a bus */
        int bus_id;
        /* GPIO number to switch between 8 and 10 bit modes */
        unsigned int gpio;
+       /* Per camera SOCAM_SENSOR_* bus flags */
+       unsigned long flags;
+       /* Optional callbacks to power on or off and reset the sensor */
+       int (*power)(struct device *, int);
+       int (*reset)(struct device *);
 };
 
 static inline struct soc_camera_device *to_soc_camera_dev(struct device *dev)
@@ -84,8 +112,7 @@ static inline struct soc_camera_host *to_soc_camera_host(struct device *dev)
        return container_of(dev, struct soc_camera_host, dev);
 }
 
-extern int soc_camera_host_register(struct soc_camera_host *ici,
-                                    struct module *owner);
+extern int soc_camera_host_register(struct soc_camera_host *ici);
 extern void soc_camera_host_unregister(struct soc_camera_host *ici);
 extern int soc_camera_device_register(struct soc_camera_device *icd);
 extern void soc_camera_device_unregister(struct soc_camera_device *icd);
@@ -93,35 +120,87 @@ extern void soc_camera_device_unregister(struct soc_camera_device *icd);
 extern int soc_camera_video_start(struct soc_camera_device *icd);
 extern void soc_camera_video_stop(struct soc_camera_device *icd);
 
+extern const struct soc_camera_data_format *soc_camera_format_by_fourcc(
+       struct soc_camera_device *icd, unsigned int fourcc);
+extern const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
+       struct soc_camera_device *icd, unsigned int fourcc);
+
 struct soc_camera_data_format {
-       char *name;
+       const char *name;
        unsigned int depth;
        __u32 fourcc;
        enum v4l2_colorspace colorspace;
 };
 
+/**
+ * struct soc_camera_format_xlate - match between host and sensor formats
+ * @cam_fmt: sensor format provided by the sensor
+ * @host_fmt: host format after host translation from cam_fmt
+ * @buswidth: bus width for this format
+ *
+ * Host and sensor translation structure. Used in table of host and sensor
+ * formats matchings in soc_camera_device. A host can override the generic list
+ * generation by implementing get_formats(), and use it for format checks and
+ * format setup.
+ */
+struct soc_camera_format_xlate {
+       const struct soc_camera_data_format *cam_fmt;
+       const struct soc_camera_data_format *host_fmt;
+       unsigned char buswidth;
+};
+
 struct soc_camera_ops {
        struct module *owner;
+       int (*probe)(struct soc_camera_device *);
+       void (*remove)(struct soc_camera_device *);
+       int (*suspend)(struct soc_camera_device *, pm_message_t state);
+       int (*resume)(struct soc_camera_device *);
        int (*init)(struct soc_camera_device *);
        int (*release)(struct soc_camera_device *);
        int (*start_capture)(struct soc_camera_device *);
        int (*stop_capture)(struct soc_camera_device *);
-       int (*set_capture_format)(struct soc_camera_device *, __u32,
-                                 struct v4l2_rect *, unsigned int);
-       int (*try_fmt_cap)(struct soc_camera_device *, struct v4l2_format *);
+       int (*set_fmt)(struct soc_camera_device *, __u32, struct v4l2_rect *);
+       int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
+       unsigned long (*query_bus_param)(struct soc_camera_device *);
+       int (*set_bus_param)(struct soc_camera_device *, unsigned long);
        int (*get_chip_id)(struct soc_camera_device *,
-                          struct v4l2_chip_ident *);
+                          struct v4l2_dbg_chip_ident *);
+       int (*set_std)(struct soc_camera_device *, v4l2_std_id *);
+       int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
 #ifdef CONFIG_VIDEO_ADV_DEBUG
-       int (*get_register)(struct soc_camera_device *, struct v4l2_register *);
-       int (*set_register)(struct soc_camera_device *, struct v4l2_register *);
+       int (*get_register)(struct soc_camera_device *, struct v4l2_dbg_register *);
+       int (*set_register)(struct soc_camera_device *, struct v4l2_dbg_register *);
 #endif
-       const struct soc_camera_data_format *formats;
-       int num_formats;
        int (*get_control)(struct soc_camera_device *, struct v4l2_control *);
        int (*set_control)(struct soc_camera_device *, struct v4l2_control *);
        const struct v4l2_queryctrl *controls;
        int num_controls;
-       unsigned int(*get_datawidth)(struct soc_camera_device *icd);
+};
+
+#define SOCAM_SENSE_PCLK_CHANGED       (1 << 0)
+
+/**
+ * This struct can be attached to struct soc_camera_device by the host driver
+ * to request sense from the camera, for example, when calling .set_fmt(). The
+ * host then can check which flags are set and verify respective values if any.
+ * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
+ * changed during this operation. After completion the host should detach sense.
+ *
+ * @flags              ored SOCAM_SENSE_* flags
+ * @master_clock       if the host wants to be informed about pixel-clock
+ *                     change, it better set master_clock.
+ * @pixel_clock_max    maximum pixel clock frequency supported by the host,
+ *                     camera is not allowed to exceed this.
+ * @pixel_clock                if the camera driver changed pixel clock during this
+ *                     operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
+ *                     master_clock to calculate the new pixel-clock and
+ *                     sets this field.
+ */
+struct soc_camera_sense {
+       unsigned long flags;
+       unsigned long master_clock;
+       unsigned long pixel_clock_max;
+       unsigned long pixel_clock;
 };
 
 static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
@@ -136,12 +215,42 @@ static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
        return NULL;
 }
 
-#define IS_MASTER              (1<<0)
-#define IS_HSYNC_ACTIVE_HIGH   (1<<1)
-#define IS_VSYNC_ACTIVE_HIGH   (1<<2)
-#define IS_DATAWIDTH_8         (1<<3)
-#define IS_DATAWIDTH_9         (1<<4)
-#define IS_DATAWIDTH_10                (1<<5)
-#define IS_PCLK_SAMPLE_RISING  (1<<6)
+#define SOCAM_MASTER                   (1 << 0)
+#define SOCAM_SLAVE                    (1 << 1)
+#define SOCAM_HSYNC_ACTIVE_HIGH                (1 << 2)
+#define SOCAM_HSYNC_ACTIVE_LOW         (1 << 3)
+#define SOCAM_VSYNC_ACTIVE_HIGH                (1 << 4)
+#define SOCAM_VSYNC_ACTIVE_LOW         (1 << 5)
+#define SOCAM_DATAWIDTH_4              (1 << 6)
+#define SOCAM_DATAWIDTH_8              (1 << 7)
+#define SOCAM_DATAWIDTH_9              (1 << 8)
+#define SOCAM_DATAWIDTH_10             (1 << 9)
+#define SOCAM_DATAWIDTH_15             (1 << 10)
+#define SOCAM_DATAWIDTH_16             (1 << 11)
+#define SOCAM_PCLK_SAMPLE_RISING       (1 << 12)
+#define SOCAM_PCLK_SAMPLE_FALLING      (1 << 13)
+#define SOCAM_DATA_ACTIVE_HIGH         (1 << 14)
+#define SOCAM_DATA_ACTIVE_LOW          (1 << 15)
+
+#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
+                             SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
+                             SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
+
+static inline unsigned long soc_camera_bus_param_compatible(
+                       unsigned long camera_flags, unsigned long bus_flags)
+{
+       unsigned long common_flags, hsync, vsync, pclk;
+
+       common_flags = camera_flags & bus_flags;
+
+       hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
+       vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
+       pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
+
+       return (!hsync || !vsync || !pclk) ? 0 : common_flags;
+}
+
+extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
+                                                  unsigned long flags);
 
 #endif