media/v4l/ext-ctrls-flash.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
3 .. _flash-controls:
17 .. _flash-controls-use-cases:
24 ------------------------------------------
35 ----------------------------------------
37 The synchronised LED flash is pre-programmed by the host (power and
46 ------------------
52 .. _flash-control-id:
55 -----------------
61     Defines the mode of the flash LED, the high-power white LED attached
68 .. flat-table::
69     :header-rows:  0
70     :stub-columns: 0
72     * - ``V4L2_FLASH_LED_MODE_NONE``
73       - Off.
74     * - ``V4L2_FLASH_LED_MODE_FLASH``
75       - Flash mode.
76     * - ``V4L2_FLASH_LED_MODE_TORCH``
77       - Torch mode.
88 .. flat-table::
89     :header-rows:  0
90     :stub-columns: 0
92     * - ``V4L2_FLASH_STROBE_SOURCE_SOFTWARE``
93       - The flash strobe is triggered by using the
95     * - ``V4L2_FLASH_STROBE_SOURCE_EXTERNAL``
96       - The flash strobe is triggered by an external source. Typically
114     This is a read-only control.
147 .. flat-table::
148     :header-rows:  0
149     :stub-columns: 0
151     * - ``V4L2_FLASH_FAULT_OVER_VOLTAGE``
152       - Flash controller voltage to the flash LED has exceeded the limit
154     * - ``V4L2_FLASH_FAULT_TIMEOUT``
155       - The flash strobe was still on when the timeout set by the user ---
156 	V4L2_CID_FLASH_TIMEOUT control --- has expired. Not all flash
158     * - ``V4L2_FLASH_FAULT_OVER_TEMPERATURE``
159       - The flash controller has overheated.
160     * - ``V4L2_FLASH_FAULT_SHORT_CIRCUIT``
161       - The short circuit protection of the flash controller has been
163     * - ``V4L2_FLASH_FAULT_OVER_CURRENT``
164       - Current in the LED power supply has exceeded the limit specific to
166     * - ``V4L2_FLASH_FAULT_INDICATOR``
167       - The flash controller has detected a short or open circuit
169     * - ``V4L2_FLASH_FAULT_UNDER_VOLTAGE``
170       - Flash controller voltage to the flash LED has been below the
172     * - ``V4L2_FLASH_FAULT_INPUT_VOLTAGE``
173       - The input voltage of the flash controller is below the limit under
176     * - ``V4L2_FLASH_FAULT_LED_OVER_TEMPERATURE``
177       - The temperature of the LED has exceeded its allowed upper limit.
188     is a read-only control.