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