nPM1300

Nordic nPM1300 PMIC core. More...

Data Structures
struct	pbl_npm1300
	nPM1300 core. More...

Macros
#define	PBL_NPM1300_DEFINE(sym, _bus, _addr)
	Define the core.

Functions
static const struct pbl_npm1300 *	pbl_npm1300_from_cell (const struct pbl_device *cell)
	Get the core a cell belongs to.
void	pbl_npm1300_lock (const struct pbl_npm1300 *pmic)
	Lock the registers, around a read-modify-write sequence.
void	pbl_npm1300_unlock (const struct pbl_npm1300 *pmic)
	Unlock the registers.
int	pbl_npm1300_read (const struct pbl_npm1300 *pmic, uint16_t reg, uint8_t *val)
	Read a register.
int	pbl_npm1300_write (const struct pbl_npm1300 *pmic, uint16_t reg, uint8_t val)
	Write a register.

Detailed Description

Nordic nPM1300 PMIC core.

The core is a struct pbl_npm1300 device on its I2C bus. It owns the register access, under a lock so its cells cannot interleave read-modify-write sequences, and brings its cells up from its init. Each cell is a child device in its own subsystem: the charger (nPM1300 charger), the GPIO port (nPM1300 GPIO) and one regulator per rail (nPM1300 regulators).

PBL_NPM1300_DEFINE(s_npm1300, &s_i2c1.bus, 0x6B);
PBL_NPM1300_CHARGER_DEFINE(s_npm1300_charger, &s_npm1300, &NPM1300_CONFIG,
                           {.peripheral = hwp_gpio1, .gpio_pin = 26});
PBL_NPM1300_GPIO_DEFINE(s_npm1300_gpio, &s_npm1300);
PBL_NPM1300_REGULATOR_DEFINE(s_ldo2, "ldo2", &s_npm1300, PBL_NPM1300_LDSW2, 3300, true, false);

---

Data Structure Documentation

pbl_npm1300

struct pbl_npm1300

nPM1300 core.

Data Fields
struct pbl_device	dev	Device, child of the I2C bus.
struct pbl_i2c_dev	i2c	I2C device.
struct pbl_npm1300_state *	state	Runtime state.

Macro Definition Documentation

PBL_NPM1300_DEFINE

#define PBL_NPM1300_DEFINE	(		sym,
			_bus,
			_addr
	)

Value:

  PBL_DEVICE_STATE_DEFINE(sym);                                                      \
  static struct pbl_npm1300_state sym##_npm1300_state;                               \
  const struct pbl_npm1300 sym = {                                                   \
    .dev = PBL_DEVICE_INIT(sym, "npm1300", pbl_npm1300_init, &(_bus)->dev, nullptr), \
    .i2c = PBL_I2C_DEV(_bus, _addr),                                                 \
    .state = &sym##_npm1300_state,                                                   \
  };                                                                                 \
  PBL_DEVICE_REGISTER(sym, &sym.dev)

Define the core.

Parameters

sym	Symbol of the core.
_bus	I2C bus.
_addr	7-bit I2C address.

Function Documentation

pbl_npm1300_from_cell()

static const struct pbl_npm1300 * pbl_npm1300_from_cell ( const struct pbl_device *  cell )

inlinestatic

Get the core a cell belongs to.

Parameters

cell	Cell device, a child of the core.

Returns

Core.

References container_of, pbl_npm1300::dev, and pbl_device::parent.

pbl_npm1300_lock()

void pbl_npm1300_lock

(

const struct pbl_npm1300 *

pmic

)

Lock the registers, around a read-modify-write sequence.

Single accesses lock on their own.

Parameters

pmic

Core.

pbl_npm1300_read()

int pbl_npm1300_read	(	const struct pbl_npm1300 *	pmic,
		uint16_t	reg,
		uint8_t *	val
	)

Read a register.

Parameters

	pmic	Core.
	reg	Register address.
[out]	val	Register value.

Returns

0 on success, or a negative errno.

pbl_npm1300_unlock()

void pbl_npm1300_unlock

(

const struct pbl_npm1300 *

pmic

)

Unlock the registers.

Parameters

pmic

Core.

pbl_npm1300_write()

int pbl_npm1300_write	(	const struct pbl_npm1300 *	pmic,
		uint16_t	reg,
		uint8_t	val
	)

Write a register.

Parameters

pmic	Core.
reg	Register address.
val	Value.

Returns

0 on success, or a negative errno.