diff mbox series

[V2,1/2] dt-bindings: pinctrl: qcom: sm6125: Document SM6125 pinctrl driver

Message ID 20210523211809.734107-1-martin.botka@somainline.org
State Superseded
Headers show
Series [V2,1/2] dt-bindings: pinctrl: qcom: sm6125: Document SM6125 pinctrl driver | expand

Commit Message

Martin Botka May 23, 2021, 9:18 p.m. UTC
Document the newly added SM6125 pinctrl driver

Signed-off-by: Martin Botka <martin.botka@somainline.org>
---
Changes in V2:
Add commit description
 .../bindings/pinctrl/qcom,sm6125-pinctrl.yaml | 161 ++++++++++++++++++
 1 file changed, 161 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/pinctrl/qcom,sm6125-pinctrl.yaml

Comments

Bjorn Andersson May 25, 2021, 3:46 a.m. UTC | #1
On Sun 23 May 16:18 CDT 2021, Martin Botka wrote:

> Document the newly added SM6125 pinctrl driver

> 

> Signed-off-by: Martin Botka <martin.botka@somainline.org>

> ---

> Changes in V2:

> Add commit description

>  .../bindings/pinctrl/qcom,sm6125-pinctrl.yaml | 161 ++++++++++++++++++

>  1 file changed, 161 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/pinctrl/qcom,sm6125-pinctrl.yaml

> 

> diff --git a/Documentation/devicetree/bindings/pinctrl/qcom,sm6125-pinctrl.yaml b/Documentation/devicetree/bindings/pinctrl/qcom,sm6125-pinctrl.yaml

> new file mode 100644

> index 000000000000..951348953c11

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/pinctrl/qcom,sm6125-pinctrl.yaml

> @@ -0,0 +1,161 @@

> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/pinctrl/qcom,sm6125-pinctrl.yaml#

> +$schema: http://devicetree.org/meta-schemas/core.yaml#

> +title: Qualcomm Technologies, Inc. SM6125 TLMM block

> +

> +maintainers:

> +  - Martin Botka <martin.botka@somainline.org>

> +

> +description: |

> +  This binding describes the Top Level Mode Multiplexer (TLMM) block found

> +  in the SM6125 platform.

> +

> +allOf:

> +  - $ref: /schemas/pinctrl/qcom,tlmm-common.yaml#

> +

> +properties:

> +  compatible:

> +    const: qcom,sm6125-tlmm

> +

> +  reg:

> +    maxItems: 1


Driver (and example) defines 3 tiles.

> +

> +  interrupts: true

> +  interrupt-controller: true

> +  '#interrupt-cells': true

> +  gpio-controller: true

> +  gpio-reserved-ranges: true

> +  '#gpio-cells': true

> +  gpio-ranges: true

> +  wakeup-parent: true

> +

> +required:

> +  - compatible

> +  - reg

> +

> +additionalProperties: false

> +

> +patternProperties:

> +  '-state$':

> +    oneOf:

> +      - $ref: "#/$defs/qcom-sm6125-tlmm-state"

> +      - patternProperties:

> +          ".*":

> +            $ref: "#/$defs/qcom-sm6125-tlmm-state"

> +

> +$defs:

> +  qcom-sm6125-tlmm-state:

> +    type: object

> +    description:

> +      Pinctrl node's client devices use subnodes for desired pin configuration.

> +      Client device subnodes use below standard properties.

> +    $ref: "qcom,tlmm-common.yaml#/$defs/qcom-tlmm-state"

> +

> +    properties:

> +      pins:

> +        description:

> +          List of gpio pins affected by the properties specified in this

> +          subnode.

> +        items:

> +          oneOf:

> +            - pattern: "^gpio([0-9]|[1-9][0-9]|1[0-9][0-9]|20[0-3])$"


This pattern allows gpio0-9, gpio10-99, gpio100-199 and gpio200-203. I
think you're looking for something in line with:

"^gpio[0-9]|[1-9][0-9]|1[0-2][0-9]|13[0-2]$"

> +            - enum: [ sdc1_clk, sdc1_cmd, sdc1_data, sdc2_clk, sdc2_cmd, sdc2_data ]

> +        minItems: 1

> +        maxItems: 36

> +

