Patch Detail
Show a patch.
GET /api/1.1/patches/19221/?format=api
{ "id": 19221, "url": "https://patchwork.libcamera.org/api/1.1/patches/19221/?format=api", "web_url": "https://patchwork.libcamera.org/patch/19221/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20231121145350.5956-7-naush@raspberrypi.com>", "date": "2023-11-21T14:53:50", "name": "[libcamera-devel,v2,6/6] documentation: Document vendor specific control and properties handling", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "d5239834a4545f9f8ca67603b0057fc871530c2b", "submitter": { "id": 34, "url": "https://patchwork.libcamera.org/api/1.1/people/34/?format=api", "name": "Naushir Patuck", "email": "naush@raspberrypi.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/19221/mbox/", "series": [ { "id": 4077, "url": "https://patchwork.libcamera.org/api/1.1/series/4077/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4077", "date": "2023-11-21T14:53:44", "name": "Vendor controls and properties", "version": 2, "mbox": "https://patchwork.libcamera.org/series/4077/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/19221/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/19221/checks/", "tags": {}, "headers": { "Return-Path": "<libcamera-devel-bounces@lists.libcamera.org>", "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 9CB62C328F\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 21 Nov 2023 14:54:06 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 48A2B629C6;\n\tTue, 21 Nov 2023 15:54:06 +0100 (CET)", "from mail-wm1-x332.google.com (mail-wm1-x332.google.com\n\t[IPv6:2a00:1450:4864:20::332])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 56487629C7\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 21 Nov 2023 15:54:04 +0100 (CET)", "by mail-wm1-x332.google.com with SMTP id\n\t5b1f17b1804b1-4084b0223ccso26071715e9.2\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 21 Nov 2023 06:54:04 -0800 (PST)", "from localhost.localdomain ([93.93.133.154])\n\tby smtp.gmail.com with ESMTPSA id\n\th18-20020a05600c351200b004063ea92492sm17570968wmq.22.2023.11.21.06.54.01\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tTue, 21 Nov 2023 06:54:02 -0800 (PST)" ], "DKIM-Signature": [ "v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1700578446;\n\tbh=VCa2KmEboVJanCSpihCW3DXtXj0h/UBsipooWVda5uA=;\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=uDD1f2omAEld30O76lq12o4fCgyqJqm+9AMNq4qPe39U3YJ3MfqeyJQ073VaT1/8o\n\tlE+42i0y0l0XY9QXu6c3eAv90VvcIekIbGnoFXmgakmaTcC/gR/t79mOsfCtfaqDy8\n\tvbSumPAI1FmP5kjG8Atsu0bkmSAHW4UqjHxfCl1RQ3gla8qrwmfMVCEO3nIg7LcT6T\n\tMpUH8axQPVNbkNVgqeXW5O37mVRtq/z5PkklTWpEx4JJE3wyCs2PUoujXo732GEtNY\n\toZ6Z9JnIYWkG6Eg6zKbNCAMfnCzLZ2knn0x6RRC4wMO+9x16MQ7Bqgn3usp8MfEJWZ\n\t+hwtmFDbShE1w==", "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=raspberrypi.com; s=google; t=1700578443; x=1701183243;\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=c6L1W2HLRfk9Spk6pPsjQsBwMqr3C4mCLeQWt4Cm0dw=;\n\tb=RHDdelsNgeGnsmXmu2LW+LO+FelKDn9GFjHSRvc4JrVOu+IG8+1uG+5ratg3kT6ncF\n\tyAx5hNc8YlAtu5vyQKnvifcOkC+7QSLv4z2L7ZX4Js5W8NeslXCGVuHWhuXOssBHBubw\n\txB+euny02xzMv7+Hp4krw612baxBeX+/h4v5asnn3uB1Rb5VwR3ti91ep8Qap00blyep\n\tKE3bZtRkKxiPzgoRonv3HDZyyPN00CW8a2EjD0VOsCFEKUPzhHi3m7+hkMUJnXW3N5lq\n\twpt/eCotnC4qgK2GSA3kTVGhTILqW6MtAtEuYQJN2wAsAPGpkH+ej2ZSK3Oep4D2R/70\n\t2aKw==" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (2048-bit key; \n\tunprotected) header.d=raspberrypi.com\n\theader.i=@raspberrypi.com\n\theader.b=\"RHDdelsN\"; dkim-atps=neutral", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20230601; t=1700578443; x=1701183243;\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=c6L1W2HLRfk9Spk6pPsjQsBwMqr3C4mCLeQWt4Cm0dw=;\n\tb=ZQV2YcepwiZd6PoitejhS9/uY5jK+cqivPgt9n2d+QVgPcDla0eMZg2zy9Q029UyAN\n\t1avECvwEjxbC+8Wbz6NPH/IiLahXCB8/OC4Brd95sLz3q0Ca+XCIChPl6JqDUGu+gzwn\n\tSStKK8hfb76YZNSPvz4hmzsM2qy5H0G7mzIUqGXOaiSKrlFUPitj1NHS1Nxk937Pe/Ad\n\tbIu0PIA66K4g6I2btOBLL0MW0v/ul74hgmUZmNb5aq2XRp28GkIqJxXUiFGkN7ZPAWDU\n\thLxBT4M5bcqfW5DtkJ7L0lXi0kV9O37NKsM7/UZ8mYnJZK4F2Qd6bQrl7ANfWqiIl/eW\n\tmHGw==", "X-Gm-Message-State": "AOJu0YxUpijKlvUBkIoXRYy4SumQqEslAejyWLwXaDKuKxrstBRjhclk\n\tRDxoIu6Igl221a3gwacPW35HPf4TS2Zg6nA6qHzvYg==", "X-Google-Smtp-Source": "AGHT+IEpbXnb4sDiusV2bk3QMZvVJbu52VklRBmtiTNzi7qKZSaO1n26InngkKAvaVtxH7zYHAsPdA==", "X-Received": "by 2002:a05:600c:19cc:b0:406:f832:6513 with SMTP id\n\tu12-20020a05600c19cc00b00406f8326513mr8107884wmq.3.1700578443600; \n\tTue, 21 Nov 2023 06:54:03 -0800 (PST)", "To": "libcamera-devel@lists.libcamera.org", "Date": "Tue, 21 Nov 2023 14:53:50 +0000", "Message-Id": "<20231121145350.5956-7-naush@raspberrypi.com>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20231121145350.5956-1-naush@raspberrypi.com>", "References": "<20231121145350.5956-1-naush@raspberrypi.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH v2 6/6] documentation: Document vendor\n\tspecific control and properties handling", "X-BeenThere": "libcamera-devel@lists.libcamera.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "<libcamera-devel.lists.libcamera.org>", "List-Unsubscribe": "<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>", "List-Archive": "<https://lists.libcamera.org/pipermail/libcamera-devel/>", "List-Post": "<mailto:libcamera-devel@lists.libcamera.org>", "List-Help": "<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>", "List-Subscribe": "<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>", "From": "Naushir Patuck via libcamera-devel\n\t<libcamera-devel@lists.libcamera.org>", "Reply-To": "Naushir Patuck <naush@raspberrypi.com>", "Errors-To": "libcamera-devel-bounces@lists.libcamera.org", "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>" }, "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 <naush@raspberrypi.com>\n---\n Documentation/guides/pipeline-handler.rst | 52 +++++++++++++++++++++++\n 1 file changed, 52 insertions(+)", "diff": "diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\nindex 10b9c75c2a7f..26977164accf 100644\n--- a/Documentation/guides/pipeline-handler.rst\n+++ b/Documentation/guides/pipeline-handler.rst\n@@ -672,6 +672,58 @@ handling controls:\n #include <libcamera/controls.h>\n #include <libcamera/control_ids.h>\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+ vendor_controls_mapping = {\n+ # Mapping of vendor (pipeline handler) specific controls files\n+ 'controls':\n+ {\n+ 'rpi/pisp': 'control_ids_rpi.yaml',\n+ },\n+ # Mapping of vendor (pipeline handler) specific properties files\n+ 'properties':\n+ {\n+\n+ }\n+ }\n+\n+Vendor-specific controls and properties must contain a `vendor: <vendor_string>`\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+\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+Note that libcamera core controls are defined with the `vendor: libcamera` tag\n+and libcamera draft controls are defined with the `vendor: draft` tag.\n+\n Generating a default configuration\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n", "prefixes": [ "libcamera-devel", "v2", "6/6" ] }