thermal: rockchip: add the notes for better reading (678065d5) · Commits · e / devices / android_kernel_fairphone_FP5

drivers/thermal/rockchip_thermal.c

+53 −21

Original line number	Original line	Diff line number	Diff line
	/*		/*
	* Copyright (c) 2014, Fuzhou Rockchip Electronics Co., Ltd		* Copyright (c) 2014-2016, Fuzhou Rockchip Electronics Co., Ltd
	*
	* Copyright (c) 2015, Fuzhou Rockchip Electronics Co., Ltd
	* Caesar Wang <wxt@rock-chips.com>		* Caesar Wang <wxt@rock-chips.com>
	*		*
	* This program is free software; you can redistribute it and/or modify it		* This program is free software; you can redistribute it and/or modify it
	@@ -75,7 +73,7 @@ enum adc_sort_mode {
	#define SOC_MAX_SENSORS 2		#define SOC_MAX_SENSORS 2

	/**		/**
	* struct chip_tsadc_table: hold information about chip-specific differences		* struct chip_tsadc_table - hold information about chip-specific differences
	* @id: conversion table		* @id: conversion table
	* @length: size of conversion table		* @length: size of conversion table
	* @data_mask: mask to apply on data inputs		* @data_mask: mask to apply on data inputs
	@@ -88,6 +86,20 @@ struct chip_tsadc_table {
	enum adc_sort_mode mode;		enum adc_sort_mode mode;
	};		};

			/**
			* struct rockchip_tsadc_chip - hold the private data of tsadc chip
			* @chn_id[SOC_MAX_SENSORS]: the sensor id of chip correspond to the channel
			* @chn_num: the channel number of tsadc chip
			* @tshut_temp: the hardware-controlled shutdown temperature value
			* @tshut_mode: the hardware-controlled shutdown mode (0:CRU 1:GPIO)
			* @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH)
			* @initialize: SoC special initialize tsadc controller method
			* @irq_ack: clear the interrupt
			* @get_temp: get the temperature
			* @set_tshut_temp: set the hardware-controlled shutdown temperature
			* @set_tshut_mode: set the hardware-controlled shutdown mode
			* @table: the chip-specific conversion table
			*/
	struct rockchip_tsadc_chip {		struct rockchip_tsadc_chip {
	/* The sensor id of chip correspond to the ADC channel */		/* The sensor id of chip correspond to the ADC channel */
	int chn_id[SOC_MAX_SENSORS];		int chn_id[SOC_MAX_SENSORS];
	@@ -115,12 +127,32 @@ struct rockchip_tsadc_chip {
	struct chip_tsadc_table table;		struct chip_tsadc_table table;
	};		};

			/**
			* struct rockchip_thermal_sensor - hold the information of thermal sensor
			* @thermal: pointer to the platform/configuration data
			* @tzd: pointer to a thermal zone
			* @id: identifier of the thermal sensor
			*/
	struct rockchip_thermal_sensor {		struct rockchip_thermal_sensor {
	struct rockchip_thermal_data *thermal;		struct rockchip_thermal_data *thermal;
	struct thermal_zone_device *tzd;		struct thermal_zone_device *tzd;
	int id;		int id;
	};		};

			/**
			* struct rockchip_thermal_data - hold the private data of thermal driver
			* @chip: pointer to the platform/configuration data
			* @pdev: platform device of thermal
			* @reset: the reset controller of tsadc
			* @sensors[SOC_MAX_SENSORS]: the thermal sensor
			* @clk: the controller clock is divided by the exteral 24MHz
			* @pclk: the advanced peripherals bus clock
			* @grf: the general register file will be used to do static set by software
			* @regs: the base address of tsadc controller
			* @tshut_temp: the hardware-controlled shutdown temperature value
			* @tshut_mode: the hardware-controlled shutdown mode (0:CRU 1:GPIO)
			* @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH)
			*/
	struct rockchip_thermal_data {		struct rockchip_thermal_data {
	const struct rockchip_tsadc_chip *chip;		const struct rockchip_tsadc_chip *chip;
	struct platform_device *pdev;		struct platform_device *pdev;
	@@ -160,12 +192,7 @@ struct rockchip_thermal_data {
	#define TSADCV2_AUTO_EN BIT(0)		#define TSADCV2_AUTO_EN BIT(0)
	#define TSADCV2_AUTO_SRC_EN(chn) BIT(4 + (chn))		#define TSADCV2_AUTO_SRC_EN(chn) BIT(4 + (chn))
	#define TSADCV2_AUTO_TSHUT_POLARITY_HIGH BIT(8)		#define TSADCV2_AUTO_TSHUT_POLARITY_HIGH BIT(8)
	/**
	* TSADCV1_AUTO_Q_SEL_EN:
	* whether select (1024 - tsadc_q) as output
	* 1'b0:use tsadc_q as output(temperature-code is rising sequence)
	* 1'b1:use(1024 - tsadc_q) as output (temperature-code is falling sequence)
	*/
	#define TSADCV3_AUTO_Q_SEL_EN BIT(1)		#define TSADCV3_AUTO_Q_SEL_EN BIT(1)

	#define TSADCV2_INT_SRC_EN(chn) BIT(chn)		#define TSADCV2_INT_SRC_EN(chn) BIT(chn)
	@@ -193,18 +220,21 @@ struct rockchip_thermal_data {
	#define GRF_SARADC_TESTBIT_ON (0x10001 << 2)		#define GRF_SARADC_TESTBIT_ON (0x10001 << 2)
	#define GRF_TSADC_TESTBIT_H_ON (0x10001 << 2)		#define GRF_TSADC_TESTBIT_H_ON (0x10001 << 2)

	struct tsadc_table {
	u32 code;
	int temp;
	};

	/**		/**
			* struct tsadc_table - code to temperature conversion table
			* @code: the value of adc channel
			* @temp: the temperature
	* Note:		* Note:
	* Code to Temperature mapping of the Temperature sensor is a piece wise linear		* code to temperature mapping of the temperature sensor is a piece wise linear
	* curve.Any temperature, code faling between to 2 give temperatures can be		* curve.Any temperature, code faling between to 2 give temperatures can be
	* linearly interpolated.		* linearly interpolated.
	* Code to Temperature mapping should be updated based on sillcon results.		* Code to Temperature mapping should be updated based on manufacturer results.
	*/		*/
			struct tsadc_table {
			u32 code;
			int temp;
			};

	static const struct tsadc_table rk3228_code_table[] = {		static const struct tsadc_table rk3228_code_table[] = {
	{0, -40000},		{0, -40000},
	{588, -40000},		{588, -40000},
	@@ -490,6 +520,7 @@ static void rk_tsadcv2_initialize(struct regmap grf, void __iomem regs,

	/**		/**
	* rk_tsadcv3_initialize - initialize TASDC Controller.		* rk_tsadcv3_initialize - initialize TASDC Controller.
			*
	* (1) The tsadc control power sequence.		* (1) The tsadc control power sequence.
	*		*
	* (2) Set TSADC_V2_AUTO_PERIOD:		* (2) Set TSADC_V2_AUTO_PERIOD:
	@@ -568,10 +599,11 @@ static void rk_tsadcv2_control(void __iomem *regs, bool enable)
	}		}

	/**		/**
	* @rk_tsadcv3_control:		* rk_tsadcv3_control - the tsadc controller is enabled or disabled.
	* TSADC controller works at auto mode, and some SoCs need set the tsadc_q_sel		*
	* bit on TSADCV2_AUTO_CON[1]. The (1024 - tsadc_q) as output adc value if		* NOTE: TSADC controller works at auto mode, and some SoCs need set the
	* setting this bit to enable.		* tsadc_q_sel bit on TSADCV2_AUTO_CON[1]. The (1024 - tsadc_q) as output
			* adc value if setting this bit to enable.
	*/		*/
	static void rk_tsadcv3_control(void __iomem *regs, bool enable)		static void rk_tsadcv3_control(void __iomem *regs, bool enable)
	{		{