blob: dcc5b86bcb6cce2cd9efa685b25252df5b3abd10 [file] [log] [blame]
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -03001/*
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
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030015#include <linux/mutex.h>
16#include <linux/pm.h>
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030017#include <linux/videodev2.h>
Paulius Zaleckas092d3922008-07-11 20:50:31 -030018#include <media/videobuf-core.h>
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030019#include <media/v4l2-device.h>
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030020
21struct soc_camera_device {
22 struct list_head list;
23 struct device dev;
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030024 struct device *pdev; /* Platform device */
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -030025 s32 user_width;
26 s32 user_height;
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -030027 enum v4l2_colorspace colorspace;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030028 unsigned char iface; /* Host number */
29 unsigned char devnum; /* Device number per host */
Guennadi Liakhovetskia9bef512008-12-18 11:34:20 -030030 struct soc_camera_sense *sense; /* See comment in struct definition */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030031 struct soc_camera_ops *ops;
32 struct video_device *vdev;
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -030033 const struct soc_camera_format_xlate *current_fmt;
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030034 struct soc_camera_format_xlate *user_formats;
35 int num_user_formats;
Guennadi Liakhovetski025c18a2009-03-13 06:08:20 -030036 enum v4l2_field field; /* Preserve field over close() */
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030037 void *host_priv; /* Per-device host private data */
38 /* soc_camera.c private count. Only accessed with .video_lock held */
Guennadi Liakhovetski9dc4e482008-04-22 14:45:32 -030039 int use_count;
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030040 struct mutex video_lock; /* Protects device data */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030041};
42
43struct soc_camera_file {
44 struct soc_camera_device *icd;
45 struct videobuf_queue vb_vidq;
46};
47
48struct soc_camera_host {
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030049 struct v4l2_device v4l2_dev;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030050 struct list_head list;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030051 unsigned char nr; /* Host number */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030052 void *priv;
Kay Sieversaf128a12008-10-30 00:51:46 -030053 const char *drv_name;
Guennadi Liakhovetskib8d99042008-04-04 13:41:25 -030054 struct soc_camera_host_ops *ops;
55};
56
57struct soc_camera_host_ops {
58 struct module *owner;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030059 int (*add)(struct soc_camera_device *);
60 void (*remove)(struct soc_camera_device *);
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030061 int (*suspend)(struct soc_camera_device *, pm_message_t);
Robert Jarzmik2e521062008-08-01 20:14:50 -030062 int (*resume)(struct soc_camera_device *);
Guennadi Liakhovetskifa489842009-08-25 11:46:43 -030063 /*
64 * .get_formats() is called for each client device format, but
65 * .put_formats() is only called once. Further, if any of the calls to
66 * .get_formats() fail, .put_formats() will not be called at all, the
67 * failing .get_formats() must then clean up internally.
68 */
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030069 int (*get_formats)(struct soc_camera_device *, int,
70 struct soc_camera_format_xlate *);
Guennadi Liakhovetskifa489842009-08-25 11:46:43 -030071 void (*put_formats)(struct soc_camera_device *);
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -030072 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
73 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetski08590b92009-08-25 11:46:54 -030074 int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetski09e231b2009-03-13 06:08:20 -030075 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
Guennadi Liakhovetskid8fac212008-12-01 09:45:21 -030076 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
Magnus Damma034d1b2008-07-11 20:59:34 -030077 void (*init_videobuf)(struct videobuf_queue *,
Paulius Zaleckas092d3922008-07-11 20:50:31 -030078 struct soc_camera_device *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030079 int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
80 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -030081 int (*set_bus_param)(struct soc_camera_device *, __u32);
Guennadi Liakhovetski2840d242009-08-25 11:44:15 -030082 int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
83 int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030084 unsigned int (*poll)(struct file *, poll_table *);
Guennadi Liakhovetski2840d242009-08-25 11:44:15 -030085 const struct v4l2_queryctrl *controls;
86 int num_controls;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030087};
88
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -030089#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
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -030095struct i2c_board_info;
96
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030097struct soc_camera_link {
98 /* Camera bus id, used to match a camera and a bus */
99 int bus_id;
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300100 /* Per camera SOCAM_SENSOR_* bus flags */
101 unsigned long flags;
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300102 int i2c_adapter_id;
103 struct i2c_board_info *board_info;
104 const char *module_name;
Guennadi Liakhovetski3fd7cef2009-12-11 11:15:06 -0300105 void *priv;
106
Guennadi Liakhovetskic41deba2009-08-25 11:06:21 -0300107 /*
108 * For non-I2C devices platform platform has to provide methods to
109 * add a device to the system and to remove
110 */
111 int (*add_device)(struct soc_camera_link *, struct device *);
112 void (*del_device)(struct soc_camera_link *);
Stefan Herbrechtsmeier81034662008-08-14 12:04:11 -0300113 /* Optional callbacks to power on or off and reset the sensor */
114 int (*power)(struct device *, int);
115 int (*reset)(struct device *);
Sascha Hauer28f59332009-03-13 06:08:20 -0300116 /*
117 * some platforms may support different data widths than the sensors
118 * native ones due to different data line routing. Let the board code
119 * overwrite the width flags.
120 */
121 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
122 unsigned long (*query_bus_param)(struct soc_camera_link *);
Guennadi Liakhovetski594bb462009-04-24 12:53:51 -0300123 void (*free_bus)(struct soc_camera_link *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300124};
125
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300126static inline struct soc_camera_device *to_soc_camera_dev(
127 const struct device *dev)
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300128{
129 return container_of(dev, struct soc_camera_device, dev);
130}
131
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300132static inline struct soc_camera_host *to_soc_camera_host(
133 const struct device *dev)
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300134{
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -0300135 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
136
137 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300138}
139
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300140static inline struct soc_camera_link *to_soc_camera_link(
141 const struct soc_camera_device *icd)
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300142{
143 return icd->dev.platform_data;
144}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300145
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300146static inline struct device *to_soc_camera_control(
147 const struct soc_camera_device *icd)
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300148{
149 return dev_get_drvdata(&icd->dev);
150}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300151
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300152static inline struct v4l2_subdev *soc_camera_to_subdev(
153 const struct soc_camera_device *icd)
Guennadi Liakhovetskic9c1f1c2009-08-25 11:46:59 -0300154{
155 struct device *control = to_soc_camera_control(icd);
156 return dev_get_drvdata(control);
157}
158
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300159int soc_camera_host_register(struct soc_camera_host *ici);
160void soc_camera_host_unregister(struct soc_camera_host *ici);
161
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300162const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300163 struct soc_camera_device *icd, unsigned int fourcc);
Guennadi Liakhovetski25c4d742008-12-01 09:44:59 -0300164
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300165/**
166 * struct soc_camera_format_xlate - match between host and sensor formats
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -0300167 * @code: code of a sensor provided format
168 * @host_fmt: host format after host translation from code
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300169 *
170 * Host and sensor translation structure. Used in table of host and sensor
171 * formats matchings in soc_camera_device. A host can override the generic list
172 * generation by implementing get_formats(), and use it for format checks and
173 * format setup.
174 */
175struct soc_camera_format_xlate {
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -0300176 enum v4l2_mbus_pixelcode code;
177 const struct soc_mbus_pixelfmt *host_fmt;
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300178};
179
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300180struct soc_camera_ops {
Robert Jarzmik2e521062008-08-01 20:14:50 -0300181 int (*suspend)(struct soc_camera_device *, pm_message_t state);
182 int (*resume)(struct soc_camera_device *);
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300183 unsigned long (*query_bus_param)(struct soc_camera_device *);
184 int (*set_bus_param)(struct soc_camera_device *, unsigned long);
Kuninori Morimoto34d359d2008-12-18 12:47:46 -0300185 int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300186 const struct v4l2_queryctrl *controls;
187 int num_controls;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300188};
189
Guennadi Liakhovetskia9bef512008-12-18 11:34:20 -0300190#define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
191
192/**
193 * This struct can be attached to struct soc_camera_device by the host driver
194 * to request sense from the camera, for example, when calling .set_fmt(). The
195 * host then can check which flags are set and verify respective values if any.
196 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
197 * changed during this operation. After completion the host should detach sense.
198 *
199 * @flags ored SOCAM_SENSE_* flags
200 * @master_clock if the host wants to be informed about pixel-clock
201 * change, it better set master_clock.
202 * @pixel_clock_max maximum pixel clock frequency supported by the host,
203 * camera is not allowed to exceed this.
204 * @pixel_clock if the camera driver changed pixel clock during this
205 * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
206 * master_clock to calculate the new pixel-clock and
207 * sets this field.
208 */
209struct soc_camera_sense {
210 unsigned long flags;
211 unsigned long master_clock;
212 unsigned long pixel_clock_max;
213 unsigned long pixel_clock;
214};
215
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300216static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
217 struct soc_camera_ops *ops, int id)
218{
219 int i;
220
221 for (i = 0; i < ops->num_controls; i++)
222 if (ops->controls[i].id == id)
223 return &ops->controls[i];
224
225 return NULL;
226}
227
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300228#define SOCAM_MASTER (1 << 0)
229#define SOCAM_SLAVE (1 << 1)
230#define SOCAM_HSYNC_ACTIVE_HIGH (1 << 2)
231#define SOCAM_HSYNC_ACTIVE_LOW (1 << 3)
232#define SOCAM_VSYNC_ACTIVE_HIGH (1 << 4)
233#define SOCAM_VSYNC_ACTIVE_LOW (1 << 5)
Guennadi Liakhovetski042d8792008-12-19 10:07:49 -0300234#define SOCAM_DATAWIDTH_4 (1 << 6)
235#define SOCAM_DATAWIDTH_8 (1 << 7)
236#define SOCAM_DATAWIDTH_9 (1 << 8)
237#define SOCAM_DATAWIDTH_10 (1 << 9)
238#define SOCAM_DATAWIDTH_15 (1 << 10)
239#define SOCAM_DATAWIDTH_16 (1 << 11)
240#define SOCAM_PCLK_SAMPLE_RISING (1 << 12)
241#define SOCAM_PCLK_SAMPLE_FALLING (1 << 13)
242#define SOCAM_DATA_ACTIVE_HIGH (1 << 14)
243#define SOCAM_DATA_ACTIVE_LOW (1 << 15)
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300244
Guennadi Liakhovetski042d8792008-12-19 10:07:49 -0300245#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
246 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
247 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300248
249static inline unsigned long soc_camera_bus_param_compatible(
250 unsigned long camera_flags, unsigned long bus_flags)
251{
Guennadi Liakhovetskif7f41482009-02-23 12:13:24 -0300252 unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300253
254 common_flags = camera_flags & bus_flags;
255
256 hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
257 vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
258 pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
Guennadi Liakhovetskif7f41482009-02-23 12:13:24 -0300259 data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
260 mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
261 buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300262
Guennadi Liakhovetskif7f41482009-02-23 12:13:24 -0300263 return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
264 common_flags;
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300265}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300266
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -0300267static inline void soc_camera_limit_side(unsigned int *start,
268 unsigned int *length, unsigned int start_min,
269 unsigned int length_min, unsigned int length_max)
270{
271 if (*length < length_min)
272 *length = length_min;
273 else if (*length > length_max)
274 *length = length_max;
275
276 if (*start < start_min)
277 *start = start_min;
278 else if (*start > start_min + length_max - *length)
279 *start = start_min + length_max - *length;
280}
281
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300282extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
283 unsigned long flags);
284
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300285#endif