diff mbox

V4L: docbook documentation for struct v4l2_create_buffers

Message ID Pine.LNX.4.64.1109080946420.31156@axis700.grange (mailing list archive)
State RFC, archived
Headers

Commit Message

Guennadi Liakhovetski Sept. 8, 2011, 7:48 a.m. UTC 
  Signed-off-by: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
---

Obviously, this goes on top of the "multi-size buffers" patch series. 
Thanks again to Sakari for the idea.

 drivers/media/video/v4l2-compat-ioctl32.c |   13 +++++++++++--
 include/linux/videodev2.h                 |   14 +++++++++++---
 2 files changed, 22 insertions(+), 5 deletions(-)
diff mbox

Patch

diff --git a/drivers/media/video/v4l2-compat-ioctl32.c b/drivers/media/video/v4l2-compat-ioctl32.c
index 85758d2..b1064a1 100644
--- a/drivers/media/video/v4l2-compat-ioctl32.c
+++ b/drivers/media/video/v4l2-compat-ioctl32.c
@@ -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];
 };
 
diff --git a/include/linux/videodev2.h b/include/linux/videodev2.h
index 66a9e53..84852c1 100644
--- a/include/linux/videodev2.h
+++ b/include/linux/videodev2.h
@@ -2102,12 +2102,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];
 };