xref: /freebsd/sys/contrib/device-tree/Bindings/power/supply/ab8500/fg.txt (revision fe6060f10f634930ff71b7c50291ddc610da2475)
1=== AB8500 Fuel Gauge Driver ===
2
3AB8500 is a mixed signal multimedia and power management
4device comprising: power and energy-management-module,
5wall-charger, usb-charger, audio codec, general purpose adc,
6tvout, clock management and sim card interface.
7
8Fuelgauge support is part of energy-management-modules, other
9components of this module are:
10main-charger, usb-combo-charger and battery-temperature-monitoring.
11
12The properties below describes the node for fuelgauge driver.
13
14Required Properties:
15- compatible = This shall be: "stericsson,ab8500-fg"
16- battery = Shall be battery specific information
17	Example:
18	ab8500_fg {
19		compatible = "stericsson,ab8500-fg";
20		battery	   = <&ab8500_battery>;
21	};
22
23dependent node:
24	ab8500_battery: ab8500_battery {
25	};
26	This node will provide information on 'thermistor interface' and
27	'battery technology type' used.
28
29Properties of this node are:
30thermistor-on-batctrl:
31	A boolean value indicating thermistor interface	to battery
32
33	Note:
34	'btemp' and 'batctrl' are the pins interfaced for battery temperature
35	measurement, 'btemp' signal is used when NTC(negative temperature
36	coefficient) resister is interfaced external to battery whereas
37	'batctrl' pin is used when NTC resister is internal to battery.
38
39	Example:
40	ab8500_battery: ab8500_battery {
41		thermistor-on-batctrl;
42	};
43	indicates: NTC resister is internal to battery, 'batctrl' is used
44		for thermal measurement.
45
46	The absence of property 'thermal-on-batctrl' indicates
47	NTC resister is external to battery and  'btemp' signal is used
48	for thermal measurement.
49
50battery-type:
51	This shall be the battery manufacturing technology type,
52	allowed types are:
53		"UNKNOWN" "NiMH" "LION" "LIPO" "LiFe" "NiCd" "LiMn"
54	Example:
55	ab8500_battery: ab8500_battery {
56		stericsson,battery-type = "LIPO";
57	}
58
59