diff options
author | Hans Verkuil <hans.verkuil@cisco.com> | 2015-03-04 04:47:59 -0500 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2015-03-23 14:50:28 -0400 |
commit | d3e4bd8e10cd70d35a59854dcdcd7280c5ed240c (patch) | |
tree | e7d4042a0230d5f3ad79586da3acd6e7f90b7de8 /Documentation/DocBook | |
parent | 5778e749c152567ac15201fcd988bc1604878021 (diff) |
[media] DocBook media: document the new 'which' field
The subdev enum ioctls now have a new 'which' field. Document this.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Acked-by: Lad, Prabhakar <prabhakar.csengg@gmail.com>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Acked-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Diffstat (limited to 'Documentation/DocBook')
3 files changed, 26 insertions, 11 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-subdev-enum-frame-interval.xml b/Documentation/DocBook/media/v4l/vidioc-subdev-enum-frame-interval.xml index 2f8f4f0a0235..cff59f5cbf04 100644 --- a/Documentation/DocBook/media/v4l/vidioc-subdev-enum-frame-interval.xml +++ b/Documentation/DocBook/media/v4l/vidioc-subdev-enum-frame-interval.xml | |||
@@ -67,9 +67,9 @@ | |||
67 | 67 | ||
68 | <para>To enumerate frame intervals applications initialize the | 68 | <para>To enumerate frame intervals applications initialize the |
69 | <structfield>index</structfield>, <structfield>pad</structfield>, | 69 | <structfield>index</structfield>, <structfield>pad</structfield>, |
70 | <structfield>code</structfield>, <structfield>width</structfield> and | 70 | <structfield>which</structfield>, <structfield>code</structfield>, |
71 | <structfield>height</structfield> fields of | 71 | <structfield>width</structfield> and <structfield>height</structfield> |
72 | &v4l2-subdev-frame-interval-enum; and call the | 72 | fields of &v4l2-subdev-frame-interval-enum; and call the |
73 | <constant>VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL</constant> ioctl with a pointer | 73 | <constant>VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL</constant> ioctl with a pointer |
74 | to this structure. Drivers fill the rest of the structure or return | 74 | to this structure. Drivers fill the rest of the structure or return |
75 | an &EINVAL; if one of the input fields is invalid. All frame intervals are | 75 | an &EINVAL; if one of the input fields is invalid. All frame intervals are |
@@ -123,7 +123,12 @@ | |||
123 | </row> | 123 | </row> |
124 | <row> | 124 | <row> |
125 | <entry>__u32</entry> | 125 | <entry>__u32</entry> |
126 | <entry><structfield>reserved</structfield>[9]</entry> | 126 | <entry><structfield>which</structfield></entry> |
127 | <entry>Frame intervals to be enumerated, from &v4l2-subdev-format-whence;.</entry> | ||
128 | </row> | ||
129 | <row> | ||
130 | <entry>__u32</entry> | ||
131 | <entry><structfield>reserved</structfield>[8]</entry> | ||
127 | <entry>Reserved for future extensions. Applications and drivers must | 132 | <entry>Reserved for future extensions. Applications and drivers must |
128 | set the array to zero.</entry> | 133 | set the array to zero.</entry> |
129 | </row> | 134 | </row> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-subdev-enum-frame-size.xml b/Documentation/DocBook/media/v4l/vidioc-subdev-enum-frame-size.xml index 79ce42b7c60c..abd545ede67a 100644 --- a/Documentation/DocBook/media/v4l/vidioc-subdev-enum-frame-size.xml +++ b/Documentation/DocBook/media/v4l/vidioc-subdev-enum-frame-size.xml | |||
@@ -61,9 +61,9 @@ | |||
61 | ioctl.</para> | 61 | ioctl.</para> |
62 | 62 | ||
63 | <para>To enumerate frame sizes applications initialize the | 63 | <para>To enumerate frame sizes applications initialize the |
64 | <structfield>pad</structfield>, <structfield>code</structfield> and | 64 | <structfield>pad</structfield>, <structfield>which</structfield> , |
65 | <structfield>index</structfield> fields of the | 65 | <structfield>code</structfield> and <structfield>index</structfield> |
66 | &v4l2-subdev-mbus-code-enum; and call the | 66 | fields of the &v4l2-subdev-mbus-code-enum; and call the |
67 | <constant>VIDIOC_SUBDEV_ENUM_FRAME_SIZE</constant> ioctl with a pointer to | 67 | <constant>VIDIOC_SUBDEV_ENUM_FRAME_SIZE</constant> ioctl with a pointer to |
68 | the structure. Drivers fill the minimum and maximum frame sizes or return | 68 | the structure. Drivers fill the minimum and maximum frame sizes or return |
69 | an &EINVAL; if one of the input parameters is invalid.</para> | 69 | an &EINVAL; if one of the input parameters is invalid.</para> |
@@ -127,7 +127,12 @@ | |||
127 | </row> | 127 | </row> |
128 | <row> | 128 | <row> |
129 | <entry>__u32</entry> | 129 | <entry>__u32</entry> |
130 | <entry><structfield>reserved</structfield>[9]</entry> | 130 | <entry><structfield>which</structfield></entry> |
131 | <entry>Frame sizes to be enumerated, from &v4l2-subdev-format-whence;.</entry> | ||
132 | </row> | ||
133 | <row> | ||
134 | <entry>__u32</entry> | ||
135 | <entry><structfield>reserved</structfield>[8]</entry> | ||
131 | <entry>Reserved for future extensions. Applications and drivers must | 136 | <entry>Reserved for future extensions. Applications and drivers must |
132 | set the array to zero.</entry> | 137 | set the array to zero.</entry> |
133 | </row> | 138 | </row> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml b/Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml index a6b3432449f6..0bcb278fd062 100644 --- a/Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml +++ b/Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml | |||
@@ -56,8 +56,8 @@ | |||
56 | </note> | 56 | </note> |
57 | 57 | ||
58 | <para>To enumerate media bus formats available at a given sub-device pad | 58 | <para>To enumerate media bus formats available at a given sub-device pad |
59 | applications initialize the <structfield>pad</structfield> and | 59 | applications initialize the <structfield>pad</structfield>, <structfield>which</structfield> |
60 | <structfield>index</structfield> fields of &v4l2-subdev-mbus-code-enum; and | 60 | and <structfield>index</structfield> fields of &v4l2-subdev-mbus-code-enum; and |
61 | call the <constant>VIDIOC_SUBDEV_ENUM_MBUS_CODE</constant> ioctl with a | 61 | call the <constant>VIDIOC_SUBDEV_ENUM_MBUS_CODE</constant> ioctl with a |
62 | pointer to this structure. Drivers fill the rest of the structure or return | 62 | pointer to this structure. Drivers fill the rest of the structure or return |
63 | an &EINVAL; if either the <structfield>pad</structfield> or | 63 | an &EINVAL; if either the <structfield>pad</structfield> or |
@@ -93,7 +93,12 @@ | |||
93 | </row> | 93 | </row> |
94 | <row> | 94 | <row> |
95 | <entry>__u32</entry> | 95 | <entry>__u32</entry> |
96 | <entry><structfield>reserved</structfield>[9]</entry> | 96 | <entry><structfield>which</structfield></entry> |
97 | <entry>Media bus format codes to be enumerated, from &v4l2-subdev-format-whence;.</entry> | ||
98 | </row> | ||
99 | <row> | ||
100 | <entry>__u32</entry> | ||
101 | <entry><structfield>reserved</structfield>[8]</entry> | ||
97 | <entry>Reserved for future extensions. Applications and drivers must | 102 | <entry>Reserved for future extensions. Applications and drivers must |
98 | set the array to zero.</entry> | 103 | set the array to zero.</entry> |
99 | </row> | 104 | </row> |