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:   Alex Helms <alexander.helms.jy@renesas.com>
To:     linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
        linux-clk@vger.kernel.org
Cc:     krzysztof.kozlowski+dt@linaro.org, robh+dt@kernel.org,
        sboyd@kernel.org, mturquette@baylibre.com, geert+renesas@glider.be,
        alexander.helms.jy@renesas.com
Subject: [PATCH 1/2] dtbindings: clock: Add bindings for Renesas PhiClock
Date:   Tue, 15 Nov 2022 12:26:24 -0700
Message-Id: <20221115192625.9410-2-alexander.helms.jy@renesas.com>
In-Reply-To: <20221115192625.9410-1-alexander.helms.jy@renesas.com>
References: <20221115192625.9410-1-alexander.helms.jy@renesas.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?iIUDOxf4+uQBVR36RZ/ios7YRzO8m+9ZnIpvWNFHXhz/lgwcpLUlu+R8d8xS?=
 =?us-ascii?Q?3moJl13QchVA8uJdAgOo5TJm0JOeuHGkYOd7V2PY/tN7WKqKXFHD317WNVuE?=
 =?us-ascii?Q?XYejos3j1oqq4axzqUiClAnyiaa2Hd7O03bSczHeOK7SSow/EKYg7ss9+Tn8?=
 =?us-ascii?Q?3AkJiR6G3QY/ZvUNLXHzfP7c5fH1lb375kmL9mkISuBT2LYQiGee03uzqyxw?=
 =?us-ascii?Q?YRXSivrC3frSvdsI4srCpARdPN3JjmmHqZ7PcFtO4kxduwJ5jNZ0fskmOpXz?=
 =?us-ascii?Q?MwFV8WL4le17FdjjfvI2GIQlNP5mcNMqkT1GqaVeRVIUFTTSBtQiJ83rB7aN?=
 =?us-ascii?Q?le5dtCTpmtnrkJrHS9IKN88WE4L7/UC+R9FyEa+ImsTDS3kPpdJ9lU0iJAI7?=
 =?us-ascii?Q?wM1I+0IORxH1JqftObeKUKyhcVxqmizUPaO4MrvKTFuh/wUeaT428K5oXLr9?=
 =?us-ascii?Q?os0dGVlSFNHtgsG3QfeJnGdCQYQXl8SAivq68gdgI26J53fC5exjPHHFDp+2?=
 =?us-ascii?Q?b58JuN3zIc/N/1tBp2c+dGiL4w8DKdGEI11Z/9cFHGpiU49cl+Z239qKI1TA?=
 =?us-ascii?Q?r3mnfc4tbQCSTQwRpmU8cleQMWlMw2v8qd/s4wCHiE3Ymrolcz4/vjJ14VEL?=
 =?us-ascii?Q?MDqAxLJ9kXq9lJ9hglsfjPeqFckBqCth1pPnh295vhfE7ZBjzlYCyGrR6kry?=
 =?us-ascii?Q?cSV5XNnMTAXuxHV3pkUYTGYljxzSXZ2EiGyf7NWEfc5VxQl8s72L4RrYY2Dn?=
 =?us-ascii?Q?dTHe9QF1uyWHkbT5znTmQvB0Bz4E6m4o1p+De9E0kHQbcutqFoiiDq/URkrK?=
 =?us-ascii?Q?C23FWWZBRj/cR3mrcqkkh0B8lsh+T7xN9Ux2pI+bSovX+Pt6ZYs16EMcu+Rt?=
 =?us-ascii?Q?4jB29i+uxiQHNaYSedZ20BvO2GrUQPO363fFqKGix9UVtm0ykfkGKkocYufY?=
 =?us-ascii?Q?8b1thZ1/7McpfiWg/Kh1nkvoMzPXw/y75oyUi7TOBIJGa/cAgUL7zmMQ9juj?=
 =?us-ascii?Q?MHAF3QvY6q0a37QCXxkiWqnsCa4wk2gK8879w3L0jq7umUe5cdWwxIpKk7LV?=
 =?us-ascii?Q?a5hB0C7i0U63t8VGGpS9WCydJxBuOeaysl8nnXzyu9xOvtDPMpUtWFxJCB5O?=
 =?us-ascii?Q?GaFAlArr06L+BAsdt/IXXU4eQ+l4X+cPCt5NAguwNsGV2zVd1Aj86nWxxFlq?=
 =?us-ascii?Q?lQ26aL+6Y61XfzhooslkP0G97fuHAZ9j0TqZlaO7CwndxJNjlik35WGJpzl7?=
 =?us-ascii?Q?yM+5+rFQxovOAUX3qJZKoIsWUmU0ii2CK/UaIJiXsNgJEbBYGF80oK77q2Y3?=
 =?us-ascii?Q?VX5mASm6WZ7BXJ1zagB9zDcedCSpH3SzvaTfi4oPicixVSnDoJSAFG0P7tfV?=
 =?us-ascii?Q?QpUkM3km2fAPzp4FjlsyfQUnUrAExLSD86eOuFw+d0SauKl2uyl74f1fsFHJ?=
 =?us-ascii?Q?GX8l58IhM4Gfpok7b/bND6zjPe/Lhp/iv+2PQWoHVXxXCwRv59hfikIzJokZ?=
 =?us-ascii?Q?2GzpTCKtOQcEUU6UaBVmBqdvHoaa5y/G+oich/gRB9+rvCT4AhUM/x5U9zhc?=
 =?us-ascii?Q?7Xk4uWEcQRlvwf0ngwnpaCeMWPmwtYlshDvoJ/aB3En8z2ZKEtgPVhx3JlmM?=
 =?us-ascii?Q?waRtMY/YzYJoV6Gi7mKXvHU=3D?=
