2 * camera image capture (abstract) bus driver header
4 * Copyright (C) 2006, Sascha Hauer, Pengutronix
5 * Copyright (C) 2008, Guennadi Liakhovetski <kernel@pengutronix.de>
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.
15 #include <linux/device.h>
16 #include <linux/mutex.h>
18 #include <linux/videodev2.h>
19 #include <media/videobuf-core.h>
20 #include <media/videobuf2-core.h>
21 #include <media/v4l2-device.h>
23 extern struct bus_type soc_camera_bus_type
;
27 struct soc_camera_device
{
28 struct list_head list
;
30 struct device
*pdev
; /* Platform device */
33 u32 bytesperline
; /* for padding, zero if unused */
35 enum v4l2_colorspace colorspace
;
36 unsigned char iface
; /* Host number */
37 unsigned char devnum
; /* Device number per host */
38 struct soc_camera_sense
*sense
; /* See comment in struct definition */
39 struct soc_camera_ops
*ops
;
40 struct video_device
*vdev
;
41 const struct soc_camera_format_xlate
*current_fmt
;
42 struct soc_camera_format_xlate
*user_formats
;
44 enum v4l2_field field
; /* Preserve field over close() */
45 void *host_priv
; /* Per-device host private data */
46 /* soc_camera.c private count. Only accessed with .video_lock held */
48 struct mutex video_lock
; /* Protects device data */
49 struct file
*streamer
; /* stream owner */
51 struct videobuf_queue vb_vidq
;
52 struct vb2_queue vb2_vidq
;
56 struct soc_camera_host
{
57 struct v4l2_device v4l2_dev
;
58 struct list_head list
;
59 unsigned char nr
; /* Host number */
62 struct soc_camera_host_ops
*ops
;
65 struct soc_camera_host_ops
{
67 int (*add
)(struct soc_camera_device
*);
68 void (*remove
)(struct soc_camera_device
*);
69 int (*suspend
)(struct soc_camera_device
*, pm_message_t
);
70 int (*resume
)(struct soc_camera_device
*);
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.
77 int (*get_formats
)(struct soc_camera_device
*, unsigned int,
78 struct soc_camera_format_xlate
*);
79 void (*put_formats
)(struct soc_camera_device
*);
80 int (*cropcap
)(struct soc_camera_device
*, struct v4l2_cropcap
*);
81 int (*get_crop
)(struct soc_camera_device
*, struct v4l2_crop
*);
82 int (*set_crop
)(struct soc_camera_device
*, struct v4l2_crop
*);
84 * The difference to .set_crop() is, that .set_livecrop is not allowed
85 * to change the output sizes
87 int (*set_livecrop
)(struct soc_camera_device
*, struct v4l2_crop
*);
88 int (*set_fmt
)(struct soc_camera_device
*, struct v4l2_format
*);
89 int (*try_fmt
)(struct soc_camera_device
*, struct v4l2_format
*);
90 void (*init_videobuf
)(struct videobuf_queue
*,
91 struct soc_camera_device
*);
92 int (*init_videobuf2
)(struct vb2_queue
*,
93 struct soc_camera_device
*);
94 int (*reqbufs
)(struct soc_camera_device
*, struct v4l2_requestbuffers
*);
95 int (*querycap
)(struct soc_camera_host
*, struct v4l2_capability
*);
96 int (*set_bus_param
)(struct soc_camera_device
*, __u32
);
97 int (*get_ctrl
)(struct soc_camera_device
*, struct v4l2_control
*);
98 int (*set_ctrl
)(struct soc_camera_device
*, struct v4l2_control
*);
99 int (*get_parm
)(struct soc_camera_device
*, struct v4l2_streamparm
*);
100 int (*set_parm
)(struct soc_camera_device
*, struct v4l2_streamparm
*);
101 int (*enum_fsizes
)(struct soc_camera_device
*, struct v4l2_frmsizeenum
*);
102 unsigned int (*poll
)(struct file
*, poll_table
*);
103 const struct v4l2_queryctrl
*controls
;
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)
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)
119 struct i2c_board_info
;
120 struct regulator_bulk_data
;
122 struct soc_camera_link
{
123 /* Camera bus id, used to match a camera and a bus */
125 /* Per camera SOCAM_SENSOR_* bus flags */
128 struct i2c_board_info
*board_info
;
129 const char *module_name
;
132 /* Optional regulators that have to be managed on power on/off events */
133 struct regulator_bulk_data
*regulators
;
137 * For non-I2C devices platform platform has to provide methods to
138 * add a device to the system and to remove
140 int (*add_device
)(struct soc_camera_link
*, struct device
*);
141 void (*del_device
)(struct soc_camera_link
*);
142 /* Optional callbacks to power on or off and reset the sensor */
143 int (*power
)(struct device
*, int);
144 int (*reset
)(struct device
*);
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.
150 int (*set_bus_param
)(struct soc_camera_link
*, unsigned long flags
);
151 unsigned long (*query_bus_param
)(struct soc_camera_link
*);
152 void (*free_bus
)(struct soc_camera_link
*);
155 static inline struct soc_camera_device
*to_soc_camera_dev(
156 const struct device
*dev
)
158 return container_of(dev
, struct soc_camera_device
, dev
);
161 static inline struct soc_camera_host
*to_soc_camera_host(
162 const struct device
*dev
)
164 struct v4l2_device
*v4l2_dev
= dev_get_drvdata(dev
);
166 return container_of(v4l2_dev
, struct soc_camera_host
, v4l2_dev
);
169 static inline struct soc_camera_link
*to_soc_camera_link(
170 const struct soc_camera_device
*icd
)
172 return icd
->dev
.platform_data
;
175 static inline struct device
*to_soc_camera_control(
176 const struct soc_camera_device
*icd
)
178 return dev_get_drvdata(&icd
->dev
);
181 static inline struct v4l2_subdev
*soc_camera_to_subdev(
182 const struct soc_camera_device
*icd
)
184 struct device
*control
= to_soc_camera_control(icd
);
185 return dev_get_drvdata(control
);
188 int soc_camera_host_register(struct soc_camera_host
*ici
);
189 void soc_camera_host_unregister(struct soc_camera_host
*ici
);
191 const struct soc_camera_format_xlate
*soc_camera_xlate_by_fourcc(
192 struct soc_camera_device
*icd
, unsigned int fourcc
);
195 * struct soc_camera_format_xlate - match between host and sensor formats
196 * @code: code of a sensor provided format
197 * @host_fmt: host format after host translation from code
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
204 struct soc_camera_format_xlate
{
205 enum v4l2_mbus_pixelcode code
;
206 const struct soc_mbus_pixelfmt
*host_fmt
;
209 struct soc_camera_ops
{
210 int (*suspend
)(struct soc_camera_device
*, pm_message_t state
);
211 int (*resume
)(struct soc_camera_device
*);
212 unsigned long (*query_bus_param
)(struct soc_camera_device
*);
213 int (*set_bus_param
)(struct soc_camera_device
*, unsigned long);
214 int (*enum_input
)(struct soc_camera_device
*, struct v4l2_input
*);
215 const struct v4l2_queryctrl
*controls
;
219 #define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
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.
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
238 struct soc_camera_sense
{
240 unsigned long master_clock
;
241 unsigned long pixel_clock_max
;
242 unsigned long pixel_clock
;
245 static inline struct v4l2_queryctrl
const *soc_camera_find_qctrl(
246 struct soc_camera_ops
*ops
, int id
)
250 for (i
= 0; i
< ops
->num_controls
; i
++)
251 if (ops
->controls
[i
].id
== id
)
252 return &ops
->controls
[i
];
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)
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)
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)
278 static inline unsigned long soc_camera_bus_param_compatible(
279 unsigned long camera_flags
, unsigned long bus_flags
)
281 unsigned long common_flags
, hsync
, vsync
, pclk
, data
, buswidth
, mode
;
284 common_flags
= camera_flags
& bus_flags
;
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
);
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
;
292 mipi
= common_flags
& SOCAM_MIPI
;
294 return ((!hsync
|| !vsync
|| !pclk
|| !data
|| !mode
|| !buswidth
) && !mipi
) ? 0 :
298 static inline void soc_camera_limit_side(int *start
, int *length
,
299 unsigned int start_min
,
300 unsigned int length_min
, unsigned int length_max
)
302 if (*length
< length_min
)
303 *length
= length_min
;
304 else if (*length
> length_max
)
305 *length
= length_max
;
307 if (*start
< start_min
)
309 else if (*start
> start_min
+ length_max
- *length
)
310 *start
= start_min
+ length_max
- *length
;
313 extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link
*icl
,
314 unsigned long flags
);
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
)
320 struct soc_camera_device
*icd
= client
->dev
.platform_data
;
324 static inline struct soc_camera_device
*soc_camera_from_vb2q(struct vb2_queue
*vq
)
326 return container_of(vq
, struct soc_camera_device
, vb2_vidq
);
329 static inline struct soc_camera_device
*soc_camera_from_vbq(struct videobuf_queue
*vq
)
331 return container_of(vq
, struct soc_camera_device
, vb_vidq
);
334 void soc_camera_lock(struct vb2_queue
*vq
);
335 void soc_camera_unlock(struct vb2_queue
*vq
);