[v5,5/5] Documentation/runtime_configuration: Add missing software_isp.mode doc
diff mbox series

Message ID 20260304075052.11599-6-johannes.goede@oss.qualcomm.com
State New
Headers show
Series
  • software_isp: debayer_cpu: Add multi-threading support
Related show

Commit Message

Hans de Goede March 4, 2026, 7:50 a.m. UTC
The software_isp.mode setting was missing from the runtime_configuration
documentation, add it.

Signed-off-by: Hans de Goede <johannes.goede@oss.qualcomm.com>
---
Changes in v5:
- New patch in v5 of this series
---
 Documentation/runtime_configuration.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Milan Zamazal March 4, 2026, 9:59 a.m. UTC | #1
Hi Hans,

thank you for adding the doc.

Hans de Goede <johannes.goede@oss.qualcomm.com> writes:

> The software_isp.mode setting was missing from the runtime_configuration
> documentation, add it.
>
> Signed-off-by: Hans de Goede <johannes.goede@oss.qualcomm.com>
> ---
> Changes in v5:
> - New patch in v5 of this series
> ---
>  Documentation/runtime_configuration.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
>
> diff --git a/Documentation/runtime_configuration.rst b/Documentation/runtime_configuration.rst
> index 651929a4d..e34321ee0 100644
> --- a/Documentation/runtime_configuration.rst
> +++ b/Documentation/runtime_configuration.rst
> @@ -51,6 +51,7 @@ file structure:
>        measure:
>          skip: # non-negative integer, frames to skip initially
>          number: # non-negative integer, frames to measure
> +      mode: # cpu/gpu
>        threads: # integer >= 1, number of render threads to use, default 2
>  
>  Configuration file example
> @@ -85,6 +86,7 @@ Configuration file example
>         measure:
>           skip: 50
>           number: 30
> +       mode: gpu
>         threads: 2
>  
>  List of variables and configuration options
> @@ -169,6 +171,16 @@ software_isp.measure.skip, software_isp.measure.number
>  
>     Example `number` value: ``30``
>  
> +software_isp.mode
> +   Select if the software ISP should use GPU or CPU image processsing,
> +   one of ``cpu`` or ``gpu``. When set to ``gpu`` and EGL is not available
> +   the software ISP will automatically fall back to the CPU.
> +
> +   This can be overridden through the ``LIBCAMERA_SOFTISP_MODE`` environment
> +   variable.

For consistency with the other items here, the item title should be

  LIBCAMERA_SOFTISP_MODE, software_isp.mode

rather than having this extra paragraph about the environment variable.

With that change:

Reviewed-by: Milan Zamazal <mzamazal@redhat.com>

(I believe this can be applied by the maintainers without a need to post
a new version if no further changes are requested.)

> +
> +   Example value: ``gpu``
> +
>  software_isp.threads
>     Number of render threads the software ISP uses when using the CPU.
>     This must be between 1 and 8 and the default is 2.
Hans de Goede March 4, 2026, 11 a.m. UTC | #2
Hi,

On 4-Mar-26 10:59 AM, Milan Zamazal wrote:
> Hi Hans,
> 
> thank you for adding the doc.
> 
> Hans de Goede <johannes.goede@oss.qualcomm.com> writes:
> 
>> The software_isp.mode setting was missing from the runtime_configuration
>> documentation, add it.
>>
>> Signed-off-by: Hans de Goede <johannes.goede@oss.qualcomm.com>
>> ---
>> Changes in v5:
>> - New patch in v5 of this series
>> ---
>>  Documentation/runtime_configuration.rst | 12 ++++++++++++
>>  1 file changed, 12 insertions(+)
>>
>> diff --git a/Documentation/runtime_configuration.rst b/Documentation/runtime_configuration.rst
>> index 651929a4d..e34321ee0 100644
>> --- a/Documentation/runtime_configuration.rst
>> +++ b/Documentation/runtime_configuration.rst
>> @@ -51,6 +51,7 @@ file structure:
>>        measure:
>>          skip: # non-negative integer, frames to skip initially
>>          number: # non-negative integer, frames to measure
>> +      mode: # cpu/gpu
>>        threads: # integer >= 1, number of render threads to use, default 2
>>  
>>  Configuration file example
>> @@ -85,6 +86,7 @@ Configuration file example
>>         measure:
>>           skip: 50
>>           number: 30
>> +       mode: gpu
>>         threads: 2
>>  
>>  List of variables and configuration options
>> @@ -169,6 +171,16 @@ software_isp.measure.skip, software_isp.measure.number
>>  
>>     Example `number` value: ``30``
>>  
>> +software_isp.mode
>> +   Select if the software ISP should use GPU or CPU image processsing,
>> +   one of ``cpu`` or ``gpu``. When set to ``gpu`` and EGL is not available
>> +   the software ISP will automatically fall back to the CPU.
>> +
>> +   This can be overridden through the ``LIBCAMERA_SOFTISP_MODE`` environment
>> +   variable.
> 
> For consistency with the other items here, the item title should be
> 
>   LIBCAMERA_SOFTISP_MODE, software_isp.mode
> 
> rather than having this extra paragraph about the environment variable.

Ok, that sounds good.
> 
> With that change:
> 
> Reviewed-by: Milan Zamazal <mzamazal@redhat.com>

Thank you; and nice benchmark results with the multi-thread patches
on your TI AM69 environment. Good to know that it scales that well
with more powereful CPU cores.

> (I believe this can be applied by the maintainers without a need to post
> a new version if no further changes are requested.)

Changing this also changes where it should be in the file, all the other
options which also have an environment setting are grouped together
at the top, so this needs to move to there now. I'll send a v6
of just this patch with your suggested change + moving this together
with the docs for the other environment options.

Regards,

Hans






> 
>> +
>> +   Example value: ``gpu``
>> +
>>  software_isp.threads
>>     Number of render threads the software ISP uses when using the CPU.
>>     This must be between 1 and 8 and the default is 2.
>

Patch
diff mbox series

diff --git a/Documentation/runtime_configuration.rst b/Documentation/runtime_configuration.rst
index 651929a4d..e34321ee0 100644
--- a/Documentation/runtime_configuration.rst
+++ b/Documentation/runtime_configuration.rst
@@ -51,6 +51,7 @@  file structure:
       measure:
         skip: # non-negative integer, frames to skip initially
         number: # non-negative integer, frames to measure
+      mode: # cpu/gpu
       threads: # integer >= 1, number of render threads to use, default 2
 
 Configuration file example
@@ -85,6 +86,7 @@  Configuration file example
        measure:
          skip: 50
          number: 30
+       mode: gpu
        threads: 2
 
 List of variables and configuration options
@@ -169,6 +171,16 @@  software_isp.measure.skip, software_isp.measure.number
 
    Example `number` value: ``30``
 
+software_isp.mode
+   Select if the software ISP should use GPU or CPU image processsing,
+   one of ``cpu`` or ``gpu``. When set to ``gpu`` and EGL is not available
+   the software ISP will automatically fall back to the CPU.
+
+   This can be overridden through the ``LIBCAMERA_SOFTISP_MODE`` environment
+   variable.
+
+   Example value: ``gpu``
+
 software_isp.threads
    Number of render threads the software ISP uses when using the CPU.
    This must be between 1 and 8 and the default is 2.