Blame view
include/media/soc_camera.h
13.6 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> |
e09da11da
|
21 |
#include <media/v4l2-async.h> |
ee02da645
|
22 |
#include <media/v4l2-ctrls.h> |
979ea1ddf
|
23 |
#include <media/v4l2-device.h> |
e55222ef2
|
24 |
|
57bee29d6
|
25 |
struct file; |
25a348110
|
26 |
struct soc_camera_desc; |
e09da11da
|
27 |
struct soc_camera_async_client; |
57bee29d6
|
28 |
|
e55222ef2
|
29 |
struct soc_camera_device { |
d33b290a1
|
30 |
struct list_head list; /* list of all registered devices */ |
25a348110
|
31 |
struct soc_camera_desc *sdesc; |
979ea1ddf
|
32 |
struct device *pdev; /* Platform device */ |
7dfff9536
|
33 34 |
struct device *parent; /* Camera host device */ struct device *control; /* E.g., the i2c client */ |
6a6c87867
|
35 36 |
s32 user_width; s32 user_height; |
0e4c180d3
|
37 38 |
u32 bytesperline; /* for padding, zero if unused */ u32 sizeimage; |
760697bec
|
39 |
enum v4l2_colorspace colorspace; |
e55222ef2
|
40 41 |
unsigned char iface; /* Host number */ unsigned char devnum; /* Device number per host */ |
a9bef518c
|
42 |
struct soc_camera_sense *sense; /* See comment in struct definition */ |
e55222ef2
|
43 |
struct video_device *vdev; |
ee02da645
|
44 |
struct v4l2_ctrl_handler ctrl_handler; |
760697bec
|
45 |
const struct soc_camera_format_xlate *current_fmt; |
c2786ad27
|
46 47 |
struct soc_camera_format_xlate *user_formats; int num_user_formats; |
025c18a19
|
48 |
enum v4l2_field field; /* Preserve field over close() */ |
1c3bb7431
|
49 |
void *host_priv; /* Per-device host private data */ |
dd669e907
|
50 |
/* soc_camera.c private count. Only accessed with .host_lock held */ |
9dc4e48fb
|
51 |
int use_count; |
57bee29d6
|
52 |
struct file *streamer; /* stream owner */ |
9aea470b3
|
53 |
struct v4l2_clk *clk; |
e09da11da
|
54 55 56 |
/* Asynchronous subdevice management */ struct soc_camera_async_client *sasc; /* video buffer queue */ |
592c2aba2
|
57 58 59 60 |
union { struct videobuf_queue vb_vidq; struct vb2_queue vb2_vidq; }; |
e55222ef2
|
61 |
}; |
914f05c81
|
62 63 |
/* Host supports programmable stride */ #define SOCAM_HOST_CAP_STRIDE (1 << 0) |
e09da11da
|
64 65 66 67 68 69 70 71 72 73 |
enum soc_camera_subdev_role { SOCAM_SUBDEV_DATA_SOURCE = 1, SOCAM_SUBDEV_DATA_SINK, SOCAM_SUBDEV_DATA_PROCESSOR, }; struct soc_camera_async_subdev { struct v4l2_async_subdev asd; enum soc_camera_subdev_role role; }; |
e55222ef2
|
74 |
struct soc_camera_host { |
979ea1ddf
|
75 |
struct v4l2_device v4l2_dev; |
e55222ef2
|
76 |
struct list_head list; |
e09da11da
|
77 78 |
struct mutex host_lock; /* Main synchronisation lock */ struct mutex clk_lock; /* Protect pipeline modifications */ |
2f9a0c880
|
79 |
unsigned char nr; /* Host number */ |
914f05c81
|
80 |
u32 capabilities; |
f7f6ce2d0
|
81 |
struct soc_camera_device *icd; /* Currently attached client */ |
e55222ef2
|
82 |
void *priv; |
af128a102
|
83 |
const char *drv_name; |
b8d9904c3
|
84 |
struct soc_camera_host_ops *ops; |
e09da11da
|
85 |
struct v4l2_async_subdev **asd; /* Flat array, arranged in groups */ |
f687f3263
|
86 |
unsigned int *asd_sizes; /* 0-terminated array of asd group sizes */ |
b8d9904c3
|
87 88 89 90 |
}; struct soc_camera_host_ops { struct module *owner; |
e55222ef2
|
91 92 |
int (*add)(struct soc_camera_device *); void (*remove)(struct soc_camera_device *); |
eb569cf9d
|
93 94 |
int (*clock_start)(struct soc_camera_host *); void (*clock_stop)(struct soc_camera_host *); |
fa48984e3
|
95 96 97 98 99 100 |
/* * .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
|
101 |
int (*get_formats)(struct soc_camera_device *, unsigned int, |
c2786ad27
|
102 |
struct soc_camera_format_xlate *); |
fa48984e3
|
103 |
void (*put_formats)(struct soc_camera_device *); |
6a6c87867
|
104 105 |
int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *); int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *); |
4f996594c
|
106 |
int (*set_crop)(struct soc_camera_device *, const struct v4l2_crop *); |
3bfb41001
|
107 108 |
int (*get_selection)(struct soc_camera_device *, struct v4l2_selection *); int (*set_selection)(struct soc_camera_device *, struct v4l2_selection *); |
aee5c2f1f
|
109 110 111 112 |
/* * The difference to .set_crop() is, that .set_livecrop is not allowed * to change the output sizes */ |
4f996594c
|
113 |
int (*set_livecrop)(struct soc_camera_device *, const struct v4l2_crop *); |
09e231b35
|
114 |
int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *); |
d8fac217c
|
115 |
int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *); |
a034d1b76
|
116 |
void (*init_videobuf)(struct videobuf_queue *, |
092d39211
|
117 |
struct soc_camera_device *); |
592c2aba2
|
118 119 |
int (*init_videobuf2)(struct vb2_queue *, struct soc_camera_device *); |
57bee29d6
|
120 |
int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *); |
e55222ef2
|
121 |
int (*querycap)(struct soc_camera_host *, struct v4l2_capability *); |
8843d119e
|
122 |
int (*set_bus_param)(struct soc_camera_device *); |
c9f6ef698
|
123 124 |
int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *); int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *); |
ad3537b56
|
125 |
int (*enum_framesizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *); |
e55222ef2
|
126 127 |
unsigned int (*poll)(struct file *, poll_table *); }; |
bd73b36f0
|
128 129 130 131 132 |
#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
|
133 |
struct i2c_board_info; |
96e442c1b
|
134 |
struct regulator_bulk_data; |
0fd327bd0
|
135 |
|
25a348110
|
136 |
struct soc_camera_subdev_desc { |
bd73b36f0
|
137 138 |
/* Per camera SOCAM_SENSOR_* bus flags */ unsigned long flags; |
25a348110
|
139 140 141 |
/* sensor driver private platform data */ void *drv_priv; |
3fd7ceffd
|
142 |
|
40f075330
|
143 144 145 146 147 148 149 150 |
/* * Set unbalanced_power to true to deal with legacy drivers, failing to * balance their calls to subdevice's .s_power() method. clock_state is * then used internally by helper functions, it shouldn't be touched by * drivers or the platform code. */ bool unbalanced_power; unsigned long clock_state; |
25a348110
|
151 152 153 154 155 156 157 158 159 160 161 162 |
/* 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 *); |
d3f884a70
|
163 164 165 |
/* Optional regulators that have to be managed on power on/off events */ struct v4l2_subdev_platform_data sd_pdata; |
25a348110
|
166 167 168 169 170 171 172 173 |
}; 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
|
174 |
/* |
d33b290a1
|
175 176 |
* For non-I2C devices platform has to provide methods to add a device * to the system and to remove it |
c41debafc
|
177 |
*/ |
7dfff9536
|
178 179 |
int (*add_device)(struct soc_camera_device *); void (*del_device)(struct soc_camera_device *); |
25a348110
|
180 181 182 |
}; /* |
e09da11da
|
183 |
* Platform data for "soc-camera-pdrv" |
25a348110
|
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
* 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; |
40f075330
|
204 205 206 207 |
/* Set by platforms to handle misbehaving drivers */ bool unbalanced_power; /* Used by soc-camera helper functions */ unsigned long clock_state; |
810346631
|
208 209 210 |
/* Optional callbacks to power on or off and reset the sensor */ int (*power)(struct device *, int); int (*reset)(struct device *); |
28f59339f
|
211 212 213 214 215 216 217 |
/* * 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
|
218 |
void (*free_bus)(struct soc_camera_link *); |
25a348110
|
219 |
|
d3f884a70
|
220 221 222 223 224 |
/* Optional regulators that have to be managed on power on/off events */ struct regulator_bulk_data *regulators; int num_regulators; void *host_priv; |
25a348110
|
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
/* * 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
|
242 |
}; |
96c753995
|
243 244 |
static inline struct soc_camera_host *to_soc_camera_host( const struct device *dev) |
e55222ef2
|
245 |
{ |
979ea1ddf
|
246 247 248 |
struct v4l2_device *v4l2_dev = dev_get_drvdata(dev); return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev); |
e55222ef2
|
249 |
} |
25a348110
|
250 |
static inline struct soc_camera_desc *to_soc_camera_desc( |
96c753995
|
251 |
const struct soc_camera_device *icd) |
40e2e0927
|
252 |
{ |
25a348110
|
253 |
return icd->sdesc; |
40e2e0927
|
254 |
} |
e55222ef2
|
255 |
|
96c753995
|
256 257 |
static inline struct device *to_soc_camera_control( const struct soc_camera_device *icd) |
40e2e0927
|
258 |
{ |
7dfff9536
|
259 |
return icd->control; |
40e2e0927
|
260 |
} |
e55222ef2
|
261 |
|
96c753995
|
262 263 |
static inline struct v4l2_subdev *soc_camera_to_subdev( const struct soc_camera_device *icd) |
c9c1f1c0d
|
264 265 266 267 |
{ struct device *control = to_soc_camera_control(icd); return dev_get_drvdata(control); } |
40e2e0927
|
268 269 |
int soc_camera_host_register(struct soc_camera_host *ici); void soc_camera_host_unregister(struct soc_camera_host *ici); |
40e2e0927
|
270 |
const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc( |
c2786ad27
|
271 |
struct soc_camera_device *icd, unsigned int fourcc); |
25c4d74ea
|
272 |
|
c2786ad27
|
273 274 |
/** * struct soc_camera_format_xlate - match between host and sensor formats |
760697bec
|
275 276 |
* @code: code of a sensor provided format * @host_fmt: host format after host translation from code |
c2786ad27
|
277 278 279 280 281 282 283 |
* * 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 { |
27ffaeb0a
|
284 |
u32 code; |
760697bec
|
285 |
const struct soc_mbus_pixelfmt *host_fmt; |
c2786ad27
|
286 |
}; |
a9bef518c
|
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
#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
|
312 313 314 315 316 |
#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) |
7b88fc086
|
317 |
#define SOCAM_DATAWIDTH_12 SOCAM_DATAWIDTH(12) |
d839fe17a
|
318 319 |
#define SOCAM_DATAWIDTH_15 SOCAM_DATAWIDTH(15) #define SOCAM_DATAWIDTH_16 SOCAM_DATAWIDTH(16) |
7b88fc086
|
320 321 |
#define SOCAM_DATAWIDTH_18 SOCAM_DATAWIDTH(18) #define SOCAM_DATAWIDTH_24 SOCAM_DATAWIDTH(24) |
042d87900
|
322 323 324 |
#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \ SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \ |
7b88fc086
|
325 326 327 |
SOCAM_DATAWIDTH_12 | SOCAM_DATAWIDTH_15 | \ SOCAM_DATAWIDTH_16 | SOCAM_DATAWIDTH_18 | \ SOCAM_DATAWIDTH_24) |
ad5f2e859
|
328 |
|
e26b31449
|
329 330 |
static inline void soc_camera_limit_side(int *start, int *length, unsigned int start_min, |
6a6c87867
|
331 332 333 334 335 336 337 338 339 340 341 342 |
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
|
343 |
unsigned long soc_camera_apply_board_flags(struct soc_camera_subdev_desc *ssdd, |
32c69fcc7
|
344 |
const struct v4l2_mbus_config *cfg); |
bd73b36f0
|
345 |
|
e09da11da
|
346 |
int soc_camera_power_init(struct device *dev, struct soc_camera_subdev_desc *ssdd); |
9aea470b3
|
347 348 349 350 |
int soc_camera_power_on(struct device *dev, struct soc_camera_subdev_desc *ssdd, struct v4l2_clk *clk); int soc_camera_power_off(struct device *dev, struct soc_camera_subdev_desc *ssdd, struct v4l2_clk *clk); |
4ec10bacd
|
351 352 |
static inline int soc_camera_set_power(struct device *dev, |
9aea470b3
|
353 |
struct soc_camera_subdev_desc *ssdd, struct v4l2_clk *clk, bool on) |
4ec10bacd
|
354 |
{ |
9aea470b3
|
355 356 |
return on ? soc_camera_power_on(dev, ssdd, clk) : soc_camera_power_off(dev, ssdd, clk); |
4ec10bacd
|
357 |
} |
4f9fb5ed0
|
358 359 |
/* This is only temporary here - until v4l2-subdev begins to link to video_device */ #include <linux/i2c.h> |
14178aa57
|
360 |
static inline struct video_device *soc_camera_i2c_to_vdev(const struct i2c_client *client) |
4f9fb5ed0
|
361 |
{ |
2f0babb7e
|
362 |
struct v4l2_subdev *sd = i2c_get_clientdata(client); |
4c0b036db
|
363 |
struct soc_camera_device *icd = v4l2_get_subdev_hostdata(sd); |
14178aa57
|
364 |
return icd ? icd->vdev : NULL; |
4f9fb5ed0
|
365 |
} |
25a348110
|
366 |
static inline struct soc_camera_subdev_desc *soc_camera_i2c_to_desc(const struct i2c_client *client) |
14178aa57
|
367 |
{ |
2f0babb7e
|
368 |
return client->dev.platform_data; |
14178aa57
|
369 |
} |
14381c267
|
370 |
static inline struct v4l2_subdev *soc_camera_vdev_to_subdev(struct video_device *vdev) |
14178aa57
|
371 |
{ |
14381c267
|
372 |
struct soc_camera_device *icd = video_get_drvdata(vdev); |
14178aa57
|
373 374 |
return soc_camera_to_subdev(icd); } |
14178aa57
|
375 |
static inline struct soc_camera_device *soc_camera_from_vb2q(const struct vb2_queue *vq) |
8eb4476d4
|
376 377 378 |
{ return container_of(vq, struct soc_camera_device, vb2_vidq); } |
14178aa57
|
379 |
static inline struct soc_camera_device *soc_camera_from_vbq(const struct videobuf_queue *vq) |
8eb4476d4
|
380 381 382 |
{ return container_of(vq, struct soc_camera_device, vb_vidq); } |
4c0b036db
|
383 384 385 386 |
static inline u32 soc_camera_grp_id(const struct soc_camera_device *icd) { return (icd->iface << 8) | (icd->devnum + 1); } |
592c2aba2
|
387 388 |
void soc_camera_lock(struct vb2_queue *vq); void soc_camera_unlock(struct vb2_queue *vq); |
e55222ef2
|
389 |
#endif |