Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a12a689c authored by Ke Liu's avatar Ke Liu
Browse files

regulator: qpnp-labibb-regulator: add support for QPNP LAB/IBB regulator 



LAB/IBB regulator can provide power supply for other consumers. Also, they
can work together to provide power supply for LCD or AMOLED panel.

Change-Id: If3eaa9b0fa14a62b2131d5d0853d061c45d846b3
Signed-off-by: default avatarKe Liu <keliu@codeaurora.org>
parent e22a9bf6

Documentation/devicetree/bindings/regulator/qpnp-labibb-regulator.txt

0 → 100644
+162 −0
Original line number Diff line number Diff line 
QTI's LAB (LCD/AMOLED BOOST)/IBB (Inverting Buck-Boost) Regulator



LAB can be used as a standalone positive boost power supply for general purpose

applications. IBB can be used as a standalone negative power supply for general

applications. Also, LAB and IBB can be used together to provide power supply for

display panels, LCD or AMOLED.



Required properties:

- compatible:			Must be "qcom,qpnp-labibb-regulator"

- spmi-dev-container:		Must be present.

- qpnp,qpnp-labibb-mode:	A string used to specify the working mode of LAB/IBB regulators when bootloader does not turned on the display panel.

				Could be "lcd", "amoled" or "stand-alone".

				"lcd" means using LAB and IBB regulators together as lcd mode.

				"amoled" means using LAB and IBB regulators together as amoled mode.

				"stand-alone" means using LAB and IBB regulators as stand alone regulators.



Sub LAB node required structure:

- reg:				Specifies the SPMI address and size for this peripheral

- reg-names:			Register names. Must be "lab"

- regulator-name:		A string used to describe the regulator

- regulator-min-microvolt:	Minimum voltage in microvolts supported by this regulator.

- regulator-max-microvolt:	Maximum voltage in microvolts supported by this regulator.



- qcom,qpnp-lab-min-voltage:	The voltage in microvolts this LAB regulator suppored

- qcom,qpnp-lab-step-size:	The step size in microvolts of LAB regulator

- qcom,qpnp-lab-slew-rate:	The time in us it takes for the regulator to change votlage value in one step.



- qcom,qpnp-lab-init-voltage:	The default initial voltage when the bootloader does not turn on LAB regulator.

- qcom,qpnp-lab-init-amoled-voltage: The default voltage when LAB regualtor working in amoled mode and the output voltage register of value 0

- qcom,qpnp-lab-init-lcd-voltage: The default voltage when LAB regulator working in lcd mode and the output voltage register of value 0

- qcom,qpnp-lab-soft-start:	The soft start time in us of LAB regulator. Supported value are 200, 400, 600 and 800.



- qcom,qpnp-lab-switching-clock-frequency:	The PWM switching clock frequency in kHz of Lab regulator, supported value are

						3200, 	2740, 	2400,  	2130, 	1920, 	1750,	1600,	1480,	1370,	1280,

						1200,	1130,	1070,	1010,	960,	910.

- qcom,qpnp-lab-limit-maximum-current:		The maximum inductor current limit in mA of LAB regulator. Supported value are 200, 400, 600 and 800.



- qcom,qpnp-lab-ps-threshold:	The threshold in mA of Pulse Skipe Mode for LAB regulator, supported value are 20, 30, 40 and 50.

- qcom,qpnp-lab-pfet-size:	FET size in percentage of PFET. Supported value are 25, 50, 75, 100.

- qcom,qpnp-lab-nfet-size:	FET size in percentage of NFET. Supported value are 25, 50, 75, 100.

- qcom,qpnp-lab-max-precharge-time:	Precharge time in us of LAB regulator. Supproted value are 200, 300, 400 and 500.



Sub LAB node optional structure:

- qcom,qpnp-lab-max-precharge-enable:		If this propert is present, fast precharge is enabled. Otherwise, it is disabled.

- qcom,qpnp-lab-ring-suppression-enable:	If this property is present, low noise PS mode will be enabled for LAB regulator. Otherwise, it will be disabled.

- qcom,qpnp-lab-ps-enable:		If this proerty is present, pulse skip mode will be enabled for LAB regulator. Othwise, pulse skip mode will be disabled for LAB regulator.

