Blame view
include/media/v4l2-event.h
5 KB
c3b5b0241
|
1 2 3 4 5 6 7 |
/* * v4l2-event.h * * V4L2 events. * * Copyright (C) 2009--2010 Nokia Corporation. * |
8c5dff905
|
8 |
* Contact: Sakari Ailus <sakari.ailus@iki.fi> |
c3b5b0241
|
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
* * 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> |
3ad57c338
|
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
/* * Overview: * * Events are subscribed per-filehandle. An event specification consists of a * type and is optionally associated with an object identified through the * 'id' field. So an event is uniquely identified by the (type, id) tuple. * * The v4l2-fh struct has a list of subscribed events. The v4l2_subscribed_event * struct is added to that list, one for every subscribed event. * * Each v4l2_subscribed_event struct ends with an array of v4l2_kevent structs. * This array (ringbuffer, really) is used to store any events raised by the * driver. The v4l2_kevent struct links into the 'available' list of the * v4l2_fh struct so VIDIOC_DQEVENT will know which event to dequeue first. * * Finally, if the event subscription is associated with a particular object * such as a V4L2 control, then that object needs to know about that as well * so that an event can be raised by that object. So the 'node' field can * be used to link the v4l2_subscribed_event struct into a list of that * object. * * So to summarize: * * struct v4l2_fh has two lists: one of the subscribed events, and one of the * pending events. * * struct v4l2_subscribed_event has a ringbuffer of raised (pending) events of * that particular type. * * If struct v4l2_subscribed_event is associated with a specific object, then * that object will have an internal list of struct v4l2_subscribed_event so * it knows who subscribed an event to that object. */ |
c3b5b0241
|
64 |
struct v4l2_fh; |
4f4d14b70
|
65 |
struct v4l2_subdev; |
f1e393de3
|
66 |
struct v4l2_subscribed_event; |
c3b5b0241
|
67 |
struct video_device; |
3f66f0ed3
|
68 69 70 71 72 |
/** 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. */ |
c3b5b0241
|
73 74 |
struct v4l2_kevent { struct list_head list; |
f1e393de3
|
75 |
struct v4l2_subscribed_event *sev; |
c3b5b0241
|
76 77 |
struct v4l2_event event; }; |
c53c25493
|
78 79 80 81 82 83 84 |
/** struct v4l2_subscribed_event_ops - Subscribed event operations. * @add: Optional callback, called when a new listener is added * @del: Optional callback, called when a listener stops listening * @replace: Optional callback that can replace event 'old' with event 'new'. * @merge: Optional callback that can merge event 'old' into event 'new'. */ struct v4l2_subscribed_event_ops { |
6e6d76cdc
|
85 |
int (*add)(struct v4l2_subscribed_event *sev, unsigned elems); |
c53c25493
|
86 87 88 89 |
void (*del)(struct v4l2_subscribed_event *sev); void (*replace)(struct v4l2_event *old, const struct v4l2_event *new); void (*merge)(const struct v4l2_event *old, struct v4l2_event *new); }; |
3f66f0ed3
|
90 91 92 93 94 95 96 |
/** 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). |
c53c25493
|
97 |
* @ops: v4l2_subscribed_event_ops |
3f66f0ed3
|
98 99 100 101 102 |
* @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. */ |
c3b5b0241
|
103 104 105 |
struct v4l2_subscribed_event { struct list_head list; u32 type; |
6e239399e
|
106 |
u32 id; |
77068d36d
|
107 |
u32 flags; |
77068d36d
|
108 |
struct v4l2_fh *fh; |
77068d36d
|
109 |
struct list_head node; |
c53c25493
|
110 |
const struct v4l2_subscribed_event_ops *ops; |
f1e393de3
|
111 |
unsigned elems; |
f1e393de3
|
112 |
unsigned first; |
f1e393de3
|
113 |
unsigned in_use; |
f1e393de3
|
114 |
struct v4l2_kevent events[]; |
c3b5b0241
|
115 |
}; |
c3b5b0241
|
116 117 118 |
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); |
6e239399e
|
119 |
void v4l2_event_queue_fh(struct v4l2_fh *fh, const struct v4l2_event *ev); |
c3b5b0241
|
120 121 |
int v4l2_event_pending(struct v4l2_fh *fh); int v4l2_event_subscribe(struct v4l2_fh *fh, |
85f5fe396
|
122 |
const struct v4l2_event_subscription *sub, unsigned elems, |
c53c25493
|
123 |
const struct v4l2_subscribed_event_ops *ops); |
c3b5b0241
|
124 |
int v4l2_event_unsubscribe(struct v4l2_fh *fh, |
85f5fe396
|
125 |
const struct v4l2_event_subscription *sub); |
f1e393de3
|
126 |
void v4l2_event_unsubscribe_all(struct v4l2_fh *fh); |
4f4d14b70
|
127 128 |
int v4l2_event_subdev_unsubscribe(struct v4l2_subdev *sd, struct v4l2_fh *fh, struct v4l2_event_subscription *sub); |
c3b5b0241
|
129 |
#endif /* V4L2_EVENT_H */ |