2 * camera image capture (abstract) bus driver header
4 * Copyright (C) 2006, Sascha Hauer, Pengutronix
5 * Copyright (C) 2008, Guennadi Liakhovetski <kernel@pengutronix.de>
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.
15 #include <linux/device.h>
16 #include <linux/mutex.h>
18 #include <linux/videodev2.h>
19 #include <media/videobuf-core.h>
20 #include <media/videobuf2-core.h>
21 #include <media/v4l2-device.h>
23 extern struct bus_type soc_camera_bus_type;
27 struct soc_camera_device {
28 struct list_head list;
30 struct device *pdev; /* Platform device */
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;
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 */
46 struct mutex video_lock; /* Protects device data */
47 struct file *streamer; /* stream owner */
49 struct videobuf_queue vb_vidq;
50 struct vb2_queue vb2_vidq;
54 struct soc_camera_host {
55 struct v4l2_device v4l2_dev;
56 struct list_head list;
57 unsigned char nr; /* Host number */
60 struct soc_camera_host_ops *ops;
63 struct soc_camera_host_ops {
65 int (*add)(struct soc_camera_device *);
66 void (*remove)(struct soc_camera_device *);
67 int (*suspend)(struct soc_camera_device *, pm_message_t);
68 int (*resume)(struct soc_camera_device *);
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.
75 int (*get_formats)(struct soc_camera_device *, unsigned int,
76 struct soc_camera_format_xlate *);
77 void (*put_formats)(struct soc_camera_device *);
78 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
79 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
80 int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
81 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
82 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
83 void (*init_videobuf)(struct videobuf_queue *,
84 struct soc_camera_device *);
85 int (*init_videobuf2)(struct vb2_queue *,
86 struct soc_camera_device *);
87 int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
88 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
89 int (*set_bus_param)(struct soc_camera_device *, __u32);
90 int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
91 int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
92 int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
93 int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
94 int (*enum_fsizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
95 unsigned int (*poll)(struct file *, poll_table *);
96 const struct v4l2_queryctrl *controls;
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)
106 struct i2c_board_info;
107 struct regulator_bulk_data;
109 struct soc_camera_link {
110 /* Camera bus id, used to match a camera and a bus */
112 /* Per camera SOCAM_SENSOR_* bus flags */
115 struct i2c_board_info *board_info;
116 const char *module_name;
119 /* Optional regulators that have to be managed on power on/off events */
120 struct regulator_bulk_data *regulators;
124 * For non-I2C devices platform platform has to provide methods to
125 * add a device to the system and to remove
127 int (*add_device)(struct soc_camera_link *, struct device *);
128 void (*del_device)(struct soc_camera_link *);
129 /* Optional callbacks to power on or off and reset the sensor */
130 int (*power)(struct device *, int);
131 int (*reset)(struct device *);
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.
137 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
138 unsigned long (*query_bus_param)(struct soc_camera_link *);
139 void (*free_bus)(struct soc_camera_link *);
142 static inline struct soc_camera_device *to_soc_camera_dev(
143 const struct device *dev)
145 return container_of(dev, struct soc_camera_device, dev);
148 static inline struct soc_camera_host *to_soc_camera_host(
149 const struct device *dev)
151 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
153 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
156 static inline struct soc_camera_link *to_soc_camera_link(
157 const struct soc_camera_device *icd)
159 return icd->dev.platform_data;
162 static inline struct device *to_soc_camera_control(
163 const struct soc_camera_device *icd)
165 return dev_get_drvdata(&icd->dev);
168 static inline struct v4l2_subdev *soc_camera_to_subdev(
169 const struct soc_camera_device *icd)
171 struct device *control = to_soc_camera_control(icd);
172 return dev_get_drvdata(control);
175 int soc_camera_host_register(struct soc_camera_host *ici);
176 void soc_camera_host_unregister(struct soc_camera_host *ici);
178 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
179 struct soc_camera_device *icd, unsigned int fourcc);
182 * struct soc_camera_format_xlate - match between host and sensor formats
183 * @code: code of a sensor provided format
184 * @host_fmt: host format after host translation from code
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
191 struct soc_camera_format_xlate {
192 enum v4l2_mbus_pixelcode code;
193 const struct soc_mbus_pixelfmt *host_fmt;
196 struct soc_camera_ops {
197 int (*suspend)(struct soc_camera_device *, pm_message_t state);
198 int (*resume)(struct soc_camera_device *);
199 unsigned long (*query_bus_param)(struct soc_camera_device *);
200 int (*set_bus_param)(struct soc_camera_device *, unsigned long);
201 int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
202 const struct v4l2_queryctrl *controls;
206 #define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
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.
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
225 struct soc_camera_sense {
227 unsigned long master_clock;
228 unsigned long pixel_clock_max;
229 unsigned long pixel_clock;
232 static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
233 struct soc_camera_ops *ops, int id)
237 for (i = 0; i < ops->num_controls; i++)
238 if (ops->controls[i].id == id)
239 return &ops->controls[i];
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)
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)
265 static inline unsigned long soc_camera_bus_param_compatible(
266 unsigned long camera_flags, unsigned long bus_flags)
268 unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
270 common_flags = camera_flags & bus_flags;
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);
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;
279 return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
283 static inline void soc_camera_limit_side(int *start, int *length,
284 unsigned int start_min,
285 unsigned int length_min, unsigned int length_max)
287 if (*length < length_min)
288 *length = length_min;
289 else if (*length > length_max)
290 *length = length_max;
292 if (*start < start_min)
294 else if (*start > start_min + length_max - *length)
295 *start = start_min + length_max - *length;
298 extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
299 unsigned long flags);
301 /* This is only temporary here - until v4l2-subdev begins to link to video_device */
302 #include <linux/i2c.h>
303 static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client)
305 struct soc_camera_device *icd = client->dev.platform_data;
309 static inline struct soc_camera_device *soc_camera_from_vb2q(struct vb2_queue *vq)
311 return container_of(vq, struct soc_camera_device, vb2_vidq);
314 static inline struct soc_camera_device *soc_camera_from_vbq(struct videobuf_queue *vq)
316 return container_of(vq, struct soc_camera_device, vb_vidq);
319 void soc_camera_lock(struct vb2_queue *vq);
320 void soc_camera_unlock(struct vb2_queue *vq);