include/power/pmic.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
3  *  Copyright (C) 2014-2015 Samsung Electronics
6  *  Copyright (C) 2011-2012 Samsung Electronics
89  * U-Boot PMIC Framework
92  * UCLASS_PMIC - This is designed to provide an I/O interface for PMIC devices.
94  * For the multi-function PMIC devices, this can be used as parent I/O device
95  * for each IC's interface. Then, each child uses its parent for read/write.
100  * |_ BUS 0 device (e.g. I2C0)                 - UCLASS_I2C/SPI/...
101  * | |_ PMIC device (READ/WRITE ops)           - UCLASS_PMIC
102  * |   |_ REGULATOR device (ldo/buck/... ops)  - UCLASS_REGULATOR
103  * |   |_ CHARGER device (charger ops)         - UCLASS_CHARGER (in the future)
104  * |   |_ MUIC device (microUSB connector ops) - UCLASS_MUIC    (in the future)
107  * |_ BUS 1 device (e.g. I2C1)                 - UCLASS_I2C/SPI/...
108  *   |_ PMIC device (READ/WRITE ops)           - UCLASS_PMIC
109  *     |_ RTC device (rtc ops)                 - UCLASS_RTC     (in the future)
112  * - single I/O interface
113  * - multiple I/O interfaces
115  * its child devices. And each child usually implements a different function,
118  * The binding should be done automatically. If device tree nodes/subnodes are
124  *       |_ regulator (child)
125  *       |_ charger   (child)
126  *       |_ other     (child)
128  * The same for other device nodes, for multi-interface PMIC.
133  * If a PMIC child device driver needs access the PMIC-specific registers,
138  * |_ dev: bus I2C0                                         - UCLASS_I2C
139  * | |_ dev: my_pmic (read/write)              (is parent)  - UCLASS_PMIC
140  * |   |_ dev: my_regulator (set value/etc..)  (is child)   - UCLASS_REGULATOR
143  * all its child devices, like in the example below. It can be done by calling
144  * the 'pmic_bind_children()' - please refer to the function description, which
149  * - 'drivers/power/pmic/max77686.c'
153  * struct dm_pmic_ops - PMIC device I/O interface
170  * enum pmic_op_type - used for various pmic devices operation calls,
173  * @PMIC_OP_GET - get operation
174  * @PMIC_OP_SET - set operation
182  * struct pmic_child_info - basic device's child info for bind child nodes with
186  * @prefix - child node name prefix (or its name if is unique or single)
187  * @driver - driver name for the sub-node with prefix
194 /* drivers/power/pmic-uclass.c */
197  * pmic_bind_children() - bind drivers for given parent pmic, using child info
200  * @pmic       - pmic device - the parent of found child's
201  * @child_info - N-childs info array
202  * @return a positive number of childs, or 0 if no child found (error)
204  * Note: For N-childs the child_info array should have N+1 entries and the last
205  * entry prefix should be NULL - the same as for drivers compatible.
213  * This function is useful for regulator sub-nodes:
216  *     (pmic - bind automatically by compatible)
219  *     (pmic's childs - bind by pmic_bind_children())
220  *     (nodes prefix: "ldo", driver: "my_regulator_ldo")
224  *     (nodes prefix: "buck", driver: "my_regulator_buck")
235  * @name - device name
236  * @devp - returned pointer to the pmic device
248  * @dev - pointer to the UCLASS_PMIC device
258  * @pmic   - pointer to the UCLASS_PMIC device
259  * @reg    - device register offset
260  * @buffer - pointer to read/write buffer
261  * @len    - byte count for read/write
268  * pmic_reg_read() - read a PMIC register value
277  * pmic_reg_write() - write a PMIC register value
287  * pmic_clrsetbits() - clear and set bits in a PMIC register
324 #define pmic_i2c_addr (p->hw.i2c.addr)
325 #define pmic_i2c_tx_num (p->hw.i2c.tx_num)
327 #define pmic_spi_bitlen (p->hw.spi.bitlen)
328 #define pmic_spi_flags (p->hw.spi.flags)