blob: 7582952dceae2810469584a7ae814356aecec5db [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 Liakhovetski592c2ab2011-01-29 12:44:51 -030020#include <media/videobuf2-core.h>
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030021#include <media/v4l2-device.h>
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030022
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030023struct file;
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -030024struct soc_camera_link;
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030025
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030026struct soc_camera_device {
Guennadi Liakhovetskid33b2902011-07-01 11:31:35 -030027 struct list_head list; /* list of all registered devices */
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -030028 struct soc_camera_link *link;
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030029 struct device *pdev; /* Platform device */
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -030030 struct device *parent; /* Camera host device */
31 struct device *control; /* E.g., the i2c client */
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -030032 s32 user_width;
33 s32 user_height;
Sergio Aguirre0e4c1802011-03-07 21:49:48 -030034 u32 bytesperline; /* for padding, zero if unused */
35 u32 sizeimage;
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -030036 enum v4l2_colorspace colorspace;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030037 unsigned char iface; /* Host number */
38 unsigned char devnum; /* Device number per host */
Guennadi Liakhovetskia9bef512008-12-18 11:34:20 -030039 struct soc_camera_sense *sense; /* See comment in struct definition */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030040 struct soc_camera_ops *ops;
41 struct video_device *vdev;
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -030042 const struct soc_camera_format_xlate *current_fmt;
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030043 struct soc_camera_format_xlate *user_formats;
44 int num_user_formats;
Guennadi Liakhovetski025c18a2009-03-13 06:08:20 -030045 enum v4l2_field field; /* Preserve field over close() */
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030046 void *host_priv; /* Per-device host private data */
47 /* soc_camera.c private count. Only accessed with .video_lock held */
Guennadi Liakhovetski9dc4e482008-04-22 14:45:32 -030048 int use_count;
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030049 struct mutex video_lock; /* Protects device data */
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030050 struct file *streamer; /* stream owner */
Guennadi Liakhovetski592c2ab2011-01-29 12:44:51 -030051 union {
52 struct videobuf_queue vb_vidq;
53 struct vb2_queue vb2_vidq;
54 };
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030055};
56
57struct soc_camera_host {
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030058 struct v4l2_device v4l2_dev;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030059 struct list_head list;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030060 unsigned char nr; /* Host number */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030061 void *priv;
Kay Sieversaf128a12008-10-30 00:51:46 -030062 const char *drv_name;
Guennadi Liakhovetskib8d99042008-04-04 13:41:25 -030063 struct soc_camera_host_ops *ops;
64};
65
66struct soc_camera_host_ops {
67 struct module *owner;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030068 int (*add)(struct soc_camera_device *);
69 void (*remove)(struct soc_camera_device *);
Guennadi Liakhovetskifa489842009-08-25 11:46:43 -030070 /*
71 * .get_formats() is called for each client device format, but
72 * .put_formats() is only called once. Further, if any of the calls to
73 * .get_formats() fail, .put_formats() will not be called at all, the
74 * failing .get_formats() must then clean up internally.
75 */
Hans Verkuil3805f202010-05-08 17:55:00 -030076 int (*get_formats)(struct soc_camera_device *, unsigned int,
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030077 struct soc_camera_format_xlate *);
Guennadi Liakhovetskifa489842009-08-25 11:46:43 -030078 void (*put_formats)(struct soc_camera_device *);
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -030079 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
80 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetski08590b92009-08-25 11:46:54 -030081 int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetskiaee5c2f2011-03-28 13:28:28 -030082 /*
83 * The difference to .set_crop() is, that .set_livecrop is not allowed
84 * to change the output sizes
85 */
86 int (*set_livecrop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetski09e231b2009-03-13 06:08:20 -030087 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
Guennadi Liakhovetskid8fac212008-12-01 09:45:21 -030088 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
Magnus Damma034d1b2008-07-11 20:59:34 -030089 void (*init_videobuf)(struct videobuf_queue *,
Paulius Zaleckas092d3922008-07-11 20:50:31 -030090 struct soc_camera_device *);
Guennadi Liakhovetski592c2ab2011-01-29 12:44:51 -030091 int (*init_videobuf2)(struct vb2_queue *,
92 struct soc_camera_device *);
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030093 int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030094 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -030095 int (*set_bus_param)(struct soc_camera_device *, __u32);
Guennadi Liakhovetski2840d242009-08-25 11:44:15 -030096 int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
97 int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
Guennadi Liakhovetskic9f6ef62010-02-09 18:00:30 +010098 int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
99 int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
Qing Xued5b65d2011-01-20 05:19:40 -0300100 int (*enum_fsizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300101 unsigned int (*poll)(struct file *, poll_table *);
Guennadi Liakhovetski2840d242009-08-25 11:44:15 -0300102 const struct v4l2_queryctrl *controls;
103 int num_controls;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300104};
105
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300106#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
107#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
108#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
109#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
110#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
111
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300112struct i2c_board_info;
Alberto Panizzo96e442c2010-12-02 07:43:37 -0300113struct regulator_bulk_data;
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300114
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300115struct soc_camera_link {
116 /* Camera bus id, used to match a camera and a bus */
117 int bus_id;
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300118 /* Per camera SOCAM_SENSOR_* bus flags */
119 unsigned long flags;
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300120 int i2c_adapter_id;
121 struct i2c_board_info *board_info;
122 const char *module_name;
Guennadi Liakhovetski3fd7cef2009-12-11 11:15:06 -0300123 void *priv;
124
Alberto Panizzo96e442c2010-12-02 07:43:37 -0300125 /* Optional regulators that have to be managed on power on/off events */
126 struct regulator_bulk_data *regulators;
127 int num_regulators;
128
Guennadi Liakhovetskic41deba2009-08-25 11:06:21 -0300129 /*
Guennadi Liakhovetskid33b2902011-07-01 11:31:35 -0300130 * For non-I2C devices platform has to provide methods to add a device
131 * to the system and to remove it
Guennadi Liakhovetskic41deba2009-08-25 11:06:21 -0300132 */
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -0300133 int (*add_device)(struct soc_camera_device *);
134 void (*del_device)(struct soc_camera_device *);
Stefan Herbrechtsmeier81034662008-08-14 12:04:11 -0300135 /* Optional callbacks to power on or off and reset the sensor */
136 int (*power)(struct device *, int);
137 int (*reset)(struct device *);
Sascha Hauer28f59332009-03-13 06:08:20 -0300138 /*
139 * some platforms may support different data widths than the sensors
140 * native ones due to different data line routing. Let the board code
141 * overwrite the width flags.
142 */
143 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
144 unsigned long (*query_bus_param)(struct soc_camera_link *);
Guennadi Liakhovetski594bb462009-04-24 12:53:51 -0300145 void (*free_bus)(struct soc_camera_link *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300146};
147
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300148static inline struct soc_camera_host *to_soc_camera_host(
149 const struct device *dev)
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300150{
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -0300151 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
152
153 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300154}
155
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300156static inline struct soc_camera_link *to_soc_camera_link(
157 const struct soc_camera_device *icd)
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300158{
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -0300159 return icd->link;
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300160}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300161
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300162static inline struct device *to_soc_camera_control(
163 const struct soc_camera_device *icd)
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300164{
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -0300165 return icd->control;
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300166}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300167
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300168static inline struct v4l2_subdev *soc_camera_to_subdev(
169 const struct soc_camera_device *icd)
Guennadi Liakhovetskic9c1f1c2009-08-25 11:46:59 -0300170{
171 struct device *control = to_soc_camera_control(icd);
172 return dev_get_drvdata(control);
173}
174
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300175int soc_camera_host_register(struct soc_camera_host *ici);
176void soc_camera_host_unregister(struct soc_camera_host *ici);
177
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300178const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300179 struct soc_camera_device *icd, unsigned int fourcc);
Guennadi Liakhovetski25c4d742008-12-01 09:44:59 -0300180
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300181/**
182 * struct soc_camera_format_xlate - match between host and sensor formats
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -0300183 * @code: code of a sensor provided format
184 * @host_fmt: host format after host translation from code
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300185 *
186 * Host and sensor translation structure. Used in table of host and sensor
187 * formats matchings in soc_camera_device. A host can override the generic list
188 * generation by implementing get_formats(), and use it for format checks and
189 * format setup.
190 */
191struct soc_camera_format_xlate {
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -0300192 enum v4l2_mbus_pixelcode code;
193 const struct soc_mbus_pixelfmt *host_fmt;
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300194};
195
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300196struct soc_camera_ops {
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300197 unsigned long (*query_bus_param)(struct soc_camera_device *);
198 int (*set_bus_param)(struct soc_camera_device *, unsigned long);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300199 const struct v4l2_queryctrl *controls;
200 int num_controls;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300201};
202
Guennadi Liakhovetskia9bef512008-12-18 11:34:20 -0300203#define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
204
205/**
206 * This struct can be attached to struct soc_camera_device by the host driver
207 * to request sense from the camera, for example, when calling .set_fmt(). The
208 * host then can check which flags are set and verify respective values if any.
209 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
210 * changed during this operation. After completion the host should detach sense.
211 *
212 * @flags ored SOCAM_SENSE_* flags
213 * @master_clock if the host wants to be informed about pixel-clock
214 * change, it better set master_clock.
215 * @pixel_clock_max maximum pixel clock frequency supported by the host,
216 * camera is not allowed to exceed this.
217 * @pixel_clock if the camera driver changed pixel clock during this
218 * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
219 * master_clock to calculate the new pixel-clock and
220 * sets this field.
221 */
222struct soc_camera_sense {
223 unsigned long flags;
224 unsigned long master_clock;
225 unsigned long pixel_clock_max;
226 unsigned long pixel_clock;
227};
228
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300229static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
230 struct soc_camera_ops *ops, int id)
231{
232 int i;
233
234 for (i = 0; i < ops->num_controls; i++)
235 if (ops->controls[i].id == id)
236 return &ops->controls[i];
237
238 return NULL;
239}
240
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300241#define SOCAM_MASTER (1 << 0)
242#define SOCAM_SLAVE (1 << 1)
243#define SOCAM_HSYNC_ACTIVE_HIGH (1 << 2)
244#define SOCAM_HSYNC_ACTIVE_LOW (1 << 3)
245#define SOCAM_VSYNC_ACTIVE_HIGH (1 << 4)
246#define SOCAM_VSYNC_ACTIVE_LOW (1 << 5)
Guennadi Liakhovetski042d8792008-12-19 10:07:49 -0300247#define SOCAM_DATAWIDTH_4 (1 << 6)
248#define SOCAM_DATAWIDTH_8 (1 << 7)
249#define SOCAM_DATAWIDTH_9 (1 << 8)
250#define SOCAM_DATAWIDTH_10 (1 << 9)
251#define SOCAM_DATAWIDTH_15 (1 << 10)
252#define SOCAM_DATAWIDTH_16 (1 << 11)
253#define SOCAM_PCLK_SAMPLE_RISING (1 << 12)
254#define SOCAM_PCLK_SAMPLE_FALLING (1 << 13)
255#define SOCAM_DATA_ACTIVE_HIGH (1 << 14)
256#define SOCAM_DATA_ACTIVE_LOW (1 << 15)
Guennadi Liakhovetskib7ccdba2011-06-04 17:24:22 -0300257#define SOCAM_MIPI_1LANE (1 << 16)
258#define SOCAM_MIPI_2LANE (1 << 17)
259#define SOCAM_MIPI_3LANE (1 << 18)
260#define SOCAM_MIPI_4LANE (1 << 19)
261#define SOCAM_MIPI (SOCAM_MIPI_1LANE | SOCAM_MIPI_2LANE | \
262 SOCAM_MIPI_3LANE | SOCAM_MIPI_4LANE)
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300263
Guennadi Liakhovetski042d8792008-12-19 10:07:49 -0300264#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
265 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
266 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300267
268static inline unsigned long soc_camera_bus_param_compatible(
269 unsigned long camera_flags, unsigned long bus_flags)
270{
Guennadi Liakhovetskif7f41482009-02-23 12:13:24 -0300271 unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
Kassey Liee1b6f42011-04-07 14:01:29 -0300272 unsigned long mipi;
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300273
274 common_flags = camera_flags & bus_flags;
275
276 hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
277 vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
278 pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
Guennadi Liakhovetskif7f41482009-02-23 12:13:24 -0300279 data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
280 mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
281 buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
Kassey Liee1b6f42011-04-07 14:01:29 -0300282 mipi = common_flags & SOCAM_MIPI;
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300283
Kassey Liee1b6f42011-04-07 14:01:29 -0300284 return ((!hsync || !vsync || !pclk || !data || !mode || !buswidth) && !mipi) ? 0 :
Guennadi Liakhovetskif7f41482009-02-23 12:13:24 -0300285 common_flags;
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300286}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300287
Márton Némethe26b3142010-02-24 17:13:29 -0300288static inline void soc_camera_limit_side(int *start, int *length,
289 unsigned int start_min,
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -0300290 unsigned int length_min, unsigned int length_max)
291{
292 if (*length < length_min)
293 *length = length_min;
294 else if (*length > length_max)
295 *length = length_max;
296
297 if (*start < start_min)
298 *start = start_min;
299 else if (*start > start_min + length_max - *length)
300 *start = start_min + length_max - *length;
301}
302
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300303extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
304 unsigned long flags);
305
Mauro Carvalho Chehab4f9fb5e2010-05-18 00:46:09 -0300306/* This is only temporary here - until v4l2-subdev begins to link to video_device */
307#include <linux/i2c.h>
308static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client)
309{
310 struct soc_camera_device *icd = client->dev.platform_data;
311 return icd->vdev;
312}
313
Guennadi Liakhovetski8eb44762011-02-07 18:09:30 -0300314static inline struct soc_camera_device *soc_camera_from_vb2q(struct vb2_queue *vq)
315{
316 return container_of(vq, struct soc_camera_device, vb2_vidq);
317}
318
319static inline struct soc_camera_device *soc_camera_from_vbq(struct videobuf_queue *vq)
320{
321 return container_of(vq, struct soc_camera_device, vb_vidq);
322}
323
Guennadi Liakhovetski592c2ab2011-01-29 12:44:51 -0300324void soc_camera_lock(struct vb2_queue *vq);
325void soc_camera_unlock(struct vb2_queue *vq);
326
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300327#endif