[deliverable/linux.git] / include / media / v4l2-event.h

/*
 * v4l2-event.h
 *
 * V4L2 events.
 *
 * Copyright (C) 2009--2010 Nokia Corporation.
 *
 * Contact: Sakari Ailus <sakari.ailus@maxwell.research.nokia.com>
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#ifndef V4L2_EVENT_H
#define V4L2_EVENT_H

#include <linux/types.h>
#include <linux/videodev2.h>
#include <linux/wait.h>

struct v4l2_fh;
struct v4l2_subscribed_event;
struct video_device;

struct v4l2_kevent {
	/* list node for the v4l2_fh->available list */
	struct list_head	list;
	/* pointer to parent v4l2_subscribed_event */
	struct v4l2_subscribed_event *sev;
	/* event itself */
	struct v4l2_event	event;
};

struct v4l2_subscribed_event {
	/* list node for the v4l2_fh->subscribed list */
	struct list_head	list;
	/* event type */
	u32			type;
	/* associated object ID (e.g. control ID) */
	u32			id;
	/* copy of v4l2_event_subscription->flags */
	u32			flags;
	/* filehandle that subscribed to this event */
	struct v4l2_fh		*fh;
	/* list node that hooks into the object's event list (if there is one) */
	struct list_head	node;
	/* Optional callback that can replace event 'old' with event 'new'. */
	void			(*replace)(struct v4l2_event *old,
					   const struct v4l2_event *new);
	/* Optional callback that can merge event 'old' into event 'new'. */
	void			(*merge)(const struct v4l2_event *old,
					 struct v4l2_event *new);
	/* the number of elements in the events array */
	unsigned		elems;
	/* the index of the events containing the oldest available event */
	unsigned		first;
	/* the number of queued events */
	unsigned		in_use;
	/* an array of elems events */
	struct v4l2_kevent	events[];
};

int v4l2_event_dequeue(struct v4l2_fh *fh, struct v4l2_event *event,
		       int nonblocking);
void v4l2_event_queue(struct video_device *vdev, const struct v4l2_event *ev);
void v4l2_event_queue_fh(struct v4l2_fh *fh, const struct v4l2_event *ev);
int v4l2_event_pending(struct v4l2_fh *fh);
int v4l2_event_subscribe(struct v4l2_fh *fh,
			 struct v4l2_event_subscription *sub, unsigned elems);
int v4l2_event_unsubscribe(struct v4l2_fh *fh,
			   struct v4l2_event_subscription *sub);
void v4l2_event_unsubscribe_all(struct v4l2_fh *fh);

#endif /* V4L2_EVENT_H */
Commit	Line	Data
c3b5b024 SA	1	/*
	2	* v4l2-event.h
	3	*
	4	* V4L2 events.
	5	*
	6	* Copyright (C) 2009--2010 Nokia Corporation.
	7	*
	8	* Contact: Sakari Ailus <sakari.ailus@maxwell.research.nokia.com>
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public License
	12	* version 2 as published by the Free Software Foundation.
	13	*
	14	* This program is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
	22	* 02110-1301 USA
	23	*/
	24
	25	#ifndef V4L2_EVENT_H
	26	#define V4L2_EVENT_H
	27
	28	#include <linux/types.h>
	29	#include <linux/videodev2.h>
	30	#include <linux/wait.h>
	31
	32	struct v4l2_fh;
f1e393de	33	struct v4l2_subscribed_event;
c3b5b024 SA	34	struct video_device;
	35
	36	struct v4l2_kevent {
f1e393de	37	/* list node for the v4l2_fh->available list */
c3b5b024	38	struct list_head list;
f1e393de HV	39	/* pointer to parent v4l2_subscribed_event */
	40	struct v4l2_subscribed_event *sev;
	41	/* event itself */
c3b5b024 SA	42	struct v4l2_event event;
	43	};
	44
	45	struct v4l2_subscribed_event {
77068d36	46	/* list node for the v4l2_fh->subscribed list */
c3b5b024	47	struct list_head list;
77068d36	48	/* event type */
c3b5b024	49	u32 type;
77068d36	50	/* associated object ID (e.g. control ID) */
6e239399	51	u32 id;
77068d36 HV	52	/* copy of v4l2_event_subscription->flags */
	53	u32 flags;
	54	/* filehandle that subscribed to this event */
	55	struct v4l2_fh *fh;
	56	/* list node that hooks into the object's event list (if there is one) */
	57	struct list_head node;
2151bdc8 HV	58	/* Optional callback that can replace event 'old' with event 'new'. */
	59	void (replace)(struct v4l2_event old,
	60	const struct v4l2_event *new);
	61	/* Optional callback that can merge event 'old' into event 'new'. */
	62	void (merge)(const struct v4l2_event old,
	63	struct v4l2_event *new);
f1e393de HV	64	/* the number of elements in the events array */
	65	unsigned elems;
	66	/* the index of the events containing the oldest available event */
	67	unsigned first;
	68	/* the number of queued events */
	69	unsigned in_use;
	70	/* an array of elems events */
	71	struct v4l2_kevent events[];
c3b5b024 SA	72	};
c3b5b024 SA	73
c3b5b024 SA	74	int v4l2_event_dequeue(struct v4l2_fh fh, struct v4l2_event event,
	75	int nonblocking);
	76	void v4l2_event_queue(struct video_device vdev, const struct v4l2_event ev);
6e239399	77	void v4l2_event_queue_fh(struct v4l2_fh fh, const struct v4l2_event ev);
c3b5b024 SA	78	int v4l2_event_pending(struct v4l2_fh *fh);
c3b5b024 SA	79	int v4l2_event_subscribe(struct v4l2_fh *fh,
f1e393de	80	struct v4l2_event_subscription *sub, unsigned elems);
c3b5b024 SA	81	int v4l2_event_unsubscribe(struct v4l2_fh *fh,
c3b5b024 SA	82	struct v4l2_event_subscription *sub);
f1e393de	83	void v4l2_event_unsubscribe_all(struct v4l2_fh *fh);
c3b5b024 SA	84
c3b5b024 SA	85	#endif /* V4L2_EVENT_H */