[media] doc-rst: linux_tc CEC enhanced markup

leaved content unchanged, only improved markup and references * more man-like sections (add Name section) * defined target for each stuct field description * replace constant with ":ref:" to (field) description Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

[media] doc-rst: linux_tc CEC enhanced markup
leaved content unchanged, only improved markup and references * more man-like sections (add Name section) * defined target for each stuct field description * replace constant with ":ref:" to (field) description Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
21c62694 · Markus Heiser · Mauro Carvalho Chehab · e2460b1d · 21c62694 · 21c62694
Commit 21c62694 authored Jul 08, 2016 by Markus Heiser Committed by Mauro Carvalho Chehab Jul 08, 2016
11 changed files
--- a/Documentation/media/uapi/cec/cec-api.rst
+++ b/Documentation/media/uapi/cec/cec-api.rst
@@ -43,7 +43,7 @@ control just the CEC pin.

 Drivers that support CEC will create a CEC device node (/dev/cecX) to
 give userspace access to the CEC adapter. The
-:ref:`CEC_ADAP_G_CAPS <cec-ioc-adap-g-caps>` ioctl will tell
+:ref:`CEC_ADAP_G_CAPS` ioctl will tell
 userspace what it is allowed to do.


@@ -83,12 +83,3 @@ Revision and Copyright
 :revision: 1.0.0 / 2016-03-17 (*hv*)

 Initial revision
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
--- a/Documentation/media/uapi/cec/cec-func-close.rst
+++ b/Documentation/media/uapi/cec/cec-func-close.rst
@@ -6,9 +6,10 @@
 cec close()
 ***********

-*man cec-close(2)*
+Name
+====

-Close a cec device
+cec-close - Close a cec device


 Synopsis
@@ -19,7 +20,7 @@ Synopsis
    #include <unistd.h>


-.. c:function:: int close( int fd )
+.. cpp:function:: int close( int fd )

 Arguments
 =========
@@ -46,12 +47,3 @@ Return Value

 EBADF
    ``fd`` is not a valid open file descriptor.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
--- a/Documentation/media/uapi/cec/cec-func-ioctl.rst
+++ b/Documentation/media/uapi/cec/cec-func-ioctl.rst
@@ -6,10 +6,10 @@
 cec ioctl()
 ***********

-*man cec-ioctl(2)*
-
-Control a cec device
+Name
+====

+cec-ioctl - Control a cec device

 Synopsis
 ========
@@ -19,7 +19,7 @@ Synopsis
    #include <sys/ioctl.h>


-.. c:function:: int ioctl( int fd, int request, void *argp )
+.. cpp:function:: int ioctl( int fd, int request, void *argp )

 Arguments
 =========
@@ -66,12 +66,3 @@ descriptions.

 When an ioctl that takes an output or read/write parameter fails, the
 parameter remains unmodified.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
--- a/Documentation/media/uapi/cec/cec-func-open.rst
+++ b/Documentation/media/uapi/cec/cec-func-open.rst
@@ -6,10 +6,10 @@
 cec open()
 **********

-*man cec-open(2)*
-
-Open a cec device
+Name
+====

+cec-open - Open a cec device

 Synopsis
 ========
@@ -19,7 +19,8 @@ Synopsis
    #include <fcntl.h>


-.. c:function:: int open( const char *device_name, int flags )
+.. cpp:function:: int open( const char *device_name, int flags )
+

 Arguments
 =========
@@ -31,11 +32,11 @@ Arguments
    Open flags. Access mode must be ``O_RDWR``.

    When the ``O_NONBLOCK`` flag is given, the
-    :ref:`CEC_RECEIVE <cec-ioc-receive>` ioctl will return EAGAIN
+    :ref:`CEC_RECEIVE` ioctl will return EAGAIN
    error code when no message is available, and the
-    :ref:`CEC_TRANSMIT <cec-ioc-receive>`,
-    :ref:`CEC_ADAP_S_PHYS_ADDR <cec-ioc-adap-g-phys-addr>` and
-    :ref:`CEC_ADAP_S_LOG_ADDRS <cec-ioc-adap-g-log-addrs>` ioctls
+    :ref:`CEC_TRANSMIT`,
+    :ref:`CEC_ADAP_S_PHYS_ADDR` and
+    :ref:`CEC_ADAP_S_LOG_ADDRS` ioctls
    all act in non-blocking mode.

    Other flags have no effect.
