arm64: NXP add LS1088a clockgen support

Add a driver for NXP LS1088a clockgen support which passes
configuration information to QorIQ clockgen class.
The implementaiton started off as copy of ls1028 support and was
adjusted accordingly.

Reviewed by:	dgr_semihalf.com (earlier), mmel
Sponsored by:	Traverse Technologies (providing Ten64 HW for testing)
Differential Revision: https://reviews.freebsd.org/D35617

(cherry picked from commit 8154df37a55948aca8358ade68b659d1aa71b755)

2 files changed, 274 insertions, 0 deletions

diff --git a/sys/arm64/qoriq/clk/ls1088a_clkgen.c b/sys/arm64/qoriq/clk/ls1088a_clkgen.c
new file mode 100644
index 000000000000..06e893504c35
--- /dev/null
+++ b/sys/arm64/qoriq/clk/ls1088a_clkgen.c
@@ -0,0 +1,273 @@
+/*-
+ * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
+ *
+ * Copyright (c) 2021 Alstom Group.
+ * Copyright (c) 2021 Semihalf.
+ * Copyright (c) 2022 Bjoern A. Zeeb
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+/*
+ * Based on QorIQ LS1088A Reference Manual, Rev. 1, 11/2020.
+ * [LS1088ARM.pdf]
+ */
+
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+#include <sys/param.h>
+#include <sys/bus.h>
+#include <sys/kernel.h>
+#include <sys/module.h>
+#include <sys/mutex.h>
+#include <sys/rman.h>
+#include <machine/bus.h>
+
+#include <dev/fdt/simplebus.h>
+
+#include <dev/ofw/ofw_bus.h>
+#include <dev/ofw/ofw_bus_subr.h>
+
+#include <dev/extres/clk/clk_fixed.h>
+
+#include <arm64/qoriq/clk/qoriq_clkgen.h>
+
+static uint8_t ls1088a_pltfrm_pll_divs[] = {
+	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 0
+};
+
+static struct qoriq_clk_pll_def ls1088a_pltfrm_pll = {
+	.clkdef = {
+		.name = "ls1088a_platform_pll",
+		.id = QORIQ_CLK_ID(QORIQ_TYPE_PLATFORM_PLL, 0),
+		.flags = 0
+	},
+	.offset = 0x60080,
+	.shift = 1,
+	.mask = 0xFE,
+	.dividers = ls1088a_pltfrm_pll_divs,
+	.flags = QORIQ_CLK_PLL_HAS_KILL_BIT
+};
+
+static const uint8_t ls1088a_cga_pll_divs[] = {
+	2, 3, 4, 0
+};
+
+static struct qoriq_clk_pll_def ls1088a_cga_pll1 = {
+	.clkdef = {
+		.name = "ls1088a_cga_pll1",
+		.id = QORIQ_CLK_ID(QORIQ_TYPE_INTERNAL, 0),
+		.flags = 0
+	},
+	.offset = 0x80,
+	.shift = 1,
+	.mask = 0xFE,
+	.dividers = ls1088a_cga_pll_divs,
+	.flags = QORIQ_CLK_PLL_HAS_KILL_BIT
+};
+
+static struct qoriq_clk_pll_def ls1088a_cga_pll2 = {
+	.clkdef = {
+		.name = "ls1088a_cga_pll2",
+		.id = QORIQ_CLK_ID(QORIQ_TYPE_INTERNAL, 20),
+		.flags = 0
+	},
+	.offset = 0xA0,
+	.shift = 1,
+	.mask = 0xFE,
+	.dividers = ls1088a_cga_pll_divs,
+	.flags = QORIQ_CLK_PLL_HAS_KILL_BIT
+};
+
+static struct qoriq_clk_pll_def *ls1088a_cga_plls[] = {
+	&ls1088a_cga_pll1,
+	&ls1088a_cga_pll2
+};
+
+
+/* 4.7.2 Core Cluster a Clock Control/Status Register (CLKC1CSR - CLKC2CSR) */
+static const char *ls1088a_cmux0_parent_names[] = {
+	"ls1088a_cga_pll1",
+	"ls1088a_cga_pll1_div2",
+	"ls1088a_cga_pll1_div4",
+	NULL,
+	"ls1088a_cga_pll2",
+	"ls1088a_cga_pll2_div2",
+	"ls1088a_cga_pll2_div4"
+};
+
+static struct clk_mux_def ls1088a_cmux0 = {
+	.clkdef = {
+		.name = "ls1088a_cmux0",
+		.id = QORIQ_CLK_ID(QORIQ_TYPE_CMUX, 0),
+		.parent_names = ls1088a_cmux0_parent_names,
+		.parent_cnt = nitems(ls1088a_cmux0_parent_names),
+		.flags = 0
+	},
+	.offset = 0x70000,
+	.shift = 27,
+	.width = 4,
+	.mux_flags = 0
+};
+
+static struct clk_mux_def ls1088a_cmux1 = {
+	.clkdef = {
+		.name = "ls1088a_cmux1",
+		.id = QORIQ_CLK_ID(QORIQ_TYPE_CMUX, 1),
+		.parent_names = ls1088a_cmux0_parent_names,
+		.parent_cnt = nitems(ls1088a_cmux0_parent_names),
+		.flags = 0
+	},
+	.offset = 0x70020,
+	.shift = 27,
+	.width = 4,
+	.mux_flags = 0
+};
+
+/* 4.4.2 HWAaCSR (HWA1CSR - HWA3CSR) */
+static const char *ls1088a_hwaccel1_parent_names[] = {
+	"ls1088a_platform_pll",
+	"ls1088a_cga_pll1",
+	"ls1088a_cga_pll1_div2",
+	"ls1088a_cga_pll1_div3",
+	"ls1088a_cga_pll1_div4",
+	NULL,	/* HWAMUX1 External Clock Source */
+	"ls1088a_cga_pll2_div2",
+	"ls1088a_cga_pll2_div3"
+};
+
+static const char *ls1088a_hwaccel2_parent_names[] = {
+	"ls1088a_platform_pll",
+	"ls1088a_cga_pll2",
+	"ls1088a_cga_pll2_div2",
+	"ls1088a_cga_pll2_div3",
+	"ls1088a_cga_pll2_div4",
+	NULL,	/* HWAMUX2 External Clock Source */
+	"ls1088a_cga_pll1_div2",
+	"ls1088a_cga_pll1_div3"
+};
+
+static const char *ls1088a_hwaccel3_parent_names[] = {
+	"ls1088a_platform_pll",
+	NULL,
+	NULL,
+	NULL,
+	NULL,
+	NULL,	/* HWAMUX3 External Clock Source */
+	"ls1088a_cga_pll2_div2",
+	"ls1088a_cga_pll2_div3"
+};
+
+static struct clk_mux_def ls1088a_hwaccel1 = {
+	.clkdef = {
+		.name = "ls1088a_hwaccel1",
+		.id = QORIQ_CLK_ID(QORIQ_TYPE_HWACCEL, 0),
+		.parent_names = ls1088a_hwaccel1_parent_names,
+		.parent_cnt = nitems(ls1088a_hwaccel1_parent_names),
+		.flags = 0
+	},
+	.offset = 0x10,
+	.shift = 27,
+	.width = 4,
+	.mux_flags = 0
+};
+
+static struct clk_mux_def ls1088a_hwaccel2 = {
+	.clkdef = {
+		.name = "ls1088a_hwaccel2",
+		.id = QORIQ_CLK_ID(QORIQ_TYPE_HWACCEL, 1),
+		.parent_names = ls1088a_hwaccel2_parent_names,
+		.parent_cnt = nitems(ls1088a_hwaccel2_parent_names),
+		.flags = 0
+	},
+	.offset = 0x30,
+	.shift = 27,
+	.width = 4,
+	.mux_flags = 0
+};
+
+static struct clk_mux_def ls1088a_hwaccel3 = {
+	.clkdef = {
+		.name = "ls1088a_hwaccel3",
+		.id = QORIQ_CLK_ID(QORIQ_TYPE_HWACCEL, 2),
+		.parent_names = ls1088a_hwaccel3_parent_names,
+		.parent_cnt = nitems(ls1088a_hwaccel3_parent_names),
+		.flags = 0
+	},
+	.offset = 0x50,
+	.shift = 27,
+	.width = 4,
+	.mux_flags = 0
+};
+
+
+static struct clk_mux_def *ls1088a_mux_nodes[] = {
+	&ls1088a_cmux0,
+	&ls1088a_cmux1,
+	&ls1088a_hwaccel1,
+	&ls1088a_hwaccel2,
+	&ls1088a_hwaccel3
+};
+
+static int
+ls1088a_clkgen_probe(device_t dev)
+{
+
+	if (!ofw_bus_status_okay(dev))
+		return (ENXIO);
+
+	if(!ofw_bus_is_compatible(dev, "fsl,ls1088a-clockgen"))
+		return (ENXIO);
+
+	device_set_desc(dev, "LS1088A clockgen");
+	return (BUS_PROBE_DEFAULT);
+}
+
+static int
+ls1088a_clkgen_attach(device_t dev)
+{
+	struct qoriq_clkgen_softc *sc;
+
+	sc = device_get_softc(dev);
+
+	sc->pltfrm_pll_def = &ls1088a_pltfrm_pll;
+	sc->cga_pll = ls1088a_cga_plls;
+	sc->cga_pll_num = nitems(ls1088a_cga_plls);
+	sc->mux = ls1088a_mux_nodes;
+	sc->mux_num = nitems(ls1088a_mux_nodes);
+	sc->flags = QORIQ_LITTLE_ENDIAN;
+
+	return (qoriq_clkgen_attach(dev));
+}
+
+static device_method_t ls1088a_clkgen_methods[] = {
+	DEVMETHOD(device_probe,		ls1088a_clkgen_probe),
+	DEVMETHOD(device_attach,	ls1088a_clkgen_attach),
+
+	DEVMETHOD_END
+};
+
+DEFINE_CLASS_1(ls1088a_clkgen, ls1088a_clkgen_driver, ls1088a_clkgen_methods,
+    sizeof(struct qoriq_clkgen_softc), qoriq_clkgen_driver);
+
+EARLY_DRIVER_MODULE(ls1088a_clkgen, simplebus, ls1088a_clkgen_driver, 0, 0,
+    BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
diff --git a/sys/conf/files.arm64 b/sys/conf/files.arm64
index 4bcc4ef122cd..bd5713533f32 100644
--- a/sys/conf/files.arm64
+++ b/sys/conf/files.arm64
@@ -507,6 +507,7 @@ arm64/qoriq/qoriq_dw_pci.c			optional pci fdt SOC_NXP_LS
 arm64/qoriq/qoriq_therm.c			optional pci fdt SOC_NXP_LS
 arm64/qoriq/qoriq_therm_if.m			optional pci fdt SOC_NXP_LS
 arm64/qoriq/clk/ls1046a_clkgen.c		optional clk SOC_NXP_LS
+arm64/qoriq/clk/ls1088a_clkgen.c		optional clk SOC_NXP_LS
 arm64/qoriq/clk/lx2160a_clkgen.c		optional clk SOC_NXP_LS
 arm64/qoriq/clk/qoriq_clk_pll.c			optional clk SOC_NXP_LS
 arm64/qoriq/clk/qoriq_clkgen.c			optional clk SOC_NXP_LS