[mirror_ubuntu-zesty-kernel.git] / include / media / soc_camera.h

/*
 * camera image capture (abstract) bus driver header
 *
 * Copyright (C) 2006, Sascha Hauer, Pengutronix
 * Copyright (C) 2008, Guennadi Liakhovetski <kernel@pengutronix.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef SOC_CAMERA_H
#define SOC_CAMERA_H

#include <linux/device.h>
#include <linux/mutex.h>
#include <linux/pm.h>
#include <linux/videodev2.h>
#include <media/videobuf-core.h>
#include <media/videobuf2-core.h>
#include <media/v4l2-device.h>

struct file;

struct soc_camera_device {
	struct list_head list;		/* list of all registered devices */
	struct device dev;
	struct device *pdev;		/* Platform device */
	s32 user_width;
	s32 user_height;
	u32 bytesperline;		/* for padding, zero if unused */
	u32 sizeimage;
	enum v4l2_colorspace colorspace;
	unsigned char iface;		/* Host number */
	unsigned char devnum;		/* Device number per host */
	struct soc_camera_sense *sense;	/* See comment in struct definition */
	struct soc_camera_ops *ops;
	struct video_device *vdev;
	const struct soc_camera_format_xlate *current_fmt;
	struct soc_camera_format_xlate *user_formats;
	int num_user_formats;
	enum v4l2_field field;		/* Preserve field over close() */
	void *host_priv;		/* Per-device host private data */
	/* soc_camera.c private count. Only accessed with .video_lock held */
	int use_count;
	struct mutex video_lock;	/* Protects device data */
	struct file *streamer;		/* stream owner */
	union {
		struct videobuf_queue vb_vidq;
		struct vb2_queue vb2_vidq;
	};
};

struct soc_camera_host {
	struct v4l2_device v4l2_dev;
	struct list_head list;
	unsigned char nr;				/* Host number */
	void *priv;
	const char *drv_name;
	struct soc_camera_host_ops *ops;
};

struct soc_camera_host_ops {
	struct module *owner;
	int (*add)(struct soc_camera_device *);
	void (*remove)(struct soc_camera_device *);
	/*
	 * .get_formats() is called for each client device format, but
	 * .put_formats() is only called once. Further, if any of the calls to
	 * .get_formats() fail, .put_formats() will not be called at all, the
	 * failing .get_formats() must then clean up internally.
	 */
	int (*get_formats)(struct soc_camera_device *, unsigned int,
			   struct soc_camera_format_xlate *);
	void (*put_formats)(struct soc_camera_device *);
	int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
	int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
	int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
	/*
	 * The difference to .set_crop() is, that .set_livecrop is not allowed
	 * to change the output sizes
	 */
	int (*set_livecrop)(struct soc_camera_device *, struct v4l2_crop *);
	int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
	int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
	void (*init_videobuf)(struct videobuf_queue *,
			      struct soc_camera_device *);
	int (*init_videobuf2)(struct vb2_queue *,
			      struct soc_camera_device *);
	int (*reqbufs)(struct soc_camera_device *, struct v4l2_requestbuffers *);
	int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
	int (*set_bus_param)(struct soc_camera_device *, __u32);
	int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
	int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
	int (*get_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
	int (*set_parm)(struct soc_camera_device *, struct v4l2_streamparm *);
	int (*enum_fsizes)(struct soc_camera_device *, struct v4l2_frmsizeenum *);
	unsigned int (*poll)(struct file *, poll_table *);
	const struct v4l2_queryctrl *controls;
	int num_controls;
};

#define SOCAM_SENSOR_INVERT_PCLK	(1 << 0)
#define SOCAM_SENSOR_INVERT_MCLK	(1 << 1)
#define SOCAM_SENSOR_INVERT_HSYNC	(1 << 2)
#define SOCAM_SENSOR_INVERT_VSYNC	(1 << 3)
#define SOCAM_SENSOR_INVERT_DATA	(1 << 4)

struct i2c_board_info;
struct regulator_bulk_data;

struct soc_camera_link {
	/* Camera bus id, used to match a camera and a bus */
	int bus_id;
	/* Per camera SOCAM_SENSOR_* bus flags */
	unsigned long flags;
	int i2c_adapter_id;
	struct i2c_board_info *board_info;
	const char *module_name;
	void *priv;

	/* Optional regulators that have to be managed on power on/off events */
	struct regulator_bulk_data *regulators;
	int num_regulators;

