X-Git-Url: http://git.cascardo.info/?p=cascardo%2Flinux.git;a=blobdiff_plain;f=Documentation%2Fmedia%2Fuapi%2Fmediactl%2Fmedia-ioc-enum-links.rst;h=d05be16ffaf66d6e5da9a73ad28ceb925dacf69a;hp=87443b1ce42d56c1031254b161767b691eef3dc4;hb=8a1e377e55f2dca5c689926313beeaa8ac2adb22;hpb=511a8cdb650544b7efd1bbccf7967d3153aee5f6 diff --git a/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst b/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst index 87443b1ce42d..d05be16ffaf6 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst +++ b/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst @@ -15,7 +15,8 @@ MEDIA_IOC_ENUM_LINKS - Enumerate all pads and links for a given entity Synopsis ======== -.. cpp: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 @@ -24,9 +25,6 @@ Arguments ``fd`` File descriptor returned by :ref:`open() `. -``request`` - MEDIA_IOC_ENUM_LINKS - ``argp`` @@ -34,10 +32,10 @@ Description =========== To enumerate pads and/or links for a given entity, applications set the -entity field of a struct :ref:`media_links_enum ` +entity field of a struct :c:type:`media_links_enum` structure and initialize the struct -:ref:`media_pad_desc ` and struct -:ref:`media_link_desc ` structure arrays pointed by +:c:type:`media_pad_desc` and struct +:c:type:`media_link_desc` structure arrays pointed by the ``pads`` and ``links`` fields. They then call the MEDIA_IOC_ENUM_LINKS ioctl with a pointer to this structure. @@ -55,7 +53,9 @@ Only forward links that originate at one of the entity's source pads are returned during the enumeration process. -.. _media-links-enum: +.. c:type:: media_links_enum + +.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| .. flat-table:: struct media_links_enum :header-rows: 0 @@ -73,7 +73,7 @@ returned during the enumeration process. - .. row 2 - - struct :ref:`media_pad_desc ` + - struct :c:type:`media_pad_desc` - \*\ ``pads`` @@ -82,7 +82,7 @@ returned during the enumeration process. - .. row 3 - - struct :ref:`media_link_desc ` + - struct :c:type:`media_link_desc` - \*\ ``links`` @@ -91,7 +91,9 @@ returned during the enumeration process. -.. _media-pad-desc: +.. c:type:: media_pad_desc + +.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| .. flat-table:: struct media_pad_desc :header-rows: 0 @@ -125,7 +127,9 @@ returned during the enumeration process. -.. _media-link-desc: +.. c:type:: media_link_desc + +.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| .. flat-table:: struct media_link_desc :header-rows: 0 @@ -135,7 +139,7 @@ returned during the enumeration process. - .. row 1 - - struct :ref:`media_pad_desc ` + - struct :c:type:`media_pad_desc` - ``source`` @@ -143,7 +147,7 @@ returned during the enumeration process. - .. row 2 - - struct :ref:`media_pad_desc ` + - struct :c:type:`media_pad_desc` - ``sink`` @@ -166,5 +170,5 @@ appropriately. The generic error codes are described at the :ref:`Generic Error Codes ` chapter. EINVAL - The struct :ref:`media_links_enum ` ``id`` + The struct :c:type:`media_links_enum` ``id`` references a non-existing entity.