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_link;
27
28 struct soc_camera_device {
29 struct list_head list; /* list of all registered devices */
30 struct soc_camera_link *link;
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 .video_lock held */
50 int use_count;
51 struct mutex video_lock; /* Protects device data */
52 struct file *streamer; /* stream owner */
53 union {
54 struct videobuf_queue vb_vidq;
55 struct vb2_queue vb2_vidq;
56 };
57 };
58
59 struct soc_camera_host {
60 struct v4l2_device v4l2_dev;
61 struct list_head list;
62 struct mutex host_lock; /* Protect during probing */
63 unsigned char nr; /* Host number */
64 void *priv;
65 const char *drv_name;
66 struct soc_camera_host_ops *ops;
67 };
68
69 struct soc_camera_host_ops {
70 struct module *owner;
71 int (*add)(struct soc_camera_device *);
72 void (*remove)(struct soc_camera_device *);
73 /*
74 * .get_formats() is called for each client device format, but
75 * .put_formats() is only called once. Further, if any of the calls to
76 * .get_formats() fail, .put_formats() will not be called at all, the
77 * failing .get_formats() must then clean up internally.
78 */
79 int (*get_formats)(struct soc_camera_device *, unsigned int,
80 struct soc_camera_format_xlate *);
81 void (*put_formats)(struct soc_camera_device *);
82 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
83 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
84 int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
85 /*
86 * The difference to .set_crop() is, that .set_livecrop is not allowed
87 * to change the output sizes
88 */
89 int (*set_livecrop)(struct soc_camera_device *, struct v4l2_crop *);
90 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
91 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
92 void (*init_videobuf)(struct videobuf_queue *,
93 struct soc_camera_device *);
94 int (*init_videobuf2)(struct vb2_queue *,
95 struct soc_camera_device *);
96 int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
97 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
98 int (*set_bus_param)(struct soc_camera_device *);
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 };
104
105 #define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
106 #define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
107 #define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
108 #define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
109 #define SOCAM_SENSOR_INVERT_DATA (1 << 4)
110
111 struct i2c_board_info;
112 struct regulator_bulk_data;
113
114 struct soc_camera_link {
115 /* Camera bus id, used to match a camera and a bus */
116 int bus_id;
117 /* Per camera SOCAM_SENSOR_* bus flags */
118 unsigned long flags;
119 int i2c_adapter_id;
120 struct i2c_board_info *board_info;
121 const char *module_name;
122 void *priv;
123
124 /* Optional regulators that have to be managed on power on/off events */
125 struct regulator_bulk_data *regulators;
126 int num_regulators;
127
128 /*
129 * For non-I2C devices platform has to provide methods to add a device
130 * to the system and to remove it
131 */
132 int (*add_device)(struct soc_camera_device *);
133 void (*del_device)(struct soc_camera_device *);
134 /* Optional callbacks to power on or off and reset the sensor */
135 int (*power)(struct device *, int);
136 int (*reset)(struct device *);
137 /*
138 * some platforms may support different data widths than the sensors
139 * native ones due to different data line routing. Let the board code
140 * overwrite the width flags.
141 */
142 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
143 unsigned long (*query_bus_param)(struct soc_camera_link *);
144 void (*free_bus)(struct soc_camera_link *);
145 };
146
to_soc_camera_host(const struct device * dev)147 static inline struct soc_camera_host *to_soc_camera_host(
148 const struct device *dev)
149 {
150 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
151
152 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
153 }
154
to_soc_camera_link(const struct soc_camera_device * icd)155 static inline struct soc_camera_link *to_soc_camera_link(
156 const struct soc_camera_device *icd)
157 {
158 return icd->link;
159 }
160
to_soc_camera_control(const struct soc_camera_device * icd)161 static inline struct device *to_soc_camera_control(
162 const struct soc_camera_device *icd)
163 {
164 return icd->control;
165 }
166
soc_camera_to_subdev(const struct soc_camera_device * icd)167 static inline struct v4l2_subdev *soc_camera_to_subdev(
168 const struct soc_camera_device *icd)
169 {
170 struct device *control = to_soc_camera_control(icd);
171 return dev_get_drvdata(control);
172 }
173
174 int soc_camera_host_register(struct soc_camera_host *ici);
175 void soc_camera_host_unregister(struct soc_camera_host *ici);
176
177 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
178 struct soc_camera_device *icd, unsigned int fourcc);
179
180 /**
181 * struct soc_camera_format_xlate - match between host and sensor formats
182 * @code: code of a sensor provided format
183 * @host_fmt: host format after host translation from code
184 *
185 * Host and sensor translation structure. Used in table of host and sensor
186 * formats matchings in soc_camera_device. A host can override the generic list
187 * generation by implementing get_formats(), and use it for format checks and
188 * format setup.
189 */
190 struct soc_camera_format_xlate {
191 enum v4l2_mbus_pixelcode code;
192 const struct soc_mbus_pixelfmt *host_fmt;
193 };
194
195 #define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
196
197 /**
198 * This struct can be attached to struct soc_camera_device by the host driver
199 * to request sense from the camera, for example, when calling .set_fmt(). The
200 * host then can check which flags are set and verify respective values if any.
201 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
202 * changed during this operation. After completion the host should detach sense.
203 *
204 * @flags ored SOCAM_SENSE_* flags
205 * @master_clock if the host wants to be informed about pixel-clock
206 * change, it better set master_clock.
207 * @pixel_clock_max maximum pixel clock frequency supported by the host,
208 * camera is not allowed to exceed this.
209 * @pixel_clock if the camera driver changed pixel clock during this
210 * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
211 * master_clock to calculate the new pixel-clock and
212 * sets this field.
213 */
214 struct soc_camera_sense {
215 unsigned long flags;
216 unsigned long master_clock;
217 unsigned long pixel_clock_max;
218 unsigned long pixel_clock;
219 };
220
221 #define SOCAM_DATAWIDTH(x) BIT((x) - 1)
222 #define SOCAM_DATAWIDTH_4 SOCAM_DATAWIDTH(4)
223 #define SOCAM_DATAWIDTH_8 SOCAM_DATAWIDTH(8)
224 #define SOCAM_DATAWIDTH_9 SOCAM_DATAWIDTH(9)
225 #define SOCAM_DATAWIDTH_10 SOCAM_DATAWIDTH(10)
226 #define SOCAM_DATAWIDTH_15 SOCAM_DATAWIDTH(15)
227 #define SOCAM_DATAWIDTH_16 SOCAM_DATAWIDTH(16)
228
229 #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
230 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
231 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
232
soc_camera_limit_side(int * start,int * length,unsigned int start_min,unsigned int length_min,unsigned int length_max)233 static inline void soc_camera_limit_side(int *start, int *length,
234 unsigned int start_min,
235 unsigned int length_min, unsigned int length_max)
236 {
237 if (*length < length_min)
238 *length = length_min;
239 else if (*length > length_max)
240 *length = length_max;
241
242 if (*start < start_min)
243 *start = start_min;
244 else if (*start > start_min + length_max - *length)
245 *start = start_min + length_max - *length;
246 }
247
248 unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
249 unsigned long flags);
250 unsigned long soc_camera_apply_board_flags(struct soc_camera_link *icl,
251 const struct v4l2_mbus_config *cfg);
252
253 /* This is only temporary here - until v4l2-subdev begins to link to video_device */
254 #include <linux/i2c.h>
soc_camera_i2c_to_vdev(const struct i2c_client * client)255 static inline struct video_device *soc_camera_i2c_to_vdev(const struct i2c_client *client)
256 {
257 struct v4l2_subdev *sd = i2c_get_clientdata(client);
258 struct soc_camera_device *icd = v4l2_get_subdev_hostdata(sd);
259 return icd ? icd->vdev : NULL;
260 }
261
soc_camera_i2c_to_link(const struct i2c_client * client)262 static inline struct soc_camera_link *soc_camera_i2c_to_link(const struct i2c_client *client)
263 {
264 return client->dev.platform_data;
265 }
266
soc_camera_vdev_to_subdev(const struct video_device * vdev)267 static inline struct v4l2_subdev *soc_camera_vdev_to_subdev(const struct video_device *vdev)
268 {
269 struct soc_camera_device *icd = dev_get_drvdata(vdev->parent);
270 return soc_camera_to_subdev(icd);
271 }
272
soc_camera_from_vb2q(const struct vb2_queue * vq)273 static inline struct soc_camera_device *soc_camera_from_vb2q(const struct vb2_queue *vq)
274 {
275 return container_of(vq, struct soc_camera_device, vb2_vidq);
276 }
277
soc_camera_from_vbq(const struct videobuf_queue * vq)278 static inline struct soc_camera_device *soc_camera_from_vbq(const struct videobuf_queue *vq)
279 {
280 return container_of(vq, struct soc_camera_device, vb_vidq);
281 }
282
soc_camera_grp_id(const struct soc_camera_device * icd)283 static inline u32 soc_camera_grp_id(const struct soc_camera_device *icd)
284 {
285 return (icd->iface << 8) | (icd->devnum + 1);
286 }
287
288 void soc_camera_lock(struct vb2_queue *vq);
289 void soc_camera_unlock(struct vb2_queue *vq);
290
291 #endif
292