Revert "V4L: soc-camera: Add support for custom host mmap"
[omap4-v4l2-camera:rahulagarwal622s-omap4-v4l2-camera.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/device.h>
16 #include <linux/mutex.h>
17 #include <linux/pm.h>
18 #include <linux/videodev2.h>
19 #include <media/videobuf-core.h>
20 #include <media/videobuf2-core.h>
21 #include <media/v4l2-device.h>
22
23 extern struct bus_type soc_camera_bus_type;
24
25 struct file;
26
27 struct soc_camera_device {
28         struct list_head list;
29         struct device dev;
30         struct device *pdev;            /* Platform device */
31         s32 user_width;
32         s32 user_height;
33         u32 bytesperline;               /* for padding, zero if unused */
34         u32 sizeimage;
35         enum v4l2_colorspace colorspace;
36         unsigned char iface;            /* Host number */
37         unsigned char devnum;           /* Device number per host */
38         struct soc_camera_sense *sense; /* See comment in struct definition */
39         struct soc_camera_ops *ops;
40         struct video_device *vdev;
41         const struct soc_camera_format_xlate *current_fmt;
42         struct soc_camera_format_xlate *user_formats;
43         int num_user_formats;
44         enum v4l2_field field;          /* Preserve field over close() */
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         struct mutex video_lock;        /* Protects device data */
49         struct file *streamer;          /* stream owner */
50         union {
51                 struct videobuf_queue vb_vidq;
52                 struct vb2_queue vb2_vidq;
53         };
54 };
55
56 struct soc_camera_host {
57         struct v4l2_device v4l2_dev;
58         struct list_head list;
59         unsigned char nr;                               /* Host number */
60         void *priv;
61         const char *drv_name;
62         struct soc_camera_host_ops *ops;
63 };
64
65 struct soc_camera_host_ops {
66         struct module *owner;
67         int (*add)(struct soc_camera_device *);
68         void (*remove)(struct soc_camera_device *);
69         int (*suspend)(struct soc_camera_device *, pm_message_t);
70         int (*resume)(struct soc_camera_device *);
71         /*
72          * .get_formats() is called for each client device format, but
73          * .put_formats() is only called once. Further, if any of the calls to
74          * .get_formats() fail, .put_formats() will not be called at all, the
75          * failing .get_formats() must then clean up internally.
76          */
77         int (*get_formats)(struct soc_camera_device *, unsigned int,
78                            struct soc_camera_format_xlate *);
79         void (*put_formats)(struct soc_camera_device *);
80         int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
81         int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
82         int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
83         int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
84         int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
85         void (*init_videobuf)(struct videobuf_queue *,
86                               struct soc_camera_device *);
87         int (*init_videobuf2)(struct vb2_queue *,
88                               struct soc_camera_device *);
89         int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
90         int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
91         int (*set_bus_param)(struct soc_camera_device *, __u32);
92         int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
93         int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
94         int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
95         int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
96         int (*enum_fsizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
97         void (*streamon)(struct soc_camera_device *);
98         void (*streamoff)(struct soc_camera_device *);
99         unsigned int (*poll)(struct file *, poll_table *);
100         const struct v4l2_queryctrl *controls;
101         int num_controls;
102 };
103
104 #define SOCAM_SENSOR_INVERT_PCLK        (1 << 0)
105 #define SOCAM_SENSOR_INVERT_MCLK        (1 << 1)
106 #define SOCAM_SENSOR_INVERT_HSYNC       (1 << 2)
107 #define SOCAM_SENSOR_INVERT_VSYNC       (1 << 3)
108 #define SOCAM_SENSOR_INVERT_DATA        (1 << 4)
109
110 struct i2c_board_info;
111 struct regulator_bulk_data;
112
113 struct soc_camera_link {
114         /* Camera bus id, used to match a camera and a bus */
115         int bus_id;
116         /* Per camera SOCAM_SENSOR_* bus flags */
117         unsigned long flags;
118         int i2c_adapter_id;
119         struct i2c_board_info *board_info;
120         const char *module_name;
121         void *priv;
122
123         /* Optional regulators that have to be managed on power on/off events */
124         struct regulator_bulk_data *regulators;
125         int num_regulators;
126
127         /*
128          * For non-I2C devices platform platform has to provide methods to
129          * add a device to the system and to remove
130          */
131         int (*add_device)(struct soc_camera_link *, struct device *);
132         void (*del_device)(struct soc_camera_link *);
133         /* Optional callbacks to power on or off and reset the sensor */
134         int (*power)(struct device *, int);
135         int (*reset)(struct device *);
136         /*
137          * some platforms may support different data widths than the sensors
138          * native ones due to different data line routing. Let the board code
139          * overwrite the width flags.
140          */
141         int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
142         unsigned long (*query_bus_param)(struct soc_camera_link *);
143         void (*free_bus)(struct soc_camera_link *);
144 };
145
146 static inline struct soc_camera_device *to_soc_camera_dev(
147         const struct device *dev)
148 {
149         return container_of(dev, struct soc_camera_device, dev);
150 }
151
152 static inline struct soc_camera_host *to_soc_camera_host(
153         const struct device *dev)
154 {
155         struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
156
157         return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
158 }
159
160 static inline struct soc_camera_link *to_soc_camera_link(
161         const struct soc_camera_device *icd)
162 {
163         return icd->dev.platform_data;
164 }
165
166 static inline struct device *to_soc_camera_control(
167         const struct soc_camera_device *icd)
168 {
169         return dev_get_drvdata(&icd->dev);
170 }
171
172 static inline struct v4l2_subdev *soc_camera_to_subdev(
173         const struct soc_camera_device *icd)
174 {
175         struct device *control = to_soc_camera_control(icd);
176         return dev_get_drvdata(control);
177 }
178
179 int soc_camera_host_register(struct soc_camera_host *ici);
180 void soc_camera_host_unregister(struct soc_camera_host *ici);
181
182 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
183         struct soc_camera_device *icd, unsigned int fourcc);
184
185 /**
186  * struct soc_camera_format_xlate - match between host and sensor formats
187  * @code: code of a sensor provided format
188  * @host_fmt: host format after host translation from code
189  *
190  * Host and sensor translation structure. Used in table of host and sensor
191  * formats matchings in soc_camera_device. A host can override the generic list
192  * generation by implementing get_formats(), and use it for format checks and
193  * format setup.
194  */
195 struct soc_camera_format_xlate {
196         enum v4l2_mbus_pixelcode code;
197         const struct soc_mbus_pixelfmt *host_fmt;
198 };
199
200 struct soc_camera_ops {
201         int (*suspend)(struct soc_camera_device *, pm_message_t state);
202         int (*resume)(struct soc_camera_device *);
203         unsigned long (*query_bus_param)(struct soc_camera_device *);
204         int (*set_bus_param)(struct soc_camera_device *, unsigned long);
205         int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
206         const struct v4l2_queryctrl *controls;
207         int num_controls;
208 };
209
210 #define SOCAM_SENSE_PCLK_CHANGED        (1 << 0)
211
212 /**
213  * This struct can be attached to struct soc_camera_device by the host driver
214  * to request sense from the camera, for example, when calling .set_fmt(). The
215  * host then can check which flags are set and verify respective values if any.
216  * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
217  * changed during this operation. After completion the host should detach sense.
218  *
219  * @flags               ored SOCAM_SENSE_* flags
220  * @master_clock        if the host wants to be informed about pixel-clock
221  *                      change, it better set master_clock.
222  * @pixel_clock_max     maximum pixel clock frequency supported by the host,
223  *                      camera is not allowed to exceed this.
224  * @pixel_clock         if the camera driver changed pixel clock during this
225  *                      operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
226  *                      master_clock to calculate the new pixel-clock and
227  *                      sets this field.
228  */
229 struct soc_camera_sense {
230         unsigned long flags;
231         unsigned long master_clock;
232         unsigned long pixel_clock_max;
233         unsigned long pixel_clock;
234 };
235
236 static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
237         struct soc_camera_ops *ops, int id)
238 {
239         int i;
240
241         for (i = 0; i < ops->num_controls; i++)
242                 if (ops->controls[i].id == id)
243                         return &ops->controls[i];
244
245         return NULL;
246 }
247
248 #define SOCAM_MASTER                    (1 << 0)
249 #define SOCAM_SLAVE                     (1 << 1)
250 #define SOCAM_HSYNC_ACTIVE_HIGH         (1 << 2)
251 #define SOCAM_HSYNC_ACTIVE_LOW          (1 << 3)
252 #define SOCAM_VSYNC_ACTIVE_HIGH         (1 << 4)
253 #define SOCAM_VSYNC_ACTIVE_LOW          (1 << 5)
254 #define SOCAM_DATAWIDTH_4               (1 << 6)
255 #define SOCAM_DATAWIDTH_8               (1 << 7)
256 #define SOCAM_DATAWIDTH_9               (1 << 8)
257 #define SOCAM_DATAWIDTH_10              (1 << 9)
258 #define SOCAM_DATAWIDTH_15              (1 << 10)
259 #define SOCAM_DATAWIDTH_16              (1 << 11)
260 #define SOCAM_PCLK_SAMPLE_RISING        (1 << 12)
261 #define SOCAM_PCLK_SAMPLE_FALLING       (1 << 13)
262 #define SOCAM_DATA_ACTIVE_HIGH          (1 << 14)
263 #define SOCAM_DATA_ACTIVE_LOW           (1 << 15)
264
265 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
266                               SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
267                               SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
268
269 static inline unsigned long soc_camera_bus_param_compatible(
270                         unsigned long camera_flags, unsigned long bus_flags)
271 {
272         unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
273
274         common_flags = camera_flags & bus_flags;
275
276         hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
277         vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
278         pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
279         data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
280         mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
281         buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
282
283         return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
284                 common_flags;
285 }
286
287 static inline void soc_camera_limit_side(int *start, int *length,
288                 unsigned int start_min,
289                 unsigned int length_min, unsigned int length_max)
290 {
291         if (*length < length_min)
292                 *length = length_min;
293         else if (*length > length_max)
294                 *length = length_max;
295
296         if (*start < start_min)
297                 *start = start_min;
298         else if (*start > start_min + length_max - *length)
299                 *start = start_min + length_max - *length;
300 }
301
302 extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
303                                                    unsigned long flags);
304
305 /* This is only temporary here - until v4l2-subdev begins to link to video_device */
306 #include <linux/i2c.h>
307 static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client)
308 {
309         struct soc_camera_device *icd = client->dev.platform_data;
310         return icd->vdev;
311 }
312
313 static inline struct soc_camera_device *soc_camera_from_vb2q(struct vb2_queue *vq)
314 {
315         return container_of(vq, struct soc_camera_device, vb2_vidq);
316 }
317
318 static inline struct soc_camera_device *soc_camera_from_vbq(struct videobuf_queue *vq)
319 {
320         return container_of(vq, struct soc_camera_device, vb_vidq);
321 }
322
323 void soc_camera_lock(struct vb2_queue *vq);
324 void soc_camera_unlock(struct vb2_queue *vq);
325
326 #endif