[media] docs-rst: Convert MC uAPI to use C function references
Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>steinar/wifi_calib_4_9_kernel
parent
15c190146c
commit
5ccbb182d7
|
@ -21,13 +21,13 @@ Synopsis
|
||||||
|
|
||||||
|
|
||||||
.. c:function:: int close( int fd )
|
.. c:function:: int close( int fd )
|
||||||
|
:name: mc-close
|
||||||
|
|
||||||
Arguments
|
Arguments
|
||||||
=========
|
=========
|
||||||
|
|
||||||
``fd``
|
``fd``
|
||||||
File descriptor returned by :ref:`open() <func-open>`.
|
File descriptor returned by :c:func:`open() <mc-open>`.
|
||||||
|
|
||||||
|
|
||||||
Description
|
Description
|
||||||
|
|
|
@ -21,13 +21,13 @@ Synopsis
|
||||||
|
|
||||||
|
|
||||||
.. c:function:: int ioctl( int fd, int request, void *argp )
|
.. c:function:: int ioctl( int fd, int request, void *argp )
|
||||||
|
:name: mc-ioctl
|
||||||
|
|
||||||
Arguments
|
Arguments
|
||||||
=========
|
=========
|
||||||
|
|
||||||
``fd``
|
``fd``
|
||||||
File descriptor returned by :ref:`open() <func-open>`.
|
File descriptor returned by :c:func:`open() <mc-open>`.
|
||||||
|
|
||||||
``request``
|
``request``
|
||||||
Media ioctl request code as defined in the media.h header file, for
|
Media ioctl request code as defined in the media.h header file, for
|
||||||
|
|
|
@ -21,7 +21,7 @@ Synopsis
|
||||||
|
|
||||||
|
|
||||||
.. c:function:: int open( const char *device_name, int flags )
|
.. c:function:: int open( const char *device_name, int flags )
|
||||||
|
:name: mc-open
|
||||||
|
|
||||||
Arguments
|
Arguments
|
||||||
=========
|
=========
|
||||||
|
|
|
@ -15,7 +15,8 @@ MEDIA_IOC_DEVICE_INFO - Query device information
|
||||||
Synopsis
|
Synopsis
|
||||||
========
|
========
|
||||||
|
|
||||||
.. c:function:: int ioctl( int fd, int request, struct media_device_info *argp )
|
.. c:function:: int ioctl( int fd, MEDIA_IOC_DEVICE_INFO, struct media_device_info *argp )
|
||||||
|
:name: MEDIA_IOC_DEVICE_INFO
|
||||||
|
|
||||||
|
|
||||||
Arguments
|
Arguments
|
||||||
|
@ -24,9 +25,6 @@ Arguments
|
||||||
``fd``
|
``fd``
|
||||||
File descriptor returned by :ref:`open() <media-func-open>`.
|
File descriptor returned by :ref:`open() <media-func-open>`.
|
||||||
|
|
||||||
``request``
|
|
||||||
MEDIA_IOC_DEVICE_INFO
|
|
||||||
|
|
||||||
``argp``
|
``argp``
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,8 @@ MEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their properties
|
||||||
Synopsis
|
Synopsis
|
||||||
========
|
========
|
||||||
|
|
||||||
.. c:function:: int ioctl( int fd, int request, struct media_entity_desc *argp )
|
.. c:function:: int ioctl( int fd, MEDIA_IOC_ENUM_ENTITIES, struct media_entity_desc *argp )
|
||||||
|
:name: MEDIA_IOC_ENUM_ENTITIES
|
||||||
|
|
||||||
|
|
||||||
Arguments
|
Arguments
|
||||||
|
@ -24,9 +25,6 @@ Arguments
|
||||||
``fd``
|
``fd``
|
||||||
File descriptor returned by :ref:`open() <media-func-open>`.
|
File descriptor returned by :ref:`open() <media-func-open>`.
|
||||||
|
|
||||||
``request``
|
|
||||||
MEDIA_IOC_ENUM_ENTITIES
|
|
||||||
|
|
||||||
``argp``
|
``argp``
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,8 @@ MEDIA_IOC_ENUM_LINKS - Enumerate all pads and links for a given entity
|
||||||
Synopsis
|
Synopsis
|
||||||
========
|
========
|
||||||
|
|
||||||
.. c:function:: int ioctl( int fd, int request, struct media_links_enum *argp )
|
.. c:function:: int ioctl( int fd, MEDIA_IOC_ENUM_LINKS, struct media_links_enum *argp )
|
||||||
|
:name: MEDIA_IOC_ENUM_LINKS
|
||||||
|
|
||||||
|
|
||||||
Arguments
|
Arguments
|
||||||
|
@ -24,9 +25,6 @@ Arguments
|
||||||
``fd``
|
``fd``
|
||||||
File descriptor returned by :ref:`open() <media-func-open>`.
|
File descriptor returned by :ref:`open() <media-func-open>`.
|
||||||
|
|
||||||
``request``
|
|
||||||
MEDIA_IOC_ENUM_LINKS
|
|
||||||
|
|
||||||
``argp``
|
``argp``
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,8 @@ MEDIA_IOC_G_TOPOLOGY - Enumerate the graph topology and graph element properties
|
||||||
Synopsis
|
Synopsis
|
||||||
========
|
========
|
||||||
|
|
||||||
.. c:function:: int ioctl( int fd, int request, struct media_v2_topology *argp )
|
.. c:function:: int ioctl( int fd, MEDIA_IOC_G_TOPOLOGY, struct media_v2_topology *argp )
|
||||||
|
:name: MEDIA_IOC_G_TOPOLOGY
|
||||||
|
|
||||||
|
|
||||||
Arguments
|
Arguments
|
||||||
|
@ -24,9 +25,6 @@ Arguments
|
||||||
``fd``
|
``fd``
|
||||||
File descriptor returned by :ref:`open() <media-func-open>`.
|
File descriptor returned by :ref:`open() <media-func-open>`.
|
||||||
|
|
||||||
``request``
|
|
||||||
MEDIA_IOC_G_TOPOLOGY
|
|
||||||
|
|
||||||
``argp``
|
``argp``
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,8 @@ MEDIA_IOC_SETUP_LINK - Modify the properties of a link
|
||||||
Synopsis
|
Synopsis
|
||||||
========
|
========
|
||||||
|
|
||||||
.. c:function:: int ioctl( int fd, int request, struct media_link_desc *argp )
|
.. c:function:: int ioctl( int fd, MEDIA_IOC_SETUP_LINK, struct media_link_desc *argp )
|
||||||
|
:name: MEDIA_IOC_SETUP_LINK
|
||||||
|
|
||||||
|
|
||||||
Arguments
|
Arguments
|
||||||
|
@ -24,9 +25,6 @@ Arguments
|
||||||
``fd``
|
``fd``
|
||||||
File descriptor returned by :ref:`open() <media-func-open>`.
|
File descriptor returned by :ref:`open() <media-func-open>`.
|
||||||
|
|
||||||
``request``
|
|
||||||
MEDIA_IOC_SETUP_LINK
|
|
||||||
|
|
||||||
``argp``
|
``argp``
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue