MFD NPM1300 Interface

Enumerations
enum	mfd_npm1300_event_t {   NPM1300_EVENT_CHG_COMPLETED , NPM1300_EVENT_CHG_ERROR , NPM1300_EVENT_BATTERY_DETECTED , NPM1300_EVENT_BATTERY_REMOVED ,   NPM1300_EVENT_SHIPHOLD_PRESS , NPM1300_EVENT_SHIPHOLD_RELEASE , NPM1300_EVENT_WATCHDOG_WARN , NPM1300_EVENT_VBUS_DETECTED ,   NPM1300_EVENT_VBUS_REMOVED , NPM1300_EVENT_GPIO0_EDGE , NPM1300_EVENT_GPIO1_EDGE , NPM1300_EVENT_GPIO2_EDGE ,   NPM1300_EVENT_GPIO3_EDGE , NPM1300_EVENT_GPIO4_EDGE , NPM1300_EVENT_MAX }

Functions
int	mfd_npm1300_reg_read_burst (const struct device *dev, uint8_t base, uint8_t offset, void *data, size_t len)
	Read multiple registers from npm1300.
int	mfd_npm1300_reg_read (const struct device *dev, uint8_t base, uint8_t offset, uint8_t *data)
	Read single register from npm1300.
int	mfd_npm1300_reg_write (const struct device *dev, uint8_t base, uint8_t offset, uint8_t data)
	Write single register to npm1300.
int	mfd_npm1300_reg_write2 (const struct device *dev, uint8_t base, uint8_t offset, uint8_t data1, uint8_t data2)
	Write two registers to npm1300.
int	mfd_npm1300_reg_update (const struct device *dev, uint8_t base, uint8_t offset, uint8_t data, uint8_t mask)
	Update selected bits in npm1300 register.
int	mfd_npm1300_set_timer (const struct device *dev, uint32_t time_ms)
	Write npm1300 timer register.
int	mfd_npm1300_reset (const struct device *dev)
	npm1300 full power reset
int	mfd_npm1300_hibernate (const struct device *dev, uint32_t time_ms)
	npm1300 hibernate
int	mfd_npm1300_add_callback (const struct device *dev, struct gpio_callback *callback)
	Add npm1300 event callback.
int	mfd_npm1300_remove_callback (const struct device *dev, struct gpio_callback *callback)
	Remove npm1300 event callback.

Detailed Description

Enumeration Type Documentation

mfd_npm1300_event_t

enum mfd_npm1300_event_t

#include <include/zephyr/drivers/mfd/npm1300.h>

Enumerator
NPM1300_EVENT_CHG_COMPLETED
NPM1300_EVENT_CHG_ERROR
NPM1300_EVENT_BATTERY_DETECTED
NPM1300_EVENT_BATTERY_REMOVED
NPM1300_EVENT_SHIPHOLD_PRESS
NPM1300_EVENT_SHIPHOLD_RELEASE
NPM1300_EVENT_WATCHDOG_WARN
NPM1300_EVENT_VBUS_DETECTED
NPM1300_EVENT_VBUS_REMOVED
NPM1300_EVENT_GPIO0_EDGE
NPM1300_EVENT_GPIO1_EDGE
NPM1300_EVENT_GPIO2_EDGE
NPM1300_EVENT_GPIO3_EDGE
NPM1300_EVENT_GPIO4_EDGE
NPM1300_EVENT_MAX

Function Documentation

mfd_npm1300_add_callback()

int mfd_npm1300_add_callback	(	const struct device *	dev,
		struct gpio_callback *	callback
	)

#include <include/zephyr/drivers/mfd/npm1300.h>

Add npm1300 event callback.

Parameters

dev	npm1300 mfd device
callback	callback

Returns

0 on success, -errno on failure

mfd_npm1300_hibernate()

int mfd_npm1300_hibernate	(	const struct device *	dev,
		uint32_t	time_ms
	)

#include <include/zephyr/drivers/mfd/npm1300.h>

npm1300 hibernate

Enters low power state, and wakes after specified time

Parameters

dev	npm1300 mfd device
time_ms	timer value in ms

Return values

0	If successful
-EINVAL	if time value is too large
-errno	In case of any bus error (see i2c_write_dt())

