V4L/DVB (9789): soc-camera: add a per-camera device host private data pointer
[safe/jmp/linux-2.6] / 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 module *owner;
45         void *host_priv;                /* per-device host private data */
46         /* soc_camera.c private count. Only accessed with video_lock held */
47         int use_count;
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 list_head list;
57         struct device dev;
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 state);
69         int (*resume)(struct soc_camera_device *);
70         int (*set_fmt)(struct soc_camera_device *, __u32, struct v4l2_rect *);
71         int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
72         void (*init_videobuf)(struct videobuf_queue *,
73                               struct soc_camera_device *);
74         int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
75         int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
76         int (*set_bus_param)(struct soc_camera_device *, __u32);
77         unsigned int (*poll)(struct file *, poll_table *);
78 };
79
80 struct soc_camera_link {
81         /* Camera bus id, used to match a camera and a bus */
82         int bus_id;
83         /* GPIO number to switch between 8 and 10 bit modes */
84         unsigned int gpio;
85         /* Optional callbacks to power on or off and reset the sensor */
86         int (*power)(struct device *, int);
87         int (*reset)(struct device *);
88 };
89
90 static inline struct soc_camera_device *to_soc_camera_dev(struct device *dev)
91 {
92         return container_of(dev, struct soc_camera_device, dev);
93 }
94
95 static inline struct soc_camera_host *to_soc_camera_host(struct device *dev)
96 {
97         return container_of(dev, struct soc_camera_host, dev);
98 }
99
100 extern int soc_camera_host_register(struct soc_camera_host *ici);
101 extern void soc_camera_host_unregister(struct soc_camera_host *ici);
102 extern int soc_camera_device_register(struct soc_camera_device *icd);
103 extern void soc_camera_device_unregister(struct soc_camera_device *icd);
104
105 extern int soc_camera_video_start(struct soc_camera_device *icd);
106 extern void soc_camera_video_stop(struct soc_camera_device *icd);
107
108 extern const struct soc_camera_data_format *soc_camera_format_by_fourcc(
109         struct soc_camera_device *icd, unsigned int fourcc);
110
111 struct soc_camera_data_format {
112         const char *name;
113         unsigned int depth;
114         __u32 fourcc;
115         enum v4l2_colorspace colorspace;
116 };
117
118 struct soc_camera_ops {
119         struct module *owner;
120         int (*probe)(struct soc_camera_device *);
121         void (*remove)(struct soc_camera_device *);
122         int (*suspend)(struct soc_camera_device *, pm_message_t state);
123         int (*resume)(struct soc_camera_device *);
124         int (*init)(struct soc_camera_device *);
125         int (*release)(struct soc_camera_device *);
126         int (*start_capture)(struct soc_camera_device *);
127         int (*stop_capture)(struct soc_camera_device *);
128         int (*set_fmt)(struct soc_camera_device *, __u32, struct v4l2_rect *);
129         int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
130         unsigned long (*query_bus_param)(struct soc_camera_device *);
131         int (*set_bus_param)(struct soc_camera_device *, unsigned long);
132         int (*get_chip_id)(struct soc_camera_device *,
133                            struct v4l2_chip_ident *);
134 #ifdef CONFIG_VIDEO_ADV_DEBUG
135         int (*get_register)(struct soc_camera_device *, struct v4l2_register *);
136         int (*set_register)(struct soc_camera_device *, struct v4l2_register *);
137 #endif
138         int (*get_control)(struct soc_camera_device *, struct v4l2_control *);
139         int (*set_control)(struct soc_camera_device *, struct v4l2_control *);
140         const struct v4l2_queryctrl *controls;
141         int num_controls;
142 };
143
144 static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
145         struct soc_camera_ops *ops, int id)
146 {
147         int i;
148
149         for (i = 0; i < ops->num_controls; i++)
150                 if (ops->controls[i].id == id)
151                         return &ops->controls[i];
152
153         return NULL;
154 }
155
156 #define SOCAM_MASTER                    (1 << 0)
157 #define SOCAM_SLAVE                     (1 << 1)
158 #define SOCAM_HSYNC_ACTIVE_HIGH         (1 << 2)
159 #define SOCAM_HSYNC_ACTIVE_LOW          (1 << 3)
160 #define SOCAM_VSYNC_ACTIVE_HIGH         (1 << 4)
161 #define SOCAM_VSYNC_ACTIVE_LOW          (1 << 5)
162 #define SOCAM_DATAWIDTH_8               (1 << 6)
163 #define SOCAM_DATAWIDTH_9               (1 << 7)
164 #define SOCAM_DATAWIDTH_10              (1 << 8)
165 #define SOCAM_DATAWIDTH_16              (1 << 9)
166 #define SOCAM_PCLK_SAMPLE_RISING        (1 << 10)
167 #define SOCAM_PCLK_SAMPLE_FALLING       (1 << 11)
168
169 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_8 | SOCAM_DATAWIDTH_9 | \
170                               SOCAM_DATAWIDTH_10 | SOCAM_DATAWIDTH_16)
171
172 static inline unsigned long soc_camera_bus_param_compatible(
173                         unsigned long camera_flags, unsigned long bus_flags)
174 {
175         unsigned long common_flags, hsync, vsync, pclk;
176
177         common_flags = camera_flags & bus_flags;
178
179         hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
180         vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
181         pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
182
183         return (!hsync || !vsync || !pclk) ? 0 : common_flags;
184 }
185
186 #endif