blob: b5c2b6cb0d81078f23fb3a6c1c779e90e31b88ce [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 Liakhovetskid839fe12011-07-28 18:42:57 -030015#include <linux/bitops.h>
Guennadi Liakhovetski52d268a2010-07-26 11:37:13 -030016#include <linux/device.h>
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030017#include <linux/mutex.h>
18#include <linux/pm.h>
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030019#include <linux/videodev2.h>
Paulius Zaleckas092d3922008-07-11 20:50:31 -030020#include <media/videobuf-core.h>
Guennadi Liakhovetski592c2ab2011-01-29 12:44:51 -030021#include <media/videobuf2-core.h>
Hans Verkuilee02da62011-09-06 12:36:39 -030022#include <media/v4l2-ctrls.h>
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030023#include <media/v4l2-device.h>
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030024
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030025struct file;
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -030026struct soc_camera_link;
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030027
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030028struct soc_camera_device {
Guennadi Liakhovetskid33b2902011-07-01 11:31:35 -030029 struct list_head list; /* list of all registered devices */
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -030030 struct soc_camera_link *link;
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030031 struct device *pdev; /* Platform device */
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -030032 struct device *parent; /* Camera host device */
33 struct device *control; /* E.g., the i2c client */
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -030034 s32 user_width;
35 s32 user_height;
Sergio Aguirre0e4c1802011-03-07 21:49:48 -030036 u32 bytesperline; /* for padding, zero if unused */
37 u32 sizeimage;
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -030038 enum v4l2_colorspace colorspace;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030039 unsigned char iface; /* Host number */
40 unsigned char devnum; /* Device number per host */
Guennadi Liakhovetskia9bef512008-12-18 11:34:20 -030041 struct soc_camera_sense *sense; /* See comment in struct definition */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030042 struct video_device *vdev;
Hans Verkuilee02da62011-09-06 12:36:39 -030043 struct v4l2_ctrl_handler ctrl_handler;
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -030044 const struct soc_camera_format_xlate *current_fmt;
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030045 struct soc_camera_format_xlate *user_formats;
46 int num_user_formats;
Guennadi Liakhovetski025c18a2009-03-13 06:08:20 -030047 enum v4l2_field field; /* Preserve field over close() */
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030048 void *host_priv; /* Per-device host private data */
49 /* soc_camera.c private count. Only accessed with .video_lock held */
Guennadi Liakhovetski9dc4e482008-04-22 14:45:32 -030050 int use_count;
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030051 struct mutex video_lock; /* Protects device data */
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030052 struct file *streamer; /* stream owner */
Guennadi Liakhovetski592c2ab2011-01-29 12:44:51 -030053 union {
54 struct videobuf_queue vb_vidq;
55 struct vb2_queue vb2_vidq;
56 };
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030057};
58
59struct soc_camera_host {
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030060 struct v4l2_device v4l2_dev;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030061 struct list_head list;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030062 unsigned char nr; /* Host number */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030063 void *priv;
Kay Sieversaf128a12008-10-30 00:51:46 -030064 const char *drv_name;
Guennadi Liakhovetskib8d99042008-04-04 13:41:25 -030065 struct soc_camera_host_ops *ops;
66};
67
68struct soc_camera_host_ops {
69 struct module *owner;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030070 int (*add)(struct soc_camera_device *);
71 void (*remove)(struct soc_camera_device *);
Guennadi Liakhovetskifa489842009-08-25 11:46:43 -030072 /*
73 * .get_formats() is called for each client device format, but
74 * .put_formats() is only called once. Further, if any of the calls to
75 * .get_formats() fail, .put_formats() will not be called at all, the
76 * failing .get_formats() must then clean up internally.
77 */
Hans Verkuil3805f202010-05-08 17:55:00 -030078 int (*get_formats)(struct soc_camera_device *, unsigned int,
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030079 struct soc_camera_format_xlate *);
Guennadi Liakhovetskifa489842009-08-25 11:46:43 -030080 void (*put_formats)(struct soc_camera_device *);
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -030081 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
82 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetski08590b92009-08-25 11:46:54 -030083 int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetskiaee5c2f2011-03-28 13:28:28 -030084 /*
85 * The difference to .set_crop() is, that .set_livecrop is not allowed
86 * to change the output sizes
87 */
88 int (*set_livecrop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetski09e231b2009-03-13 06:08:20 -030089 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
Guennadi Liakhovetskid8fac212008-12-01 09:45:21 -030090 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
Magnus Damma034d1b2008-07-11 20:59:34 -030091 void (*init_videobuf)(struct videobuf_queue *,
Paulius Zaleckas092d3922008-07-11 20:50:31 -030092 struct soc_camera_device *);
Guennadi Liakhovetski592c2ab2011-01-29 12:44:51 -030093 int (*init_videobuf2)(struct vb2_queue *,
94 struct soc_camera_device *);
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030095 int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030096 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
Guennadi Liakhovetski8843d112011-09-21 17:52:51 -030097 int (*set_bus_param)(struct soc_camera_device *);
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 *);
102};
103
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300104#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
105#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
106#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
107#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
108#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
109
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300110struct i2c_board_info;
Alberto Panizzo96e442c2010-12-02 07:43:37 -0300111struct regulator_bulk_data;
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300112
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300113struct soc_camera_link {
114 /* Camera bus id, used to match a camera and a bus */
115 int bus_id;
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300116 /* Per camera SOCAM_SENSOR_* bus flags */
117 unsigned long flags;
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300118 int i2c_adapter_id;
119 struct i2c_board_info *board_info;
120 const char *module_name;
Guennadi Liakhovetski3fd7cef2009-12-11 11:15:06 -0300121 void *priv;
122
Alberto Panizzo96e442c2010-12-02 07:43:37 -0300123 /* Optional regulators that have to be managed on power on/off events */
124 struct regulator_bulk_data *regulators;
125 int num_regulators;
126
Guennadi Liakhovetskic41deba2009-08-25 11:06:21 -0300127 /*
Guennadi Liakhovetskid33b2902011-07-01 11:31:35 -0300128 * For non-I2C devices platform has to provide methods to add a device
129 * to the system and to remove it
Guennadi Liakhovetskic41deba2009-08-25 11:06:21 -0300130 */
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -0300131 int (*add_device)(struct soc_camera_device *);
132 void (*del_device)(struct soc_camera_device *);
Stefan Herbrechtsmeier81034662008-08-14 12:04:11 -0300133 /* Optional callbacks to power on or off and reset the sensor */
134 int (*power)(struct device *, int);
135 int (*reset)(struct device *);
Sascha Hauer28f59332009-03-13 06:08:20 -0300136 /*
137 * some platforms may support different data widths than the sensors
138 * native ones due to different data line routing. Let the board code
139 * overwrite the width flags.
140 */
141 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
142 unsigned long (*query_bus_param)(struct soc_camera_link *);
Guennadi Liakhovetski594bb462009-04-24 12:53:51 -0300143 void (*free_bus)(struct soc_camera_link *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300144};
145
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300146static inline struct soc_camera_host *to_soc_camera_host(
147 const struct device *dev)
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300148{
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -0300149 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
150
151 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300152}
153
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300154static inline struct soc_camera_link *to_soc_camera_link(
155 const struct soc_camera_device *icd)
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300156{
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -0300157 return icd->link;
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300158}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300159
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300160static inline struct device *to_soc_camera_control(
161 const struct soc_camera_device *icd)
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300162{
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -0300163 return icd->control;
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300164}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300165
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300166static inline struct v4l2_subdev *soc_camera_to_subdev(
167 const struct soc_camera_device *icd)
Guennadi Liakhovetskic9c1f1c2009-08-25 11:46:59 -0300168{
169 struct device *control = to_soc_camera_control(icd);
170 return dev_get_drvdata(control);
171}
172
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300173int soc_camera_host_register(struct soc_camera_host *ici);
174void soc_camera_host_unregister(struct soc_camera_host *ici);
175
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300176const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300177 struct soc_camera_device *icd, unsigned int fourcc);
Guennadi Liakhovetski25c4d742008-12-01 09:44:59 -0300178
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300179/**
180 * struct soc_camera_format_xlate - match between host and sensor formats
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -0300181 * @code: code of a sensor provided format
182 * @host_fmt: host format after host translation from code
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300183 *
184 * Host and sensor translation structure. Used in table of host and sensor
185 * formats matchings in soc_camera_device. A host can override the generic list
186 * generation by implementing get_formats(), and use it for format checks and
187 * format setup.
188 */
189struct soc_camera_format_xlate {
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -0300190 enum v4l2_mbus_pixelcode code;
191 const struct soc_mbus_pixelfmt *host_fmt;
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300192};
193
Guennadi Liakhovetskia9bef512008-12-18 11:34:20 -0300194#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
Guennadi Liakhovetskid839fe12011-07-28 18:42:57 -0300220#define SOCAM_DATAWIDTH(x) BIT((x) - 1)
221#define SOCAM_DATAWIDTH_4 SOCAM_DATAWIDTH(4)
222#define SOCAM_DATAWIDTH_8 SOCAM_DATAWIDTH(8)
223#define SOCAM_DATAWIDTH_9 SOCAM_DATAWIDTH(9)
224#define SOCAM_DATAWIDTH_10 SOCAM_DATAWIDTH(10)
225#define SOCAM_DATAWIDTH_15 SOCAM_DATAWIDTH(15)
226#define SOCAM_DATAWIDTH_16 SOCAM_DATAWIDTH(16)
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300227
Guennadi Liakhovetski042d8792008-12-19 10:07:49 -0300228#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
229 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
230 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300231
Márton Némethe26b3142010-02-24 17:13:29 -0300232static inline void soc_camera_limit_side(int *start, int *length,
233 unsigned int start_min,
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -0300234 unsigned int length_min, unsigned int length_max)
235{
236 if (*length < length_min)
237 *length = length_min;
238 else if (*length > length_max)
239 *length = length_max;
240
241 if (*start < start_min)
242 *start = start_min;
243 else if (*start > start_min + length_max - *length)
244 *start = start_min + length_max - *length;
245}
246
Guennadi Liakhovetski32c69fcc2011-07-26 11:38:01 -0300247unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
248 unsigned long flags);
249unsigned long soc_camera_apply_board_flags(struct soc_camera_link *icl,
250 const struct v4l2_mbus_config *cfg);
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300251
Mauro Carvalho Chehab4f9fb5e2010-05-18 00:46:09 -0300252/* This is only temporary here - until v4l2-subdev begins to link to video_device */
253#include <linux/i2c.h>
Guennadi Liakhovetski14178aa2011-09-21 15:16:30 -0300254static inline struct video_device *soc_camera_i2c_to_vdev(const struct i2c_client *client)
Mauro Carvalho Chehab4f9fb5e2010-05-18 00:46:09 -0300255{
Guennadi Liakhovetski2f0babb2011-09-09 13:39:20 -0300256 struct v4l2_subdev *sd = i2c_get_clientdata(client);
Guennadi Liakhovetski4c0b0362011-12-05 16:01:13 -0300257 struct soc_camera_device *icd = v4l2_get_subdev_hostdata(sd);
Guennadi Liakhovetski14178aa2011-09-21 15:16:30 -0300258 return icd ? icd->vdev : NULL;
Mauro Carvalho Chehab4f9fb5e2010-05-18 00:46:09 -0300259}
260
Guennadi Liakhovetski14178aa2011-09-21 15:16:30 -0300261static inline struct soc_camera_link *soc_camera_i2c_to_link(const struct i2c_client *client)
262{
Guennadi Liakhovetski2f0babb2011-09-09 13:39:20 -0300263 return client->dev.platform_data;
Guennadi Liakhovetski14178aa2011-09-21 15:16:30 -0300264}
265
266static inline struct v4l2_subdev *soc_camera_vdev_to_subdev(const struct video_device *vdev)
267{
268 struct soc_camera_device *icd = dev_get_drvdata(vdev->parent);
269 return soc_camera_to_subdev(icd);
270}
271
Guennadi Liakhovetski14178aa2011-09-21 15:16:30 -0300272static inline struct soc_camera_device *soc_camera_from_vb2q(const struct vb2_queue *vq)
Guennadi Liakhovetski8eb44762011-02-07 18:09:30 -0300273{
274 return container_of(vq, struct soc_camera_device, vb2_vidq);
275}
276
Guennadi Liakhovetski14178aa2011-09-21 15:16:30 -0300277static inline struct soc_camera_device *soc_camera_from_vbq(const struct videobuf_queue *vq)
Guennadi Liakhovetski8eb44762011-02-07 18:09:30 -0300278{
279 return container_of(vq, struct soc_camera_device, vb_vidq);
280}
281
Guennadi Liakhovetski4c0b0362011-12-05 16:01:13 -0300282static inline u32 soc_camera_grp_id(const struct soc_camera_device *icd)
283{
284 return (icd->iface << 8) | (icd->devnum + 1);
285}
286
Guennadi Liakhovetski592c2ab2011-01-29 12:44:51 -0300287void soc_camera_lock(struct vb2_queue *vq);
288void soc_camera_unlock(struct vb2_queue *vq);
289
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300290#endif