[deliverable/linux.git] / Documentation / devicetree / bindings / mfd / tps65910.txt

TPS65910 Power Management Integrated Circuit

Required properties:
- compatible: "ti,tps65910" or "ti,tps65911"
- reg: I2C slave address
- interrupts: the interrupt outputs of the controller
- #gpio-cells: number of cells to describe a GPIO, this should be 2.
  The first cell is the GPIO number.
  The second cell is used to specify additional options <unused>.
- gpio-controller: mark the device as a GPIO controller
- #interrupt-cells: the number of cells to describe an IRQ, this should be 2.
  The first cell is the IRQ number.
  The second cell is the flags, encoded as the trigger masks from
  Documentation/devicetree/bindings/interrupts.txt
- regulators: This is the list of child nodes that specify the regulator
  initialization data for defined regulators. Not all regulators for the given
  device need to be present. The definition for each of these nodes is defined
  using the standard binding for regulators found at
  Documentation/devicetree/bindings/regulator/regulator.txt.
  The regulator is matched with the regulator-compatible.

  The valid regulator-compatible values are:
  tps65910: vrtc, vio, vdd1, vdd2, vdd3, vdig1, vdig2, vpll, vdac, vaux1,
            vaux2, vaux33, vmmc
  tps65911: vrtc, vio, vdd1, vdd3, vddctrl, ldo1, ldo2, ldo3, ldo4, ldo5,
            ldo6, ldo7, ldo8

- xxx-supply: Input voltage supply regulator.
  These entries are require if regulators are enabled for a device. Missing of these
  properties can cause the regulator registration fails.
  If some of input supply is powered through battery or always-on supply then
  also it is require to have these parameters with proper node handle of always
  on power supply.
  tps65910:
	vcc1-supply: VDD1 input.
	vcc2-supply: VDD2 input.
	vcc3-supply: VAUX33 and VMMC input.
	vcc4-supply: VAUX1 and VAUX2 input.
	vcc5-supply: VPLL and VDAC input.
	vcc6-supply: VDIG1 and VDIG2 input.
	vcc7-supply: VRTC input.
	vccio-supply: VIO input.
  tps65911:
	vcc1-supply: VDD1 input.
	vcc2-supply: VDD2 input.
	vcc3-supply: LDO6, LDO7 and LDO8 input.
	vcc4-supply: LDO5 input.
	vcc5-supply: LDO3 and LDO4 input.
	vcc6-supply: LDO1 and LDO2 input.
	vcc7-supply: VRTC input.
	vccio-supply: VIO input.

Optional properties:
- ti,vmbch-threshold: (tps65911) main battery charged threshold
  comparator. (see VMBCH_VSEL in TPS65910 datasheet)
- ti,vmbch2-threshold: (tps65911) main battery discharged threshold
  comparator. (see VMBCH_VSEL in TPS65910 datasheet)
- ti,en-ck32k-xtal: enable external 32-kHz crystal oscillator (see CK32K_CTRL
  in TPS6591X datasheet)
- ti,en-gpio-sleep: enable sleep control for gpios
  There should be 9 entries here, one for each gpio.

Regulator Optional properties:
- ti,regulator-ext-sleep-control: enable external sleep
  control through external inputs [0 (not enabled), 1 (EN1), 2 (EN2) or 4(EN3)]
  If this property is not defined, it defaults to 0 (not enabled).

