drivers: firmware: Clock control TISCI driver support

Support added for clock control using TISCI for devices using the binding
ti,k2g-sci-clk. This driver relies on the TISCI layer to make calls to the
DMSC core to set and get the clock rate and retrieve clock status.

Signed-off-by: Dave Joseph <[email protected]>

Author: Kronosblaster

drivers/clock_control/CMakeLists.txt

@@ -132,6 +132,7 @@ zephyr_library_sources_ifdef(CONFIG_CLOCK_CONTROL_SI32_PLL clock_control_si32_pl
 zephyr_library_sources_ifdef(CONFIG_CLOCK_CONTROL_SILABS_SERIES clock_control_silabs_series.c)
 zephyr_library_sources_ifdef(CONFIG_CLOCK_CONTROL_SILABS_SIWX91X clock_control_silabs_siwx91x.c)
 zephyr_library_sources_ifdef(CONFIG_CLOCK_CONTROL_SMARTBOND clock_control_smartbond.c)
+zephyr_library_sources_ifdef(CONFIG_CLOCK_CONTROL_TISCI clock_control_tisci.c)
 zephyr_library_sources_ifdef(CONFIG_CLOCK_CONTROL_WCH_RCC clock_control_wch_rcc.c)
 zephyr_library_sources_ifdef(CONFIG_SOC_SERIES_AGILEX clock_agilex.c)
 zephyr_library_sources_ifdef(CONFIG_SOC_SERIES_AGILEX clock_agilex_ll.c)

drivers/clock_control/Kconfig

@@ -74,6 +74,7 @@ source "drivers/clock_control/Kconfig.silabs"
 source "drivers/clock_control/Kconfig.siwx91x"
 source "drivers/clock_control/Kconfig.smartbond"
 source "drivers/clock_control/Kconfig.stm32"
+source "drivers/clock_control/Kconfig.tisci"
 source "drivers/clock_control/Kconfig.wch_rcc"
 source "drivers/clock_control/Kconfig.xec"
 # zephyr-keep-sorted-stop

drivers/clock_control/Kconfig.tisci

@@ -0,0 +1,9 @@
+# Copyright 2024 Texas Instruments Incorporated.
+# SPDX-License-Identifier: Apache-2.0
+
+config CLOCK_CONTROL_TISCI
+	bool "TI SCI Clock Control driver"
+	default y
+	depends on DT_HAS_TI_K2G_SCI_CLK_ENABLED
+	help
+	  Driver for TISCI based clock control.

drivers/clock_control/clock_control_tisci.c

@@ -0,0 +1,100 @@
+/*
+ * Copyright (c) 2025, Texas Instruments
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#define DT_DRV_COMPAT ti_k2g_sci_clk
+
+#include <zephyr/device.h>
+#include <zephyr/drivers/firmware/tisci/tisci.h>
+#include <zephyr/drivers/clock_control.h>
+#include <zephyr/drivers/clock_control/tisci_clock_control.h>
+#include <zephyr/devicetree.h>
+#include <zephyr/logging/log.h>
+
+LOG_MODULE_REGISTER(ti_k2g_sci_clk, CONFIG_CLOCK_CONTROL_LOG_LEVEL);
+
+static const struct device *dmsc = DEVICE_DT_GET(DT_NODELABEL(dmsc));
+
+static int tisci_get_rate(const struct device *dev, clock_control_subsys_t sys, uint32_t *rate)
+{
+	struct tisci_clock_config *req = (struct tisci_clock_config *)sys;
+	uint64_t temp_rate;
+	int ret;
+
+	ret = tisci_cmd_clk_get_freq(dmsc, req->dev_id, req->clk_id, &temp_rate);
+	if (ret) {
+		LOG_ERR("Failed to get clock freq: dev_id=%u clk_id=%u err=%d", req->dev_id,
+			req->clk_id, ret);
+		return ret;
+	}
+
+	*rate = (uint32_t)temp_rate;
+
+	return 0;
+}
+
+static int tisci_set_rate(const struct device *dev, void *sys, void *rate)
+{
+	struct tisci_clock_config *req = (struct tisci_clock_config *)sys;
+	uint64_t freq = *((uint64_t *)rate);
+	int ret;
+
+	ret = tisci_cmd_clk_set_freq(dmsc, req->dev_id, req->clk_id, freq, freq, freq);
+	if (ret) {
+		LOG_ERR("Failed to set clock freq: dev_id=%u clk_id=%u freq=%llu err=%d",
+			req->dev_id, req->clk_id, freq, ret);
+	}
+
+	return ret;
+}
+
+static enum clock_control_status tisci_get_status(const struct device *dev,
+						  clock_control_subsys_t sys)
+{
+	struct tisci_clock_config *req = (struct tisci_clock_config *)sys;
+	bool req_state = true;
+	bool curr_state = true;
+	int ret;
+
+	ret = tisci_cmd_clk_is_on(dmsc, req->clk_id, req->dev_id, &req_state, &curr_state);
+	if (ret) {
+		LOG_ERR("Failed to get clock ON status: dev_id=%u clk_id=%u err=%d", req->dev_id,
+			req->clk_id, ret);
+		return CLOCK_CONTROL_STATUS_UNKNOWN;
+	}
+	if (curr_state) {
+		return CLOCK_CONTROL_STATUS_ON;
+	}
+	if (req_state && !curr_state) {
+		return CLOCK_CONTROL_STATUS_STARTING;
+	}
+
+	curr_state = true;
+
+	ret = tisci_cmd_clk_is_off(dmsc, req->clk_id, req->dev_id, NULL, &curr_state);
+	if (ret) {
+		LOG_ERR("Failed to get clock OFF status: dev_id=%u clk_id=%u err=%d", req->dev_id,
+			req->clk_id, ret);
+		return CLOCK_CONTROL_STATUS_UNKNOWN;
+	}
+
+	if (curr_state) {
+		return CLOCK_CONTROL_STATUS_OFF;
+	}
+
+	return CLOCK_CONTROL_STATUS_UNKNOWN;
+}
+
+static DEVICE_API(clock_control, tisci_clock_driver_api) = {
+	.get_rate = tisci_get_rate,
+	.set_rate = tisci_set_rate,
+	.get_status = tisci_get_status
+};
+
+#define TI_K2G_SCI_CLK_INIT(_n)                                                                    \
+	DEVICE_DT_INST_DEFINE(_n, NULL, NULL, NULL, NULL, PRE_KERNEL_1,                            \
+			      CONFIG_CLOCK_CONTROL_INIT_PRIORITY, &tisci_clock_driver_api);
+
+DT_INST_FOREACH_STATUS_OKAY(TI_K2G_SCI_CLK_INIT)

dts/bindings/clock/ti,k2g-sci-clk.yaml

@@ -0,0 +1,22 @@
+# Copyright 2025 Texas Instruments Incorporated.
+# SPDX-License-Identifier: Apache-2.0
+
+description: TI-SCI clock controller
+
+compatible: "ti,k2g-sci-clk"
+
+include:
+  - clock-controller.yaml
+  - base.yaml
+
+properties:
+  "#clock-cells":
+    type: int
+    required: true
+    description: >
+      Number of cells required to specify a clock provided by this controller.
+    const: 2
+
+clock-cells:
+  - devid
+  - clkid

include/zephyr/drivers/clock_control/tisci_clock_control.h

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2025 Texas Instruments
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#ifndef ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_TISCI_CLOCK_CONTROL_H_
+#define ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_TISCI_CLOCK_CONTROL_H_
+
+#include <stdint.h>
+
+/**
+ * @struct tisci_clock_config
+ * @brief Clock configuration structure
+ *
+ * This structure is used to define the configuration for a clock, including
+ * the device ID and clock ID.
+ *
+ * @param tisci_clock_config::dev_id
+ * Device ID associated with the clock.
+ *
+ * @param tisci_clock_config::clk_id
+ * Clock ID within the device.
+ */
+struct tisci_clock_config {
+	uint32_t dev_id;
+	uint32_t clk_id;
+};
+
+#define TISCI_GET_CLOCK(node_id) DEVICE_DT_GET(DT_PHANDLE(node_id, clocks))
+
+#define TISCI_GET_CLOCK_DETAILS(node_id)	\
+	{	\
+		.dev_id = DT_CLOCKS_CELL(node_id, devid),	\
+		.clk_id = DT_CLOCKS_CELL(node_id, clkid)	\
+	}
+
+#define TISCI_GET_CLOCK_BY_INST(inst) TISCI_GET_CLOCK(DT_DRV_INST(inst))
+
+#define TISCI_GET_CLOCK_DETAILS_BY_INST(DT_DRV_INST) TISCI_GET_CLOCK_DETAILS(DT_DRV_INST(inst))
+
+#endif