> +      function:

> +        description:

> +          Specify the alternative function to be configured for the specified

> +          pins.

> +

> +        enum: [ adsp_ext, agera_pll, atest_char, atest_char0, atest_char1,

> +                atest_char2, atest_char3, atest_tsens, atest_tsens2, atest_usb1,

> +                atest_usb10, atest_usb11, atest_usb12, atest_usb13, atest_usb2,

> +                atest_usb20, atest_usb21, atest_usb22, atest_usb23, aud_sb,

> +                audio_ref, cam_mclk, cci_async, cci_i2c, cci_timer0, cci_timer1,

> +                cci_timer2, cci_timer3, cci_timer4, copy_gp, copy_phase, cri_trng,

> +                cri_trng0, cri_trng1, dbg_out, ddr_bist, ddr_pxi0, ddr_pxi1,

> +                ddr_pxi2, ddr_pxi3, debug_hot, dmic0_clk, dmic0_data, dmic1_clk,

> +                dmic1_data, dp_hot, edp_hot, edp_lcd, gcc_gp1, gcc_gp2, gcc_gp3,

> +                gp_pdm0, gp_pdm1, gp_pdm2, gpio, gps_tx, jitter_bist, ldo_en,

> +                ldo_update, m_voc, mclk1, mclk2, mdp_vsync, mdp_vsync0, mdp_vsync1,

> +                mdp_vsync2, mdp_vsync3, mdp_vsync4, mdp_vsync5, mpm_pwr, mss_lte,

> +                nav_pps, pa_indicator, phase_flag0, phase_flag1, phase_flag10,

> +                phase_flag11, phase_flag12, phase_flag13, phase_flag14, phase_flag15,

> +                phase_flag16, phase_flag17, phase_flag18, phase_flag19, phase_flag2,

> +                phase_flag20, phase_flag21, phase_flag22, phase_flag23, phase_flag24,

> +                phase_flag25, phase_flag26, phase_flag27, phase_flag28, phase_flag29,

> +                phase_flag3, phase_flag30, phase_flag31, phase_flag4, phase_flag5,

> +                phase_flag6, phase_flag7, phase_flag8, phase_flag9, pll_bist,

> +                pll_bypassnl, pll_reset, pri_mi2s, pri_mi2s_ws, prng_rosc, qca_sb,

> +                qdss_cti, qdss_gpio, qdss_gpio0, qdss_gpio1, qdss_gpio10, qdss_gpio11,

> +                qdss_gpio12, qdss_gpio13, qdss_gpio14, qdss_gpio15, qdss_gpio2,

> +                qdss_gpio3, qdss_gpio4, qdss_gpio5, qdss_gpio6, qdss_gpio7, qdss_gpio8,

> +                qdss_gpio9, qlink_enable, qlink_request, qua_mi2s, qui_mi2s, qup00,

> +                qup01, qup02, qup03, qup04, qup10, qup11, qup12, qup13, qup14,

> +                sd_write, sec_mi2s, sp_cmu, swr_rx, swr_tx, ter_mi2s, tgu_ch0,

> +                tgu_ch1, tgu_ch2, tgu_ch3, tsense_pwm, uim1_clk, uim1_data,

> +                uim1_present, uim1_reset, uim2_clk, uim2_data, uim2_present,

> +                uim2_reset, unused1, unused2, usb_phy, vfr_1, vsense_trigger,

> +                wlan1_adc0, wlan1_adc1, wlan2_adc0, wlan2_adc1, wsa_clk, wsa_data ]

> +

> +

> +      bias-disable: true

> +      bias-pull-down: true

> +      bias-pull-up: true

> +      drive-strength: true

> +      input-enable: true

> +      output-high: true

> +      output-low: true

> +

> +    required:

> +      - pins

> +      - function

> +

> +    additionalProperties: false

> +

> +examples:

> +  - |

> +        #include <dt-bindings/interrupt-controller/arm-gic.h>

