[deliverable/linux.git] / Documentation / devicetree / bindings / regulator / tps6586x.txt

TPS6586x family of regulators

Required properties:
- compatible: "ti,tps6586x"
- reg: I2C slave address
- interrupts: the interrupt outputs of the controller
- #gpio-cells: number of cells to describe a GPIO
- gpio-controller: mark the device as a GPIO controller
- regulators: A node that houses a sub-node for each regulator within the
  device. Each sub-node is identified using the node's name (or the deprecated
  regulator-compatible property if present), with valid values listed below.
  The content of each sub-node is defined by the standard binding for
  regulators; see regulator.txt.
  sys, sm[0-2], ldo[0-9] and ldo_rtc
- sys-supply: The input supply for SYS.
- vin-sm0-supply: The input supply for the SM0.
- vin-sm1-supply: The input supply for the SM1.
- vin-sm2-supply: The input supply for the SM2.
- vinldo01-supply: The input supply for the LDO1 and LDO2
- vinldo23-supply: The input supply for the LDO2 and LDO3
- vinldo4-supply: The input supply for the LDO4
- vinldo678-supply: The input supply for the LDO6, LDO7 and LDO8
- vinldo9-supply: The input supply for the LDO9

Optional properties:
- ti,system-power-controller: Telling whether or not this pmic is controlling
  the system power.

Each regulator is defined using the standard binding for regulators.

Note: LDO5 and LDO_RTC is supplied by SYS regulator internally and driver
      take care of making proper parent child relationship.

Example:

	pmu: tps6586x@34 {
		compatible = "ti,tps6586x";
		reg = <0x34>;
		interrupts = <0 88 0x4>;

		#gpio-cells = <2>;
		gpio-controller;

		ti,system-power-controller;

		sys-supply = <&some_reg>;
		vin-sm0-supply = <&some_reg>;
		vin-sm1-supply = <&some_reg>;
		vin-sm2-supply = <&some_reg>;
		vinldo01-supply = <...>;
		vinldo23-supply = <...>;
		vinldo4-supply = <...>;
		vinldo678-supply = <...>;
		vinldo9-supply = <...>;

		regulators {
			sys_reg: sys {
				regulator-name = "vdd_sys";
				regulator-boot-on;
				regulator-always-on;
			};

			sm0_reg: sm0 {
				regulator-min-microvolt = < 725000>;
				regulator-max-microvolt = <1500000>;
				regulator-boot-on;
				regulator-always-on;
			};

			sm1_reg: sm1 {
				regulator-min-microvolt = < 725000>;
				regulator-max-microvolt = <1500000>;
				regulator-boot-on;
				regulator-always-on;
			};

			sm2_reg: sm2 {
				regulator-min-microvolt = <3000000>;
				regulator-max-microvolt = <4550000>;
				regulator-boot-on;
				regulator-always-on;
			};

			ldo0_reg: ldo0 {
				regulator-name = "PCIE CLK";
				regulator-min-microvolt = <3300000>;
				regulator-max-microvolt = <3300000>;
			};

			ldo1_reg: ldo1 {
				regulator-min-microvolt = < 725000>;
				regulator-max-microvolt = <1500000>;
			};

			ldo2_reg: ldo2 {
				regulator-min-microvolt = < 725000>;
				regulator-max-microvolt = <1500000>;
			};

			ldo3_reg: ldo3 {
				regulator-min-microvolt = <1250000>;
				regulator-max-microvolt = <3300000>;
			};

			ldo4_reg: ldo4 {
				regulator-min-microvolt = <1700000>;
				regulator-max-microvolt = <2475000>;
			};

			ldo5_reg: ldo5 {
				regulator-min-microvolt = <1250000>;
				regulator-max-microvolt = <3300000>;
			};

			ldo6_reg: ldo6 {
				regulator-min-microvolt = <1250000>;
				regulator-max-microvolt = <3300000>;
			};

			ldo7_reg: ldo7 {
				regulator-min-microvolt = <1250000>;
				regulator-max-microvolt = <3300000>;
			};

			ldo8_reg: ldo8 {
				regulator-min-microvolt = <1250000>;
				regulator-max-microvolt = <3300000>;
			};

			ldo9_reg: ldo9 {
				regulator-min-microvolt = <1250000>;
				regulator-max-microvolt = <3300000>;
			};
		};
	};
Commit	Line	Data
62f6b087 TR	1	TPS6586x family of regulators
	2
	3	Required properties:
	4	- compatible: "ti,tps6586x"
	5	- reg: I2C slave address
	6	- interrupts: the interrupt outputs of the controller
	7	- #gpio-cells: number of cells to describe a GPIO
	8	- gpio-controller: mark the device as a GPIO controller
3006b8d6 SW	9	- regulators: A node that houses a sub-node for each regulator within the
	10	device. Each sub-node is identified using the node's name (or the deprecated
	11	regulator-compatible property if present), with valid values listed below.
	12	The content of each sub-node is defined by the standard binding for
	13	regulators; see regulator.txt.
