]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/media/soc_camera.h
V4L/DVB (11022): zoran/bt819: use new notify functionality.
[net-next-2.6.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>
e55222ef
GL
19
20struct soc_camera_device {
21 struct list_head list;
22 struct device dev;
23 struct device *control;
24 unsigned short width; /* Current window */
25 unsigned short height; /* sizes */
26 unsigned short x_min; /* Camera capabilities */
27 unsigned short y_min;
28 unsigned short x_current; /* Current window location */
29 unsigned short y_current;
30 unsigned short width_min;
31 unsigned short width_max;
32 unsigned short height_min;
33 unsigned short height_max;
34 unsigned short y_skip_top; /* Lines to skip at the top */
35 unsigned short gain;
36 unsigned short exposure;
37 unsigned char iface; /* Host number */
38 unsigned char devnum; /* Device number per host */
ad5f2e85 39 unsigned char buswidth; /* See comment in .c */
a9bef518 40 struct soc_camera_sense *sense; /* See comment in struct definition */
e55222ef
GL
41 struct soc_camera_ops *ops;
42 struct video_device *vdev;
43 const struct soc_camera_data_format *current_fmt;
26f1b942
GL
44 const struct soc_camera_data_format *formats;
45 int num_formats;
c2786ad2
GL
46 struct soc_camera_format_xlate *user_formats;
47 int num_user_formats;
e55222ef 48 struct module *owner;
1c3bb743
GL
49 void *host_priv; /* Per-device host private data */
50 /* soc_camera.c private count. Only accessed with .video_lock held */
9dc4e48f 51 int use_count;
1c3bb743 52 struct mutex video_lock; /* Protects device data */
e55222ef
GL
53};
54
55struct soc_camera_file {
56 struct soc_camera_device *icd;
57 struct videobuf_queue vb_vidq;
58};
59
60struct soc_camera_host {
61 struct list_head list;
62 struct device dev;
63 unsigned char nr; /* Host number */
e55222ef 64 void *priv;
af128a10 65 const char *drv_name;
b8d9904c
GL
66 struct soc_camera_host_ops *ops;
67};
68
69struct soc_camera_host_ops {
70 struct module *owner;
e55222ef
GL
71 int (*add)(struct soc_camera_device *);
72 void (*remove)(struct soc_camera_device *);
c2786ad2 73 int (*suspend)(struct soc_camera_device *, pm_message_t);
2e521061 74 int (*resume)(struct soc_camera_device *);
c2786ad2
GL
75 int (*get_formats)(struct soc_camera_device *, int,
76 struct soc_camera_format_xlate *);
d8fac217
GL
77 int (*set_fmt)(struct soc_camera_device *, __u32, struct v4l2_rect *);
78 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
a034d1b7 79 void (*init_videobuf)(struct videobuf_queue *,
092d3921 80 struct soc_camera_device *);
e55222ef
GL
81 int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
82 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
ad5f2e85 83 int (*set_bus_param)(struct soc_camera_device *, __u32);
e55222ef
GL
84 unsigned int (*poll)(struct file *, poll_table *);
85};
86
bd73b36f
GL
87#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
88#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
89#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
90#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
91#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
92
e55222ef
GL
93struct soc_camera_link {
94 /* Camera bus id, used to match a camera and a bus */
95 int bus_id;
96 /* GPIO number to switch between 8 and 10 bit modes */
97 unsigned int gpio;
bd73b36f
GL
98 /* Per camera SOCAM_SENSOR_* bus flags */
99 unsigned long flags;
81034663
SH
100 /* Optional callbacks to power on or off and reset the sensor */
101 int (*power)(struct device *, int);
102 int (*reset)(struct device *);
e55222ef
GL
103};
104
105static inline struct soc_camera_device *to_soc_camera_dev(struct device *dev)
106{
107 return container_of(dev, struct soc_camera_device, dev);
108}
109
110static inline struct soc_camera_host *to_soc_camera_host(struct device *dev)
111{
112 return container_of(dev, struct soc_camera_host, dev);
113}
114
b8d9904c 115extern int soc_camera_host_register(struct soc_camera_host *ici);
e55222ef
GL
116extern void soc_camera_host_unregister(struct soc_camera_host *ici);
117extern int soc_camera_device_register(struct soc_camera_device *icd);
118extern void soc_camera_device_unregister(struct soc_camera_device *icd);
119
120extern int soc_camera_video_start(struct soc_camera_device *icd);
121extern void soc_camera_video_stop(struct soc_camera_device *icd);
122
25c4d74e
GL
123extern const struct soc_camera_data_format *soc_camera_format_by_fourcc(
124 struct soc_camera_device *icd, unsigned int fourcc);
c2786ad2
GL
125extern const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
126 struct soc_camera_device *icd, unsigned int fourcc);
25c4d74e 127
e55222ef 128struct soc_camera_data_format {
af128a10 129 const char *name;
e55222ef
GL
130 unsigned int depth;
131 __u32 fourcc;
132 enum v4l2_colorspace colorspace;
133};
134
c2786ad2
GL
135/**
136 * struct soc_camera_format_xlate - match between host and sensor formats
137 * @cam_fmt: sensor format provided by the sensor
138 * @host_fmt: host format after host translation from cam_fmt
139 * @buswidth: bus width for this format
140 *
141 * Host and sensor translation structure. Used in table of host and sensor
142 * formats matchings in soc_camera_device. A host can override the generic list
143 * generation by implementing get_formats(), and use it for format checks and
144 * format setup.
145 */
146struct soc_camera_format_xlate {
147 const struct soc_camera_data_format *cam_fmt;
148 const struct soc_camera_data_format *host_fmt;
149 unsigned char buswidth;
150};
151
e55222ef
GL
152struct soc_camera_ops {
153 struct module *owner;
26f1b942
GL
154 int (*probe)(struct soc_camera_device *);
155 void (*remove)(struct soc_camera_device *);
2e521061
RJ
156 int (*suspend)(struct soc_camera_device *, pm_message_t state);
157 int (*resume)(struct soc_camera_device *);
e55222ef
GL
158 int (*init)(struct soc_camera_device *);
159 int (*release)(struct soc_camera_device *);
160 int (*start_capture)(struct soc_camera_device *);
161 int (*stop_capture)(struct soc_camera_device *);
d8fac217
GL
162 int (*set_fmt)(struct soc_camera_device *, __u32, struct v4l2_rect *);
163 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
ad5f2e85
GL
164 unsigned long (*query_bus_param)(struct soc_camera_device *);
165 int (*set_bus_param)(struct soc_camera_device *, unsigned long);
e55222ef 166 int (*get_chip_id)(struct soc_camera_device *,
aecde8b5 167 struct v4l2_dbg_chip_ident *);
513791ab 168 int (*set_std)(struct soc_camera_device *, v4l2_std_id *);
34d359db 169 int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
e55222ef 170#ifdef CONFIG_VIDEO_ADV_DEBUG
aecde8b5
HV
171 int (*get_register)(struct soc_camera_device *, struct v4l2_dbg_register *);
172 int (*set_register)(struct soc_camera_device *, struct v4l2_dbg_register *);
e55222ef 173#endif
e55222ef
GL
174 int (*get_control)(struct soc_camera_device *, struct v4l2_control *);
175 int (*set_control)(struct soc_camera_device *, struct v4l2_control *);
176 const struct v4l2_queryctrl *controls;
177 int num_controls;
e55222ef
GL
178};
179
a9bef518
GL
180#define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
181
182/**
183 * This struct can be attached to struct soc_camera_device by the host driver
184 * to request sense from the camera, for example, when calling .set_fmt(). The
185 * host then can check which flags are set and verify respective values if any.
186 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
187 * changed during this operation. After completion the host should detach sense.
188 *
189 * @flags ored SOCAM_SENSE_* flags
190 * @master_clock if the host wants to be informed about pixel-clock
191 * change, it better set master_clock.
192 * @pixel_clock_max maximum pixel clock frequency supported by the host,
193 * camera is not allowed to exceed this.
194 * @pixel_clock if the camera driver changed pixel clock during this
195 * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
196 * master_clock to calculate the new pixel-clock and
197 * sets this field.
198 */
199struct soc_camera_sense {
200 unsigned long flags;
201 unsigned long master_clock;
202 unsigned long pixel_clock_max;
203 unsigned long pixel_clock;
204};
205
e55222ef
GL
206static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
207 struct soc_camera_ops *ops, int id)
208{
209 int i;
210
211 for (i = 0; i < ops->num_controls; i++)
212 if (ops->controls[i].id == id)
213 return &ops->controls[i];
214
215 return NULL;
216}
217
ad5f2e85
GL
218#define SOCAM_MASTER (1 << 0)
219#define SOCAM_SLAVE (1 << 1)
220#define SOCAM_HSYNC_ACTIVE_HIGH (1 << 2)
221#define SOCAM_HSYNC_ACTIVE_LOW (1 << 3)
222#define SOCAM_VSYNC_ACTIVE_HIGH (1 << 4)
223#define SOCAM_VSYNC_ACTIVE_LOW (1 << 5)
042d8790
GL
224#define SOCAM_DATAWIDTH_4 (1 << 6)
225#define SOCAM_DATAWIDTH_8 (1 << 7)
226#define SOCAM_DATAWIDTH_9 (1 << 8)
227#define SOCAM_DATAWIDTH_10 (1 << 9)
228#define SOCAM_DATAWIDTH_15 (1 << 10)
229#define SOCAM_DATAWIDTH_16 (1 << 11)
230#define SOCAM_PCLK_SAMPLE_RISING (1 << 12)
231#define SOCAM_PCLK_SAMPLE_FALLING (1 << 13)
232#define SOCAM_DATA_ACTIVE_HIGH (1 << 14)
233#define SOCAM_DATA_ACTIVE_LOW (1 << 15)
234
235#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
236 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
237 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
ad5f2e85
GL
238
239static inline unsigned long soc_camera_bus_param_compatible(
240 unsigned long camera_flags, unsigned long bus_flags)
241{
f7f41483 242 unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
ad5f2e85
GL
243
244 common_flags = camera_flags & bus_flags;
245
246 hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
247 vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
248 pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
f7f41483
GL
249 data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
250 mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
251 buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
ad5f2e85 252
f7f41483
GL
253 return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
254 common_flags;
ad5f2e85 255}
e55222ef 256
bd73b36f
GL
257extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
258 unsigned long flags);
259
e55222ef 260#endif