Example:

	pmu: tps65910@d2 {
		compatible = "ti,tps65910";
		reg = <0xd2>;
		interrupt-parent = <&intc>;
		interrupts = < 0 118 0x04 >;

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

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

		ti,vmbch-threshold = 0;
		ti,vmbch2-threshold = 0;

		ti,en-gpio-sleep = <0 0 1 0 0 0 0 0 0>;

		vcc1-supply = <&reg_parent>;
		vcc2-supply = <&some_reg>;
		vcc3-supply = <...>;
		vcc4-supply = <...>;
		vcc5-supply = <...>;
		vcc6-supply = <...>;
		vcc7-supply = <...>;
		vccio-supply = <...>;

		regulators {
			#address-cells = <1>;
			#size-cells = <0>;

			vdd1_reg: regulator@0 {
				regulator-compatible = "vdd1";
				reg = <0>;
				regulator-min-microvolt = < 600000>;
				regulator-max-microvolt = <1500000>;
				regulator-always-on;
				regulator-boot-on;
				ti,regulator-ext-sleep-control = <0>;
			};
			vdd2_reg: regulator@1 {
				regulator-compatible = "vdd2";
				reg = <1>;
				regulator-min-microvolt = < 600000>;
				regulator-max-microvolt = <1500000>;
				regulator-always-on;
				regulator-boot-on;
				ti,regulator-ext-sleep-control = <4>;
			};
			vddctrl_reg: regulator@2 {
				regulator-compatible = "vddctrl";
				reg = <2>;
				regulator-min-microvolt = < 600000>;
				regulator-max-microvolt = <1400000>;
				regulator-always-on;
				regulator-boot-on;
				ti,regulator-ext-sleep-control = <0>;
			};
			vio_reg: regulator@3 {
				regulator-compatible = "vio";
				reg = <3>;
				regulator-min-microvolt = <1500000>;
				regulator-max-microvolt = <1800000>;
				regulator-always-on;
				regulator-boot-on;
				ti,regulator-ext-sleep-control = <1>;
			};
			ldo1_reg: regulator@4 {
				regulator-compatible = "ldo1";
				reg = <4>;
				regulator-min-microvolt = <1000000>;
				regulator-max-microvolt = <3300000>;
				ti,regulator-ext-sleep-control = <0>;
			};
			ldo2_reg: regulator@5 {
				regulator-compatible = "ldo2";
				reg = <5>;
				regulator-min-microvolt = <1050000>;
				regulator-max-microvolt = <1050000>;
				ti,regulator-ext-sleep-control = <0>;
			};
			ldo3_reg: regulator@6 {
				regulator-compatible = "ldo3";
				reg = <6>;
				regulator-min-microvolt = <1000000>;
				regulator-max-microvolt = <3300000>;
				ti,regulator-ext-sleep-control = <0>;
			};
			ldo4_reg: regulator@7 {
				regulator-compatible = "ldo4";
				reg = <7>;
				regulator-min-microvolt = <1000000>;
				regulator-max-microvolt = <3300000>;
				regulator-always-on;
				ti,regulator-ext-sleep-control = <0>;
			};
			ldo5_reg: regulator@8 {
				regulator-compatible = "ldo5";
				reg = <8>;
				regulator-min-microvolt = <1000000>;
				regulator-max-microvolt = <3300000>;
				ti,regulator-ext-sleep-control = <0>;
			};
			ldo6_reg: regulator@9 {
				regulator-compatible = "ldo6";
				reg = <9>;
				regulator-min-microvolt = <1200000>;
				regulator-max-microvolt = <1200000>;
				ti,regulator-ext-sleep-control = <0>;
			};
			ldo7_reg: regulator@10 {
				regulator-compatible = "ldo7";
				reg = <10>;
				regulator-min-microvolt = <1200000>;
				regulator-max-microvolt = <1200000>;
				regulator-always-on;
				regulator-boot-on;
				ti,regulator-ext-sleep-control = <1>;
			};
			ldo8_reg: regulator@11 {
				regulator-compatible = "ldo8";
				reg = <11>;
				regulator-min-microvolt = <1000000>;
				regulator-max-microvolt = <3300000>;
				regulator-always-on;
				ti,regulator-ext-sleep-control = <1>;
			};
		};
	};
Commit	Line	Data
1291aa45 RK	1	TPS65910 Power Management Integrated Circuit
	2
	3	Required properties:
	4	- compatible: "ti,tps65910" or "ti,tps65911"
	5	- reg: I2C slave address
	6	- interrupts: the interrupt outputs of the controller
	7	- #gpio-cells: number of cells to describe a GPIO, this should be 2.
	8	The first cell is the GPIO number.
	9	The second cell is used to specify additional options <unused>.
	10	- gpio-controller: mark the device as a GPIO controller
	11	- #interrupt-cells: the number of cells to describe an IRQ, this should be 2.
	12	The first cell is the IRQ number.
	13	The second cell is the flags, encoded as the trigger masks from
	14	Documentation/devicetree/bindings/interrupts.txt
	15	- regulators: This is the list of child nodes that specify the regulator
	16	initialization data for defined regulators. Not all regulators for the given
	17	device need to be present. The definition for each of these nodes is defined
	18	using the standard binding for regulators found at
	19	Documentation/devicetree/bindings/regulator/regulator.txt.
