PF1550 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Namespace List
Here is a list of all documented namespaces with brief descriptions:
[detail level 123]
 ▼Npf1550The PF1550 driver: everything it declares lives here; internals in detail
 ▼NregThe PF1550 register map
 CRegisterInfoOne row of the access table
 CAcknowledgementsExplicit acknowledgements; every flag defaults to false
 CBatfetConfigThe battery FET (Tables 156, 161, 171)
 CBuckConfigA buck regulator. apply = false leaves the block as the chip holds it
 CCategoriesWhich category-summary bits are set in INT_CATEGORY (Table 89)
 CChargerAsFoundCharger registers as found at start-up (the as-found check)
 CChargerConfigThe charger. apply = false leaves it as found. Voltage, current and input limit have no default: they must be set when apply is true
 CChargerInterruptsCharger interrupt options (Table 167)
 CChargerStatusThe charger status of one ReadChargerStatus() pass (separate reads, not atomic)
 CCoinCellThe coin cell charger (Table 111)
 CConfigEverything the driver writes. The constructor stores it with no I/O
 CCoreOffConfirmToken: the caller confirms that EnterCoreOff() turns the PMIC core off
 CFaultPolicyBATFET behaviour per fault; false opens the BATFET (the reset value, the safe one)
 CI2cInterfaceCRTP base of the platform I2C port
 CInterruptEventsInterrupt events returned by ServiceInterrupts(), one status byte per group
 CIrqLocationWhere one interrupt source lives
 CIrqMaskInterrupt 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)
 CJeitaConfigJEITA thresholds and reductions (Tables 162, 168)
 CLdoConfigAn LDO
 CLedConfigThe charger LED driver (Tables 170 and 172)
 CLimitsWhat the application's hardware tolerates. No defaults: Validate() rejects unset ones
 CLoadSwitchConfirmToken: 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)
 CMicrovoltsA voltage in microvolts, so that grids such as 12.5 mV steps stay exact
 CPF1550Driver for one PF1550 on a platform port
 CPowerConfigPower control (Tables 135 to 137)
 CPowerDownConfigThe power-down order (Tables 139 to 145); needs power_down_order_reviewed
 CPowerDownSequenceThe registers of the power-down sequence (Tables 139 to 145)
 CRailLimitsThe voltage window and load a rail's consumer tolerates. All zero means "not set"
 CRailModesPer-state rail enables (EN, STBY_EN, OMODE, LPWR)
 CRailReadoutOne rail as the chip holds it
 CResultThe value of a call, or why there is none
 CResult< void >The result of a call that returns no value
 CSelfCheckReportResult of SelfCheck(): what is wrong, if anything
 CShipConfirmToken: the caller confirms that EnterShip() cuts all supplies, VSNVS included
 CSnapshotA read-only view of the chip for diagnostics (ReadSnapshot())
 CStartupProfileThe start-up behaviour of one pre-programmed option (Table 85)
 CUsbPhyConfigThe USBPHY LDO (Table 165)
 CVariantInfoWhat ReadVariant() reports
 CVbusFlagsVBUS flags of VBUS_SNS (Table 153)
 CVbusOptionsVBUS options (Tables 164, 166, 169)
 CVrefDdrConfigVREFDDR
 CVsnvsConfigVSNVS
 CWatchdogConfigThe charger watchdog. When on, ServiceChargerWatchdog() must run every 16 s or less
 RI2cPortSatisfied by a class that derives from I2cInterface<Port> and implements the required hooks with exactly the types above, noexcept and returning bool