Lines Matching +full:flash +full:- +full:mode
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
3 .. _flash-controls:
6 Flash Control Reference
9 The V4L2 flash controls are intended to provide generic access to flash
10 controller devices. Flash controller devices are typically used in
13 The interface can support both LED and xenon flash devices. As of
14 writing this, there is no xenon flash driver using this interface.
17 .. _flash-controls-use-cases:
23 Unsynchronised LED flash (software strobe)
24 ------------------------------------------
26 Unsynchronised LED flash is controlled directly by the host as the
27 sensor. The flash must be enabled by the host before the exposure of the
29 for the timing of the flash.
34 Synchronised LED flash (hardware strobe)
35 ----------------------------------------
37 The synchronised LED flash is pre-programmed by the host (power and
39 sensor to the flash.
41 The sensor controls the flash duration and timing. This information
45 LED flash as torch
46 ------------------
48 LED flash may be used as torch in conjunction with another use case
52 .. _flash-control-id:
54 Flash Control IDs
55 -----------------
58 The FLASH class descriptor.
61 Defines the mode of the flash LED, the high-power white LED attached
62 to the flash controller. Setting this control may not be possible in
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.
84 Defines the source of the flash LED strobe.
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
98 flash strobe start to exposure start.
103 Strobe flash. Valid when V4L2_CID_FLASH_LED_MODE is set to
110 Stop flash strobe immediately.
113 Strobe status: whether the flash is strobing at the moment or not.
114 This is a read-only control.
117 Hardware timeout for flash. The flash strobe is stopped after this
121 Intensity of the flash strobe when the flash LED is in flash mode
126 Intensity of the flash LED in torch mode
133 independent of the flash LED. The unit should be microamps (uA) if
137 Faults related to the flash. The faults tell about specific problems
138 in the flash chip itself or the LEDs attached to it. Faults may
139 prevent further use of some of the flash controls. In particular,
141 if the fault affects the flash LED. Exactly which faults have such
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
153 specific to the flash controller.
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
165 the flash controller.
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
171 minimum limit specific to the flash controller.
172 * - ``V4L2_FLASH_FAULT_INPUT_VOLTAGE``
173 - The input voltage of the flash controller is below the limit under
174 which strobing the flash at full current will not be possible.The
176 * - ``V4L2_FLASH_FAULT_LED_OVER_TEMPERATURE``
177 - The temperature of the LED has exceeded its allowed upper limit.
182 Enable or disable charging of the xenon flash capacitor.
185 Is the flash ready to strobe? Xenon flashes require their capacitors
188 is a read-only control.