8c5e461d	20	The regulator is matched with the regulator-compatible.
1291aa45	21
8c5e461d	22	The valid regulator-compatible values are:
1291aa45 RK	23	tps65910: vrtc, vio, vdd1, vdd2, vdd3, vdig1, vdig2, vpll, vdac, vaux1,
	24	vaux2, vaux33, vmmc
	25	tps65911: vrtc, vio, vdd1, vdd3, vddctrl, ldo1, ldo2, ldo3, ldo4, ldo5,
	26	ldo6, ldo7, ldo8
	27
19228a6a	28	- xxx-supply: Input voltage supply regulator.
d2cfdb05 LD	29	These entries are require if regulators are enabled for a device. Missing of these
	30	properties can cause the regulator registration fails.
	31	If some of input supply is powered through battery or always-on supply then
	32	also it is require to have these parameters with proper node handle of always
	33	on power supply.
19228a6a LD	34	tps65910:
	35	vcc1-supply: VDD1 input.
	36	vcc2-supply: VDD2 input.
	37	vcc3-supply: VAUX33 and VMMC input.
	38	vcc4-supply: VAUX1 and VAUX2 input.
	39	vcc5-supply: VPLL and VDAC input.
	40	vcc6-supply: VDIG1 and VDIG2 input.
	41	vcc7-supply: VRTC input.
	42	vccio-supply: VIO input.
	43	tps65911:
	44	vcc1-supply: VDD1 input.
	45	vcc2-supply: VDD2 input.
	46	vcc3-supply: LDO6, LDO7 and LDO8 input.
	47	vcc4-supply: LDO5 input.
	48	vcc5-supply: LDO3 and LDO4 input.
	49	vcc6-supply: LDO1 and LDO2 input.
	50	vcc7-supply: VRTC input.
	51	vccio-supply: VIO input.
1291aa45	52
d2cfdb05 LD	53	Optional properties:
	54	- ti,vmbch-threshold: (tps65911) main battery charged threshold
	55	comparator. (see VMBCH_VSEL in TPS65910 datasheet)
	56	- ti,vmbch2-threshold: (tps65911) main battery discharged threshold
	57	comparator. (see VMBCH_VSEL in TPS65910 datasheet)
	58	- ti,en-ck32k-xtal: enable external 32-kHz crystal oscillator (see CK32K_CTRL
	59	in TPS6591X datasheet)
	60	- ti,en-gpio-sleep: enable sleep control for gpios
	61	There should be 9 entries here, one for each gpio.
	62
