[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 {
	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
 * @bus_type:	subdevice bus type to select the appropriate matching method
 * @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;
};

/**
 * v4l2_async_subdev_list - provided by subdevices
 * @list:	links struct v4l2_async_subdev_list objects to a global list
 *		before probing, and onto notifier->done after probing
 * @asd:	pointer to respective struct v4l2_async_subdev
 * @notifier:	pointer to managing notifier
 */
struct v4l2_async_subdev_list {
	struct list_head list;
	struct v4l2_async_subdev *asd;
	struct v4l2_async_notifier *notifier;
};

/**
 * 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_async_subdev_list, 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);
};

int v4l2_async_notifier_register(struct v4l2_device *v4l2_dev,
				 struct v4l2_async_notifier *notifier);
void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);
int v4l2_async_register_subdev(struct v4l2_subdev *sd);
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
cfca7644 SN	26	enum v4l2_async_match_type {
	27	V4L2_ASYNC_MATCH_CUSTOM,
	28	V4L2_ASYNC_MATCH_DEVNAME,
	29	V4L2_ASYNC_MATCH_I2C,
e7359f8e	30	V4L2_ASYNC_MATCH_OF,
e9e31049 GL	31	};
	32
	33	/**
	34	* struct v4l2_async_subdev - sub-device descriptor, as known to a bridge
	35	* @bus_type: subdevice bus type to select the appropriate matching method
	36	* @match: union of per-bus type matching data sets
	37	* @list: used to link struct v4l2_async_subdev objects, waiting to be
	38	* probed, to a notifier->waiting list
	39	*/
	40	struct v4l2_async_subdev {
cfca7644	41	enum v4l2_async_match_type match_type;
e9e31049	42	union {
e7359f8e SN	43	struct {
	44	const struct device_node *node;
	45	} of;
e9e31049 GL	46	struct {
e9e31049 GL	47	const char *name;
cfca7644	48	} device_name;
e9e31049 GL	49	struct {
	50	int adapter_id;
	51	unsigned short address;
	52	} i2c;
	53	struct {
	54	bool (match)(struct device ,
	55	struct v4l2_async_subdev *);
	56	void *priv;
	57	} custom;
	58	} match;
	59
	60	/* v4l2-async core private: not to be used by drivers */
	61	struct list_head list;
	62	};
	63
	64	/**
	65	* v4l2_async_subdev_list - provided by subdevices
	66	* @list: links struct v4l2_async_subdev_list objects to a global list
	67	* before probing, and onto notifier->done after probing
	68	* @asd: pointer to respective struct v4l2_async_subdev
	69	* @notifier: pointer to managing notifier
	70	*/
	71	struct v4l2_async_subdev_list {
	72	struct list_head list;
	73	struct v4l2_async_subdev *asd;
	74	struct v4l2_async_notifier *notifier;
	75	};
	76
	77	/**
	78	* v4l2_async_notifier - v4l2_device notifier data
	79	* @num_subdevs:number of subdevices
e8419d08	80	* @subdevs: array of pointers to subdevice descriptors
e9e31049 GL	81	* @v4l2_dev: pointer to struct v4l2_device
	82	* @waiting: list of struct v4l2_async_subdev, waiting for their drivers
	83	* @done: list of struct v4l2_async_subdev_list, already probed
	84	* @list: member in a global list of notifiers
	85	* @bound: a subdevice driver has successfully probed one of subdevices
	86	* @complete: all subdevices have been probed successfully
	87	* @unbind: a subdevice is leaving
	88	*/
	89	struct v4l2_async_notifier {
	90	unsigned int num_subdevs;
e8419d08	91	struct v4l2_async_subdev **subdevs;
e9e31049 GL	92	struct v4l2_device *v4l2_dev;
	93	struct list_head waiting;
	94	struct list_head done;
	95	struct list_head list;
	96	int (bound)(struct v4l2_async_notifier notifier,
	97	struct v4l2_subdev *subdev,
	98	struct v4l2_async_subdev *asd);
	99	int (complete)(struct v4l2_async_notifier notifier);
	100	void (unbind)(struct v4l2_async_notifier notifier,
	101	struct v4l2_subdev *subdev,
	102	struct v4l2_async_subdev *asd);
	103	};
	104
	105	int v4l2_async_notifier_register(struct v4l2_device *v4l2_dev,
	106	struct v4l2_async_notifier *notifier);
	107	void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);
	108	int v4l2_async_register_subdev(struct v4l2_subdev *sd);
	109	void v4l2_async_unregister_subdev(struct v4l2_subdev *sd);
	110	#endif