X-OriginatorOrg: renesas.com
X-MS-Exchange-CrossTenant-Network-Message-Id: f7e01ab4-6478-49b4-409e-08dac73f544a
X-MS-Exchange-CrossTenant-AuthSource: OSAPR01MB3892.jpnprd01.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Nov 2022 19:26:43.8772
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 53d82571-da19-47e4-9cb4-625a166a4a2a
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Ht9LNrhWLQzp72n/jgeAX27X5HhKPL+USQCPoEpTbaMeaJC0Kazzb/xg9F632fhbHNFMU4O/63devwc9K/EX4p0lNrLabfNEhvoq+OPWYM0=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: TYWPR01MB10539
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,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

Add dt bindings for the Renesas PhiClock clock generator.

Signed-off-by: Alex Helms <alexander.helms.jy@renesas.com>
---
 .../bindings/clock/renesas,phiclock.yaml      | 81 +++++++++++++++++++
 MAINTAINERS                                   |  5 ++
 2 files changed, 86 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/renesas,phiclock.yaml

diff --git a/Documentation/devicetree/bindings/clock/renesas,phiclock.yaml b/Documentation/devicetree/bindings/clock/renesas,phiclock.yaml
new file mode 100644
index 000000000..2b36534d3
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/renesas,phiclock.yaml
@@ -0,0 +1,81 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/renesas,phiclock.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Renesas PhiClock Clock Generator Device Tree Bindings
+
+maintainers:
+  - Alex Helms <alexander.helms.jy@renesas.com>
+
+description: |
+  The Renesas PhiClock is a programmable I2C clock generator that provides
+  1 reference output and 2 clock outputs.
+
+  The driver supports spread spectrum but only if all configurations use the
+  same spread spectrum parameters. If your configuration uses spread spectrum,
+  you must include renesas,ss-amount-percent, renesas,ss-modulation-hz, and
+  renesas,ss-direction in the device tree.
+
+properties:
+  '#clock-cells':
+    const: 1
+
+  clock-names:
+    items:
+      - const: xin-clkin
+
+  clocks:
+    const: 1
+
+  compatible:
+    enum:
+      - renesas,9fgv1006
+
+  reg:
+    maxItems: 1
+
+  renesas,ss-amount-percent:
+    description: Spread spectrum absolute amount as hundredths of a percent, e.g. 150 is 1.50%.
+    minimum: 0
+    maximum: 500
+
+  renesas,ss-modulation-hz:
+    description: Spread spectrum modulation rate in Hz
+    minimum: 30000
+    maximum: 63000
+
+  renesas,ss-direction:
+    $ref: /schemas/types.yaml#/definitions/string
+    description: Spread spectrum direction
+    enum: [ down, center ]
+
+required:
+  - clock-names
+  - '#clock-cells'
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    ref25: ref25m {
+      compatible = "fixed-clock";
+      #clock-cells = <0>;
+      clock-frequency = <25000000>;
+    };
+
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      phiclock: clock-controller@68 {
+        compatible = "renesas,9fgv1006";
+        reg = <0x68>;
+        #clock-cells = <1>;
+        clocks = <&ref25>;
+        clock-names = "xin-clkin";
+      };
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index 256f03904..7eabe930b 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -17641,6 +17641,11 @@ S:	Maintained
 F:	Documentation/devicetree/bindings/clock/renesas,versaclock7.yaml
 F:	drivers/clk/clk-versaclock7.c
 
+RENESAS PHICLOCK CLOCK DRIVER
+M:	Alex Helms <alexander.helms.jy@renesas.com>
+S:	Maintained
+F:	Documentation/devicetree/bindings/clock/renesas,phiclock.yaml
+
 RESET CONTROLLER FRAMEWORK
 M:	Philipp Zabel <p.zabel@pengutronix.de>
 S:	Maintained
-- 
2.25.1