blob: 2ce957301f770b36af1c5b13ddd7c4b363354086 [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 Liakhovetski52d268a2010-07-26 11:37:13 -030015#include <linux/device.h>
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030016#include <linux/mutex.h>
17#include <linux/pm.h>
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030018#include <linux/videodev2.h>
Paulius Zaleckas092d3922008-07-11 20:50:31 -030019#include <media/videobuf-core.h>
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030020#include <media/v4l2-device.h>
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030021
Guennadi Liakhovetski52d268a2010-07-26 11:37:13 -030022extern struct bus_type soc_camera_bus_type;
23
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030024struct soc_camera_device {
25 struct list_head list;
26 struct device dev;
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030027 struct device *pdev; /* Platform device */
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -030028 s32 user_width;
29 s32 user_height;
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -030030 enum v4l2_colorspace colorspace;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030031 unsigned char iface; /* Host number */
32 unsigned char devnum; /* Device number per host */
Guennadi Liakhovetskia9bef512008-12-18 11:34:20 -030033 struct soc_camera_sense *sense; /* See comment in struct definition */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030034 struct soc_camera_ops *ops;
35 struct video_device *vdev;
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -030036 const struct soc_camera_format_xlate *current_fmt;
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030037 struct soc_camera_format_xlate *user_formats;
38 int num_user_formats;
Guennadi Liakhovetski025c18a2009-03-13 06:08:20 -030039 enum v4l2_field field; /* Preserve field over close() */
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030040 void *host_priv; /* Per-device host private data */
41 /* soc_camera.c private count. Only accessed with .video_lock held */
Guennadi Liakhovetski9dc4e482008-04-22 14:45:32 -030042 int use_count;
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030043 struct mutex video_lock; /* Protects device data */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030044};
45
46struct soc_camera_file {
47 struct soc_camera_device *icd;
48 struct videobuf_queue vb_vidq;
49};
50
51struct soc_camera_host {
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030052 struct v4l2_device v4l2_dev;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030053 struct list_head list;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030054 unsigned char nr; /* Host number */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030055 void *priv;
Kay Sieversaf128a12008-10-30 00:51:46 -030056 const char *drv_name;
Guennadi Liakhovetskib8d99042008-04-04 13:41:25 -030057 struct soc_camera_host_ops *ops;
58};
59
60struct soc_camera_host_ops {
61 struct module *owner;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030062 int (*add)(struct soc_camera_device *);
63 void (*remove)(struct soc_camera_device *);
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030064 int (*suspend)(struct soc_camera_device *, pm_message_t);
Robert Jarzmik2e521062008-08-01 20:14:50 -030065 int (*resume)(struct soc_camera_device *);
Guennadi Liakhovetskifa489842009-08-25 11:46:43 -030066 /*
67 * .get_formats() is called for each client device format, but
68 * .put_formats() is only called once. Further, if any of the calls to
69 * .get_formats() fail, .put_formats() will not be called at all, the
70 * failing .get_formats() must then clean up internally.
71 */
Hans Verkuil3805f202010-05-08 17:55:00 -030072 int (*get_formats)(struct soc_camera_device *, unsigned int,
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030073 struct soc_camera_format_xlate *);
Guennadi Liakhovetskifa489842009-08-25 11:46:43 -030074 void (*put_formats)(struct soc_camera_device *);
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -030075 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
76 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetski08590b92009-08-25 11:46:54 -030077 int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetski09e231b2009-03-13 06:08:20 -030078 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
Guennadi Liakhovetskid8fac212008-12-01 09:45:21 -030079 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
Magnus Damma034d1b2008-07-11 20:59:34 -030080 void (*init_videobuf)(struct videobuf_queue *,
Paulius Zaleckas092d3922008-07-11 20:50:31 -030081 struct soc_camera_device *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030082 int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
83 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -030084 int (*set_bus_param)(struct soc_camera_device *, __u32);
Guennadi Liakhovetski2840d242009-08-25 11:44:15 -030085 int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
86 int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
Guennadi Liakhovetskic9f6ef62010-02-09 18:00:30 +010087 int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
88 int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030089 unsigned int (*poll)(struct file *, poll_table *);
Guennadi Liakhovetski2840d242009-08-25 11:44:15 -030090 const struct v4l2_queryctrl *controls;
91 int num_controls;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030092};
93
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -030094#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
95#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
96#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
97#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
98#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
99
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300100struct i2c_board_info;
101
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300102struct soc_camera_link {
103 /* Camera bus id, used to match a camera and a bus */
104 int bus_id;
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300105 /* Per camera SOCAM_SENSOR_* bus flags */
106 unsigned long flags;
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300107 int i2c_adapter_id;
108 struct i2c_board_info *board_info;
109 const char *module_name;
Guennadi Liakhovetski3fd7cef2009-12-11 11:15:06 -0300110 void *priv;
111
Guennadi Liakhovetskic41deba2009-08-25 11:06:21 -0300112 /*
113 * For non-I2C devices platform platform has to provide methods to
114 * add a device to the system and to remove
115 */
116 int (*add_device)(struct soc_camera_link *, struct device *);
117 void (*del_device)(struct soc_camera_link *);
Stefan Herbrechtsmeier81034662008-08-14 12:04:11 -0300118 /* Optional callbacks to power on or off and reset the sensor */
119 int (*power)(struct device *, int);
120 int (*reset)(struct device *);
Sascha Hauer28f59332009-03-13 06:08:20 -0300121 /*
122 * some platforms may support different data widths than the sensors
123 * native ones due to different data line routing. Let the board code
124 * overwrite the width flags.
125 */
126 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
127 unsigned long (*query_bus_param)(struct soc_camera_link *);
Guennadi Liakhovetski594bb462009-04-24 12:53:51 -0300128 void (*free_bus)(struct soc_camera_link *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300129};
130
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300131static inline struct soc_camera_device *to_soc_camera_dev(
132 const struct device *dev)
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300133{
134 return container_of(dev, struct soc_camera_device, dev);
135}
136
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300137static inline struct soc_camera_host *to_soc_camera_host(
138 const struct device *dev)
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300139{
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -0300140 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
141
142 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300143}
144
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300145static inline struct soc_camera_link *to_soc_camera_link(
146 const struct soc_camera_device *icd)
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300147{
148 return icd->dev.platform_data;
149}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300150
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300151static inline struct device *to_soc_camera_control(
152 const struct soc_camera_device *icd)
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300153{
154 return dev_get_drvdata(&icd->dev);
155}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300156
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300157static inline struct v4l2_subdev *soc_camera_to_subdev(
158 const struct soc_camera_device *icd)
Guennadi Liakhovetskic9c1f1c2009-08-25 11:46:59 -0300159{
160 struct device *control = to_soc_camera_control(icd);
161 return dev_get_drvdata(control);
162}
163
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300164int soc_camera_host_register(struct soc_camera_host *ici);
165void soc_camera_host_unregister(struct soc_camera_host *ici);
166
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300167const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300168 struct soc_camera_device *icd, unsigned int fourcc);
Guennadi Liakhovetski25c4d742008-12-01 09:44:59 -0300169
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300170/**
171 * struct soc_camera_format_xlate - match between host and sensor formats
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -0300172 * @code: code of a sensor provided format
173 * @host_fmt: host format after host translation from code
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300174 *
175 * Host and sensor translation structure. Used in table of host and sensor
176 * formats matchings in soc_camera_device. A host can override the generic list
177 * generation by implementing get_formats(), and use it for format checks and
178 * format setup.
179 */
180struct soc_camera_format_xlate {
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -0300181 enum v4l2_mbus_pixelcode code;
182 const struct soc_mbus_pixelfmt *host_fmt;
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300183};
184
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300185struct soc_camera_ops {
Robert Jarzmik2e521062008-08-01 20:14:50 -0300186 int (*suspend)(struct soc_camera_device *, pm_message_t state);
187 int (*resume)(struct soc_camera_device *);
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300188 unsigned long (*query_bus_param)(struct soc_camera_device *);
189 int (*set_bus_param)(struct soc_camera_device *, unsigned long);
Kuninori Morimoto34d359d2008-12-18 12:47:46 -0300190 int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300191 const struct v4l2_queryctrl *controls;
192 int num_controls;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300193};
194
Guennadi Liakhovetskia9bef512008-12-18 11:34:20 -0300195#define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
196
197/**
198 * This struct can be attached to struct soc_camera_device by the host driver
199 * to request sense from the camera, for example, when calling .set_fmt(). The
200 * host then can check which flags are set and verify respective values if any.
201 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
202 * changed during this operation. After completion the host should detach sense.
203 *
204 * @flags ored SOCAM_SENSE_* flags
205 * @master_clock if the host wants to be informed about pixel-clock
206 * change, it better set master_clock.
207 * @pixel_clock_max maximum pixel clock frequency supported by the host,
208 * camera is not allowed to exceed this.
209 * @pixel_clock if the camera driver changed pixel clock during this
210 * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
211 * master_clock to calculate the new pixel-clock and
212 * sets this field.
213 */
214struct soc_camera_sense {
215 unsigned long flags;
216 unsigned long master_clock;
217 unsigned long pixel_clock_max;
218 unsigned long pixel_clock;
219};
220
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300221static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
222 struct soc_camera_ops *ops, int id)
223{
224 int i;
225
226 for (i = 0; i < ops->num_controls; i++)
227 if (ops->controls[i].id == id)
228 return &ops->controls[i];
229
230 return NULL;
231}
232
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300233#define SOCAM_MASTER (1 << 0)
234#define SOCAM_SLAVE (1 << 1)
235#define SOCAM_HSYNC_ACTIVE_HIGH (1 << 2)
236#define SOCAM_HSYNC_ACTIVE_LOW (1 << 3)
237#define SOCAM_VSYNC_ACTIVE_HIGH (1 << 4)
238#define SOCAM_VSYNC_ACTIVE_LOW (1 << 5)
Guennadi Liakhovetski042d8792008-12-19 10:07:49 -0300239#define SOCAM_DATAWIDTH_4 (1 << 6)
240#define SOCAM_DATAWIDTH_8 (1 << 7)
241#define SOCAM_DATAWIDTH_9 (1 << 8)
242#define SOCAM_DATAWIDTH_10 (1 << 9)
243#define SOCAM_DATAWIDTH_15 (1 << 10)
244#define SOCAM_DATAWIDTH_16 (1 << 11)
245#define SOCAM_PCLK_SAMPLE_RISING (1 << 12)
246#define SOCAM_PCLK_SAMPLE_FALLING (1 << 13)
247#define SOCAM_DATA_ACTIVE_HIGH (1 << 14)
248#define SOCAM_DATA_ACTIVE_LOW (1 << 15)
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300249
Guennadi Liakhovetski042d8792008-12-19 10:07:49 -0300250#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
251 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
252 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300253
254static inline unsigned long soc_camera_bus_param_compatible(
255 unsigned long camera_flags, unsigned long bus_flags)
256{
Guennadi Liakhovetskif7f41482009-02-23 12:13:24 -0300257 unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300258
259 common_flags = camera_flags & bus_flags;
260
261 hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
262 vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
263 pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
Guennadi Liakhovetskif7f41482009-02-23 12:13:24 -0300264 data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
265 mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
266 buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300267
Guennadi Liakhovetskif7f41482009-02-23 12:13:24 -0300268 return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
269 common_flags;
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300270}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300271
Márton Némethe26b3142010-02-24 17:13:29 -0300272static inline void soc_camera_limit_side(int *start, int *length,
273 unsigned int start_min,
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -0300274 unsigned int length_min, unsigned int length_max)
275{
276 if (*length < length_min)
277 *length = length_min;
278 else if (*length > length_max)
279 *length = length_max;
280
281 if (*start < start_min)
282 *start = start_min;
283 else if (*start > start_min + length_max - *length)
284 *start = start_min + length_max - *length;
285}
286
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300287extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
288 unsigned long flags);
289
Mauro Carvalho Chehab4f9fb5e2010-05-18 00:46:09 -0300290/* This is only temporary here - until v4l2-subdev begins to link to video_device */
291#include <linux/i2c.h>
292static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client)
293{
294 struct soc_camera_device *icd = client->dev.platform_data;
295 return icd->vdev;
296}
297
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300298#endif