	/*
	 * For non-I2C devices platform has to provide methods to add a device
	 * to the system and to remove it
	 */
	int (*add_device)(struct soc_camera_link *, struct device *);
	void (*del_device)(struct soc_camera_link *);
	/* Optional callbacks to power on or off and reset the sensor */
	int (*power)(struct device *, int);
	int (*reset)(struct device *);
	/*
	 * some platforms may support different data widths than the sensors
	 * native ones due to different data line routing. Let the board code
	 * overwrite the width flags.
	 */
	int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
	unsigned long (*query_bus_param)(struct soc_camera_link *);
	void (*free_bus)(struct soc_camera_link *);
};

static inline struct soc_camera_device *to_soc_camera_dev(
	const struct device *dev)
{
	return container_of(dev, struct soc_camera_device, dev);
}

static inline struct soc_camera_host *to_soc_camera_host(
	const struct device *dev)
{
	struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);

	return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
}

static inline struct soc_camera_link *to_soc_camera_link(
	const struct soc_camera_device *icd)
{
	return icd->dev.platform_data;
}

static inline struct device *to_soc_camera_control(
	const struct soc_camera_device *icd)
{
	return dev_get_drvdata(&icd->dev);
}

static inline struct v4l2_subdev *soc_camera_to_subdev(
	const struct soc_camera_device *icd)
{
	struct device *control = to_soc_camera_control(icd);
	return dev_get_drvdata(control);
}

int soc_camera_host_register(struct soc_camera_host *ici);
void soc_camera_host_unregister(struct soc_camera_host *ici);

const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
	struct soc_camera_device *icd, unsigned int fourcc);

/**
 * struct soc_camera_format_xlate - match between host and sensor formats
 * @code: code of a sensor provided format
 * @host_fmt: host format after host translation from code
 *
 * Host and sensor translation structure. Used in table of host and sensor
 * formats matchings in soc_camera_device. A host can override the generic list
 * generation by implementing get_formats(), and use it for format checks and
 * format setup.
 */
struct soc_camera_format_xlate {
	enum v4l2_mbus_pixelcode code;
	const struct soc_mbus_pixelfmt *host_fmt;
};

struct soc_camera_ops {
	unsigned long (*query_bus_param)(struct soc_camera_device *);
	int (*set_bus_param)(struct soc_camera_device *, unsigned long);
	const struct v4l2_queryctrl *controls;
	int num_controls;
};

#define SOCAM_SENSE_PCLK_CHANGED	(1 << 0)

/**
 * This struct can be attached to struct soc_camera_device by the host driver
 * to request sense from the camera, for example, when calling .set_fmt(). The
 * host then can check which flags are set and verify respective values if any.
 * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
 * changed during this operation. After completion the host should detach sense.
 *
 * @flags		ored SOCAM_SENSE_* flags
 * @master_clock	if the host wants to be informed about pixel-clock
 *			change, it better set master_clock.
 * @pixel_clock_max	maximum pixel clock frequency supported by the host,
 *			camera is not allowed to exceed this.
 * @pixel_clock		if the camera driver changed pixel clock during this
 *			operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
 *			master_clock to calculate the new pixel-clock and
 *			sets this field.
 */
struct soc_camera_sense {
	unsigned long flags;
	unsigned long master_clock;
	unsigned long pixel_clock_max;
	unsigned long pixel_clock;
};

static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
	struct soc_camera_ops *ops, int id)
{
	int i;

	for (i = 0; i < ops->num_controls; i++)
		if (ops->controls[i].id == id)
			return &ops->controls[i];

	return NULL;
}

#define SOCAM_MASTER			(1 << 0)
#define SOCAM_SLAVE			(1 << 1)
#define SOCAM_HSYNC_ACTIVE_HIGH		(1 << 2)
#define SOCAM_HSYNC_ACTIVE_LOW		(1 << 3)
#define SOCAM_VSYNC_ACTIVE_HIGH		(1 << 4)
#define SOCAM_VSYNC_ACTIVE_LOW		(1 << 5)
#define SOCAM_DATAWIDTH_4		(1 << 6)
#define SOCAM_DATAWIDTH_8		(1 << 7)
#define SOCAM_DATAWIDTH_9		(1 << 8)
#define SOCAM_DATAWIDTH_10		(1 << 9)
#define SOCAM_DATAWIDTH_15		(1 << 10)
#define SOCAM_DATAWIDTH_16		(1 << 11)
#define SOCAM_PCLK_SAMPLE_RISING	(1 << 12)
#define SOCAM_PCLK_SAMPLE_FALLING	(1 << 13)
#define SOCAM_DATA_ACTIVE_HIGH		(1 << 14)
#define SOCAM_DATA_ACTIVE_LOW		(1 << 15)
#define SOCAM_MIPI_1LANE		(1 << 16)
#define SOCAM_MIPI_2LANE		(1 << 17)
#define SOCAM_MIPI_3LANE		(1 << 18)
#define SOCAM_MIPI_4LANE		(1 << 19)
#define SOCAM_MIPI	(SOCAM_MIPI_1LANE | SOCAM_MIPI_2LANE | \
			SOCAM_MIPI_3LANE | SOCAM_MIPI_4LANE)

