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