{"id":14889,"url":"https://patchwork.libcamera.org/api/1.1/patches/14889/?format=json","web_url":"https://patchwork.libcamera.org/patch/14889/","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":"<20211130105157.203856-4-hanlinchen@chromium.org>","date":"2021-11-30T10:51:56","name":"[libcamera-devel,v6,3/4] libcamera: camera_lens: Add a new class to model a camera lens","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"6ad8be749843da833c683473d7c1d5435f54cbea","submitter":{"id":98,"url":"https://patchwork.libcamera.org/api/1.1/people/98/?format=json","name":"Hanlin Chen","email":"hanlinchen@chromium.org"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/14889/mbox/","series":[{"id":2782,"url":"https://patchwork.libcamera.org/api/1.1/series/2782/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=2782","date":"2021-11-30T10:51:53","name":"Introduce Lens class and apply auto focus on ipu3","version":6,"mbox":"https://patchwork.libcamera.org/series/2782/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/14889/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/14889/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 F12CFBDB13\n\tfor ;\n\tTue, 30 Nov 2021 10:52:12 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A03D960230;\n\tTue, 30 Nov 2021 11:52:12 +0100 (CET)","from mail-pg1-x535.google.com (mail-pg1-x535.google.com\n\t[IPv6:2607:f8b0:4864:20::535])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 2FA38605B7\n\tfor ;\n\tTue, 30 Nov 2021 11:52:10 +0100 (CET)","by mail-pg1-x535.google.com with SMTP id 71so19346237pgb.4\n\tfor ;\n\tTue, 30 Nov 2021 02:52:10 -0800 (PST)","from localhost ([2401:fa00:1:10:1659:cd3d:a00c:fa38])\n\tby smtp.gmail.com with UTF8SMTPSA id\n\tc6sm22841609pfv.54.2021.11.30.02.52.07\n\t(version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128);\n\tTue, 30 Nov 2021 02:52:08 -0800 (PST)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=chromium.org header.i=@chromium.org\n\theader.b=\"LoxTAlax\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org;\n\ts=google; \n\th=from:to:cc:subject:date:message-id:in-reply-to:references\n\t:mime-version:content-transfer-encoding;\n\tbh=F1vwhP5RgG8QaekroMGG0M2Z8gxjFljzKVlYD09fApc=;\n\tb=LoxTAlaxjHNhnm5nWaJ289i6vE8yQqleIvauts/ZE23Xl9C2gzpBJgOZW0Q0eBYuKH\n\trB8m9K35zGu5RhhvHH0jZKlbaYTZjL+neJ57oUCfDMFskZQJ7xwuU5gI9KUyuaReITiO\n\tE0lcY1ZQD0d550m4dff3nP+7uG4DE5iYC0rJ0=","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20210112;\n\th=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\n\t:references:mime-version:content-transfer-encoding;\n\tbh=F1vwhP5RgG8QaekroMGG0M2Z8gxjFljzKVlYD09fApc=;\n\tb=uhQFREHwHT1x7Vvm0Lyku5B0VnmCQo/LEtWdvB1jwHlWJAaq3054Ge8d6gdgDFBk9R\n\tdk6Lh7Q56XpmPjubEVQE9s4N9mW1raG9Ijgj4iMbONTyXGb9frSoeh/XcgEK5BUri/ml\n\teLov4ykTRPpGaI8Iv3/gG+p5XPNqqSLZRzJAbjSqOtJ/7jdCkXPu2urc8MoicIOPokXr\n\tGuaRY2goVgUpkR3IsPmwgbM0qwn50g5c8vFNQSH2Xb5STIQ5UIhkBBQJKFAj19kLkowq\n\tv0IdFPJGhfFbKq3WRtFAECj0F75jwASO1GK/NYqhT1EF5sjkgSgm0wOg4Tf6hoNQn/cj\n\t+LmA==","X-Gm-Message-State":"AOAM531k9e58JFSe886sG8m9qB/J2kKD29Mg/argrCSbglUTLEPS18Ge\n\t5xuHxKnmhZH6RrkY90GSR+x+aS/f6rBU7A==","X-Google-Smtp-Source":"ABdhPJz4bwlBeTvQ677dLJk6EZD26TJDUXa4Qrcc/nNioridrLGlZrkKjE0yOul4HC5SOArJ1UDZxQ==","X-Received":"by 2002:a05:6a00:14d4:b0:49f:f2ca:e2fc with SMTP id\n\tw20-20020a056a0014d400b0049ff2cae2fcmr44990310pfu.54.1638269528435; \n\tTue, 30 Nov 2021 02:52:08 -0800 (PST)","From":"Han-Lin Chen ","To":"libcamera-devel@lists.libcamera.org","Date":"Tue, 30 Nov 2021 18:51:56 +0800","Message-Id":"<20211130105157.203856-4-hanlinchen@chromium.org>","X-Mailer":"git-send-email 2.34.0.rc2.393.gf8c9666880-goog","In-Reply-To":"<20211130105157.203856-1-hanlinchen@chromium.org>","References":"<20211130105157.203856-1-hanlinchen@chromium.org>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v6 3/4] libcamera: camera_lens: Add a new\n\tclass to model a camera lens","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","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"The CameraLens class abstracts camera lens and provides helper\nfunctions to ease interactions with them.\n\nSigned-off-by: Han-Lin Chen \nReviewed-by: Kieran Bingham \nReviewed-by: Laurent Pinchart \n---\n Documentation/index.rst | 1 +\n Documentation/lens_driver_requirements.rst | 27 ++++\n Documentation/meson.build | 1 +\n include/libcamera/internal/camera_lens.h | 45 +++++++\n include/libcamera/internal/meson.build | 1 +\n src/libcamera/camera_lens.cpp | 142 +++++++++++++++++++++\n src/libcamera/meson.build | 1 +\n 7 files changed, 218 insertions(+)\n create mode 100644 Documentation/lens_driver_requirements.rst\n create mode 100644 include/libcamera/internal/camera_lens.h\n create mode 100644 src/libcamera/camera_lens.cpp","diff":"diff --git a/Documentation/index.rst b/Documentation/index.rst\nindex 1f4fc485..0ee10044 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -21,3 +21,4 @@\n Tracing guide \n Environment variables \n Sensor driver requirements \n+ Lens driver requirements \ndiff --git a/Documentation/lens_driver_requirements.rst b/Documentation/lens_driver_requirements.rst\nnew file mode 100644\nindex 00000000..b96e502d\n--- /dev/null\n+++ b/Documentation/lens_driver_requirements.rst\n@@ -0,0 +1,27 @@\n+.. SPDX-License-Identifier: CC-BY-SA-4.0\n+\n+.. _lens-driver-requirements:\n+\n+Lens Driver Requirements\n+========================\n+\n+libcamera handles lens devices in the CameraLens class and defines\n+a consistent interface through its API towards other library components.\n+\n+The CameraLens class uses the V4L2 subdev kernel API to interface with the\n+camera lens through a sub-device exposed to userspace by the lens driver.\n+\n+In order for libcamera to be fully operational and provide all the required\n+information to interface with the camera lens to applications and pipeline\n+handlers, a set of mandatory features the driver has to support has been defined.\n+\n+Mandatory Requirements\n+----------------------\n+\n+The lens driver is assumed to be fully compliant with the V4L2 specification.\n+\n+The lens driver shall support the following V4L2 controls:\n+\n+* `V4L2_CID_FOCUS_ABSOLUTE`_\n+\n+.. _V4L2_CID_FOCUS_ABSOLUTE: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/ext-ctrls-camera.html\ndiff --git a/Documentation/meson.build b/Documentation/meson.build\nindex 4c972675..33af82aa 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -66,6 +66,7 @@ if sphinx.found()\n 'guides/pipeline-handler.rst',\n 'guides/tracing.rst',\n 'index.rst',\n+ 'lens_driver_requirements.rst',\n 'sensor_driver_requirements.rst',\n '../README.rst',\n ]\ndiff --git a/include/libcamera/internal/camera_lens.h b/include/libcamera/internal/camera_lens.h\nnew file mode 100644\nindex 00000000..6f2ea1bc\n--- /dev/null\n+++ b/include/libcamera/internal/camera_lens.h\n@@ -0,0 +1,45 @@\n+/* SPDX-License-Identifier: LGPL-2.1-or-later */\n+/*\n+ * Copyright (C) 2021, Google Inc.\n+ *\n+ * camera_lens.h - A camera lens controller\n+ */\n+#pragma once\n+\n+#include \n+#include \n+\n+#include \n+#include \n+\n+namespace libcamera {\n+\n+class MediaEntity;\n+class V4L2Subdevice;\n+\n+class CameraLens : protected Loggable\n+{\n+public:\n+\texplicit CameraLens(const MediaEntity *entity);\n+\t~CameraLens();\n+\n+\tint init();\n+\tint setFocusPostion(int32_t position);\n+\n+\tconst std::string &model() const { return model_; }\n+\n+protected:\n+\tstd::string logPrefix() const override;\n+\n+private:\n+\tLIBCAMERA_DISABLE_COPY_AND_MOVE(CameraLens)\n+\n+\tint validateLensDriver();\n+\n+\tconst MediaEntity *entity_;\n+\tstd::unique_ptr subdev_;\n+\n+\tstd::string model_;\n+};\n+\n+} /* namespace libcamera */\ndiff --git a/include/libcamera/internal/meson.build b/include/libcamera/internal/meson.build\nindex 665fd6de..a96bbb95 100644\n--- a/include/libcamera/internal/meson.build\n+++ b/include/libcamera/internal/meson.build\n@@ -14,6 +14,7 @@ libcamera_internal_headers = files([\n 'byte_stream_buffer.h',\n 'camera.h',\n 'camera_controls.h',\n+ 'camera_lens.h',\n 'camera_sensor.h',\n 'camera_sensor_properties.h',\n 'control_serializer.h',\ndiff --git a/src/libcamera/camera_lens.cpp b/src/libcamera/camera_lens.cpp\nnew file mode 100644\nindex 00000000..189cb025\n--- /dev/null\n+++ b/src/libcamera/camera_lens.cpp\n@@ -0,0 +1,142 @@\n+/* SPDX-License-Identifier: LGPL-2.1-or-later */\n+/*\n+ * Copyright (C) 2021, Google Inc.\n+ *\n+ * camera_lens.cpp - A camera lens\n+ */\n+\n+#include \"libcamera/internal/camera_lens.h\"\n+\n+#include \n+\n+#include \"libcamera/internal/v4l2_subdevice.h\"\n+\n+/**\n+ * \\file camera_lens.h\n+ * \\brief A camera lens controller\n+ */\n+\n+namespace libcamera {\n+\n+LOG_DEFINE_CATEGORY(CameraLens)\n+\n+/**\n+ * \\class CameraLens\n+ * \\brief A camera lens based on V4L2 subdevices\n+ *\n+ * The CameraLens class eases handling of lens for pipeline handlers by\n+ * hiding the details of the V4L2 subdevice kernel API and caching lens\n+ * information.\n+ */\n+\n+/**\n+ * \\brief Construct a CameraLens\n+ * \\param[in] entity The media entity backing the camera lens controller\n+ *\n+ * Once constructed the instance must be initialized with init().\n+ */\n+CameraLens::CameraLens(const MediaEntity *entity)\n+\t: entity_(entity)\n+{\n+}\n+\n+/**\n+ * \\brief Destroy a CameraLens\n+ */\n+CameraLens::~CameraLens() = default;\n+\n+/**\n+ * \\brief Initialize the camera lens instance\n+ *\n+ * This function performs the initialisation steps of the CameraLens that may\n+ * fail. It shall be called once and only once after constructing the instance.\n+ *\n+ * \\return 0 on success or a negative error code otherwise\n+ */\n+int CameraLens::init()\n+{\n+\tif (entity_->function() != MEDIA_ENT_F_LENS) {\n+\t\tLOG(CameraLens, Error)\n+\t\t\t<< \"Invalid lens function \"\n+\t\t\t<< utils::hex(entity_->function());\n+\t\treturn -EINVAL;\n+\t}\n+\n+\t/* Create and open the subdev. */\n+\tsubdev_ = std::make_unique(entity_);\n+\tint ret = subdev_->open();\n+\tif (ret < 0)\n+\t\treturn ret;\n+\n+\tret = validateLensDriver();\n+\tif (ret)\n+\t\treturn ret;\n+\n+\tmodel_ = subdev_->model();\n+\treturn 0;\n+}\n+\n+/**\n+ * \\brief This function sets the focal point of the lens to a specific position.\n+ * \\param[in] position The focal point of the lens\n+ *\n+ * This function sets the value of focal point of the lens as in \\a position.\n+ *\n+ * \\return 0 on success or -EINVAL otherwise\n+ */\n+int CameraLens::setFocusPostion(int32_t position)\n+{\n+\tControlList lensCtrls(subdev_->controls());\n+\tlensCtrls.set(V4L2_CID_FOCUS_ABSOLUTE, static_cast(position));\n+\n+\tif (subdev_->setControls(&lensCtrls))\n+\t\treturn -EINVAL;\n+\n+\treturn 0;\n+}\n+\n+int CameraLens::validateLensDriver()\n+{\n+\tint ret = 0;\n+\tstatic constexpr uint32_t mandatoryControls[] = {\n+\t\tV4L2_CID_FOCUS_ABSOLUTE,\n+\t};\n+\n+\tconst ControlInfoMap &controls = subdev_->controls();\n+\tfor (uint32_t ctrl : mandatoryControls) {\n+\t\tif (!controls.count(ctrl)) {\n+\t\t\tLOG(CameraLens, Error)\n+\t\t\t\t<< \"Mandatory V4L2 control \" << utils::hex(ctrl)\n+\t\t\t\t<< \" not available\";\n+\t\t\tret = -EINVAL;\n+\t\t}\n+\t}\n+\n+\tif (ret) {\n+\t\tLOG(CameraLens, Error)\n+\t\t\t<< \"The lens kernel driver needs to be fixed\";\n+\t\tLOG(CameraLens, Error)\n+\t\t\t<< \"See Documentation/lens_driver_requirements.rst in\"\n+\t\t\t<< \" the libcamera sources for more information\";\n+\t\treturn ret;\n+\t}\n+\n+\treturn ret;\n+}\n+\n+/**\n+ * \\fn CameraLens::model()\n+ * \\brief Retrieve the lens model name\n+ *\n+ * The lens model name is a free-formed string that uniquely identifies the\n+ * lens model.\n+ *\n+ * \\return The lens model name\n+ */\n+\n+std::string CameraLens::logPrefix() const\n+{\n+\treturn \"'\" + entity_->name() + \"'\";\n+}\n+\n+} /* namespace libcamera */\ndiff --git a/src/libcamera/meson.build b/src/libcamera/meson.build\nindex 6727a777..3bee8fee 100644\n--- a/src/libcamera/meson.build\n+++ b/src/libcamera/meson.build\n@@ -5,6 +5,7 @@ libcamera_sources = files([\n 'byte_stream_buffer.cpp',\n 'camera.cpp',\n 'camera_controls.cpp',\n+ 'camera_lens.cpp',\n 'camera_manager.cpp',\n 'camera_sensor.cpp',\n 'camera_sensor_properties.cpp',\n","prefixes":["libcamera-devel","v6","3/4"]}