Commit b0864e1a authored by Serge Semin's avatar Serge Semin Committed by Greg Kroah-Hartman
Browse files

dt-bindings: usb: Convert generic USB properties to DT schemas 



The generic USB properties have been described in the legacy bindings
text file: Documentation/devicetree/bindings/usb/generic.txt . Let's
convert its content into the generic USB, USB HCD and USB DRD DT
schemas. So the Generic USB schema will be applicable to all USB
controllers, USB HCD - for the generic USB Host controllers and the USB
DRD - for the USB Dual-role controllers.

Note the USB DRD schema is supposed to work in conjunction with
the USB peripheral/gadget and USB host controllers DT schemas.

Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarSerge Semin <Sergey.Semin@baikalelectronics.ru>
Link: https://lore.kernel.org/r/20201210090944.16283-3-Sergey.Semin@baikalelectronics.ru


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

Documentation/devicetree/bindings/usb/generic.txt

deleted100644 → 0
+0 −57
Original line number Diff line number Diff line 
Generic USB Properties



Optional properties:

 - maximum-speed: tells USB controllers we want to work up to a certain

			speed. Valid arguments are "super-speed-plus",

			"super-speed", "high-speed", "full-speed" and

			"low-speed". In case this isn't passed via DT, USB

			controllers should default to their maximum HW

			capability.

 - dr_mode: tells Dual-Role USB controllers that we want to work on a

			particular mode. Valid arguments are "host",

			"peripheral" and "otg". In case this attribute isn't

			passed via DT, USB DRD controllers should default to

			OTG.

 - phy_type: tells USB controllers that we want to configure the core to support

			a UTMI+ PHY with an 8- or 16-bit interface if UTMI+ is

			selected. Valid arguments are "utmi" and "utmi_wide".

			In case this isn't passed via DT, USB controllers should

			default to HW capability.

 - otg-rev: tells usb driver the release number of the OTG and EH supplement

			with which the device and its descriptors are compliant,

			in binary-coded decimal (i.e. 2.0 is 0200H). This

			property is used if any real OTG features(HNP/SRP/ADP)

			is enabled, if ADP is required, otg-rev should be

			0x0200 or above.

 - companion: phandle of a companion

 - hnp-disable: tells OTG controllers we want to disable OTG HNP, normally HNP

			is the basic function of real OTG except you want it

			to be a srp-capable only B device.

 - srp-disable: tells OTG controllers we want to disable OTG SRP, SRP is

			optional for OTG device.

 - adp-disable: tells OTG controllers we want to disable OTG ADP, ADP is

			optional for OTG device.

 - usb-role-switch: boolean, indicates that the device is capable of assigning

			the USB data role (USB host or USB device) for a given

			USB connector, such as Type-C, Type-B(micro).

			see connector/usb-connector.yaml.

 - role-switch-default-mode: indicating if usb-role-switch is enabled, the

			device default operation mode of controller while usb

			role is USB_ROLE_NONE. Valid arguments are "host" and

			"peripheral". Defaults to "peripheral" if not

			specified.





This is an attribute to a USB controller such as:



dwc3@4a030000 {

	compatible = "synopsys,dwc3";

	reg = <0x4a030000 0xcfff>;

	interrupts = <0 92 4>

	usb-phy = <&usb2_phy>, <&usb3,phy>;

	maximum-speed = "super-speed";

	dr_mode = "otg";

	phy_type = "utmi_wide";

	otg-rev = <0x0200>;

	adp-disable;

};

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

0 → 100644
+77 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0

%YAML 1.2

---

$id: http://devicetree.org/schemas/usb/usb-drd.yaml#

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



title: Generic USB OTG Controller Device Tree Bindings



maintainers:

  - Greg Kroah-Hartman <gregkh@linuxfoundation.org>



properties:

  otg-rev:

    description:

      Tells usb driver the release number of the OTG and EH supplement with

      which the device and its descriptors are compliant, in binary-coded

      decimal (i.e. 2.0 is 0200H). This property is used if any real OTG

      features (HNP/SRP/ADP) is enabled. If ADP is required, otg-rev should be

      0x0200 or above.

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



  dr_mode:

    description:

      Tells Dual-Role USB controllers that we want to work on a particular

      mode. In case this attribute isn't passed via DT, USB DRD controllers

      should default to OTG.

    $ref: /schemas/types.yaml#/definitions/string

    enum: [host, peripheral, otg]



  hnp-disable:

    description:

      Tells OTG controllers we want to disable OTG HNP. Normally HNP is the

      basic function of real OTG except you want it to be a srp-capable only B

      device.

    type: boolean



  srp-disable:

    description:

      Tells OTG controllers we want to disable OTG SRP. SRP is optional for OTG

      device.

    type: boolean



  adp-disable:

    description:

      Tells OTG controllers we want to disable OTG ADP. ADP is optional for OTG

      device.

    type: boolean



  usb-role-switch:

    description:

      Indicates that the device is capable of assigning the USB data role

      (USB host or USB device) for a given USB connector, such as Type-C,

      Type-B(micro). See connector/usb-connector.yaml.



  role-switch-default-mode:

    description:

      Indicates if usb-role-switch is enabled, the device default operation

      mode of controller while usb role is USB_ROLE_NONE.

    $ref: /schemas/types.yaml#/definitions/string

    enum: [host, peripheral]

    default: peripheral



additionalProperties: true



examples:

  - |

    usb@4a030000 {

        compatible = "snps,dwc3";

        reg = <0x4a030000 0xcfff>;

        interrupts = <0 92 4>;

        usb-phy = <&usb2_phy>, <&usb3_phy>;

        maximum-speed = "super-speed";

        dr_mode = "otg";

        phy_type = "utmi_wide";

        otg-rev = <0x0200>;

        adp-disable;

    };

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

+5 −0
Original line number Diff line number Diff line
@@ -12,6 +12,11 @@ maintainers: 
allOf:

  - $ref: usb.yaml#



properties:

  companion:

    description: Phandle of a companion device

    $ref: /schemas/types.yaml#/definitions/phandle



additionalProperties: true



examples:

Documentation/devicetree/bindings/usb/usb.yaml

+22 −0
Original line number Diff line number Diff line
@@ -24,6 +24,28 @@ properties: 
    description:

      Name specifier for the USB PHY



  phy_type:

    description:

      Tells USB controllers that we want to configure the core to support a

      UTMI+ PHY with an 8- or 16-bit interface if UTMI+ is selected. In case

      this isn't passed via DT, USB controllers should default to HW

      capability.

    $ref: /schemas/types.yaml#/definitions/string

    enum: [utmi, utmi_wide]



  maximum-speed:

    description:

      Tells USB controllers we want to work up to a certain speed. In case this

      isn't passed via DT, USB controllers should default to their maximum HW

      capability.

    $ref: /schemas/types.yaml#/definitions/string

    enum:

      - low-speed

      - full-speed

      - high-speed

      - super-speed

      - super-speed-plus



additionalProperties: true



...