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
15 #include <linux/bitops.h>
16 #include <linux/device.h>
17 #include <linux/mutex.h>
18 #include <linux/pm.h>
19 #include <linux/videodev2.h>
20 #include <media/videobuf-core.h>
21 #include <media/videobuf2-core.h>
22 #include <media/v4l2-ctrls.h>
23 #include <media/v4l2-device.h>
24
25 struct file;
26 struct soc_camera_link;
27
28 struct soc_camera_device {
29 struct list_head list; /* list of all registered devices */
30 struct soc_camera_link *link;
31 struct device *pdev; /* Platform device */
32 struct device *parent; /* Camera host device */
33 struct device *control; /* E.g., the i2c client */
34 s32 user_width;
35 s32 user_height;
36 u32 bytesperline; /* for padding, zero if unused */
37 u32 sizeimage;
38 enum v4l2_colorspace colorspace;
39 unsigned char iface; /* Host number */
40 unsigned char devnum; /* Device number per host */
41 struct soc_camera_sense *sense; /* See comment in struct definition */
42 struct video_device *vdev;
43 struct v4l2_ctrl_handler ctrl_handler;
44 const struct soc_camera_format_xlate *current_fmt;
45 struct soc_camera_format_xlate *user_formats;
46 int num_user_formats;
47 enum v4l2_field field; /* Preserve field over close() */
48 void *host_priv; /* Per-device host private data */
49 /* soc_camera.c private count. Only accessed with .video_lock held */
50 int use_count;
51 struct mutex video_lock; /* Protects device data */
52 struct file *streamer; /* stream owner */
53 union {
54 struct videobuf_queue vb_vidq;
55 struct vb2_queue vb2_vidq;
56 };
57 };
58
59 struct soc_camera_host {
60 struct v4l2_device v4l2_dev;
61 struct list_head list;
62 unsigned char nr; /* Host number */
63 void *priv;
64 const char *drv_name;
65 struct soc_camera_host_ops *ops;
66 };
67
68 struct soc_camera_host_ops {
69 struct module *owner;
70 int (*add)(struct soc_camera_device *);
71 void (*remove)(struct soc_camera_device *);
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 */
78 int (*get_formats)(struct soc_camera_device *, unsigned int,
79 struct soc_camera_format_xlate *);
80 void (*put_formats)(struct soc_camera_device *);
81 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
82 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
83 int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
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 *);
89 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
90 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
91 void (*init_videobuf)(struct videobuf_queue *,
92 struct soc_camera_device *);
93 int (*init_videobuf2)(struct vb2_queue *,
94 struct soc_camera_device *);
95 int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
96 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
97 int (*set_bus_param)(struct soc_camera_device *);
98 int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
99 int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
100 int (*enum_fsizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
101 unsigned int (*poll)(struct file *, poll_table *);
102 };
103
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
110 struct i2c_board_info;
111 struct regulator_bulk_data;
112
113 struct soc_camera_link {
114 /* Camera bus id, used to match a camera and a bus */
115 int bus_id;
116 /* Per camera SOCAM_SENSOR_* bus flags */
117 unsigned long flags;
118 int i2c_adapter_id;
119 struct i2c_board_info *board_info;
120 const char *module_name;
121 void *priv;
122
123 /* Optional regulators that have to be managed on power on/off events */
124 struct regulator_bulk_data *regulators;
125 int num_regulators;
126
127 /*
128 * For non-I2C devices platform has to provide methods to add a device
129 * to the system and to remove it
130 */
131 int (*add_device)(struct soc_camera_device *);
132 void (*del_device)(struct soc_camera_device *);
133 /* Optional callbacks to power on or off and reset the sensor */
134 int (*power)(struct device *, int);
135 int (*reset)(struct device *);
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 *);
143 void (*free_bus)(struct soc_camera_link *);
144 };
145
to_soc_camera_host(const struct device * dev)146 static inline struct soc_camera_host *to_soc_camera_host(
147 const struct device *dev)
148 {
149 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
150
151 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
152 }
153
to_soc_camera_link(const struct soc_camera_device * icd)154 static inline struct soc_camera_link *to_soc_camera_link(
155 const struct soc_camera_device *icd)
156 {
157 return icd->link;
158 }
159
to_soc_camera_control(const struct soc_camera_device * icd)160 static inline struct device *to_soc_camera_control(
161 const struct soc_camera_device *icd)
162 {
163 return icd->control;
164 }
165
soc_camera_to_subdev(const struct soc_camera_device * icd)166 static inline struct v4l2_subdev *soc_camera_to_subdev(
167 const struct soc_camera_device *icd)
168 {
169 struct device *control = to_soc_camera_control(icd);
170 return dev_get_drvdata(control);
171 }
172
173 int soc_camera_host_register(struct soc_camera_host *ici);
174 void soc_camera_host_unregister(struct soc_camera_host *ici);
175
176 const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
177 struct soc_camera_device *icd, unsigned int fourcc);
178
179 /**
180 * struct soc_camera_format_xlate - match between host and sensor formats
181 * @code: code of a sensor provided format
182 * @host_fmt: host format after host translation from code
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 {
190 enum v4l2_mbus_pixelcode code;
191 const struct soc_mbus_pixelfmt *host_fmt;
192 };
193
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
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)
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)
231
soc_camera_limit_side(int * start,int * length,unsigned int start_min,unsigned int length_min,unsigned int length_max)232 static inline void soc_camera_limit_side(int *start, int *length,
233 unsigned int start_min,
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
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);
251
252 /* This is only temporary here - until v4l2-subdev begins to link to video_device */
253 #include <linux/i2c.h>
soc_camera_i2c_to_vdev(const struct i2c_client * client)254 static inline struct video_device *soc_camera_i2c_to_vdev(const struct i2c_client *client)
255 {
256 struct v4l2_subdev *sd = i2c_get_clientdata(client);
257 struct soc_camera_device *icd = v4l2_get_subdev_hostdata(sd);
258 return icd ? icd->vdev : NULL;
259 }
260
soc_camera_i2c_to_link(const struct i2c_client * client)261 static inline struct soc_camera_link *soc_camera_i2c_to_link(const struct i2c_client *client)
262 {
263 return client->dev.platform_data;
264 }
265
soc_camera_vdev_to_subdev(const struct video_device * vdev)266 static inline struct v4l2_subdev *soc_camera_vdev_to_subdev(const struct video_device *vdev)
267 {
268 struct soc_camera_device *icd = dev_get_drvdata(vdev->parent);
269 return soc_camera_to_subdev(icd);
270 }
271
soc_camera_from_vb2q(const struct vb2_queue * vq)272 static inline struct soc_camera_device *soc_camera_from_vb2q(const struct vb2_queue *vq)
273 {
274 return container_of(vq, struct soc_camera_device, vb2_vidq);
275 }
276
soc_camera_from_vbq(const struct videobuf_queue * vq)277 static inline struct soc_camera_device *soc_camera_from_vbq(const struct videobuf_queue *vq)
278 {
279 return container_of(vq, struct soc_camera_device, vb_vidq);
280 }
281
soc_camera_grp_id(const struct soc_camera_device * icd)282 static inline u32 soc_camera_grp_id(const struct soc_camera_device *icd)
283 {
284 return (icd->iface << 8) | (icd->devnum + 1);
285 }
286
287 void soc_camera_lock(struct vb2_queue *vq);
288 void soc_camera_unlock(struct vb2_queue *vq);
289
290 #endif
291