7c44d4016561795cc82358ab0f6080bfd00d4b38
[linux-2.6.git] / 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         /*
71          * .get_formats() is called for each client device format, but
72          * .put_formats() is only called once. Further, if any of the calls to
73          * .get_formats() fail, .put_formats() will not be called at all, the
74          * failing .get_formats() must then clean up internally.
75          */
76         int (*get_formats)(struct soc_camera_device *, int,
77                            struct soc_camera_format_xlate *);
78         void (*put_formats)(struct soc_camera_device *);
79         int (*set_crop)(struct soc_camera_device *, struct v4l2_rect *);
80         int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
81         int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
82         void (*init_videobuf)(struct videobuf_queue *,
83                               struct soc_camera_device *);
84         int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
85         int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
86         int (*set_bus_param)(struct soc_camera_device *, __u32);
87         int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
88         int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
89         unsigned int (*poll)(struct file *, poll_table *);
90         const struct v4l2_queryctrl *controls;
91         int num_controls;
92 };
93
94 #define SOCAM_SENSOR_INVERT_PCLK        (1 << 0)
95 #define SOCAM_SENSOR_INVERT_MCLK        (1 << 1)
96 #define SOCAM_SENSOR_INVERT_HSYNC       (1 << 2)
97 #define SOCAM_SENSOR_INVERT_VSYNC       (1 << 3)
98 #define SOCAM_SENSOR_INVERT_DATA        (1 << 4)
99
100 struct i2c_board_info;
101
102 struct soc_camera_link {
103         /* Camera bus id, used to match a camera and a bus */
104         int bus_id;
105         /* Per camera SOCAM_SENSOR_* bus flags */
106         unsigned long flags;
107         int i2c_adapter_id;
108         struct i2c_board_info *board_info;
109         const char *module_name;
110         /*
111          * For non-I2C devices platform platform has to provide methods to
112          * add a device to the system and to remove
113          */
114         int (*add_device)(struct soc_camera_link *, struct device *);
115         void (*del_device)(struct soc_camera_link *);
116         /* Optional callbacks to power on or off and reset the sensor */
117         int (*power)(struct device *, int);
118         int (*reset)(struct device *);
119         /*
120          * some platforms may support different data widths than the sensors
121          * native ones due to different data line routing. Let the board code
122          * overwrite the width flags.
123          */
124         int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
125         unsigned long (*query_bus_param)(struct soc_camera_link *);
126         void (*free_bus)(struct soc_camera_link *);
127 };
128
129 static inline struct soc_camera_device *to_soc_camera_dev(struct device *dev)
130 {
131         return container_of(dev, struct soc_camera_device, dev);
132 }
133
134 static inline struct soc_camera_host *to_soc_camera_host(struct device *dev)
135 {
136         struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
137
138         return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
139 }
140
141 static inline struct soc_camera_link *to_soc_camera_link(struct soc_camera_device *icd)
142 {
143         return icd->dev.platform_data;
144 }
145
146 static inline struct device *to_soc_camera_control(struct soc_camera_device *icd)
147 {
148         return dev_get_drvdata(&icd->dev);
149 }
150
151 int soc_camera_host_register(struct soc_camera_host *ici);
152 void soc_camera_host_unregister(struct soc_camera_host *ici);
153
154 const struct soc_camera_data_format *soc_camera_format_by_fourcc(
155         struct soc_camera_device *icd, unsigned int fourcc);
156 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
157         struct soc_camera_device *icd, unsigned int fourcc);
158
159 struct soc_camera_data_format {
160         const char *name;
161         unsigned int depth;
162         __u32 fourcc;
163         enum v4l2_colorspace colorspace;
164 };
165
166 /**
167  * struct soc_camera_format_xlate - match between host and sensor formats
168  * @cam_fmt: sensor format provided by the sensor
169  * @host_fmt: host format after host translation from cam_fmt
170  * @buswidth: bus width for this format
171  *
172  * Host and sensor translation structure. Used in table of host and sensor
173  * formats matchings in soc_camera_device. A host can override the generic list
174  * generation by implementing get_formats(), and use it for format checks and
175  * format setup.
176  */
177 struct soc_camera_format_xlate {
178         const struct soc_camera_data_format *cam_fmt;
179         const struct soc_camera_data_format *host_fmt;
180         unsigned char buswidth;
181 };
182
183 struct soc_camera_ops {
184         int (*suspend)(struct soc_camera_device *, pm_message_t state);
185         int (*resume)(struct soc_camera_device *);
186         int (*init)(struct soc_camera_device *);
187         int (*release)(struct soc_camera_device *);
188         int (*set_crop)(struct soc_camera_device *, struct v4l2_rect *);
189         unsigned long (*query_bus_param)(struct soc_camera_device *);
190         int (*set_bus_param)(struct soc_camera_device *, unsigned long);
191         int (*get_chip_id)(struct soc_camera_device *,
192                            struct v4l2_dbg_chip_ident *);
193         int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
194         const struct v4l2_queryctrl *controls;
195         int num_controls;
196 };
197
198 #define SOCAM_SENSE_PCLK_CHANGED        (1 << 0)
199
200 /**
201  * This struct can be attached to struct soc_camera_device by the host driver
202  * to request sense from the camera, for example, when calling .set_fmt(). The
203  * host then can check which flags are set and verify respective values if any.
204  * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
205  * changed during this operation. After completion the host should detach sense.
206  *
207  * @flags               ored SOCAM_SENSE_* flags
208  * @master_clock        if the host wants to be informed about pixel-clock
209  *                      change, it better set master_clock.
210  * @pixel_clock_max     maximum pixel clock frequency supported by the host,
211  *                      camera is not allowed to exceed this.
212  * @pixel_clock         if the camera driver changed pixel clock during this
213  *                      operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
214  *                      master_clock to calculate the new pixel-clock and
215  *                      sets this field.
216  */
217 struct soc_camera_sense {
218         unsigned long flags;
219         unsigned long master_clock;
220         unsigned long pixel_clock_max;
221         unsigned long pixel_clock;
222 };
223
224 static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
225         struct soc_camera_ops *ops, int id)
226 {
227         int i;
228
229         for (i = 0; i < ops->num_controls; i++)
230                 if (ops->controls[i].id == id)
231                         return &ops->controls[i];
232
233         return NULL;
234 }
235
236 #define SOCAM_MASTER                    (1 << 0)
237 #define SOCAM_SLAVE                     (1 << 1)
238 #define SOCAM_HSYNC_ACTIVE_HIGH         (1 << 2)
239 #define SOCAM_HSYNC_ACTIVE_LOW          (1 << 3)
240 #define SOCAM_VSYNC_ACTIVE_HIGH         (1 << 4)
241 #define SOCAM_VSYNC_ACTIVE_LOW          (1 << 5)
242 #define SOCAM_DATAWIDTH_4               (1 << 6)
243 #define SOCAM_DATAWIDTH_8               (1 << 7)
244 #define SOCAM_DATAWIDTH_9               (1 << 8)
245 #define SOCAM_DATAWIDTH_10              (1 << 9)
246 #define SOCAM_DATAWIDTH_15              (1 << 10)
247 #define SOCAM_DATAWIDTH_16              (1 << 11)
248 #define SOCAM_PCLK_SAMPLE_RISING        (1 << 12)
249 #define SOCAM_PCLK_SAMPLE_FALLING       (1 << 13)
250 #define SOCAM_DATA_ACTIVE_HIGH          (1 << 14)
251 #define SOCAM_DATA_ACTIVE_LOW           (1 << 15)
252
253 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
254                               SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
255                               SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
256
257 static inline unsigned long soc_camera_bus_param_compatible(
258                         unsigned long camera_flags, unsigned long bus_flags)
259 {
260         unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
261
262         common_flags = camera_flags & bus_flags;
263
264         hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
265         vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
266         pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
267         data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
268         mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
269         buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
270
271         return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
272                 common_flags;
273 }
274
275 extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
276                                                    unsigned long flags);
277
278 #endif