@@ -77,12 +78,3 @@ ENOMEM

 ENXIO
    No device corresponding to this device special file exists.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
--- a/Documentation/media/uapi/cec/cec-func-poll.rst
+++ b/Documentation/media/uapi/cec/cec-func-poll.rst
@@ -6,9 +6,10 @@
 cec poll()
 **********

-*man cec-poll(2)*
+Name
+====

-Wait for some event on a file descriptor
+cec-poll - Wait for some event on a file descriptor


 Synopsis
@@ -19,7 +20,11 @@ Synopsis
    #include <sys/poll.h>


-.. c:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
+.. cpp:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
+
+Arguments
+=========
+

 Description
 ===========
@@ -63,12 +68,3 @@ EINTR

 EINVAL
    The ``nfds`` argument is greater than ``OPEN_MAX``.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
--- a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
 .. -*- coding: utf-8; mode: rst -*-

-.. _cec-ioc-adap-g-caps:
+.. _CEC_ADAP_G_CAPS:

 *********************
 ioctl CEC_ADAP_G_CAPS
 *********************

-*man CEC_ADAP_G_CAPS(2)*
-
-Query device capabilities
+Name
+====

+CEC_ADAP_G_CAPS - Query device capabilities

 Synopsis
 ========

-.. c:function:: int ioctl( int fd, int request, struct cec_caps *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct cec_caps *argp )

 Arguments
 =========
@@ -34,7 +34,7 @@ Description
 Note: this documents the proposed CEC API. This API is not yet finalized
 and is currently only available as a staging kernel module.

-All cec devices must support the ``CEC_ADAP_G_CAPS`` ioctl. To query
+All cec devices must support the :ref:`CEC_ADAP_G_CAPS` ioctl. To query
 device information, applications call the ioctl with a pointer to a
 struct :ref:`cec_caps <cec-caps>`. The driver fills the structure and
 returns the information to the application. The ioctl never fails.
@@ -93,52 +93,52 @@ returns the information to the application. The ioctl never fails.
    :widths:       3 1 4


-    -  .. row 1
+    -  .. _`CEC_CAP_PHYS_ADDR`:

       -  ``CEC_CAP_PHYS_ADDR``

       -  0x00000001

       -  Userspace has to configure the physical address by calling
-          :ref:`CEC_ADAP_S_PHYS_ADDR <cec-ioc-adap-g-phys-addr>`. If
+          :ref:`CEC_ADAP_S_PHYS_ADDR`. If
          this capability isn't set, then setting the physical address is
          handled by the kernel whenever the EDID is set (for an HDMI
          receiver) or read (for an HDMI transmitter).

-    -  .. row 2
+    -  .. _`CEC_CAP_LOG_ADDRS`:

       -  ``CEC_CAP_LOG_ADDRS``

       -  0x00000002

       -  Userspace has to configure the logical addresses by calling
-          :ref:`CEC_ADAP_S_LOG_ADDRS <cec-ioc-adap-g-log-addrs>`. If
+          :ref:`CEC_ADAP_S_LOG_ADDRS`. If
          this capability isn't set, then the kernel will have configured
          this.

-    -  .. row 3
+    -  .. _`CEC_CAP_TRANSMIT`:

       -  ``CEC_CAP_TRANSMIT``

       -  0x00000004

       -  Userspace can transmit CEC messages by calling
-          :ref:`CEC_TRANSMIT <cec-ioc-receive>`. This implies that
+          :ref:`CEC_TRANSMIT`. This implies that
          userspace can be a follower as well, since being able to transmit
          messages is a prerequisite of becoming a follower. If this
          capability isn't set, then the kernel will handle all CEC
          transmits and process all CEC messages it receives.

-    -  .. row 4
+    -  .. _`CEC_CAP_PASSTHROUGH`:

       -  ``CEC_CAP_PASSTHROUGH``

       -  0x00000008

       -  Userspace can use the passthrough mode by calling
-          :ref:`CEC_S_MODE <cec-ioc-g-mode>`.
+          :ref:`CEC_S_MODE`.

-    -  .. row 5
+    -  .. _`CEC_CAP_RC`:

       -  ``CEC_CAP_RC``

@@ -146,7 +146,7 @@ returns the information to the application. The ioctl never fails.

       -  This adapter supports the remote control protocol.

-    -  .. row 6
+    -  .. _`CEC_CAP_MONITOR_ALL`:

       -  ``CEC_CAP_MONITOR_ALL``