#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
			      SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
			      SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)

static inline unsigned long soc_camera_bus_param_compatible(
			unsigned long camera_flags, unsigned long bus_flags)
{
	unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
	unsigned long mipi;

	common_flags = camera_flags & bus_flags;

	hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
	vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
	pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
	data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
	mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
	buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
	mipi = common_flags & SOCAM_MIPI;

	return ((!hsync || !vsync || !pclk || !data || !mode || !buswidth) && !mipi) ? 0 :
		common_flags;
}

static inline void soc_camera_limit_side(int *start, int *length,
		unsigned int start_min,
		unsigned int length_min, unsigned int length_max)
{
	if (*length < length_min)
		*length = length_min;
	else if (*length > length_max)
		*length = length_max;

	if (*start < start_min)
		*start = start_min;
	else if (*start > start_min + length_max - *length)
		*start = start_min + length_max - *length;
}

extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
						   unsigned long flags);

/* This is only temporary here - until v4l2-subdev begins to link to video_device */
#include <linux/i2c.h>
static inline struct video_device *soc_camera_i2c_to_vdev(struct i2c_client *client)
{
	struct soc_camera_device *icd = client->dev.platform_data;
	return icd->vdev;
}

static inline struct soc_camera_device *soc_camera_from_vb2q(struct vb2_queue *vq)
{
	return container_of(vq, struct soc_camera_device, vb2_vidq);
}

static inline struct soc_camera_device *soc_camera_from_vbq(struct videobuf_queue *vq)
{
	return container_of(vq, struct soc_camera_device, vb_vidq);
}

void soc_camera_lock(struct vb2_queue *vq);
void soc_camera_unlock(struct vb2_queue *vq);

