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:   Liu Ying <victor.liu@nxp.com>
To:     devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
        linux-kernel@vger.kernel.org
Cc:     robh+dt@kernel.org, krzysztof.kozlowski+dt@linaro.org,
        shawnguo@kernel.org, s.hauer@pengutronix.de, kernel@pengutronix.de,
        festevam@gmail.com, linux-imx@nxp.com, saravanak@google.com,
        gregkh@linuxfoundation.org, geert+renesas@glider.be,
        krzysztof.kozlowski@linaro.org
Subject: [PATCH v2 3/3] dt-bindings: bus: Add Freescale i.MX8qxp pixel link MSI bus binding
Date:   Wed,  3 Aug 2022 09:24:21 +0800
Message-Id: <20220803012421.3410226-4-victor.liu@nxp.com>
In-Reply-To: <20220803012421.3410226-1-victor.liu@nxp.com>
References: <20220803012421.3410226-1-victor.liu@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?nSKcYp1lOiDcpcvOt2SALyMum/EmPFB7ucq4ZEdr3TgUVpfC7FIdHsbb5gy9?=
 =?us-ascii?Q?leEWRJISKlsDlEQw3o1AfLm3y9f6VcMg57K+AFWyWptVm+QsLIRdSjxgFcFw?=
 =?us-ascii?Q?NcSmWfRbbHbhkbKI0Uzn7ofbkpU2lttpXXPkxfd/3ki6KtdF898wbJ/ysHTH?=
 =?us-ascii?Q?jxGo+99MEef2j+YLbIWCrPxCZ9BaMTUgPCAXbU2zagmFdkN+mrH7tB5UbKIk?=
 =?us-ascii?Q?fUYzqsGhh5Zq9SQBjduWdOGhen/LPEfO2clTw1KHnlthmMKzYG55fcBVoRhE?=
 =?us-ascii?Q?VgB9ehA8wl9wxceFP0JASSvhModC8GynjbSx8kxBTREGaldmmJ40Rfw6u8To?=
 =?us-ascii?Q?XmVHKn1UN5VuWIpMamaloWHG/fHk0RYK6QTyAdupBo+BLBkoTIpXYnc2GWTk?=
 =?us-ascii?Q?hqd3fWadszDW0TX0MNvEzHFlr6zRss3x4zCp1ZWOBL9LitkaqX2hFQYyyReB?=
 =?us-ascii?Q?wkGz3+XELKa8PWse9Xu1io6Gi2CGk1YATiuohWPXFssueS2xj7n97dx/cSgN?=
 =?us-ascii?Q?yDEpL38K46ZsHnvketNWUGkjLWZ3ZyIxklf1K1/7IYWgta+hZ85EF8l2Tso/?=
 =?us-ascii?Q?ddPBRVOfVGXwWnStGlFCeNe2EnP3GnZDn8aw5sWqeWok2lqg2bQ5kKJM9vd4?=
 =?us-ascii?Q?pab106h6U+kaOZIOIgMvJActO6HThtAafo51aUGv1SfWxeayaXnb5+wxMpWV?=
 =?us-ascii?Q?iXNVYIT7v3SF+OHu1OIur7R4QhpLxjSo8N1WO359YY5MTsOSr5P5hzmC4gwg?=
 =?us-ascii?Q?tQlHcij0W4dL6x2hBjbEB2Ec24YP1Ux94e9MOOLOV3nYTioAplUy5ayyBilx?=
 =?us-ascii?Q?VcFC+BrKwwKnCOfJ5JYknQfQ0bvZECDP71jjECIHMC/uKE8d8+5O9qw5i08S?=
 =?us-ascii?Q?Wyl09ciy9EKyzhK025hLFmV0Fbm5Uz5pq2Rg2OwhZ/vcwpZt0OaWx2x6YokL?=
 =?us-ascii?Q?2Sh3H3fIf3ZI0zEDaAZ2aFRXwISYvk9/fJhxKh8kmDYX2oEHgVOJWDD0BhxK?=
 =?us-ascii?Q?AgeQjRf4kUvTndKpNIfKGbTgDMWzllcuPV0R56/iME+Aa51R5AjJAb+PlSQX?=
 =?us-ascii?Q?61V4B1iZaj9tYo4Ktbga1l/NH+aNrLn2n9vkYbVDmgZ1pAIy6CdNzs7zdGPR?=
 =?us-ascii?Q?Q0XPnFMd3PiGjc0omI9caGD8VVmxLDXY9XEuKtSnmthTSvJ0lfC+scmo45Hi?=
 =?us-ascii?Q?QrXmr+QZj8d/SGFr8WzjsgHuyDJOLShxlizKsJLBChOqxrVcSk50Hti4p5F6?=
 =?us-ascii?Q?r6Srbww2bBqGGvDGDTUMLu9iUBz1XjqZ1U3shgMVsy0IA0WEiUBQP1UnIEX4?=
 =?us-ascii?Q?8Akwn7pa5KCla4wHB2cM07Da/Q5lHZTXLRfIVNpKz6KkBtaGw6domEfLQp8f?=
 =?us-ascii?Q?7P3RbT5tkZkdUpxuJhO89HZXQWzBF04yve2ZWKIGVVY5VMKsf8xoqme5s6fq?=
 =?us-ascii?Q?xmRikRiwESqw2WqSFVY9d9mROmbs9JIAroJn8ME9+L9MwGRD6j08N9ObSIym?=
 =?us-ascii?Q?yjhG9htIUVO9OeIsUCxXQaChvFgAn0Q9AXEzm4NCLlV5eTqX+wySq7EFtbMU?=
 =?us-ascii?Q?D96Nj6qu0F5ZWBTN/zCWYkOyrDV2ieLPUAtMYztt?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 7659afe3-4880-40f6-8393-08da74eeb26a
