diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-29 22:37:59 +0200 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-09 14:34:01 +0200 |
commit | e8be7e97e639af6f968473e5a598afbebc737b9c (patch) | |
tree | a33c38e32956ad127634eabb978f824ecbbb6c65 /Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst | |
parent | [media] v4l2-ctrls: document some extra data structures (diff) | |
download | linux-e8be7e97e639af6f968473e5a598afbebc737b9c.tar.xz linux-e8be7e97e639af6f968473e5a598afbebc737b9c.zip |
[media] docs-rst: convert uAPI structs to C domain
instead of declaring the uAPI structs using usual refs, e. g.:
.. _foo-struct:
Use the C domain way:
.. c:type:: foo_struct
This way, the kAPI documentation can use cross-references to
point to the uAPI symbols.
That solves about ~100 undefined warnings like:
WARNING: c:type reference target not found: foo_struct
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst')
-rw-r--r-- | Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst b/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst index ee72c69f902a..01561ddfe73b 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst +++ b/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst @@ -46,13 +46,13 @@ to the same control class. Applications must always fill in the ``count``, ``which``, ``controls`` and ``reserved`` fields of struct -:ref:`v4l2_ext_controls <v4l2-ext-controls>`, and initialize the -struct :ref:`v4l2_ext_control <v4l2-ext-control>` array pointed to +:c:type:`v4l2_ext_controls`, and initialize the +struct :c:type:`v4l2_ext_control` array pointed to by the ``controls`` fields. To get the current value of a set of controls applications initialize the ``id``, ``size`` and ``reserved2`` fields of each struct -:ref:`v4l2_ext_control <v4l2-ext-control>` and call the +:c:type:`v4l2_ext_control` and call the :ref:`VIDIOC_G_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` ioctl. String controls controls must also set the ``string`` field. Controls of compound types (``V4L2_CTRL_FLAG_HAS_PAYLOAD`` is set) must set the ``ptr`` field. @@ -74,14 +74,14 @@ by calling :ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>`. To change the value of a set of controls applications initialize the ``id``, ``size``, ``reserved2`` and ``value/value64/string/ptr`` fields -of each struct :ref:`v4l2_ext_control <v4l2-ext-control>` and call +of each struct :c:type:`v4l2_ext_control` and call the :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` ioctl. The controls will only be set if *all* control values are valid. To check if a set of controls have correct values applications initialize the ``id``, ``size``, ``reserved2`` and ``value/value64/string/ptr`` fields of each struct -:ref:`v4l2_ext_control <v4l2-ext-control>` and call the +:c:type:`v4l2_ext_control` and call the :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` ioctl. It is up to the driver whether wrong values are automatically adjusted to a valid value or if an error is returned. @@ -90,7 +90,7 @@ When the ``id`` or ``which`` is invalid drivers return an ``EINVAL`` error code. When the value is out of bounds drivers can choose to take the closest valid value or return an ``ERANGE`` error code, whatever seems more appropriate. In the first case the new value is set in struct -:ref:`v4l2_ext_control <v4l2-ext-control>`. If the new control value +:c:type:`v4l2_ext_control`. If the new control value is inappropriate (e.g. the given menu index is not supported by the menu control), then this will also result in an ``EINVAL`` error code error. @@ -102,7 +102,7 @@ still cause this situation. .. tabularcolumns:: |p{1.2cm}|p{3.0cm}|p{1.5cm}|p{11.8cm}| -.. _v4l2-ext-control: +.. c:type:: v4l2_ext_control .. cssclass: longtable @@ -236,7 +236,7 @@ still cause this situation. .. tabularcolumns:: |p{4.0cm}|p{2.0cm}|p{2.0cm}|p{8.5cm}| -.. _v4l2-ext-controls: +.. c:type:: v4l2_ext_controls .. cssclass:: longtable @@ -362,7 +362,7 @@ still cause this situation. - .. row 7 - - struct :ref:`v4l2_ext_control <v4l2-ext-control>` * + - struct :c:type:`v4l2_ext_control` * - ``controls`` @@ -483,17 +483,17 @@ appropriately. The generic error codes are described at the :ref:`Generic Error Codes <gen-errors>` chapter. EINVAL - The struct :ref:`v4l2_ext_control <v4l2-ext-control>` ``id`` is - invalid, the struct :ref:`v4l2_ext_controls <v4l2-ext-controls>` + The struct :c:type:`v4l2_ext_control` ``id`` is + invalid, the struct :c:type:`v4l2_ext_controls` ``which`` is invalid, or the struct - :ref:`v4l2_ext_control <v4l2-ext-control>` ``value`` was + :c:type:`v4l2_ext_control` ``value`` was inappropriate (e.g. the given menu index is not supported by the driver). This error code is also returned by the :ref:`VIDIOC_S_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` and :ref:`VIDIOC_TRY_EXT_CTRLS <VIDIOC_G_EXT_CTRLS>` ioctls if two or more control values are in conflict. ERANGE - The struct :ref:`v4l2_ext_control <v4l2-ext-control>` ``value`` + The struct :c:type:`v4l2_ext_control` ``value`` is out of bounds. EBUSY |