power_management.h

Go to the documentation of this file.

#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
namespace ersa::board { class Pins; }
 
namespace ersa::hal {
 
enum class PerformanceProfile : uint8_t {
    Interactive,
    DisplayRefresh,
    Compute
};
 
class IPowerManagement {
public:
    virtual ~IPowerManagement() = default;
    virtual bool initialize() = 0;
    virtual void tick() = 0;
    virtual bool initializeWakeSources(const board::Pins& pins) = 0;
    virtual void allowAutomaticSleep(bool allow) = 0;
    virtual void waitForWake(uint32_t timeoutMs) = 0;
    virtual void notifyWake() = 0;
    virtual void enterDeepSleep(uint64_t timerUs) = 0;
    virtual bool acquirePerformance(PerformanceProfile profile, const char* reason) = 0;
    virtual void releasePerformance(PerformanceProfile profile, const char* reason) = 0;
    virtual void reportPowerModes() = 0;
    virtual bool getPowerModeReport(char* buffer, size_t capacity) = 0;
    virtual bool setTestCpuFrequencyMHz(unsigned mhz) = 0;
    virtual unsigned testCpuFrequencyMHz() const = 0;
};
 
class PerformanceScope {
public:
    PerformanceScope(IPowerManagement& power, PerformanceProfile profile, const char* reason)
        : power_(&power), profile_(profile), reason_(reason), acquired_(power.acquirePerformance(profile, reason)) {}
    ~PerformanceScope() { if (acquired_) power_->releasePerformance(profile_, reason_); }
    PerformanceScope(const PerformanceScope&) = delete;
    PerformanceScope& operator=(const PerformanceScope&) = delete;
private:
    IPowerManagement* power_;
    PerformanceProfile profile_;
    const char* reason_;
    bool acquired_;
};
 
} // namespace ersa::hal