{"id":19240,"url":"https://patchwork.libcamera.org/api/1.1/patches/19240/?format=json","web_url":"https://patchwork.libcamera.org/patch/19240/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20231124123713.22519-8-naush@raspberrypi.com>","date":"2023-11-24T12:37:13","name":"[libcamera-devel,v3,7/7] documentation: Document vendor specific controls and properties handling","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"4c93b7f5e8c8c1a76e3c496936cd3f80c88cd8e9","submitter":{"id":34,"url":"https://patchwork.libcamera.org/api/1.1/people/34/?format=json","name":"Naushir Patuck","email":"naush@raspberrypi.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/19240/mbox/","series":[{"id":4084,"url":"https://patchwork.libcamera.org/api/1.1/series/4084/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4084","date":"2023-11-24T12:37:06","name":"Vendor controls and properties","version":3,"mbox":"https://patchwork.libcamera.org/series/4084/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/19240/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/19240/checks/","tags":{},"headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 5FC7CC32B7\n\tfor ;\n\tFri, 24 Nov 2023 12:37:27 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id E79C9629D4;\n\tFri, 24 Nov 2023 13:37:26 +0100 (CET)","from mail-wm1-x331.google.com (mail-wm1-x331.google.com\n\t[IPv6:2a00:1450:4864:20::331])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id C9787629C8\n\tfor ;\n\tFri, 24 Nov 2023 13:37:23 +0100 (CET)","by mail-wm1-x331.google.com with SMTP id\n\t5b1f17b1804b1-4083f613272so13113745e9.1\n\tfor ;\n\tFri, 24 Nov 2023 04:37:23 -0800 (PST)","from localhost.localdomain ([93.93.133.154])\n\tby smtp.gmail.com with ESMTPSA id\n\tv11-20020a05600c444b00b0040b3867a297sm3303690wmn.36.2023.11.24.04.37.22\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tFri, 24 Nov 2023 04:37:22 -0800 (PST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1700829446;\n\tbh=eGqs129EM6+J8Mws/VYo52jC5pwtv4hgfPnByXcVwC0=;\n\th=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=PdzMDKnJc8QSn1/Mbx1uZyl9CadujJX5eAHvE/d/g8TBPL/e8UZ34hsyX6uNf7ZbP\n\tH0AoKvPnP15CQbNlJSSwFEr6U51nsS4ZtEwRRfpHhtNu9WwLX5c3df3TTXStarbK9S\n\toLdZzlO3HL9FgxmuE12V8YIXxuC/hWFn3m6pCWPc3H31RGsnetY0CTMQyuEHBk+Ma5\n\tveF6rQNumRUjucoo2qhEI9YtWxY0VLdahOJKGUcTsBSmOt9hfLQGutJ4VSpjR9lT3/\n\t93KHXc3anT/4SRUh3o2b7IHwZe0JbgoCwlxYphSkjzZYguIkwgjuBBr5v6lfttLZBH\n\tQlI05GG46nO8w==","v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=raspberrypi.com; s=google; t=1700829443; x=1701434243;\n\tdarn=lists.libcamera.org; \n\th=content-transfer-encoding:mime-version:references:in-reply-to\n\t:message-id:date:subject:cc:to:from:from:to:cc:subject:date\n\t:message-id:reply-to;\n\tbh=kQC94eTP69cZcBBoIV68TpVGNbbk+m4+pPQAyOU5+U8=;\n\tb=hoLwH1VaATjiR2vD70pe+b1p/2vDrZNppmkH9oduTGJ4dGg4xV122ZPT4oF0Gcwh5H\n\tCO58VUzdb2wn0BckJ2dWuuu7oUAipDAZcNsocO1c6PoYhXk12ZomJRz2XfYcGEKAr6Da\n\tMARM/j/mJAtVfO1m3niqiHT5sDj4J5yVqfPcuCVa+18QwMoDRr8fuKLh71zoBQcO4NlU\n\tB0X4M/Jui/RIJbagB9oDFB4I5Q5Umsn9vDHQBCFOjF40Cj7GLXAY35oSl8ePn1HCCTlS\n\tCCqGwPGRwHVm9QQXAFwuiTQzWfasiFhXYSq/7tdN7u3tdWcP5zhxEosYyKB4K4z7rCDm\n\t/aJA=="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (2048-bit key; \n\tunprotected) header.d=raspberrypi.com\n\theader.i=@raspberrypi.com\n\theader.b=\"hoLwH1Va\"; dkim-atps=neutral","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20230601; t=1700829443; x=1701434243;\n\th=content-transfer-encoding:mime-version:references:in-reply-to\n\t:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n\t:subject:date:message-id:reply-to;\n\tbh=kQC94eTP69cZcBBoIV68TpVGNbbk+m4+pPQAyOU5+U8=;\n\tb=U7pyEz5SHiv+wThHztHHkG25ia+UW6SRAP/r5hJTNOQbQ99kUHsOs1VS0vWxYASKbB\n\tsluySNLk8g5fC0NVAXASLpBP/EEHi3flqR2g/vA0YXrTBShYxQ68ehVziBZJuXXmZ84R\n\tsGR1AsbDAMnd/TL64+6aM1dfgO3AoYJP7l9ZKnXumo++6V/B/ol1x0ABk/zsBjDqdn4z\n\tRd0yl5slb2jisHYXmspnSRjuCMBdBFvWn3x4w33S/K2i9fNG+wOpaHOvAwNUk2JlG2Sh\n\tor03KSRy++WRsXAhLAoiXQrmC6Xgdj6FUi83E+fMRNN/0tIWslcdp0aH/uBzd/X6FhHJ\n\t2xfg==","X-Gm-Message-State":"AOJu0Yxy+GgPx4oGZQPkMhloHCoAG7zIreQ3WZJNB/tqY1XqlFlxi0aO\n\tW/+e3VRB2Qot9PSlXukEuxdF5oHoOUShM+QucwwG/A==","X-Google-Smtp-Source":"AGHT+IFF/nzYuQObldNmcy6aHIUUzCIoWBEKza8Rdn5pMmpz3HzBlpV85AWMfJq5ztzrJRJyj4VipA==","X-Received":"by 2002:a05:600c:4f90:b0:40b:36e5:e1e9 with SMTP id\n\tn16-20020a05600c4f9000b0040b36e5e1e9mr1993845wmq.24.1700829443250; \n\tFri, 24 Nov 2023 04:37:23 -0800 (PST)","To":"libcamera-devel@lists.libcamera.org","Date":"Fri, 24 Nov 2023 12:37:13 +0000","Message-Id":"<20231124123713.22519-8-naush@raspberrypi.com>","X-Mailer":"git-send-email 2.34.1","In-Reply-To":"<20231124123713.22519-1-naush@raspberrypi.com>","References":"<20231124123713.22519-1-naush@raspberrypi.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v3 7/7] documentation: Document vendor\n\tspecific controls and properties handling","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","From":"Naushir Patuck via libcamera-devel\n\t","Reply-To":"Naushir Patuck ","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Add some documentation to the pipeline handler file describing how to\nimplement and handle vendor specific controls and properties with a\nsmall example.\n\nSigned-off-by: Naushir Patuck \nReviewed-by: Laurent Pinchart \n---\n Documentation/guides/pipeline-handler.rst | 48 +++++++++++++++++++++++\n 1 file changed, 48 insertions(+)","diff":"diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\nindex 66d428a19c4f..5a3d00b1b879 100644\n--- a/Documentation/guides/pipeline-handler.rst\n+++ b/Documentation/guides/pipeline-handler.rst\n@@ -672,6 +672,54 @@ handling controls:\n #include \n #include \n \n+Vendor-specific controls and properties\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+Vendor-specific controls and properties must be defined in a separate YAML file\n+and included in the build by defining the pipeline handler to file mapping in\n+include/libcamera/meson.build.\n+\n+For example, adding a Raspberry Pi vendor control file for the PiSP pipeline\n+handler is done with the following mapping:\n+\n+.. code-block:: meson\n+\n+ controls_map = {\n+ 'controls': {\n+ 'draft': 'control_ids_draft.yaml',\n+ 'libcamera': 'control_ids.yaml',\n+ 'rpi/pisp': 'control_ids_rpi.yaml',\n+ },\n+\n+ 'properties': {\n+ 'draft': 'property_ids_draft.yaml',\n+ 'libcamera': 'property_ids.yaml',\n+ }\n+ }\n+\n+Vendor-specific controls and properties must contain a `vendor: `\n+tag in the YAML file. Every unique vendor tag must define a unique and\n+non-overlapping range of reserved control IDs in src/libcamera/control_ranges.yaml.\n+\n+For example, the following block defines a vendor-specific control with the\n+`rpi` vendor tag:\n+\n+.. code-block:: yaml\n+\n+ vendor: rpi\n+ controls:\n+ - PispConfigDumpFile:\n+ type: string\n+ description: |\n+ Triggers the Raspberry Pi PiSP pipeline handler to generate a JSON\n+ formatted dump of the Backend configuration to the filename given by the\n+ value of the control.\n+\n+This controls will be generated in the vendor-specific namespace\n+`libcamera::controls::rpi`. Additionally a `#define\n+LIBCAMERA_HAS_RPI_VENDOR_CONTROLS` will be available to allow applications to\n+test for the availability of these controls.\n+\n Generating a default configuration\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n","prefixes":["libcamera-devel","v3","7/7"]}