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

/*
 * V4L2 asynchronous subdevice registration API
 *
 * Copyright (C) 2012-2013, Guennadi Liakhovetski <g.liakhovetski@gmx.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 V4L2_ASYNC_H
#define V4L2_ASYNC_H

#include <linux/list.h>
#include <linux/mutex.h>

struct device;
struct device_node;
struct v4l2_device;
struct v4l2_subdev;
struct v4l2_async_notifier;

/* A random max subdevice number, used to allocate an array on stack */
#define V4L2_MAX_SUBDEVS 128U

/**
 * enum v4l2_async_match_type - type of asynchronous subdevice logic to be used
 *	in order to identify a match
 *
 * @V4L2_ASYNC_MATCH_CUSTOM: Match will use the logic provided by &struct
 * 	v4l2_async_subdev.match ops
 * @V4L2_ASYNC_MATCH_DEVNAME: Match will use the device name
 * @V4L2_ASYNC_MATCH_I2C: Match will check for I2C adapter ID and address
 * @V4L2_ASYNC_MATCH_OF: Match will use OF node
 *
 * This enum is used by the asyncrhronous sub-device logic to define the
 * algorithm that will be used to match an asynchronous device.
 */
enum v4l2_async_match_type {
	V4L2_ASYNC_MATCH_CUSTOM,
	V4L2_ASYNC_MATCH_DEVNAME,
	V4L2_ASYNC_MATCH_I2C,
	V4L2_ASYNC_MATCH_OF,
};

/**
 * struct v4l2_async_subdev - sub-device descriptor, as known to a bridge
 *
 * @match_type:	type of match that will be used
 * @match:	union of per-bus type matching data sets
 * @list:	used to link struct v4l2_async_subdev objects, waiting to be
 *		probed, to a notifier->waiting list
 */
struct v4l2_async_subdev {
	enum v4l2_async_match_type match_type;
	union {
		struct {
			const struct device_node *node;
		} of;
		struct {
			const char *name;
		} device_name;
		struct {
			int adapter_id;
			unsigned short address;
		} i2c;
		struct {
			bool (*match)(struct device *,
				      struct v4l2_async_subdev *);
			void *priv;
		} custom;
	} match;

	/* v4l2-async core private: not to be used by drivers */
	struct list_head list;
};

/**
 * struct v4l2_async_notifier - v4l2_device notifier data
 *
 * @num_subdevs: number of subdevices
 * @subdevs:	array of pointers to subdevice descriptors
 * @v4l2_dev:	pointer to struct v4l2_device
 * @waiting:	list of struct v4l2_async_subdev, waiting for their drivers
 * @done:	list of struct v4l2_subdev, already probed
 * @list:	member in a global list of notifiers
 * @bound:	a subdevice driver has successfully probed one of subdevices
 * @complete:	all subdevices have been probed successfully
 * @unbind:	a subdevice is leaving
 */
struct v4l2_async_notifier {
	unsigned int num_subdevs;
	struct v4l2_async_subdev **subdevs;
	struct v4l2_device *v4l2_dev;
	struct list_head waiting;
	struct list_head done;
	struct list_head list;
	int (*bound)(struct v4l2_async_notifier *notifier,
		     struct v4l2_subdev *subdev,
		     struct v4l2_async_subdev *asd);
	int (*complete)(struct v4l2_async_notifier *notifier);
	void (*unbind)(struct v4l2_async_notifier *notifier,
		       struct v4l2_subdev *subdev,
		       struct v4l2_async_subdev *asd);
};

/**
 * v4l2_async_notifier_register - registers a subdevice asynchronous notifier
 *
 * @v4l2_dev: pointer to &struct v4l2_device
 * @notifier: pointer to &struct v4l2_async_notifier
 */
int v4l2_async_notifier_register(struct v4l2_device *v4l2_dev,
				 struct v4l2_async_notifier *notifier);

/**
 * v4l2_async_notifier_unregister - unregisters a subdevice asynchronous notifier
 *
 * @notifier: pointer to &struct v4l2_async_notifier
 */
void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);

/**
 * v4l2_async_register_subdev - registers a sub-device to the asynchronous
 * 	subdevice framework
 *
 * @sd: pointer to &struct v4l2_subdev
 */
int v4l2_async_register_subdev(struct v4l2_subdev *sd);

/**
 * v4l2_async_unregister_subdev - unregisters a sub-device to the asynchronous
 * 	subdevice framework
 *
 * @sd: pointer to &struct v4l2_subdev
 */
void v4l2_async_unregister_subdev(struct v4l2_subdev *sd);
#endif
Commit	Line	Data
e9e31049 GL	1	/*
	2	* V4L2 asynchronous subdevice registration API
	3	*
	4	* Copyright (C) 2012-2013, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*/
	10
	11	#ifndef V4L2_ASYNC_H
	12	#define V4L2_ASYNC_H
	13
	14	#include <linux/list.h>
	15	#include <linux/mutex.h>
	16
	17	struct device;
e7359f8e	18	struct device_node;
e9e31049 GL	19	struct v4l2_device;
	20	struct v4l2_subdev;
	21	struct v4l2_async_notifier;
	22
	23	/* A random max subdevice number, used to allocate an array on stack */
	24	#define V4L2_MAX_SUBDEVS 128U
	25
