Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Frank Li <Frank.Li@nxp.com>
To:     frank.li@nxp.com
Cc:     devicetree@vger.kernel.org, festevam@gmail.com,
        imx@lists.linux.dev, kernel@pengutronix.de,
        krzysztof.kozlowski+dt@linaro.org, krzysztof.kozlowski@linaro.org,
        linux-arm-kernel@lists.infradead.org, linux-imx@nxp.com,
        linux-kernel@vger.kernel.org, robh+dt@kernel.org,
        s.hauer@pengutronix.de, shawnguo@kernel.org
Subject: [PATCH v5 1/3] dt-bindings: usb: cdns-imx8qm: add imx8qm cdns3 glue layer
Date:   Mon, 27 Mar 2023 10:55:21 -0400
Message-Id: <20230327145523.3121810-2-Frank.Li@nxp.com>
In-Reply-To: <20230327145523.3121810-1-Frank.Li@nxp.com>
References: <20230327145523.3121810-1-Frank.Li@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?hMF/lmwC5aXI5oiWyVfN+4pdAmFXtGDOUfbtjMMtfPzAhMb6rG7vAPSqzYnE?=
 =?us-ascii?Q?TerrvR1tQ3UvB9jYxgp79hM3ubh5aMZuP5JIDXi5SKEXbghcSj5YpvT+aZNx?=
 =?us-ascii?Q?3W6NlzXWJvfZu4whqarqEDrCoPud3eSJM9uLwoptaSwM+KiPGmfhGjWR1sE1?=
 =?us-ascii?Q?XkNelSCcAFPR4XmoLkfioSejxyyNCoUpOKNdwYEynwJOSkOA/2BVtyxsJaw7?=
 =?us-ascii?Q?xefrAKYmNTzn3MRUiTOrREz6IUyaB5/1CfyGX/xmjHzy7a0zI+tIHjdo/XCn?=
 =?us-ascii?Q?8zianKnYk5KhpvDgde0MzgMV0wP3l9RHib3zjY8d0U4+D9zpH3vDF8cE6ctk?=
 =?us-ascii?Q?xogXRZeV4tcksIziQJ58X8ztnwOxIlPJmuo6gbzrUt2QmzEyWZt2GFkxGhRr?=
 =?us-ascii?Q?sxpOSuIb4oWk5WyWhzZEdNyTts3Wc+pqjsT6zR6je5eeCKzm4AHSY6O7Z3og?=
 =?us-ascii?Q?PCjy/GtWB3SyRwcUcLT5BW+PJrHSdXMXuM4pa+Ou7TCZsz04JXJ8gtUt2hD/?=
 =?us-ascii?Q?5kXLB08dfHpFks96/085ED0uhhDB5I6Y4jzJUUGx/fnubTdneZUJAHCqyzeP?=
 =?us-ascii?Q?m9Q+KB8WA61Lf+0iPEHHR92F2bL6y/cu9H40Ti40cf4+2Hxwlb4MyzbEslTs?=
 =?us-ascii?Q?XJ8fWamAW7zVgBWFZxFeoLUIhzoWzdrFe3FQwoSJfUJJINxaKDm3d4dCLsn7?=
 =?us-ascii?Q?3mp5CJ4UCgBnkc9dhbNlGd26MiVj3sAxPP05P2GsuF+vMpsEX2LMPPa0F9b7?=
 =?us-ascii?Q?l3hVGm3ohdJXu/kE5LLEqPQXlSUYk+8Sh4+SC5MWksBAsJPIEedUEOOP/FSl?=
 =?us-ascii?Q?t5Z1+Gj/nqlVoMnQcrlpwklkUoTGDhWCGmI8ubZeh15LUjKhjuAO/gjW4Cii?=
 =?us-ascii?Q?BN7iIw/J4upPK19ZlqkAlUcBeYJRSL6BqIMJSaRszHHUhasGZv5ciHqdVm9i?=
 =?us-ascii?Q?RcQSUmpPC/oWgvrPKmzwE+XWU3tcFG5lYTcXy/kiqZ4KpazKIT7s9EgSnX1a?=
 =?us-ascii?Q?XBXWKhWFH1TfNOhK0ui8joh16vcS9T6HGUbc6cw3E9eNVg+TWG0EvNecjglP?=
 =?us-ascii?Q?M1KRebOwVH2HL3vC6ZTqTY5fograyafh1Avoeg/4Ou0mKRA80AlDAqWfnbgz?=
 =?us-ascii?Q?gheKRA30uxsVznCeMBe3CnYSgPkYcEA7bWvcZ3bsI9m7NPfdsTlqn7RfawwS?=
 =?us-ascii?Q?I37OsSRZ6hFXp0UO7TGCYldlIhJ0YLgmOUT+utriB+VU/j1o2JmGfzlO5mdV?=
 =?us-ascii?Q?FzH9pXtKyZlWT5qeTi6fiKql+qM7yWNWoEiApXaIXW3BDvNC98SR5XRNTK9Q?=
 =?us-ascii?Q?H9cqScSYjMRR2ZfxdHonbfjjRS4m7dz9ZFFpEOP5N6spoVuhMLKK8Ypp/veH?=
 =?us-ascii?Q?Z1+O0gQgMROKI6D82eJKDSN1XiQzNYYJHmellUzGbr8XdwEbgj+KTaJBoHSL?=
 =?us-ascii?Q?YlrX8jDdiGl8uiNiZwuKS8rjWniJjqSNh9ShGeE8Lk+OprS7ljAltHKpP9A3?=
 =?us-ascii?Q?gfPdrG4I6iZEThNcsm6gRDjEFxfR6/jRQh/Y5NezhtFL7+WJip/6Q2Lx6G1Y?=
 =?us-ascii?Q?efYOPC6djXmiiGKYrOb3X+/5WlgerYXkzn/2UaqJ?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 9b491f2d-4c4c-4bcb-1b94-08db2ed3582d
