[media] v4l2-ctrls/v4l2-events: small coding style cleanups
[pandora-kernel.git] / include / media / v4l2-event.h
index 042b893..7abeb39 100644 (file)
 #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_alloc(struct v4l2_fh *fh, unsigned int n);
-void v4l2_event_free(struct v4l2_fh *fh);
 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);
+                        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 */