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