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