> +	pinctrl@500000 {

> +		compatible = "qcom,sm6125-pinctrl";


s/pinconf/tlmm/

> +		reg = <0x00500000 0x400000>,

> +			<0x00900000 0x400000>,

> +			<0x00d00000 0x400000>;

> +		reg-names = "west", "south", "east";

> +		interrupts = <GIC_SPI 227 IRQ_TYPE_LEVEL_HIGH>;

> +		gpio-controller;

> +		gpio-ranges = <&tlmm 0 0 134>;

> +		#gpio-cells = <2>;

> +		interrupt-controller;

> +		#interrupt-cells = <2>;

> +

> +		sdc2_state_on: sdc2-on {


Per the binding the node name needs to end in "-state".

> +			pinconf-clk {


There's no risk of name collisions in the state, so you should drop the
"pinconf-" prefix.

Regards,
Bjorn

> +				pins = "sdc2_clk";

> +				bias-disable;

> +				drive-strength = <16>;

> +			};

> +

> +			pinconf-cmd {

> +				pins = "sdc2_cmd";

> +				bias-pull-up;

> +				drive-strength = <10>;

> +			};

> +

> +			pinconf-data {

> +				pins = "sdc2_data";

> +				bias-pull-up;

> +				drive-strength = <10>;

> +			};

> +

> +			pinconf-sd-cd {

> +				pins = "gpio98";

> +				bias-pull-up;

> +				drive-strength = <2>;

> +			};

> +		};

> +	};

> +...

> -- 