- qcom,qpnp-lab-full-pull-down:		If this property, the pull down strength of LAB regulator will full. Otherwise, the pull down strength will be half.

- qcom,qpnp-lab-pull-down-enable:	If this property is present, pull down is enabled for LAB regulator. Otherwise, pull down is disabled for LAB regulator.

- qcom,qpnp-lab-limit-max-current-enable:	If this property is present, maximum inductor current constraint is put for LAB regulator. Otherwise, There is no maximum current constraint.

- qcom,qpnp-lab-use-default-voltage:		When bootloader does not turn on LAB regulator and this property is present, value specified in qcom,qpnp-lab-init-voltage is the default init voltage when the voltage output register is of value 0. Otherwise, we need to enable the output override bit in voltage output register.



Sub IBB node required structure:

- reg:				Specifies the SPMI address and size for this peripheral

- reg-names:			Register names. Must be "ibb"

- regulator-name:		A string used to describe the regulator

- regulator-min-microvolt:	Minimum voltage in microvolts supported by this regulator.

- regulator-max-microvolt:	Maximum voltage in microvolts supported by this regulator.



- qcom,qpnp-ibb-min-voltage:	The voltage in microvolts this IBB regulator suppored

- qcom,qpnp-ibb-step-size:	The step size in microvolts of IBB regulator

- qcom,qpnp-ibb-slew-rate:	The time in us it takes for the regulator to change votlage value in one step.

- qcom,qpnp-ibb-soft-start:	The soft start time in us of IBB regulator.



- qcom,qpnp-ibb-init-voltage:	The default initial voltage  when the bootloader does not turn on LAB regulator.

- qcom,qpnp-lab-init-amoled-voltage: The default voltage when IBB regulator working in amoled mode and the output voltage register of value 0

- qcom,qpnp-lab-init-lcd-voltage: The default voltage when IBB regulator working in lcd mode and the output voltage register of value 0



- qcom,qpnp-ibb-discharge-resistor:	The discharge resistor in Kilo Ohm who controls the soft start time. Supported values are 300, 64, 32 and 16.

- qcom,qpnp-ibb-lab-pwrup-delay:	The delay in us of IBB regulator during power up. Supported value are 1250, 2500, 5000 and 10000.

- qcom,qpnp-ibb-lab-pwrdn-delay:	The delay in us of IBB regulator during power down. Supported value are 1250, 2500, 5000 and 10000.



- qcom,qpnp-ibb-switching-clock-frequency:	The PWM switching clock frequency in kHz of IBB regulator, supported value are

						3200, 	2740, 	2400,  	2130, 	1920, 	1750,	1600,	1480,	1370,	1280,

						1200,	1130,	1070,	1010,	960,	910.

- qcom,qpnp-ibb-limit-maximum-current:		The maximum inductor current limit in mA of IBB regulator. Supported value are

						0,	50,	100,	150,	200,	250,	300,	350,	400,	450,

						500,	550,	600,	650,	700,	750,	800,	850,	900,	950,

						1000,	1050,	1100,	1150,	1200,	1250,	1300,	1350,	1400,	1450,	1500,	1550.

- qcom,qpnp-ibb-debounce-cycle:			The debounce cycle of IBB regulator. Supported value are 8, 16, 32 and 64.



Sub IBB node optional structure:

- qcom,qpnp-ibb-en-discharge:			If this property is present, discharge will be enabled for IBB regulator. Otherwise, it will be disabled.

- qcom,qpnp-ibb-ring-suppression-enable:	If this property is present, low noise PS mode will be enabled for IBB regulator. Otherwise, it will be disabled.

- qcom,qpnp-ibb-ps-enable:		If this proerty is present, pulse skip mode will be enabled for IBB regulator. Othwise, pulse skip mode will be disabled for IBB regulator.

- qcom,qpnp-ibb-full-pull-down:		If this property is present, the pull down strength of IBB regulator will full. Otherwise, the pull down strength will be half.

- qcom,qpnp-ibb-pull-down-enable:	If this property is present, pull down is enabled for IBB regulator. Otherwise, pull down is disabled for IBB regulator.

- qcom,qpnp-ibb-limit-max-current-enable:	If this property is present, maximum inductor current constraint is put for IBB regulator. Otherwise, There is no maximum current constraint.

