[media] V4L: docbook documentation for struct v4l2_create_buffers
authorGuennadi Liakhovetski <g.liakhovetski@gmx.de>
Wed, 7 Sep 2011 21:07:23 +0000 (18:07 -0300)
committerMauro Carvalho Chehab <mchehab@redhat.com>
Thu, 3 Nov 2011 20:28:57 +0000 (18:28 -0200)
Signed-off-by: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
drivers/media/video/v4l2-compat-ioctl32.c
include/linux/videodev2.h

index e77e0cf..c68531b 100644 (file)
@@ -159,11 +159,20 @@ struct v4l2_format32 {
        } fmt;
 };
 
+/**
+ * struct v4l2_create_buffers32 - VIDIOC_CREATE_BUFS32 argument
+ * @index:     on return, index of the first created buffer
+ * @count:     entry: number of requested buffers,
+ *             return: number of created buffers
+ * @memory:    buffer memory type
+ * @format:    frame format, for which buffers are requested
+ * @reserved:  future extensions
+ */
 struct v4l2_create_buffers32 {
-       __u32                   index;          /* output: buffers index...index + count - 1 have been created */
+       __u32                   index;
        __u32                   count;
        enum v4l2_memory        memory;
-       struct v4l2_format32    format;         /* filled in by the user, plane sizes calculated by the driver */
+       struct v4l2_format32    format;
        __u32                   reserved[8];
 };
 
index cd512f0..66945a6 100644 (file)
@@ -2142,12 +2142,20 @@ struct v4l2_dbg_chip_ident {
        __u32 revision;    /* chip revision, chip specific */
 } __attribute__ ((packed));
 
-/* VIDIOC_CREATE_BUFS */
+/**
+ * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
+ * @index:     on return, index of the first created buffer
+ * @count:     entry: number of requested buffers,
+ *             return: number of created buffers
+ * @memory:    buffer memory type
+ * @format:    frame format, for which buffers are requested
+ * @reserved:  future extensions
+ */
 struct v4l2_create_buffers {
-       __u32                   index;          /* output: buffers index...index + count - 1 have been created */
+       __u32                   index;
        __u32                   count;
        enum v4l2_memory        memory;
-       struct v4l2_format      format;         /* "type" is used always, the rest if sizeimage == 0 */
+       struct v4l2_format      format;
        __u32                   reserved[8];
 };