Commit 501b1520 authored by Kyle Tso's avatar Kyle Tso Committed by Greg Kroah-Hartman
Browse files

dt-bindings: connector: Add child nodes for multiple PD capabilities 



Commit 662a6010 ("usb: typec: Separate USB Power Delivery from USB
Type-C") allows userspace to configure the PD of a port by selecting
different set of predefined PD capabilities. Define the PD capability
sets in DT for better configurability in device modules.

Define an optional child node "capabilities" to contain multiple USB
Power Delivery capabilities.

Define child nodes with pattern (e.g. caps-0, caps-1) under
"capabilities". Each node contains PDO data of a selectable Power
Delivery capability.

Also define common properties for source-pdos, sink-pdos, and
op-sink-microwatt that can be referenced.

Signed-off-by: default avatarKyle Tso <kyletso@google.com>
Link: https://lore.kernel.org/r/20231205030114.1349089-2-kyletso@google.com


Signed-off-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20231216104630.2720818-2-kyletso@google.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 6d6887c4

Documentation/devicetree/bindings/connector/usb-connector.yaml

+50 −31
Original line number Diff line number Diff line
@@ -66,7 +66,6 @@ properties: 
      Particularly, if use an output GPIO to control a VBUS regulator, should

      model it as a regulator. See bindings/regulator/fixed-regulator.yaml



  # The following are optional properties for "usb-c-connector".

  power-role:

    description: Determines the power role that the Type C connector will

      support. "dual" refers to Dual Role Port (DRP).
@@ -119,30 +118,6 @@ properties: 


  # The following are optional properties for "usb-c-connector" with power

  # delivery support.

  source-pdos:

    description: An array of u32 with each entry providing supported power

      source data object(PDO), the detailed bit definitions of PDO can be found

      in "Universal Serial Bus Power Delivery Specification" chapter 6.4.1.2

      Source_Capabilities Message, the order of each entry(PDO) should follow

      the PD spec chapter 6.4.1. Required for power source and power dual role.

      User can specify the source PDO array via PDO_FIXED/BATT/VAR/PPS_APDO()

      defined in dt-bindings/usb/pd.h.

    minItems: 1

    maxItems: 7

    $ref: /schemas/types.yaml#/definitions/uint32-array



  sink-pdos:

    description: An array of u32 with each entry providing supported power sink

      data object(PDO), the detailed bit definitions of PDO can be found in

      "Universal Serial Bus Power Delivery Specification" chapter 6.4.1.3

      Sink Capabilities Message, the order of each entry(PDO) should follow the

      PD spec chapter 6.4.1. Required for power sink and power dual role. User

      can specify the sink PDO array via PDO_FIXED/BATT/VAR/PPS_APDO() defined

      in dt-bindings/usb/pd.h.

    minItems: 1

    maxItems: 7

    $ref: /schemas/types.yaml#/definitions/uint32-array



  sink-vdos:

    description: An array of u32 with each entry, a Vendor Defined Message Object (VDO),

      providing additional information corresponding to the product, the detailed bit
@@ -166,11 +141,6 @@ properties: 
    maxItems: 6

    $ref: /schemas/types.yaml#/definitions/uint32-array



  op-sink-microwatt:

    description: Sink required operating power in microwatt, if source can't

      offer the power, Capability Mismatch is set. Required for power sink and

      power dual role.



  accessory-mode-audio:

    type: boolean

    description: Whether the device supports Audio Adapter Accessory Mode. This
@@ -269,6 +239,20 @@ properties: 
      SNK_READY for non-pd link.

    type: boolean



  capabilities:

    description: A child node to contain all the selectable USB Power Delivery capabilities.

    type: object



    patternProperties:

      "^caps-[0-9]+$":

        description: Child nodes under "capabilities" node. Each node contains a selectable USB

          Power Delivery capability.

        type: object

        $ref: "#/$defs/capabilities"

        unevaluatedProperties: false



    additionalProperties: false



dependencies:

  sink-vdos-v1: [ sink-vdos ]

  sink-vdos: [ sink-vdos-v1 ]
@@ -276,7 +260,42 @@ dependencies: 
required:

  - compatible



$defs:

  capabilities:

    type: object



    properties:

      source-pdos:

        description: An array of u32 with each entry providing supported power

          source data object(PDO), the detailed bit definitions of PDO can be found

          in "Universal Serial Bus Power Delivery Specification" chapter 6.4.1.2

          Source_Capabilities Message, the order of each entry(PDO) should follow

          the PD spec chapter 6.4.1. Required for power source and power dual role.

          User can specify the source PDO array via PDO_FIXED/BATT/VAR/PPS_APDO()

          defined in dt-bindings/usb/pd.h.

        minItems: 1

        maxItems: 7

        $ref: /schemas/types.yaml#/definitions/uint32-array



      sink-pdos:

        description: An array of u32 with each entry providing supported power sink

          data object(PDO), the detailed bit definitions of PDO can be found in

          "Universal Serial Bus Power Delivery Specification" chapter 6.4.1.3

          Sink Capabilities Message, the order of each entry(PDO) should follow the

          PD spec chapter 6.4.1. Required for power sink and power dual role. User

          can specify the sink PDO array via PDO_FIXED/BATT/VAR/PPS_APDO() defined

          in dt-bindings/usb/pd.h.

        minItems: 1

        maxItems: 7

        $ref: /schemas/types.yaml#/definitions/uint32-array



      op-sink-microwatt:

        description: Sink required operating power in microwatt, if source can't

          offer the power, Capability Mismatch is set. Required for power sink and

          power dual role.



allOf:

  - $ref: "#/$defs/capabilities"

  - if:

      properties:

        compatible:
@@ -305,7 +324,7 @@ anyOf: 
        - typec-power-opmode

        - new-source-frs-typec-current



additionalProperties: false

unevaluatedProperties: false



examples:

  # Micro-USB connector with HS lines routed via controller (MUIC).