From patchwork Sat Mar 13 10:02:18 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Naushir Patuck X-Patchwork-Id: 11572 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id D3569BD1F1 for ; Sat, 13 Mar 2021 10:02:29 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 47E4E605B2; Sat, 13 Mar 2021 11:02:29 +0100 (CET) Authentication-Results: lancelot.ideasonboard.com; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=raspberrypi.com header.i=@raspberrypi.com header.b="t28/uzBS"; dkim-atps=neutral Received: from mail-wm1-x32f.google.com (mail-wm1-x32f.google.com [IPv6:2a00:1450:4864:20::32f]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id CA221602E3 for ; Sat, 13 Mar 2021 11:02:27 +0100 (CET) Received: by mail-wm1-x32f.google.com with SMTP id r10-20020a05600c35cab029010c946c95easo16555960wmq.4 for ; Sat, 13 Mar 2021 02:02:27 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=raspberrypi.com; s=google; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=pLcOs/U6hdvmvqiKyFjlkzc9xuf8WSi8IGrLCbr8YNs=; b=t28/uzBSeks9JuvC/ZDonmyTr227jU3eQ/x8VR2WZQhdoPmv7rAz2mszEZ3+3anQfS OvY6gQoB7zurU8hrv/rn3V9n5BujKVtybw1XcJ7vX7/1IWuSeQ8WzmzRNEhuw9sNoSYT Yodru003fenaqaDV3X+aMou80RFy4uW9HuHBlk/p8688WfDz5LvL0zNkPqVu64QMw8a3 JCC+hLC6Pb6JGNyrHj/RifnU40yxklCirH8Xe8W6w727KV9hqkFHNA0G08hqyV0Zijzo 6LlRq/9qHzsm9QtJI7XR2Qk4j0slGWqqBAq4vLJ+Z5FI76mCiT87u/yQojUxjtDZIwJT ADAw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=pLcOs/U6hdvmvqiKyFjlkzc9xuf8WSi8IGrLCbr8YNs=; b=U6tpHotOrVic51T4uPIP7BaZ4Wq2JfT2Ag8zlCnW+DmanB61Ii4hFz/le2k/m8OZah DX12zKxhwu/QncrKg2D+Pq8Hn/Vp7Y2Ut7hf/8pKH7OcvZKxKQyS2ZEL9ZCTQDVIYXAi sh5Vb7voMKsYVoeyxVBG1vVGtl+SF25wM02pdTbUPDgDF4dQG/nQ/BCg0ekk1kcVpwwk yzX4YEnWGvsTH+RyiQAxqRgGZ89C/mLvffR0UmgbZAWpE1KHpyiH/v96fmI3UWldx44Y JyyYTyQ67TwTSRj/q4W8f2WVokJ71Qmh86vIY9wCqpfslYizfSYk1MZzelom+IuQnw8v vSgQ== X-Gm-Message-State: AOAM5321PwR2Ve7z3NB1Zs4M50lCKGtDOtdYqSlRUJa2j6VgJ/qSUy8E 4x2uLmhxhHjabu1N7a8Ypf9AR4oRItYNkQ== X-Google-Smtp-Source: ABdhPJxhKz9r7Z6NBQlup51UsHxyUmT46l1HA4zZ0z8J8qY+BWPyjVAjI3omyxwkXscx65VocSkL9A== X-Received: by 2002:a7b:c0c4:: with SMTP id s4mr17627337wmh.9.1615629747013; Sat, 13 Mar 2021 02:02:27 -0800 (PST) Received: from naush-laptop.patuck.local ([88.97.76.4]) by smtp.gmail.com with ESMTPSA id c11sm12116333wrm.67.2021.03.13.02.02.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 13 Mar 2021 02:02:26 -0800 (PST) From: Naushir Patuck To: libcamera-devel@lists.libcamera.org Date: Sat, 13 Mar 2021 10:02:18 +0000 Message-Id: <20210313100218.2872534-1-naush@raspberrypi.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH] libcamera: delayed_controls: Add missing documentation for ControlParams X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Document struct DelayedControls::ControlParams and its associated fields. Signed-off-by: Naushir Patuck Reviewed-by: Laurent Pinchart --- src/libcamera/delayed_controls.cpp | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/libcamera/delayed_controls.cpp b/src/libcamera/delayed_controls.cpp index a3917fd99e7a..0f70d087b22c 100644 --- a/src/libcamera/delayed_controls.cpp +++ b/src/libcamera/delayed_controls.cpp @@ -37,6 +37,23 @@ LOG_DEFINE_CATEGORY(DelayedControls) * delay. */ +/** + * \struct DelayedControls::ControlParams + * \brief Parameters associated with controls handled by the \a DelayedControls + * helper class + * + * \var ControlParams::delay + * \brief Frame delay from setting the control on a sensor device to when it is + * consumed during framing. + * + * \var ControlParams::priorityWrite + * \brief Flag to indicate that this control must be applied + * ahead of, and separately from the other controls. Typically set for the \a + * V4L2_CID_VBLANK control so that the device driver does not reject \a + * V4L2_CID_EXPOSURE control values that may be outside of the existing vertical + * blanking specified bounds, but are within the new blanking bounds. + */ + /** * \brief Construct a DelayedControls instance * \param[in] device The V4L2 device the controls have to be applied to