sc7180: Add clock driver

Add support for clock driver for SC7180

Developer/Reviewer, be aware of this patch from Napali:
https://review.coreboot.org/c/coreboot/+/31083/6

Change-Id: I3f39252c887c36e8af43bc49289795000e4638d8
Signed-off-by: Taniya Das <tdas@codeaurora.org>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/35496
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Julius Werner <jwerner@chromium.org>

5 files changed, 448 insertions, 1 deletions

diff --git a/src/soc/qualcomm/sc7180/Makefile.inc b/src/soc/qualcomm/sc7180/Makefile.inc
index 6d2a3e7c08..6b492d5784 100644
--- a/src/soc/qualcomm/sc7180/Makefile.inc
+++ b/src/soc/qualcomm/sc7180/Makefile.inc
@@ -8,12 +8,14 @@ bootblock-y += timer.c
 bootblock-y += spi.c
 bootblock-y += gpio.c
 bootblock-$(CONFIG_DRIVERS_UART) += uart_bitbang.c
+bootblock-y += clock.c
 
 ################################################################################
 verstage-y += timer.c
 verstage-y += spi.c
 verstage-y += gpio.c
 verstage-$(CONFIG_DRIVERS_UART) += uart_bitbang.c
+verstage-y += clock.c
 
 ################################################################################
 romstage-y += cbmem.c
@@ -25,6 +27,7 @@ romstage-y += mmu.c
 romstage-y += spi.c
 romstage-y += gpio.c
 romstage-$(CONFIG_DRIVERS_UART) += uart_bitbang.c
+romstage-y += clock.c
 
 ################################################################################
 ramstage-y += soc.c
@@ -32,6 +35,7 @@ ramstage-y += timer.c
 ramstage-y += spi.c
 ramstage-y += gpio.c
 ramstage-$(CONFIG_DRIVERS_UART) += uart_bitbang.c
+ramstage-y += clock.c
 
 ################################################################################
 
diff --git a/src/soc/qualcomm/sc7180/bootblock.c b/src/soc/qualcomm/sc7180/bootblock.c
index b9b86609ad..bf80bff706 100644
--- a/src/soc/qualcomm/sc7180/bootblock.c
+++ b/src/soc/qualcomm/sc7180/bootblock.c
@@ -14,9 +14,11 @@
  */
 
 #include <bootblock_common.h>
+#include <soc/clock.h>
 #include <soc/mmu.h>
 
 void bootblock_soc_init(void)
 {
 	sc7180_mmu_init();
+	clock_init();
 }
