Gpio.hxx

Go to the documentation of this file.

 
#ifndef _OS_GPIO_HXX_
#define _OS_GPIO_HXX_
 
#include "utils/macros.h"
 
class Gpio
{
public:
    constexpr Gpio()
    {
    }
 
    /* It is important that there be no destructor declared here, not even with
     * empty and inlined and non-virtual body. The Gpio objects are never
     * deleted through their base class; the specific implementations must live
     * in HwInit.cxx with global scope. If there is a destructor here, that
     * will prevent the compiler from creating the Gpio instance variables in
     * the flash, and they will all start using RAM instead. That's a big
     * difference. */
 
    enum Value : bool
    {
        CLR = false,
        SET = true,
        VLOW = CLR,
        VHIGH = SET
    };
 
    enum class Direction
    {
        DINPUT,
        DOUTPUT,
    };
 
    virtual void write(Value new_state) const = 0;
 
    void write(bool new_state) const
    {
        write((Value)new_state);
    }
 
    virtual Value read() const = 0;
 
    bool is_set() const
    {
        return read() == SET;
    }
 
    bool is_clr()const
    {
        return read() == CLR;
    }
 
    virtual void set() const = 0;
 
    virtual void clr() const = 0;
 
    virtual void set_direction(Direction dir) const = 0;
 
    virtual Direction direction() const = 0;
};
 
#endif /* _FREERTOS_DRIVERS_COMMON_GPIOGENERIC_HXX_ */