blob: ab21954036b13100aae26f330d4b2c5704afe9e1 [file] [log] [blame]
Ram Chandrasekar5e511932018-02-06 16:34:02 -07001===============================================================================
2BCL Peripheral driver for PMIC5:
3===============================================================================
4Qualcomm Technologies, Inc's PMIC has battery current limiting peripheral,
5which can monitor for high battery current and low battery voltage in the
6hardware. The BCL peripheral driver interacts with the PMIC peripheral using
7the SPMI driver interface. The hardware can take threshold for notifying for
8high battery current or low battery voltage events. This driver works only
9with PMIC version 5, where the same BCL peripheral can be found in multiple
10PMIC's that are used in a device, with limited functionalities. For example,
11one PMIC can have only vbat monitoring, while the other PMIC can have both
12vbat and ibat monitoring. This is a common driver, that can interact
13with the multiple BCL peripherals.
14
15Required Parameters:
16- compatible: must be
Manaf Meethalavalappu Pallikunhie49406e2018-03-09 18:34:14 +053017 'qcom,bcl-v5' for bcl peripheral in PMIC version 5.
Ram Chandrasekar5e511932018-02-06 16:34:02 -070018- reg: <a b> where 'a' is the starting register address of the PMIC
19 peripheral and 'b' is the size of the peripheral address space.
Ram Chandrasekar7b5c6922018-02-27 17:07:12 -070020- interrupts: <a b c d> Where,
21 'a' is the SLAVE ID of the PMIC,
22 'b' is the peripheral ID,
23 'c' is the interrupt number in PMIC and
24 'd' is the interrupt type.
Ram Chandrasekar5e511932018-02-06 16:34:02 -070025- interrupt-names: user defined names for the interrupts. These
26 interrupt names will be used by the drivers to identify the
27 interrupts, instead of specifying the ID's. bcl driver will
28 accept these standard interrupts.
Ram Chandrasekar7b5c6922018-02-27 17:07:12 -070029 "bcl-ibat-lvl0",
30 "bcl-ibat-lvl1",
31 "bcl-vbat-lvl0",
32 "bcl-vbat-lvl1",
33 "bcl-vbat-lvl2",
Ram Chandrasekar5e511932018-02-06 16:34:02 -070034
35Example:
Manaf Meethalavalappu Pallikunhie49406e2018-03-09 18:34:14 +053036 bcl@4200 {
37 compatible = "qcom,bcl-v5";
38 reg = <0x4200 0x100>;
Ram Chandrasekar7b5c6922018-02-27 17:07:12 -070039 interrupts = <0x2 0x42 0x0 IRQ_TYPE_NONE>,
40 <0x2 0x42 0x1 IRQ_TYPE_NONE>;
41 interrupt-names = "bcl-ibat-lvl0",
42 "bcl-vbat-lvl0";
Manaf Meethalavalappu Pallikunhie49406e2018-03-09 18:34:14 +053043 };