- qcom,qpnp-ibb-use-default-voltage:		When bootloader does not turn on IBB regulator and this property is present, value specified in qcom,qpnp-ibb-init-voltage is the default init voltage when the voltage output register is of value 0. Otherwise, we need to enable the output override bit in voltage output register.



Example:

	qcom,pmi8994@3 {

		qpnp-labibb-regulator {

			spmi-dev-container;

			compatible = "qcom,qpnp-labibb-regulator";

			#address-cells = <1>;

			#size-cells = <1>;

			qpnp,qpnp-labibb-mode = "lcd";



			lab_regulator: qcom,lab@de00 {

				reg = <0xde00 0x100>;

				reg-names = "lab";

				regulator-name = "lab_reg";



				regulator-min-microvolt = <4600000>;

				regulator-max-microvolt = <6000000>;



				qcom,qpnp-lab-min-voltage = <4600000>;

				qcom,qpnp-lab-step-size = <100000>;

				qcom,qpnp-lab-slew-rate = <5000>;

				qcom,qpnp-lab-use-default-voltage;

				qcom,qpnp-lab-init-voltage = <5500000>;

				qcom,qpnp-lab-init-amoled-voltage = <4600000>;

				qcom,qpnp-lab-init-lcd-voltage = <5500000>;



				qcom,qpnp-lab-soft-start = <400>;



				qcom,qpnp-lab-full-pull-down;

				qcom,qpnp-lab-pull-down-enable;

				qcom,qpnp-lab-switching-clock-frequency = <1600>;

				qcom,qpnp-lab-limit-maximum-current = <800>;

				qcom,qpnp-lab-limit-max-current-enable;

				qcom,qpnp-lab-ps-threshold = <40>;

				qcom,qpnp-lab-ps-enable;

				qcom,qpnp-lab-nfet-size = <100>;

				qcom,qpnp-lab-pfet-size = <100>;

				qcom,qpnp-lab-max-precharge-time = <200>;

			};



			ibb_regulator: qcom,ibb@dc00 {

				reg = <0xdc00 0x100>;

				reg-names = "ibb_reg";

				regulator-name = "ibb_reg";



				regulator-min-microvolt = <4600000>;

				regulator-max-microvolt = <6000000>;



				qcom,qpnp-ibb-min-voltage = <1400000>;

				qcom,qpnp-ibb-step-size = <100000>;

				qcom,qpnp-ibb-slew-rate = <2000000>;

				qcom,qpnp-ibb-use-default-voltage;

				qcom,qpnp-ibb-init-voltage = <5500000>;

				qcom,qpnp-ibb-init-amoled-voltage = <4000000>;

				qcom,qpnp-ibb-init-lcd-voltage = <5500000>;



				qcom,qpnp-ibb-soft-start = <400>;



				qcom,qpnp-ibb-discharge-resistor = <300>;

				qcom,qpnp-ibb-lab-pwrup-delay = <10000>;

				qcom,qpnp-ibb-lab-pwrdn-delay = <10000>;

				qcom,qpnp-ibb-en-discharge;



				qcom,qpnp-ibb-full-pull-down;

				qcom,qpnp-ibb-pull-down-enable;

				qcom,qpnp-ibb-switching-clock-frequency = <1480>;

				qcom,qpnp-ibb-limit-maximum-current = <1550>;

				qcom,qpnp-ibb-debounce-cycle = <16>;

				qcom,qpnp-ibb-limit-max-current-enable;

				qcom,qpnp-ibb-ps-enable;

			};



		};

	};

drivers/regulator/Kconfig

+12 −0
Original line number Diff line number Diff line
@@ -588,6 +588,18 @@ config REGULATOR_QPNP 
	  chips provide several different varieties of LDO and switching

	  regulators.  They also provide voltage switches and boost regulators.



config REGULATOR_QPNP_LABIBB

	depends on SPMI

	depends on OF_SPMI

	tristate "Qualcomm Technologies, Inc QPNP LAB/IBB regulator support"

	help

	  This driver supports voltage regulators in Qualcomm Technologies, Inc

	  PMIC chips which comply with QPNP LAB/IBB regulators. QPNP LAB and IBB

	  are SPMI based PMIC implementation. LAB regulator can be used as a

	  regular positive boost regulator. IBB can be used as a regular

	  negative boost regulator. LAB/IBB regulators can also be used

	  together for LCD or AMOLED.



