On Wed, Apr 21, 2021 at 12:59:05PM -0500, Chris Morgan wrote:
From: Chris Morgan macromorgan@hotmail.com
Create dt-binding documentation to document rk817 codec. New property name of rockchip,mic-in-differential added to control if the microphone is in differential mode or not.
Signed-off-by: Chris Morgan macromorgan@hotmail.com
Changes in v8:
- Added additional documentation for missing properties of #sound-dai-cells, interrupt-parent, and wakeup-source for mfd documentation.
- Corrected order of elements descriptions in device tree documentation.
- Changed name of "mic-in-differential" to "rockchip,mic-in-differential".
- Changed name of sound card from "rockchip,rk817-codec" to "Analog".
- Removed unused resets and reset-names from the i2s1_2ch node.
Changes in v7:
- Removed ifdef around register definitions for MFD.
- Replaced codec documentation with updates to MFD documentation.
- Reordered elements in example to comply with upstream rules.
- Added binding update back for Odroid Go Advance as requested.
- Submitting patches from gmail now.
Changes in v6:
- Included additional project maintainers for correct subsystems.
- Removed unneeded compatible from DT documentation.
- Removed binding update for Odroid Go Advance (will do in seperate series).
Changes in v5:
- Move register definitions from rk817_codec.h to main rk808.h register definitions.
- Add volatile register for codec bits.
- Add default values for codec bits.
- Removed of_compatible from mtd driver (not necessary).
- Switched to using parent regmap instead of private regmap for codec.
Changes in v4:
- Created set_pll() call.
- Created user visible gain control in mic.
- Check for return value of clk_prepare_enable().
- Removed duplicate clk_prepare_enable().
- Split DT documentation to separate commit.
Changes in v3:
- Use DAPM macros to set audio path.
- Updated devicetree binding (as every rk817 has this codec chip).
- Changed documentation to yaml format.
- Split MFD changes to separate commit.
Changes in v2:
- Fixed audio path registers to solve some bugs.
.../devicetree/bindings/mfd/rk808.txt | 188 ++++++++++++++++++ 1 file changed, 188 insertions(+)
diff --git a/Documentation/devicetree/bindings/mfd/rk808.txt b/Documentation/devicetree/bindings/mfd/rk808.txt index 04df07f6f793..e27fb2c1ebe0 100644 --- a/Documentation/devicetree/bindings/mfd/rk808.txt +++ b/Documentation/devicetree/bindings/mfd/rk808.txt @@ -14,6 +14,8 @@ Required properties:
- compatible: "rockchip,rk817"
- compatible: "rockchip,rk818"
- reg: I2C slave address
+- interrupt-parent: Should contain a phandle to the correct interrupt
controller node.
This can be in any parent node, so generally not required. IOW, you don't need to document it.
Otherwise,
Acked-by: Rob Herring robh@kernel.org
(Really, this should be converted to schema, but given it's on v8 already that can come later.)
- interrupts: the interrupt outputs of the controller.
- #clock-cells: from common clock binding; shall be set to 1 (multiple clock outputs). See <dt-bindings/clock/rockchip,rk808.h> for clock IDs.
@@ -23,6 +25,7 @@ Optional properties: default output clock name
- rockchip,system-power-controller: Telling whether or not this pmic is controlling the system power.
+- wakeup-source: Device can be used as a wakeup source.
Optional RK805 properties:
- vcc1-supply: The input supply for DCDC_REG1
@@ -63,8 +66,16 @@ Optional RK809 properties:
- vcc9-supply: The input supply for DCDC_REG5, SWITCH_REG2
Optional RK817 properties: +- clocks: The input clock for the audio codec +- clock-names: The clock name for the codec clock. Should be "mclk". +- #sound-dai-cells: Needed for the interpretation of sound dais. Should be 0.
- vcc8-supply: The input supply for BOOST
- vcc9-supply: The input supply for OTG_SWITCH
+- codec: The child node for the codec to hold additional properties.
+- rockchip,mic-in-differential: Telling if the microphone uses differential
mode. Should be under the codec child node.Optional RK818 properties:
- vcc1-supply: The input supply for DCDC_REG1
@@ -275,3 +286,180 @@ Example: }; }; };
- rk817: pmic@20 {
compatible = "rockchip,rk817";reg = <0x20>;interrupt-parent = <&gpio0>;interrupts = <RK_PB2 IRQ_TYPE_LEVEL_LOW>;clock-output-names = "rk808-clkout1", "xin32k";clock-names = "mclk";clocks = <&cru SCLK_I2S1_OUT>;pinctrl-names = "default";pinctrl-0 = <&pmic_int>, <&i2s1_2ch_mclk>;wakeup-source;#clock-cells = <1>;#sound-dai-cells = <0>;vcc1-supply = <&vccsys>;vcc2-supply = <&vccsys>;vcc3-supply = <&vccsys>;vcc4-supply = <&vccsys>;vcc5-supply = <&vccsys>;vcc6-supply = <&vccsys>;vcc7-supply = <&vccsys>;regulators {vdd_logic: DCDC_REG1 {regulator-name = "vdd_logic";regulator-min-microvolt = <950000>;regulator-max-microvolt = <1150000>;regulator-ramp-delay = <6001>;regulator-always-on;regulator-boot-on;regulator-state-mem {regulator-on-in-suspend;regulator-suspend-microvolt = <950000>;};};vdd_arm: DCDC_REG2 {regulator-name = "vdd_arm";regulator-min-microvolt = <950000>;regulator-max-microvolt = <1350000>;regulator-ramp-delay = <6001>;regulator-always-on;regulator-boot-on;regulator-state-mem {regulator-off-in-suspend;regulator-suspend-microvolt = <950000>;};};vcc_ddr: DCDC_REG3 {regulator-name = "vcc_ddr";regulator-always-on;regulator-boot-on;regulator-state-mem {regulator-on-in-suspend;};};vcc_3v3: DCDC_REG4 {regulator-name = "vcc_3v3";regulator-min-microvolt = <3300000>;regulator-max-microvolt = <3300000>;regulator-always-on;regulator-boot-on;regulator-state-mem {regulator-off-in-suspend;regulator-suspend-microvolt = <3300000>;};};vcc_1v8: LDO_REG2 {regulator-name = "vcc_1v8";regulator-min-microvolt = <1800000>;regulator-max-microvolt = <1800000>;regulator-always-on;regulator-boot-on;regulator-state-mem {regulator-on-in-suspend;regulator-suspend-microvolt = <1800000>;};};vdd_1v0: LDO_REG3 {regulator-name = "vdd_1v0";regulator-min-microvolt = <1000000>;regulator-max-microvolt = <1000000>;regulator-always-on;regulator-boot-on;regulator-state-mem {regulator-on-in-suspend;regulator-suspend-microvolt = <1000000>;};};vcc3v3_pmu: LDO_REG4 {regulator-name = "vcc3v3_pmu";regulator-min-microvolt = <3300000>;regulator-max-microvolt = <3300000>;regulator-always-on;regulator-boot-on;regulator-state-mem {regulator-on-in-suspend;regulator-suspend-microvolt = <3300000>;};};vccio_sd: LDO_REG5 {regulator-name = "vccio_sd";regulator-min-microvolt = <1800000>;regulator-max-microvolt = <3300000>;regulator-always-on;regulator-boot-on;regulator-state-mem {regulator-on-in-suspend;regulator-suspend-microvolt = <3300000>;};};vcc_sd: LDO_REG6 {regulator-name = "vcc_sd";regulator-min-microvolt = <3300000>;regulator-max-microvolt = <3300000>;regulator-boot-on;regulator-state-mem {regulator-on-in-suspend;regulator-suspend-microvolt = <3300000>;};};vcc_bl: LDO_REG7 {regulator-name = "vcc_bl";regulator-min-microvolt = <3300000>;regulator-max-microvolt = <3300000>;regulator-state-mem {regulator-off-in-suspend;regulator-suspend-microvolt = <3300000>;};};vcc_lcd: LDO_REG8 {regulator-name = "vcc_lcd";regulator-min-microvolt = <2800000>;regulator-max-microvolt = <2800000>;regulator-state-mem {regulator-off-in-suspend;regulator-suspend-microvolt = <2800000>;};};vcc_cam: LDO_REG9 {regulator-name = "vcc_cam";regulator-min-microvolt = <3000000>;regulator-max-microvolt = <3000000>;regulator-state-mem {regulator-off-in-suspend;regulator-suspend-microvolt = <3000000>;};};};rk817_codec: codec {rockchip,mic-in-differential;};- };
-- 2.25.1