Patch Detail
Show a patch.
GET /api/patches/19499/?format=api
{ "id": 19499, "url": "https://patchwork.libcamera.org/api/patches/19499/?format=api", "web_url": "https://patchwork.libcamera.org/patch/19499/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/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": "<20240214170122.60754-17-hdegoede@redhat.com>", "date": "2024-02-14T17:01:20", "name": "[v3,16/16] libcamera: Add \"Software ISP benchmarking\" documentation", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "8ab4a528aa20990bd6f1dfa833f7e0fb56f516e6", "submitter": { "id": 102, "url": "https://patchwork.libcamera.org/api/people/102/?format=api", "name": "Hans de Goede", "email": "hdegoede@redhat.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/19499/mbox/", "series": [ { "id": 4167, "url": "https://patchwork.libcamera.org/api/series/4167/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4167", "date": "2024-02-14T17:01:04", "name": "libcamera: introduce Software ISP and Software IPA", "version": 3, "mbox": "https://patchwork.libcamera.org/series/4167/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/19499/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/19499/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 23AAEC3257\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 14 Feb 2024 17:02:00 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C1E4762835;\n\tWed, 14 Feb 2024 18:01:59 +0100 (CET)", "from us-smtp-delivery-124.mimecast.com\n\t(us-smtp-delivery-124.mimecast.com [170.10.133.124])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 18D656282A\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 14 Feb 2024 18:01:56 +0100 (CET)", "from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73])\n\tby relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n\tcipher=TLS_AES_256_GCM_SHA384) id us-mta-196-FrqZqsX9OkyCTxC9hpLwqQ-1;\n\tWed, 14 Feb 2024 12:01:54 -0500", "from smtp.corp.redhat.com\n\t(int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6])\n\t(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n\tkey-exchange X25519 server-signature RSA-PSS (2048 bits)\n\tserver-digest SHA256) (No client certificate requested)\n\tby mimecast-mx02.redhat.com (Postfix) with ESMTPS id A9F383C2E0A7;\n\tWed, 14 Feb 2024 17:01:53 +0000 (UTC)", "from localhost.localdomain (unknown [10.39.192.30])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id B3EE82166B4F;\n\tWed, 14 Feb 2024 17:01:52 +0000 (UTC)" ], "Authentication-Results": "lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=redhat.com header.i=@redhat.com\n\theader.b=\"E3TH1AQn\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1707930115;\n\th=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n\tto:to:cc:cc:mime-version:mime-version:content-type:content-type:\n\tcontent-transfer-encoding:content-transfer-encoding:\n\tin-reply-to:in-reply-to:references:references;\n\tbh=5FVTTXT+Nr8wVc+KKshWjni7ir6OmtoGsdsyN/dgIHU=;\n\tb=E3TH1AQnmF59vs9N4WWBvroF7NM80sH8C83p23j9yb6GDiHGT+CQet+FK8xb7CwUH/QDvu\n\tskAD7wvkn8GpdvYwMTs2BRW5cUDjUKavQUxZNSZxQqgMC98OvGOsR4qo/C+0hZ7pGDLvqf\n\ts6lv1WiEPhqKINmRhpnIrHp8Nr/+EIM=", "X-MC-Unique": "FrqZqsX9OkyCTxC9hpLwqQ-1", "From": "Hans de Goede <hdegoede@redhat.com>", "To": "libcamera-devel@lists.libcamera.org", "Subject": "[PATCH v3 16/16] libcamera: Add \"Software ISP benchmarking\"\n\tdocumentation", "Date": "Wed, 14 Feb 2024 18:01:20 +0100", "Message-ID": "<20240214170122.60754-17-hdegoede@redhat.com>", "In-Reply-To": "<20240214170122.60754-1-hdegoede@redhat.com>", "References": "<20240214170122.60754-1-hdegoede@redhat.com>", "MIME-Version": "1.0", "X-Scanned-By": "MIMEDefang 3.4.1 on 10.11.54.6", "X-Mimecast-Spam-Score": "0", "X-Mimecast-Originator": "redhat.com", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "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>", "Cc": "Maxime Ripard <mripard@redhat.com>, Pavel Machek <pavel@ucw.cz>,\n\tBryan O'Donoghue <bryan.odonoghue@linaro.org>", "Errors-To": "libcamera-devel-bounces@lists.libcamera.org", "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>" }, "content": "Add a \"Software ISP benchmarking\" documentation section which describes\nthe performance/power consumption measurements used during\nthe Software ISP's development.\n\nSigned-off-by: Hans de Goede <hdegoede@redhat.com>\n---\n Documentation/index.rst | 1 +\n Documentation/meson.build | 1 +\n Documentation/software-isp-benchmarking.rst | 82 +++++++++++++++++++++\n 3 files changed, 84 insertions(+)\n create mode 100644 Documentation/software-isp-benchmarking.rst", "diff": "diff --git a/Documentation/index.rst b/Documentation/index.rst\nindex 63fac72d..5442ae75 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -24,3 +24,4 @@\n Lens driver requirements <lens_driver_requirements>\n Python Bindings <python-bindings>\n Camera Sensor Model <camera-sensor-model>\n+ SoftwareISP Benchmarking <software-isp-benchmarking>\ndiff --git a/Documentation/meson.build b/Documentation/meson.build\nindex 7a58fec8..3872e0a8 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -80,6 +80,7 @@ if sphinx.found()\n 'lens_driver_requirements.rst',\n 'python-bindings.rst',\n 'sensor_driver_requirements.rst',\n+ 'software-isp-benchmarking.rst',\n '../README.rst',\n ]\n \ndiff --git a/Documentation/software-isp-benchmarking.rst b/Documentation/software-isp-benchmarking.rst\nnew file mode 100644\nindex 00000000..321db138\n--- /dev/null\n+++ b/Documentation/software-isp-benchmarking.rst\n@@ -0,0 +1,82 @@\n+.. SPDX-License-Identifier: CC-BY-SA-4.0\n+\n+.. _software-isp-benchmarking:\n+\n+Software ISP benchmarking\n+=========================\n+\n+The Software ISP is particularly sensitive to performance regressions\n+therefore it is a good idea to always benchmark the Software ISP\n+before and after making changes to it and ensure that there are\n+no performance regressions.\n+\n+DebayerCpu class builtin benchmark\n+----------------------------------\n+\n+The DebayerCpu class has a builtin benchmark. This benchmark\n+measures the time spend on processing (collecting statistics\n+and debayering) only, it does not measure the time spent on\n+capturing or outputting the frames.\n+\n+The builtin benchmark always runs. So this can be used by simply\n+running \"cam\" or \"qcam\" with a pipeline using the Software ISP.\n+\n+When it runs it will skip measuring the first 30 frames to\n+allow the caches and the CPU temperature (turbo-ing) to warm-up\n+and then it measures 30 fps and shows the total and per frame\n+processing time using an info level log message:\n+\n+.. code-block::\n+\n+ INFO Debayer debayer_cpu.cpp:907 Processed 30 frames in 244317us, 8143 us/frame\n+\n+To get stable measurements it is advised to disable any other processes which\n+may cause significant CPU usage (e.g. disable wifi, bluetooth and browsers).\n+When possible it is also advisable to disable CPU turbo-ing and\n+frequency-scaling.\n+\n+For example when benchmarking on a Lenovo ThinkPad X1 Yoga Gen 8, with\n+the charger plugged in, the CPU can be fixed to run at 2 GHz using:\n+\n+.. code-block::\n+\n+ sudo x86_energy_perf_policy --turbo-enable 0\n+ sudo cpupower frequency-set -d 2GHz -u 2GHz\n+\n+with these settings the builtin bench reports a processing time of ~7.8ms/frame\n+on this laptop for FHD SGRBG10 (unpacked) bayer data.\n+\n+Measuring power consumption\n+---------------------------\n+\n+Since the Software ISP is often used on mobile devices it is also\n+important to measure power consumption and ensure that that does\n+not regress.\n+\n+For example to measure power consumption on a Lenovo ThinkPad X1 Yoga Gen 8\n+it needs to be running on battery and it should be configured with its\n+platform-profile (/sys/firmware/acpi/platform_profile) set to balanced and\n+with its default turbo and frequency-scaling behavior to match real world usage.\n+\n+Then start qcam to capture a FHD picture at 30 fps and position the qcam window\n+so that it is fully visible. After this run the following command to monitor\n+the power consumption:\n+\n+.. code-block::\n+\n+ watch -n 10 cat /sys/class/power_supply/BAT0/power_now /sys/class/hwmon/hwmon6/fan?_input\n+\n+Note this not only measures the power consumption in ųW it also monitors\n+the speed of this laptop's 2 fans. This is important because depending on\n+the ambient temperature the 2 fans may spin up while testing and this\n+will cause an additional power consumption of approx. 0.5W messing up\n+the measurement.\n+\n+After starting qcam + the watch command let the laptop sit without using\n+it for 2 minutes for the readings to stabilize. Then check that the fans\n+have not turned on and manually take a couple of consecutive power readings\n+and avarage these.\n+\n+On the example Lenovo ThinkPad X1 Yoga Gen 8 laptop this results in\n+a measured power consumption of approx. 13W while running qcam versus\n+approx. 4-5W while setting idle with its OLED panel on.\n", "prefixes": [ "v3", "16/16" ] }