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/bitops.h>
16 #include <linux/device.h>
17 #include <linux/mutex.h>
18 #include <linux/pm.h>
19 #include <linux/videodev2.h>
20 #include <media/videobuf-core.h>
21 #include <media/videobuf2-core.h>
22 #include <media/v4l2-ctrls.h>
23 #include <media/v4l2-device.h>
24
25 struct file;
26 struct soc_camera_desc;
27
28 struct soc_camera_device {
29 struct list_head list; /* list of all registered devices */
30 struct soc_camera_desc *sdesc;
31 struct device *pdev; /* Platform device */
32 struct device *parent; /* Camera host device */
33 struct device *control; /* E.g., the i2c client */
34 s32 user_width;
35 s32 user_height;
36 u32 bytesperline; /* for padding, zero if unused */
37 u32 sizeimage;
38 enum v4l2_colorspace colorspace;
39 unsigned char iface; /* Host number */
40 unsigned char devnum; /* Device number per host */
41 struct soc_camera_sense *sense; /* See comment in struct definition */
42 struct video_device *vdev;
43 struct v4l2_ctrl_handler ctrl_handler;
44 const struct soc_camera_format_xlate *current_fmt;
45 struct soc_camera_format_xlate *user_formats;
46 int num_user_formats;
47 enum v4l2_field field; /* Preserve field over close() */
48 void *host_priv; /* Per-device host private data */
49 /* soc_camera.c private count. Only accessed with .host_lock held */
50 int use_count;
51 struct file *streamer; /* stream owner */
52 union {
53 struct videobuf_queue vb_vidq;
54 struct vb2_queue vb2_vidq;
55 };
56 };
57
58 /* Host supports programmable stride */
59 #define SOCAM_HOST_CAP_STRIDE (1 << 0)
60
61 struct soc_camera_host {
62 struct v4l2_device v4l2_dev;
63 struct list_head list;
64 struct mutex host_lock; /* Protect pipeline modifications */
65 unsigned char nr; /* Host number */
66 u32 capabilities;
67 void *priv;
68 const char *drv_name;
69 struct soc_camera_host_ops *ops;
70 };
71
72 struct soc_camera_host_ops {
73 struct module *owner;
74 int (*add)(struct soc_camera_device *);
75 void (*remove)(struct soc_camera_device *);
76 /*
77 * .get_formats() is called for each client device format, but
78 * .put_formats() is only called once. Further, if any of the calls to
79 * .get_formats() fail, .put_formats() will not be called at all, the
80 * failing .get_formats() must then clean up internally.
81 */
82 int (*get_formats)(struct soc_camera_device *, unsigned int,
83 struct soc_camera_format_xlate *);
84 void (*put_formats)(struct soc_camera_device *);
85 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
86 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
87 int (*set_crop)(struct soc_camera_device *, const struct v4l2_crop *);
88 int (*get_selection)(struct soc_camera_device *, struct v4l2_selection *);
89 int (*set_selection)(struct soc_camera_device *, struct v4l2_selection *);
90 /*
91 * The difference to .set_crop() is, that .set_livecrop is not allowed
92 * to change the output sizes
93 */
94 int (*set_livecrop)(struct soc_camera_device *, const struct v4l2_crop *);
95 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
96 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
97 void (*init_videobuf)(struct videobuf_queue *,
98 struct soc_camera_device *);
99 int (*init_videobuf2)(struct vb2_queue *,
100 struct soc_camera_device *);
101 int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
102 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
103 int (*set_bus_param)(struct soc_camera_device *);
104 int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
105 int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
106 int (*enum_framesizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
107 unsigned int (*poll)(struct file *, poll_table *);
108 };
109
110 #define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
111 #define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
112 #define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
113 #define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
114 #define SOCAM_SENSOR_INVERT_DATA (1 << 4)
115
116 struct i2c_board_info;
117 struct regulator_bulk_data;
118
119 struct soc_camera_subdev_desc {
120 /* Per camera SOCAM_SENSOR_* bus flags */
121 unsigned long flags;
122
123 /* sensor driver private platform data */
124 void *drv_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 /* Optional callbacks to power on or off and reset the sensor */
131 int (*power)(struct device *, int);
132 int (*reset)(struct device *);
133
134 /*
135 * some platforms may support different data widths than the sensors
136 * native ones due to different data line routing. Let the board code
137 * overwrite the width flags.
138 */
139 int (*set_bus_param)(struct soc_camera_subdev_desc *, unsigned long flags);
140 unsigned long (*query_bus_param)(struct soc_camera_subdev_desc *);
141 void (*free_bus)(struct soc_camera_subdev_desc *);
142 };
143
144 struct soc_camera_host_desc {
145 /* Camera bus id, used to match a camera and a bus */
146 int bus_id;
147 int i2c_adapter_id;
148 struct i2c_board_info *board_info;
149 const char *module_name;
150
151 /*
152 * For non-I2C devices platform has to provide methods to add a device
153 * to the system and to remove it
154 */
155 int (*add_device)(struct soc_camera_device *);
156 void (*del_device)(struct soc_camera_device *);
157 };
158
159 /*
160 * This MUST be kept binary-identical to struct soc_camera_link below, until
161 * it is completely replaced by this one, after which we can split it into its
162 * two components.
163 */
164 struct soc_camera_desc {
165 struct soc_camera_subdev_desc subdev_desc;
166 struct soc_camera_host_desc host_desc;
167 };
168
169 /* Prepare to replace this struct: don't change its layout any more! */
170 struct soc_camera_link {
171 /*
172 * Subdevice part - keep at top and compatible to
173 * struct soc_camera_subdev_desc
174 */
175
176 /* Per camera SOCAM_SENSOR_* bus flags */
177 unsigned long flags;
178
179 void *priv;
180
181 /* Optional regulators that have to be managed on power on/off events */
182 struct regulator_bulk_data *regulators;
183 int num_regulators;
184
185 /* Optional callbacks to power on or off and reset the sensor */
186 int (*power)(struct device *, int);
187 int (*reset)(struct device *);
188 /*
189 * some platforms may support different data widths than the sensors
190 * native ones due to different data line routing. Let the board code
191 * overwrite the width flags.
192 */
193 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
194 unsigned long (*query_bus_param)(struct soc_camera_link *);
195 void (*free_bus)(struct soc_camera_link *);
196
197 /*
198 * Host part - keep at bottom and compatible to
199 * struct soc_camera_host_desc
200 */
201
202 /* Camera bus id, used to match a camera and a bus */
203 int bus_id;
204 int i2c_adapter_id;
205 struct i2c_board_info *board_info;
206 const char *module_name;
207
208 /*
209 * For non-I2C devices platform has to provide methods to add a device
210 * to the system and to remove it
211 */
212 int (*add_device)(struct soc_camera_device *);
213 void (*del_device)(struct soc_camera_device *);
214 };
215
to_soc_camera_host(const struct device * dev)216 static inline struct soc_camera_host *to_soc_camera_host(
217 const struct device *dev)
218 {
219 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
220
221 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
222 }
223
to_soc_camera_desc(const struct soc_camera_device * icd)224 static inline struct soc_camera_desc *to_soc_camera_desc(
225 const struct soc_camera_device *icd)
226 {
227 return icd->sdesc;
228 }
229
to_soc_camera_control(const struct soc_camera_device * icd)230 static inline struct device *to_soc_camera_control(
231 const struct soc_camera_device *icd)
232 {
233 return icd->control;
234 }
235
soc_camera_to_subdev(const struct soc_camera_device * icd)236 static inline struct v4l2_subdev *soc_camera_to_subdev(
237 const struct soc_camera_device *icd)
238 {
239 struct device *control = to_soc_camera_control(icd);
240 return dev_get_drvdata(control);
241 }
242
243 int soc_camera_host_register(struct soc_camera_host *ici);
244 void soc_camera_host_unregister(struct soc_camera_host *ici);
245
246 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
247 struct soc_camera_device *icd, unsigned int fourcc);
248
249 /**
250 * struct soc_camera_format_xlate - match between host and sensor formats
251 * @code: code of a sensor provided format
252 * @host_fmt: host format after host translation from code
253 *
254 * Host and sensor translation structure. Used in table of host and sensor
255 * formats matchings in soc_camera_device. A host can override the generic list
256 * generation by implementing get_formats(), and use it for format checks and
257 * format setup.
258 */
259 struct soc_camera_format_xlate {
260 enum v4l2_mbus_pixelcode code;
261 const struct soc_mbus_pixelfmt *host_fmt;
262 };
263
264 #define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
265
266 /**
267 * This struct can be attached to struct soc_camera_device by the host driver
268 * to request sense from the camera, for example, when calling .set_fmt(). The
269 * host then can check which flags are set and verify respective values if any.
270 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
271 * changed during this operation. After completion the host should detach sense.
272 *
273 * @flags ored SOCAM_SENSE_* flags
274 * @master_clock if the host wants to be informed about pixel-clock
275 * change, it better set master_clock.
276 * @pixel_clock_max maximum pixel clock frequency supported by the host,
277 * camera is not allowed to exceed this.
278 * @pixel_clock if the camera driver changed pixel clock during this
279 * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
280 * master_clock to calculate the new pixel-clock and
281 * sets this field.
282 */
283 struct soc_camera_sense {
284 unsigned long flags;
285 unsigned long master_clock;
286 unsigned long pixel_clock_max;
287 unsigned long pixel_clock;
288 };
289
290 #define SOCAM_DATAWIDTH(x) BIT((x) - 1)
291 #define SOCAM_DATAWIDTH_4 SOCAM_DATAWIDTH(4)
292 #define SOCAM_DATAWIDTH_8 SOCAM_DATAWIDTH(8)
293 #define SOCAM_DATAWIDTH_9 SOCAM_DATAWIDTH(9)
294 #define SOCAM_DATAWIDTH_10 SOCAM_DATAWIDTH(10)
295 #define SOCAM_DATAWIDTH_12 SOCAM_DATAWIDTH(12)
296 #define SOCAM_DATAWIDTH_15 SOCAM_DATAWIDTH(15)
297 #define SOCAM_DATAWIDTH_16 SOCAM_DATAWIDTH(16)
298 #define SOCAM_DATAWIDTH_18 SOCAM_DATAWIDTH(18)
299 #define SOCAM_DATAWIDTH_24 SOCAM_DATAWIDTH(24)
300
301 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
302 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
303 SOCAM_DATAWIDTH_12 | SOCAM_DATAWIDTH_15 | \
304 SOCAM_DATAWIDTH_16 | SOCAM_DATAWIDTH_18 | \
305 SOCAM_DATAWIDTH_24)
306
soc_camera_limit_side(int * start,int * length,unsigned int start_min,unsigned int length_min,unsigned int length_max)307 static inline void soc_camera_limit_side(int *start, int *length,
308 unsigned int start_min,
309 unsigned int length_min, unsigned int length_max)
310 {
311 if (*length < length_min)
312 *length = length_min;
313 else if (*length > length_max)
314 *length = length_max;
315
316 if (*start < start_min)
317 *start = start_min;
318 else if (*start > start_min + length_max - *length)
319 *start = start_min + length_max - *length;
320 }
321
322 unsigned long soc_camera_apply_board_flags(struct soc_camera_subdev_desc *ssdd,
323 const struct v4l2_mbus_config *cfg);
324
325 int soc_camera_power_on(struct device *dev, struct soc_camera_subdev_desc *ssdd);
326 int soc_camera_power_off(struct device *dev, struct soc_camera_subdev_desc *ssdd);
327
soc_camera_set_power(struct device * dev,struct soc_camera_subdev_desc * ssdd,bool on)328 static inline int soc_camera_set_power(struct device *dev,
329 struct soc_camera_subdev_desc *ssdd, bool on)
330 {
331 return on ? soc_camera_power_on(dev, ssdd)
332 : soc_camera_power_off(dev, ssdd);
333 }
334
335 /* This is only temporary here - until v4l2-subdev begins to link to video_device */
336 #include <linux/i2c.h>
soc_camera_i2c_to_vdev(const struct i2c_client * client)337 static inline struct video_device *soc_camera_i2c_to_vdev(const struct i2c_client *client)
338 {
339 struct v4l2_subdev *sd = i2c_get_clientdata(client);
340 struct soc_camera_device *icd = v4l2_get_subdev_hostdata(sd);
341 return icd ? icd->vdev : NULL;
342 }
343
soc_camera_i2c_to_desc(const struct i2c_client * client)344 static inline struct soc_camera_subdev_desc *soc_camera_i2c_to_desc(const struct i2c_client *client)
345 {
346 return client->dev.platform_data;
347 }
348
soc_camera_vdev_to_subdev(const struct video_device * vdev)349 static inline struct v4l2_subdev *soc_camera_vdev_to_subdev(const struct video_device *vdev)
350 {
351 struct soc_camera_device *icd = dev_get_drvdata(vdev->parent);
352 return soc_camera_to_subdev(icd);
353 }
354
soc_camera_from_vb2q(const struct vb2_queue * vq)355 static inline struct soc_camera_device *soc_camera_from_vb2q(const struct vb2_queue *vq)
356 {
357 return container_of(vq, struct soc_camera_device, vb2_vidq);
358 }
359
soc_camera_from_vbq(const struct videobuf_queue * vq)360 static inline struct soc_camera_device *soc_camera_from_vbq(const struct videobuf_queue *vq)
361 {
362 return container_of(vq, struct soc_camera_device, vb_vidq);
363 }
364
soc_camera_grp_id(const struct soc_camera_device * icd)365 static inline u32 soc_camera_grp_id(const struct soc_camera_device *icd)
366 {
367 return (icd->iface << 8) | (icd->devnum + 1);
368 }
369
370 void soc_camera_lock(struct vb2_queue *vq);
371 void soc_camera_unlock(struct vb2_queue *vq);
372
373 #endif
374