> 2.31.1

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/pinctrl/qcom,sm6125-pinctrl.yaml b/Documentation/devicetree/bindings/pinctrl/qcom,sm6125-pinctrl.yaml
new file mode 100644
index 000000000000..951348953c11
--- /dev/null
+++ b/Documentation/devicetree/bindings/pinctrl/qcom,sm6125-pinctrl.yaml
@@ -0,0 +1,161 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pinctrl/qcom,sm6125-pinctrl.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+title: Qualcomm Technologies, Inc. SM6125 TLMM block
+
+maintainers:
+  - Martin Botka <martin.botka@somainline.org>
+
+description: |
+  This binding describes the Top Level Mode Multiplexer (TLMM) block found
+  in the SM6125 platform.
+
+allOf:
+  - $ref: /schemas/pinctrl/qcom,tlmm-common.yaml#
+
+properties:
+  compatible:
+    const: qcom,sm6125-tlmm
+
+  reg:
+    maxItems: 1
+
+  interrupts: true
+  interrupt-controller: true
+  '#interrupt-cells': true
+  gpio-controller: true
+  gpio-reserved-ranges: true
+  '#gpio-cells': true
+  gpio-ranges: true
+  wakeup-parent: true
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+patternProperties:
+  '-state$':
+    oneOf:
+      - $ref: "#/$defs/qcom-sm6125-tlmm-state"
+      - patternProperties:
+          ".*":
+            $ref: "#/$defs/qcom-sm6125-tlmm-state"
+
+$defs:
+  qcom-sm6125-tlmm-state:
+    type: object
+    description:
+      Pinctrl node's client devices use subnodes for desired pin configuration.
+      Client device subnodes use below standard properties.
+    $ref: "qcom,tlmm-common.yaml#/$defs/qcom-tlmm-state"
+
+    properties:
+      pins:
+        description:
+          List of gpio pins affected by the properties specified in this
+          subnode.
+        items:
+          oneOf:
+            - pattern: "^gpio([0-9]|[1-9][0-9]|1[0-9][0-9]|20[0-3])$"
+            - enum: [ sdc1_clk, sdc1_cmd, sdc1_data, sdc2_clk, sdc2_cmd, sdc2_data ]
+        minItems: 1
+        maxItems: 36
+
+      function:
+        description:
+          Specify the alternative function to be configured for the specified
+          pins.
+
+        enum: [ adsp_ext, agera_pll, atest_char, atest_char0, atest_char1,
+                atest_char2, atest_char3, atest_tsens, atest_tsens2, atest_usb1,
+                atest_usb10, atest_usb11, atest_usb12, atest_usb13, atest_usb2,
+                atest_usb20, atest_usb21, atest_usb22, atest_usb23, aud_sb,
+                audio_ref, cam_mclk, cci_async, cci_i2c, cci_timer0, cci_timer1,
+                cci_timer2, cci_timer3, cci_timer4, copy_gp, copy_phase, cri_trng,
+                cri_trng0, cri_trng1, dbg_out, ddr_bist, ddr_pxi0, ddr_pxi1,
+                ddr_pxi2, ddr_pxi3, debug_hot, dmic0_clk, dmic0_data, dmic1_clk,
+                dmic1_data, dp_hot, edp_hot, edp_lcd, gcc_gp1, gcc_gp2, gcc_gp3,
+                gp_pdm0, gp_pdm1, gp_pdm2, gpio, gps_tx, jitter_bist, ldo_en,
+                ldo_update, m_voc, mclk1, mclk2, mdp_vsync, mdp_vsync0, mdp_vsync1,
+                mdp_vsync2, mdp_vsync3, mdp_vsync4, mdp_vsync5, mpm_pwr, mss_lte,
+                nav_pps, pa_indicator, phase_flag0, phase_flag1, phase_flag10,
+                phase_flag11, phase_flag12, phase_flag13, phase_flag14, phase_flag15,
+                phase_flag16, phase_flag17, phase_flag18, phase_flag19, phase_flag2,
+                phase_flag20, phase_flag21, phase_flag22, phase_flag23, phase_flag24,
+                phase_flag25, phase_flag26, phase_flag27, phase_flag28, phase_flag29,
+                phase_flag3, phase_flag30, phase_flag31, phase_flag4, phase_flag5,
+                phase_flag6, phase_flag7, phase_flag8, phase_flag9, pll_bist,
+                pll_bypassnl, pll_reset, pri_mi2s, pri_mi2s_ws, prng_rosc, qca_sb,
+                qdss_cti, qdss_gpio, qdss_gpio0, qdss_gpio1, qdss_gpio10, qdss_gpio11,
+                qdss_gpio12, qdss_gpio13, qdss_gpio14, qdss_gpio15, qdss_gpio2,
+                qdss_gpio3, qdss_gpio4, qdss_gpio5, qdss_gpio6, qdss_gpio7, qdss_gpio8,
+                qdss_gpio9, qlink_enable, qlink_request, qua_mi2s, qui_mi2s, qup00,
+                qup01, qup02, qup03, qup04, qup10, qup11, qup12, qup13, qup14,
+                sd_write, sec_mi2s, sp_cmu, swr_rx, swr_tx, ter_mi2s, tgu_ch0,
+                tgu_ch1, tgu_ch2, tgu_ch3, tsense_pwm, uim1_clk, uim1_data,
+                uim1_present, uim1_reset, uim2_clk, uim2_data, uim2_present,
+                uim2_reset, unused1, unused2, usb_phy, vfr_1, vsense_trigger,
+                wlan1_adc0, wlan1_adc1, wlan2_adc0, wlan2_adc1, wsa_clk, wsa_data ]
+
+
+      bias-disable: true
+      bias-pull-down: true
+      bias-pull-up: true
+      drive-strength: true
+      input-enable: true
+      output-high: true
+      output-low: true
+
+    required:
+      - pins
+      - function
+
+    additionalProperties: false
+
+examples:
+  - |
+        #include <dt-bindings/interrupt-controller/arm-gic.h>
+	pinctrl@500000 {
+		compatible = "qcom,sm6125-pinctrl";
+		reg = <0x00500000 0x400000>,
+			<0x00900000 0x400000>,
+			<0x00d00000 0x400000>;
+		reg-names = "west", "south", "east";
+		interrupts = <GIC_SPI 227 IRQ_TYPE_LEVEL_HIGH>;
+		gpio-controller;
+		gpio-ranges = <&tlmm 0 0 134>;
+		#gpio-cells = <2>;
+		interrupt-controller;
+		#interrupt-cells = <2>;
+
+		sdc2_state_on: sdc2-on {
+			pinconf-clk {
+				pins = "sdc2_clk";
+				bias-disable;
+				drive-strength = <16>;
+			};
+
+			pinconf-cmd {
+				pins = "sdc2_cmd";
+				bias-pull-up;
+				drive-strength = <10>;
+			};
+
+			pinconf-data {
+				pins = "sdc2_data";
+				bias-pull-up;
+				drive-strength = <10>;
+			};
+
+			pinconf-sd-cd {
+				pins = "gpio98";
+				bias-pull-up;
+				drive-strength = <2>;
+			};
+		};
+	};
+...