|
PF1550 Driver 0.1.0
API reference
|
| ▼Npf1550 | The PF1550 driver: everything it declares lives here; internals in detail |
| ▼Nreg | The PF1550 register map |
| CRegisterInfo | One row of the access table |
| CAcknowledgements | Explicit acknowledgements; every flag defaults to false |
| CBatfetConfig | The battery FET (Tables 156, 161, 171) |
| CBuckConfig | A buck regulator. apply = false leaves the block as the chip holds it |
| CCategories | Which category-summary bits are set in INT_CATEGORY (Table 89) |
| CChargerAsFound | Charger registers as found at start-up (the as-found check) |
| CChargerConfig | The charger. apply = false leaves it as found. Voltage, current and input limit have no default: they must be set when apply is true |
| CChargerInterrupts | Charger interrupt options (Table 167) |
| CChargerStatus | The charger status of one ReadChargerStatus() pass (separate reads, not atomic) |
| CCoinCell | The coin cell charger (Table 111) |
| CConfig | Everything the driver writes. The constructor stores it with no I/O |
| CCoreOffConfirm | Token: the caller confirms that EnterCoreOff() turns the PMIC core off |
| CFaultPolicy | BATFET behaviour per fault; false opens the BATFET (the reset value, the safe one) |
| CI2cInterface | CRTP base of the platform I2C port |
| CInterruptEvents | Interrupt events returned by ServiceInterrupts(), one status byte per group |
| CIrqLocation | Where one interrupt source lives |
| CIrqMask | Interrupt masks, one byte per group; a set bit masks the source. The default masks every source, as the chip does after power-up (section 9.4) |
| CJeitaConfig | JEITA thresholds and reductions (Tables 162, 168) |
| CLdoConfig | An LDO |
| CLedConfig | The charger LED driver (Tables 170 and 172) |
| CLimits | What the application's hardware tolerates. No defaults: Validate() rejects unset ones |
| CLoadSwitchConfirm | Token: the caller confirms that a load switch has no current limit and cannot go back, and states the voltage of the LDO's input rail. The call refuses when that voltage is outside the rail's Limits window: in switch mode the output is the input voltage (section 7.2.6) |
| CMicrovolts | A voltage in microvolts, so that grids such as 12.5 mV steps stay exact |
| CPF1550 | Driver for one PF1550 on a platform port |
| CPowerConfig | Power control (Tables 135 to 137) |
| CPowerDownConfig | The power-down order (Tables 139 to 145); needs power_down_order_reviewed |
| CPowerDownSequence | The registers of the power-down sequence (Tables 139 to 145) |
| CRailLimits | The voltage window and load a rail's consumer tolerates. All zero means "not set" |
| CRailModes | Per-state rail enables (EN, STBY_EN, OMODE, LPWR) |
| CRailReadout | One rail as the chip holds it |
| CResult | The value of a call, or why there is none |
| CResult< void > | The result of a call that returns no value |
| CSelfCheckReport | Result of SelfCheck(): what is wrong, if anything |
| CShipConfirm | Token: the caller confirms that EnterShip() cuts all supplies, VSNVS included |
| CSnapshot | A read-only view of the chip for diagnostics (ReadSnapshot()) |
| CStartupProfile | The start-up behaviour of one pre-programmed option (Table 85) |
| CUsbPhyConfig | The USBPHY LDO (Table 165) |
| CVariantInfo | What ReadVariant() reports |
| CVbusFlags | VBUS flags of VBUS_SNS (Table 153) |
| CVbusOptions | VBUS options (Tables 164, 166, 169) |
| CVrefDdrConfig | VREFDDR |
| CVsnvsConfig | VSNVS |
| CWatchdogConfig | The charger watchdog. When on, ServiceChargerWatchdog() must run every 16 s or less |
| RI2cPort | Satisfied by a class that derives from I2cInterface<Port> and implements the required hooks with exactly the types above, noexcept and returning bool |