V4L/DVB (12512): ov772x: implement a band-stop filter support
[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 */
e55222ef
GL
25 unsigned short width; /* Current window */
26 unsigned short height; /* sizes */
27 unsigned short x_min; /* Camera capabilities */
28 unsigned short y_min;
29 unsigned short x_current; /* Current window location */
30 unsigned short y_current;
31 unsigned short width_min;
32 unsigned short width_max;
33 unsigned short height_min;
34 unsigned short height_max;
35 unsigned short y_skip_top; /* Lines to skip at the top */
36 unsigned short gain;
37 unsigned short exposure;
38 unsigned char iface; /* Host number */
39 unsigned char devnum; /* Device number per host */
ad5f2e85 40 unsigned char buswidth; /* See comment in .c */
a9bef518 41 struct soc_camera_sense *sense; /* See comment in struct definition */
e55222ef
GL
42 struct soc_camera_ops *ops;
43 struct video_device *vdev;
44 const struct soc_camera_data_format *current_fmt;
26f1b942
GL
45 const struct soc_camera_data_format *formats;
46 int num_formats;
c2786ad2
GL
47 struct soc_camera_format_xlate *user_formats;
48 int num_user_formats;
025c18a1 49 enum v4l2_field field; /* Preserve field over close() */
1c3bb743
GL
50 void *host_priv; /* Per-device host private data */
51 /* soc_camera.c private count. Only accessed with .video_lock held */
9dc4e48f 52 int use_count;
1c3bb743 53 struct mutex video_lock; /* Protects device data */
e55222ef
GL
54};
55
56struct soc_camera_file {
57 struct soc_camera_device *icd;
58 struct videobuf_queue vb_vidq;
59};
60
61struct soc_camera_host {
979ea1dd 62 struct v4l2_device v4l2_dev;
e55222ef 63 struct list_head list;
e55222ef 64 unsigned char nr; /* Host number */
e55222ef 65 void *priv;
af128a10 66 const char *drv_name;
b8d9904c
GL
67 struct soc_camera_host_ops *ops;
68};
69
70struct soc_camera_host_ops {
71 struct module *owner;
e55222ef
GL
72 int (*add)(struct soc_camera_device *);
73 void (*remove)(struct soc_camera_device *);
c2786ad2 74 int (*suspend)(struct soc_camera_device *, pm_message_t);
2e521061 75 int (*resume)(struct soc_camera_device *);
c2786ad2
GL
76 int (*get_formats)(struct soc_camera_device *, int,
77 struct soc_camera_format_xlate *);
09e231b3
GL
78 int (*set_crop)(struct soc_camera_device *, struct v4l2_rect *);
79 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
d8fac217 80 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
a034d1b7 81 void (*init_videobuf)(struct videobuf_queue *,
092d3921 82 struct soc_camera_device *);
e55222ef
GL
83 int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
84 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
ad5f2e85 85 int (*set_bus_param)(struct soc_camera_device *, __u32);
e55222ef
GL
86 unsigned int (*poll)(struct file *, poll_table *);
87};
88
bd73b36f
GL
89#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
90#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
91#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
92#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
93#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
94
0fd327bd
GL
95struct i2c_board_info;
96
e55222ef
GL
97struct soc_camera_link {
98 /* Camera bus id, used to match a camera and a bus */
99 int bus_id;
bd73b36f
GL
100 /* Per camera SOCAM_SENSOR_* bus flags */
101 unsigned long flags;
0fd327bd
GL
102 int i2c_adapter_id;
103 struct i2c_board_info *board_info;
104 const char *module_name;
c41debaf
GL
105 /*
106 * For non-I2C devices platform platform has to provide methods to
107 * add a device to the system and to remove
108 */
109 int (*add_device)(struct soc_camera_link *, struct device *);
110 void (*del_device)(struct soc_camera_link *);
81034663
SH
111 /* Optional callbacks to power on or off and reset the sensor */
112 int (*power)(struct device *, int);
113 int (*reset)(struct device *);
28f59339
SH
114 /*
115 * some platforms may support different data widths than the sensors
116 * native ones due to different data line routing. Let the board code
117 * overwrite the width flags.
118 */
119 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
120 unsigned long (*query_bus_param)(struct soc_camera_link *);
594bb46d 121 void (*free_bus)(struct soc_camera_link *);
e55222ef
GL
122};
123
124static inline struct soc_camera_device *to_soc_camera_dev(struct device *dev)
125{
126 return container_of(dev, struct soc_camera_device, dev);
127}
128
129static inline struct soc_camera_host *to_soc_camera_host(struct device *dev)
130{
979ea1dd
GL
131 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
132
133 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
e55222ef
GL
134}
135
40e2e092
GL
136static inline struct soc_camera_link *to_soc_camera_link(struct soc_camera_device *icd)
137{
138 return icd->dev.platform_data;
139}
e55222ef 140
40e2e092
GL
141static inline struct device *to_soc_camera_control(struct soc_camera_device *icd)
142{
143 return dev_get_drvdata(&icd->dev);
144}
e55222ef 145
40e2e092
GL
146int soc_camera_host_register(struct soc_camera_host *ici);
147void soc_camera_host_unregister(struct soc_camera_host *ici);
148
40e2e092 149const struct soc_camera_data_format *soc_camera_format_by_fourcc(
25c4d74e 150 struct soc_camera_device *icd, unsigned int fourcc);
40e2e092 151const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
c2786ad2 152 struct soc_camera_device *icd, unsigned int fourcc);
25c4d74e 153
e55222ef 154struct soc_camera_data_format {
af128a10 155 const char *name;
e55222ef
GL
156 unsigned int depth;
157 __u32 fourcc;
158 enum v4l2_colorspace colorspace;
159};
160
c2786ad2
GL
161/**
162 * struct soc_camera_format_xlate - match between host and sensor formats
163 * @cam_fmt: sensor format provided by the sensor
164 * @host_fmt: host format after host translation from cam_fmt
165 * @buswidth: bus width for this format
166 *
167 * Host and sensor translation structure. Used in table of host and sensor
168 * formats matchings in soc_camera_device. A host can override the generic list
169 * generation by implementing get_formats(), and use it for format checks and
170 * format setup.
171 */
172struct soc_camera_format_xlate {
173 const struct soc_camera_data_format *cam_fmt;
174 const struct soc_camera_data_format *host_fmt;
175 unsigned char buswidth;
176};
177
e55222ef 178struct soc_camera_ops {
2e521061
RJ
179 int (*suspend)(struct soc_camera_device *, pm_message_t state);
180 int (*resume)(struct soc_camera_device *);
e55222ef
GL
181 int (*init)(struct soc_camera_device *);
182 int (*release)(struct soc_camera_device *);
09e231b3 183 int (*set_crop)(struct soc_camera_device *, struct v4l2_rect *);
ad5f2e85
GL
184 unsigned long (*query_bus_param)(struct soc_camera_device *);
185 int (*set_bus_param)(struct soc_camera_device *, unsigned long);
e55222ef 186 int (*get_chip_id)(struct soc_camera_device *,
aecde8b5 187 struct v4l2_dbg_chip_ident *);
513791ab 188 int (*set_std)(struct soc_camera_device *, v4l2_std_id *);
34d359db 189 int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
e55222ef
GL
190 const struct v4l2_queryctrl *controls;
191 int num_controls;
e55222ef
GL
192};
193
a9bef518
GL
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 */
213struct 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
e55222ef
GL
220static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
221 struct soc_camera_ops *ops, int id)
222{
223 int i;
224
225 for (i = 0; i < ops->num_controls; i++)
226 if (ops->controls[i].id == id)
227 return &ops->controls[i];
228
229 return NULL;
230}
231
ad5f2e85
GL
232#define SOCAM_MASTER (1 << 0)
233#define SOCAM_SLAVE (1 << 1)
234#define SOCAM_HSYNC_ACTIVE_HIGH (1 << 2)
235#define SOCAM_HSYNC_ACTIVE_LOW (1 << 3)
236#define SOCAM_VSYNC_ACTIVE_HIGH (1 << 4)
237#define SOCAM_VSYNC_ACTIVE_LOW (1 << 5)
042d8790
GL
238#define SOCAM_DATAWIDTH_4 (1 << 6)
239#define SOCAM_DATAWIDTH_8 (1 << 7)
240#define SOCAM_DATAWIDTH_9 (1 << 8)
241#define SOCAM_DATAWIDTH_10 (1 << 9)
242#define SOCAM_DATAWIDTH_15 (1 << 10)
243#define SOCAM_DATAWIDTH_16 (1 << 11)
244#define SOCAM_PCLK_SAMPLE_RISING (1 << 12)
245#define SOCAM_PCLK_SAMPLE_FALLING (1 << 13)
246#define SOCAM_DATA_ACTIVE_HIGH (1 << 14)
247#define SOCAM_DATA_ACTIVE_LOW (1 << 15)
248
249#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
250 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
251 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
ad5f2e85
GL
252
253static inline unsigned long soc_camera_bus_param_compatible(
254 unsigned long camera_flags, unsigned long bus_flags)
255{
f7f41483 256 unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
ad5f2e85
GL
257
258 common_flags = camera_flags & bus_flags;
259
260 hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
261 vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
262 pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
f7f41483
GL
263 data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
264 mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
265 buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
ad5f2e85 266
f7f41483
GL
267 return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
268 common_flags;
ad5f2e85 269}
e55222ef 270
bd73b36f
GL
271extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
272 unsigned long flags);
273
e55222ef 274#endif
This page took 0.175626 seconds and 5 git commands to generate.