X-MS-Exchange-CrossTenant-AuthSource: AM6PR04MB4838.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 27 Mar 2023 14:55:45.7145
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: QPM/bnbrGO/BtKtIpq/cHlx109z+Wg4G+U4ABo9bsbrVW/SojorQcUaSQSzafF+/aKn5bQ+qezp49KHwFoSCuA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR04MB8640
X-Spam-Status: No, score=-0.2 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
        DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,
        SPF_HELO_PASS,SPF_PASS autolearn=unavailable autolearn_force=no
        version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

NXP imx8qm integrates 1 cdns3 IP. This is glue layer device bindings.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
---

Change from v4 to v5
- Use shorter clock name according to rob's comments

Change from v3 to v4
- Drop all clock-assign

Change from v2 to v3
- Drop two fixed frequency clocks, it is system reset value, no need set now.
If need, futher work/discuss on driver or dts change. It will not block this
basic enablement work.
- Drop lable
- Drop some descriptions
- Reg as second property.

Change from v1 to v2.
- new add binding doc

 .../bindings/usb/fsl,imx8qm-cdns3.yaml        | 103 ++++++++++++++++++
 1 file changed, 103 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/fsl,imx8qm-cdns3.yaml

diff --git a/Documentation/devicetree/bindings/usb/fsl,imx8qm-cdns3.yaml b/Documentation/devicetree/bindings/usb/fsl,imx8qm-cdns3.yaml
new file mode 100644
index 000000000000..ceb76394af60
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/fsl,imx8qm-cdns3.yaml
@@ -0,0 +1,103 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (c) 2020 NXP
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/fsl,imx8qm-cdns3.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP iMX8QM Soc USB Controller
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    const: fsl,imx8qm-usb3
+
+  reg:
+    items:
+      - description: Register set for iMX USB3 Platform Control
+
+  "#address-cells":
+    enum: [ 1, 2 ]
+
+  "#size-cells":
+    enum: [ 1, 2 ]
+
+  ranges: true
+
+  clocks:
+    items:
+      - description: Standby clock. Used during ultra low power states.
+      - description: USB bus clock for usb3 controller.
+      - description: AXI clock for AXI interface.
+      - description: ipg clock for register access.
+      - description: Core clock for usb3 controller.
+
+  clock-names:
+    items:
+      - const: lpm
+      - const: bus
+      - const: aclk
+      - const: ipg
+      - const: core
+
+  power-domains:
+    maxItems: 1
+
+# Required child node:
+
+patternProperties:
+  "^usb@[0-9a-f]+$":
+    $ref: cdns,usb3.yaml#
+
+required:
+  - compatible
+  - reg
+  - "#address-cells"
+  - "#size-cells"
+  - ranges
+  - clocks
+  - clock-names
+  - power-domains
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/imx8-lpcg.h>
+    #include <dt-bindings/firmware/imx/rsrc.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    usb@5b110000 {
+      compatible = "fsl,imx8qm-usb3";
+      reg = <0x5b110000 0x10000>;
+      ranges;
+      clocks = <&usb3_lpcg IMX_LPCG_CLK_1>,
+               <&usb3_lpcg IMX_LPCG_CLK_0>,
+               <&usb3_lpcg IMX_LPCG_CLK_7>,
+               <&usb3_lpcg IMX_LPCG_CLK_4>,
+               <&usb3_lpcg IMX_LPCG_CLK_5>;
+      clock-names = "lpm", "bus", "aclk", "ipg", "core";
+      assigned-clocks = <&clk IMX_SC_R_USB_2 IMX_SC_PM_CLK_MST_BUS>;
+      assigned-clock-rates = <250000000>;
+      power-domains = <&pd IMX_SC_R_USB_2>;
+      #address-cells = <1>;
+      #size-cells = <1>;
+
+      usb@5b120000 {
+        compatible = "cdns,usb3";
+        reg = <0x5b120000 0x10000>,   /* memory area for OTG/DRD registers */
+              <0x5b130000 0x10000>,   /* memory area for HOST registers */
+              <0x5b140000 0x10000>;   /* memory area for DEVICE registers */
+        reg-names = "otg", "xhci", "dev";
+        interrupt-parent = <&gic>;
+        interrupts = <GIC_SPI 271 IRQ_TYPE_LEVEL_HIGH>,
+                     <GIC_SPI 271 IRQ_TYPE_LEVEL_HIGH>,
+                     <GIC_SPI 271 IRQ_TYPE_LEVEL_HIGH>,
+                     <GIC_SPI 271 IRQ_TYPE_LEVEL_HIGH>;
+        interrupt-names = "host", "peripheral", "otg", "wakeup";
+        phys = <&usb3_phy>;
+        phy-names = "cdns3,usb3-phy";
+      };
+    };
-- 
2.34.1