#endif
Commit	Line	Data
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
52d268a3	15	#include <linux/device.h>
1c3bb743 GL	16	#include <linux/mutex.h>
1c3bb743 GL	17	#include <linux/pm.h>
e55222ef	18	#include <linux/videodev2.h>
092d3921	19	#include <media/videobuf-core.h>
592c2aba	20	#include <media/videobuf2-core.h>
979ea1dd	21	#include <media/v4l2-device.h>
e55222ef	22
57bee29d GL	23	struct file;
57bee29d GL	24
e55222ef	25	struct soc_camera_device {
d33b290a	26	struct list_head list; /* list of all registered devices */
e55222ef	27	struct device dev;
979ea1dd	28	struct device pdev; / Platform device */
6a6c8786 GL	29	s32 user_width;
6a6c8786 GL	30	s32 user_height;
0e4c180d SA	31	u32 bytesperline; /* for padding, zero if unused */
0e4c180d SA	32	u32 sizeimage;
760697be	33	enum v4l2_colorspace colorspace;
e55222ef GL	34	unsigned char iface; /* Host number */
e55222ef GL	35	unsigned char devnum; /* Device number per host */
a9bef518	36	struct soc_camera_sense sense; / See comment in struct definition */
e55222ef GL	37	struct soc_camera_ops *ops;
e55222ef GL	38	struct video_device *vdev;
760697be	39	const struct soc_camera_format_xlate *current_fmt;
c2786ad2 GL	40	struct soc_camera_format_xlate *user_formats;
c2786ad2 GL	41	int num_user_formats;
025c18a1	42	enum v4l2_field field; /* Preserve field over close() */
1c3bb743 GL	43	void host_priv; / Per-device host private data */
1c3bb743 GL	44	/* soc_camera.c private count. Only accessed with .video_lock held */
9dc4e48f	45	int use_count;
1c3bb743	46	struct mutex video_lock; /* Protects device data */
57bee29d	47	struct file streamer; / stream owner */
592c2aba GL	48	union {
	49	struct videobuf_queue vb_vidq;
	50	struct vb2_queue vb2_vidq;
	51	};
e55222ef GL	52	};
	53
	54	struct soc_camera_host {
979ea1dd	55	struct v4l2_device v4l2_dev;
e55222ef	56	struct list_head list;
e55222ef	57	unsigned char nr; /* Host number */
e55222ef	58	void *priv;
af128a10	59	const char *drv_name;
b8d9904c GL	60	struct soc_camera_host_ops *ops;
	61	};
	62
	63	struct soc_camera_host_ops {
	64	struct module *owner;
e55222ef GL	65	int (add)(struct soc_camera_device );
e55222ef GL	66	void (remove)(struct soc_camera_device );
fa48984e GL	67	/*
	68	* .get_formats() is called for each client device format, but
	69	* .put_formats() is only called once. Further, if any of the calls to
	70	* .get_formats() fail, .put_formats() will not be called at all, the
	71	* failing .get_formats() must then clean up internally.
	72	*/
3805f201	73	int (get_formats)(struct soc_camera_device , unsigned int,
c2786ad2	74	struct soc_camera_format_xlate *);
fa48984e	75	void (put_formats)(struct soc_camera_device );
6a6c8786 GL	76	int (cropcap)(struct soc_camera_device , struct v4l2_cropcap *);
6a6c8786 GL	77	int (get_crop)(struct soc_camera_device , struct v4l2_crop *);
08590b96	78	int (set_crop)(struct soc_camera_device , struct v4l2_crop *);
aee5c2f1 GL	79	/*
	80	* The difference to .set_crop() is, that .set_livecrop is not allowed
	81	* to change the output sizes
	82	*/
	83	int (set_livecrop)(struct soc_camera_device , struct v4l2_crop *);
09e231b3	84	int (set_fmt)(struct soc_camera_device , struct v4l2_format *);
d8fac217	85	int (try_fmt)(struct soc_camera_device , struct v4l2_format *);
a034d1b7	86	void (init_videobuf)(struct videobuf_queue ,
092d3921	87	struct soc_camera_device *);
592c2aba GL	88	int (init_videobuf2)(struct vb2_queue ,
592c2aba GL	89	struct soc_camera_device *);
57bee29d	90	int (reqbufs)(struct soc_camera_device , struct v4l2_requestbuffers *);
e55222ef	91	int (querycap)(struct soc_camera_host , struct v4l2_capability *);
ad5f2e85	92	int (set_bus_param)(struct soc_camera_device , __u32);
2840d249 GL	93	int (get_ctrl)(struct soc_camera_device , struct v4l2_control *);
2840d249 GL	94	int (set_ctrl)(struct soc_camera_device , struct v4l2_control *);
c9f6ef69 GL	95	int (get_parm)(struct soc_camera_device , struct v4l2_streamparm *);
c9f6ef69 GL	96	int (set_parm)(struct soc_camera_device , struct v4l2_streamparm *);
ed5b65dc	97	int (enum_fsizes)(struct soc_camera_device , struct v4l2_frmsizeenum *);
e55222ef	98	unsigned int (poll)(struct file , poll_table *);
2840d249 GL	99	const struct v4l2_queryctrl *controls;
2840d249 GL	100	int num_controls;
e55222ef GL	101	};
e55222ef GL	102
bd73b36f GL	103	#define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
	104	#define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
	105	#define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
	106	#define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
	107	#define SOCAM_SENSOR_INVERT_DATA (1 << 4)
	108
0fd327bd	109	struct i2c_board_info;
96e442c1	110	struct regulator_bulk_data;
0fd327bd	111
e55222ef GL	112	struct soc_camera_link {
	113	/* Camera bus id, used to match a camera and a bus */
	114	int bus_id;
bd73b36f GL	115	/* Per camera SOCAM_SENSOR_* bus flags */
bd73b36f GL	116	unsigned long flags;
0fd327bd GL	117	int i2c_adapter_id;
	118	struct i2c_board_info *board_info;
	119	const char *module_name;
3fd7ceff GL	120	void *priv;
3fd7ceff GL	121
96e442c1 AP	122	/* Optional regulators that have to be managed on power on/off events */
	123	struct regulator_bulk_data *regulators;
	124	int num_regulators;
	125
c41debaf	126	/*
d33b290a GL	127	* For non-I2C devices platform has to provide methods to add a device
d33b290a GL	128	* to the system and to remove it
c41debaf GL	129	*/
	130	int (add_device)(struct soc_camera_link , struct device *);
	131	void (del_device)(struct soc_camera_link );
81034663 SH	132	/* Optional callbacks to power on or off and reset the sensor */
	133	int (power)(struct device , int);
	134	int (reset)(struct device );
28f59339 SH	135	/*
	136	* some platforms may support different data widths than the sensors
	137	* native ones due to different data line routing. Let the board code
	138	* overwrite the width flags.
	139	*/
	140	int (set_bus_param)(struct soc_camera_link , unsigned long flags);
	141	unsigned long (query_bus_param)(struct soc_camera_link );
594bb46d	142	void (free_bus)(struct soc_camera_link );
e55222ef GL	143	};
e55222ef GL	144
96c75399 GL	145	static inline struct soc_camera_device *to_soc_camera_dev(
96c75399 GL	146	const struct device *dev)
e55222ef GL	147	{
	148	return container_of(dev, struct soc_camera_device, dev);
	149	}
	150
