Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d3e4bd8e authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

[media] DocBook media: document the new 'which' field 



The subdev enum ioctls now have a new 'which' field. Document this.

Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Acked-by: default avatarLad, Prabhakar <prabhakar.csengg@gmail.com>
Acked-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
Acked-by: default avatarSylwester Nawrocki <s.nawrocki@samsung.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 5778e749

Documentation/DocBook/media/v4l/vidioc-subdev-enum-frame-interval.xml

+9 −4
Original line number Diff line number Diff line
@@ -67,9 +67,9 @@ 


    <para>To enumerate frame intervals applications initialize the

    <structfield>index</structfield>, <structfield>pad</structfield>,

    <structfield>code</structfield>, <structfield>width</structfield> and

    <structfield>height</structfield> fields of

    &v4l2-subdev-frame-interval-enum; and call the

    <structfield>which</structfield>, <structfield>code</structfield>,

    <structfield>width</structfield> and <structfield>height</structfield>

    fields of &v4l2-subdev-frame-interval-enum; and call the

    <constant>VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL</constant> ioctl with a pointer

    to this structure. Drivers fill the rest of the structure or return

    an &EINVAL; if one of the input fields is invalid. All frame intervals are
@@ -123,7 +123,12 @@ 
	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>reserved</structfield>[9]</entry>

	    <entry><structfield>which</structfield></entry>

	    <entry>Frame intervals to be enumerated, from &v4l2-subdev-format-whence;.</entry>

	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>reserved</structfield>[8]</entry>

	    <entry>Reserved for future extensions. Applications and drivers must

	    set the array to zero.</entry>

	  </row>

Documentation/DocBook/media/v4l/vidioc-subdev-enum-frame-size.xml

+9 −4
Original line number Diff line number Diff line
@@ -61,9 +61,9 @@ 
    ioctl.</para>



    <para>To enumerate frame sizes applications initialize the

    <structfield>pad</structfield>, <structfield>code</structfield> and

    <structfield>index</structfield> fields of the

    &v4l2-subdev-mbus-code-enum; and call the

    <structfield>pad</structfield>, <structfield>which</structfield> ,

    <structfield>code</structfield> and <structfield>index</structfield>

    fields of the &v4l2-subdev-mbus-code-enum; and call the

    <constant>VIDIOC_SUBDEV_ENUM_FRAME_SIZE</constant> ioctl with a pointer to

    the structure. Drivers fill the minimum and maximum frame sizes or return

    an &EINVAL; if one of the input parameters is invalid.</para>
@@ -127,7 +127,12 @@ 
	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>reserved</structfield>[9]</entry>

	    <entry><structfield>which</structfield></entry>

	    <entry>Frame sizes to be enumerated, from &v4l2-subdev-format-whence;.</entry>

	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>reserved</structfield>[8]</entry>

	    <entry>Reserved for future extensions. Applications and drivers must

	    set the array to zero.</entry>

	  </row>

Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml

+8 −3
Original line number Diff line number Diff line
@@ -56,8 +56,8 @@ 
    </note>



    <para>To enumerate media bus formats available at a given sub-device pad

    applications initialize the <structfield>pad</structfield> and

    <structfield>index</structfield> fields of &v4l2-subdev-mbus-code-enum; and

    applications initialize the <structfield>pad</structfield>, <structfield>which</structfield>

    and <structfield>index</structfield> fields of &v4l2-subdev-mbus-code-enum; and

    call the <constant>VIDIOC_SUBDEV_ENUM_MBUS_CODE</constant> ioctl with a

    pointer to this structure. Drivers fill the rest of the structure or return

    an &EINVAL; if either the <structfield>pad</structfield> or
@@ -93,7 +93,12 @@ 
	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>reserved</structfield>[9]</entry>

	    <entry><structfield>which</structfield></entry>

	    <entry>Media bus format codes to be enumerated, from &v4l2-subdev-format-whence;.</entry>

	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>reserved</structfield>[8]</entry>

	    <entry>Reserved for future extensions. Applications and drivers must

	    set the array to zero.</entry>

	  </row>