mfd_npm1300_reg_read()

int mfd_npm1300_reg_read	(	const struct device *	dev,
		uint8_t	base,
		uint8_t	offset,
		uint8_t *	data
	)

#include <include/zephyr/drivers/mfd/npm1300.h>

Read single register from npm1300.

Parameters

dev	npm1300 mfd device
base	Register base address (bits 15..8 of 16-bit address)
offset	Register offset address (bits 7..0 of 16-bit address)
data	Pointer to buffer for received data

Return values

0	If successful
-errno	In case of any bus error (see i2c_write_read_dt())

mfd_npm1300_reg_read_burst()

int mfd_npm1300_reg_read_burst	(	const struct device *	dev,
		uint8_t	base,
		uint8_t	offset,
		void *	data,
		size_t	len
	)

#include <include/zephyr/drivers/mfd/npm1300.h>

Read multiple registers from npm1300.

Parameters

dev	npm1300 mfd device
base	Register base address (bits 15..8 of 16-bit address)
offset	Register offset address (bits 7..0 of 16-bit address)
data	Pointer to buffer for received data
len	Number of bytes to read

Return values

0	If successful
-errno	In case of any bus error (see i2c_write_read_dt())

mfd_npm1300_reg_update()

int mfd_npm1300_reg_update	(	const struct device *	dev,
		uint8_t	base,
		uint8_t	offset,
		uint8_t	data,
		uint8_t	mask
	)

#include <include/zephyr/drivers/mfd/npm1300.h>

Update selected bits in npm1300 register.

Parameters

dev	npm1300 mfd device
base	Register base address (bits 15..8 of 16-bit address)
offset	Register offset address (bits 7..0 of 16-bit address)
data	data to write
mask	mask of bits to be modified

Return values

0	If successful
-errno	In case of any bus error (see i2c_write_read_dt(), i2c_write_dt())

mfd_npm1300_reg_write()

int mfd_npm1300_reg_write	(	const struct device *	dev,
		uint8_t	base,
		uint8_t	offset,
		uint8_t	data
	)

#include <include/zephyr/drivers/mfd/npm1300.h>

Write single register to npm1300.

Parameters

dev	npm1300 mfd device
base	Register base address (bits 15..8 of 16-bit address)
offset	Register offset address (bits 7..0 of 16-bit address)
data	data to write

Return values

0	If successful
-errno	In case of any bus error (see i2c_write_dt())

mfd_npm1300_reg_write2()

int mfd_npm1300_reg_write2	(	const struct device *	dev,
		uint8_t	base,
		uint8_t	offset,
		uint8_t	data1,
		uint8_t	data2
	)

#include <include/zephyr/drivers/mfd/npm1300.h>

Write two registers to npm1300.

Parameters

dev	npm1300 mfd device
base	Register base address (bits 15..8 of 16-bit address)
offset	Register offset address (bits 7..0 of 16-bit address)
data1	first byte of data to write
data2	second byte of data to write

Return values

0	If successful
-errno	In case of any bus error (see i2c_write_dt())

mfd_npm1300_remove_callback()

int mfd_npm1300_remove_callback	(	const struct device *	dev,
		struct gpio_callback *	callback
	)

#include <include/zephyr/drivers/mfd/npm1300.h>

Remove npm1300 event callback.

Parameters

dev	npm1300 mfd device
callback	callback

Returns

0 on success, -errno on failure

mfd_npm1300_reset()

int mfd_npm1300_reset

(

const struct device *

dev

)

#include <include/zephyr/drivers/mfd/npm1300.h>

npm1300 full power reset

Parameters

dev	npm1300 mfd device

Return values

0	If successful
-errno	In case of any bus error (see i2c_write_dt())

mfd_npm1300_set_timer()

int mfd_npm1300_set_timer	(	const struct device *	dev,
		uint32_t	time_ms
	)

#include <include/zephyr/drivers/mfd/npm1300.h>

Write npm1300 timer register.

Parameters

dev	npm1300 mfd device
time_ms	timer value in ms

Return values

0	If successful
-EINVAL	if time value is too large
-errno	In case of any bus error (see i2c_write_dt())