[media] V4L: soc-camera: add a livecrop host operation
[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/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         /*
84          * The difference to .set_crop() is, that .set_livecrop is not allowed
85          * to change the output sizes
86          */
87         int (*set_livecrop)(struct soc_camera_device *, struct v4l2_crop *);
88         int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
89         int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
90         void (*init_videobuf)(struct videobuf_queue *,
91                               struct soc_camera_device *);
92         int (*init_videobuf2)(struct vb2_queue *,
93                               struct soc_camera_device *);
94         int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
95         int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
96         int (*set_bus_param)(struct soc_camera_device *, __u32);
97         int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
98         int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
99         int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
100         int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
101         int (*enum_fsizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
102         unsigned int (*poll)(struct file *, poll_table *);
103         const struct v4l2_queryctrl *controls;
104         int num_controls;
105 };
106
107 #define SOCAM_SENSOR_INVERT_PCLK        (1 << 0)
108 #define SOCAM_SENSOR_INVERT_MCLK        (1 << 1)
109 #define SOCAM_SENSOR_INVERT_HSYNC       (1 << 2)
110 #define SOCAM_SENSOR_INVERT_VSYNC       (1 << 3)
111 #define SOCAM_SENSOR_INVERT_DATA        (1 << 4)
112
113 struct i2c_board_info;
114 struct regulator_bulk_data;
115
116 struct soc_camera_link {
117         /* Camera bus id, used to match a camera and a bus */
118         int bus_id;
119         /* Per camera SOCAM_SENSOR_* bus flags */
120         unsigned long flags;
121         int i2c_adapter_id;
122         struct i2c_board_info *board_info;
123         const char *module_name;
124         void *priv;
125
126         /* Optional regulators that have to be managed on power on/off events */
127         struct regulator_bulk_data *regulators;
128         int num_regulators;
129
130         /*
131          * For non-I2C devices platform platform has to provide methods to
132          * add a device to the system and to remove
133          */
134         int (*add_device)(struct soc_camera_link *, struct device *);
135         void (*del_device)(struct soc_camera_link *);
136         /* Optional callbacks to power on or off and reset the sensor */
137         int (*power)(struct device *, int);
138         int (*reset)(struct device *);
139         /*
140          * some platforms may support different data widths than the sensors
141          * native ones due to different data line routing. Let the board code
142          * overwrite the width flags.
143          */
144         int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
145         unsigned long (*query_bus_param)(struct soc_camera_link *);
146         void (*free_bus)(struct soc_camera_link *);
147 };
148
149 static inline struct soc_camera_device *to_soc_camera_dev(
150         const struct device *dev)
151 {
152         return container_of(dev, struct soc_camera_device, dev);
153 }
154
155 static inline struct soc_camera_host *to_soc_camera_host(
156         const struct device *dev)
157 {
158         struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
159
160         return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
161 }
162
163 static inline struct soc_camera_link *to_soc_camera_link(
164         const struct soc_camera_device *icd)
165 {
166         return icd->dev.platform_data;
167 }
168
169 static inline struct device *to_soc_camera_control(
170         const struct soc_camera_device *icd)
171 {
172         return dev_get_drvdata(&icd->dev);
173 }
174
175 static inline struct v4l2_subdev *soc_camera_to_subdev(
176         const struct soc_camera_device *icd)
177 {
178         struct device *control = to_soc_camera_control(icd);
179         return dev_get_drvdata(control);
180 }
181
182 int soc_camera_host_register(struct soc_camera_host *ici);
183 void soc_camera_host_unregister(struct soc_camera_host *ici);
184
185 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
186         struct soc_camera_device *icd, unsigned int fourcc);
187
188 /**
189  * struct soc_camera_format_xlate - match between host and sensor formats
190  * @code: code of a sensor provided format
191  * @host_fmt: host format after host translation from code
192  *
193  * Host and sensor translation structure. Used in table of host and sensor
194  * formats matchings in soc_camera_device. A host can override the generic list
195  * generation by implementing get_formats(), and use it for format checks and
196  * format setup.
197  */
198 struct soc_camera_format_xlate {
199         enum v4l2_mbus_pixelcode code;
200         const struct soc_mbus_pixelfmt *host_fmt;
201 };
202
203 struct soc_camera_ops {
204         int (*suspend)(struct soc_camera_device *, pm_message_t state);
205         int (*resume)(struct soc_camera_device *);
206         unsigned long (*query_bus_param)(struct soc_camera_device *);
207         int (*set_bus_param)(struct soc_camera_device *, unsigned long);
208         int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
209         const struct v4l2_queryctrl *controls;
210         int num_controls;
211 };
212
213 #define SOCAM_SENSE_PCLK_CHANGED        (1 << 0)
214
215 /**
216  * This struct can be attached to struct soc_camera_device by the host driver
217  * to request sense from the camera, for example, when calling .set_fmt(). The
218  * host then can check which flags are set and verify respective values if any.
219  * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
220  * changed during this operation. After completion the host should detach sense.
221  *
222  * @flags               ored SOCAM_SENSE_* flags
223  * @master_clock        if the host wants to be informed about pixel-clock
224  *                      change, it better set master_clock.
225  * @pixel_clock_max     maximum pixel clock frequency supported by the host,
226  *                      camera is not allowed to exceed this.
227  * @pixel_clock         if the camera driver changed pixel clock during this
228  *                      operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
229  *                      master_clock to calculate the new pixel-clock and
230  *                      sets this field.
231  */
232 struct soc_camera_sense {
233         unsigned long flags;
234         unsigned long master_clock;
235         unsigned long pixel_clock_max;
236         unsigned long pixel_clock;
237 };
238
239 static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
240         struct soc_camera_ops *ops, int id)
241 {
242         int i;
243
244         for (i = 0; i < ops->num_controls; i++)
245                 if (ops->controls[i].id == id)
246                         return &ops->controls[i];
247
248         return NULL;
249 }
250
251 #define SOCAM_MASTER                    (1 << 0)
252 #define SOCAM_SLAVE                     (1 << 1)
253 #define SOCAM_HSYNC_ACTIVE_HIGH         (1 << 2)
254 #define SOCAM_HSYNC_ACTIVE_LOW          (1 << 3)
255 #define SOCAM_VSYNC_ACTIVE_HIGH         (1 << 4)
256 #define SOCAM_VSYNC_ACTIVE_LOW          (1 << 5)
257 #define SOCAM_DATAWIDTH_4               (1 << 6)
258 #define SOCAM_DATAWIDTH_8               (1 << 7)
259 #define SOCAM_DATAWIDTH_9               (1 << 8)
260 #define SOCAM_DATAWIDTH_10              (1 << 9)
261 #define SOCAM_DATAWIDTH_15              (1 << 10)
262 #define SOCAM_DATAWIDTH_16              (1 << 11)
263 #define SOCAM_PCLK_SAMPLE_RISING        (1 << 12)
264 #define SOCAM_PCLK_SAMPLE_FALLING       (1 << 13)
265 #define SOCAM_DATA_ACTIVE_HIGH          (1 << 14)
266 #define SOCAM_DATA_ACTIVE_LOW           (1 << 15)
267
268 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
269                               SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
270                               SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
271
272 static inline unsigned long soc_camera_bus_param_compatible(
273                         unsigned long camera_flags, unsigned long bus_flags)
274 {
275         unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
276
277         common_flags = camera_flags & bus_flags;
278
279         hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
280         vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
281         pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
282         data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
283         mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
284         buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
285
286         return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
287                 common_flags;
288 }
289
290 static inline void soc_camera_limit_side(int *start, int *length,
291                 unsigned int start_min,
292                 unsigned int length_min, unsigned int length_max)
293 {
294         if (*length < length_min)
295                 *length = length_min;
296         else if (*length > length_max)
297                 *length = length_max;
298
299         if (*start < start_min)
300                 *start = start_min;
301         else if (*start > start_min + length_max - *length)
302                 *start = start_min + length_max - *length;
303 }
304
305 extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
306                                                    unsigned long flags);
307
308 /* This is only temporary here - until v4l2-subdev begins to link to video_device */
309 #include <linux/i2c.h>
310 static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client)
311 {
312         struct soc_camera_device *icd = client->dev.platform_data;
313         return icd->vdev;
314 }
315
316 static inline struct soc_camera_device *soc_camera_from_vb2q(struct vb2_queue *vq)
317 {
318         return container_of(vq, struct soc_camera_device, vb2_vidq);
319 }
320
321 static inline struct soc_camera_device *soc_camera_from_vbq(struct videobuf_queue *vq)
322 {
323         return container_of(vq, struct soc_camera_device, vb_vidq);
324 }
325
326 void soc_camera_lock(struct vb2_queue *vq);
327 void soc_camera_unlock(struct vb2_queue *vq);
328
329 #endif