]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/media/soc_camera.h
[media] soc-camera: Continue the power off sequence if one of the steps fails
[mirror_ubuntu-artful-kernel.git] / include / media / soc_camera.h
CommitLineData
e55222ef
GL
1/*
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
d839fe17 15#include <linux/bitops.h>
52d268a3 16#include <linux/device.h>
1c3bb743
GL
17#include <linux/mutex.h>
18#include <linux/pm.h>
e55222ef 19#include <linux/videodev2.h>
092d3921 20#include <media/videobuf-core.h>
592c2aba 21#include <media/videobuf2-core.h>
ee02da64 22#include <media/v4l2-ctrls.h>
979ea1dd 23#include <media/v4l2-device.h>
e55222ef 24
57bee29d 25struct file;
7dfff953 26struct soc_camera_link;
57bee29d 27
e55222ef 28struct soc_camera_device {
d33b290a 29 struct list_head list; /* list of all registered devices */
7dfff953 30 struct soc_camera_link *link;
979ea1dd 31 struct device *pdev; /* Platform device */
7dfff953
GL
32 struct device *parent; /* Camera host device */
33 struct device *control; /* E.g., the i2c client */
6a6c8786
GL
34 s32 user_width;
35 s32 user_height;
0e4c180d
SA
36 u32 bytesperline; /* for padding, zero if unused */
37 u32 sizeimage;
760697be 38 enum v4l2_colorspace colorspace;
e55222ef
GL
39 unsigned char iface; /* Host number */
40 unsigned char devnum; /* Device number per host */
a9bef518 41 struct soc_camera_sense *sense; /* See comment in struct definition */
e55222ef 42 struct video_device *vdev;
ee02da64 43 struct v4l2_ctrl_handler ctrl_handler;
760697be 44 const struct soc_camera_format_xlate *current_fmt;
c2786ad2
GL
45 struct soc_camera_format_xlate *user_formats;
46 int num_user_formats;
025c18a1 47 enum v4l2_field field; /* Preserve field over close() */
1c3bb743
GL
48 void *host_priv; /* Per-device host private data */
49 /* soc_camera.c private count. Only accessed with .video_lock held */
9dc4e48f 50 int use_count;
1c3bb743 51 struct mutex video_lock; /* Protects device data */
57bee29d 52 struct file *streamer; /* stream owner */
592c2aba
GL
53 union {
54 struct videobuf_queue vb_vidq;
55 struct vb2_queue vb2_vidq;
56 };
e55222ef
GL
57};
58
914f05c8
LP
59/* Host supports programmable stride */
60#define SOCAM_HOST_CAP_STRIDE (1 << 0)
61
e55222ef 62struct soc_camera_host {
979ea1dd 63 struct v4l2_device v4l2_dev;
e55222ef 64 struct list_head list;
2f9a0c88
GL
65 struct mutex host_lock; /* Protect during probing */
66 unsigned char nr; /* Host number */
914f05c8 67 u32 capabilities;
e55222ef 68 void *priv;
af128a10 69 const char *drv_name;
b8d9904c
GL
70 struct soc_camera_host_ops *ops;
71};
72
73struct soc_camera_host_ops {
74 struct module *owner;
e55222ef
GL
75 int (*add)(struct soc_camera_device *);
76 void (*remove)(struct soc_camera_device *);
fa48984e
GL
77 /*
78 * .get_formats() is called for each client device format, but
79 * .put_formats() is only called once. Further, if any of the calls to
80 * .get_formats() fail, .put_formats() will not be called at all, the
81 * failing .get_formats() must then clean up internally.
82 */
3805f201 83 int (*get_formats)(struct soc_camera_device *, unsigned int,
c2786ad2 84 struct soc_camera_format_xlate *);
fa48984e 85 void (*put_formats)(struct soc_camera_device *);
6a6c8786
GL
86 int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
87 int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
08590b96 88 int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
aee5c2f1
GL
89 /*
90 * The difference to .set_crop() is, that .set_livecrop is not allowed
91 * to change the output sizes
92 */
93 int (*set_livecrop)(struct soc_camera_device *, struct v4l2_crop *);
09e231b3 94 int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
d8fac217 95 int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
a034d1b7 96 void (*init_videobuf)(struct videobuf_queue *,
092d3921 97 struct soc_camera_device *);
592c2aba
GL
98 int (*init_videobuf2)(struct vb2_queue *,
99 struct soc_camera_device *);
57bee29d 100 int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
e55222ef 101 int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
8843d119 102 int (*set_bus_param)(struct soc_camera_device *);
c9f6ef69
GL
103 int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
104 int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
ad3537b5 105 int (*enum_framesizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
e55222ef
GL
106 unsigned int (*poll)(struct file *, poll_table *);
107};
108
bd73b36f
GL
109#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
110#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
111#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
112#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
113#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
114
0fd327bd 115struct i2c_board_info;
96e442c1 116struct regulator_bulk_data;
0fd327bd 117
e55222ef
GL
118struct soc_camera_link {
119 /* Camera bus id, used to match a camera and a bus */
120 int bus_id;
bd73b36f
GL
121 /* Per camera SOCAM_SENSOR_* bus flags */
122 unsigned long flags;
0fd327bd
GL
123 int i2c_adapter_id;
124 struct i2c_board_info *board_info;
125 const char *module_name;
3fd7ceff
GL
126 void *priv;
127
96e442c1
AP
128 /* Optional regulators that have to be managed on power on/off events */
129 struct regulator_bulk_data *regulators;
130 int num_regulators;
131
c41debaf 132 /*
d33b290a
GL
133 * For non-I2C devices platform has to provide methods to add a device
134 * to the system and to remove it
c41debaf 135 */
7dfff953
GL
136 int (*add_device)(struct soc_camera_device *);
137 void (*del_device)(struct soc_camera_device *);
81034663
SH
138 /* Optional callbacks to power on or off and reset the sensor */
139 int (*power)(struct device *, int);
140 int (*reset)(struct device *);
28f59339
SH
141 /*
142 * some platforms may support different data widths than the sensors
143 * native ones due to different data line routing. Let the board code
144 * overwrite the width flags.
145 */
146 int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
147 unsigned long (*query_bus_param)(struct soc_camera_link *);
594bb46d 148 void (*free_bus)(struct soc_camera_link *);
e55222ef
GL
149};
150
96c75399
GL
151static inline struct soc_camera_host *to_soc_camera_host(
152 const struct device *dev)
e55222ef 153{
979ea1dd
GL
154 struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
155
156 return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
e55222ef
GL
157}
158
96c75399
GL
159static inline struct soc_camera_link *to_soc_camera_link(
160 const struct soc_camera_device *icd)
40e2e092 161{
7dfff953 162 return icd->link;
40e2e092 163}
e55222ef 164
96c75399
GL
165static inline struct device *to_soc_camera_control(
166 const struct soc_camera_device *icd)
40e2e092 167{
7dfff953 168 return icd->control;
40e2e092 169}
e55222ef 170
96c75399
GL
171static inline struct v4l2_subdev *soc_camera_to_subdev(
172 const struct soc_camera_device *icd)
c9c1f1c0
GL
173{
174 struct device *control = to_soc_camera_control(icd);
175 return dev_get_drvdata(control);
176}
177
40e2e092
GL
178int soc_camera_host_register(struct soc_camera_host *ici);
179void soc_camera_host_unregister(struct soc_camera_host *ici);
180
40e2e092 181const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
c2786ad2 182 struct soc_camera_device *icd, unsigned int fourcc);
25c4d74e 183
c2786ad2
GL
184/**
185 * struct soc_camera_format_xlate - match between host and sensor formats
760697be
GL
186 * @code: code of a sensor provided format
187 * @host_fmt: host format after host translation from code
c2786ad2
GL
188 *
189 * Host and sensor translation structure. Used in table of host and sensor
190 * formats matchings in soc_camera_device. A host can override the generic list
191 * generation by implementing get_formats(), and use it for format checks and
192 * format setup.
193 */
194struct soc_camera_format_xlate {
760697be
GL
195 enum v4l2_mbus_pixelcode code;
196 const struct soc_mbus_pixelfmt *host_fmt;
c2786ad2
GL
197};
198
a9bef518
GL
199#define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
200
201/**
202 * This struct can be attached to struct soc_camera_device by the host driver
203 * to request sense from the camera, for example, when calling .set_fmt(). The
204 * host then can check which flags are set and verify respective values if any.
205 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
206 * changed during this operation. After completion the host should detach sense.
207 *
208 * @flags ored SOCAM_SENSE_* flags
209 * @master_clock if the host wants to be informed about pixel-clock
210 * change, it better set master_clock.
211 * @pixel_clock_max maximum pixel clock frequency supported by the host,
212 * camera is not allowed to exceed this.
213 * @pixel_clock if the camera driver changed pixel clock during this
214 * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
215 * master_clock to calculate the new pixel-clock and
216 * sets this field.
217 */
218struct soc_camera_sense {
219 unsigned long flags;
220 unsigned long master_clock;
221 unsigned long pixel_clock_max;
222 unsigned long pixel_clock;
223};
224
d839fe17
GL
225#define SOCAM_DATAWIDTH(x) BIT((x) - 1)
226#define SOCAM_DATAWIDTH_4 SOCAM_DATAWIDTH(4)
227#define SOCAM_DATAWIDTH_8 SOCAM_DATAWIDTH(8)
228#define SOCAM_DATAWIDTH_9 SOCAM_DATAWIDTH(9)
229#define SOCAM_DATAWIDTH_10 SOCAM_DATAWIDTH(10)
230#define SOCAM_DATAWIDTH_15 SOCAM_DATAWIDTH(15)
231#define SOCAM_DATAWIDTH_16 SOCAM_DATAWIDTH(16)
042d8790
GL
232
233#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
234 SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
235 SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
ad5f2e85 236
e26b3144
MN
237static inline void soc_camera_limit_side(int *start, int *length,
238 unsigned int start_min,
6a6c8786
GL
239 unsigned int length_min, unsigned int length_max)
240{
241 if (*length < length_min)
242 *length = length_min;
243 else if (*length > length_max)
244 *length = length_max;
245
246 if (*start < start_min)
247 *start = start_min;
248 else if (*start > start_min + length_max - *length)
249 *start = start_min + length_max - *length;
250}
251
32c69fcc
GL
252unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
253 unsigned long flags);
254unsigned long soc_camera_apply_board_flags(struct soc_camera_link *icl,
255 const struct v4l2_mbus_config *cfg);
bd73b36f 256
4f9fb5ed
MCC
257/* This is only temporary here - until v4l2-subdev begins to link to video_device */
258#include <linux/i2c.h>
14178aa5 259static inline struct video_device *soc_camera_i2c_to_vdev(const struct i2c_client *client)
4f9fb5ed 260{
2f0babb7 261 struct v4l2_subdev *sd = i2c_get_clientdata(client);
4c0b036d 262 struct soc_camera_device *icd = v4l2_get_subdev_hostdata(sd);
14178aa5 263 return icd ? icd->vdev : NULL;
4f9fb5ed
MCC
264}
265
14178aa5
GL
266static inline struct soc_camera_link *soc_camera_i2c_to_link(const struct i2c_client *client)
267{
2f0babb7 268 return client->dev.platform_data;
14178aa5
GL
269}
270
271static inline struct v4l2_subdev *soc_camera_vdev_to_subdev(const struct video_device *vdev)
272{
273 struct soc_camera_device *icd = dev_get_drvdata(vdev->parent);
274 return soc_camera_to_subdev(icd);
275}
276
14178aa5 277static inline struct soc_camera_device *soc_camera_from_vb2q(const struct vb2_queue *vq)
8eb4476d
GL
278{
279 return container_of(vq, struct soc_camera_device, vb2_vidq);
280}
281
14178aa5 282static inline struct soc_camera_device *soc_camera_from_vbq(const struct videobuf_queue *vq)
8eb4476d
GL
283{
284 return container_of(vq, struct soc_camera_device, vb_vidq);
285}
286
4c0b036d
GL
287static inline u32 soc_camera_grp_id(const struct soc_camera_device *icd)
288{
289 return (icd->iface << 8) | (icd->devnum + 1);
290}
291
592c2aba
GL
292void soc_camera_lock(struct vb2_queue *vq);
293void soc_camera_unlock(struct vb2_queue *vq);
294
e55222ef 295#endif