NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

libcamera: device_enumerator: extend documentation of DeviceMatch

Browse source 
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>
This commit is contained in:
Niklas Söderlund 2019-01-18 00:02:37 +01:00
parent 70b0518ba7
commit a9685c508f
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/libcamera/device_enumerator.cpp
View file

@ -54,6 +54,17 @@ LOG_DEFINE_CATEGORY(DeviceEnumerator)
* *
* The description is meant to be filled by pipeline managers and passed to a * The description is meant to be filled by pipeline managers and passed to a
* device enumerator to find matching media devices. * 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.
*/ */
/** /**