96c75399 GL	151	static inline struct soc_camera_host *to_soc_camera_host(
96c75399 GL	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	}
e55222ef GL	158
96c75399 GL	159	static inline struct soc_camera_link *to_soc_camera_link(
96c75399 GL	160	const struct soc_camera_device *icd)
40e2e092 GL	161	{
	162	return icd->dev.platform_data;
	163	}
e55222ef	164
96c75399 GL	165	static inline struct device *to_soc_camera_control(
96c75399 GL	166	const struct soc_camera_device *icd)
40e2e092 GL	167	{
	168	return dev_get_drvdata(&icd->dev);
	169	}
e55222ef	170
96c75399 GL	171	static inline struct v4l2_subdev *soc_camera_to_subdev(
96c75399 GL	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	178	int soc_camera_host_register(struct soc_camera_host *ici);
	179	void soc_camera_host_unregister(struct soc_camera_host *ici);
	180
40e2e092	181	const 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	/**
c2786ad2 GL	185	* struct soc_camera_format_xlate - match between host and sensor formats
760697be GL	186	* @code: code of a sensor provided format
760697be GL	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	*/
	194	struct soc_camera_format_xlate {
760697be GL	195	enum v4l2_mbus_pixelcode code;
760697be GL	196	const struct soc_mbus_pixelfmt *host_fmt;
c2786ad2 GL	197	};
c2786ad2 GL	198
e55222ef	199	struct soc_camera_ops {
ad5f2e85 GL	200	unsigned long (query_bus_param)(struct soc_camera_device );
ad5f2e85 GL	201	int (set_bus_param)(struct soc_camera_device , unsigned long);
e55222ef GL	202	const struct v4l2_queryctrl *controls;
e55222ef GL	203	int num_controls;
e55222ef GL	204	};
e55222ef GL	205
a9bef518 GL	206	#define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
	207
	208	/**
	209	* This struct can be attached to struct soc_camera_device by the host driver
	210	* to request sense from the camera, for example, when calling .set_fmt(). The
	211	* host then can check which flags are set and verify respective values if any.
	212	* For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
	213	* changed during this operation. After completion the host should detach sense.
	214	*
	215	* @flags ored SOCAM_SENSE_* flags
	216	* @master_clock if the host wants to be informed about pixel-clock
	217	* change, it better set master_clock.
	218	* @pixel_clock_max maximum pixel clock frequency supported by the host,
	219	* camera is not allowed to exceed this.
	220	* @pixel_clock if the camera driver changed pixel clock during this
	221	* operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
	222	* master_clock to calculate the new pixel-clock and
	223	* sets this field.
	224	*/
	225	struct soc_camera_sense {
	226	unsigned long flags;
	227	unsigned long master_clock;
	228	unsigned long pixel_clock_max;
	229	unsigned long pixel_clock;
	230	};
	231
e55222ef GL	232	static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
	233	struct soc_camera_ops *ops, int id)
	234	{
	235	int i;
	236
	237	for (i = 0; i < ops->num_controls; i++)
	238	if (ops->controls[i].id == id)
	239	return &ops->controls[i];
	240
	241	return NULL;
	242	}
	243
ad5f2e85 GL	244	#define SOCAM_MASTER (1 << 0)
	245	#define SOCAM_SLAVE (1 << 1)
	246	#define SOCAM_HSYNC_ACTIVE_HIGH (1 << 2)
	247	#define SOCAM_HSYNC_ACTIVE_LOW (1 << 3)
	248	#define SOCAM_VSYNC_ACTIVE_HIGH (1 << 4)
	249	#define SOCAM_VSYNC_ACTIVE_LOW (1 << 5)
