diff options
| author | Niklas Söderlund <niklas.soderlund@ragnatech.se> | 2019-01-18 00:02:37 +0100 |
|---|---|---|
| committer | Niklas Söderlund <niklas.soderlund@ragnatech.se> | 2019-01-22 15:05:05 +0100 |
| commit | a9685c508f6d4391f8f4494338fe22285ff4b5a1 (patch) | |
| tree | e424c3a4aa19bdbbe3139d0b05c33e752c2bae90 /src | |
| parent | 70b0518ba711f37a0cd519661b87f0b2dc5995dc (diff) | |
libcamera: device_enumerator: extend documentation of DeviceMatch
Extend the documentation of the intended usage of DeviceMatch. The
DeviceMatch needs enough information to be able to uniquely identify a
specific media device.
Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/libcamera/device_enumerator.cpp | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp index fcf71af6..8100972a 100644 --- a/src/libcamera/device_enumerator.cpp +++ b/src/libcamera/device_enumerator.cpp @@ -54,6 +54,17 @@ LOG_DEFINE_CATEGORY(DeviceEnumerator) * * The description is meant to be filled by pipeline managers and passed to a * device enumerator to find matching media devices. + * + * A DeviceMatch is created with a specific Linux device driver in mind, + * therefore the name of the driver is a required property. One or more Entity + * names can be added as match criteria. + * + * Pipeline handlers are recommended to add entities to DeviceMatch as + * appropriare to ensure that the media device they need can be uniquely + * identified. This is useful when the corresponding kernel driver can produce + * different graphs, for instance as a result of different driver versions or + * hardware configurations, and not all those graphs are suitable for a pipeline + * handler. */ /** |