blob: 1864e2242d45d2959cf1bd63b307e69d7de76c6a [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>
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030022#include <media/v4l2-device.h>
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030023
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030024struct file;
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -030025struct soc_camera_link;
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030026
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030027struct soc_camera_device {
Guennadi Liakhovetskid33b2902011-07-01 11:31:35 -030028 struct list_head list; /* list of all registered devices */
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -030029 struct soc_camera_link *link;
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030030 struct device *pdev; /* Platform device */
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -030031 struct device *parent; /* Camera host device */
32 struct device *control; /* E.g., the i2c client */
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -030033 s32 user_width;
34 s32 user_height;
Sergio Aguirre0e4c1802011-03-07 21:49:48 -030035 u32 bytesperline; /* for padding, zero if unused */
36 u32 sizeimage;
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -030037 enum v4l2_colorspace colorspace;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030038 unsigned char iface; /* Host number */
39 unsigned char devnum; /* Device number per host */
Guennadi Liakhovetskia9bef512008-12-18 11:34:20 -030040 struct soc_camera_sense *sense; /* See comment in struct definition */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030041 struct soc_camera_ops *ops;
42 struct video_device *vdev;
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -030043 const struct soc_camera_format_xlate *current_fmt;
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030044 struct soc_camera_format_xlate *user_formats;
45 int num_user_formats;
Guennadi Liakhovetski025c18a2009-03-13 06:08:20 -030046 enum v4l2_field field; /* Preserve field over close() */
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030047 void *host_priv; /* Per-device host private data */
48 /* soc_camera.c private count. Only accessed with .video_lock held */
Guennadi Liakhovetski9dc4e482008-04-22 14:45:32 -030049 int use_count;
Guennadi Liakhovetski1c3bb742008-12-18 12:28:54 -030050 struct mutex video_lock; /* Protects device data */
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030051 struct file *streamer; /* stream owner */
Guennadi Liakhovetski592c2ab2011-01-29 12:44:51 -030052 union {
53 struct videobuf_queue vb_vidq;
54 struct vb2_queue vb2_vidq;
55 };
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030056};
57
58struct soc_camera_host {
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -030059 struct v4l2_device v4l2_dev;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030060 struct list_head list;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030061 unsigned char nr; /* Host number */
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030062 void *priv;
Kay Sieversaf128a12008-10-30 00:51:46 -030063 const char *drv_name;
Guennadi Liakhovetskib8d99042008-04-04 13:41:25 -030064 struct soc_camera_host_ops *ops;
65};
66
67struct soc_camera_host_ops {
68 struct module *owner;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030069 int (*add)(struct soc_camera_device *);
70 void (*remove)(struct soc_camera_device *);
Guennadi Liakhovetskifa489842009-08-25 11:46:43 -030071 /*
72 * .get_formats() is called for each client device format, but
73 * .put_formats() is only called once. Further, if any of the calls to
74 * .get_formats() fail, .put_formats() will not be called at all, the
75 * failing .get_formats() must then clean up internally.
76 */
Hans Verkuil3805f202010-05-08 17:55:00 -030077 int (*get_formats)(struct soc_camera_device *, unsigned int,
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -030078 struct soc_camera_format_xlate *);
Guennadi Liakhovetskifa489842009-08-25 11:46:43 -030079 void (*put_formats)(struct soc_camera_device *);
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -030080 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
81 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetski08590b92009-08-25 11:46:54 -030082 int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetskiaee5c2f2011-03-28 13:28:28 -030083 /*
84 * The difference to .set_crop() is, that .set_livecrop is not allowed
85 * to change the output sizes
86 */
87 int (*set_livecrop)(struct soc_camera_device *, struct v4l2_crop *);
Guennadi Liakhovetski09e231b2009-03-13 06:08:20 -030088 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
Guennadi Liakhovetskid8fac212008-12-01 09:45:21 -030089 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
Magnus Damma034d1b2008-07-11 20:59:34 -030090 void (*init_videobuf)(struct videobuf_queue *,
Paulius Zaleckas092d3922008-07-11 20:50:31 -030091 struct soc_camera_device *);
Guennadi Liakhovetski592c2ab2011-01-29 12:44:51 -030092 int (*init_videobuf2)(struct vb2_queue *,
93 struct soc_camera_device *);
Guennadi Liakhovetski57bee292010-08-17 14:29:51 -030094 int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -030095 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -030096 int (*set_bus_param)(struct soc_camera_device *, __u32);
Guennadi Liakhovetski2840d242009-08-25 11:44:15 -030097 int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
98 int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
Guennadi Liakhovetskic9f6ef62010-02-09 18:00:30 +010099 int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
100 int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
Qing Xued5b65d2011-01-20 05:19:40 -0300101 int (*enum_fsizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300102 unsigned int (*poll)(struct file *, poll_table *);
Guennadi Liakhovetski2840d242009-08-25 11:44:15 -0300103 const struct v4l2_queryctrl *controls;
104 int num_controls;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300105};
106
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300107#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
108#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
109#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
110#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
111#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
112
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300113struct i2c_board_info;
Alberto Panizzo96e442c2010-12-02 07:43:37 -0300114struct regulator_bulk_data;
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300115
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300116struct soc_camera_link {
117 /* Camera bus id, used to match a camera and a bus */
118 int bus_id;
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300119 /* Per camera SOCAM_SENSOR_* bus flags */
120 unsigned long flags;
Guennadi Liakhovetski0fd327b2009-05-07 13:25:32 -0300121 int i2c_adapter_id;
122 struct i2c_board_info *board_info;
123 const char *module_name;
Guennadi Liakhovetski3fd7cef2009-12-11 11:15:06 -0300124 void *priv;
125
Alberto Panizzo96e442c2010-12-02 07:43:37 -0300126 /* Optional regulators that have to be managed on power on/off events */
127 struct regulator_bulk_data *regulators;
128 int num_regulators;
129
Guennadi Liakhovetskic41deba2009-08-25 11:06:21 -0300130 /*
Guennadi Liakhovetskid33b2902011-07-01 11:31:35 -0300131 * For non-I2C devices platform has to provide methods to add a device
132 * to the system and to remove it
Guennadi Liakhovetskic41deba2009-08-25 11:06:21 -0300133 */
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -0300134 int (*add_device)(struct soc_camera_device *);
135 void (*del_device)(struct soc_camera_device *);
Stefan Herbrechtsmeier81034662008-08-14 12:04:11 -0300136 /* Optional callbacks to power on or off and reset the sensor */
137 int (*power)(struct device *, int);
138 int (*reset)(struct device *);
Sascha Hauer28f59332009-03-13 06:08:20 -0300139 /*
140 * some platforms may support different data widths than the sensors
141 * native ones due to different data line routing. Let the board code
142 * overwrite the width flags.
143 */
144 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
145 unsigned long (*query_bus_param)(struct soc_camera_link *);
Guennadi Liakhovetski594bb462009-04-24 12:53:51 -0300146 void (*free_bus)(struct soc_camera_link *);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300147};
148
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300149static inline struct soc_camera_host *to_soc_camera_host(
150 const struct device *dev)
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300151{
Guennadi Liakhovetski979ea1d2009-08-25 11:43:33 -0300152 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
153
154 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300155}
156
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300157static inline struct soc_camera_link *to_soc_camera_link(
158 const struct soc_camera_device *icd)
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300159{
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -0300160 return icd->link;
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300161}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300162
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300163static inline struct device *to_soc_camera_control(
164 const struct soc_camera_device *icd)
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300165{
Guennadi Liakhovetski7dfff952011-07-15 20:03:38 -0300166 return icd->control;
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300167}
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300168
Guennadi Liakhovetski96c75392009-08-25 11:53:23 -0300169static inline struct v4l2_subdev *soc_camera_to_subdev(
170 const struct soc_camera_device *icd)
Guennadi Liakhovetskic9c1f1c2009-08-25 11:46:59 -0300171{
172 struct device *control = to_soc_camera_control(icd);
173 return dev_get_drvdata(control);
174}
175
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300176int soc_camera_host_register(struct soc_camera_host *ici);
177void soc_camera_host_unregister(struct soc_camera_host *ici);
178
Guennadi Liakhovetski40e2e092009-08-25 11:28:22 -0300179const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300180 struct soc_camera_device *icd, unsigned int fourcc);
Guennadi Liakhovetski25c4d742008-12-01 09:44:59 -0300181
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300182/**
183 * struct soc_camera_format_xlate - match between host and sensor formats
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -0300184 * @code: code of a sensor provided format
185 * @host_fmt: host format after host translation from code
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300186 *
187 * Host and sensor translation structure. Used in table of host and sensor
188 * formats matchings in soc_camera_device. A host can override the generic list
189 * generation by implementing get_formats(), and use it for format checks and
190 * format setup.
191 */
192struct soc_camera_format_xlate {
Guennadi Liakhovetski760697b2009-12-11 11:46:49 -0300193 enum v4l2_mbus_pixelcode code;
194 const struct soc_mbus_pixelfmt *host_fmt;
Guennadi Liakhovetskic2786ad2008-12-01 09:45:27 -0300195};
196
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300197struct soc_camera_ops {
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300198 const struct v4l2_queryctrl *controls;
199 int num_controls;
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300200};
201
Guennadi Liakhovetskia9bef512008-12-18 11:34:20 -0300202#define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
203
204/**
205 * This struct can be attached to struct soc_camera_device by the host driver
206 * to request sense from the camera, for example, when calling .set_fmt(). The
207 * host then can check which flags are set and verify respective values if any.
208 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
209 * changed during this operation. After completion the host should detach sense.
210 *
211 * @flags ored SOCAM_SENSE_* flags
212 * @master_clock if the host wants to be informed about pixel-clock
213 * change, it better set master_clock.
214 * @pixel_clock_max maximum pixel clock frequency supported by the host,
215 * camera is not allowed to exceed this.
216 * @pixel_clock if the camera driver changed pixel clock during this
217 * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
218 * master_clock to calculate the new pixel-clock and
219 * sets this field.
220 */
221struct soc_camera_sense {
222 unsigned long flags;
223 unsigned long master_clock;
224 unsigned long pixel_clock_max;
225 unsigned long pixel_clock;
226};
227
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300228static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
229 struct soc_camera_ops *ops, int id)
230{
231 int i;
232
233 for (i = 0; i < ops->num_controls; i++)
234 if (ops->controls[i].id == id)
235 return &ops->controls[i];
236
237 return NULL;
238}
239
Guennadi Liakhovetskid839fe12011-07-28 18:42:57 -0300240#define SOCAM_DATAWIDTH(x) BIT((x) - 1)
241#define SOCAM_DATAWIDTH_4 SOCAM_DATAWIDTH(4)
242#define SOCAM_DATAWIDTH_8 SOCAM_DATAWIDTH(8)
243#define SOCAM_DATAWIDTH_9 SOCAM_DATAWIDTH(9)
244#define SOCAM_DATAWIDTH_10 SOCAM_DATAWIDTH(10)
245#define SOCAM_DATAWIDTH_15 SOCAM_DATAWIDTH(15)
246#define SOCAM_DATAWIDTH_16 SOCAM_DATAWIDTH(16)
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300247
Guennadi Liakhovetski042d8792008-12-19 10:07:49 -0300248#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
249 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
250 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
Guennadi Liakhovetskiad5f2e82008-03-07 21:57:18 -0300251
Márton Némethe26b3142010-02-24 17:13:29 -0300252static inline void soc_camera_limit_side(int *start, int *length,
253 unsigned int start_min,
Guennadi Liakhovetski6a6c8782009-08-25 11:50:46 -0300254 unsigned int length_min, unsigned int length_max)
255{
256 if (*length < length_min)
257 *length = length_min;
258 else if (*length > length_max)
259 *length = length_max;
260
261 if (*start < start_min)
262 *start = start_min;
263 else if (*start > start_min + length_max - *length)
264 *start = start_min + length_max - *length;
265}
266
Guennadi Liakhovetski32c69fc2011-07-26 11:38:01 -0300267unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
268 unsigned long flags);
269unsigned long soc_camera_apply_board_flags(struct soc_camera_link *icl,
270 const struct v4l2_mbus_config *cfg);
Guennadi Liakhovetskibd73b362008-12-23 05:54:45 -0300271
Mauro Carvalho Chehab4f9fb5e2010-05-18 00:46:09 -0300272/* This is only temporary here - until v4l2-subdev begins to link to video_device */
273#include <linux/i2c.h>
274static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client)
275{
276 struct soc_camera_device *icd = client->dev.platform_data;
277 return icd->vdev;
278}
279
Guennadi Liakhovetski8eb44762011-02-07 18:09:30 -0300280static inline struct soc_camera_device *soc_camera_from_vb2q(struct vb2_queue *vq)
281{
282 return container_of(vq, struct soc_camera_device, vb2_vidq);
283}
284
285static inline struct soc_camera_device *soc_camera_from_vbq(struct videobuf_queue *vq)
286{
287 return container_of(vq, struct soc_camera_device, vb_vidq);
288}
289
Guennadi Liakhovetski592c2ab2011-01-29 12:44:51 -0300290void soc_camera_lock(struct vb2_queue *vq);
291void soc_camera_unlock(struct vb2_queue *vq);
292
Guennadi Liakhovetskie55222e2008-04-22 14:42:03 -0300293#endif