X-MS-Exchange-CrossTenant-AuthSource: AM7PR04MB7046.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Aug 2022 01:22:57.3198
 (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: VDplbtHiB4bE7TMCP8zwys3roe5vlOtVX78/fQHWtAwVQ4pKByI9joHoTPdlZTHX3nzuWgjbKV0dVTVmmivBJw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB8PR04MB6891
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=ham
        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

Freescale i.MX8qxp pixel link MSI bus is a simple memory-mapped bus.
It is used to access peripherals in i.MX8qm/qxp imaging, LVDS, MIPI
DSI and HDMI TX subsystems, like I2C controller, PWM controller,
MIPI DSI controller and Control and Status Registers (CSR) module.

Reference simple-pm-bus bindings and add Freescale i.MX8qxp pixel
link MSI bus specific bindings.

Signed-off-by: Liu Ying <victor.liu@nxp.com>
---
v1->v2:
Address Krzysztof's comments:
* Add a select to explicitly select the MSI bus dt-binding.
* List 'simple-pm-bus' explicitly as one item of compatible strings.
* Require compatible and reg properties.
* Put reg property just after compatible property in example.

 .../bus/fsl,imx8qxp-pixel-link-msi-bus.yaml   | 97 +++++++++++++++++++
 1 file changed, 97 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/bus/fsl,imx8qxp-pixel-link-msi-bus.yaml

diff --git a/Documentation/devicetree/bindings/bus/fsl,imx8qxp-pixel-link-msi-bus.yaml b/Documentation/devicetree/bindings/bus/fsl,imx8qxp-pixel-link-msi-bus.yaml
new file mode 100644
index 000000000000..358c032041e5
--- /dev/null
+++ b/Documentation/devicetree/bindings/bus/fsl,imx8qxp-pixel-link-msi-bus.yaml
@@ -0,0 +1,97 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/bus/fsl,imx8qxp-pixel-link-msi-bus.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale i.MX8qxp Pixel Link Medium Speed Interconnect (MSI) Bus
+
+maintainers:
+  - Liu Ying <victor.liu@nxp.com>
+
+description: |
+  i.MX8qxp pixel link MSI bus is used to control settings of PHYs, I/Os
+  sitting together with the PHYs.  It is not the same as the MSI bus coming
+  from i.MX8 System Controller Unit (SCU) which is used to control power,
+  clock and reset through the i.MX8 Distributed Slave System Controller (DSC).
+
+  i.MX8qxp pixel link MSI bus is a simple memory-mapped bus. Two input clocks,
+  that is, MSI clock and AHB clock, need to be enabled so that peripherals
+  connected to the bus can be accessed. Also, the bus is part of a power
+  domain. The power domain needs to be enabled before the peripherals can
+  be accessed.
+
+  Peripherals in i.MX8qm/qxp imaging, LVDS, MIPI DSI and HDMI TX subsystems,
+  like I2C controller, PWM controller, MIPI DSI controller and Control and
+  Status Registers (CSR) module, are accessed through the bus.
+
+  The i.MX System Controller Firmware (SCFW) owns and uses the i.MX8qm/qxp
+  pixel link MSI bus controller and does not allow SCFW user to control it.
+  So, the controller's registers cannot be accessed by SCFW user. Hence,
+  the interrupts generated by the controller don't make any sense from SCFW
+  user's point of view.
+
+allOf:
+  - $ref: simple-pm-bus.yaml#
+
+# We need a select here so we don't match all nodes with 'simple-pm-bus'.
+select:
+  properties:
+    compatible:
+      contains:
+        enum:
+          - fsl,imx8qxp-display-pixel-link-msi-bus
+          - fsl,imx8qm-display-pixel-link-msi-bus
+  required:
+    - compatible
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - fsl,imx8qxp-display-pixel-link-msi-bus
+          - fsl,imx8qm-display-pixel-link-msi-bus
+      - const: simple-pm-bus
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: master gated clock from system
+      - description: AHB clock
+
+  clock-names:
+    items:
+      - const: msi
+      - const: ahb
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - power-domains
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/imx8-lpcg.h>
+    #include <dt-bindings/firmware/imx/rsrc.h>
+    bus@56200000 {
+        compatible = "fsl,imx8qxp-display-pixel-link-msi-bus", "simple-pm-bus";
+        reg = <0x56200000 0x20000>;
+        #address-cells = <1>;
+        #size-cells = <1>;
+        interrupt-parent = <&dc0_irqsteer>;
+        interrupts = <320>;
+        ranges;
+        clocks = <&dc0_disp_ctrl_link_mst0_lpcg IMX_LPCG_CLK_4>,
+                 <&dc0_disp_ctrl_link_mst0_lpcg IMX_LPCG_CLK_4>;
+        clock-names = "msi", "ahb";
+        power-domains = <&pd IMX_SC_R_DC_0>;
+    };
-- 
2.25.1