1291aa45 RK	63	Regulator Optional properties:
	64	- ti,regulator-ext-sleep-control: enable external sleep
	65	control through external inputs [0 (not enabled), 1 (EN1), 2 (EN2) or 4(EN3)]
	66	If this property is not defined, it defaults to 0 (not enabled).
	67
	68	Example:
	69
	70	pmu: tps65910@d2 {
	71	compatible = "ti,tps65910";
	72	reg = <0xd2>;
	73	interrupt-parent = <&intc>;
	74	interrupts = < 0 118 0x04 >;
	75
	76	#gpio-cells = <2>;
	77	gpio-controller;
	78
	79	#interrupt-cells = <2>;
	80	interrupt-controller;
	81
	82	ti,vmbch-threshold = 0;
	83	ti,vmbch2-threshold = 0;
	84
	85	ti,en-gpio-sleep = <0 0 1 0 0 0 0 0 0>;
	86
19228a6a	87	vcc1-supply = <&reg_parent>;
d2cfdb05 LD	88	vcc2-supply = <&some_reg>;
	89	vcc3-supply = <...>;
	90	vcc4-supply = <...>;
	91	vcc5-supply = <...>;
	92	vcc6-supply = <...>;
	93	vcc7-supply = <...>;
	94	vccio-supply = <...>;
19228a6a	95
1291aa45	96	regulators {
8c5e461d LD	97	#address-cells = <1>;
	98	#size-cells = <0>;
	99
	100	vdd1_reg: regulator@0 {
	101	regulator-compatible = "vdd1";
	102	reg = <0>;
1291aa45 RK	103	regulator-min-microvolt = < 600000>;
	104	regulator-max-microvolt = <1500000>;
	105	regulator-always-on;
	106	regulator-boot-on;
	107	ti,regulator-ext-sleep-control = <0>;
	108	};
8c5e461d LD	109	vdd2_reg: regulator@1 {
	110	regulator-compatible = "vdd2";
	111	reg = <1>;
1291aa45 RK	112	regulator-min-microvolt = < 600000>;
	113	regulator-max-microvolt = <1500000>;
	114	regulator-always-on;
	115	regulator-boot-on;
	116	ti,regulator-ext-sleep-control = <4>;
	117	};
8c5e461d LD	118	vddctrl_reg: regulator@2 {
	119	regulator-compatible = "vddctrl";
	120	reg = <2>;
1291aa45 RK	121	regulator-min-microvolt = < 600000>;
	122	regulator-max-microvolt = <1400000>;
	123	regulator-always-on;
	124	regulator-boot-on;
	125	ti,regulator-ext-sleep-control = <0>;
	126	};
8c5e461d LD	127	vio_reg: regulator@3 {
	128	regulator-compatible = "vio";
	129	reg = <3>;
1291aa45 RK	130	regulator-min-microvolt = <1500000>;
	131	regulator-max-microvolt = <1800000>;
	132	regulator-always-on;
	133	regulator-boot-on;
	134	ti,regulator-ext-sleep-control = <1>;
	135	};
8c5e461d LD	136	ldo1_reg: regulator@4 {
	137	regulator-compatible = "ldo1";
	138	reg = <4>;
1291aa45 RK	139	regulator-min-microvolt = <1000000>;
	140	regulator-max-microvolt = <3300000>;
	141	ti,regulator-ext-sleep-control = <0>;
	142	};
8c5e461d LD	143	ldo2_reg: regulator@5 {
	144	regulator-compatible = "ldo2";
	145	reg = <5>;
1291aa45 RK	146	regulator-min-microvolt = <1050000>;
	147	regulator-max-microvolt = <1050000>;
	148	ti,regulator-ext-sleep-control = <0>;
	149	};
8c5e461d LD	150	ldo3_reg: regulator@6 {
	151	regulator-compatible = "ldo3";
	152	reg = <6>;
1291aa45 RK	153	regulator-min-microvolt = <1000000>;
	154	regulator-max-microvolt = <3300000>;
	155	ti,regulator-ext-sleep-control = <0>;
	156	};
8c5e461d LD	157	ldo4_reg: regulator@7 {
	158	regulator-compatible = "ldo4";
	159	reg = <7>;
1291aa45 RK	160	regulator-min-microvolt = <1000000>;
	161	regulator-max-microvolt = <3300000>;
	162	regulator-always-on;
	163	ti,regulator-ext-sleep-control = <0>;
	164	};
8c5e461d LD	165	ldo5_reg: regulator@8 {
	166	regulator-compatible = "ldo5";
	167	reg = <8>;
1291aa45 RK	168	regulator-min-microvolt = <1000000>;
	169	regulator-max-microvolt = <3300000>;
	170	ti,regulator-ext-sleep-control = <0>;
	171	};
8c5e461d LD	172	ldo6_reg: regulator@9 {
	173	regulator-compatible = "ldo6";
	174	reg = <9>;
1291aa45 RK	175	regulator-min-microvolt = <1200000>;
	176	regulator-max-microvolt = <1200000>;
	177	ti,regulator-ext-sleep-control = <0>;
	178	};
8c5e461d LD	179	ldo7_reg: regulator@10 {
	180	regulator-compatible = "ldo7";
	181	reg = <10>;
1291aa45 RK	182	regulator-min-microvolt = <1200000>;
	183	regulator-max-microvolt = <1200000>;
	184	regulator-always-on;
	185	regulator-boot-on;
	186	ti,regulator-ext-sleep-control = <1>;
	187	};
8c5e461d LD	188	ldo8_reg: regulator@11 {
	189	regulator-compatible = "ldo8";
	190	reg = <11>;
1291aa45 RK	191	regulator-min-microvolt = <1000000>;
	192	regulator-max-microvolt = <3300000>;
	193	regulator-always-on;
	194	ti,regulator-ext-sleep-control = <1>;
	195	};
	196	};
	197	};