ab4f5a4a MCC	26	/**
	27	* enum v4l2_async_match_type - type of asynchronous subdevice logic to be used
	28	* in order to identify a match
	29	*
	30	* @V4L2_ASYNC_MATCH_CUSTOM: Match will use the logic provided by &struct
	31	* v4l2_async_subdev.match ops
	32	* @V4L2_ASYNC_MATCH_DEVNAME: Match will use the device name
	33	* @V4L2_ASYNC_MATCH_I2C: Match will check for I2C adapter ID and address
	34	* @V4L2_ASYNC_MATCH_OF: Match will use OF node
	35	*
	36	* This enum is used by the asyncrhronous sub-device logic to define the
	37	* algorithm that will be used to match an asynchronous device.
	38	*/
cfca7644 SN	39	enum v4l2_async_match_type {
	40	V4L2_ASYNC_MATCH_CUSTOM,
	41	V4L2_ASYNC_MATCH_DEVNAME,
	42	V4L2_ASYNC_MATCH_I2C,
e7359f8e	43	V4L2_ASYNC_MATCH_OF,
e9e31049 GL	44	};
	45
	46	/**
	47	* struct v4l2_async_subdev - sub-device descriptor, as known to a bridge
f8b27377 MCC	48	*
f8b27377 MCC	49	* @match_type: type of match that will be used
e9e31049 GL	50	* @match: union of per-bus type matching data sets
	51	* @list: used to link struct v4l2_async_subdev objects, waiting to be
	52	* probed, to a notifier->waiting list
	53	*/
	54	struct v4l2_async_subdev {
cfca7644	55	enum v4l2_async_match_type match_type;
e9e31049	56	union {
e7359f8e SN	57	struct {
	58	const struct device_node *node;
	59	} of;
e9e31049 GL	60	struct {
e9e31049 GL	61	const char *name;
cfca7644	62	} device_name;
e9e31049 GL	63	struct {
	64	int adapter_id;
	65	unsigned short address;
	66	} i2c;
	67	struct {
	68	bool (match)(struct device ,
	69	struct v4l2_async_subdev *);
	70	void *priv;
	71	} custom;
	72	} match;
	73
	74	/* v4l2-async core private: not to be used by drivers */
	75	struct list_head list;
	76	};
	77
e9e31049	78	/**
f8b27377 MCC	79	* struct v4l2_async_notifier - v4l2_device notifier data
	80	*
	81	* @num_subdevs: number of subdevices
e8419d08	82	* @subdevs: array of pointers to subdevice descriptors
e9e31049 GL	83	* @v4l2_dev: pointer to struct v4l2_device
e9e31049 GL	84	* @waiting: list of struct v4l2_async_subdev, waiting for their drivers
b426b3a6	85	* @done: list of struct v4l2_subdev, already probed
e9e31049 GL	86	* @list: member in a global list of notifiers
	87	* @bound: a subdevice driver has successfully probed one of subdevices
	88	* @complete: all subdevices have been probed successfully
	89	* @unbind: a subdevice is leaving
	90	*/
	91	struct v4l2_async_notifier {
	92	unsigned int num_subdevs;
e8419d08	93	struct v4l2_async_subdev **subdevs;
e9e31049 GL	94	struct v4l2_device *v4l2_dev;
	95	struct list_head waiting;
	96	struct list_head done;
	97	struct list_head list;
	98	int (bound)(struct v4l2_async_notifier notifier,
	99	struct v4l2_subdev *subdev,
	100	struct v4l2_async_subdev *asd);
	101	int (complete)(struct v4l2_async_notifier notifier);
	102	void (unbind)(struct v4l2_async_notifier notifier,
	103	struct v4l2_subdev *subdev,
	104	struct v4l2_async_subdev *asd);
	105	};
	106
ab4f5a4a MCC	107	/**
	108	* v4l2_async_notifier_register - registers a subdevice asynchronous notifier
	109	*
	110	* @v4l2_dev: pointer to &struct v4l2_device
	111	* @notifier: pointer to &struct v4l2_async_notifier
	112	*/
e9e31049 GL	113	int v4l2_async_notifier_register(struct v4l2_device *v4l2_dev,
e9e31049 GL	114	struct v4l2_async_notifier *notifier);
ab4f5a4a MCC	115
	116	/**
	117	* v4l2_async_notifier_unregister - unregisters a subdevice asynchronous notifier
	118	*
	119	* @notifier: pointer to &struct v4l2_async_notifier
	120	*/
e9e31049	121	void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);
ab4f5a4a MCC	122
	123	/**
	124	* v4l2_async_register_subdev - registers a sub-device to the asynchronous
	125	* subdevice framework
	126	*
	127	* @sd: pointer to &struct v4l2_subdev
	128	*/
e9e31049	129	int v4l2_async_register_subdev(struct v4l2_subdev *sd);
ab4f5a4a MCC	130
	131	/**
	132	* v4l2_async_unregister_subdev - unregisters a sub-device to the asynchronous
	133	* subdevice framework
	134	*
	135	* @sd: pointer to &struct v4l2_subdev
	136	*/
e9e31049 GL	137	void v4l2_async_unregister_subdev(struct v4l2_subdev *sd);
e9e31049 GL	138	#endif