leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

media: media-ioc-enum-entities.rst/-g-topology.rst: clarify ID/name usage

Browse Source 
Mention that IDs should not be hardcoded in applications and that the
entity name must be unique within the media topology.

Signed-off-by: Hans Verkuil <hansverk@cisco.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
This commit is contained in:
Hans Verkuil 2018-06-29 07:31:20 -04:00 committed by Mauro Carvalho Chehab
parent e5def28568
commit 8601494e0e
2 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst
View File

@ -62,15 +62,18 @@ id's until they get an error.
- ``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
the first entity with a larger id.
the first entity with a larger ID. Do not expect that the ID will
always be the same for each instance of the device. In other words,
do not hardcode entity IDs in an application.
* - char
- ``name``\ [32]
-
-
- Entity name as an UTF-8 NULL-terminated string.
- Entity name as an UTF-8 NULL-terminated string. This name must be unique
within the media topology.
* - __u32
- ``type``

19
Documentation/media/uapi/mediactl/media-ioc-g-topology.rst
View File

@ -131,11 +131,14 @@ desired arrays with the media graph elements.
* - __u32
- ``id``
- Unique ID for the entity.
- Unique ID for the entity. Do not expect that the ID will
always be the same for each instance of the device. In other words,
do not hardcode entity IDs in an application.
* - char
- ``name``\ [64]
- Entity name as an UTF-8 NULL-terminated string.
- Entity name as an UTF-8 NULL-terminated string. This name must be unique
within the media topology.
* - __u32
- ``function``
@ -166,7 +169,9 @@ desired arrays with the media graph elements.
* - __u32
- ``id``
- Unique ID for the interface.
- Unique ID for the interface. Do not expect that the ID will
always be the same for each instance of the device. In other words,
do not hardcode interface IDs in an application.
* - __u32
- ``intf_type``
@ -215,7 +220,9 @@ desired arrays with the media graph elements.
* - __u32
- ``id``
- Unique ID for the pad.
- Unique ID for the pad. Do not expect that the ID will
always be the same for each instance of the device. In other words,
do not hardcode pad IDs in an application.
* - __u32
- ``entity_id``
@ -249,7 +256,9 @@ desired arrays with the media graph elements.
* - __u32
- ``id``
- Unique ID for the link.
- Unique ID for the link. Do not expect that the ID will
always be the same for each instance of the device. In other words,
do not hardcode link IDs in an application.
* - __u32
- ``source_id``