Board.cpp

#include "Board.h"
#include "MAX1726Driver.h"
#include <map>

constexpr int UNKNOWN_VALUE = 0xFF;

std::map<float, Ldo2Voltage> ldo2VoltageMap = {
    {1.80f, Ldo2Voltage::V_1_80},
    {1.90f, Ldo2Voltage::V_1_90},
    {2.00f, Ldo2Voltage::V_2_00},
    {2.10f, Ldo2Voltage::V_2_10},
    {2.20f, Ldo2Voltage::V_2_20},
    {2.30f, Ldo2Voltage::V_2_30},
    {2.40f, Ldo2Voltage::V_2_40},
    {2.50f, Ldo2Voltage::V_2_50},
    {2.60f, Ldo2Voltage::V_2_60},
    {2.70f, Ldo2Voltage::V_2_70},
    {2.80f, Ldo2Voltage::V_2_80},
    {2.90f, Ldo2Voltage::V_2_90},
    {3.00f, Ldo2Voltage::V_3_00},
    {3.10f, Ldo2Voltage::V_3_10},
    {3.20f, Ldo2Voltage::V_3_20},
    {3.30f, Ldo2Voltage::V_3_30}
};

std::map<float, Sw1Voltage> sw1VoltageMap = {
    {1.10f, Sw1Voltage::V_1_10},
    {1.20f, Sw1Voltage::V_1_20},
    {1.35f, Sw1Voltage::V_1_35},
    {1.50f, Sw1Voltage::V_1_50},
    {1.80f, Sw1Voltage::V_1_80},
    {2.50f, Sw1Voltage::V_2_50},
    {3.00f, Sw1Voltage::V_3_00},
    {3.30f, Sw1Voltage::V_3_30}
};

std::map<float, Sw2Voltage> sw2VoltageMap = {
    {1.10f, Sw2Voltage::V_1_10},
    {1.20f, Sw2Voltage::V_1_20},
    {1.35f, Sw2Voltage::V_1_35},
    {1.50f, Sw2Voltage::V_1_50},
    {1.80f, Sw2Voltage::V_1_80},
    {2.50f, Sw2Voltage::V_2_50},
    {3.00f, Sw2Voltage::V_3_00},
    {3.30f, Sw2Voltage::V_3_30}
};

Board::Board() {
    #if defined(ARDUINO_PORTENTA_C33)
        this->lowPower = new LowPower();
    #endif
}

Board::~Board() {
    #if defined(ARDUINO_PORTENTA_C33)
        delete lowPower;
    #endif
}

bool Board::begin() {
    #if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION)
        if (CM7_CPUID == HAL_GetCurrentCPUID()){
            if (LowPowerReturnCode::success != LowPower.checkOptionBytes()){
                LowPower.prepareOptionBytes();
            }
            bootM4();
        }
    #endif 
    return PMIC.begin() == 0;
}

bool Board::isUSBPowered() {
    uint16_t registerValue = PMIC.readPMICreg(Register::CHARGER_VBUS_SNS);
    return bitRead(registerValue, 5) == 1; // — VBUS is valid -> USB powered
}

bool Board::isBatteryPowered() {
    uint8_t registerValue = PMIC.readPMICreg(Register::CHARGER_BATT_SNS);
    uint8_t batteryPower = extractBits(registerValue, 0, 2);
    return batteryPower == 0; 
}

void Board::setExternalPowerEnabled(bool on) {
        if(on)
            PMIC.getControl()->turnSw2On(Sw2Mode::Normal);
        else
            PMIC.getControl()->turnSw2Off(Sw2Mode::Normal);
}

bool Board::setExternalVoltage(float voltage) {
        this -> setExternalPowerEnabled(false);
        uint8_t targetVoltage = getRailVoltageEnum(voltage, CONTEXT_SW2);

        if (targetVoltage == UNKNOWN_VALUE){                    
            return false;
        }

        PMIC.writePMICreg(Register::PMIC_SW2_VOLT, targetVoltage);
        if(PMIC.readPMICreg(Register::PMIC_SW2_VOLT) == targetVoltage){
            this -> setExternalPowerEnabled(true);
            return true;
        }
 
        return false;
}

void Board::setCameraPowerEnabled(bool on) {
    #if defined(ARDUINO_NICLA_VISION)
        if(on){
            PMIC.getControl()->turnLDO1On(Ldo1Mode::Normal);
            PMIC.getControl()->turnLDO2On(Ldo2Mode::Normal);
            PMIC.getControl()->turnLDO3On(Ldo3Mode::Normal);
        } else {
            PMIC.getControl()->turnLDO1Off(Ldo1Mode::Normal);
            PMIC.getControl()->turnLDO2Off(Ldo2Mode::Normal);
            PMIC.getControl()->turnLDO3Off(Ldo3Mode::Normal);
        }
    #endif
}

