| Message ID | 20220130235821.48076-4-djrscally@gmail.com |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series |
|
| Related | show |
Hi Dan, Thank you for the patch. On Sun, Jan 30, 2022 at 11:58:18PM +0000, Daniel Scally wrote: > Add some elements to the uAPI documentation to explain the new link > type, their purpose and some aspects of their current implementation. > > Signed-off-by: Daniel Scally <djrscally@gmail.com> > --- > Changes since v1: > > - New patch > > .../media/mediactl/media-controller-model.rst | 6 ++++++ > .../userspace-api/media/mediactl/media-types.rst | 9 ++++++++- > 2 files changed, 14 insertions(+), 1 deletion(-) > > diff --git a/Documentation/userspace-api/media/mediactl/media-controller-model.rst b/Documentation/userspace-api/media/mediactl/media-controller-model.rst > index 222cb99debb5..f77cb9d952e5 100644 > --- a/Documentation/userspace-api/media/mediactl/media-controller-model.rst > +++ b/Documentation/userspace-api/media/mediactl/media-controller-model.rst > @@ -33,3 +33,9 @@ are: > > - An **interface link** is a point-to-point bidirectional control > connection between a Linux Kernel interface and an entity. > + > +- An **ancillary link** is a point-to-point connection describing a physical > + relationship between two entities. For example this could represent the > + fact that a particular camera sensor and lens controller form a single > + physical module, meaning this lens controller drives the lens for this > + camera sensor. > \ No newline at end of file > diff --git a/Documentation/userspace-api/media/mediactl/media-types.rst b/Documentation/userspace-api/media/mediactl/media-types.rst > index 0a26397bd01d..d69bae359e5b 100644 > --- a/Documentation/userspace-api/media/mediactl/media-types.rst > +++ b/Documentation/userspace-api/media/mediactl/media-types.rst > @@ -413,7 +413,7 @@ must be set for every pad. > > * - ``MEDIA_LNK_FL_LINK_TYPE`` > - This is a bitmask that defines the type of the link. Currently, > - two types of links are supported: > + three types of links are supported: Let's avoid having to patch this every time: - This is a bitmask that defines the type of the link. The following types of links are supported: > > .. _MEDIA-LNK-FL-DATA-LINK: > > @@ -423,3 +423,10 @@ must be set for every pad. > > ``MEDIA_LNK_FL_INTERFACE_LINK`` if the link is between an > interface and an entity > + > + .. _MEDIA-LNK-FL-ANCILLARY-LINK: > + > + ``MEDIA_LNK_FL_ANCILLARY_LINK`` if the link is between two > + different entities. This at present implies both MEDIA_LNK_FL_ENABLED > + and MEDIA_LNK_FL_IMMUTABLE, however applications should not rely on > + that being the case in the future. Let's describe what the link represents: ``MEDIA_LNK_FL_ANCILLARY_LINK`` for links that represent a physical relationship between two entities. You could also update the previous items similarly: ``MEDIA_LNK_FL_DATA_LINK`` for links thatrepresent a data connection between two pads. ``MEDIA_LNK_FL_INTERFACE_LINK`` for links that associate an entity and its interface. Let's also not tell that it impllies ENABLED and IMMUTABLE if applications shouldn't rely on this: The link may or may not be immutable, applications must not assume either case as always being true.
diff --git a/Documentation/userspace-api/media/mediactl/media-controller-model.rst b/Documentation/userspace-api/media/mediactl/media-controller-model.rst index 222cb99debb5..f77cb9d952e5 100644 --- a/Documentation/userspace-api/media/mediactl/media-controller-model.rst +++ b/Documentation/userspace-api/media/mediactl/media-controller-model.rst @@ -33,3 +33,9 @@ are: - An **interface link** is a point-to-point bidirectional control connection between a Linux Kernel interface and an entity. + +- An **ancillary link** is a point-to-point connection describing a physical + relationship between two entities. For example this could represent the + fact that a particular camera sensor and lens controller form a single + physical module, meaning this lens controller drives the lens for this + camera sensor. \ No newline at end of file diff --git a/Documentation/userspace-api/media/mediactl/media-types.rst b/Documentation/userspace-api/media/mediactl/media-types.rst index 0a26397bd01d..d69bae359e5b 100644 --- a/Documentation/userspace-api/media/mediactl/media-types.rst +++ b/Documentation/userspace-api/media/mediactl/media-types.rst @@ -413,7 +413,7 @@ must be set for every pad. * - ``MEDIA_LNK_FL_LINK_TYPE`` - This is a bitmask that defines the type of the link. Currently, - two types of links are supported: + three types of links are supported: .. _MEDIA-LNK-FL-DATA-LINK: @@ -423,3 +423,10 @@ must be set for every pad. ``MEDIA_LNK_FL_INTERFACE_LINK`` if the link is between an interface and an entity + + .. _MEDIA-LNK-FL-ANCILLARY-LINK: + + ``MEDIA_LNK_FL_ANCILLARY_LINK`` if the link is between two + different entities. This at present implies both MEDIA_LNK_FL_ENABLED + and MEDIA_LNK_FL_IMMUTABLE, however applications should not rely on + that being the case in the future.
Add some elements to the uAPI documentation to explain the new link type, their purpose and some aspects of their current implementation. Signed-off-by: Daniel Scally <djrscally@gmail.com> --- Changes since v1: - New patch .../media/mediactl/media-controller-model.rst | 6 ++++++ .../userspace-api/media/mediactl/media-types.rst | 9 ++++++++- 2 files changed, 14 insertions(+), 1 deletion(-)