drivers: tegra: pmc: change name of struct tegra_tsensor_pmu_data

At Aleks' request, change the name of struct tegra_tsensor_pmu_data, to
clarify what it is and what it does.  This structure has nothing to do
with PMIC temperature sensors.  Instead it's used to configure the boot ROM
appropriately to tell the PMIC how to power off the SoC after SOC_THERM's
critical thermal trip point has been reached ("thermtrip").

The name will now be 'struct tegra_thermtrip_pmic_data'.

Change-Id: I40e5aeeb74267993272e33c92300d3506a15a4a8
Cc: Aleksandr Frid <afrid@nvidia.com>
Cc: Diwakar Tundlam <dtundlam@nvidia.com>
Cc: Matthew Longnecker <mlongnecker@nvidia.com>
Signed-off-by: Paul Walmsley <pwalmsley@nvidia.com>
Reviewed-on: http://git-master/r/396170
Reviewed-by: Matthew Longnecker <mlongnecker@nvidia.com>
Reviewed-by: Diwakar Tundlam <dtundlam@nvidia.com>

13 files changed, 24 insertions, 22 deletions

diff --git a/arch/arm/mach-tegra/board-ardbeg-power.c b/arch/arm/mach-tegra/board-ardbeg-power.c
index df5b452397af..12fbd05c779b 100644
--- a/arch/arm/mach-tegra/board-ardbeg-power.c
+++ b/arch/arm/mach-tegra/board-ardbeg-power.c
@@ -397,7 +397,7 @@ static struct thermal_zone_params soctherm_tzp = {
 	.governor_params = &soctherm_pid_params,
 };
 