#if defined(ARDUINO_PORTENTA_C33) 
void Board::enableWakeupFromPin(uint8_t pin, PinStatus direction){
    lowPower->enableWakeupFromPin(pin, direction);
}
#endif

#if defined(ARDUINO_PORTENTA_H7)
void Board::enableWakeupFromPin(){
    standbyType |= StandbyType::untilPinActivity;
}

void Board::enableSleepWhenIdle(){
    LowPower.allowDeepSleep();
}
#endif


#if defined(ARDUINO_PORTENTA_C33)
bool Board::enableWakeupFromRTC(uint32_t hours, uint32_t minutes, uint32_t seconds, void (* const callbackFunction)(), RTClock * rtc){
    return lowPower->setWakeUpAlarm(hours, minutes, seconds, callbackFunction, rtc);
}

bool Board::enableWakeupFromRTC(uint32_t hours, uint32_t minutes, uint32_t seconds, RTClock * rtc){
    return enableWakeupFromRTC(hours, minutes, seconds, nullptr, rtc);
}

#endif

#if defined(ARDUINO_PORTENTA_H7) || defined(ARDUINO_NICLA_VISION)
bool Board::enableWakeupFromRTC(uint32_t hours, uint32_t minutes, uint32_t seconds){
    standbyType |= StandbyType::untilTimeElapsed;
    wakeupDelayHours = hours;
    wakeupDelayMinutes = minutes;
    wakeupDelaySeconds = seconds;
    return true;
}
#endif

#if defined(ARDUINO_PORTENTA_C33)
void Board::sleepUntilWakeupEvent(){
    lowPower -> sleep();
}
#endif

void Board::standByUntilWakeupEvent(){
    #if defined(ARDUINO_PORTENTA_C33)
        lowPower -> deepSleep();
    #elif defined(CORE_CM4)
        LowPower.standbyM4();
    #elif defined(ARDUINO_PORTENTA_H7_M7)
        RTCWakeupDelay rtcWakeupDelay = RTCWakeupDelay(wakeupDelayHours, wakeupDelayMinutes, wakeupDelaySeconds);
        if(standbyType == StandbyType::untilEither)
            LowPower.standbyM7(LowPowerStandbyType::untilPinActivity | LowPowerStandbyType::untilTimeElapsed, rtcWakeupDelay);
        else if (standbyType == StandbyType::untilPinActivity)
            LowPower.standbyM7(LowPowerStandbyType::untilPinActivity);
        else if (standbyType == StandbyType::untilTimeElapsed)
           LowPower.standbyM7(LowPowerStandbyType::untilTimeElapsed, rtcWakeupDelay);
    #elif defined(ARDUINO_NICLA_VISION) && defined(CORE_CM7)
        RTCWakeupDelay rtcWakeupDelay = RTCWakeupDelay(wakeupDelayHours, wakeupDelayMinutes, wakeupDelaySeconds);
        LowPower.standbyM7(rtcWakeupDelay);
    #endif
}

