From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Received: from mga14.intel.com ([192.55.52.115]:19796 "EHLO mga14.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1758247AbcEFK4m (ORCPT ); Fri, 6 May 2016 06:56:42 -0400 From: Sakari Ailus To: linux-media@vger.kernel.org Cc: laurent.pinchart@ideasonboard.com, hverkuil@xs4all.nl, mchehab@osg.samsung.com Subject: [RFC 21/22] DocBook: media: Document media events (MEDIA_IOC_DQEVENT IOCTL) Date: Fri, 6 May 2016 13:53:30 +0300 Message-Id: <1462532011-15527-22-git-send-email-sakari.ailus@linux.intel.com> In-Reply-To: <1462532011-15527-1-git-send-email-sakari.ailus@linux.intel.com> References: <1462532011-15527-1-git-send-email-sakari.ailus@linux.intel.com> Sender: linux-media-owner@vger.kernel.org List-ID: Add DocBook documentation for media events. Signed-off-by: Sakari Ailus --- .../DocBook/media/v4l/media-controller.xml | 1 + .../DocBook/media/v4l/media-ioc-dqevent.xml | 155 +++++++++++++++++++++ 2 files changed, 156 insertions(+) create mode 100644 Documentation/DocBook/media/v4l/media-ioc-dqevent.xml diff --git a/Documentation/DocBook/media/v4l/media-controller.xml b/Documentation/DocBook/media/v4l/media-controller.xml index 2a5a5d0..aa78fcb 100644 --- a/Documentation/DocBook/media/v4l/media-controller.xml +++ b/Documentation/DocBook/media/v4l/media-controller.xml @@ -98,6 +98,7 @@ &sub-media-func-ioctl; &sub-media-ioc-device-info; + &sub-media-ioc-dqevent; &sub-media-ioc-g-topology; &sub-media-ioc-enum-entities; &sub-media-ioc-enum-links; diff --git a/Documentation/DocBook/media/v4l/media-ioc-dqevent.xml b/Documentation/DocBook/media/v4l/media-ioc-dqevent.xml new file mode 100644 index 0000000..7d58491 --- /dev/null +++ b/Documentation/DocBook/media/v4l/media-ioc-dqevent.xml @@ -0,0 +1,155 @@ + + + ioctl MEDIA_IOC_DQEVENT + &manvol; + + + + MEDIA_IOC_DQEVENT + Dequeue a media event + + + + + + int ioctl + int fd + int request + struct media_event *argp + + + + + + Arguments + + + + fd + + File descriptor returned by + open(). + + + + request + + MEDIA_IOC_DQEVENT + + + + argp + + + + + + + + + Description + + Dequeue a media event from a media device. Both non-blocking + and blocking access is supported. poll(2) + IOCTL may be used with poll event type + POLLPRI to learn about dequeueable + events. + + Media events are specific to file handle: they are delivered + to and dequeued from each file handle separately. + + + struct <structname>media_event</structname> + + &cs-str; + + + __u32 + type + + Type of the media event. Set by the driver. See + for available media + event types. + + + __u32 + sequence + + Event sequence number. The sequence number is file + handle specific and counts from zero until it wraps around + after reaching 32^2-1. + + + union + + + Anonymous union for event type specific data. + + + + struct &media_event_request_complete; + req_complete + Event data for + MEDIA_EVENT_REQUEST_COMPLETE event. + + + + +
+ + + Media event types + + &cs-def; + + + MEDIA_EVENT_REQUEST_COMPLETE + 1 + A request has been completed. This media event type + has &media-event-request-complete; associated with it. The + event is only queued to the file handle from which the + event was queued. + + + + +
+ + + struct <structname>media_event_request_complete</structname> + + &cs-str; + + + __u32 + id + Request ID. The identifier of the request which has + been completed. + + + __s32 + status + Negative error code of the completed request. See errno(2) + for possible error codes. + + + +
+ + + + + &return-value; + + + + ENOENT + + No events are available for dequeueing. This is returned + only when non-blocking I/O is used. + + + + + + -- 1.9.1