Commit 8c4fe248 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab

media: Documentation/media/uapi/mediactl: redo tables

Drop the '-  .. row 1' lines to make it easier to add new rows to
the tables in the future without having to renumber these lines.
Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
parent 1831af09
...@@ -48,12 +48,8 @@ ioctl never fails. ...@@ -48,12 +48,8 @@ ioctl never fails.
:widths: 1 1 2 :widths: 1 1 2
- .. row 1 * - char
- char
- ``driver``\ [16] - ``driver``\ [16]
- Name of the driver implementing the media API as a NUL-terminated - Name of the driver implementing the media API as a NUL-terminated
ASCII string. The driver version is stored in the ASCII string. The driver version is stored in the
``driver_version`` field. ``driver_version`` field.
...@@ -62,66 +58,38 @@ ioctl never fails. ...@@ -62,66 +58,38 @@ ioctl never fails.
the driver identity. It is also useful to work around known bugs, the driver identity. It is also useful to work around known bugs,
or to identify drivers in error reports. or to identify drivers in error reports.
- .. row 2 * - char
- char
- ``model``\ [32] - ``model``\ [32]
- Device model name as a NUL-terminated UTF-8 string. The device - Device model name as a NUL-terminated UTF-8 string. The device
version is stored in the ``device_version`` field and is not be version is stored in the ``device_version`` field and is not be
appended to the model name. appended to the model name.
- .. row 3 * - char
- char
- ``serial``\ [40] - ``serial``\ [40]
- Serial number as a NUL-terminated ASCII string. - Serial number as a NUL-terminated ASCII string.
- .. row 4 * - char
- char
- ``bus_info``\ [32] - ``bus_info``\ [32]
- Location of the device in the system as a NUL-terminated ASCII - Location of the device in the system as a NUL-terminated ASCII
string. This includes the bus type name (PCI, USB, ...) and a string. This includes the bus type name (PCI, USB, ...) and a
bus-specific identifier. bus-specific identifier.
- .. row 5 * - __u32
- __u32
- ``media_version`` - ``media_version``
- Media API version, formatted with the ``KERNEL_VERSION()`` macro. - Media API version, formatted with the ``KERNEL_VERSION()`` macro.
- .. row 6 * - __u32
- __u32
- ``hw_revision`` - ``hw_revision``
- Hardware device revision in a driver-specific format. - Hardware device revision in a driver-specific format.
- .. row 7 * - __u32
- __u32
- ``driver_version`` - ``driver_version``
- Media device driver version, formatted with the - Media device driver version, formatted with the
``KERNEL_VERSION()`` macro. Together with the ``driver`` field ``KERNEL_VERSION()`` macro. Together with the ``driver`` field
this identifies a particular driver. this identifies a particular driver.
- .. row 8 * - __u32
- __u32
- ``reserved``\ [31] - ``reserved``\ [31]
- Reserved for future extensions. Drivers and applications must set - Reserved for future extensions. Drivers and applications must set
this array to zero. this array to zero.
......
...@@ -58,142 +58,87 @@ id's until they get an error. ...@@ -58,142 +58,87 @@ id's until they get an error.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 1 1 8 :widths: 1 1 1 1 8
* - __u32
- .. row 1
- __u32
- ``id`` - ``id``
- -
- -
- Entity id, set by the application. When the id is or'ed with - Entity id, set by the application. When the id is or'ed with
``MEDIA_ENT_ID_FLAG_NEXT``, the driver clears the flag and returns ``MEDIA_ENT_ID_FLAG_NEXT``, the driver clears the flag and returns
the first entity with a larger id. the first entity with a larger id.
- .. row 2 * - char
- char
- ``name``\ [32] - ``name``\ [32]
- -
- -
- Entity name as an UTF-8 NULL-terminated string. - Entity name as an UTF-8 NULL-terminated string.
- .. row 3 * - __u32
- __u32
- ``type`` - ``type``
- -
- -
- Entity type, see :ref:`media-entity-functions` for details. - Entity type, see :ref:`media-entity-functions` for details.
- .. row 4 * - __u32
- __u32
- ``revision`` - ``revision``
- -
- -
- Entity revision. Always zero (obsolete) - Entity revision. Always zero (obsolete)
- .. row 5 * - __u32
- __u32
- ``flags`` - ``flags``
- -
- -
- Entity flags, see :ref:`media-entity-flag` for details. - Entity flags, see :ref:`media-entity-flag` for details.
- .. row 6 * - __u32
- __u32
- ``group_id`` - ``group_id``
- -
- -
- Entity group ID. Always zero (obsolete) - Entity group ID. Always zero (obsolete)
- .. row 7 * - __u16
- __u16
- ``pads`` - ``pads``
- -
- -
- Number of pads - Number of pads
- .. row 8 * - __u16
- __u16
- ``links`` - ``links``
- -
- -
- Total number of outbound links. Inbound links are not counted in - Total number of outbound links. Inbound links are not counted in
this field. this field.
- .. row 9 * - __u32
- __u32
- ``reserved[4]`` - ``reserved[4]``
- -
- -
- Reserved for future extensions. Drivers and applications must set - Reserved for future extensions. Drivers and applications must set
the array to zero. the array to zero.
- .. row 10 * - union
- union
- .. row 11
- * -
- struct - struct
- ``dev`` - ``dev``
- -
- Valid for (sub-)devices that create a single device node. - Valid for (sub-)devices that create a single device node.
- .. row 12 * -
-
- -
- __u32 - __u32
- ``major`` - ``major``
- Device node major number. - Device node major number.
- .. row 13 * -
-
- -
- __u32 - __u32
- ``minor`` - ``minor``
- Device node minor number. - Device node minor number.
- .. row 14 * -
-
- __u8 - __u8
- ``raw``\ [184] - ``raw``\ [184]
- -
- -
......
...@@ -62,35 +62,21 @@ returned during the enumeration process. ...@@ -62,35 +62,21 @@ returned during the enumeration process.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1
- __u32
- ``entity`` - ``entity``
- Entity id, set by the application. - Entity id, set by the application.
- .. row 2 * - struct :c:type:`media_pad_desc`
- struct :c:type:`media_pad_desc`
- \*\ ``pads`` - \*\ ``pads``
- Pointer to a pads array allocated by the application. Ignored if - Pointer to a pads array allocated by the application. Ignored if
NULL. NULL.
- .. row 3 * - struct :c:type:`media_link_desc`
- struct :c:type:`media_link_desc`
- \*\ ``links`` - \*\ ``links``
- Pointer to a links array allocated by the application. Ignored if - Pointer to a links array allocated by the application. Ignored if
NULL. NULL.
.. c:type:: media_pad_desc .. c:type:: media_pad_desc
.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}| .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
...@@ -100,37 +86,20 @@ returned during the enumeration process. ...@@ -100,37 +86,20 @@ returned during the enumeration process.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - __u32
- .. row 1
- __u32
- ``entity`` - ``entity``
- ID of the entity this pad belongs to. - ID of the entity this pad belongs to.
- .. row 2 * - __u16
- __u16
- ``index`` - ``index``
- 0-based pad index. - 0-based pad index.
- .. row 3 * - __u32
- __u32
- ``flags`` - ``flags``
- Pad flags, see :ref:`media-pad-flag` for more details. - Pad flags, see :ref:`media-pad-flag` for more details.
- .. row 4 * - __u32
- __u32
- ``reserved[2]`` - ``reserved[2]``
- Reserved for future extensions. Drivers and applications must set - Reserved for future extensions. Drivers and applications must set
the array to zero. the array to zero.
...@@ -145,37 +114,20 @@ returned during the enumeration process. ...@@ -145,37 +114,20 @@ returned during the enumeration process.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 2 :widths: 1 1 2
* - struct :c:type:`media_pad_desc`
- .. row 1
- struct :c:type:`media_pad_desc`
- ``source`` - ``source``
- Pad at the origin of this link. - Pad at the origin of this link.
- .. row 2 * - struct :c:type:`media_pad_desc`
- struct :c:type:`media_pad_desc`
- ``sink`` - ``sink``
- Pad at the target of this link. - Pad at the target of this link.
- .. row 3 * - __u32
- __u32
- ``flags`` - ``flags``
- Link flags, see :ref:`media-link-flag` for more details. - Link flags, see :ref:`media-link-flag` for more details.
- .. row 4 * - __u32
- __u32
- ``reserved[4]`` - ``reserved[4]``
- Reserved for future extensions. Drivers and applications must set - Reserved for future extensions. Drivers and applications must set
the array to zero. the array to zero.
......
...@@ -55,119 +55,66 @@ desired arrays with the media graph elements. ...@@ -55,119 +55,66 @@ desired arrays with the media graph elements.
:stub-columns: 0 :stub-columns: 0
:widths: 1 2 8 :widths: 1 2 8
* - __u64
- .. row 1
- __u64
- ``topology_version`` - ``topology_version``
- Version of the media graph topology. When the graph is created, - Version of the media graph topology. When the graph is created,
this field starts with zero. Every time a graph element is added this field starts with zero. Every time a graph element is added
or removed, this field is incremented. or removed, this field is incremented.
- .. row 2 * - __u32
- __u32
- ``num_entities`` - ``num_entities``
- Number of entities in the graph - Number of entities in the graph
- .. row 3 * - __u32
- __u32
- ``reserved1`` - ``reserved1``
- Applications and drivers shall set this to 0. - Applications and drivers shall set this to 0.
- .. row 4 * - __u64
- __u64
- ``ptr_entities`` - ``ptr_entities``
- A pointer to a memory area where the entities array will be - A pointer to a memory area where the entities array will be
stored, converted to a 64-bits integer. It can be zero. if zero, stored, converted to a 64-bits integer. It can be zero. if zero,
the ioctl won't store the entities. It will just update the ioctl won't store the entities. It will just update
``num_entities`` ``num_entities``
- .. row 5 * - __u32
- __u32
- ``num_interfaces`` - ``num_interfaces``
- Number of interfaces in the graph - Number of interfaces in the graph
- .. row 6 * - __u32
- __u32
- ``reserved2`` - ``reserved2``
- Applications and drivers shall set this to 0. - Applications and drivers shall set this to 0.
- .. row 7 * - __u64
- __u64
- ``ptr_interfaces`` - ``ptr_interfaces``
- A pointer to a memory area where the interfaces array will be - A pointer to a memory area where the interfaces array will be
stored, converted to a 64-bits integer. It can be zero. if zero, stored, converted to a 64-bits integer. It can be zero. if zero,
the ioctl won't store the interfaces. It will just update the ioctl won't store the interfaces. It will just update
``num_interfaces`` ``num_interfaces``
- .. row 8 * - __u32
- __u32
- ``num_pads`` - ``num_pads``
- Total number of pads in the graph - Total number of pads in the graph
- .. row 9 * - __u32
- __u32
- ``reserved3`` - ``reserved3``
- Applications and drivers shall set this to 0. - Applications and drivers shall set this to 0.
- .. row 10 * - __u64
- __u64
- ``ptr_pads`` - ``ptr_pads``
- A pointer to a memory area where the pads array will be stored, - A pointer to a memory area where the pads array will be stored,
converted to a 64-bits integer. It can be zero. if zero, the ioctl converted to a 64-bits integer. It can be zero. if zero, the ioctl
won't store the pads. It will just update ``num_pads`` won't store the pads. It will just update ``num_pads``
- .. row 11 * - __u32
- __u32
- ``num_links`` - ``num_links``
- Total number of data and interface links in the graph - Total number of data and interface links in the graph
- .. row 12 * - __u32
- __u32
- ``reserved4`` - ``reserved4``
- Applications and drivers shall set this to 0. - Applications and drivers shall set this to 0.
- .. row 13 * - __u64
- __u64
- ``ptr_links`` - ``ptr_links``
- A pointer to a memory area where the links array will be stored, - A pointer to a memory area where the links array will be stored,
converted to a 64-bits integer. It can be zero. if zero, the ioctl converted to a 64-bits integer. It can be zero. if zero, the ioctl
won't store the links. It will just update ``num_links`` won't store the links. It will just update ``num_links``
...@@ -182,37 +129,20 @@ desired arrays with the media graph elements. ...@@ -182,37 +129,20 @@ desired arrays with the media graph elements.
:stub-columns: 0 :stub-columns: 0
:widths: 1 2 8 :widths: 1 2 8
* - __u32
- .. row 1
- __u32
- ``id`` - ``id``
- Unique ID for the entity. - Unique ID for the entity.
- .. row 2 * - char
- char
- ``name``\ [64] - ``name``\ [64]
- Entity name as an UTF-8 NULL-terminated string. - Entity name as an UTF-8 NULL-terminated string.
- .. row 3 * - __u32
- __u32
- ``function`` - ``function``
- Entity main function, see :ref:`media-entity-functions` for details. - Entity main function, see :ref:`media-entity-functions` for details.
- .. row 4 * - __u32
- __u32
- ``reserved``\ [6] - ``reserved``\ [6]
- Reserved for future extensions. Drivers and applications must set - Reserved for future extensions. Drivers and applications must set
this array to zero. this array to zero.
...@@ -226,45 +156,25 @@ desired arrays with the media graph elements. ...@@ -226,45 +156,25 @@ desired arrays with the media graph elements.
:stub-columns: 0 :stub-columns: 0
:widths: 1 2 8 :widths: 1 2 8
- .. row 1 * - __u32
- __u32
- ``id`` - ``id``
- Unique ID for the interface. - Unique ID for the interface.
- .. row 2 * - __u32
- __u32
- ``intf_type`` - ``intf_type``
- Interface type, see :ref:`media-intf-type` for details. - Interface type, see :ref:`media-intf-type` for details.
- .. row 3 * - __u32
- __u32
- ``flags`` - ``flags``
- Interface flags. Currently unused. - Interface flags. Currently unused.
- .. row 4 * - __u32
- __u32
- ``reserved``\ [9] - ``reserved``\ [9]
- Reserved for future extensions. Drivers and applications must set - Reserved for future extensions. Drivers and applications must set
this array to zero. this array to zero.
- .. row 5 * - struct media_v2_intf_devnode
- struct media_v2_intf_devnode
- ``devnode`` - ``devnode``
- Used only for device node interfaces. See - Used only for device node interfaces. See
:c:type:`media_v2_intf_devnode` for details.. :c:type:`media_v2_intf_devnode` for details..
...@@ -278,24 +188,14 @@ desired arrays with the media graph elements. ...@@ -278,24 +188,14 @@ desired arrays with the media graph elements.
:stub-columns: 0 :stub-columns: 0
:widths: 1 2 8 :widths: 1 2 8
* - __u32
- .. row 1
- __u32
- ``major`` - ``major``
- Device node major number. - Device node major number.
- .. row 2 * - __u32
- __u32
- ``minor`` - ``minor``
- Device node minor number. - Device node minor number.
.. tabularcolumns:: |p{1.6cm}|p{3.2cm}|p{12.7cm}| .. tabularcolumns:: |p{1.6cm}|p{3.2cm}|p{12.7cm}|
.. c:type:: media_v2_pad .. c:type:: media_v2_pad
...@@ -305,37 +205,20 @@ desired arrays with the media graph elements. ...@@ -305,37 +205,20 @@ desired arrays with the media graph elements.
:stub-columns: 0 :stub-columns: 0
:widths: 1 2 8 :widths: 1 2 8
* - __u32
- .. row 1
- __u32
- ``id`` - ``id``
- Unique ID for the pad. - Unique ID for the pad.
- .. row 2 * - __u32
- __u32
- ``entity_id`` - ``entity_id``
- Unique ID for the entity where this pad belongs. - Unique ID for the entity where this pad belongs.
- .. row 3 * - __u32
- __u32
- ``flags`` - ``flags``
- Pad flags, see :ref:`media-pad-flag` for more details. - Pad flags, see :ref:`media-pad-flag` for more details.
- .. row 4 * - __u32
- __u32
- ``reserved``\ [5] - ``reserved``\ [5]
- Reserved for future extensions. Drivers and applications must set - Reserved for future extensions. Drivers and applications must set
this array to zero. this array to zero.
...@@ -349,49 +232,28 @@ desired arrays with the media graph elements. ...@@ -349,49 +232,28 @@ desired arrays with the media graph elements.
:stub-columns: 0 :stub-columns: 0
:widths: 1 2 8 :widths: 1 2 8
* - __u32
- .. row 1
- __u32
- ``id`` - ``id``
- Unique ID for the link. - Unique ID for the link.
- .. row 2 * - __u32
- __u32
- ``source_id`` - ``source_id``
- On pad to pad links: unique ID for the source pad. - On pad to pad links: unique ID for the source pad.
On interface to entity links: unique ID for the interface. On interface to entity links: unique ID for the interface.
- .. row 3 * - __u32
- __u32
- ``sink_id`` - ``sink_id``
- On pad to pad links: unique ID for the sink pad. - On pad to pad links: unique ID for the sink pad.
On interface to entity links: unique ID for the entity. On interface to entity links: unique ID for the entity.
- .. row 4 * - __u32
- __u32
- ``flags`` - ``flags``
- Link flags, see :ref:`media-link-flag` for more details. - Link flags, see :ref:`media-link-flag` for more details.
- .. row 5 * - __u32
- __u32
- ``reserved``\ [6] - ``reserved``\ [6]
- Reserved for future extensions. Drivers and applications must set - Reserved for future extensions. Drivers and applications must set
this array to zero. this array to zero.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment