Re: [PATCH v5 05/14] dt-bindings: usb: Add Qualcomm PMIC Type-C YAML schema

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 2023-04-13 12:34:29, Bryan O'Donoghue wrote:
> Add a YAML binding for the Type-C silicon interface inside Qualcomm's
> pm8150b hardware block.
> 
> The Type-C driver operates with a pdphy driver inside of a high level
> single TCPM device.
> 
> Based on original work by Wesley.
> 
> Signed-off-by: Wesley Cheng <wcheng@xxxxxxxxxxxxxx>
> Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@xxxxxxxxxx>
> ---
>  .../bindings/usb/qcom,pmic-typec.yaml         | 169 ++++++++++++++++++
>  1 file changed, 169 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml
> 
> diff --git a/Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml b/Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml
> new file mode 100644
> index 0000000000000..6d0f5d00305cf
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml
> @@ -0,0 +1,169 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/usb/qcom,pmic-typec.yaml#";
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#";
> +
> +title: Qualcomm PMIC based USB Type-C block
> +
> +maintainers:
> +  - Bryan O'Donoghue <bryan.odonoghue@xxxxxxxxxx>
> +
> +description: |
> +  Qualcomm PMIC Type-C block
> +
> +properties:
> +  compatible:
> +    enum:
> +      - qcom,pm8150b-typec
> +
> +  connector:
> +    type: object
> +    $ref: /schemas/connector/usb-connector.yaml#
> +    unevaluatedProperties: false
> +
> +  reg:
> +    description: Type-C port and pdphy SPMI register base offsets
> +    minItems: 2
> +    maxItems: 2
> +
> +  interrupts:
> +    items:
> +      - description: Bitmask of CC attach, VBUS error, tCCDebounce done and more
> +      - description: VCONN Powered Detection
> +      - description: CC state change
> +      - description: VCONN over-current condition
> +      - description: VBUS state change
> +      - description: Attach Deteach notification

Deteach -> Detach

> +      - description: Legacy cable detect
> +      - description: Try.Src Try.Snk state change
> +      - description: Sig TX - transmitted reset signal
> +      - description: Sig RX - received reset signal
> +      - description: TX completion
> +      - description: RX completion
> +      - description: TX fail
> +      - description: TX discgard
> +      - description: RX discgard

discgard (2x) -> discard

> +      - description: Fast Role Swap event

None of these descriptions follow a similar pattern and are very hard to
read and understand.  Can you rewrite them?  For starters, think about
using the same wording and capitalization.

> +
> +  interrupt-names:
> +    items:
> +      - const: or-rid-detect-change
> +      - const: vpd-detect
> +      - const: cc-state-change
> +      - const: vconn-oc
> +      - const: vbus-change
> +      - const: attach-detach
> +      - const: legacy-cable-detect
> +      - const: try-snk-src-detect
> +      - const: sig-tx
> +      - const: sig-rx
> +      - const: msg-tx
> +      - const: msg-rx
> +      - const: msg-tx-failed
> +      - const: msg-tx-discarded
> +      - const: msg-rx-discarded
> +      - const: fr-swap
> +
> +  vdd-vbus-supply:
> +    description: VBUS power supply.
> +
> +  vdd-pdphy-supply:
> +    description: VDD regulator supply to the PDPHY.
> +
> +  port:
> +    $ref: /schemas/graph.yaml#/properties/port
> +    description:
> +      Contains a port which produces data-role switching messages.
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - interrupt-names
> +  - vdd-vbus-supply
> +  - vdd-pdphy-supply
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    #include <dt-bindings/usb/pd.h>
> +
> +    pm8150b {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        pm8150b_typec: typec@1500 {
> +            compatible = "qcom,pm8150b-typec";
> +            reg = <0x1500>,
> +                  <0x1700>;
> +
> +            interrupts = <0x2 0x15 0x00 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x15 0x01 IRQ_TYPE_EDGE_BOTH>,
> +                         <0x2 0x15 0x02 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x15 0x03 IRQ_TYPE_EDGE_BOTH>,
> +                         <0x2 0x15 0x04 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x15 0x05 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x15 0x06 IRQ_TYPE_EDGE_BOTH>,
> +                         <0x2 0x15 0x07 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x17 0x00 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x17 0x01 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x17 0x02 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x17 0x03 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x17 0x04 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x17 0x05 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x17 0x06 IRQ_TYPE_EDGE_RISING>,
> +                         <0x2 0x17 0x07 IRQ_TYPE_EDGE_RISING>;
> +
> +            interrupt-names = "or-rid-detect-change",
> +                              "vpd-detect",
> +                              "cc-state-change",
> +                              "vconn-oc",
> +                              "vbus-change",
> +                              "attach-detach",
> +                              "legacy-cable-detect",
> +                              "try-snk-src-detect",
> +                              "sig-tx",
> +                              "sig-rx",
> +                              "msg-tx",
> +                              "msg-rx",
> +                              "msg-tx-failed",
> +                              "msg-tx-discarded",
> +                              "msg-rx-discarded",
> +                              "fr-swap";
> +
> +            vdd-vbus-supply = <&pm8150b_vbus>;
> +            vdd-pdphy-supply = <&vreg_l2a_3p1>;
> +            connector {
> +                compatible = "usb-c-connector";
> +
> +                power-role = "source";
> +                data-role = "dual";
> +                self-powered;
> +
> +                source-pdos = <PDO_FIXED(5000, 3000, PDO_FIXED_DUAL_ROLE |
> +                               PDO_FIXED_USB_COMM | PDO_FIXED_DATA_SWAP)>;
> +
> +                ports {
> +                    #address-cells = <1>;
> +                    #size-cells = <0>;
> +
> +                    port@0 {
> +                        reg = <0>;
> +                        pm8150b_typec_mux_out: endpoint {
> +                            remote-endpoint = <&qmpphy_typec_mux_in>;
> +                        };
> +                    };

Also a newline?

- Marijn

> +                    port@1 {
> +                        reg = <1>;
> +                        pm8150b_typec_role_switch_out: endpoint {
> +                            remote-endpoint = <&dwc3_role_switch_in>;
> +                        };
> +                    };
> +                };
> +            };
> +        };
> +    };
> +...
> -- 
> 2.39.2
> 



[Index of Archives]     [Linux Media]     [Linux Input]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Old Linux USB Devel Archive]

  Powered by Linux