PF1550 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Classes | Namespaces
pf1550.hpp File Reference

PF1550 driver: the one header to include. More...

#include <array>
#include <cstddef>
#include <cstdint>
#include <span>
#include "pf1550_codec.hpp"
#include "pf1550_config.hpp"
#include "pf1550_detail.hpp"
#include "pf1550_i2c_interface.hpp"
#include "pf1550_irq.hpp"
#include "pf1550_plan.hpp"
#include "pf1550_registers.hpp"
#include "pf1550_sequencer.hpp"
#include "pf1550_types.hpp"
#include "pf1550_version.h"
#include "../src/pf1550.ipp"

Go to the source code of this file.

Classes

class  pf1550::PF1550< Port >
 Driver for one PF1550 on a platform port. More...
 

Namespaces

namespace  pf1550
 The PF1550 driver: everything it declares lives here; internals in detail.
 

Detailed Description

PF1550 driver: the one header to include.

pf1550::PF1550<Port> drives one NXP PF1550 power management IC (a single-cell linear charger, three buck regulators, three LDOs, VSNVS, VREFDDR, a USB PHY LDO, an LED driver and a coin cell charger) through a platform port you write (see pf1550_i2c_interface.hpp). The driver has no platform code, allocates nothing, throws nothing, takes no lock and is not thread-safe: give each object one owner, or guard it with one mutex.

The chip is a power supply and the driver treats it as one: there is no raw register write, every value is checked against the data sheet grids and against the Limits your application declares, every safety downgrade needs a named acknowledgement, and every typed configuration write is a read-modify-write from two agreeing reads that is read back and compared (the command writes of ServiceInterrupts(), the shutdown requests and the watchdog service excepted; see docs/contract.md).