From patchwork Thu Jan 17 23:06:36 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Niklas_S=C3=B6derlund?= X-Patchwork-Id: 265 Return-Path: Received: from bin-mail-out-05.binero.net (bin-mail-out-05.binero.net [195.74.38.228]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 2E7D660B2D for ; Fri, 18 Jan 2019 00:06:44 +0100 (CET) X-Halon-ID: 7f8462cc-1aac-11e9-911a-0050569116f7 Authorized-sender: niklas@soderlund.pp.se Received: from bismarck.berto.se (unknown [89.233.230.99]) by bin-vsp-out-03.atm.binero.net (Halon) with ESMTPA id 7f8462cc-1aac-11e9-911a-0050569116f7; Fri, 18 Jan 2019 00:06:23 +0100 (CET) From: =?utf-8?q?Niklas_S=C3=B6derlund?= To: libcamera-devel@lists.libcamera.org Date: Fri, 18 Jan 2019 00:06:36 +0100 Message-Id: <20190117230636.16176-1-niklas.soderlund@ragnatech.se> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH] libcamera: device_enumerator: extend documentation of DeviceMatch X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 17 Jan 2019 23:06:44 -0000 Extend the document of the intended usage of DeviceMatch need for information to correctly function to find a uniquely identifiable media device. Signed-off-by: Niklas Söderlund --- src/libcamera/device_enumerator.cpp | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp index 55c510e3b79a415b..e0b19313552f6aa5 100644 --- a/src/libcamera/device_enumerator.cpp +++ b/src/libcamera/device_enumerator.cpp @@ -52,6 +52,15 @@ namespace libcamera { * * 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, therefor + * the name of the driver is a required property. One or more Entity names can + * be added the matching with \a add(). + * + * A pipeline handler should add as many entities to a DeviceMatch so that the + * media device can be uniquely identified in case a Linux device driver is + * capable of producing different media graphs as a result of different hardware + * versions or other circumstances. */ /**