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