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