* [U-Boot] [PATCH 0/7 v5] Add TMU support for Exynos5250 based SMDK5250
@ 2013-01-21 11:11 Akshay Saraswat
2013-01-21 11:11 ` [U-Boot] [PATCH 1/7 v5] EXYNOS5: TMU: Add driver for Thermal Management Unit Akshay Saraswat
` (6 more replies)
0 siblings, 7 replies; 15+ messages in thread
From: Akshay Saraswat @ 2013-01-21 11:11 UTC (permalink / raw)
To: u-boot
This patch series adds support for TMU driver using device tree for Exynos5250
based SMDK5250 board.
Changes since v4:
- Patch-1:Changed return value of get_cur_temp() in case of 0 degree temp from -1 to TMU_STATUS_INIT.
- Patch-2:Changed API name from power_shutdown() to generic board_poweroff.
- Patch-3:Rebased.
- Patch-4:Replaced board polling with initial SoC temperature analysis for any possible threshold breach.
- Patch-5:Rebased.
- Patch-6:Removed tmu command and added to dtt.
- Patch-7:Replaced tmu command configs with corresponding dtt configs.
Akshay Saraswat (7):
EXYNOS5: TMU: Add driver for Thermal Management Unit
EXYNOS5: Implement board_poweroff for Thermal Management Unit
EXYNOS5: FDT: Add TMU device node values
EXYNOS5: TMU: Add TMU init and status check
EXYNOS5: Config: Enable support for Exynos TMU driver
TMU: Add TMU support in dtt command
EXYNOS5: Config: Enable dtt command for TMU
arch/arm/cpu/armv7/exynos/power.c | 15 ++
arch/arm/dts/exynos5250.dtsi | 5 +
arch/arm/include/asm/arch-exynos/exynos-tmu.h | 58 +++++
arch/arm/include/asm/arch-exynos/power.h | 1 +
board/samsung/dts/exynos5250-smdk5250.dts | 13 ++
board/samsung/smdk5250/smdk5250.c | 35 +++
common/cmd_dtt.c | 19 ++
doc/device-tree-bindings/exynos/tmu.txt | 35 +++
drivers/power/Makefile | 1 +
drivers/power/exynos-tmu.c | 297 +++++++++++++++++++++++++
include/configs/exynos5250-dt.h | 5 +
include/fdtdec.h | 1 +
include/tmu.h | 46 ++++
lib/fdtdec.c | 1 +
14 files changed, 532 insertions(+)
create mode 100644 arch/arm/include/asm/arch-exynos/exynos-tmu.h
create mode 100644 doc/device-tree-bindings/exynos/tmu.txt
create mode 100644 drivers/power/exynos-tmu.c
create mode 100644 include/tmu.h
--
1.7.9.5
^ permalink raw reply [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 1/7 v5] EXYNOS5: TMU: Add driver for Thermal Management Unit
2013-01-21 11:11 [U-Boot] [PATCH 0/7 v5] Add TMU support for Exynos5250 based SMDK5250 Akshay Saraswat
@ 2013-01-21 11:11 ` Akshay Saraswat
2013-01-22 15:51 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 2/7 v5] EXYNOS5: Implement board_poweroff " Akshay Saraswat
` (5 subsequent siblings)
6 siblings, 1 reply; 15+ messages in thread
From: Akshay Saraswat @ 2013-01-21 11:11 UTC (permalink / raw)
To: u-boot
Adding Exynos Thermal Management Unit driver to monitor SOC
temperature and take actions corresponding to states of TMU.
Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
---
Changes since v4:
- Changed return value of get_cur_temp in case of 0 degree temp from -1 to TMU_STATUS_INIT because return value should be enum tmu_status_t.
arch/arm/include/asm/arch-exynos/exynos-tmu.h | 58 +++++
drivers/power/Makefile | 1 +
drivers/power/exynos-tmu.c | 297 +++++++++++++++++++++++++
include/tmu.h | 46 ++++
4 files changed, 402 insertions(+)
create mode 100644 arch/arm/include/asm/arch-exynos/exynos-tmu.h
create mode 100644 drivers/power/exynos-tmu.c
create mode 100644 include/tmu.h
diff --git a/arch/arm/include/asm/arch-exynos/exynos-tmu.h b/arch/arm/include/asm/arch-exynos/exynos-tmu.h
new file mode 100644
index 0000000..c79a520
--- /dev/null
+++ b/arch/arm/include/asm/arch-exynos/exynos-tmu.h
@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2012 Samsung Electronics Co., Ltd.
+ * http://www.samsung.com
+ * Akshay Saraswat <akshay.s@samsung.com>
+ *
+ * EXYNOS - Thermal Management Unit
+ *
+ * See file CREDITS for list of people who contributed to this
+ * project.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ */
+
+#ifndef __ASM_ARCH_TMU_H
+#define __ASM_ARCH_TMU_H
+
+struct tmu_reg {
+ unsigned triminfo;
+ unsigned rsvd1;
+ unsigned rsvd2;
+ unsigned rsvd3;
+ unsigned rsvd4;
+ unsigned triminfo_control;
+ unsigned rsvd5;
+ unsigned rsvd6;
+ unsigned tmu_control;
+ unsigned rsvd7;
+ unsigned tmu_status;
+ unsigned sampling_internal;
+ unsigned counter_value0;
+ unsigned counter_value1;
+ unsigned rsvd8;
+ unsigned rsvd9;
+ unsigned current_temp;
+ unsigned rsvd10;
+ unsigned rsvd11;
+ unsigned rsvd12;
+ unsigned threshold_temp_rise;
+ unsigned threshold_temp_fall;
+ unsigned rsvd13;
+ unsigned rsvd14;
+ unsigned past_temp3_0;
+ unsigned past_temp7_4;
+ unsigned past_temp11_8;
+ unsigned past_temp15_12;
+ unsigned inten;
+ unsigned intstat;
+ unsigned intclear;
+ unsigned rsvd15;
+ unsigned emul_con;
+};
+#endif /* __ASM_ARCH_THERMAL_H */
diff --git a/drivers/power/Makefile b/drivers/power/Makefile
index 8c71901..a5c7027 100644
--- a/drivers/power/Makefile
+++ b/drivers/power/Makefile
@@ -30,6 +30,7 @@ COBJS-$(CONFIG_TPS6586X_POWER) += tps6586x.o
COBJS-$(CONFIG_TWL4030_POWER) += twl4030.o
COBJS-$(CONFIG_TWL6030_POWER) += twl6030.o
COBJS-$(CONFIG_TWL6035_POWER) += twl6035.o
+COBJS-$(CONFIG_EXYNOS_TMU) += exynos-tmu.o
COBJS-$(CONFIG_POWER) += power_core.o
COBJS-$(CONFIG_DIALOG_POWER) += power_dialog.o
diff --git a/drivers/power/exynos-tmu.c b/drivers/power/exynos-tmu.c
new file mode 100644
index 0000000..c48fe28
--- /dev/null
+++ b/drivers/power/exynos-tmu.c
@@ -0,0 +1,297 @@
+/*
+ * Copyright (c) 2012 Samsung Electronics Co., Ltd.
+ * http://www.samsung.com
+ * Akshay Saraswat <akshay.s@samsung.com>
+ *
+ * EXYNOS - Thermal Management Unit
+ *
+ * See file CREDITS for list of people who contributed to this
+ * project.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ */
+
+#include <common.h>
+#include <errno.h>
+#include <fdtdec.h>
+#include <tmu.h>
+#include <asm/arch/exynos-tmu.h>
+
+#define TRIMINFO_RELOAD 1
+#define CORE_EN 1
+
+#define INTEN_RISE0 1
+#define INTEN_RISE1 (1 << 4)
+#define INTEN_RISE2 (1 << 8)
+#define INTEN_FALL0 (1 << 16)
+#define INTEN_FALL1 (1 << 20)
+#define INTEN_FALL2 (1 << 24)
+
+#define TRIM_INFO_MASK 0xff
+
+#define INTCLEAR_RISE0 1
+#define INTCLEAR_RISE1 (1 << 4)
+#define INTCLEAR_RISE2 (1 << 8)
+#define INTCLEAR_FALL0 (1 << 16)
+#define INTCLEAR_FALL1 (1 << 20)
+#define INTCLEAR_FALL2 (1 << 24)
+#define INTCLEARALL (INTCLEAR_RISE0 | INTCLEAR_RISE1 | \
+ INTCLEAR_RISE2 | INTCLEAR_FALL0 | \
+ INTCLEAR_FALL1 | INTCLEAR_FALL2)
+
+/* Tmeperature threshold values for various thermal events */
+struct temperature_params {
+ /* minimum value in temperature code range */
+ unsigned int min_val;
+ /* maximum value in temperature code range */
+ unsigned int max_val;
+ /* temperature threshold to start warning */
+ unsigned int start_warning;
+ /* temperature threshold CPU tripping */
+ unsigned int start_tripping;
+};
+
+/* Pre-defined values and thresholds for calibration of current temperature */
+struct tmu_data {
+ /* pre-defined temperature thresholds */
+ struct temperature_params ts;
+ /* pre-defined efuse range minimum value */
+ unsigned int efuse_min_value;
+ /* pre-defined efuse value for temperature calibration */
+ unsigned int efuse_value;
+ /* pre-defined efuse range maximum value */
+ unsigned int efuse_max_value;
+ /* current temperature sensing slope */
+ unsigned int slope;
+};
+
+/* TMU device specific details and status */
+struct tmu_info {
+ /* base Address for the TMU */
+ unsigned tmu_base;
+ /* mux Address for the TMU */
+ int tmu_mux;
+ /* pre-defined values for calibration and thresholds */
+ struct tmu_data data;
+ /* value required for triminfo_25 calibration */
+ unsigned int te1;
+ /* value required for triminfo_85 calibration */
+ unsigned int te2;
+ /* TMU DC value for threshold calculation */
+ int dc_value;
+ /* enum value indicating status of the TMU */
+ int tmu_state;
+};
+
+/* Global struct tmu_info variable to store init values */
+static struct tmu_info gbl_info;
+
+/*
+ * Get current temperature code from register,
+ * then calculate and calibrate it's value
+ * in degree celsius.
+ *
+ * @return current temperature of the chip as sensed by TMU
+ */
+int get_cur_temp(struct tmu_info *info)
+{
+ int cur_temp;
+ struct tmu_reg *reg = (struct tmu_reg *)info->tmu_base;
+
+ /* Temperature code range between min 25 and max 125 */
+ cur_temp = readl(®->current_temp) & 0xff;
+
+ /* Calibrate current temperature */
+ if (cur_temp)
+ cur_temp = cur_temp - info->te1 + info->dc_value;
+
+ return cur_temp;
+}
+
+/*
+ * Monitors status of the TMU device and exynos temperature
+ *
+ * @param temp pointer to the current temperature value
+ * @return enum tmu_status_t value, code indicating event to execute
+ */
+enum tmu_status_t tmu_monitor(int *temp)
+{
+ if (gbl_info.tmu_state == TMU_STATUS_INIT)
+ return TMU_STATUS_INIT;
+
+ int cur_temp;
+ struct tmu_data *data = &gbl_info.data;
+
+ /* Read current temperature of the SOC */
+ cur_temp = get_cur_temp(&gbl_info);
+ *temp = cur_temp;
+
+ /* Temperature code lies between min 25 and max 125 */
+ if (cur_temp >= data->ts.start_tripping &&
+ cur_temp <= data->ts.max_val)
+ return TMU_STATUS_TRIPPED;
+ else if (cur_temp >= data->ts.start_warning)
+ return TMU_STATUS_WARNING;
+ else if (cur_temp < data->ts.start_warning &&
+ cur_temp >= data->ts.min_val)
+ return TMU_STATUS_NORMAL;
+ /* Temperature code does not lie between min 25 and max 125 */
+ else {
+ gbl_info.tmu_state = TMU_STATUS_INIT;
+ debug("EXYNOS_TMU: Thermal reading failed\n");
+ return TMU_STATUS_INIT;
+ }
+}
+
+/*
+ * Get TMU specific pre-defined values from FDT
+ *
+ * @param info pointer to the tmu_info struct
+ * @param blob FDT blob
+ * @return int value, 0 for success
+ */
+int get_tmu_fdt_values(struct tmu_info *info, const void *blob)
+{
+ int node;
+ int error = 0;
+
+ /* Get the node from FDT for TMU */
+ node = fdtdec_next_compatible(blob, 0,
+ COMPAT_SAMSUNG_EXYNOS_TMU);
+ if (node < 0) {
+ debug("EXYNOS_TMU: No node for tmu in device tree\n");
+ return -1;
+ }
+
+ /*
+ * Get the pre-defined TMU specific values from FDT.
+ * All of these are expected to be correct otherwise
+ * miscalculation of register values in tmu_setup_parameters
+ * may result in misleading current temperature.
+ */
+ info->tmu_base = fdtdec_get_addr(blob, node, "reg");
+ if (info->tmu_base == FDT_ADDR_T_NONE) {
+ debug("%s: Missing tmu-base\n", __func__);
+ return -1;
+ }
+ info->tmu_mux = fdtdec_get_int(blob,
+ node, "samsung,mux", -1);
+ error |= info->tmu_mux;
+ info->data.ts.min_val = fdtdec_get_int(blob,
+ node, "samsung,min-temp", -1);
+ error |= info->data.ts.min_val;
+ info->data.ts.max_val = fdtdec_get_int(blob,
+ node, "samsung,max-temp", -1);
+ error |= info->data.ts.max_val;
+ info->data.ts.start_warning = fdtdec_get_int(blob,
+ node, "samsung,start-warning", -1);
+ error |= info->data.ts.start_warning;
+ info->data.ts.start_tripping = fdtdec_get_int(blob,
+ node, "samsung,start-tripping", -1);
+ error |= info->data.ts.start_tripping;
+ info->data.efuse_min_value = fdtdec_get_int(blob,
+ node, "samsung,efuse-min-value", -1);
+ error |= info->data.efuse_min_value;
+ info->data.efuse_value = fdtdec_get_int(blob,
+ node, "samsung,efuse-value", -1);
+ error |= info->data.efuse_value;
+ info->data.efuse_max_value = fdtdec_get_int(blob,
+ node, "samsung,efuse-max-value", -1);
+ error |= info->data.efuse_max_value;
+ info->data.slope = fdtdec_get_int(blob,
+ node, "samsung,slope", -1);
+ error |= info->data.slope;
+ info->dc_value = fdtdec_get_int(blob,
+ node, "samsung,dc-value", -1);
+ error |= info->dc_value;
+
+ if (error == -1) {
+ debug("fail to get tmu node properties\n");
+ return -1;
+ }
+
+ return 0;
+}
+
+/*
+ * Calibrate and calculate threshold values and
+ * enable interrupt levels
+ *
+ * @param info pointer to the tmu_info struct
+ */
+void tmu_setup_parameters(struct tmu_info *info)
+{
+ unsigned int te_temp, con;
+ unsigned int warning_temp, trip_temp;
+ unsigned int cooling_temp;
+ unsigned int rising_value;
+ struct tmu_data *data = &info->data;
+ struct tmu_reg *reg = (struct tmu_reg *)info->tmu_base;
+
+ /* Must reload for using efuse value at EXYNOS */
+ writel(TRIMINFO_RELOAD, ®->triminfo_control);
+
+ /* Get the compensation parameter */
+ te_temp = readl(®->triminfo);
+ info->te1 = te_temp & TRIM_INFO_MASK;
+ info->te2 = ((te_temp >> 8) & TRIM_INFO_MASK);
+
+ if ((data->efuse_min_value > info->te1) ||
+ (info->te1 > data->efuse_max_value)
+ || (info->te2 != 0))
+ info->te1 = data->efuse_value;
+
+ /* Get RISING & FALLING Threshold value */
+ warning_temp = data->ts.start_warning
+ + info->te1 - info->dc_value;
+ trip_temp = data->ts.start_tripping
+ + info->te1 - info->dc_value;
+ cooling_temp = 0;
+
+ rising_value = ((warning_temp << 8) | (trip_temp << 16));
+
+ /* Set interrupt level */
+ writel(rising_value, ®->threshold_temp_rise);
+ writel(cooling_temp, ®->threshold_temp_fall);
+
+ /*
+ * Need to init all regsiter setting after getting parameter info
+ * [28:23] vref [11:8] slope - Tunning parameter
+ */
+ writel(data->slope, ®->tmu_control);
+
+ writel(INTCLEARALL, ®->intclear);
+ /* TMU core enable */
+ con = readl(®->tmu_control);
+ con |= (info->tmu_mux << 20) | CORE_EN;
+
+ writel(con, ®->tmu_control);
+
+ /* LEV0 LEV1 LEV2 interrupt enable */
+ writel(INTEN_RISE0 | INTEN_RISE1 | INTEN_RISE2, ®->inten);
+}
+
+/*
+ * Initialize TMU device
+ *
+ * @param blob FDT blob
+ * @return int value, 0 for success
+ */
+int tmu_init(const void *blob)
+{
+ gbl_info.tmu_state = TMU_STATUS_INIT;
+ if (get_tmu_fdt_values(&gbl_info, blob) < 0)
+ return -1;
+
+ tmu_setup_parameters(&gbl_info);
+ gbl_info.tmu_state = TMU_STATUS_NORMAL;
+ puts("EXYNOS_TMU: Available\n");
+
+ return 0;
+}
diff --git a/include/tmu.h b/include/tmu.h
new file mode 100644
index 0000000..17e9a85
--- /dev/null
+++ b/include/tmu.h
@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2012 Samsung Electronics Co., Ltd.
+ * http://www.samsung.com
+ * Akshay Saraswat <akshay.s@samsung.com>
+ *
+ * Thermal Management Unit
+ *
+ * See file CREDITS for list of people who contributed to this
+ * project.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ */
+
+#ifndef _TMU_H
+#define _TMU_H
+
+enum tmu_status_t {
+ TMU_STATUS_INIT = 0,
+ TMU_STATUS_NORMAL,
+ TMU_STATUS_WARNING,
+ TMU_STATUS_TRIPPED,
+};
+
+/*
+ * Monitors status of the TMU device and exynos temperature
+ *
+ * @param temp pointer to the current temperature value
+ * @return enum tmu_status_t value, code indicating event to execute
+ * and -1 on error
+ */
+enum tmu_status_t tmu_monitor(int *temp);
+
+/*
+ * Initialize TMU device
+ *
+ * @param blob FDT blob
+ * @return int value, 0 for success
+ */
+int tmu_init(const void *blob);
+#endif /* _THERMAL_H_ */
--
1.7.9.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 2/7 v5] EXYNOS5: Implement board_poweroff for Thermal Management Unit
2013-01-21 11:11 [U-Boot] [PATCH 0/7 v5] Add TMU support for Exynos5250 based SMDK5250 Akshay Saraswat
2013-01-21 11:11 ` [U-Boot] [PATCH 1/7 v5] EXYNOS5: TMU: Add driver for Thermal Management Unit Akshay Saraswat
@ 2013-01-21 11:11 ` Akshay Saraswat
2013-01-22 15:52 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 3/7 v5] EXYNOS5: FDT: Add TMU device node values Akshay Saraswat
` (4 subsequent siblings)
6 siblings, 1 reply; 15+ messages in thread
From: Akshay Saraswat @ 2013-01-21 11:11 UTC (permalink / raw)
To: u-boot
Adding API in power for system shutdown when tripping value is reached
in Exynos Thermal Management Unit.
Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
---
Changes since v4:
- Changed API name from power_shutdown to generic board_poweroff defined in commomn.h.
arch/arm/cpu/armv7/exynos/power.c | 15 +++++++++++++++
arch/arm/include/asm/arch-exynos/power.h | 1 +
2 files changed, 16 insertions(+)
diff --git a/arch/arm/cpu/armv7/exynos/power.c b/arch/arm/cpu/armv7/exynos/power.c
index d4bce6d..1d26982 100644
--- a/arch/arm/cpu/armv7/exynos/power.c
+++ b/arch/arm/cpu/armv7/exynos/power.c
@@ -95,3 +95,18 @@ void set_dp_phy_ctrl(unsigned int enable)
if (cpu_is_exynos5())
exynos5_dp_phy_control(enable);
}
+
+/*
+ * This function never returns.
+ * When called this function makes system hang and PAD driving value high
+ * which in turn makes system power down.
+ */
+void board_poweroff(void)
+{
+ struct exynos5_power *power =
+ (struct exynos5_power *)samsung_get_base_power();
+
+ clrbits_le32(&power->ps_hold_control, POWER_PS_HOLD_CONTROL_DATA_HIGH);
+
+ hang();
+}
diff --git a/arch/arm/include/asm/arch-exynos/power.h b/arch/arm/include/asm/arch-exynos/power.h
index d2fdb59..7463036 100644
--- a/arch/arm/include/asm/arch-exynos/power.h
+++ b/arch/arm/include/asm/arch-exynos/power.h
@@ -863,5 +863,6 @@ void set_usbhost_phy_ctrl(unsigned int enable);
void set_dp_phy_ctrl(unsigned int enable);
#define EXYNOS_DP_PHY_ENABLE (1 << 0)
+#define POWER_PS_HOLD_CONTROL_DATA_HIGH (1 << 8)
#endif
--
1.7.9.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 3/7 v5] EXYNOS5: FDT: Add TMU device node values
2013-01-21 11:11 [U-Boot] [PATCH 0/7 v5] Add TMU support for Exynos5250 based SMDK5250 Akshay Saraswat
2013-01-21 11:11 ` [U-Boot] [PATCH 1/7 v5] EXYNOS5: TMU: Add driver for Thermal Management Unit Akshay Saraswat
2013-01-21 11:11 ` [U-Boot] [PATCH 2/7 v5] EXYNOS5: Implement board_poweroff " Akshay Saraswat
@ 2013-01-21 11:11 ` Akshay Saraswat
2013-01-22 15:58 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 4/7 v5] EXYNOS5: TMU: Add TMU init and status check Akshay Saraswat
` (3 subsequent siblings)
6 siblings, 1 reply; 15+ messages in thread
From: Akshay Saraswat @ 2013-01-21 11:11 UTC (permalink / raw)
To: u-boot
Fdt entry for Exynos TMU driver specific pre-defined values used for
calibration of current temperature and defining threshold values.
Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
---
Changes since v4:
- Rebased this patch.
arch/arm/dts/exynos5250.dtsi | 5 +++++
board/samsung/dts/exynos5250-smdk5250.dts | 13 +++++++++++
doc/device-tree-bindings/exynos/tmu.txt | 35 +++++++++++++++++++++++++++++
include/fdtdec.h | 1 +
lib/fdtdec.c | 1 +
5 files changed, 55 insertions(+)
create mode 100644 doc/device-tree-bindings/exynos/tmu.txt
diff --git a/arch/arm/dts/exynos5250.dtsi b/arch/arm/dts/exynos5250.dtsi
index ed8c8dd..b2ef42e 100644
--- a/arch/arm/dts/exynos5250.dtsi
+++ b/arch/arm/dts/exynos5250.dtsi
@@ -151,4 +151,9 @@
};
};
+ tmu at 10060000 {
+ compatible = "samsung,exynos-tmu";
+ reg = <0x10060000 0xffff>;
+ };
+
};
diff --git a/board/samsung/dts/exynos5250-smdk5250.dts b/board/samsung/dts/exynos5250-smdk5250.dts
index cbfab6f..f49ca44 100644
--- a/board/samsung/dts/exynos5250-smdk5250.dts
+++ b/board/samsung/dts/exynos5250-smdk5250.dts
@@ -66,4 +66,17 @@
compatible = "maxim,max77686_pmic";
};
};
+
+ tmu at 10060000 {
+ samsung,mux = <6>;
+ samsung,min-temp = <25>;
+ samsung,max-temp = <125>;
+ samsung,start-warning = <95>;
+ samsung,start-tripping = <105>;
+ samsung,efuse-min-value = <40>;
+ samsung,efuse-value = <55>;
+ samsung,efuse-max-value = <100>;
+ samsung,slope = <268470274>;
+ samsung,dc-value = <25>;
+ };
};
diff --git a/doc/device-tree-bindings/exynos/tmu.txt b/doc/device-tree-bindings/exynos/tmu.txt
new file mode 100644
index 0000000..ed1e22a
--- /dev/null
+++ b/doc/device-tree-bindings/exynos/tmu.txt
@@ -0,0 +1,35 @@
+Exynos Thermal management Unit
+
+The device node for TMU that is a part of Exynos5250
+SOC is as described in the document "Open Firmware Recommended
+Practic : Universal Serial Bus" with the following modifications
+and additions:
+
+Required properties :
+ - compatible : Should be "samsung,exynos-tmu" for TMU
+ - samsung,mux : mux Address for the TMU to enable TMU core
+ - samsung,min-temp : Minimum temperature, default is 25
+ - samsung,max-temp : Maximum temperature, defalut set to 125
+ - samsung,start-warning : temp at which TMU start giving warning
+ - samsung,start-tripping : temp at which system will trip and shutdown
+ - samsung,efuse-min-value : SOC efuse min value
+ - samsung,efuse-value : SOC actual efuse value
+ - samsung,efuse-max-value : SoC max efuse value
+ - samsung,slope : Gain of amplifier, default is 268470274
+ - samsung,dc-value : DC value of TMU, default is 25
+
+Example:
+
+tmu at 10060000 {
+ compatible = "samsung,exynos-tmu"
+ samsung,mux = <6>;
+ samsung,min-temp = <25>;
+ samsung,max-temp = <125>;
+ samsung,start-warning = <95>;
+ samsung,start-tripping = <105>;
+ samsung,efuse-min-value = <40>;
+ samsung,efuse-value = <55>;
+ samsung,efuse-max-value = <100>;
+ samsung,slope = <268470274>;
+ samsung,dc-value = <25>;
+};
diff --git a/include/fdtdec.h b/include/fdtdec.h
index f77d195..058fb51 100644
--- a/include/fdtdec.h
+++ b/include/fdtdec.h
@@ -79,6 +79,7 @@ enum fdt_compat_id {
COMPAT_SAMSUNG_EXYNOS_EHCI, /* Exynos EHCI controller */
COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */
COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */
+ COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */
COMPAT_COUNT,
};
diff --git a/lib/fdtdec.c b/lib/fdtdec.c
index 16921e1..4613fcd 100644
--- a/lib/fdtdec.c
+++ b/lib/fdtdec.c
@@ -54,6 +54,7 @@ static const char * const compat_names[COMPAT_COUNT] = {
COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
+ COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
};
const char *fdtdec_get_compatible(enum fdt_compat_id id)
--
1.7.9.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 4/7 v5] EXYNOS5: TMU: Add TMU init and status check
2013-01-21 11:11 [U-Boot] [PATCH 0/7 v5] Add TMU support for Exynos5250 based SMDK5250 Akshay Saraswat
` (2 preceding siblings ...)
2013-01-21 11:11 ` [U-Boot] [PATCH 3/7 v5] EXYNOS5: FDT: Add TMU device node values Akshay Saraswat
@ 2013-01-21 11:11 ` Akshay Saraswat
2013-01-22 20:45 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 5/7 v5] EXYNOS5: Config: Enable support for Exynos TMU driver Akshay Saraswat
` (2 subsequent siblings)
6 siblings, 1 reply; 15+ messages in thread
From: Akshay Saraswat @ 2013-01-21 11:11 UTC (permalink / raw)
To: u-boot
This adds call to tmu_init() and TMU boot time analysis
for the SoC temperature threshold breach.
Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
---
Changes since v4:
- Replaced board polling with initial SoC temperature analysis for any possible threshold breach.
board/samsung/smdk5250/smdk5250.c | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/board/samsung/smdk5250/smdk5250.c b/board/samsung/smdk5250/smdk5250.c
index 7a5f132..7b9a8c5 100644
--- a/board/samsung/smdk5250/smdk5250.c
+++ b/board/samsung/smdk5250/smdk5250.c
@@ -35,9 +35,35 @@
#include <asm/arch/sromc.h>
#include <asm/arch/dp_info.h>
#include <power/pmic.h>
+#include <tmu.h>
DECLARE_GLOBAL_DATA_PTR;
+#if defined CONFIG_EXYNOS_TMU
+/*
+ * Boot Time Thermal Analysis for SoC temperature threshold breach
+ */
+void boot_temp_check(void)
+{
+ int temp;
+
+ switch (tmu_monitor(&temp)) {
+ case TMU_STATUS_TRIPPED:
+ puts("EXYNOS_TMU: TRIPPING! Device power going down ...\n");
+ board_poweroff();
+ break;
+ case TMU_STATUS_WARNING:
+ puts("EXYNOS_TMU: WARNING! Temperature very high\n");
+ break;
+ case TMU_STATUS_NORMAL:
+ break;
+ case TMU_STATUS_INIT:
+ default:
+ debug("Unknown TMU state\n");
+ }
+}
+#endif
+
#ifdef CONFIG_USB_EHCI_EXYNOS
int board_usb_vbus_init(void)
{
@@ -57,6 +83,15 @@ int board_usb_vbus_init(void)
int board_init(void)
{
gd->bd->bi_boot_params = (PHYS_SDRAM_1 + 0x100UL);
+
+#if defined CONFIG_EXYNOS_TMU
+ if (tmu_init(gd->fdt_blob)) {
+ debug("%s: Failed to init TMU\n", __func__);
+ return -1;
+ }
+ boot_temp_check();
+#endif
+
#ifdef CONFIG_EXYNOS_SPI
spi_init();
#endif
--
1.7.9.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 5/7 v5] EXYNOS5: Config: Enable support for Exynos TMU driver
2013-01-21 11:11 [U-Boot] [PATCH 0/7 v5] Add TMU support for Exynos5250 based SMDK5250 Akshay Saraswat
` (3 preceding siblings ...)
2013-01-21 11:11 ` [U-Boot] [PATCH 4/7 v5] EXYNOS5: TMU: Add TMU init and status check Akshay Saraswat
@ 2013-01-21 11:11 ` Akshay Saraswat
2013-01-22 20:46 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 6/7 v5] TMU: Add TMU support in dtt command Akshay Saraswat
2013-01-21 11:11 ` [U-Boot] [PATCH 7/7 v5] EXYNOS5: Config: Enable dtt command for TMU Akshay Saraswat
6 siblings, 1 reply; 15+ messages in thread
From: Akshay Saraswat @ 2013-01-21 11:11 UTC (permalink / raw)
To: u-boot
Enables TMU driver support for exynos5250
Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
---
Changes since v4:
- Rebased this patch.
include/configs/exynos5250-dt.h | 3 +++
1 file changed, 3 insertions(+)
diff --git a/include/configs/exynos5250-dt.h b/include/configs/exynos5250-dt.h
index cabd2f2..53ca41f 100644
--- a/include/configs/exynos5250-dt.h
+++ b/include/configs/exynos5250-dt.h
@@ -117,6 +117,9 @@
#define CONFIG_BOOTDELAY 3
#define CONFIG_ZERO_BOOTDELAY_CHECK
+/* Thermal Management Unit */
+#define CONFIG_EXYNOS_TMU
+
/* USB */
#define CONFIG_CMD_USB
#define CONFIG_USB_EHCI
--
1.7.9.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 6/7 v5] TMU: Add TMU support in dtt command
2013-01-21 11:11 [U-Boot] [PATCH 0/7 v5] Add TMU support for Exynos5250 based SMDK5250 Akshay Saraswat
` (4 preceding siblings ...)
2013-01-21 11:11 ` [U-Boot] [PATCH 5/7 v5] EXYNOS5: Config: Enable support for Exynos TMU driver Akshay Saraswat
@ 2013-01-21 11:11 ` Akshay Saraswat
2013-01-22 20:51 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 7/7 v5] EXYNOS5: Config: Enable dtt command for TMU Akshay Saraswat
6 siblings, 1 reply; 15+ messages in thread
From: Akshay Saraswat @ 2013-01-21 11:11 UTC (permalink / raw)
To: u-boot
Add generic TMU support alongwith i2c sensors in dtt command
to enable temperature reading in cases where TMU is present
instead of i2c sensors.
Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
---
Changes since v4:
- Removed tmu command and added to dtt.
common/cmd_dtt.c | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/common/cmd_dtt.c b/common/cmd_dtt.c
index cd94423..715f4ba 100644
--- a/common/cmd_dtt.c
+++ b/common/cmd_dtt.c
@@ -28,6 +28,20 @@
#include <dtt.h>
#include <i2c.h>
+#if defined CONFIG_TMU_CMD_DTT
+#include <tmu.h>
+
+void dtt_get_temp(void)
+{
+ int cur_temp;
+
+ if (tmu_monitor(&cur_temp) == TMU_STATUS_INIT)
+ printf("TMU is in unknown state, temperature is invalid \n");
+ else
+ printf("Current temperature: %u degrees Celsius \n", cur_temp);
+}
+
+#else
static unsigned long sensor_initialized;
static void _initialize_dtt(void)
@@ -59,9 +73,13 @@ void dtt_init(void)
/* switch back to original I2C bus */
I2C_SET_BUS(old_bus);
}
+#endif
int do_dtt (cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
{
+#if defined CONFIG_TMU_CMD_DTT
+ dtt_get_temp();
+#else
int i;
unsigned char sensors[] = CONFIG_DTT_SENSORS;
int old_bus;
@@ -83,6 +101,7 @@ int do_dtt (cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
/* switch back to original I2C bus */
I2C_SET_BUS(old_bus);
+#endif
return 0;
} /* do_dtt() */
--
1.7.9.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 7/7 v5] EXYNOS5: Config: Enable dtt command for TMU
2013-01-21 11:11 [U-Boot] [PATCH 0/7 v5] Add TMU support for Exynos5250 based SMDK5250 Akshay Saraswat
` (5 preceding siblings ...)
2013-01-21 11:11 ` [U-Boot] [PATCH 6/7 v5] TMU: Add TMU support in dtt command Akshay Saraswat
@ 2013-01-21 11:11 ` Akshay Saraswat
2013-01-22 20:51 ` Simon Glass
6 siblings, 1 reply; 15+ messages in thread
From: Akshay Saraswat @ 2013-01-21 11:11 UTC (permalink / raw)
To: u-boot
This enables the dtt command to read the current SOC
temperature with the help of TMU
Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
---
Changes since v4:
- Replaced tmu command configs with corresponding dtt configs.
include/configs/exynos5250-dt.h | 2 ++
1 file changed, 2 insertions(+)
diff --git a/include/configs/exynos5250-dt.h b/include/configs/exynos5250-dt.h
index 53ca41f..8a8e9fe 100644
--- a/include/configs/exynos5250-dt.h
+++ b/include/configs/exynos5250-dt.h
@@ -119,6 +119,8 @@
/* Thermal Management Unit */
#define CONFIG_EXYNOS_TMU
+#define CONFIG_CMD_DTT
+#define CONFIG_TMU_CMD_DTT
/* USB */
#define CONFIG_CMD_USB
--
1.7.9.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 1/7 v5] EXYNOS5: TMU: Add driver for Thermal Management Unit
2013-01-21 11:11 ` [U-Boot] [PATCH 1/7 v5] EXYNOS5: TMU: Add driver for Thermal Management Unit Akshay Saraswat
@ 2013-01-22 15:51 ` Simon Glass
0 siblings, 0 replies; 15+ messages in thread
From: Simon Glass @ 2013-01-22 15:51 UTC (permalink / raw)
To: u-boot
Hi Akshay,
On Mon, Jan 21, 2013 at 3:11 AM, Akshay Saraswat <akshay.s@samsung.com> wrote:
> Adding Exynos Thermal Management Unit driver to monitor SOC
> temperature and take actions corresponding to states of TMU.
>
> Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
Acked-by: Simon Glass <sjg@chromium.org>
See a few nits below in case you do a v5.
> ---
> Changes since v4:
> - Changed return value of get_cur_temp in case of 0 degree temp from -1 to TMU_STATUS_INIT because return value should be enum tmu_status_t.
>
> arch/arm/include/asm/arch-exynos/exynos-tmu.h | 58 +++++
> drivers/power/Makefile | 1 +
> drivers/power/exynos-tmu.c | 297 +++++++++++++++++++++++++
> include/tmu.h | 46 ++++
> 4 files changed, 402 insertions(+)
> create mode 100644 arch/arm/include/asm/arch-exynos/exynos-tmu.h
> create mode 100644 drivers/power/exynos-tmu.c
> create mode 100644 include/tmu.h
>
> diff --git a/drivers/power/Makefile b/drivers/power/Makefile
> index 8c71901..a5c7027 100644
> --- a/drivers/power/Makefile
> +++ b/drivers/power/Makefile
> @@ -30,6 +30,7 @@ COBJS-$(CONFIG_TPS6586X_POWER) += tps6586x.o
> COBJS-$(CONFIG_TWL4030_POWER) += twl4030.o
> COBJS-$(CONFIG_TWL6030_POWER) += twl6030.o
> COBJS-$(CONFIG_TWL6035_POWER) += twl6035.o
> +COBJS-$(CONFIG_EXYNOS_TMU) += exynos-tmu.o
Should be in alphabetical order by CONFIG name
>
> COBJS-$(CONFIG_POWER) += power_core.o
> COBJS-$(CONFIG_DIALOG_POWER) += power_dialog.o
> diff --git a/drivers/power/exynos-tmu.c b/drivers/power/exynos-tmu.c
> new file mode 100644
> index 0000000..c48fe28
> --- /dev/null
> +++ b/drivers/power/exynos-tmu.c
> @@ -0,0 +1,297 @@
> +/*
> + * Copyright (c) 2012 Samsung Electronics Co., Ltd.
> + * http://www.samsung.com
> + * Akshay Saraswat <akshay.s@samsung.com>
> + *
> + * EXYNOS - Thermal Management Unit
> + *
> + * See file CREDITS for list of people who contributed to this
> + * project.
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License version 2 as
> + * published by the Free Software Foundation.
> + * You should have received a copy of the GNU General Public License
> + * along with this program; if not, write to the Free Software
> + * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> + * MA 02111-1307 USA
> + */
> +
> +#include <common.h>
> +#include <errno.h>
> +#include <fdtdec.h>
> +#include <tmu.h>
> +#include <asm/arch/exynos-tmu.h>
> +
> +#define TRIMINFO_RELOAD 1
> +#define CORE_EN 1
> +
> +#define INTEN_RISE0 1
> +#define INTEN_RISE1 (1 << 4)
> +#define INTEN_RISE2 (1 << 8)
> +#define INTEN_FALL0 (1 << 16)
> +#define INTEN_FALL1 (1 << 20)
> +#define INTEN_FALL2 (1 << 24)
> +
> +#define TRIM_INFO_MASK 0xff
> +
> +#define INTCLEAR_RISE0 1
> +#define INTCLEAR_RISE1 (1 << 4)
> +#define INTCLEAR_RISE2 (1 << 8)
> +#define INTCLEAR_FALL0 (1 << 16)
> +#define INTCLEAR_FALL1 (1 << 20)
> +#define INTCLEAR_FALL2 (1 << 24)
> +#define INTCLEARALL (INTCLEAR_RISE0 | INTCLEAR_RISE1 | \
> + INTCLEAR_RISE2 | INTCLEAR_FALL0 | \
> + INTCLEAR_FALL1 | INTCLEAR_FALL2)
> +
> +/* Tmeperature threshold values for various thermal events */
> +struct temperature_params {
> + /* minimum value in temperature code range */
> + unsigned int min_val;
> + /* maximum value in temperature code range */
> + unsigned int max_val;
> + /* temperature threshold to start warning */
> + unsigned int start_warning;
> + /* temperature threshold CPU tripping */
> + unsigned int start_tripping;
> +};
> +
> +/* Pre-defined values and thresholds for calibration of current temperature */
> +struct tmu_data {
> + /* pre-defined temperature thresholds */
> + struct temperature_params ts;
> + /* pre-defined efuse range minimum value */
> + unsigned int efuse_min_value;
> + /* pre-defined efuse value for temperature calibration */
> + unsigned int efuse_value;
> + /* pre-defined efuse range maximum value */
> + unsigned int efuse_max_value;
> + /* current temperature sensing slope */
> + unsigned int slope;
> +};
> +
> +/* TMU device specific details and status */
> +struct tmu_info {
> + /* base Address for the TMU */
> + unsigned tmu_base;
> + /* mux Address for the TMU */
> + int tmu_mux;
> + /* pre-defined values for calibration and thresholds */
> + struct tmu_data data;
> + /* value required for triminfo_25 calibration */
> + unsigned int te1;
> + /* value required for triminfo_85 calibration */
> + unsigned int te2;
> + /* TMU DC value for threshold calculation */
> + int dc_value;
> + /* enum value indicating status of the TMU */
> + int tmu_state;
> +};
> +
> +/* Global struct tmu_info variable to store init values */
> +static struct tmu_info gbl_info;
> +
> +/*
> + * Get current temperature code from register,
> + * then calculate and calibrate it's value
> + * in degree celsius.
> + *
> + * @return current temperature of the chip as sensed by TMU
> + */
> +int get_cur_temp(struct tmu_info *info)
> +{
> + int cur_temp;
> + struct tmu_reg *reg = (struct tmu_reg *)info->tmu_base;
> +
> + /* Temperature code range between min 25 and max 125 */
> + cur_temp = readl(®->current_temp) & 0xff;
> +
> + /* Calibrate current temperature */
> + if (cur_temp)
> + cur_temp = cur_temp - info->te1 + info->dc_value;
> +
> + return cur_temp;
> +}
> +
> +/*
> + * Monitors status of the TMU device and exynos temperature
> + *
> + * @param temp pointer to the current temperature value
> + * @return enum tmu_status_t value, code indicating event to execute
> + */
> +enum tmu_status_t tmu_monitor(int *temp)
> +{
> + if (gbl_info.tmu_state == TMU_STATUS_INIT)
> + return TMU_STATUS_INIT;
> +
> + int cur_temp;
> + struct tmu_data *data = &gbl_info.data;
> +
> + /* Read current temperature of the SOC */
> + cur_temp = get_cur_temp(&gbl_info);
> + *temp = cur_temp;
> +
> + /* Temperature code lies between min 25 and max 125 */
> + if (cur_temp >= data->ts.start_tripping &&
> + cur_temp <= data->ts.max_val)
> + return TMU_STATUS_TRIPPED;
> + else if (cur_temp >= data->ts.start_warning)
> + return TMU_STATUS_WARNING;
> + else if (cur_temp < data->ts.start_warning &&
> + cur_temp >= data->ts.min_val)
> + return TMU_STATUS_NORMAL;
> + /* Temperature code does not lie between min 25 and max 125 */
> + else {
> + gbl_info.tmu_state = TMU_STATUS_INIT;
> + debug("EXYNOS_TMU: Thermal reading failed\n");
> + return TMU_STATUS_INIT;
> + }
The else has {} but no the others. Does checkpatch / patman not pick this up?
> +}
> +
> +/*
> + * Get TMU specific pre-defined values from FDT
> + *
> + * @param info pointer to the tmu_info struct
> + * @param blob FDT blob
> + * @return int value, 0 for success
> + */
> +int get_tmu_fdt_values(struct tmu_info *info, const void *blob)
> +{
> + int node;
> + int error = 0;
> +
> + /* Get the node from FDT for TMU */
> + node = fdtdec_next_compatible(blob, 0,
> + COMPAT_SAMSUNG_EXYNOS_TMU);
> + if (node < 0) {
> + debug("EXYNOS_TMU: No node for tmu in device tree\n");
> + return -1;
> + }
> +
> + /*
> + * Get the pre-defined TMU specific values from FDT.
> + * All of these are expected to be correct otherwise
> + * miscalculation of register values in tmu_setup_parameters
> + * may result in misleading current temperature.
> + */
> + info->tmu_base = fdtdec_get_addr(blob, node, "reg");
> + if (info->tmu_base == FDT_ADDR_T_NONE) {
> + debug("%s: Missing tmu-base\n", __func__);
> + return -1;
> + }
> + info->tmu_mux = fdtdec_get_int(blob,
> + node, "samsung,mux", -1);
> + error |= info->tmu_mux;
> + info->data.ts.min_val = fdtdec_get_int(blob,
> + node, "samsung,min-temp", -1);
> + error |= info->data.ts.min_val;
> + info->data.ts.max_val = fdtdec_get_int(blob,
> + node, "samsung,max-temp", -1);
> + error |= info->data.ts.max_val;
> + info->data.ts.start_warning = fdtdec_get_int(blob,
> + node, "samsung,start-warning", -1);
> + error |= info->data.ts.start_warning;
> + info->data.ts.start_tripping = fdtdec_get_int(blob,
> + node, "samsung,start-tripping", -1);
> + error |= info->data.ts.start_tripping;
> + info->data.efuse_min_value = fdtdec_get_int(blob,
> + node, "samsung,efuse-min-value", -1);
> + error |= info->data.efuse_min_value;
> + info->data.efuse_value = fdtdec_get_int(blob,
> + node, "samsung,efuse-value", -1);
> + error |= info->data.efuse_value;
> + info->data.efuse_max_value = fdtdec_get_int(blob,
> + node, "samsung,efuse-max-value", -1);
> + error |= info->data.efuse_max_value;
> + info->data.slope = fdtdec_get_int(blob,
> + node, "samsung,slope", -1);
> + error |= info->data.slope;
> + info->dc_value = fdtdec_get_int(blob,
> + node, "samsung,dc-value", -1);
> + error |= info->dc_value;
> +
> + if (error == -1) {
> + debug("fail to get tmu node properties\n");
> + return -1;
> + }
> +
> + return 0;
> +}
> +
> +/*
> + * Calibrate and calculate threshold values and
> + * enable interrupt levels
> + *
> + * @param info pointer to the tmu_info struct
> + */
> +void tmu_setup_parameters(struct tmu_info *info)
> +{
> + unsigned int te_temp, con;
> + unsigned int warning_temp, trip_temp;
> + unsigned int cooling_temp;
> + unsigned int rising_value;
> + struct tmu_data *data = &info->data;
> + struct tmu_reg *reg = (struct tmu_reg *)info->tmu_base;
> +
> + /* Must reload for using efuse value at EXYNOS */
> + writel(TRIMINFO_RELOAD, ®->triminfo_control);
> +
> + /* Get the compensation parameter */
> + te_temp = readl(®->triminfo);
> + info->te1 = te_temp & TRIM_INFO_MASK;
> + info->te2 = ((te_temp >> 8) & TRIM_INFO_MASK);
> +
> + if ((data->efuse_min_value > info->te1) ||
> + (info->te1 > data->efuse_max_value)
> + || (info->te2 != 0))
> + info->te1 = data->efuse_value;
> +
> + /* Get RISING & FALLING Threshold value */
> + warning_temp = data->ts.start_warning
> + + info->te1 - info->dc_value;
> + trip_temp = data->ts.start_tripping
> + + info->te1 - info->dc_value;
> + cooling_temp = 0;
> +
> + rising_value = ((warning_temp << 8) | (trip_temp << 16));
> +
> + /* Set interrupt level */
> + writel(rising_value, ®->threshold_temp_rise);
> + writel(cooling_temp, ®->threshold_temp_fall);
> +
> + /*
> + * Need to init all regsiter setting after getting parameter info
> + * [28:23] vref [11:8] slope - Tunning parameter
> + */
> + writel(data->slope, ®->tmu_control);
> +
> + writel(INTCLEARALL, ®->intclear);
> + /* TMU core enable */
> + con = readl(®->tmu_control);
> + con |= (info->tmu_mux << 20) | CORE_EN;
> +
> + writel(con, ®->tmu_control);
> +
> + /* LEV0 LEV1 LEV2 interrupt enable */
> + writel(INTEN_RISE0 | INTEN_RISE1 | INTEN_RISE2, ®->inten);
> +}
> +
> +/*
> + * Initialize TMU device
> + *
> + * @param blob FDT blob
> + * @return int value, 0 for success
> + */
> +int tmu_init(const void *blob)
> +{
> + gbl_info.tmu_state = TMU_STATUS_INIT;
> + if (get_tmu_fdt_values(&gbl_info, blob) < 0)
> + return -1;
> +
> + tmu_setup_parameters(&gbl_info);
> + gbl_info.tmu_state = TMU_STATUS_NORMAL;
> + puts("EXYNOS_TMU: Available\n");
Maybe this should be debug()?
> +
> + return 0;
> +}
> diff --git a/include/tmu.h b/include/tmu.h
> new file mode 100644
> index 0000000..17e9a85
> --- /dev/null
> +++ b/include/tmu.h
> @@ -0,0 +1,46 @@
> +/*
> + * Copyright (c) 2012 Samsung Electronics Co., Ltd.
> + * http://www.samsung.com
> + * Akshay Saraswat <akshay.s@samsung.com>
> + *
> + * Thermal Management Unit
> + *
> + * See file CREDITS for list of people who contributed to this
> + * project.
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License version 2 as
> + * published by the Free Software Foundation.
> + * You should have received a copy of the GNU General Public License
> + * along with this program; if not, write to the Free Software
> + * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
> + * MA 02111-1307 USA
> + */
> +
> +#ifndef _TMU_H
> +#define _TMU_H
> +
> +enum tmu_status_t {
> + TMU_STATUS_INIT = 0,
> + TMU_STATUS_NORMAL,
> + TMU_STATUS_WARNING,
> + TMU_STATUS_TRIPPED,
> +};
> +
> +/*
> + * Monitors status of the TMU device and exynos temperature
> + *
> + * @param temp pointer to the current temperature value
> + * @return enum tmu_status_t value, code indicating event to execute
> + * and -1 on error
> + */
> +enum tmu_status_t tmu_monitor(int *temp);
> +
> +/*
> + * Initialize TMU device
> + *
> + * @param blob FDT blob
> + * @return int value, 0 for success
> + */
> +int tmu_init(const void *blob);
> +#endif /* _THERMAL_H_ */
> --
> 1.7.9.5
>
Regards,
Simon
^ permalink raw reply [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 2/7 v5] EXYNOS5: Implement board_poweroff for Thermal Management Unit
2013-01-21 11:11 ` [U-Boot] [PATCH 2/7 v5] EXYNOS5: Implement board_poweroff " Akshay Saraswat
@ 2013-01-22 15:52 ` Simon Glass
0 siblings, 0 replies; 15+ messages in thread
From: Simon Glass @ 2013-01-22 15:52 UTC (permalink / raw)
To: u-boot
On Mon, Jan 21, 2013 at 3:11 AM, Akshay Saraswat <akshay.s@samsung.com> wrote:
> Adding API in power for system shutdown when tripping value is reached
> in Exynos Thermal Management Unit.
>
> Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
Acked-by: Simon Glass <sjg@chromium.org>
> ---
> Changes since v4:
> - Changed API name from power_shutdown to generic board_poweroff defined in commomn.h.
>
> arch/arm/cpu/armv7/exynos/power.c | 15 +++++++++++++++
> arch/arm/include/asm/arch-exynos/power.h | 1 +
> 2 files changed, 16 insertions(+)
>
> diff --git a/arch/arm/cpu/armv7/exynos/power.c b/arch/arm/cpu/armv7/exynos/power.c
> index d4bce6d..1d26982 100644
> --- a/arch/arm/cpu/armv7/exynos/power.c
> +++ b/arch/arm/cpu/armv7/exynos/power.c
> @@ -95,3 +95,18 @@ void set_dp_phy_ctrl(unsigned int enable)
> if (cpu_is_exynos5())
> exynos5_dp_phy_control(enable);
> }
> +
> +/*
> + * This function never returns.
> + * When called this function makes system hang and PAD driving value high
> + * which in turn makes system power down.
> + */
> +void board_poweroff(void)
> +{
> + struct exynos5_power *power =
> + (struct exynos5_power *)samsung_get_base_power();
> +
> + clrbits_le32(&power->ps_hold_control, POWER_PS_HOLD_CONTROL_DATA_HIGH);
> +
> + hang();
> +}
> diff --git a/arch/arm/include/asm/arch-exynos/power.h b/arch/arm/include/asm/arch-exynos/power.h
> index d2fdb59..7463036 100644
> --- a/arch/arm/include/asm/arch-exynos/power.h
> +++ b/arch/arm/include/asm/arch-exynos/power.h
> @@ -863,5 +863,6 @@ void set_usbhost_phy_ctrl(unsigned int enable);
> void set_dp_phy_ctrl(unsigned int enable);
>
> #define EXYNOS_DP_PHY_ENABLE (1 << 0)
> +#define POWER_PS_HOLD_CONTROL_DATA_HIGH (1 << 8)
>
> #endif
> --
> 1.7.9.5
>
^ permalink raw reply [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 3/7 v5] EXYNOS5: FDT: Add TMU device node values
2013-01-21 11:11 ` [U-Boot] [PATCH 3/7 v5] EXYNOS5: FDT: Add TMU device node values Akshay Saraswat
@ 2013-01-22 15:58 ` Simon Glass
0 siblings, 0 replies; 15+ messages in thread
From: Simon Glass @ 2013-01-22 15:58 UTC (permalink / raw)
To: u-boot
Hi Akshay,
On Mon, Jan 21, 2013 at 3:11 AM, Akshay Saraswat <akshay.s@samsung.com> wrote:
> Fdt entry for Exynos TMU driver specific pre-defined values used for
> calibration of current temperature and defining threshold values.
>
> Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
With nits below fixed
Acked-by: Simon Glass <sjg@chromium.org>
> ---
> Changes since v4:
> - Rebased this patch.
>
> arch/arm/dts/exynos5250.dtsi | 5 +++++
> board/samsung/dts/exynos5250-smdk5250.dts | 13 +++++++++++
> doc/device-tree-bindings/exynos/tmu.txt | 35 +++++++++++++++++++++++++++++
> include/fdtdec.h | 1 +
> lib/fdtdec.c | 1 +
> 5 files changed, 55 insertions(+)
> create mode 100644 doc/device-tree-bindings/exynos/tmu.txt
>
> diff --git a/arch/arm/dts/exynos5250.dtsi b/arch/arm/dts/exynos5250.dtsi
> index ed8c8dd..b2ef42e 100644
> --- a/arch/arm/dts/exynos5250.dtsi
> +++ b/arch/arm/dts/exynos5250.dtsi
> @@ -151,4 +151,9 @@
> };
> };
>
> + tmu at 10060000 {
> + compatible = "samsung,exynos-tmu";
> + reg = <0x10060000 0xffff>;
The size should be 0x10000 I think.
> + };
> +
> };
> diff --git a/board/samsung/dts/exynos5250-smdk5250.dts b/board/samsung/dts/exynos5250-smdk5250.dts
> index cbfab6f..f49ca44 100644
> --- a/board/samsung/dts/exynos5250-smdk5250.dts
> +++ b/board/samsung/dts/exynos5250-smdk5250.dts
> @@ -66,4 +66,17 @@
> compatible = "maxim,max77686_pmic";
> };
> };
> +
> + tmu at 10060000 {
> + samsung,mux = <6>;
> + samsung,min-temp = <25>;
> + samsung,max-temp = <125>;
> + samsung,start-warning = <95>;
> + samsung,start-tripping = <105>;
> + samsung,efuse-min-value = <40>;
> + samsung,efuse-value = <55>;
> + samsung,efuse-max-value = <100>;
> + samsung,slope = <268470274>;
> + samsung,dc-value = <25>;
> + };
> };
> diff --git a/doc/device-tree-bindings/exynos/tmu.txt b/doc/device-tree-bindings/exynos/tmu.txt
> new file mode 100644
> index 0000000..ed1e22a
> --- /dev/null
> +++ b/doc/device-tree-bindings/exynos/tmu.txt
> @@ -0,0 +1,35 @@
> +Exynos Thermal management Unit
> +
> +The device node for TMU that is a part of Exynos5250
> +SOC is as described in the document "Open Firmware Recommended
> +Practic : Universal Serial Bus" with the following modifications
Practice
> +and additions:
> +
> +Required properties :
> + - compatible : Should be "samsung,exynos-tmu" for TMU
> + - samsung,mux : mux Address for the TMU to enable TMU core
This doesn't make a lot of sense - can you expand this comment a bit
so people know what value to use?
> + - samsung,min-temp : Minimum temperature, default is 25
> + - samsung,max-temp : Maximum temperature, defalut set to 125
> + - samsung,start-warning : temp at which TMU start giving warning
> + - samsung,start-tripping : temp at which system will trip and shutdown
> + - samsung,efuse-min-value : SOC efuse min value
> + - samsung,efuse-value : SOC actual efuse value
> + - samsung,efuse-max-value : SoC max efuse value
> + - samsung,slope : Gain of amplifier, default is 268470274
What are the units for this value?
> + - samsung,dc-value : DC value of TMU, default is 25
> +
> +Example:
> +
> +tmu at 10060000 {
> + compatible = "samsung,exynos-tmu"
> + samsung,mux = <6>;
> + samsung,min-temp = <25>;
> + samsung,max-temp = <125>;
> + samsung,start-warning = <95>;
> + samsung,start-tripping = <105>;
> + samsung,efuse-min-value = <40>;
> + samsung,efuse-value = <55>;
> + samsung,efuse-max-value = <100>;
> + samsung,slope = <268470274>;
> + samsung,dc-value = <25>;
> +};
> diff --git a/include/fdtdec.h b/include/fdtdec.h
> index f77d195..058fb51 100644
> --- a/include/fdtdec.h
> +++ b/include/fdtdec.h
> @@ -79,6 +79,7 @@ enum fdt_compat_id {
> COMPAT_SAMSUNG_EXYNOS_EHCI, /* Exynos EHCI controller */
> COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */
> COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */
> + COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */
>
> COMPAT_COUNT,
> };
> diff --git a/lib/fdtdec.c b/lib/fdtdec.c
> index 16921e1..4613fcd 100644
> --- a/lib/fdtdec.c
> +++ b/lib/fdtdec.c
> @@ -54,6 +54,7 @@ static const char * const compat_names[COMPAT_COUNT] = {
> COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
> COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
> COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
> + COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
> };
>
> const char *fdtdec_get_compatible(enum fdt_compat_id id)
> --
> 1.7.9.5
>
Regards,
Simon
^ permalink raw reply [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 4/7 v5] EXYNOS5: TMU: Add TMU init and status check
2013-01-21 11:11 ` [U-Boot] [PATCH 4/7 v5] EXYNOS5: TMU: Add TMU init and status check Akshay Saraswat
@ 2013-01-22 20:45 ` Simon Glass
0 siblings, 0 replies; 15+ messages in thread
From: Simon Glass @ 2013-01-22 20:45 UTC (permalink / raw)
To: u-boot
On Mon, Jan 21, 2013 at 3:11 AM, Akshay Saraswat <akshay.s@samsung.com> wrote:
> This adds call to tmu_init() and TMU boot time analysis
> for the SoC temperature threshold breach.
>
> Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
Acked-by: Simon Glass <sjg@chromium.org>
> ---
> Changes since v4:
> - Replaced board polling with initial SoC temperature analysis for any possible threshold breach.
>
> board/samsung/smdk5250/smdk5250.c | 35 +++++++++++++++++++++++++++++++++++
> 1 file changed, 35 insertions(+)
>
> diff --git a/board/samsung/smdk5250/smdk5250.c b/board/samsung/smdk5250/smdk5250.c
> index 7a5f132..7b9a8c5 100644
> --- a/board/samsung/smdk5250/smdk5250.c
> +++ b/board/samsung/smdk5250/smdk5250.c
> @@ -35,9 +35,35 @@
> #include <asm/arch/sromc.h>
> #include <asm/arch/dp_info.h>
> #include <power/pmic.h>
> +#include <tmu.h>
>
> DECLARE_GLOBAL_DATA_PTR;
>
> +#if defined CONFIG_EXYNOS_TMU
> +/*
> + * Boot Time Thermal Analysis for SoC temperature threshold breach
> + */
> +void boot_temp_check(void)
> +{
> + int temp;
> +
> + switch (tmu_monitor(&temp)) {
> + case TMU_STATUS_TRIPPED:
> + puts("EXYNOS_TMU: TRIPPING! Device power going down ...\n");
> + board_poweroff();
> + break;
> + case TMU_STATUS_WARNING:
> + puts("EXYNOS_TMU: WARNING! Temperature very high\n");
> + break;
> + case TMU_STATUS_NORMAL:
> + break;
> + case TMU_STATUS_INIT:
> + default:
> + debug("Unknown TMU state\n");
> + }
> +}
> +#endif
> +
> #ifdef CONFIG_USB_EHCI_EXYNOS
> int board_usb_vbus_init(void)
> {
> @@ -57,6 +83,15 @@ int board_usb_vbus_init(void)
> int board_init(void)
> {
> gd->bd->bi_boot_params = (PHYS_SDRAM_1 + 0x100UL);
> +
> +#if defined CONFIG_EXYNOS_TMU
> + if (tmu_init(gd->fdt_blob)) {
> + debug("%s: Failed to init TMU\n", __func__);
> + return -1;
> + }
> + boot_temp_check();
> +#endif
> +
> #ifdef CONFIG_EXYNOS_SPI
> spi_init();
> #endif
> --
> 1.7.9.5
>
^ permalink raw reply [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 5/7 v5] EXYNOS5: Config: Enable support for Exynos TMU driver
2013-01-21 11:11 ` [U-Boot] [PATCH 5/7 v5] EXYNOS5: Config: Enable support for Exynos TMU driver Akshay Saraswat
@ 2013-01-22 20:46 ` Simon Glass
0 siblings, 0 replies; 15+ messages in thread
From: Simon Glass @ 2013-01-22 20:46 UTC (permalink / raw)
To: u-boot
On Mon, Jan 21, 2013 at 3:11 AM, Akshay Saraswat <akshay.s@samsung.com> wrote:
> Enables TMU driver support for exynos5250
>
> Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
Acked-by: Simon Glass <sjg@chromium.org>
> ---
> Changes since v4:
> - Rebased this patch.
>
> include/configs/exynos5250-dt.h | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/include/configs/exynos5250-dt.h b/include/configs/exynos5250-dt.h
> index cabd2f2..53ca41f 100644
> --- a/include/configs/exynos5250-dt.h
> +++ b/include/configs/exynos5250-dt.h
> @@ -117,6 +117,9 @@
> #define CONFIG_BOOTDELAY 3
> #define CONFIG_ZERO_BOOTDELAY_CHECK
>
> +/* Thermal Management Unit */
> +#define CONFIG_EXYNOS_TMU
> +
> /* USB */
> #define CONFIG_CMD_USB
> #define CONFIG_USB_EHCI
> --
> 1.7.9.5
>
^ permalink raw reply [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 6/7 v5] TMU: Add TMU support in dtt command
2013-01-21 11:11 ` [U-Boot] [PATCH 6/7 v5] TMU: Add TMU support in dtt command Akshay Saraswat
@ 2013-01-22 20:51 ` Simon Glass
0 siblings, 0 replies; 15+ messages in thread
From: Simon Glass @ 2013-01-22 20:51 UTC (permalink / raw)
To: u-boot
Hi Akshay,
On Mon, Jan 21, 2013 at 3:11 AM, Akshay Saraswat <akshay.s@samsung.com> wrote:
> Add generic TMU support alongwith i2c sensors in dtt command
> to enable temperature reading in cases where TMU is present
> instead of i2c sensors.
>
> Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
> ---
> Changes since v4:
> - Removed tmu command and added to dtt.
>
> common/cmd_dtt.c | 19 +++++++++++++++++++
> 1 file changed, 19 insertions(+)
>
> diff --git a/common/cmd_dtt.c b/common/cmd_dtt.c
> index cd94423..715f4ba 100644
> --- a/common/cmd_dtt.c
> +++ b/common/cmd_dtt.c
> @@ -28,6 +28,20 @@
> #include <dtt.h>
> #include <i2c.h>
>
> +#if defined CONFIG_TMU_CMD_DTT
> +#include <tmu.h>
> +
> +void dtt_get_temp(void)
> +{
> + int cur_temp;
> +
> + if (tmu_monitor(&cur_temp) == TMU_STATUS_INIT)
> + printf("TMU is in unknown state, temperature is invalid \n");
puts()
Should return an error result here so that do_dtt() returns 1.
> + else
> + printf("Current temperature: %u degrees Celsius \n", cur_temp);
> +}
> +
> +#else
> static unsigned long sensor_initialized;
>
> static void _initialize_dtt(void)
> @@ -59,9 +73,13 @@ void dtt_init(void)
> /* switch back to original I2C bus */
> I2C_SET_BUS(old_bus);
> }
> +#endif
>
> int do_dtt (cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
> {
> +#if defined CONFIG_TMU_CMD_DTT
> + dtt_get_temp();
> +#else
How about creating two versions of the dtt_get_temp() function: one
with your code and one with the old code? Then you don't have an
#ifdef here.
> int i;
> unsigned char sensors[] = CONFIG_DTT_SENSORS;
> int old_bus;
> @@ -83,6 +101,7 @@ int do_dtt (cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
>
> /* switch back to original I2C bus */
> I2C_SET_BUS(old_bus);
> +#endif
>
> return 0;
> } /* do_dtt() */
> --
> 1.7.9.5
>
Regards,
Simon
^ permalink raw reply [flat|nested] 15+ messages in thread
* [U-Boot] [PATCH 7/7 v5] EXYNOS5: Config: Enable dtt command for TMU
2013-01-21 11:11 ` [U-Boot] [PATCH 7/7 v5] EXYNOS5: Config: Enable dtt command for TMU Akshay Saraswat
@ 2013-01-22 20:51 ` Simon Glass
0 siblings, 0 replies; 15+ messages in thread
From: Simon Glass @ 2013-01-22 20:51 UTC (permalink / raw)
To: u-boot
On Mon, Jan 21, 2013 at 3:11 AM, Akshay Saraswat <akshay.s@samsung.com> wrote:
> This enables the dtt command to read the current SOC
> temperature with the help of TMU
>
> Signed-off-by: Akshay Saraswat <akshay.s@samsung.com>
Acked-by: Simon Glass <sjg@chromium.org>
> ---
> Changes since v4:
> - Replaced tmu command configs with corresponding dtt configs.
>
> include/configs/exynos5250-dt.h | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/include/configs/exynos5250-dt.h b/include/configs/exynos5250-dt.h
> index 53ca41f..8a8e9fe 100644
> --- a/include/configs/exynos5250-dt.h
> +++ b/include/configs/exynos5250-dt.h
> @@ -119,6 +119,8 @@
>
> /* Thermal Management Unit */
> #define CONFIG_EXYNOS_TMU
> +#define CONFIG_CMD_DTT
> +#define CONFIG_TMU_CMD_DTT
>
> /* USB */
> #define CONFIG_CMD_USB
> --
> 1.7.9.5
>
^ permalink raw reply [flat|nested] 15+ messages in thread
end of thread, other threads:[~2013-01-22 20:51 UTC | newest]
Thread overview: 15+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2013-01-21 11:11 [U-Boot] [PATCH 0/7 v5] Add TMU support for Exynos5250 based SMDK5250 Akshay Saraswat
2013-01-21 11:11 ` [U-Boot] [PATCH 1/7 v5] EXYNOS5: TMU: Add driver for Thermal Management Unit Akshay Saraswat
2013-01-22 15:51 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 2/7 v5] EXYNOS5: Implement board_poweroff " Akshay Saraswat
2013-01-22 15:52 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 3/7 v5] EXYNOS5: FDT: Add TMU device node values Akshay Saraswat
2013-01-22 15:58 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 4/7 v5] EXYNOS5: TMU: Add TMU init and status check Akshay Saraswat
2013-01-22 20:45 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 5/7 v5] EXYNOS5: Config: Enable support for Exynos TMU driver Akshay Saraswat
2013-01-22 20:46 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 6/7 v5] TMU: Add TMU support in dtt command Akshay Saraswat
2013-01-22 20:51 ` Simon Glass
2013-01-21 11:11 ` [U-Boot] [PATCH 7/7 v5] EXYNOS5: Config: Enable dtt command for TMU Akshay Saraswat
2013-01-22 20:51 ` Simon Glass
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.