9394b80c LD	14	sys, sm[0-2], ldo[0-9] and ldo_rtc
9394b80c LD	15	- sys-supply: The input supply for SYS.
7f852e05 LD	16	- vin-sm0-supply: The input supply for the SM0.
	17	- vin-sm1-supply: The input supply for the SM1.
	18	- vin-sm2-supply: The input supply for the SM2.
7c7fac30 LD	19	- vinldo01-supply: The input supply for the LDO1 and LDO2
	20	- vinldo23-supply: The input supply for the LDO2 and LDO3
	21	- vinldo4-supply: The input supply for the LDO4
	22	- vinldo678-supply: The input supply for the LDO6, LDO7 and LDO8
	23	- vinldo9-supply: The input supply for the LDO9
62f6b087	24
004c15a6 BH	25	Optional properties:
	26	- ti,system-power-controller: Telling whether or not this pmic is controlling
	27	the system power.
	28
62f6b087 TR	29	Each regulator is defined using the standard binding for regulators.
62f6b087 TR	30
9394b80c LD	31	Note: LDO5 and LDO_RTC is supplied by SYS regulator internally and driver
	32	take care of making proper parent child relationship.
	33
62f6b087 TR	34	Example:
	35
	36	pmu: tps6586x@34 {
	37	compatible = "ti,tps6586x";
	38	reg = <0x34>;
	39	interrupts = <0 88 0x4>;
	40
	41	#gpio-cells = <2>;
	42	gpio-controller;
	43
004c15a6 BH	44	ti,system-power-controller;
004c15a6 BH	45
9394b80c	46	sys-supply = <&some_reg>;
7f852e05 LD	47	vin-sm0-supply = <&some_reg>;
	48	vin-sm1-supply = <&some_reg>;
	49	vin-sm2-supply = <&some_reg>;
7c7fac30 LD	50	vinldo01-supply = <...>;
	51	vinldo23-supply = <...>;
	52	vinldo4-supply = <...>;
	53	vinldo678-supply = <...>;
	54	vinldo9-supply = <...>;
	55
62f6b087	56	regulators {
3006b8d6	57	sys_reg: sys {
9394b80c LD	58	regulator-name = "vdd_sys";
	59	regulator-boot-on;
	60	regulator-always-on;
	61	};
	62
3006b8d6	63	sm0_reg: sm0 {
62f6b087 TR	64	regulator-min-microvolt = < 725000>;
	65	regulator-max-microvolt = <1500000>;
	66	regulator-boot-on;
	67	regulator-always-on;
	68	};
	69
3006b8d6	70	sm1_reg: sm1 {
62f6b087 TR	71	regulator-min-microvolt = < 725000>;
	72	regulator-max-microvolt = <1500000>;
	73	regulator-boot-on;
	74	regulator-always-on;
	75	};
	76
3006b8d6	77	sm2_reg: sm2 {
62f6b087 TR	78	regulator-min-microvolt = <3000000>;
	79	regulator-max-microvolt = <4550000>;
	80	regulator-boot-on;
	81	regulator-always-on;
	82	};
	83
3006b8d6	84	ldo0_reg: ldo0 {
62f6b087 TR	85	regulator-name = "PCIE CLK";
	86	regulator-min-microvolt = <3300000>;
	87	regulator-max-microvolt = <3300000>;
	88	};
	89
3006b8d6	90	ldo1_reg: ldo1 {
62f6b087 TR	91	regulator-min-microvolt = < 725000>;
	92	regulator-max-microvolt = <1500000>;
	93	};
	94
3006b8d6	95	ldo2_reg: ldo2 {
62f6b087 TR	96	regulator-min-microvolt = < 725000>;
	97	regulator-max-microvolt = <1500000>;
	98	};
	99
3006b8d6	100	ldo3_reg: ldo3 {
62f6b087 TR	101	regulator-min-microvolt = <1250000>;
	102	regulator-max-microvolt = <3300000>;
	103	};
	104
3006b8d6	105	ldo4_reg: ldo4 {
62f6b087 TR	106	regulator-min-microvolt = <1700000>;
	107	regulator-max-microvolt = <2475000>;
	108	};
	109
3006b8d6	110	ldo5_reg: ldo5 {
62f6b087 TR	111	regulator-min-microvolt = <1250000>;
	112	regulator-max-microvolt = <3300000>;
	113	};
	114
3006b8d6	115	ldo6_reg: ldo6 {
62f6b087 TR	116	regulator-min-microvolt = <1250000>;
	117	regulator-max-microvolt = <3300000>;
	118	};
	119
3006b8d6	120	ldo7_reg: ldo7 {
62f6b087 TR	121	regulator-min-microvolt = <1250000>;
	122	regulator-max-microvolt = <3300000>;
	123	};
	124
3006b8d6	125	ldo8_reg: ldo8 {
62f6b087 TR	126	regulator-min-microvolt = <1250000>;
	127	regulator-max-microvolt = <3300000>;
	128	};
	129
3006b8d6	130	ldo9_reg: ldo9 {
62f6b087 TR	131	regulator-min-microvolt = <1250000>;
	132	regulator-max-microvolt = <3300000>;
	133	};
	134	};
	135	};