diff --git a/src/soc/qualcomm/sc7180/clock.c b/src/soc/qualcomm/sc7180/clock.c
new file mode 100644
index 0000000000..97b7b280ca
--- /dev/null
+++ b/src/soc/qualcomm/sc7180/clock.c
@@ -0,0 +1,227 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright 2019 Qualcomm Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 and
+ * only version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#include <assert.h>
+#include <commonlib/helpers.h>
+#include <device/mmio.h>
+#include <soc/clock.h>
+#include <types.h>
+
+#define DIV(div) (2 * div - 1)
+
+struct clock_config qup_cfg[] = {
+	{
+		.hz = 7372800,
+		.src = SRC_GPLL0_EVEN_300MHZ,
+		.div = DIV(1),
+		.m = 384,
+		.n = 15625,
+		.d_2 = 15625,
+	},
+	{
+		.hz = SRC_XO_HZ,	/* 19.2KHz */
+		.src = SRC_XO_19_2MHZ,
+		.div = DIV(1),
+	}
+};
+
+struct clock_config qspi_core_cfg[] = {
+	{
+		.hz = SRC_XO_HZ,	/* 19.2KHz */
+		.src = SRC_XO_19_2MHZ,
+		.div = DIV(1),
+	},
+	{
+		.hz = 100 * MHz,
+		.src = SRC_GPLL0_EVEN_300MHZ,
+		.div = DIV(3),
+	},
+	{
+		.hz = 150 * MHz,
+		.src = SRC_GPLL0_EVEN_300MHZ,
+		.div = DIV(2),
+	},
+	{
+		.hz = GPLL0_EVEN_HZ,	/* 300MHz */
+		.src = SRC_GPLL0_EVEN_300MHZ,
+		.div = DIV(1),
+	}
+};
+
+static int clock_configure_gpll0(void)
+{
+	setbits_le32(&gcc->gpll0.user_ctl_u, 1 << SCALE_FREQ_SHFT);
+
+	/* Keep existing GPLL0 configuration, in RUN mode @600Mhz. */
+	setbits_le32(&gcc->gpll0.user_ctl,
+			1 << CLK_CTL_GPLL_PLLOUT_EVEN_SHFT |
+			1 << CLK_CTL_GPLL_PLLOUT_MAIN_SHFT |
+			1 << CLK_CTL_GPLL_PLLOUT_ODD_SHFT);
+
+	return 0;
+}
+
+static int clock_configure_mnd(struct sc7180_clock *clk, uint32_t m, uint32_t n,
+				uint32_t d_2)
+{
+	struct sc7180_mnd_clock *mnd = (struct sc7180_mnd_clock *)clk;
+	setbits_le32(&clk->rcg_cfg,
+			RCG_MODE_DUAL_EDGE << CLK_CTL_CFG_MODE_SHFT);
+
+	write32(&mnd->m, m & CLK_CTL_RCG_MND_BMSK);
+	write32(&mnd->n, ~(n-m) & CLK_CTL_RCG_MND_BMSK);
+	write32(&mnd->d_2, ~(d_2) & CLK_CTL_RCG_MND_BMSK);
+
+	return 0;
+}
+
+static int clock_configure(struct sc7180_clock *clk,
+				struct clock_config *clk_cfg,
+				uint32_t hz, uint32_t num_perfs)
+{
+	uint32_t reg_val;
+	uint32_t idx;
+
+	for (idx = 0; idx < num_perfs; idx++)
+		if (hz <= clk_cfg[idx].hz)
+			break;
+
+	assert(hz == clk_cfg[idx].hz);
+
+	reg_val = (clk_cfg[idx].src << CLK_CTL_CFG_SRC_SEL_SHFT) |
+			(clk_cfg[idx].div << CLK_CTL_CFG_SRC_DIV_SHFT);
+
+	/* Set clock config */
+	write32(&clk->rcg_cfg, reg_val);
+
+	if (clk_cfg[idx].m != 0)
+		clock_configure_mnd(clk, clk_cfg[idx].m, clk_cfg[idx].n,
+				clk_cfg[idx].d_2);
+
+	/* Commit config to RCG*/
+	setbits_le32(&clk->rcg_cmd, BIT(CLK_CTL_CMD_UPDATE_SHFT));
+
+	return 0;
+}
+
+static bool clock_is_off(u32 *cbcr_addr)
+{
+	return (read32(cbcr_addr) & CLK_CTL_CBC_CLK_OFF_BMSK);
+}
+
+static int clock_enable_vote(void *cbcr_addr, void *vote_addr,
+				uint32_t vote_bit)
+{
+	/* Set clock vote bit */
+	setbits_le32(vote_addr, BIT(vote_bit));
+
+	/* Ensure clock is enabled */
+	while (clock_is_off(cbcr_addr))
+		;
+
+	return 0;
+}
+
+static int clock_enable(void *cbcr_addr)
+{
+	/* Set clock enable bit */
+	setbits_le32(cbcr_addr, BIT(CLK_CTL_CBC_CLK_EN_SHFT));
+
+	/* Ensure clock is enabled */
+	while (clock_is_off(cbcr_addr))
+		;
+
+	return 0;
+}
+
+void clock_reset_aop(void)
+{
+	/* Bring AOP out of RESET */
+	clrbits_le32(&aoss->aoss_cc_apcs_misc, BIT(AOP_RESET_SHFT));
+}
+
+void clock_configure_qspi(uint32_t hz)
+{
+	clock_configure(&gcc->qspi_core,
+			qspi_core_cfg, hz,
+			ARRAY_SIZE(qspi_core_cfg));
+	clock_enable(&gcc->qspi_cnoc_ahb_cbcr);
+	clock_enable(&gcc->qspi_core.cbcr);
+}
+
+int clock_reset_bcr(void *bcr_addr, bool reset)
+{
+	struct sc7180_bcr *bcr = bcr_addr;
+
+	if (reset)
+		setbits_le32(bcr, BIT(CLK_CTL_BCR_BLK_ARES_SHFT));
+	else
+		clrbits_le32(bcr, BIT(CLK_CTL_BCR_BLK_ARES_SHFT));
+
+	return 0;
+}
+
+void clock_configure_qup(int qup, uint32_t hz)
+{
+	int s = qup % QUP_WRAP1_S0;
+	struct sc7180_qupv3_clock *qup_clk = qup < QUP_WRAP1_S0 ?
+				&gcc->qup_wrap0_s[s] : &gcc->qup_wrap1_s[s];
+
+	clock_configure(&qup_clk->mnd_clk.clock, qup_cfg, hz,
+							ARRAY_SIZE(qup_cfg));
+}
+
+void clock_enable_qup(int qup)
+{
+	int s = qup % QUP_WRAP1_S0;
+	int clk_en_off = qup < QUP_WRAP1_S0 ?
+			QUPV3_WRAP0_CLK_ENA_S(s) : QUPV3_WRAP1_CLK_ENA_S(s);
+	struct sc7180_qupv3_clock *qup_clk = qup < QUP_WRAP1_S0 ?
+				&gcc->qup_wrap0_s[s] : &gcc->qup_wrap1_s[s];
+
+	clock_enable_vote(&qup_clk->mnd_clk, &gcc->apcs_clk_br_en1,
+							clk_en_off);
+}
+
+void clock_init(void)
+{
+	clock_configure_gpll0();
+
+	clock_enable_vote(&gcc->qup_wrap0_core_2x.cbcr,
+				&gcc->apcs_clk_br_en1,
+				QUPV3_WRAP0_CORE_2X_CLK_ENA);
+	clock_enable_vote(&gcc->qup_wrap0_core_cbcr,
+				&gcc->apcs_clk_br_en1,
+				QUPV3_WRAP0_CORE_CLK_ENA);
+	clock_enable_vote(&gcc->qup_wrap0_m_ahb_cbcr,
+				&gcc->apcs_clk_br_en1,
+				QUPV3_WRAP_0_M_AHB_CLK_ENA);
+	clock_enable_vote(&gcc->qup_wrap0_s_ahb_cbcr,
+				&gcc->apcs_clk_br_en1,
+				QUPV3_WRAP_0_S_AHB_CLK_ENA);
+
+	clock_enable_vote(&gcc->qup_wrap1_core_2x_cbcr,
+				&gcc->apcs_clk_br_en1,
+				QUPV3_WRAP1_CORE_2X_CLK_ENA);
+	clock_enable_vote(&gcc->qup_wrap1_core_cbcr,
+				&gcc->apcs_clk_br_en1,
+				QUPV3_WRAP1_CORE_CLK_ENA);
+	clock_enable_vote(&gcc->qup_wrap1_m_ahb_cbcr,
+				&gcc->apcs_clk_br_en1,
+				QUPV3_WRAP_1_M_AHB_CLK_ENA);
+	clock_enable_vote(&gcc->qup_wrap1_s_ahb_cbcr,
+				&gcc->apcs_clk_br_en1,
+				QUPV3_WRAP_1_S_AHB_CLK_ENA);
+}
diff --git a/src/soc/qualcomm/sc7180/include/soc/addressmap.h b/src/soc/qualcomm/sc7180/include/soc/addressmap.h
index ffacf55681..e3941899f6 100644
--- a/src/soc/qualcomm/sc7180/include/soc/addressmap.h
+++ b/src/soc/qualcomm/sc7180/include/soc/addressmap.h
@@ -1,7 +1,7 @@
 /*
  * This file is part of the coreboot project.
  *
- * Copyright (c) 2018-2019 Qualcomm Technologies
+ * Copyright (c) 2019 Qualcomm Technologies
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 2 and
diff --git a/src/soc/qualcomm/sc7180/include/soc/clock.h b/src/soc/qualcomm/sc7180/include/soc/clock.h
new file mode 100644
index 0000000000..39cde8c1bc
--- /dev/null
+++ b/src/soc/qualcomm/sc7180/include/soc/clock.h
@@ -0,0 +1,214 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright 2019 Qualcomm Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 and
+ * only version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#include <soc/addressmap.h>
+#include <types.h>
+
+#ifndef __SOC_QUALCOMM_SC7180_CLOCK_H__
+#define __SOC_QUALCOMM_SC7180_CLOCK_H__
+
+#define QUPV3_WRAP_0_M_AHB_CLK_ENA	6
+#define QUPV3_WRAP_0_S_AHB_CLK_ENA	7
+#define QUPV3_WRAP0_CORE_2X_CLK_ENA	9
+#define QUPV3_WRAP0_CORE_CLK_ENA	8
+#define QUPV3_WRAP1_CORE_2X_CLK_ENA	18
+#define QUPV3_WRAP1_CORE_CLK_ENA	19
+#define QUPV3_WRAP_1_M_AHB_CLK_ENA	20
+#define QUPV3_WRAP_1_S_AHB_CLK_ENA	21
+#define QUPV3_WRAP0_CLK_ENA_S(idx)	(10 + idx)
+#define QUPV3_WRAP1_CLK_ENA_S(idx)	(22 + idx)
+
+#define SRC_XO_HZ			(19200 * KHz)
+#define GPLL0_EVEN_HZ			(300 * MHz)
+#define GPLL0_MAIN_HZ			(600 * MHz)
+
+#define SRC_XO_19_2MHZ			0
+#define SRC_GPLL0_MAIN_600MHZ		1
+#define SRC_GPLL0_EVEN_300MHZ		6
+
+#define AOP_RESET_SHFT			0
+#define RCG_MODE_DUAL_EDGE		2
+
+#define SCALE_FREQ_SHFT			11
+
+struct sc7180_clock {
+	u32 cbcr;
+	u32 rcg_cmd;
+	u32 rcg_cfg;
+};
+
+struct sc7180_mnd_clock {
+	struct sc7180_clock clock;
+	u32 m;
+	u32 n;
+	u32 d_2;
+};
+
+struct sc7180_qupv3_clock {
+	struct sc7180_mnd_clock mnd_clk;
+	u8 _res[0x130 - 0x18];
+};
+
+struct sc7180_gpll {
+	u32 mode;
+	u32 l_val;
+	u32 cal_l_val;
+	u32 user_ctl;
+	u32 user_ctl_u;
+	u32 config_ctl;
+	u32 config_ctl_u;
+	u32 test_ctl;
+	u32 test_ctl_u;
+	u8 _res[0x1000 - 0x24];
+};
+
+struct sc7180_gcc {
+	struct sc7180_gpll gpll0;
+	u8 _res0[0xf000 - 0x1000];
+	u32 usb30_prim_bcr;
+	u8 _res1[0x17000 - 0xf004];
+	u32 qup_wrap0_bcr;
+	u32 qup_wrap0_m_ahb_cbcr;
+	u32 qup_wrap0_s_ahb_cbcr;
+	u32 qup_wrap0_core_cbcr;
+	u32 qup_wrap0_core_cdivr;
+	struct sc7180_clock qup_wrap0_core_2x;
+	u8 _res2[0x17030 - 0x17020];
+	struct sc7180_qupv3_clock qup_wrap0_s[6];
+	u8 _res3[0x18000 - 0x17750];
+	u32 qup_wrap1_bcr;
+	u32 qup_wrap1_core_2x_cbcr;
+	u32 qup_wrap1_core_cbcr;
+	u32 qup_wrap1_m_ahb_cbcr;
+	u32 qup_wrap1_s_ahb_cbcr;
+	struct sc7180_qupv3_clock qup_wrap1_s[6];
+	u8 _res4[0x18994 - 0x18734];
+	u32 qup_wrap1_core_cdivr;
+	u8 _res5[0x26000 - 0x18998];
+	u32 qusb2phy_prim_bcr;
+	u8 _res6[0x4b000 - 0x26004];
+	u32 qspi_bcr;
+	u32 qspi_cnoc_ahb_cbcr;
+	struct sc7180_clock qspi_core;
+	u8 _res7[0x50000 - 0x4b014];
+	u32 usb3_phy_prim_bcr;
+	u32 usb3phy_phy_prim_bcr;
+	u32 usb3_dp_phy_prim_bcr;
+	u32 usb3_phy_sec_bcr;
+	u32 usb3phy_phy_sec_bcr;
+	u32 usb3_dp_phy_sec_bcr;
+	u8 _res8[0x52008 - 0x50018];
+	u32 apcs_clk_br_en1;
+	u8 _res9[0x1000000 - 0x5200c];
+};
+check_member(sc7180_gcc, usb30_prim_bcr, 0xf000);
+check_member(sc7180_gcc, qup_wrap0_bcr, 0x17000);
+check_member(sc7180_gcc, qup_wrap1_bcr, 0x18000);
+check_member(sc7180_gcc, qup_wrap1_core_cdivr, 0x18994);
+check_member(sc7180_gcc, qusb2phy_prim_bcr, 0x26000);
+check_member(sc7180_gcc, usb3phy_phy_prim_bcr, 0x50004);
+check_member(sc7180_gcc, usb3_phy_prim_bcr, 0x50000);
+check_member(sc7180_gcc, apcs_clk_br_en1, 0x52008);
+
+struct sc7180_aoss {
+	u8 _res[0x5002c];
+	u32 aoss_cc_apcs_misc;
+};
+
+enum clk_ctl_gpll_user_ctl {
+	CLK_CTL_GPLL_PLLOUT_EVEN_BMSK = 0x2,
+	CLK_CTL_GPLL_PLLOUT_MAIN_SHFT = 0,
+	CLK_CTL_GPLL_PLLOUT_EVEN_SHFT = 1,
+	CLK_CTL_GPLL_PLLOUT_ODD_SHFT = 2
+};
+
+enum clk_ctl_cfg_rcgr {
+	CLK_CTL_CFG_HW_CTL_BMSK = 0x100000,
+	CLK_CTL_CFG_HW_CTL_SHFT = 20,
+	CLK_CTL_CFG_MODE_BMSK = 0x3000,
+	CLK_CTL_CFG_MODE_SHFT = 12,
+	CLK_CTL_CFG_SRC_SEL_BMSK = 0x700,
+	CLK_CTL_CFG_SRC_SEL_SHFT = 8,
+	CLK_CTL_CFG_SRC_DIV_BMSK = 0x1F,
+	CLK_CTL_CFG_SRC_DIV_SHFT = 0
+};
+
+enum clk_ctl_cmd_rcgr {
+	CLK_CTL_CMD_ROOT_OFF_BMSK = 0x80000000,
+	CLK_CTL_CMD_ROOT_OFF_SHFT = 31,
+	CLK_CTL_CMD_ROOT_EN_BMSK = 0x2,
+	CLK_CTL_CMD_ROOT_EN_SHFT = 1,
+	CLK_CTL_CMD_UPDATE_BMSK = 0x1,
+	CLK_CTL_CMD_UPDATE_SHFT  = 0
+};
+
+enum clk_ctl_cbcr {
+	CLK_CTL_CBC_CLK_OFF_BMSK = 0x80000000,
+	CLK_CTL_CBC_CLK_OFF_SHFT = 31,
+	CLK_CTL_CBC_CLK_EN_BMSK = 0x1,
+	CLK_CTL_CBC_CLK_EN_SHFT  = 0
+};
+
+enum clk_ctl_rcg_mnd {
+	CLK_CTL_RCG_MND_BMSK = 0xFFFF,
+	CLK_CTL_RCG_MND_SHFT = 0,
+};
+
+enum clk_ctl_bcr {
+	CLK_CTL_BCR_BLK_ARES_BMSK = 0x1,
+	CLK_CTL_BCR_BLK_ARES_SHFT = 0,
+};
+
+enum clk_qup {
+	QUP_WRAP0_S0,
+	QUP_WRAP0_S1,
+	QUP_WRAP0_S2,
+	QUP_WRAP0_S3,
+	QUP_WRAP0_S4,
+	QUP_WRAP0_S5,
+	QUP_WRAP1_S0,
+	QUP_WRAP1_S1,
+	QUP_WRAP1_S2,
+	QUP_WRAP1_S3,
+	QUP_WRAP1_S4,
+	QUP_WRAP1_S5,
+};
+
+struct clock_config {
+	uint32_t hz;
+	uint8_t src;
+	uint8_t div;
+	uint16_t m;
+	uint16_t n;
+	uint16_t d_2;
+};
+
+struct mdss_clock_config {
+	const char *clk_name;
+	uintptr_t rcgr;
+	uintptr_t cbcr;
+};
+
+static struct sc7180_gcc *const gcc = (void *)GCC_BASE;
+static struct sc7180_aoss *const aoss = (void *)AOSS_CC_BASE;
+
+void clock_init(void);
+void clock_reset_aop(void);
+void clock_configure_qspi(uint32_t hz);
+int clock_reset_bcr(void *bcr_addr, bool reset);
+void clock_configure_qup(int qup, uint32_t hz);
+void clock_enable_qup(int qup);
+
+#endif	// __SOC_QUALCOMM_SC7180_CLOCK_H__