config REGULATOR_SPM

	bool "SPM regulator driver"

	depends on SPMI && OF_SPMI

drivers/regulator/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -79,5 +79,6 @@ obj-$(CONFIG_REGULATOR_RPM_SMD) += rpm-smd-regulator.o 
obj-$(CONFIG_REGULATOR_QPNP) += qpnp-regulator.o

obj-$(CONFIG_REGULATOR_SPM) += spm-regulator.o

obj-$(CONFIG_REGULATOR_CPR) += cpr-regulator.o

obj-$(CONFIG_REGULATOR_QPNP_LABIBB) += qpnp-labibb-regulator.o



ccflags-$(CONFIG_REGULATOR_DEBUG) += -DDEBUG

drivers/regulator/qpnp-labibb-regulator.c

0 → 100644
+2184 −0

File added.

Preview size limit exceeded, changes collapsed.

include/linux/regulator/qpnp-labibb-regulator.h

0 → 100644
+91 −0
Original line number Diff line number Diff line 
/* Copyright (c) 2014, The Linux Foundation. All rights reserved.

 *

 * 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.

 */



#ifndef __REGULATOR_QPNP_LABIBB_REGULATOR_H__

#define __REGULATOR_QPNP_LABIBB_REGULATOR_H__



#ifdef CONFIG_REGULATOR_QPNP_LABIBB

#include <linux/regulator/driver.h>



/** This API is used to set the pull down strength of LAB regulator

 * regulator: the reglator device

 * strength: if strengh is 0, LAB regulator will be set to half strength.

 * otherwise, LAB regulator will be set to full strengh

 */

int qpnp_lab_set_pd_strength(struct regulator *regulator, u32 strength);



/** This API is used to enable pull down of LAB regulator

 * regulator: the reglator device

 * enable: if enable is true, this API will enable pull down of LAB regulator.

 * otherwise, it will disable pull down for LAB regulator

 */

int qpnp_lab_pd_enable_ctl(struct regulator *regulator, bool enable);



/** This API is used to set the power up delay for IBB regulator

 * regulator: the reglator device

 * val: the delay in us for power up of IBB regulator

 */

int qpnp_ibb_set_pwrup_dly(struct regulator *regulator, u32 val);



/** This API is used to set the power down delay for IBB regulator

 * regulator: the reglator device

 * val: the delay in us for power down of IBB regulator

 */

int qpnp_ibb_set_pwrdn_dly(struct regulator *regulator, u32 val);



/** This API is used to set the pull down strength of IBB regulator

 * regulator: the reglator device

 * strength: if strengh is 0, IBB regulator will be set to half strength.

 * otherwise, IBB regulator will be set to full strengh

 */

int qpnp_ibb_set_pd_strength(struct regulator *regulator, u32 strength);



/** This API is used to enable pull down of IBB regulator

 * regulator: the reglator device

 * enable: if enable is true, this API will enable pull down of IBB regulator.

 * otherwise, it will disable pull down for IBB regulator

 */

int qpnp_ibb_pd_enable_ctl(struct regulator *regulator, bool enable);

#else



static int qpnp_lab_set_pd_strength(struct regulator *regulator, u32 strength)

{

	return -ENODEV;

}



static int qpnp_lab_pd_enable_ctl(struct regulator *regulator, bool enable)

{

	return -ENODEV;

}



static inline int qpnp_ibb_set_pwrup_dly(struct regulator *regulator, u32 val)

{

	return -ENODEV;

}



static inline int qpnp_ibb_set_pwrdn_dly(struct regulator *regulator, u32 val)

{

	return -ENODEV;

}



static int qpnp_ibb_set_pd_strength(struct regulator *regulator, u32 strength)

{

	return -ENODEV;

}



static int qpnp_ibb_pd_enable_ctl(struct regulator *regulator, bool enable)

{

	return -ENODEV;

}

#endif /* CONFIG_REGULATOR_QPNP_LABIBB */



#endif /* __REGULATOR_QPNP_LABIBB_REGULATOR_H__ */