-static struct tegra_tsensor_pmu_data tpdata_palmas = {
+static struct tegra_thermtrip_pmic_data tpdata_palmas = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
@@ -407,7 +407,7 @@ static struct tegra_tsensor_pmu_data tpdata_palmas = {
 	.poweroff_reg_data = 0x0,
 };
 
-static struct tegra_tsensor_pmu_data tpdata_as3722 = {
+static struct tegra_thermtrip_pmic_data tpdata_as3722 = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
diff --git a/arch/arm/mach-tegra/board-dalmore-power.c b/arch/arm/mach-tegra/board-dalmore-power.c
index 28d685578d46..8bab8e0da739 100644
--- a/arch/arm/mach-tegra/board-dalmore-power.c
+++ b/arch/arm/mach-tegra/board-dalmore-power.c
@@ -1329,7 +1329,7 @@ static struct thermal_zone_params soctherm_tzp = {
 	.governor_params = &soctherm_pid_params,
 };
 
-static struct tegra_tsensor_pmu_data tpdata_palmas = {
+static struct tegra_thermtrip_pmic_data tpdata_palmas = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
@@ -1339,7 +1339,7 @@ static struct tegra_tsensor_pmu_data tpdata_palmas = {
 	.poweroff_reg_data = 0x0,
 };
 
-static struct tegra_tsensor_pmu_data tpdata_max77663 = {
+static struct tegra_thermtrip_pmic_data tpdata_max77663 = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
diff --git a/arch/arm/mach-tegra/board-loki-power.c b/arch/arm/mach-tegra/board-loki-power.c
index d9139c41c1eb..18565d4763b4 100644
--- a/arch/arm/mach-tegra/board-loki-power.c
+++ b/arch/arm/mach-tegra/board-loki-power.c
@@ -913,7 +913,7 @@ static struct thermal_zone_params soctherm_tzp = {
 	.governor_params = &soctherm_pid_params,
 };
 
-static struct tegra_tsensor_pmu_data tpdata_palmas = {
+static struct tegra_thermtrip_pmic_data tpdata_palmas = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
diff --git a/arch/arm/mach-tegra/board-macallan-power.c b/arch/arm/mach-tegra/board-macallan-power.c
index b10d7ac803bb..a6c022e26fc8 100644
--- a/arch/arm/mach-tegra/board-macallan-power.c
+++ b/arch/arm/mach-tegra/board-macallan-power.c
@@ -759,7 +759,7 @@ static struct thermal_zone_params macallan_soctherm_therm_cpu_tzp = {
 	.governor_params = &soctherm_cpu_pid_params,
 };
 
-static struct tegra_tsensor_pmu_data tpdata_palmas = {
+static struct tegra_thermtrip_pmic_data tpdata_palmas = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
diff --git a/arch/arm/mach-tegra/board-norrin-power.c b/arch/arm/mach-tegra/board-norrin-power.c
index f2812911d851..1e0e48b60768 100644
--- a/arch/arm/mach-tegra/board-norrin-power.c
+++ b/arch/arm/mach-tegra/board-norrin-power.c
@@ -200,7 +200,7 @@ static struct thermal_zone_params soctherm_tzp = {
 	.governor_params = &soctherm_pid_params,
 };
 
-static struct tegra_tsensor_pmu_data tpdata_as3722 = {
+static struct tegra_thermtrip_pmic_data tpdata_as3722 = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
diff --git a/arch/arm/mach-tegra/board-pismo-power.c b/arch/arm/mach-tegra/board-pismo-power.c
index a3d2df5d85f9..fcc45b90fbf7 100644
--- a/arch/arm/mach-tegra/board-pismo-power.c
+++ b/arch/arm/mach-tegra/board-pismo-power.c
@@ -817,7 +817,7 @@ int __init pismo_edp_init(void)
 
 /* place holder for tpdata for as3720 regulator
  * TODO: fill the correct i2c type, bus, reg_addr and data here:
-static struct tegra_tsensor_pmu_data tpdata_as3720 = {
+static struct tegra_thermtrip_pmic_data tpdata_as3720 = {
 	.reset_tegra = ,
 	.pmu_16bit_ops = ,
 	.controller_type = ,
diff --git a/arch/arm/mach-tegra/board-pluto-power.c b/arch/arm/mach-tegra/board-pluto-power.c
index f8f4dae5532b..39722415e1dc 100644
--- a/arch/arm/mach-tegra/board-pluto-power.c
+++ b/arch/arm/mach-tegra/board-pluto-power.c
@@ -821,7 +821,7 @@ static struct thermal_zone_params soctherm_tzp = {
 	.governor_params = &soctherm_pid_params,
 };
 
-static struct tegra_tsensor_pmu_data tpdata_palmas = {
+static struct tegra_thermtrip_pmic_data tpdata_palmas = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
diff --git a/arch/arm/mach-tegra/board-roth-power.c b/arch/arm/mach-tegra/board-roth-power.c
index ea2f75e76e71..195c55f91692 100644
--- a/arch/arm/mach-tegra/board-roth-power.c
+++ b/arch/arm/mach-tegra/board-roth-power.c
@@ -776,7 +776,7 @@ int __init roth_edp_init(void)
 	return 0;
 }
 
-static struct tegra_tsensor_pmu_data tpdata_palmas = {
+static struct tegra_thermtrip_pmic_data tpdata_palmas = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
diff --git a/arch/arm/mach-tegra/board-vcm30_t124-power.c b/arch/arm/mach-tegra/board-vcm30_t124-power.c
index 590d1440446e..8cdfd4b745ce 100644
--- a/arch/arm/mach-tegra/board-vcm30_t124-power.c
+++ b/arch/arm/mach-tegra/board-vcm30_t124-power.c
@@ -273,7 +273,7 @@ static struct thermal_zone_params soctherm_tzp = {
 	.governor_name = "pid_thermal_gov",
 };
 
-static struct tegra_tsensor_pmu_data tpdata_palmas = {
+static struct tegra_thermtrip_pmic_data tpdata_palmas = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
@@ -283,7 +283,7 @@ static struct tegra_tsensor_pmu_data tpdata_palmas = {
 	.poweroff_reg_data = 0x0,
 };
 
-static struct tegra_tsensor_pmu_data tpdata_max77663 = {
+static struct tegra_thermtrip_pmic_data tpdata_max77663 = {
 	.reset_tegra = 1,
 	.pmu_16bit_ops = 0,
 	.controller_type = 0,
diff --git a/arch/arm/mach-tegra/tegra11_soctherm.c b/arch/arm/mach-tegra/tegra11_soctherm.c
index 09a7657a1483..26142de97936 100644
--- a/arch/arm/mach-tegra/tegra11_soctherm.c
+++ b/arch/arm/mach-tegra/tegra11_soctherm.c
@@ -2634,7 +2634,7 @@ static int soctherm_fuse_read_tsensor(enum soctherm_sense sensor)
  * PMC will use if SOC_THERM requests a shutdown based on excessive
  * temperature (i.e. a thermtrip).
  */
-static void soctherm_therm_trip_init(struct tegra_tsensor_pmu_data *data)
+static void soctherm_therm_trip_init(struct tegra_thermtrip_pmic_data *data)
 {
 	if (!data)
 		return;
diff --git a/arch/arm/mach-tegra/tegra11_soctherm.h b/arch/arm/mach-tegra/tegra11_soctherm.h
index 336d18abdd9e..5178c3e09735 100644
--- a/arch/arm/mach-tegra/tegra11_soctherm.h
+++ b/arch/arm/mach-tegra/tegra11_soctherm.h
@@ -149,7 +149,7 @@ struct soctherm_tsensor_pmu_data {
  *				responses.
  *				See struct soctherm_throttle.
  * @tshut_pmu_trip_data:	PMU-specific thermal shutdown settings.
- *				See struct tegra_tsensor_pmu_data.
+ *				See struct tegra_thermtrip_pmic_data.
  *
  * therm is used for trip point configuration and should be moved out of
  * soctherm_platform_data.
@@ -164,7 +164,7 @@ struct soctherm_platform_data {
 	struct soctherm_sensor sensor_data[TSENSE_SIZE];
 	struct soctherm_therm therm[THERM_SIZE];
 	struct soctherm_throttle throttle[THROTTLE_SIZE];
-	struct tegra_tsensor_pmu_data *tshut_pmu_trip_data;
+	struct tegra_thermtrip_pmic_data *tshut_pmu_trip_data;
 };
 
 #ifdef CONFIG_TEGRA_SOCTHERM
diff --git a/drivers/platform/tegra/pmc.c b/drivers/platform/tegra/pmc.c
index d4f69642e7a0..1b7e6983031a 100644
--- a/drivers/platform/tegra/pmc.c
+++ b/drivers/platform/tegra/pmc.c
@@ -181,7 +181,7 @@ EXPORT_SYMBOL(tegra_pmc_enable_thermal_trip);
  *
  * XXX This function does no input validation, but it should.
  */
-void tegra_pmc_config_thermal_trip(struct tegra_tsensor_pmu_data *data)
+void tegra_pmc_config_thermal_trip(struct tegra_thermtrip_pmic_data *data)
 {
 	u32 v = 0;
 	u32 c, w;
diff --git a/include/linux/tegra-pmc.h b/include/linux/tegra-pmc.h
index 9f712ca13af3..002f8849905d 100644
--- a/include/linux/tegra-pmc.h
+++ b/include/linux/tegra-pmc.h
@@ -52,8 +52,7 @@ struct pmc_pm_data {
 };
 
 /**
- * struct tegra_tsensor_pmu_data - PMIC temperature sensor
- * configuration
+ * struct tegra_thermtrip_pmic_data - PMIC shutdown command data
  * @poweroff_reg_data:	The data to write to turn the system off
  * @poweroff_reg_addr:	The PMU address of poweroff register
  * @reset_tegra:	Flag indicating whether or not the system
@@ -76,8 +75,11 @@ struct pmc_pm_data {
  *			operations.
  * @pmu_i2c_addr:	The address of the PMIC on the I2C bus
  *
- * When the temperature gets too high, the PMIC will power off the device
- * based on what is written to the PMIC registers.
+ * When the SoC temperature gets too high, the SOC_THERM hardware can
+ * reset the SoC, and, by setting a bit in one of its registers, can
+ * instruct the boot ROM to power off the Tegra SoC. This data
+ * structure contains the information that the boot ROM needs to tell
+ * the PMIC to shut down.
  *
  * @poweroff_reg_data and @poweroff_reg_addr are written to the PMC SCRATCH54
  * register.
@@ -85,7 +87,7 @@ struct pmc_pm_data {
  * @reset_tegra, @controller_type, @i2c_controller_id, @pinmux, @pmu_16bit_ops
  * and @pmu_i2c_addr are written to the PMC SCRATCH55 register.
  */
-struct tegra_tsensor_pmu_data {
+struct tegra_thermtrip_pmic_data {
 	u8 poweroff_reg_data;
 	u8 poweroff_reg_addr;
 	u8 reset_tegra;
@@ -106,7 +108,7 @@ int tegra_pmc_cpu_remove_clamping(int cpuid);
 void tegra_pmc_pmu_interrupt_polarity(bool active_low);
 struct pmc_pm_data *tegra_get_pm_data(void);
 
-extern void tegra_pmc_config_thermal_trip(struct tegra_tsensor_pmu_data *data);
+extern void tegra_pmc_config_thermal_trip(struct tegra_thermtrip_pmic_data *data);
 
 extern void tegra_pmc_enable_thermal_trip(void);