@@ -163,12 +163,3 @@ Return Value
 On success 0 is returned, on error -1 and the ``errno`` variable is set
 appropriately. The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
--- a/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst
 .. -*- coding: utf-8; mode: rst -*-

-.. _cec-ioc-adap-g-log-addrs:
+.. _CEC_ADAP_LOG_ADDRS:
+.. _CEC_ADAP_G_LOG_ADDRS:
+.. _CEC_ADAP_S_LOG_ADDRS:

 ************************************************
 ioctl CEC_ADAP_G_LOG_ADDRS, CEC_ADAP_S_LOG_ADDRS
 ************************************************

-*man CEC_ADAP_G_LOG_ADDRS(2)*
+Name
+====

-CEC_ADAP_S_LOG_ADDRS
-Get or set the logical addresses
+CEC_ADAP_G_LOG_ADDRS, CEC_ADAP_S_LOG_ADDRS - Get or set the logical addresses


 Synopsis
 ========

-.. c:function:: int ioctl( int fd, int request, struct cec_log_addrs *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct cec_log_addrs *argp )
+

 Arguments
 =========
@@ -36,18 +39,18 @@ Note: this documents the proposed CEC API. This API is not yet finalized
 and is currently only available as a staging kernel module.

 To query the current CEC logical addresses, applications call the
-``CEC_ADAP_G_LOG_ADDRS`` ioctl with a pointer to a
+:ref:`CEC_ADAP_G_LOG_ADDRS` ioctl with a pointer to a
 :c:type:`struct cec_log_addrs` structure where the drivers stores
 the logical addresses.

 To set new logical addresses, applications fill in struct
-:c:type:`struct cec_log_addrs` and call the ``CEC_ADAP_S_LOG_ADDRS``
-ioctl with a pointer to this struct. The ``CEC_ADAP_S_LOG_ADDRS`` ioctl
+:c:type:`struct cec_log_addrs` and call the :ref:`CEC_ADAP_S_LOG_ADDRS`
+ioctl with a pointer to this struct. The :ref:`CEC_ADAP_S_LOG_ADDRS` ioctl
 is only available if ``CEC_CAP_LOG_ADDRS`` is set (ENOTTY error code is
 returned otherwise). This ioctl will block until all requested logical
-addresses have been claimed. ``CEC_ADAP_S_LOG_ADDRS`` can only be called
+addresses have been claimed. :ref:`CEC_ADAP_S_LOG_ADDRS` can only be called
 by a file handle in initiator mode (see
-:ref:`CEC_S_MODE <cec-ioc-g-mode>`).
+:ref:`CEC_S_MODE`).


 .. _cec-log-addrs:
@@ -90,7 +93,7 @@ by a file handle in initiator mode (see
       -  The CEC version that this adapter shall use. See
          :ref:`cec-versions`. Used to implement the
          ``CEC_MSG_CEC_VERSION`` and ``CEC_MSG_REPORT_FEATURES`` messages.
-          Note that ``CEC_OP_CEC_VERSION_1_3A`` is not allowed by the CEC
+          Note that :ref:`CEC_OP_CEC_VERSION_1_3A <CEC_OP_CEC_VERSION_1_3A>` is not allowed by the CEC
          framework.

    -  .. row 4
@@ -101,7 +104,7 @@ by a file handle in initiator mode (see

       -  Number of logical addresses to set up. Must be ≤
          ``available_log_addrs`` as returned by
-          :ref:`CEC_ADAP_G_CAPS <cec-ioc-adap-g-caps>`. All arrays in
+          :ref:`CEC_ADAP_G_CAPS`. All arrays in
          this structure are only filled up to index
          ``available_log_addrs``-1. The remaining array elements will be
          ignored. Note that the CEC 2.0 standard allows for a maximum of 2
@@ -158,7 +161,7 @@ by a file handle in initiator mode (see
       -  Logical address types. See :ref:`cec-log-addr-types` for
          possible types. The driver will update this with the actual
          logical address type that it claimed (e.g. it may have to fallback
-          to ``CEC_LOG_ADDR_TYPE_UNREGISTERED``).
+          to :ref:`CEC_LOG_ADDR_TYPE_UNREGISTERED <CEC_LOG_ADDR_TYPE_UNREGISTERED>`).

    -  .. row 10

@@ -169,7 +172,7 @@ by a file handle in initiator mode (see
       -  CEC 2.0 specific: all device types. See
          :ref:`cec-all-dev-types-flags`. Used to implement the
          ``CEC_MSG_REPORT_FEATURES`` message. This field is ignored if
-          ``cec_version`` < ``CEC_OP_CEC_VERSION_2_0``.
+          ``cec_version`` < :ref:`CEC_OP_CEC_VERSION_2_0 <CEC_OP_CEC_VERSION_2_0>`.

    -  .. row 11

@@ -180,7 +183,7 @@ by a file handle in initiator mode (see
       -  Features for each logical address. Used to implement the
          ``CEC_MSG_REPORT_FEATURES`` message. The 12 bytes include both the
          RC Profile and the Device Features. This field is ignored if
-          ``cec_version`` < ``CEC_OP_CEC_VERSION_2_0``.
+          ``cec_version`` < :ref:`CEC_OP_CEC_VERSION_2_0 <CEC_OP_CEC_VERSION_2_0>`.



@@ -192,7 +195,7 @@ by a file handle in initiator mode (see
    :widths:       3 1 4


-    -  .. row 1
+    -  .. _`CEC_OP_CEC_VERSION_1_3A`:

       -  ``CEC_OP_CEC_VERSION_1_3A``

@@ -200,7 +203,7 @@ by a file handle in initiator mode (see

       -  CEC version according to the HDMI 1.3a standard.

-    -  .. row 2
+    -  .. _`CEC_OP_CEC_VERSION_1_4B`:

       -  ``CEC_OP_CEC_VERSION_1_4B``

@@ -208,7 +211,7 @@ by a file handle in initiator mode (see

       -  CEC version according to the HDMI 1.4b standard.

-    -  .. row 3
+    -  .. _`CEC_OP_CEC_VERSION_2_0`:

       -  ``CEC_OP_CEC_VERSION_2_0``

@@ -226,7 +229,7 @@ by a file handle in initiator mode (see
    :widths:       3 1 4


-    -  .. row 1
+    -  .. _`CEC_OP_PRIM_DEVTYPE_TV`:

       -  ``CEC_OP_PRIM_DEVTYPE_TV``

@@ -234,7 +237,7 @@ by a file handle in initiator mode (see

       -  Use for a TV.

-    -  .. row 2
+    -  .. _`CEC_OP_PRIM_DEVTYPE_RECORD`:

       -  ``CEC_OP_PRIM_DEVTYPE_RECORD``

@@ -242,7 +245,7 @@ by a file handle in initiator mode (see

       -  Use for a recording device.

-    -  .. row 3
+    -  .. _`CEC_OP_PRIM_DEVTYPE_TUNER`:

       -  ``CEC_OP_PRIM_DEVTYPE_TUNER``

@@ -250,7 +253,7 @@ by a file handle in initiator mode (see

       -  Use for a device with a tuner.

-    -  .. row 4
+    -  .. _`CEC_OP_PRIM_DEVTYPE_PLAYBACK`:

       -  ``CEC_OP_PRIM_DEVTYPE_PLAYBACK``

@@ -258,7 +261,7 @@ by a file handle in initiator mode (see

       -  Use for a playback device.

-    -  .. row 5
+    -  .. _`CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM`:

       -  ``CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM``

@@ -266,7 +269,7 @@ by a file handle in initiator mode (see

       -  Use for an audio system (e.g. an audio/video receiver).

-    -  .. row 6
+    -  .. _`CEC_OP_PRIM_DEVTYPE_SWITCH`:

       -  ``CEC_OP_PRIM_DEVTYPE_SWITCH``

@@ -274,7 +277,7 @@ by a file handle in initiator mode (see

       -  Use for a CEC switch.

-    -  .. row 7
+    -  .. _`CEC_OP_PRIM_DEVTYPE_VIDEOPROC`:

       -  ``CEC_OP_PRIM_DEVTYPE_VIDEOPROC``

@@ -292,7 +295,7 @@ by a file handle in initiator mode (see
    :widths:       3 1 4


-    -  .. row 1
+    -  .. _`CEC_LOG_ADDR_TYPE_TV`:

       -  ``CEC_LOG_ADDR_TYPE_TV``

@@ -300,7 +303,7 @@ by a file handle in initiator mode (see

       -  Use for a TV.

-    -  .. row 2
+    -  .. _`CEC_LOG_ADDR_TYPE_RECORD`:

       -  ``CEC_LOG_ADDR_TYPE_RECORD``

@@ -308,7 +311,7 @@ by a file handle in initiator mode (see

       -  Use for a recording device.

-    -  .. row 3
+    -  .. _`CEC_LOG_ADDR_TYPE_TUNER`:

       -  ``CEC_LOG_ADDR_TYPE_TUNER``

@@ -316,7 +319,7 @@ by a file handle in initiator mode (see

       -  Use for a tuner device.

-    -  .. row 4
+    -  .. _`CEC_LOG_ADDR_TYPE_PLAYBACK`:

       -  ``CEC_LOG_ADDR_TYPE_PLAYBACK``

@@ -324,7 +327,7 @@ by a file handle in initiator mode (see

       -  Use for a playback device.

-    -  .. row 5
+    -  .. _`CEC_LOG_ADDR_TYPE_AUDIOSYSTEM`:

       -  ``CEC_LOG_ADDR_TYPE_AUDIOSYSTEM``

@@ -332,7 +335,7 @@ by a file handle in initiator mode (see

       -  Use for an audio system device.

-    -  .. row 6
+    -  .. _`CEC_LOG_ADDR_TYPE_SPECIFIC`:

       -  ``CEC_LOG_ADDR_TYPE_SPECIFIC``

@@ -340,7 +343,7 @@ by a file handle in initiator mode (see

       -  Use for a second TV or for a video processor device.

-    -  .. row 7
+    -  .. _`CEC_LOG_ADDR_TYPE_UNREGISTERED`:

       -  ``CEC_LOG_ADDR_TYPE_UNREGISTERED``

@@ -360,7 +363,7 @@ by a file handle in initiator mode (see
    :widths:       3 1 4


-    -  .. row 1
+    -  .. _`CEC_OP_ALL_DEVTYPE_TV`:

       -  ``CEC_OP_ALL_DEVTYPE_TV``

@@ -368,7 +371,7 @@ by a file handle in initiator mode (see

       -  This supports the TV type.

-    -  .. row 2
+    -  .. _`CEC_OP_ALL_DEVTYPE_RECORD`:

       -  ``CEC_OP_ALL_DEVTYPE_RECORD``

@@ -376,7 +379,7 @@ by a file handle in initiator mode (see

       -  This supports the Recording type.

-    -  .. row 3
+    -  .. _`CEC_OP_ALL_DEVTYPE_TUNER`:

       -  ``CEC_OP_ALL_DEVTYPE_TUNER``

@@ -384,7 +387,7 @@ by a file handle in initiator mode (see

       -  This supports the Tuner type.

-    -  .. row 4
+    -  .. _`CEC_OP_ALL_DEVTYPE_PLAYBACK`:

       -  ``CEC_OP_ALL_DEVTYPE_PLAYBACK``

@@ -392,7 +395,7 @@ by a file handle in initiator mode (see

       -  This supports the Playback type.

-    -  .. row 5
+    -  .. _`CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM`:

       -  ``CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM``

@@ -400,7 +403,7 @@ by a file handle in initiator mode (see

       -  This supports the Audio System type.

-    -  .. row 6
+    -  .. _`CEC_OP_ALL_DEVTYPE_SWITCH`:

       -  ``CEC_OP_ALL_DEVTYPE_SWITCH``

@@ -417,11 +420,3 @@ On success 0 is returned, on error -1 and the ``errno`` variable is set
 appropriately. The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.

-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
--- a/Documentation/media/uapi/cec/cec-ioc-adap-g-phys-addr.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-phys-addr.rst
 .. -*- coding: utf-8; mode: rst -*-

-.. _cec-ioc-adap-g-phys-addr:
+.. _CEC_ADAP_PHYS_ADDR:
+.. _CEC_ADAP_G_PHYS_ADDR:
+.. _CEC_ADAP_S_PHYS_ADDR:

 ************************************************
 ioctl CEC_ADAP_G_PHYS_ADDR, CEC_ADAP_S_PHYS_ADDR
 ************************************************

-*man CEC_ADAP_G_PHYS_ADDR(2)*
+Name
+====

-CEC_ADAP_S_PHYS_ADDR
-Get or set the physical address
+CEC_ADAP_G_PHYS_ADDR, CEC_ADAP_S_PHYS_ADDR - Get or set the physical address


 Synopsis
 ========

-.. c:function:: int ioctl( int fd, int request, __u16 *argp )
+.. cpp:function:: int ioctl( int fd, int request, __u16 *argp )

 Arguments
 =========
@@ -36,15 +38,15 @@ Note: this documents the proposed CEC API. This API is not yet finalized
 and is currently only available as a staging kernel module.

 To query the current physical address applications call the
-``CEC_ADAP_G_PHYS_ADDR`` ioctl with a pointer to an __u16 where the
+:ref:`CEC_ADAP_G_PHYS_ADDR` ioctl with a pointer to an __u16 where the
 driver stores the physical address.

 To set a new physical address applications store the physical address in
-an __u16 and call the ``CEC_ADAP_S_PHYS_ADDR`` ioctl with a pointer to
-this integer. ``CEC_ADAP_S_PHYS_ADDR`` is only available if
+an __u16 and call the :ref:`CEC_ADAP_S_PHYS_ADDR` ioctl with a pointer to
+this integer. :ref:`CEC_ADAP_S_PHYS_ADDR` is only available if
 ``CEC_CAP_PHYS_ADDR`` is set (ENOTTY error code will be returned
-otherwise). ``CEC_ADAP_S_PHYS_ADDR`` can only be called by a file handle
-in initiator mode (see :ref:`CEC_S_MODE <cec-ioc-g-mode>`), if not
+otherwise). :ref:`CEC_ADAP_S_PHYS_ADDR` can only be called by a file handle
+in initiator mode (see :ref:`CEC_S_MODE`), if not
 EBUSY error code will be returned.

 The physical address is a 16-bit number where each group of 4 bits
@@ -67,12 +69,3 @@ Return Value
 On success 0 is returned, on error -1 and the ``errno`` variable is set
 appropriately. The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
--- a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
 .. -*- coding: utf-8; mode: rst -*-

-.. _cec-ioc-g-event:
+.. _CEC_DQEVENT:

 *****************
 ioctl CEC_DQEVENT
 *****************

-*man CEC_DQEVENT(2)*
+Name
+====

-Dequeue a CEC event
+CEC_DQEVENT - Dequeue a CEC event


 Synopsis
 ========

-.. c:function:: int ioctl( int fd, int request, struct cec_event *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct cec_event *argp )

 Arguments
 =========
@@ -35,7 +36,7 @@ Note: this documents the proposed CEC API. This API is not yet finalized
 and is currently only available as a staging kernel module.

 CEC devices can send asynchronous events. These can be retrieved by
-calling the ``CEC_DQEVENT`` ioctl. If the file descriptor is in
+calling the :ref:`CEC_DQEVENT` ioctl. If the file descriptor is in
 non-blocking mode and no event is pending, then it will return -1 and
 set errno to the EAGAIN error code.

@@ -155,7 +156,7 @@ state did change in between the two events.

       -  ``state_change``

-       -  The new adapter state as sent by the ``CEC_EVENT_STATE_CHANGE``
+       -  The new adapter state as sent by the :ref:`CEC_EVENT_STATE_CHANGE <CEC_EVENT_STATE_CHANGE>`
          event.

    -  .. row 6
@@ -165,7 +166,7 @@ state did change in between the two events.

       -  ``lost_msgs``

-       -  The number of lost messages as sent by the ``CEC_EVENT_LOST_MSGS``
+       -  The number of lost messages as sent by the :ref:`CEC_EVENT_LOST_MSGS <CEC_EVENT_LOST_MSGS>`
          event.


@@ -178,7 +179,7 @@ state did change in between the two events.
    :widths:       3 1 4


-    -  .. row 1
+    -  .. _CEC_EVENT_STATE_CHANGE:

       -  ``CEC_EVENT_STATE_CHANGE``

@@ -188,7 +189,7 @@ state did change in between the two events.
          called an initial event will be generated for that filehandle with
          the CEC Adapter's state at that time.

-    -  .. row 2
+    -  .. _CEC_EVENT_LOST_MSGS:

       -  ``CEC_EVENT_LOST_MSGS``

@@ -207,7 +208,7 @@ state did change in between the two events.
    :widths:       3 1 4


-    -  .. row 1
+    -  .. _CEC_EVENT_FL_INITIAL_VALUE:

       -  ``CEC_EVENT_FL_INITIAL_VALUE``

@@ -226,12 +227,3 @@ Return Value
 On success 0 is returned, on error -1 and the ``errno`` variable is set
 appropriately. The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------
--- a/Documentation/media/uapi/cec/cec-ioc-g-mode.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-g-mode.rst
--- a/Documentation/media/uapi/cec/cec-ioc-receive.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-receive.rst