feat(nxp-clk): add oscillator clock objects
The oscillator clock objects will be used to describe the FIRC, FXOSC,
and SIRC clocks, all of which are oscillators on S32CC SoCs.
Change-Id: Icf235cc9b8f1d95d2c0051ce9a7655fd120289b8
Signed-off-by: Ghennadi Procopciuc <ghennadi.procopciuc@nxp.com>
diff --git a/include/drivers/nxp/clk/s32cc/s32cc-clk-modules.h b/include/drivers/nxp/clk/s32cc/s32cc-clk-modules.h
new file mode 100644
index 0000000..1047bff
--- /dev/null
+++ b/include/drivers/nxp/clk/s32cc/s32cc-clk-modules.h
@@ -0,0 +1,75 @@
+/* SPDX-License-Identifier: BSD-3-Clause */
+/*
+ * Copyright 2020-2024 NXP
+ */
+#ifndef S32CC_CLK_MODULES_H
+#define S32CC_CLK_MODULES_H
+
+#include <inttypes.h>
+#include <stddef.h>
+
+#define MHZ UL(1000000)
+#define GHZ (UL(1000) * MHZ)
+
+enum s32cc_clkm_type {
+ s32cc_osc_t,
+ s32cc_clk_t,
+};
+
+enum s32cc_clk_source {
+ S32CC_FIRC,
+ S32CC_FXOSC,
+ S32CC_SIRC,
+};
+
+struct s32cc_clk_obj {
+ enum s32cc_clkm_type type;
+ uint32_t refcount;
+};
+
+struct s32cc_osc {
+ struct s32cc_clk_obj desc;
+ enum s32cc_clk_source source;
+ unsigned long freq;
+ void *base;
+};
+
+#define S32CC_OSC_INIT(SOURCE) \
+{ \
+ .desc = { \
+ .type = s32cc_osc_t, \
+ }, \
+ .source = (SOURCE), \
+}
+
+struct s32cc_clk {
+ struct s32cc_clk_obj desc;
+ struct s32cc_clk_obj *module;
+ struct s32cc_clk *pclock;
+ unsigned long min_freq;
+ unsigned long max_freq;
+};
+
+struct s32cc_clk_array {
+ unsigned long type_mask;
+ struct s32cc_clk **clks;
+ size_t n_clks;
+};
+
+#define S32CC_FREQ_MODULE(PARENT_MODULE, MIN_F, MAX_F) \
+{ \
+ .desc = { \
+ .type = s32cc_clk_t, \
+ }, \
+ .module = &(PARENT_MODULE).desc, \
+ .min_freq = (MIN_F), \
+ .max_freq = (MAX_F), \
+}
+
+#define S32CC_FREQ_MODULE_CLK(PARENT_MODULE, MIN_F, MAX_F) \
+ S32CC_FREQ_MODULE(PARENT_MODULE, MIN_F, MAX_F)
+
+#define S32CC_MODULE_CLK(PARENT_MODULE) \
+ S32CC_FREQ_MODULE_CLK(PARENT_MODULE, 0, 0)
+
+#endif /* S32CC_CLK_MODULES_H */
diff --git a/include/drivers/nxp/clk/s32cc/s32cc-clk-utils.h b/include/drivers/nxp/clk/s32cc/s32cc-clk-utils.h
new file mode 100644
index 0000000..aaf6c5f
--- /dev/null
+++ b/include/drivers/nxp/clk/s32cc/s32cc-clk-utils.h
@@ -0,0 +1,16 @@
+/* SPDX-License-Identifier: BSD-3-Clause */
+/*
+ * Copyright 2024 NXP
+ */
+#ifndef S32CC_CLK_UTILS_H
+#define S32CC_CLK_UTILS_H
+
+#include <s32cc-clk-modules.h>
+
+struct s32cc_clk *s32cc_get_clk_from_table(const struct s32cc_clk_array *const *clk_arr,
+ size_t size,
+ unsigned long clk_id);
+
+struct s32cc_clk *s32cc_get_arch_clk(unsigned long id);
+
+#endif /* S32CC_CLK_UTILS_H */