npm10xx.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_MFD_NPM10XX_H_
#define ZEPHYR_INCLUDE_DRIVERS_MFD_NPM10XX_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <zephyr/sys/slist.h>
#include <zephyr/sys/clock.h>
#include <zephyr/device.h>


#define NPM10XX_RSTREAS_HIBERNATE     BIT(0)
#define NPM10XX_RSTREAS_BOOTMON       BIT(1)
#define NPM10XX_RSTREAS_WATCHDOG      BIT(2)
#define NPM10XX_RSTREAS_LONGPRESS     BIT(3)
#define NPM10XX_RSTREAS_THERMAL       BIT(4)
#define NPM10XX_RSTREAS_POF           BIT(5)
#define NPM10XX_RSTREAS_SW            BIT(6)
#define NPM10XX_RSTREAS_SHIPERR       BIT(7)
#define NPM10XX_RSTREAS_TIMER         BIT(8)
#define NPM10XX_RSTREAS_BUTTON        BIT(9)
#define NPM10XX_RSTREAS_HIBERNATEVBUS BIT(10)
#define NPM10XX_RSTREAS_WATCHDOGSOFT  BIT(11)

#define NPM10XX_EVENT_ADC_VBAT    BIT64(0)
#define NPM10XX_EVENT_ADC_NTC     BIT64(1)
#define NPM10XX_EVENT_ADC_DIETEMP BIT64(2)
#define NPM10XX_EVENT_ADC_VSYS    BIT64(3)
#define NPM10XX_EVENT_ADC_VBUS    BIT64(4)
#define NPM10XX_EVENT_ADC_VSET    BIT64(5)
#define NPM10XX_EVENT_ADC_OFFSET  BIT64(6)
#define NPM10XX_EVENT_IBATVBAT    BIT64(7)

#define NPM10XX_EVENT_CHARGE     BIT64(8)
#define NPM10XX_EVENT_DISCHARGE  BIT64(9)
#define NPM10XX_EVENT_DROPOUT    BIT64(10)
#define NPM10XX_EVENT_SUPPLEMENT BIT64(11)
#define NPM10XX_EVENT_COMPLETE   BIT64(12)
#define NPM10XX_EVENT_BATILIM    BIT64(13)
#define NPM10XX_EVENT_ITERM      BIT64(14)
#define NPM10XX_EVENT_VTERM      BIT64(16)
#define NPM10XX_EVENT_RECHARGE   BIT64(17)
#define NPM10XX_EVENT_VTHROTTLE  BIT64(18)
#define NPM10XX_EVENT_VWEAK      BIT64(19)
#define NPM10XX_EVENT_VTRICKLE   BIT64(20)
#define NPM10XX_EVENT_VBATLOW    BIT64(21)
#define NPM10XX_EVENT_NTCCOLD    BIT64(24)
#define NPM10XX_EVENT_NTCCOOL    BIT64(25)
#define NPM10XX_EVENT_NTCWARM    BIT64(26)
#define NPM10XX_EVENT_NTCHOT     BIT64(27)
#define NPM10XX_EVENT_DIETEMP    BIT64(28)
#define NPM10XX_EVENT_ERROR      BIT64(29)
#define NPM10XX_EVENT_VSYSWRNPE  BIT64(30)
#define NPM10XX_EVENT_VSYSWRNNE  BIT64(31)

#define NPM10XX_EVENT_VBUSOVPE      BIT64(32)
#define NPM10XX_EVENT_VBUSOVNE      BIT64(33)
#define NPM10XX_EVENT_VBUSUNDERPE   BIT64(34)
#define NPM10XX_EVENT_VBUSUNDERNE   BIT64(35)
#define NPM10XX_EVENT_VBUSPRESENTPE BIT64(36)
#define NPM10XX_EVENT_VBUSPRESENTNE BIT64(37)
#define NPM10XX_EVENT_VBUSOKPE      BIT64(38)
#define NPM10XX_EVENT_VBUSOKNE      BIT64(39)

#define NPM10XX_EVENT_GPIO0PE BIT64(40)
#define NPM10XX_EVENT_GPIO0NE BIT64(41)
#define NPM10XX_EVENT_GPIO1PE BIT64(42)
#define NPM10XX_EVENT_GPIO1NE BIT64(43)
#define NPM10XX_EVENT_GPIO2PE BIT64(44)
#define NPM10XX_EVENT_GPIO2NE BIT64(45)

#define NPM10XX_EVENT_TIMERTIMEOUT BIT64(48)
#define NPM10XX_EVENT_TIMERFREE    BIT64(49)
#define NPM10XX_EVENT_TIMERPREWARN BIT64(50)
#define NPM10XX_EVENT_LDOSWOC      BIT64(51)
#define NPM10XX_EVENT_LOADSWOC     BIT64(52)
#define NPM10XX_EVENT_SHPHLDPE     BIT64(53)
#define NPM10XX_EVENT_SHPHLDNE     BIT64(54)
#define NPM10XX_EVENT_ADCTEST      BIT64(55)

enum mfd_npm10xx_hibernate_mode {
        NPM10XX_HIBERNATE_VBAT,
        NPM10XX_HIBERNATE_VBUS_WAIT,
        NPM10XX_HIBERNATE_VBUS_NOWAIT,
};

enum mfd_npm10xx_standby_op {
        NPM10XX_STANDBY1_ENTER_WAIT,
        NPM10XX_STANDBY1_ENTER_NOWAIT,
        NPM10XX_STANDBY2_ENTER_WAIT,
        NPM10XX_STANDBY2_ENTER_NOWAIT,
        NPM10XX_STANDBY_EXIT,
};

typedef uint64_t npm10xx_event_t;

typedef uint16_t npm10xx_rstreas_t;
 
struct mfd_npm10xx_event_callback;

typedef void (*npm10xx_callback_handler_t)(const struct device *mfd_npm10xx_dev,
                                           struct mfd_npm10xx_event_callback *cb,
                                           npm10xx_event_t events);

struct mfd_npm10xx_event_callback {
        sys_snode_t node;
        npm10xx_event_t event_mask;
        npm10xx_callback_handler_t handler;
};

int mfd_npm10xx_reset(const struct device *dev);

int mfd_npm10xx_get_reset_reason(const struct device *dev, npm10xx_rstreas_t *reason);

int mfd_npm10xx_hibernate(const struct device *dev, enum mfd_npm10xx_hibernate_mode mode,
                          k_timeout_t time);

int mfd_npm10xx_standby(const struct device *dev, enum mfd_npm10xx_standby_op operation);

int mfd_npm10xx_manage_callback(const struct device *dev,
                                struct mfd_npm10xx_event_callback *callback, bool add);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_MFD_NPM10XX_H_ */