include/media/v4l2-event.h

   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;
  33 struct v4l2_subscribed_event;
  34 struct video_device;
  35
  36 struct v4l2_kevent {
  37         /* list node for the v4l2_fh->available list */
  38         struct list_head        list;
  39         /* pointer to parent v4l2_subscribed_event */
  40         struct v4l2_subscribed_event *sev;
  41         /* event itself */
  42         struct v4l2_event       event;
  43 };
  44
  45 struct v4l2_subscribed_event {
  46         /* list node for the v4l2_fh->subscribed list */
  47         struct list_head        list;
  48         /* event type */
  49         u32                     type;
  50         /* associated object ID (e.g. control ID) */
  51         u32                     id;
  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;
  58         /* the number of elements in the events array */
  59         unsigned                elems;
  60         /* the index of the events containing the oldest available event */
  61         unsigned                first;
  62         /* the number of queued events */
  63         unsigned                in_use;
  64         /* an array of elems events */
  65         struct v4l2_kevent      events[];
  66 };
  67
  68 int v4l2_event_dequeue(struct v4l2_fh *fh, struct v4l2_event *event,
  69                        int nonblocking);
  70 void v4l2_event_queue(struct video_device *vdev, const struct v4l2_event *ev);
  71 void v4l2_event_queue_fh(struct v4l2_fh *fh, const struct v4l2_event *ev);
  72 int v4l2_event_pending(struct v4l2_fh *fh);
  73 int v4l2_event_subscribe(struct v4l2_fh *fh,
  74                          struct v4l2_event_subscription *sub, unsigned elems);
  75 int v4l2_event_unsubscribe(struct v4l2_fh *fh,
  76                            struct v4l2_event_subscription *sub);
  77 void v4l2_event_unsubscribe_all(struct v4l2_fh *fh);
  78
  79 #endif /* V4L2_EVENT_H */