V4L/DVB (12535): soc-camera: remove .init() and .release() methods from struct soc_ca...
[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
1c3bb743
GL
15#include <linux/mutex.h>
16#include <linux/pm.h>
e55222ef 17#include <linux/videodev2.h>
092d3921 18#include <media/videobuf-core.h>
979ea1dd 19#include <media/v4l2-device.h>
e55222ef
GL
20
21struct soc_camera_device {
22 struct list_head list;
23 struct device dev;
979ea1dd 24 struct device *pdev; /* Platform device */
6a6c8786
GL
25 s32 user_width;
26 s32 user_height;
e55222ef 27 unsigned short width_min;
e55222ef 28 unsigned short height_min;
e55222ef
GL
29 unsigned short y_skip_top; /* Lines to skip at the top */
30 unsigned short gain;
31 unsigned short exposure;
32 unsigned char iface; /* Host number */
33 unsigned char devnum; /* Device number per host */
ad5f2e85 34 unsigned char buswidth; /* See comment in .c */
a9bef518 35 struct soc_camera_sense *sense; /* See comment in struct definition */
e55222ef
GL
36 struct soc_camera_ops *ops;
37 struct video_device *vdev;
38 const struct soc_camera_data_format *current_fmt;
26f1b942
GL
39 const struct soc_camera_data_format *formats;
40 int num_formats;
c2786ad2
GL
41 struct soc_camera_format_xlate *user_formats;
42 int num_user_formats;
025c18a1 43 enum v4l2_field field; /* Preserve field over close() */
1c3bb743
GL
44 void *host_priv; /* Per-device host private data */
45 /* soc_camera.c private count. Only accessed with .video_lock held */
9dc4e48f 46 int use_count;
1c3bb743 47 struct mutex video_lock; /* Protects device data */
e55222ef
GL
48};
49
50struct soc_camera_file {
51 struct soc_camera_device *icd;
52 struct videobuf_queue vb_vidq;
53};
54
55struct soc_camera_host {
979ea1dd 56 struct v4l2_device v4l2_dev;
e55222ef 57 struct list_head list;
e55222ef 58 unsigned char nr; /* Host number */
e55222ef 59 void *priv;
af128a10 60 const char *drv_name;
b8d9904c
GL
61 struct soc_camera_host_ops *ops;
62};
63
64struct soc_camera_host_ops {
65 struct module *owner;
e55222ef
GL
66 int (*add)(struct soc_camera_device *);
67 void (*remove)(struct soc_camera_device *);
c2786ad2 68 int (*suspend)(struct soc_camera_device *, pm_message_t);
2e521061 69 int (*resume)(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 */
c2786ad2
GL
76 int (*get_formats)(struct soc_camera_device *, int,
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 *);
09e231b3 82 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
d8fac217 83 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
a034d1b7 84 void (*init_videobuf)(struct videobuf_queue *,
092d3921 85 struct soc_camera_device *);
e55222ef
GL
86 int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
87 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
ad5f2e85 88 int (*set_bus_param)(struct soc_camera_device *, __u32);
2840d249
GL
89 int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
90 int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
e55222ef 91 unsigned int (*poll)(struct file *, poll_table *);
2840d249
GL
92 const struct v4l2_queryctrl *controls;
93 int num_controls;
e55222ef
GL
94};
95
bd73b36f
GL
96#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
97#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
98#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
99#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
100#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
101
0fd327bd
GL
102struct i2c_board_info;
103
e55222ef
GL
104struct soc_camera_link {
105 /* Camera bus id, used to match a camera and a bus */
106 int bus_id;
bd73b36f
GL
107 /* Per camera SOCAM_SENSOR_* bus flags */
108 unsigned long flags;
0fd327bd
GL
109 int i2c_adapter_id;
110 struct i2c_board_info *board_info;
111 const char *module_name;
c41debaf
GL
112 /*
113 * For non-I2C devices platform platform has to provide methods to
114 * add a device to the system and to remove
115 */
116 int (*add_device)(struct soc_camera_link *, struct device *);
117 void (*del_device)(struct soc_camera_link *);
81034663
SH
118 /* Optional callbacks to power on or off and reset the sensor */
119 int (*power)(struct device *, int);
120 int (*reset)(struct device *);
28f59339
SH
121 /*
122 * some platforms may support different data widths than the sensors
123 * native ones due to different data line routing. Let the board code
124 * overwrite the width flags.
125 */
126 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
127 unsigned long (*query_bus_param)(struct soc_camera_link *);
594bb46d 128 void (*free_bus)(struct soc_camera_link *);
e55222ef
GL
129};
130
c9c1f1c0 131static inline struct soc_camera_device *to_soc_camera_dev(const struct device *dev)
e55222ef
GL
132{
133 return container_of(dev, struct soc_camera_device, dev);
134}
135
c9c1f1c0 136static inline struct soc_camera_host *to_soc_camera_host(const struct device *dev)
e55222ef 137{
979ea1dd
GL
138 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
139
140 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
e55222ef
GL
141}
142
c9c1f1c0 143static inline struct soc_camera_link *to_soc_camera_link(const struct soc_camera_device *icd)
40e2e092
GL
144{
145 return icd->dev.platform_data;
146}
e55222ef 147
c9c1f1c0 148static inline struct device *to_soc_camera_control(const struct soc_camera_device *icd)
40e2e092
GL
149{
150 return dev_get_drvdata(&icd->dev);
151}
e55222ef 152
c9c1f1c0
GL
153static inline struct v4l2_subdev *soc_camera_to_subdev(const struct soc_camera_device *icd)
154{
155 struct device *control = to_soc_camera_control(icd);
156 return dev_get_drvdata(control);
157}
158
40e2e092
GL
159int soc_camera_host_register(struct soc_camera_host *ici);
160void soc_camera_host_unregister(struct soc_camera_host *ici);
161
40e2e092 162const struct soc_camera_data_format *soc_camera_format_by_fourcc(
25c4d74e 163 struct soc_camera_device *icd, unsigned int fourcc);
40e2e092 164const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
c2786ad2 165 struct soc_camera_device *icd, unsigned int fourcc);
25c4d74e 166
e55222ef 167struct soc_camera_data_format {
af128a10 168 const char *name;
e55222ef
GL
169 unsigned int depth;
170 __u32 fourcc;
171 enum v4l2_colorspace colorspace;
172};
173
c2786ad2
GL
174/**
175 * struct soc_camera_format_xlate - match between host and sensor formats
176 * @cam_fmt: sensor format provided by the sensor
177 * @host_fmt: host format after host translation from cam_fmt
178 * @buswidth: bus width for this format
179 *
180 * Host and sensor translation structure. Used in table of host and sensor
181 * formats matchings in soc_camera_device. A host can override the generic list
182 * generation by implementing get_formats(), and use it for format checks and
183 * format setup.
184 */
185struct soc_camera_format_xlate {
186 const struct soc_camera_data_format *cam_fmt;
187 const struct soc_camera_data_format *host_fmt;
188 unsigned char buswidth;
189};
190
e55222ef 191struct soc_camera_ops {
2e521061
RJ
192 int (*suspend)(struct soc_camera_device *, pm_message_t state);
193 int (*resume)(struct soc_camera_device *);
ad5f2e85
GL
194 unsigned long (*query_bus_param)(struct soc_camera_device *);
195 int (*set_bus_param)(struct soc_camera_device *, unsigned long);
34d359db 196 int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
e55222ef
GL
197 const struct v4l2_queryctrl *controls;
198 int num_controls;
e55222ef
GL
199};
200
a9bef518
GL
201#define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
202
203/**
204 * This struct can be attached to struct soc_camera_device by the host driver
205 * to request sense from the camera, for example, when calling .set_fmt(). The
206 * host then can check which flags are set and verify respective values if any.
207 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
208 * changed during this operation. After completion the host should detach sense.
209 *
210 * @flags ored SOCAM_SENSE_* flags
211 * @master_clock if the host wants to be informed about pixel-clock
212 * change, it better set master_clock.
213 * @pixel_clock_max maximum pixel clock frequency supported by the host,
214 * camera is not allowed to exceed this.
215 * @pixel_clock if the camera driver changed pixel clock during this
216 * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
217 * master_clock to calculate the new pixel-clock and
218 * sets this field.
219 */
220struct soc_camera_sense {
221 unsigned long flags;
222 unsigned long master_clock;
223 unsigned long pixel_clock_max;
224 unsigned long pixel_clock;
225};
226
e55222ef
GL
227static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
228 struct soc_camera_ops *ops, int id)
229{
230 int i;
231
232 for (i = 0; i < ops->num_controls; i++)
233 if (ops->controls[i].id == id)
234 return &ops->controls[i];
235
236 return NULL;
237}
238
ad5f2e85
GL
239#define SOCAM_MASTER (1 << 0)
240#define SOCAM_SLAVE (1 << 1)
241#define SOCAM_HSYNC_ACTIVE_HIGH (1 << 2)
242#define SOCAM_HSYNC_ACTIVE_LOW (1 << 3)
243#define SOCAM_VSYNC_ACTIVE_HIGH (1 << 4)
244#define SOCAM_VSYNC_ACTIVE_LOW (1 << 5)
042d8790
GL
245#define SOCAM_DATAWIDTH_4 (1 << 6)
246#define SOCAM_DATAWIDTH_8 (1 << 7)
247#define SOCAM_DATAWIDTH_9 (1 << 8)
248#define SOCAM_DATAWIDTH_10 (1 << 9)
249#define SOCAM_DATAWIDTH_15 (1 << 10)
250#define SOCAM_DATAWIDTH_16 (1 << 11)
251#define SOCAM_PCLK_SAMPLE_RISING (1 << 12)
252#define SOCAM_PCLK_SAMPLE_FALLING (1 << 13)
253#define SOCAM_DATA_ACTIVE_HIGH (1 << 14)
254#define SOCAM_DATA_ACTIVE_LOW (1 << 15)
255
256#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
257 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
258 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
ad5f2e85
GL
259
260static inline unsigned long soc_camera_bus_param_compatible(
261 unsigned long camera_flags, unsigned long bus_flags)
262{
f7f41483 263 unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
ad5f2e85
GL
264
265 common_flags = camera_flags & bus_flags;
266
267 hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
268 vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
269 pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
f7f41483
GL
270 data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
271 mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
272 buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
ad5f2e85 273
f7f41483
GL
274 return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
275 common_flags;
ad5f2e85 276}
e55222ef 277
6a6c8786
GL
278static inline void soc_camera_limit_side(unsigned int *start,
279 unsigned int *length, unsigned int start_min,
280 unsigned int length_min, unsigned int length_max)
281{
282 if (*length < length_min)
283 *length = length_min;
284 else if (*length > length_max)
285 *length = length_max;
286
287 if (*start < start_min)
288 *start = start_min;
289 else if (*start > start_min + length_max - *length)
290 *start = start_min + length_max - *length;
291}
292
bd73b36f
GL
293extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
294 unsigned long flags);
295
e55222ef 296#endif
This page took 0.177513 seconds and 5 git commands to generate.