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 | ||
d839fe17 | 15 | #include <linux/bitops.h> |
52d268a3 | 16 | #include <linux/device.h> |
1c3bb743 GL |
17 | #include <linux/mutex.h> |
18 | #include <linux/pm.h> | |
e55222ef | 19 | #include <linux/videodev2.h> |
092d3921 | 20 | #include <media/videobuf-core.h> |
592c2aba | 21 | #include <media/videobuf2-core.h> |
ee02da64 | 22 | #include <media/v4l2-ctrls.h> |
979ea1dd | 23 | #include <media/v4l2-device.h> |
e55222ef | 24 | |
57bee29d | 25 | struct file; |
7dfff953 | 26 | struct soc_camera_link; |
57bee29d | 27 | |
e55222ef | 28 | struct soc_camera_device { |
d33b290a | 29 | struct list_head list; /* list of all registered devices */ |
7dfff953 | 30 | struct soc_camera_link *link; |
979ea1dd | 31 | struct device *pdev; /* Platform device */ |
7dfff953 GL |
32 | struct device *parent; /* Camera host device */ |
33 | struct device *control; /* E.g., the i2c client */ | |
6a6c8786 GL |
34 | s32 user_width; |
35 | s32 user_height; | |
0e4c180d SA |
36 | u32 bytesperline; /* for padding, zero if unused */ |
37 | u32 sizeimage; | |
760697be | 38 | enum v4l2_colorspace colorspace; |
e55222ef GL |
39 | unsigned char iface; /* Host number */ |
40 | unsigned char devnum; /* Device number per host */ | |
a9bef518 | 41 | struct soc_camera_sense *sense; /* See comment in struct definition */ |
e55222ef | 42 | struct video_device *vdev; |
ee02da64 | 43 | struct v4l2_ctrl_handler ctrl_handler; |
760697be | 44 | const struct soc_camera_format_xlate *current_fmt; |
c2786ad2 GL |
45 | struct soc_camera_format_xlate *user_formats; |
46 | int num_user_formats; | |
025c18a1 | 47 | enum v4l2_field field; /* Preserve field over close() */ |
1c3bb743 GL |
48 | void *host_priv; /* Per-device host private data */ |
49 | /* soc_camera.c private count. Only accessed with .video_lock held */ | |
9dc4e48f | 50 | int use_count; |
1c3bb743 | 51 | struct mutex video_lock; /* Protects device data */ |
57bee29d | 52 | struct file *streamer; /* stream owner */ |
592c2aba GL |
53 | union { |
54 | struct videobuf_queue vb_vidq; | |
55 | struct vb2_queue vb2_vidq; | |
56 | }; | |
e55222ef GL |
57 | }; |
58 | ||
59 | struct soc_camera_host { | |
979ea1dd | 60 | struct v4l2_device v4l2_dev; |
e55222ef | 61 | struct list_head list; |
e55222ef | 62 | unsigned char nr; /* Host number */ |
e55222ef | 63 | void *priv; |
af128a10 | 64 | const char *drv_name; |
b8d9904c GL |
65 | struct soc_camera_host_ops *ops; |
66 | }; | |
67 | ||
68 | struct soc_camera_host_ops { | |
69 | struct module *owner; | |
e55222ef GL |
70 | int (*add)(struct soc_camera_device *); |
71 | void (*remove)(struct soc_camera_device *); | |
fa48984e GL |
72 | /* |
73 | * .get_formats() is called for each client device format, but | |
74 | * .put_formats() is only called once. Further, if any of the calls to | |
75 | * .get_formats() fail, .put_formats() will not be called at all, the | |
76 | * failing .get_formats() must then clean up internally. | |
77 | */ | |
3805f201 | 78 | int (*get_formats)(struct soc_camera_device *, unsigned int, |
c2786ad2 | 79 | struct soc_camera_format_xlate *); |
fa48984e | 80 | void (*put_formats)(struct soc_camera_device *); |
6a6c8786 GL |
81 | int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *); |
82 | int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *); | |
08590b96 | 83 | int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *); |
aee5c2f1 GL |
84 | /* |
85 | * The difference to .set_crop() is, that .set_livecrop is not allowed | |
86 | * to change the output sizes | |
87 | */ | |
88 | int (*set_livecrop)(struct soc_camera_device *, struct v4l2_crop *); | |
09e231b3 | 89 | int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *); |
d8fac217 | 90 | int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *); |
a034d1b7 | 91 | void (*init_videobuf)(struct videobuf_queue *, |
092d3921 | 92 | struct soc_camera_device *); |
592c2aba GL |
93 | int (*init_videobuf2)(struct vb2_queue *, |
94 | struct soc_camera_device *); | |
57bee29d | 95 | int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *); |
e55222ef | 96 | int (*querycap)(struct soc_camera_host *, struct v4l2_capability *); |
ad5f2e85 | 97 | int (*set_bus_param)(struct soc_camera_device *, __u32); |
c9f6ef69 GL |
98 | int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *); |
99 | int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *); | |
ed5b65dc | 100 | int (*enum_fsizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *); |
e55222ef GL |
101 | unsigned int (*poll)(struct file *, poll_table *); |
102 | }; | |
103 | ||
bd73b36f GL |
104 | #define SOCAM_SENSOR_INVERT_PCLK (1 << 0) |
105 | #define SOCAM_SENSOR_INVERT_MCLK (1 << 1) | |
106 | #define SOCAM_SENSOR_INVERT_HSYNC (1 << 2) | |
107 | #define SOCAM_SENSOR_INVERT_VSYNC (1 << 3) | |
108 | #define SOCAM_SENSOR_INVERT_DATA (1 << 4) | |
109 | ||
0fd327bd | 110 | struct i2c_board_info; |
96e442c1 | 111 | struct regulator_bulk_data; |
0fd327bd | 112 | |
e55222ef GL |
113 | struct soc_camera_link { |
114 | /* Camera bus id, used to match a camera and a bus */ | |
115 | int bus_id; | |
bd73b36f GL |
116 | /* Per camera SOCAM_SENSOR_* bus flags */ |
117 | unsigned long flags; | |
0fd327bd GL |
118 | int i2c_adapter_id; |
119 | struct i2c_board_info *board_info; | |
120 | const char *module_name; | |
3fd7ceff GL |
121 | void *priv; |
122 | ||
96e442c1 AP |
123 | /* Optional regulators that have to be managed on power on/off events */ |
124 | struct regulator_bulk_data *regulators; | |
125 | int num_regulators; | |
126 | ||
c41debaf | 127 | /* |
d33b290a GL |
128 | * For non-I2C devices platform has to provide methods to add a device |
129 | * to the system and to remove it | |
c41debaf | 130 | */ |
7dfff953 GL |
131 | int (*add_device)(struct soc_camera_device *); |
132 | void (*del_device)(struct soc_camera_device *); | |
81034663 SH |
133 | /* Optional callbacks to power on or off and reset the sensor */ |
134 | int (*power)(struct device *, int); | |
135 | int (*reset)(struct device *); | |
28f59339 SH |
136 | /* |
137 | * some platforms may support different data widths than the sensors | |
138 | * native ones due to different data line routing. Let the board code | |
139 | * overwrite the width flags. | |
140 | */ | |
141 | int (*set_bus_param)(struct soc_camera_link *, unsigned long flags); | |
142 | unsigned long (*query_bus_param)(struct soc_camera_link *); | |
594bb46d | 143 | void (*free_bus)(struct soc_camera_link *); |
e55222ef GL |
144 | }; |
145 | ||
96c75399 GL |
146 | static inline struct soc_camera_host *to_soc_camera_host( |
147 | const struct device *dev) | |
e55222ef | 148 | { |
979ea1dd GL |
149 | struct v4l2_device *v4l2_dev = dev_get_drvdata(dev); |
150 | ||
151 | return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev); | |
e55222ef GL |
152 | } |
153 | ||
96c75399 GL |
154 | static inline struct soc_camera_link *to_soc_camera_link( |
155 | const struct soc_camera_device *icd) | |
40e2e092 | 156 | { |
7dfff953 | 157 | return icd->link; |
40e2e092 | 158 | } |
e55222ef | 159 | |
96c75399 GL |
160 | static inline struct device *to_soc_camera_control( |
161 | const struct soc_camera_device *icd) | |
40e2e092 | 162 | { |
7dfff953 | 163 | return icd->control; |
40e2e092 | 164 | } |
e55222ef | 165 | |
96c75399 GL |
166 | static inline struct v4l2_subdev *soc_camera_to_subdev( |
167 | const struct soc_camera_device *icd) | |
c9c1f1c0 GL |
168 | { |
169 | struct device *control = to_soc_camera_control(icd); | |
170 | return dev_get_drvdata(control); | |
171 | } | |
172 | ||
40e2e092 GL |
173 | int soc_camera_host_register(struct soc_camera_host *ici); |
174 | void soc_camera_host_unregister(struct soc_camera_host *ici); | |
175 | ||
40e2e092 | 176 | const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc( |
c2786ad2 | 177 | struct soc_camera_device *icd, unsigned int fourcc); |
25c4d74e | 178 | |
c2786ad2 GL |
179 | /** |
180 | * struct soc_camera_format_xlate - match between host and sensor formats | |
760697be GL |
181 | * @code: code of a sensor provided format |
182 | * @host_fmt: host format after host translation from code | |
c2786ad2 GL |
183 | * |
184 | * Host and sensor translation structure. Used in table of host and sensor | |
185 | * formats matchings in soc_camera_device. A host can override the generic list | |
186 | * generation by implementing get_formats(), and use it for format checks and | |
187 | * format setup. | |
188 | */ | |
189 | struct soc_camera_format_xlate { | |
760697be GL |
190 | enum v4l2_mbus_pixelcode code; |
191 | const struct soc_mbus_pixelfmt *host_fmt; | |
c2786ad2 GL |
192 | }; |
193 | ||
a9bef518 GL |
194 | #define SOCAM_SENSE_PCLK_CHANGED (1 << 0) |
195 | ||
196 | /** | |
197 | * This struct can be attached to struct soc_camera_device by the host driver | |
198 | * to request sense from the camera, for example, when calling .set_fmt(). The | |
199 | * host then can check which flags are set and verify respective values if any. | |
200 | * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has | |
201 | * changed during this operation. After completion the host should detach sense. | |
202 | * | |
203 | * @flags ored SOCAM_SENSE_* flags | |
204 | * @master_clock if the host wants to be informed about pixel-clock | |
205 | * change, it better set master_clock. | |
206 | * @pixel_clock_max maximum pixel clock frequency supported by the host, | |
207 | * camera is not allowed to exceed this. | |
208 | * @pixel_clock if the camera driver changed pixel clock during this | |
209 | * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses | |
210 | * master_clock to calculate the new pixel-clock and | |
211 | * sets this field. | |
212 | */ | |
213 | struct soc_camera_sense { | |
214 | unsigned long flags; | |
215 | unsigned long master_clock; | |
216 | unsigned long pixel_clock_max; | |
217 | unsigned long pixel_clock; | |
218 | }; | |
219 | ||
d839fe17 GL |
220 | #define SOCAM_DATAWIDTH(x) BIT((x) - 1) |
221 | #define SOCAM_DATAWIDTH_4 SOCAM_DATAWIDTH(4) | |
222 | #define SOCAM_DATAWIDTH_8 SOCAM_DATAWIDTH(8) | |
223 | #define SOCAM_DATAWIDTH_9 SOCAM_DATAWIDTH(9) | |
224 | #define SOCAM_DATAWIDTH_10 SOCAM_DATAWIDTH(10) | |
225 | #define SOCAM_DATAWIDTH_15 SOCAM_DATAWIDTH(15) | |
226 | #define SOCAM_DATAWIDTH_16 SOCAM_DATAWIDTH(16) | |
042d8790 GL |
227 | |
228 | #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \ | |
229 | SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \ | |
230 | SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16) | |
ad5f2e85 | 231 | |
e26b3144 MN |
232 | static inline void soc_camera_limit_side(int *start, int *length, |
233 | unsigned int start_min, | |
6a6c8786 GL |
234 | unsigned int length_min, unsigned int length_max) |
235 | { | |
236 | if (*length < length_min) | |
237 | *length = length_min; | |
238 | else if (*length > length_max) | |
239 | *length = length_max; | |
240 | ||
241 | if (*start < start_min) | |
242 | *start = start_min; | |
243 | else if (*start > start_min + length_max - *length) | |
244 | *start = start_min + length_max - *length; | |
245 | } | |
246 | ||
32c69fcc GL |
247 | unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl, |
248 | unsigned long flags); | |
249 | unsigned long soc_camera_apply_board_flags(struct soc_camera_link *icl, | |
250 | const struct v4l2_mbus_config *cfg); | |
bd73b36f | 251 | |
4f9fb5ed MCC |
252 | /* This is only temporary here - until v4l2-subdev begins to link to video_device */ |
253 | #include <linux/i2c.h> | |
254 | static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client) | |
255 | { | |
256 | struct soc_camera_device *icd = client->dev.platform_data; | |
257 | return icd->vdev; | |
258 | } | |
259 | ||
8eb4476d GL |
260 | static inline struct soc_camera_device *soc_camera_from_vb2q(struct vb2_queue *vq) |
261 | { | |
262 | return container_of(vq, struct soc_camera_device, vb2_vidq); | |
263 | } | |
264 | ||
265 | static inline struct soc_camera_device *soc_camera_from_vbq(struct videobuf_queue *vq) | |
266 | { | |
267 | return container_of(vq, struct soc_camera_device, vb_vidq); | |
268 | } | |
269 | ||
592c2aba GL |
270 | void soc_camera_lock(struct vb2_queue *vq); |
271 | void soc_camera_unlock(struct vb2_queue *vq); | |
272 | ||
e55222ef | 273 | #endif |