V4L/DVB (12509): sh: prepare board-ap325rxa.c for v4l2-subdev conversion
[GitHub/moto-9609/android_kernel_motorola_exynos9610.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;
e55222ef
GL
23 unsigned short width; /* Current window */
24 unsigned short height; /* sizes */
25 unsigned short x_min; /* Camera capabilities */
26 unsigned short y_min;
27 unsigned short x_current; /* Current window location */
28 unsigned short y_current;
29 unsigned short width_min;
30 unsigned short width_max;
31 unsigned short height_min;
32 unsigned short height_max;
33 unsigned short y_skip_top; /* Lines to skip at the top */
34 unsigned short gain;
35 unsigned short exposure;
36 unsigned char iface; /* Host number */
37 unsigned char devnum; /* Device number per host */
ad5f2e85 38 unsigned char buswidth; /* See comment in .c */
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;
42 const struct soc_camera_data_format *current_fmt;
26f1b942
GL
43 const struct soc_camera_data_format *formats;
44 int num_formats;
c2786ad2
GL
45 struct soc_camera_format_xlate *user_formats;
46 int num_user_formats;
025c18a1 47 enum v4l2_field field; /* Preserve field over close() */
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;
eff505fa 62 struct device *dev;
e55222ef 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 *);
09e231b3
GL
77 int (*set_crop)(struct soc_camera_device *, struct v4l2_rect *);
78 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
d8fac217 79 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
a034d1b7 80 void (*init_videobuf)(struct videobuf_queue *,
092d3921 81 struct soc_camera_device *);
e55222ef
GL
82 int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
83 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
ad5f2e85 84 int (*set_bus_param)(struct soc_camera_device *, __u32);
e55222ef
GL
85 unsigned int (*poll)(struct file *, poll_table *);
86};
87
bd73b36f
GL
88#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
89#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
90#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
91#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
92#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
93
0fd327bd
GL
94struct i2c_board_info;
95
e55222ef
GL
96struct soc_camera_link {
97 /* Camera bus id, used to match a camera and a bus */
98 int bus_id;
bd73b36f
GL
99 /* Per camera SOCAM_SENSOR_* bus flags */
100 unsigned long flags;
0fd327bd
GL
101 int i2c_adapter_id;
102 struct i2c_board_info *board_info;
103 const char *module_name;
c41debaf
GL
104 /*
105 * For non-I2C devices platform platform has to provide methods to
106 * add a device to the system and to remove
107 */
108 int (*add_device)(struct soc_camera_link *, struct device *);
109 void (*del_device)(struct soc_camera_link *);
81034663
SH
110 /* Optional callbacks to power on or off and reset the sensor */
111 int (*power)(struct device *, int);
112 int (*reset)(struct device *);
28f59339
SH
113 /*
114 * some platforms may support different data widths than the sensors
115 * native ones due to different data line routing. Let the board code
116 * overwrite the width flags.
117 */
118 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
119 unsigned long (*query_bus_param)(struct soc_camera_link *);
594bb46d 120 void (*free_bus)(struct soc_camera_link *);
e55222ef
GL
121};
122
123static inline struct soc_camera_device *to_soc_camera_dev(struct device *dev)
124{
125 return container_of(dev, struct soc_camera_device, dev);
126}
127
128static inline struct soc_camera_host *to_soc_camera_host(struct device *dev)
129{
eff505fa 130 return dev_get_drvdata(dev);
e55222ef
GL
131}
132
40e2e092
GL
133static inline struct soc_camera_link *to_soc_camera_link(struct soc_camera_device *icd)
134{
135 return icd->dev.platform_data;
136}
e55222ef 137
40e2e092
GL
138static inline struct device *to_soc_camera_control(struct soc_camera_device *icd)
139{
140 return dev_get_drvdata(&icd->dev);
141}
e55222ef 142
40e2e092
GL
143int soc_camera_host_register(struct soc_camera_host *ici);
144void soc_camera_host_unregister(struct soc_camera_host *ici);
145
146int soc_camera_video_start(struct soc_camera_device *icd, struct device *dev);
147void soc_camera_video_stop(struct soc_camera_device *icd);
148
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
GL
178struct soc_camera_ops {
179 struct module *owner;
2e521061
RJ
180 int (*suspend)(struct soc_camera_device *, pm_message_t state);
181 int (*resume)(struct soc_camera_device *);
e55222ef
GL
182 int (*init)(struct soc_camera_device *);
183 int (*release)(struct soc_camera_device *);
184 int (*start_capture)(struct soc_camera_device *);
185 int (*stop_capture)(struct soc_camera_device *);
09e231b3
GL
186 int (*set_crop)(struct soc_camera_device *, struct v4l2_rect *);
187 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
d8fac217 188 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
ad5f2e85
GL
189 unsigned long (*query_bus_param)(struct soc_camera_device *);
190 int (*set_bus_param)(struct soc_camera_device *, unsigned long);
e55222ef 191 int (*get_chip_id)(struct soc_camera_device *,
aecde8b5 192 struct v4l2_dbg_chip_ident *);
513791ab 193 int (*set_std)(struct soc_camera_device *, v4l2_std_id *);
34d359db 194 int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
e55222ef 195#ifdef CONFIG_VIDEO_ADV_DEBUG
aecde8b5
HV
196 int (*get_register)(struct soc_camera_device *, struct v4l2_dbg_register *);
197 int (*set_register)(struct soc_camera_device *, struct v4l2_dbg_register *);
e55222ef 198#endif
e55222ef
GL
199 int (*get_control)(struct soc_camera_device *, struct v4l2_control *);
200 int (*set_control)(struct soc_camera_device *, struct v4l2_control *);
201 const struct v4l2_queryctrl *controls;
202 int num_controls;
e55222ef
GL
203};
204
a9bef518
GL
205#define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
206
207/**
208 * This struct can be attached to struct soc_camera_device by the host driver
209 * to request sense from the camera, for example, when calling .set_fmt(). The
210 * host then can check which flags are set and verify respective values if any.
211 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
212 * changed during this operation. After completion the host should detach sense.
213 *
214 * @flags ored SOCAM_SENSE_* flags
215 * @master_clock if the host wants to be informed about pixel-clock
216 * change, it better set master_clock.
217 * @pixel_clock_max maximum pixel clock frequency supported by the host,
218 * camera is not allowed to exceed this.
219 * @pixel_clock if the camera driver changed pixel clock during this
220 * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
221 * master_clock to calculate the new pixel-clock and
222 * sets this field.
223 */
224struct soc_camera_sense {
225 unsigned long flags;
226 unsigned long master_clock;
227 unsigned long pixel_clock_max;
228 unsigned long pixel_clock;
229};
230
e55222ef
GL
231static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
232 struct soc_camera_ops *ops, int id)
233{
234 int i;
235
236 for (i = 0; i < ops->num_controls; i++)
237 if (ops->controls[i].id == id)
238 return &ops->controls[i];
239
240 return NULL;
241}
242
ad5f2e85
GL
243#define SOCAM_MASTER (1 << 0)
244#define SOCAM_SLAVE (1 << 1)
245#define SOCAM_HSYNC_ACTIVE_HIGH (1 << 2)
246#define SOCAM_HSYNC_ACTIVE_LOW (1 << 3)
247#define SOCAM_VSYNC_ACTIVE_HIGH (1 << 4)
248#define SOCAM_VSYNC_ACTIVE_LOW (1 << 5)
042d8790
GL
249#define SOCAM_DATAWIDTH_4 (1 << 6)
250#define SOCAM_DATAWIDTH_8 (1 << 7)
251#define SOCAM_DATAWIDTH_9 (1 << 8)
252#define SOCAM_DATAWIDTH_10 (1 << 9)
253#define SOCAM_DATAWIDTH_15 (1 << 10)
254#define SOCAM_DATAWIDTH_16 (1 << 11)
255#define SOCAM_PCLK_SAMPLE_RISING (1 << 12)
256#define SOCAM_PCLK_SAMPLE_FALLING (1 << 13)
257#define SOCAM_DATA_ACTIVE_HIGH (1 << 14)
258#define SOCAM_DATA_ACTIVE_LOW (1 << 15)
259
260#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
261 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
262 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
ad5f2e85
GL
263
264static inline unsigned long soc_camera_bus_param_compatible(
265 unsigned long camera_flags, unsigned long bus_flags)
266{
f7f41483 267 unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
ad5f2e85
GL
268
269 common_flags = camera_flags & bus_flags;
270
271 hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
272 vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
273 pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
f7f41483
GL
274 data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
275 mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
276 buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
ad5f2e85 277
f7f41483
GL
278 return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
279 common_flags;
ad5f2e85 280}
e55222ef 281
bd73b36f
GL
282extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
283 unsigned long flags);
284
e55222ef 285#endif