]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame_incremental - include/media/soc_camera.h
[media] V4L: soc-camera: un-export the soc-camera bus
[mirror_ubuntu-zesty-kernel.git] / include / media / soc_camera.h
... / ...
CommitLineData
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
23struct file;
24
25struct soc_camera_device {
26 struct list_head list; /* list of all registered devices */
27 struct device dev;
28 struct device *pdev; /* Platform device */
29 s32 user_width;
30 s32 user_height;
31 u32 bytesperline; /* for padding, zero if unused */
32 u32 sizeimage;
33 enum v4l2_colorspace colorspace;
34 unsigned char iface; /* Host number */
35 unsigned char devnum; /* Device number per host */
36 struct soc_camera_sense *sense; /* See comment in struct definition */
37 struct soc_camera_ops *ops;
38 struct video_device *vdev;
39 const struct soc_camera_format_xlate *current_fmt;
40 struct soc_camera_format_xlate *user_formats;
41 int num_user_formats;
42 enum v4l2_field field; /* Preserve field over close() */
43 void *host_priv; /* Per-device host private data */
44 /* soc_camera.c private count. Only accessed with .video_lock held */
45 int use_count;
46 struct mutex video_lock; /* Protects device data */
47 struct file *streamer; /* stream owner */
48 union {
49 struct videobuf_queue vb_vidq;
50 struct vb2_queue vb2_vidq;
51 };
52};
53
54struct soc_camera_host {
55 struct v4l2_device v4l2_dev;
56 struct list_head list;
57 unsigned char nr; /* Host number */
58 void *priv;
59 const char *drv_name;
60 struct soc_camera_host_ops *ops;
61};
62
63struct soc_camera_host_ops {
64 struct module *owner;
65 int (*add)(struct soc_camera_device *);
66 void (*remove)(struct soc_camera_device *);
67 /*
68 * .get_formats() is called for each client device format, but
69 * .put_formats() is only called once. Further, if any of the calls to
70 * .get_formats() fail, .put_formats() will not be called at all, the
71 * failing .get_formats() must then clean up internally.
72 */
73 int (*get_formats)(struct soc_camera_device *, unsigned int,
74 struct soc_camera_format_xlate *);
75 void (*put_formats)(struct soc_camera_device *);
76 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
77 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
78 int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
79 /*
80 * The difference to .set_crop() is, that .set_livecrop is not allowed
81 * to change the output sizes
82 */
83 int (*set_livecrop)(struct soc_camera_device *, struct v4l2_crop *);
84 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
85 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
86 void (*init_videobuf)(struct videobuf_queue *,
87 struct soc_camera_device *);
88 int (*init_videobuf2)(struct vb2_queue *,
89 struct soc_camera_device *);
90 int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
91 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
92 int (*set_bus_param)(struct soc_camera_device *, __u32);
93 int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
94 int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
95 int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
96 int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
97 int (*enum_fsizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
98 unsigned int (*poll)(struct file *, poll_table *);
99 const struct v4l2_queryctrl *controls;
100 int num_controls;
101};
102
103#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
104#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
105#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
106#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
107#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
108
109struct i2c_board_info;
110struct regulator_bulk_data;
111
112struct soc_camera_link {
113 /* Camera bus id, used to match a camera and a bus */
114 int bus_id;
115 /* Per camera SOCAM_SENSOR_* bus flags */
116 unsigned long flags;
117 int i2c_adapter_id;
118 struct i2c_board_info *board_info;
119 const char *module_name;
120 void *priv;
121
122 /* Optional regulators that have to be managed on power on/off events */
123 struct regulator_bulk_data *regulators;
124 int num_regulators;
125
126 /*
127 * For non-I2C devices platform has to provide methods to add a device
128 * to the system and to remove it
129 */
130 int (*add_device)(struct soc_camera_link *, struct device *);
131 void (*del_device)(struct soc_camera_link *);
132 /* Optional callbacks to power on or off and reset the sensor */
133 int (*power)(struct device *, int);
134 int (*reset)(struct device *);
135 /*
136 * some platforms may support different data widths than the sensors
137 * native ones due to different data line routing. Let the board code
138 * overwrite the width flags.
139 */
140 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
141 unsigned long (*query_bus_param)(struct soc_camera_link *);
142 void (*free_bus)(struct soc_camera_link *);
143};
144
145static inline struct soc_camera_device *to_soc_camera_dev(
146 const struct device *dev)
147{
148 return container_of(dev, struct soc_camera_device, dev);
149}
150
151static inline struct soc_camera_host *to_soc_camera_host(
152 const struct device *dev)
153{
154 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
155
156 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
157}
158
159static inline struct soc_camera_link *to_soc_camera_link(
160 const struct soc_camera_device *icd)
161{
162 return icd->dev.platform_data;
163}
164
165static inline struct device *to_soc_camera_control(
166 const struct soc_camera_device *icd)
167{
168 return dev_get_drvdata(&icd->dev);
169}
170
171static inline struct v4l2_subdev *soc_camera_to_subdev(
172 const struct soc_camera_device *icd)
173{
174 struct device *control = to_soc_camera_control(icd);
175 return dev_get_drvdata(control);
176}
177
178int soc_camera_host_register(struct soc_camera_host *ici);
179void soc_camera_host_unregister(struct soc_camera_host *ici);
180
181const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
182 struct soc_camera_device *icd, unsigned int fourcc);
183
184/**
185 * struct soc_camera_format_xlate - match between host and sensor formats
186 * @code: code of a sensor provided format
187 * @host_fmt: host format after host translation from code
188 *
189 * Host and sensor translation structure. Used in table of host and sensor
190 * formats matchings in soc_camera_device. A host can override the generic list
191 * generation by implementing get_formats(), and use it for format checks and
192 * format setup.
193 */
194struct soc_camera_format_xlate {
195 enum v4l2_mbus_pixelcode code;
196 const struct soc_mbus_pixelfmt *host_fmt;
197};
198
199struct soc_camera_ops {
200 unsigned long (*query_bus_param)(struct soc_camera_device *);
201 int (*set_bus_param)(struct soc_camera_device *, unsigned long);
202 const struct v4l2_queryctrl *controls;
203 int num_controls;
204};
205
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
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
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)
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#define SOCAM_MIPI_1LANE (1 << 16)
261#define SOCAM_MIPI_2LANE (1 << 17)
262#define SOCAM_MIPI_3LANE (1 << 18)
263#define SOCAM_MIPI_4LANE (1 << 19)
264#define SOCAM_MIPI (SOCAM_MIPI_1LANE | SOCAM_MIPI_2LANE | \
265 SOCAM_MIPI_3LANE | SOCAM_MIPI_4LANE)
266
267#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
268 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
269 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
270
271static inline unsigned long soc_camera_bus_param_compatible(
272 unsigned long camera_flags, unsigned long bus_flags)
273{
274 unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
275 unsigned long mipi;
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 mipi = common_flags & SOCAM_MIPI;
286
287 return ((!hsync || !vsync || !pclk || !data || !mode || !buswidth) && !mipi) ? 0 :
288 common_flags;
289}
290
291static inline void soc_camera_limit_side(int *start, int *length,
292 unsigned int start_min,
293 unsigned int length_min, unsigned int length_max)
294{
295 if (*length < length_min)
296 *length = length_min;
297 else if (*length > length_max)
298 *length = length_max;
299
300 if (*start < start_min)
301 *start = start_min;
302 else if (*start > start_min + length_max - *length)
303 *start = start_min + length_max - *length;
304}
305
306extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
307 unsigned long flags);
308
309/* This is only temporary here - until v4l2-subdev begins to link to video_device */
310#include <linux/i2c.h>
311static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client)
312{
313 struct soc_camera_device *icd = client->dev.platform_data;
314 return icd->vdev;
315}
316
317static inline struct soc_camera_device *soc_camera_from_vb2q(struct vb2_queue *vq)
318{
319 return container_of(vq, struct soc_camera_device, vb2_vidq);
320}
321
322static inline struct soc_camera_device *soc_camera_from_vbq(struct videobuf_queue *vq)
323{
324 return container_of(vq, struct soc_camera_device, vb_vidq);
325}
326
327void soc_camera_lock(struct vb2_queue *vq);
328void soc_camera_unlock(struct vb2_queue *vq);
329
330#endif