[PATCH 3/4] ASoC: dt-bindings: cs35l45: Adds Boost BPE properties
From: Ricardo Rivera-Matos via B4 Relay
Date: Mon Nov 09 2026 - 13:01:27 EST
From: Ricardo Rivera-Matos <rriveram@xxxxxxxxxxxxxxxxxxxxx>
Documents devicetree properties for configuring the boost
brownout prevention engine (BBPE).
Signed-off-by: Ricardo Rivera-Matos <rriveram@xxxxxxxxxxxxxxxxxxxxx>
---
.../devicetree/bindings/sound/cirrus,cs35l45.yaml | 254 +++++++++++++++++++++
include/dt-bindings/sound/cs35l45.h | 45 ++++
2 files changed, 299 insertions(+)
diff --git a/Documentation/devicetree/bindings/sound/cirrus,cs35l45.yaml b/Documentation/devicetree/bindings/sound/cirrus,cs35l45.yaml
index 2c118fa57ad1..9373ce4bc3a8 100644
--- a/Documentation/devicetree/bindings/sound/cirrus,cs35l45.yaml
+++ b/Documentation/devicetree/bindings/sound/cirrus,cs35l45.yaml
@@ -73,6 +73,64 @@ allOf:
cirrus,amplifier-bpe-attenuation-levels-db: false
cirrus,amplifier-bpe-attenuation-levels-microvolt: false
+ - if:
+ required:
+ - cirrus,boost-bpe-enable
+ then:
+ required:
+ - cirrus,boost-bpe-output-operating-mode
+ - cirrus,boost-bpe-output-attack-rate
+ - cirrus,boost-bpe-output-release-rate
+ - cirrus,boost-bpe-battery-limits-microamp
+ - cirrus,boost-bpe-battery-thresholds-microvolt
+ - cirrus,boost-bpe-battery-attack-rates
+ - cirrus,boost-bpe-battery-hold-times-us
+ - cirrus,boost-bpe-battery-release-rates
+ else:
+ properties:
+ cirrus,boost-bpe-output-operating-mode: false
+ cirrus,boost-bpe-output-attack-rate: false
+ cirrus,boost-bpe-output-release-rate: false
+ cirrus,boost-bpe-battery-limits-microamp: false
+ cirrus,boost-bpe-battery-thresholds-microvolt: false
+ cirrus,boost-bpe-battery-attack-rates: false
+ cirrus,boost-bpe-battery-hold-times-us: false
+ cirrus,boost-bpe-battery-release-rates: false
+ cirrus,boost-bpe-inductor-release-mode: false
+ cirrus,boost-bpe-inductor-threshold-microamp: false
+ cirrus,boost-bpe-inductor-threshold-deltas-microamp: false
+ cirrus,boost-bpe-inductor-threshold-hysteresis-microamp: false
+ cirrus,boost-bpe-inductor-delay-hysteresis-us: false
+ cirrus,boost-bpe-inductor-delays-ms: false
+ cirrus,boost-bpe-inductor-attack-rates: false
+ cirrus,boost-bpe-inductor-release-rates: false
+ - if:
+ properties:
+ cirrus,boost-bpe-output-operating-mode:
+ const: 0
+ required:
+ - cirrus,boost-bpe-output-operating-mode
+ then:
+ required:
+ - cirrus,boost-bpe-inductor-release-mode
+ - cirrus,boost-bpe-inductor-threshold-microamp
+ - cirrus,boost-bpe-inductor-threshold-deltas-microamp
+ - cirrus,boost-bpe-inductor-threshold-hysteresis-microamp
+ - cirrus,boost-bpe-inductor-delay-hysteresis-us
+ - cirrus,boost-bpe-inductor-delays-ms
+ - cirrus,boost-bpe-inductor-attack-rates
+ - cirrus,boost-bpe-inductor-release-rates
+ else:
+ properties:
+ cirrus,boost-bpe-inductor-release-mode: false
+ cirrus,boost-bpe-inductor-threshold-microamp: false
+ cirrus,boost-bpe-inductor-threshold-deltas-microamp: false
+ cirrus,boost-bpe-inductor-threshold-hysteresis-microamp: false
+ cirrus,boost-bpe-inductor-delay-hysteresis-us: false
+ cirrus,boost-bpe-inductor-delays-ms: false
+ cirrus,boost-bpe-inductor-attack-rates: false
+ cirrus,boost-bpe-inductor-release-rates: false
+
properties:
compatible:
enum:
@@ -165,6 +223,166 @@ properties:
- 0
- 1
+ cirrus,boost-bpe-enable:
+ type: boolean
+ description:
+ Enable the boost converter brownout protection engine (BBPE).
+ Configuration properties are applied before the engine is enabled.
+
+ cirrus,boost-bpe-inductor-release-mode:
+ description:
+ Selects whether the inductor current response releases instantly or
+ through the release counter. Required in combined mode. Use a
+ CS35L45_BST_BPE_IL_RELEASE_MODE_* constant.
+ $ref: /schemas/types.yaml#/definitions/uint32
+ enum: [0, 1]
+
+ cirrus,boost-bpe-output-operating-mode:
+ description:
+ Selects the operating mode for the BBPE output stage. The BBPE can be
+ configured to apply the minimum of the battery voltage and inductor
+ current response or the battery voltage response only. When operating in
+ battery voltage only mode, the inductor response related properties are
+ invalid.
+
+ Required when Boost BPE is enabled. Use a CS35L45_BST_BPE_OUTPUT_MODE_*
+ constant.
+ $ref: /schemas/types.yaml#/definitions/uint32
+ enum: [0, 1]
+
+ cirrus,boost-bpe-output-attack-rate:
+ description:
+ Boost BPE output attack-rate selector. Use a
+ CS35L45_BST_BPE_ATTACK_RATE_* constant.
+ $ref: /schemas/types.yaml#/definitions/uint32
+ minimum: 0
+ maximum: 7
+
+ cirrus,boost-bpe-output-release-rate:
+ description:
+ Boost BPE output release-rate selector. Use a
+ CS35L45_BST_BPE_RELEASE_RATE_* constant.
+ $ref: /schemas/types.yaml#/definitions/uint32
+ minimum: 0
+ maximum: 16
+
+ cirrus,boost-bpe-battery-limits-microamp:
+ description:
+ Boost converter current limits for battery voltage response levels 1
+ through 4, in ascending level order.
+ minItems: 4
+ maxItems: 4
+ items:
+ minimum: 250000
+ maximum: 4625000
+ multipleOf: 62500
+
+ cirrus,boost-bpe-battery-thresholds-microvolt:
+ description:
+ Battery voltage thresholds for battery voltage response levels 0 through
+ 3, in ascending level order.
+ minItems: 4
+ maxItems: 4
+ items:
+ minimum: 2300000
+ maximum: 4500000
+ multipleOf: 10000
+
+ cirrus,boost-bpe-battery-attack-rates:
+ description:
+ Attack-rate selectors for battery voltage response levels 1 through 3, in
+ ascending level order. Use CS35L45_BST_BPE_ATTACK_RATE_* constants.
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ minItems: 3
+ maxItems: 3
+ items:
+ minimum: 0
+ maximum: 7
+
+ cirrus,boost-bpe-battery-hold-times-us:
+ description:
+ Hold times for battery voltage response levels 0 through 3, in ascending
+ level order. Infinite hold is not supported.
+ minItems: 4
+ maxItems: 4
+ items:
+ enum: [0, 5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000]
+
+ cirrus,boost-bpe-battery-release-rates:
+ description:
+ Release-rate selectors for voltage response levels 0 through 3, in
+ ascending level order. Use CS35L45_BST_BPE_RELEASE_RATE_* constants.
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ minItems: 4
+ maxItems: 4
+ items:
+ minimum: 0
+ maximum: 16
+
+ cirrus,boost-bpe-inductor-threshold-microamp:
+ description:
+ Inductor current response level 1 threshold.
+ minimum: 250000
+ maximum: 4000000
+ multipleOf: 62500
+
+ cirrus,boost-bpe-inductor-threshold-deltas-microamp:
+ description:
+ Inductor current response threshold deltas 1 and 2, in that order.
+ minItems: 2
+ maxItems: 2
+ items:
+ minimum: 0
+ maximum: 3750000
+ multipleOf: 62500
+
+ cirrus,boost-bpe-inductor-threshold-hysteresis-microamp:
+ description:
+ Release threshold hysteresis for inductor current response levels 1
+ and 2.
+ minimum: 0
+ maximum: 968750
+ multipleOf: 31250
+
+ cirrus,boost-bpe-inductor-delay-hysteresis-us:
+ description:
+ Release delay hysteresis for inductor current response levels 1 and 2.
+ minimum: 0
+ maximum: 992
+ multipleOf: 32
+
+ cirrus,boost-bpe-inductor-delays-ms:
+ description:
+ Entry delays for inductor current response levels 1 and 2, in ascending
+ level order.
+ minItems: 2
+ maxItems: 2
+ items:
+ minimum: 0
+ maximum: 100
+
+ cirrus,boost-bpe-inductor-attack-rates:
+ description:
+ Attack-rate selectors for inductor current response levels 1 and 2, in
+ ascending level order. Use CS35L45_BST_BPE_ATTACK_RATE_* constants.
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ minItems: 2
+ maxItems: 2
+ items:
+ minimum: 0
+ maximum: 7
+
+ cirrus,boost-bpe-inductor-release-rates:
+ description:
+ Release-rate selectors for inductor current response levels 1 and 2, in
+ ascending level order. Use CS35L45_BST_BPE_RELEASE_RATE_* constants.
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ minItems: 2
+ maxItems: 2
+ items:
+ minimum: 0
+ maximum: 16
+
cirrus,ldpm-group2-vmon-select:
type: boolean
description:
@@ -412,6 +630,42 @@ examples:
cirrus,amplifier-bpe-attack-rates = <6 6 6 6>;
cirrus,amplifier-bpe-hold-times-us = <500 500 500 500>;
cirrus,amplifier-bpe-release-rates = <5 5 5 5>;
+ cirrus,boost-bpe-enable;
+ cirrus,boost-bpe-inductor-release-mode =
+ <CS35L45_BST_BPE_IL_RELEASE_MODE_COUNTER>;
+ cirrus,boost-bpe-output-operating-mode =
+ <CS35L45_BST_BPE_OUTPUT_MODE_BOTH>;
+ cirrus,boost-bpe-output-attack-rate =
+ <CS35L45_BST_BPE_ATTACK_RATE_31P25MA_PER_US>;
+ cirrus,boost-bpe-output-release-rate =
+ <CS35L45_BST_BPE_RELEASE_RATE_3P90625MA_PER_US>;
+ cirrus,boost-bpe-battery-limits-microamp =
+ <1000000 1500000 2000000 2500000>;
+ cirrus,boost-bpe-battery-thresholds-microvolt =
+ <4000000 3600000 3200000 2800000>;
+ cirrus,boost-bpe-battery-attack-rates =
+ <CS35L45_BST_BPE_ATTACK_RATE_INSTANT
+ CS35L45_BST_BPE_ATTACK_RATE_125MA_PER_US
+ CS35L45_BST_BPE_ATTACK_RATE_31P25MA_PER_US>;
+ cirrus,boost-bpe-battery-hold-times-us = <0 5 10 25>;
+ cirrus,boost-bpe-battery-release-rates =
+ <CS35L45_BST_BPE_RELEASE_RATE_INSTANT
+ CS35L45_BST_BPE_RELEASE_RATE_62P5MA_PER_US
+ CS35L45_BST_BPE_RELEASE_RATE_31P25MA_PER_US
+ CS35L45_BST_BPE_RELEASE_RATE_15P625MA_PER_US>;
+ cirrus,boost-bpe-inductor-threshold-microamp = <3000000>;
+ cirrus,boost-bpe-inductor-threshold-deltas-microamp =
+ <250000 500000>;
+ cirrus,boost-bpe-inductor-threshold-hysteresis-microamp =
+ <125000>;
+ cirrus,boost-bpe-inductor-delay-hysteresis-us = <64>;
+ cirrus,boost-bpe-inductor-delays-ms = <12 4>;
+ cirrus,boost-bpe-inductor-attack-rates =
+ <CS35L45_BST_BPE_ATTACK_RATE_INSTANT
+ CS35L45_BST_BPE_ATTACK_RATE_125MA_PER_US>;
+ cirrus,boost-bpe-inductor-release-rates =
+ <CS35L45_BST_BPE_RELEASE_RATE_INSTANT
+ CS35L45_BST_BPE_RELEASE_RATE_62P5MA_PER_US>;
cirrus,gpio-ctrl1 {
gpio-ctrl = <0x2>;
};
diff --git a/include/dt-bindings/sound/cs35l45.h b/include/dt-bindings/sound/cs35l45.h
index 5cb77d48b0b8..4a7535a81612 100644
--- a/include/dt-bindings/sound/cs35l45.h
+++ b/include/dt-bindings/sound/cs35l45.h
@@ -17,6 +17,51 @@
#define CS35L45_ASP_TX_HIZ_UNUSED 0x1
#define CS35L45_ASP_TX_HIZ_DISABLED 0x2
+/*
+ * cirrus,boost-bpe-inductor-release-mode
+ */
+#define CS35L45_BST_BPE_IL_RELEASE_MODE_INSTANT 0x0
+#define CS35L45_BST_BPE_IL_RELEASE_MODE_COUNTER 0x1
+
+/*
+ * cirrus,boost-bpe-output-operating-mode
+ */
+#define CS35L45_BST_BPE_OUTPUT_MODE_BOTH 0x0
+#define CS35L45_BST_BPE_OUTPUT_MODE_VOLTAGE_ONLY 0x1
+
+/*
+ * Boost BPE attack-rate selectors
+ */
+#define CS35L45_BST_BPE_ATTACK_RATE_INSTANT 0x0
+#define CS35L45_BST_BPE_ATTACK_RATE_250MA_PER_US 0x1
+#define CS35L45_BST_BPE_ATTACK_RATE_125MA_PER_US 0x2
+#define CS35L45_BST_BPE_ATTACK_RATE_62P5MA_PER_US 0x3
+#define CS35L45_BST_BPE_ATTACK_RATE_31P25MA_PER_US 0x4
+#define CS35L45_BST_BPE_ATTACK_RATE_15P625MA_PER_US 0x5
+#define CS35L45_BST_BPE_ATTACK_RATE_7P8125MA_PER_US 0x6
+#define CS35L45_BST_BPE_ATTACK_RATE_3P90625MA_PER_US 0x7
+
+/*
+ * Boost BPE release-rate selectors
+ */
+#define CS35L45_BST_BPE_RELEASE_RATE_INSTANT 0x00
+#define CS35L45_BST_BPE_RELEASE_RATE_62P5MA_PER_US 0x01
+#define CS35L45_BST_BPE_RELEASE_RATE_31P25MA_PER_US 0x02
+#define CS35L45_BST_BPE_RELEASE_RATE_15P625MA_PER_US 0x03
+#define CS35L45_BST_BPE_RELEASE_RATE_7P8125MA_PER_US 0x04
+#define CS35L45_BST_BPE_RELEASE_RATE_3P90625MA_PER_US 0x05
+#define CS35L45_BST_BPE_RELEASE_RATE_1P953125MA_PER_US 0x06
+#define CS35L45_BST_BPE_RELEASE_RATE_0P976562MA_PER_US 0x07
+#define CS35L45_BST_BPE_RELEASE_RATE_0P488281MA_PER_US 0x08
+#define CS35L45_BST_BPE_RELEASE_RATE_0P244141MA_PER_US 0x09
+#define CS35L45_BST_BPE_RELEASE_RATE_0P122070MA_PER_US 0x0A
+#define CS35L45_BST_BPE_RELEASE_RATE_0P061035MA_PER_US 0x0B
+#define CS35L45_BST_BPE_RELEASE_RATE_0P030518MA_PER_US 0x0C
+#define CS35L45_BST_BPE_RELEASE_RATE_0P015259MA_PER_US 0x0D
+#define CS35L45_BST_BPE_RELEASE_RATE_0P007629MA_PER_US 0x0E
+#define CS35L45_BST_BPE_RELEASE_RATE_0P003815MA_PER_US 0x0F
+#define CS35L45_BST_BPE_RELEASE_RATE_0P001907MA_PER_US 0x10
+
/*
* cirrus,boost-low-power-mode
*
--
2.43.0