From patchwork Sun Feb 24 17:36:58 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: 610 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 7DB95601E2 for ; Sun, 24 Feb 2019 18:37:11 +0100 (CET) X-Halon-ID: d01e8a70-385a-11e9-b5ae-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 d01e8a70-385a-11e9-b5ae-0050569116f7; Sun, 24 Feb 2019 18:37:10 +0100 (CET) From: =?utf-8?q?Niklas_S=C3=B6derlund?= To: libcamera-devel@lists.libcamera.org Date: Sun, 24 Feb 2019 18:36:58 +0100 Message-Id: <20190224173701.8587-2-niklas.soderlund@ragnatech.se> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190224173701.8587-1-niklas.soderlund@ragnatech.se> References: <20190224173701.8587-1-niklas.soderlund@ragnatech.se> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v2 1/4] libcamera: pipeline_handler: extend documentation for configureStreams() 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: Sun, 24 Feb 2019 17:37:11 -0000 Extend the documentation to explicitly state that the pipeline handler implementations are responsible for validating that the requested configuration can be exactly satisfied by the hardware. Signed-off-by: Niklas Söderlund Reviewed-by: Laurent Pinchart --- src/libcamera/pipeline_handler.cpp | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp index 616838fed702fec7..dad0a2964486c5d4 100644 --- a/src/libcamera/pipeline_handler.cpp +++ b/src/libcamera/pipeline_handler.cpp @@ -136,6 +136,14 @@ PipelineHandler::~PipelineHandler() * is the Camera class which will receive configuration to apply from the * application. * + * Each pipeline handler implementation is responsible for validating + * that the configuration requested in \a config can be achieved + * exactly. Any difference in pixel format, frame size or any other + * parameter shall result in the -EINVAL error being returned, and no + * change in configuration being applied to the pipeline. If + * configuration of a subset of the streams can't be satisfied, the + * whole configuration is considered invalid. + * * \return 0 on success or a negative error code on error. */