PmicGpioBase.hpp

Go to the documentation of this file.

 
#pragma once
#include <stdint.h>
 
class PmicGpioBase
{
public:
    virtual ~PmicGpioBase() = default;
 
    enum class Direction : uint8_t {
        Input = 0,   
        Output = 1,  
    };
 
    enum class DriveType : uint8_t {
        PushPull = 0,  
        OpenDrain = 1, 
        Keep = 0xFF,   
    };
 
    enum class Level : uint8_t {
        Low = 0,   
        HiZ = 1,   
        High = 2,  
    };
 
    enum class Pull : uint8_t {
        None = 0,  
        Down = 1,  
        Up = 2,    
        Keep = 0xFF, 
    };
 
    enum class Status : uint8_t {
        Ok = 0,
        InvalidPin = 1,
        Failed = 2,
    };
 
    static constexpr bool isOk(Status s)
    {
        return s == Status::Ok;
    }
 
    Status pinMode(uint8_t pin, Direction dir, DriveType drive = DriveType::Keep,
                   Pull pull = Pull::Keep, uint8_t func = 0xFF)
    {
        if (drive != DriveType::Keep) {
            Status st = setDrive(pin, drive);
            if (!isOk(st) && getDrive(pin) != drive) return st;
        }
 
        if (pull != Pull::Keep) {
            Status st = setPull(pin, pull);
            if (!isOk(st) && getPull(pin) != pull) return st;
        }
 
        return Status::Ok;
    }
 
    virtual uint8_t getPinCount() const = 0;
 
    virtual Status setDirection(uint8_t pin, Direction dir) = 0;
 
    virtual Direction getDirection(uint8_t pin) = 0;
 
    virtual Status setDrive(uint8_t pin, DriveType drive) = 0;
 
    virtual DriveType getDrive(uint8_t pin) = 0;
 
    virtual Status read(uint8_t pin, bool &high) = 0;
 
    virtual Status write(uint8_t pin, Level level) = 0;
 
    virtual Status setFunction(uint8_t pin, uint8_t func)
    {
        (void)pin;
        (void)func;
        return Status::Failed;
    }
 
    virtual uint8_t getFunction(uint8_t pin)
    {
        (void)pin;
        return 0xFF;
    }
 
    virtual Status setPull(uint8_t pin, Pull pull)
    {
        (void)pin;
        (void)pull;
        return Status::Failed;
    }
 
    virtual Pull getPull(uint8_t pin)
    {
        (void)pin;
        return Pull::None;
    }
};