[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 - Internal kernel event struct.
  * @list:	List node for the v4l2_fh->available list.
  * @sev:	Pointer to parent v4l2_subscribed_event.
  * @event:	The event itself.
  */
struct v4l2_kevent {
	struct list_head	list;
	struct v4l2_subscribed_event *sev;
	struct v4l2_event	event;
};

/** struct v4l2_subscribed_event - Internal struct representing a subscribed event.
  * @list:	List node for the v4l2_fh->subscribed list.
  * @type:	Event type.
  * @id:	Associated object ID (e.g. control ID). 0 if there isn't any.
  * @flags:	Copy of v4l2_event_subscription->flags.
  * @fh:	Filehandle that subscribed to this event.
  * @node:	List node that hooks into the object's event list (if there is one).
  * @replace:	Optional callback that can replace event 'old' with event 'new'.
  * @merge:	Optional callback that can merge event 'old' into event 'new'.
  * @elems:	The number of elements in the events array.
  * @first:	The index of the events containing the oldest available event.
  * @in_use:	The number of queued events.
  * @events:	An array of @elems events.
  */
struct v4l2_subscribed_event {
	struct list_head	list;
	u32			type;
	u32			id;
	u32			flags;
	struct v4l2_fh		*fh;
	struct list_head	node;
	void			(*replace)(struct v4l2_event *old,
					   const struct v4l2_event *new);
	void			(*merge)(const struct v4l2_event *old,
					 struct v4l2_event *new);
	unsigned		elems;
	unsigned		first;
	unsigned		in_use;
	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;
c3b5b024 SA	35
3f66f0ed HV	36	/** struct v4l2_kevent - Internal kernel event struct.
	37	* @list: List node for the v4l2_fh->available list.
	38	* @sev: Pointer to parent v4l2_subscribed_event.
	39	* @event: The event itself.
	40	*/
c3b5b024 SA	41	struct v4l2_kevent {
c3b5b024 SA	42	struct list_head list;
f1e393de	43	struct v4l2_subscribed_event *sev;
c3b5b024 SA	44	struct v4l2_event event;
	45	};
	46
3f66f0ed HV	47	/** struct v4l2_subscribed_event - Internal struct representing a subscribed event.
	48	* @list: List node for the v4l2_fh->subscribed list.
	49	* @type: Event type.
	50	* @id: Associated object ID (e.g. control ID). 0 if there isn't any.
	51	* @flags: Copy of v4l2_event_subscription->flags.
	52	* @fh: Filehandle that subscribed to this event.
	53	* @node: List node that hooks into the object's event list (if there is one).
	54	* @replace: Optional callback that can replace event 'old' with event 'new'.
	55	* @merge: Optional callback that can merge event 'old' into event 'new'.
	56	* @elems: The number of elements in the events array.
	57	* @first: The index of the events containing the oldest available event.
	58	* @in_use: The number of queued events.
	59	* @events: An array of @elems events.
	60	*/
c3b5b024 SA	61	struct v4l2_subscribed_event {
	62	struct list_head list;
	63	u32 type;
6e239399	64	u32 id;
77068d36	65	u32 flags;
77068d36	66	struct v4l2_fh *fh;
77068d36	67	struct list_head node;
2151bdc8 HV	68	void (replace)(struct v4l2_event old,
2151bdc8 HV	69	const struct v4l2_event *new);
2151bdc8 HV	70	void (merge)(const struct v4l2_event old,
2151bdc8 HV	71	struct v4l2_event *new);
f1e393de	72	unsigned elems;
f1e393de	73	unsigned first;
f1e393de	74	unsigned in_use;
f1e393de	75	struct v4l2_kevent events[];
c3b5b024 SA	76	};
c3b5b024 SA	77
c3b5b024 SA	78	int v4l2_event_dequeue(struct v4l2_fh fh, struct v4l2_event event,
	79	int nonblocking);
	80	void v4l2_event_queue(struct video_device vdev, const struct v4l2_event ev);
6e239399	81	void v4l2_event_queue_fh(struct v4l2_fh fh, const struct v4l2_event ev);
c3b5b024 SA	82	int v4l2_event_pending(struct v4l2_fh *fh);
c3b5b024 SA	83	int v4l2_event_subscribe(struct v4l2_fh *fh,
f1e393de	84	struct v4l2_event_subscription *sub, unsigned elems);
c3b5b024 SA	85	int v4l2_event_unsubscribe(struct v4l2_fh *fh,
c3b5b024 SA	86	struct v4l2_event_subscription *sub);
f1e393de	87	void v4l2_event_unsubscribe_all(struct v4l2_fh *fh);
c3b5b024 SA	88
c3b5b024 SA	89	#endif /* V4L2_EVENT_H */