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

Commit e9069a1f authored by Subbaraman Narayanamurthy's avatar Subbaraman Narayanamurthy
Browse files

regulator: qpnp-labibb: Fix the LABIBB regulator documentation 



Correct some typos and add line formatting to LABIBB regulator
documentation to make it more readable.

Change-Id: If332f69496571b04df30a9d2bbc4a21eac127dbf
Signed-off-by: default avatarSubbaraman Narayanamurthy <subbaram@codeaurora.org>
parent 630fdcc6

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

+159 −75
Original line number Diff line number Diff line
@@ -5,91 +5,175 @@ 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:

Main node 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

- 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 are

				configured for LCD mode together.

				"amoled" means using LAB and IBB regulators are

				configured for AMOLED mode together.

				"stand-alone" means using LAB and IBB regulators

				as stand alone regulators.



LAB subnode required properties:



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

- qpnp,qpnp-lab-current-sense:	If this property is present, the LAB current sense gain will be programmed for LAB regulator.

				Otherwise, LAB current sense gain will be default to "1x". A string uses to specify the LAB current sense gain.

				Could be "0.5x" or "1x" or "1.5x" or "2x". For ex: "0.5x" means current sense gain is 0.5.





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

- qcom,qpnp-lab-min-voltage:	The minimum voltage in microvolts LAB regulator can support.

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

- qcom,qpnp-lab-slew-rate:	The time in us taken by the regulator to change

				voltage 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 output voltage when LAB regulator

					is configured in amoled mode.

- qcom,qpnp-lab-init-lcd-voltage: 	The default output voltage when LAB regulator

					is configured in lcd mode.

- 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-ps-threshold:		The threshold in mA of Pulse Skip Mode for

					LAB regulator. Supported values are 20, 30,

					40 and 50.

- qcom,qpnp-lab-pfet-size:		PFET size in percentage. Supported values

					are 25, 50, 75 and 100.

- qcom,qpnp-lab-nfet-size:		NFET size in percentage. Supported values

					are 25, 50, 75 and 100.

- qcom,qpnp-lab-max-precharge-time:	Precharge time in us of LAB regulator.

					Supported values are 200, 300, 400 and 500.

- qcom,qpnp-lab-switching-clock-frequency:	The PWM switching clock frequency in

						kHz of Lab regulator, Supported values

						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 values

						are 200, 400, 600 and 800.



LAB subnode optional properties:



- qpnp,qpnp-lab-current-sense:		If this property is specified, the LAB current

					sense gain will be programmed for LAB regulator.

					Otherwise, LAB current sense gain will be

					default to "1x". A string is used to specify the

					LAB current sense gain. Could be "0.5x" or "1x"

					or "1.5x" or "2x". For e.g. "0.5x" means current

					sense gain is 0.5.

- qcom,qpnp-lab-ps-enable:		A boolean proerty which upon set will enable

					pulse skip mode for LAB regulator. Otherwise,

					it is disabled.

- qcom,qpnp-lab-full-pull-down:		A boolean property which upon set will enable

					the pull down strength of LAB regulator to

					full. Otherwise, the pull down strength is

					configured to half.

- qcom,qpnp-lab-pull-down-enable:	A boolean property which upon set will enable

					the pull down for LAB regulator. Otherwise,

					it is disabled.

- qcom,qpnp-lab-max-precharge-enable:		A boolean property which upon set will

						enable fast precharge. Otherwise, it is

						disabled.

- qcom,qpnp-lab-ring-suppression-enable:	A boolean property which upon set will

						enable ring suppression for LAB

						regulator. Otherwise, it is disabled.

- qcom,qpnp-lab-limit-max-current-enable:	A boolean property which upon set will

						enforce maximum inductor current constraint

						for LAB regulator. Otherwise, there is no

						maximum current constraint.

- qcom,qpnp-lab-use-default-voltage:		A boolean property which upon set will

						use the value specified in

						qcom,qpnp-lab-init-voltage property.

						This will be used only if the bootloader

						doesn't configure the output voltage

						already. If it it not specified, then

						output voltage can be configured to

						any value in the allowed limit.



IBB subnode required properties:



- 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-min-voltage:	The minimum voltage in microvolts IBB regulator can support.

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

- qcom,qpnp-ibb-slew-rate:	The time in us taken by the regulator to change

				voltage 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:	Power up delay (in us) for IBB regulator when it is enabled or turned on. Supported value are 1000, 2000, 4000 and 8000.

- qcom,qpnp-ibb-lab-pwrdn-delay:	Power down delay (in us) for IBB regulator when it is disabled or turned off. Supported value are 1000, 2000, 4000 and 8000.



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

- qcom,qpnp-ibb-init-voltage:	The default initial voltage when the bootloader does

				not turn on IBB regulator.

- qcom,qpnp-ibb-init-amoled-voltage:	The default output voltage when IBB regulator

					is configured in amoled mode.

- qcom,qpnp-ibb-init-lcd-voltage: 	The default output voltage when IBB regulator

					is configured in lcd mode.



- qcom,qpnp-ibb-discharge-resistor:	The discharge resistor in Kilo Ohms which

					controls the soft start time. Supported values

					are 300, 64, 32 and 16.

- qcom,qpnp-ibb-lab-pwrup-delay:	Power up delay (in us) for IBB regulator when

					it is enabled or turned on. Supported values

					are 1000, 2000, 4000 and 8000.

- qcom,qpnp-ibb-lab-pwrdn-delay:	Power down delay (in us) for IBB regulator

					when it is disabled or turned off. Supported

					values are 1000, 2000, 4000 and 8000.



- qcom,qpnp-ibb-switching-clock-frequency:	The PWM switching clock frequency in

						kHz of IBB regulator. Supported values

						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 values

						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 and 1550.

- qcom,qpnp-ibb-debounce-cycle:			The debounce cycle of IBB regulator.

						Supported values are 8, 16, 32 and 64.



IBB subnode optional properties:



- qcom,qpnp-ibb-ps-enable:		A boolean property which upon set will enable

					pulse skip mode for IBB regulator. Otherwise,

					it is disabled.

- qcom,qpnp-ibb-full-pull-down:		A boolean property which upon set will enable

					the pull down strength of IBB regulator to

					full. Otherwise, the pull down strength is

					configured to half.

- qcom,qpnp-ibb-pull-down-enable:	A boolean property which upon set will enable

					the pull down for IBB regulator. Otherwise,

					it is disabled.

- qcom,qpnp-ibb-en-discharge:			A boolean property which upon set will

						enable discharge for IBB regulator.

						Otherwise, it is kept disabled.

- qcom,qpnp-ibb-ring-suppression-enable:	A boolean property which upon set will

						enable ring suppression for IBB

						regulator. Otherwise, it is disabled.

- qcom,qpnp-ibb-limit-max-current-enable:	A boolean property which upon set will

						enforce maximum inductor current constraint

						for IBB regulator. Otherwise, there is no

						maximum current constraint.

- qcom,qpnp-ibb-use-default-voltage:		A boolean property which upon set will

						use the value specified in

						qcom,qpnp-ibb-init-voltage property.

						This will be used only if the bootloader

						doesn't configure the output voltage

						already. If it it not specified, then

						output voltage can be configured to

						any value in the allowed limit.



Example:

	qcom,pmi8994@3 {