042d8790 GL	250	#define SOCAM_DATAWIDTH_4 (1 << 6)
	251	#define SOCAM_DATAWIDTH_8 (1 << 7)
	252	#define SOCAM_DATAWIDTH_9 (1 << 8)
	253	#define SOCAM_DATAWIDTH_10 (1 << 9)
	254	#define SOCAM_DATAWIDTH_15 (1 << 10)
	255	#define SOCAM_DATAWIDTH_16 (1 << 11)
	256	#define SOCAM_PCLK_SAMPLE_RISING (1 << 12)
	257	#define SOCAM_PCLK_SAMPLE_FALLING (1 << 13)
	258	#define SOCAM_DATA_ACTIVE_HIGH (1 << 14)
	259	#define SOCAM_DATA_ACTIVE_LOW (1 << 15)
b7ccdba0 GL	260	#define SOCAM_MIPI_1LANE (1 << 16)
	261	#define SOCAM_MIPI_2LANE (1 << 17)
	262	#define SOCAM_MIPI_3LANE (1 << 18)
	263	#define SOCAM_MIPI_4LANE (1 << 19)
	264	#define SOCAM_MIPI (SOCAM_MIPI_1LANE \| SOCAM_MIPI_2LANE \| \
	265	SOCAM_MIPI_3LANE \| SOCAM_MIPI_4LANE)
042d8790 GL	266
	267	#define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 \| SOCAM_DATAWIDTH_8 \| \
	268	SOCAM_DATAWIDTH_9 \| SOCAM_DATAWIDTH_10 \| \
	269	SOCAM_DATAWIDTH_15 \| SOCAM_DATAWIDTH_16)
ad5f2e85 GL	270
	271	static inline unsigned long soc_camera_bus_param_compatible(
	272	unsigned long camera_flags, unsigned long bus_flags)
	273	{
f7f41483	274	unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
ee1b6f4b	275	unsigned long mipi;
ad5f2e85 GL	276
	277	common_flags = camera_flags & bus_flags;
	278
	279	hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH \| SOCAM_HSYNC_ACTIVE_LOW);
	280	vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH \| SOCAM_VSYNC_ACTIVE_LOW);
	281	pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING \| SOCAM_PCLK_SAMPLE_FALLING);
f7f41483 GL	282	data = common_flags & (SOCAM_DATA_ACTIVE_HIGH \| SOCAM_DATA_ACTIVE_LOW);
	283	mode = common_flags & (SOCAM_MASTER \| SOCAM_SLAVE);
	284	buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
ee1b6f4b	285	mipi = common_flags & SOCAM_MIPI;
ad5f2e85	286
ee1b6f4b	287	return ((!hsync \|\| !vsync \|\| !pclk \|\| !data \|\| !mode \|\| !buswidth) && !mipi) ? 0 :
f7f41483	288	common_flags;
ad5f2e85	289	}
e55222ef	290
e26b3144 MN	291	static inline void soc_camera_limit_side(int start, int length,
e26b3144 MN	292	unsigned int start_min,
6a6c8786 GL	293	unsigned int length_min, unsigned int length_max)
	294	{
	295	if (*length < length_min)
	296	*length = length_min;
	297	else if (*length > length_max)
	298	*length = length_max;
	299
	300	if (*start < start_min)
	301	*start = start_min;
	302	else if (start > start_min + length_max - length)
	303	start = start_min + length_max - length;
	304	}
	305
bd73b36f GL	306	extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
	307	unsigned long flags);
	308
4f9fb5ed MCC	309	/* This is only temporary here - until v4l2-subdev begins to link to video_device */
	310	#include <linux/i2c.h>
	311	static inline struct video_device soc_camera_i2c_to_vdev(struct i2c_client client)
	312	{
	313	struct soc_camera_device *icd = client->dev.platform_data;
	314	return icd->vdev;
	315	}
	316
8eb4476d GL	317	static inline struct soc_camera_device soc_camera_from_vb2q(struct vb2_queue vq)
	318	{
	319	return container_of(vq, struct soc_camera_device, vb2_vidq);
	320	}
	321
	322	static inline struct soc_camera_device soc_camera_from_vbq(struct videobuf_queue vq)
	323	{
	324	return container_of(vq, struct soc_camera_device, vb_vidq);
	325	}
	326
592c2aba GL	327	void soc_camera_lock(struct vb2_queue *vq);
	328	void soc_camera_unlock(struct vb2_queue *vq);
	329
e55222ef	330	#endif