void Board::setAllPeripheralsPower(bool on){
    #if defined(ARDUINO_PORTENTA_C33)
    // The power architecture on the C33 puts peripherals on sepparate power lanes which are independent, so we can turn off the peripherals separately. 
    // Turning these rails will not interfere with your sketch. 
        this -> setCommunicationPeripheralsPower(on);
        this -> setExternalPowerEnabled(on);
        this -> setAnalogDigitalConverterPower(on);
    #elif defined(ARDUINO_PORTENTA_H7)
    // On the H7 several chips need different voltages, so we cannot turn the lanes that are dependent on each other separately.
    // This should only be used when going into standby mode, as turning off the USB-C PHY, Ethernet or Video bridge might cause undefined behaviour. 
    if(on){
        PMIC.getControl() -> turnLDO2On(Ldo2Mode::Normal);
        PMIC.getControl() -> turnLDO1On(Ldo1Mode::Normal);
        PMIC.getControl() -> turnLDO3On(Ldo3Mode::Normal);
        PMIC.getControl() -> turnSw1On(Sw1Mode::Normal);
    } else {
        PMIC.getControl() -> turnLDO2Off(Ldo2Mode::Normal);
        PMIC.getControl() -> turnLDO1Off(Ldo1Mode::Normal);
        PMIC.getControl() -> turnLDO3Off(Ldo3Mode::Normal);
        PMIC.getControl() -> turnSw1Off(Sw1Mode::Normal);
    }

    #elif defined(ARDUINO_NICLA_VISION)
    if(on){
        PMIC.getControl() -> turnLDO2On(Ldo2Mode::Normal);  // Camera
        PMIC.getControl() -> turnLDO1On(Ldo1Mode::Normal);  // ToF sensor / Camera
        PMIC.getControl() -> turnLDO3On(Ldo3Mode::Normal);  // VDDA - Analog components, e.g. ADC
        PMIC.getControl() -> turnSw2On(Sw2Mode::Normal);    // USB, 25 MHz crystal, 32 kHz crystal
        // TODO: Not supported yet by PMIC library
        // PMIC.getControl() -> turnSw3On(Sw3Mode::Normal);    // External power VDDIO_EXT
    } else {
        PMIC.getControl() -> turnLDO2Off(Ldo2Mode::Normal); // Camera
        PMIC.getControl() -> turnLDO1Off(Ldo1Mode::Normal); // ToF sensor / Camera
        PMIC.getControl() -> turnLDO3Off(Ldo3Mode::Normal); // VDDA - Analog components, e.g. ADC
        PMIC.getControl() -> turnSw2Off(Sw2Mode::Normal);   // USB, 25 MHz crystal, 32 kHz crystal
        // TODO: Not supported yet by PMIC library
        // PMIC.getControl() -> turnSw3Off(Sw3Mode::Normal);   // External power VDDIO_EXT
    }
    #endif
}
//
void Board::setAnalogDigitalConverterPower(bool on){
    #if defined(ARDUINO_PORTENTA_C33)
        if(on){
            PMIC.getControl()->turnLDO1On(Ldo1Mode::Normal);
        } else {
            PMIC.getControl()->turnLDO1Off(Ldo1Mode::Normal);
        }
    #endif
    // On the H7 the ADC is powered by the main MCU power lane, so we cannot turn it off independently. 
}

void Board::setCommunicationPeripheralsPower(bool on){
    #if defined(ARDUINO_PORTENTA_C33)
        if(on){
            PMIC.getControl()->turnSw1On(Sw1Mode::Normal);
        } else {
            PMIC.getControl()->turnSw1Off(Sw1Mode::Normal);
        }
    #endif
    // On the H7 the communication peripherals are powered by the main MCU power lane, 
    // so we cannot turn them off independently. 
}


bool Board::setReferenceVoltage(float voltage) {
    uint8_t voltageRegisterValue = getRailVoltageEnum(voltage, CONTEXT_LDO2);

    // If voltageRegisterValue is not empty, write it to the PMIC register 
    // and return the result of the comparison directly.
    if (voltageRegisterValue != UNKNOWN_VALUE) {
        PMIC.writePMICreg(Register::PMIC_LDO2_VOLT, voltageRegisterValue);
        return (PMIC.readPMICreg(Register::PMIC_LDO2_VOLT) == voltageRegisterValue);
    }

    return false;
}

 uint8_t Board::getRailVoltageEnum(float voltage, int context) {
    switch (context) {
        case CONTEXT_LDO2:
            if (ldo2VoltageMap.find(voltage) != ldo2VoltageMap.end()) {
                return static_cast<uint8_t>(ldo2VoltageMap[voltage]);
            }
            break;
            
        case CONTEXT_SW1:
            if (sw1VoltageMap.find(voltage) != sw1VoltageMap.end()) {
                return static_cast<uint8_t>(sw1VoltageMap[voltage]);
            }
            break;

        case CONTEXT_SW2:
            if (sw2VoltageMap.find(voltage) != sw2VoltageMap.end()) {
                return static_cast<uint8_t>(sw2VoltageMap[voltage]);
            }
            break;

        default:
            return UNKNOWN_VALUE;
    }
    

    return UNKNOWN_VALUE;
}

void Board::shutDownFuelGauge() {
    #if defined(ARDUINO_PORTENTA_C33)
        MAX1726Driver fuelGauge(&Wire3);
    #elif defined(ARDUINO_PORTENTA_H7)
        MAX1726Driver fuelGauge(&Wire1);
    #elif defined(ARDUINO_NICLA_VISION)
        MAX1726Driver fuelGauge(&Wire1);
    #else
        #error "The selected board is not supported by the Battery class."
    #endif
    fuelGauge.setOperationMode(FuelGaugeOperationMode::shutdown);
}