tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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/mutex.h>
16#include <linux/pm.h>
17#include <linux/videodev2.h>
18#include <media/videobuf-core.h>
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 */
39 unsigned char buswidth; /* See comment in .c */
40 struct soc_camera_sense *sense; /* See comment in struct definition */
41 struct soc_camera_ops *ops;
42 struct video_device *vdev;
43 const struct soc_camera_data_format *current_fmt;
44 const struct soc_camera_data_format *formats;
45 int num_formats;
46 struct soc_camera_format_xlate *user_formats;
47 int num_user_formats;
48 enum v4l2_field field; /* Preserve field over close() */
49 struct module *owner;
50 void *host_priv; /* Per-device host private data */
51 /* soc_camera.c private count. Only accessed with .video_lock held */
52 int use_count;
53 struct mutex video_lock; /* Protects device data */
54};
55
56struct soc_camera_file {
57 struct soc_camera_device *icd;
58 struct videobuf_queue vb_vidq;
59};
60
61struct soc_camera_host {
62 struct list_head list;
63 struct device *dev;
64 unsigned char nr; /* Host number */
65 void *priv;
66 const char *drv_name;
67 struct soc_camera_host_ops *ops;
68};
69
70struct soc_camera_host_ops {
71 struct module *owner;
72 int (*add)(struct soc_camera_device *);
73 void (*remove)(struct soc_camera_device *);
74 int (*suspend)(struct soc_camera_device *, pm_message_t);
75 int (*resume)(struct soc_camera_device *);
76 int (*get_formats)(struct soc_camera_device *, int,
77 struct soc_camera_format_xlate *);
78 int (*set_crop)(struct soc_camera_device *, struct v4l2_rect *);
79 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
80 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
81 void (*init_videobuf)(struct videobuf_queue *,
82 struct soc_camera_device *);
83 int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
84 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
85 int (*set_bus_param)(struct soc_camera_device *, __u32);
86 unsigned int (*poll)(struct file *, poll_table *);
87};
88
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
95struct i2c_board_info;
96
97struct soc_camera_link {
98 /* Camera bus id, used to match a camera and a bus */
99 int bus_id;
100 /* Per camera SOCAM_SENSOR_* bus flags */
101 unsigned long flags;
102 int i2c_adapter_id;
103 struct i2c_board_info *board_info;
104 const char *module_name;
105 /* Optional callbacks to power on or off and reset the sensor */
106 int (*power)(struct device *, int);
107 int (*reset)(struct device *);
108 /*
109 * some platforms may support different data widths than the sensors
110 * native ones due to different data line routing. Let the board code
111 * overwrite the width flags.
112 */
113 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
114 unsigned long (*query_bus_param)(struct soc_camera_link *);
115 void (*free_bus)(struct soc_camera_link *);
116};
117
118static inline struct soc_camera_device *to_soc_camera_dev(struct device *dev)
119{
120 return container_of(dev, struct soc_camera_device, dev);
121}
122
123static inline struct soc_camera_host *to_soc_camera_host(struct device *dev)
124{
125 return dev_get_drvdata(dev);
126}
127
128extern int soc_camera_host_register(struct soc_camera_host *ici);
129extern void soc_camera_host_unregister(struct soc_camera_host *ici);
130extern int soc_camera_device_register(struct soc_camera_device *icd);
131extern void soc_camera_device_unregister(struct soc_camera_device *icd);
132
133extern int soc_camera_video_start(struct soc_camera_device *icd);
134extern void soc_camera_video_stop(struct soc_camera_device *icd);
135
136extern const struct soc_camera_data_format *soc_camera_format_by_fourcc(
137 struct soc_camera_device *icd, unsigned int fourcc);
138extern const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
139 struct soc_camera_device *icd, unsigned int fourcc);
140
141struct soc_camera_data_format {
142 const char *name;
143 unsigned int depth;
144 __u32 fourcc;
145 enum v4l2_colorspace colorspace;
146};
147
148/**
149 * struct soc_camera_format_xlate - match between host and sensor formats
150 * @cam_fmt: sensor format provided by the sensor
151 * @host_fmt: host format after host translation from cam_fmt
152 * @buswidth: bus width for this format
153 *
154 * Host and sensor translation structure. Used in table of host and sensor
155 * formats matchings in soc_camera_device. A host can override the generic list
156 * generation by implementing get_formats(), and use it for format checks and
157 * format setup.
158 */
159struct soc_camera_format_xlate {
160 const struct soc_camera_data_format *cam_fmt;
161 const struct soc_camera_data_format *host_fmt;
162 unsigned char buswidth;
163};
164
165struct soc_camera_ops {
166 struct module *owner;
167 int (*probe)(struct soc_camera_device *);
168 void (*remove)(struct soc_camera_device *);
169 int (*suspend)(struct soc_camera_device *, pm_message_t state);
170 int (*resume)(struct soc_camera_device *);
171 int (*init)(struct soc_camera_device *);
172 int (*release)(struct soc_camera_device *);
173 int (*start_capture)(struct soc_camera_device *);
174 int (*stop_capture)(struct soc_camera_device *);
175 int (*set_crop)(struct soc_camera_device *, struct v4l2_rect *);
176 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
177 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
178 unsigned long (*query_bus_param)(struct soc_camera_device *);
179 int (*set_bus_param)(struct soc_camera_device *, unsigned long);
180 int (*get_chip_id)(struct soc_camera_device *,
181 struct v4l2_dbg_chip_ident *);
182 int (*set_std)(struct soc_camera_device *, v4l2_std_id *);
183 int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
184#ifdef CONFIG_VIDEO_ADV_DEBUG
185 int (*get_register)(struct soc_camera_device *, struct v4l2_dbg_register *);
186 int (*set_register)(struct soc_camera_device *, struct v4l2_dbg_register *);
187#endif
188 int (*get_control)(struct soc_camera_device *, struct v4l2_control *);
189 int (*set_control)(struct soc_camera_device *, struct v4l2_control *);
190 const struct v4l2_queryctrl *controls;
191 int num_controls;
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 */
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
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
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)
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)
252
253static inline unsigned long soc_camera_bus_param_compatible(
254 unsigned long camera_flags, unsigned long bus_flags)
255{
256 unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
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);
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;
266
267 return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
268 common_flags;
269}
270
271extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
272 unsigned long flags);
273
274#endif