BasicIoAbstraction.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 https://www.thecoderscorner.com (Dave Cherry).
 * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
 */
 
#ifndef _IO_ABSTRACTION_CORE_TYPES
#define _IO_ABSTRACTION_CORE_TYPES

#include "PlatformDetermination.h"
#include <TaskManagerIO.h>
 
#define IO_PIN_NOT_DEFINED 0xFF
 
#if defined(IOA_USE_MBED)
# include "mbed/MbedDigitalIO.h"
#elif defined(ESP32) && defined(IOA_USE_ESP32_EXTRAS)
# include "esp32/ESP32DigitalIO.h"
#elif defined(BUILD_FOR_PICO_CMAKE)
# include "pico/PicoDigitalIO.h"
#elif defined(BUILD_FOR_STM32CUBE_CMAKE)
# include "stmCube/StmCubeDigital.h"
#elif defined(BUILD_FOR_NATIVE_PLATFORM)
#include "testing/TestDigitalIO.h"
#else
# include <Arduino.h>
#endif //IOA_USE_MBED

class BasicIoAbstraction : public InterruptAbstraction {
private:
#ifdef IOA_USE_MBED
    BtreeList<uint32_t, GpioWrapper> pinCache;
 
    GpioWrapper *allocatePinIfNeedBe(uint8_t pinToAlloc);
#endif //IOA_USE_MBED
public:
    virtual ~BasicIoAbstraction() = default;

    uint8_t digitalRead(pinid_t p) { return readValue(p); }

    void digitalWrite(pinid_t p, uint8_t v) { return writeValue(p, v); }

    uint8_t digitalReadS(pinid_t p) { runLoop(); return readValue(p); }

    void digitalWriteS(pinid_t p, uint8_t v) { writeValue(p, v); sync(); }

    void writePortS(pinid_t p, uint8_t v) { writePort(p, v); sync(); }

    uint8_t readPortS(pinid_t p) { sync(); return readPort(p); }

    void pinMode(pinid_t pin, uint8_t mode) { pinDirection(pin, mode); }

    bool sync() { return runLoop(); }

    virtual void pinDirection(pinid_t pin, uint8_t mode);

    virtual void writeValue(pinid_t pin, uint8_t value);

    virtual uint8_t readValue(pinid_t pin);
    
    virtual void attachInterrupt(pinid_t pin, RawIntHandler interruptHandler, uint8_t mode);

    virtual bool runLoop() { return true; }

    virtual void writePort(pinid_t pin, uint8_t portVal);

    virtual uint8_t readPort(pinid_t pin);
};

typedef BasicIoAbstraction* IoAbstractionRef;

#ifdef IOA_USE_MBED
#define pgm_read_byte_near(x) (*(x))
#elif defined(IOA_USE_ARDUINO)
#define ioUsingArduino internalDigitalIo
#endif

IoAbstractionRef internalDigitalIo();
 
extern BasicIoAbstraction internalIoAbstraction;

#define internalDigitalDevice() internalIoAbstraction

inline void ioDevicePinMode(IoAbstractionRef ioDev, pinid_t pin, uint8_t dir) { ioDev->pinDirection(pin, dir); }

inline uint8_t ioDeviceDigitalRead(IoAbstractionRef ioDev, pinid_t pin) { return ioDev->readValue(pin); }

inline void ioDeviceDigitalWrite(IoAbstractionRef ioDev, pinid_t pin, uint8_t val) { ioDev->writeValue(pin, (val)); }
 
inline bool ioDeviceSync(IoAbstractionRef ioDev) { return ioDev->runLoop(); }

inline void ioDeviceAttachInterrupt(IoAbstractionRef ioDev, pinid_t pin, RawIntHandler intHandler, uint8_t mode) {ioDev->attachInterrupt(pin, intHandler, mode) ;}

inline uint8_t ioDeviceDigitalReadS(IoAbstractionRef ioDev, pinid_t pin) { ioDev->runLoop(); return ioDev->readValue(pin); }

inline bool ioDeviceDigitalWriteS(IoAbstractionRef ioDev, pinid_t pin, uint8_t val) { ioDev->writeValue(pin, (val)); return ioDev->runLoop(); }

inline bool ioDeviceDigitalWritePortS(IoAbstractionRef ioDev, pinid_t pinOnPort, uint8_t portVal) { ioDev->writePort(pinOnPort, portVal); return ioDev->runLoop(); }

inline uint8_t ioDeviceDigitalReadPortS(IoAbstractionRef ioDev, pinid_t pinOnPort) { ioDev->runLoop(); return ioDev->readPort(pinOnPort);  }

inline void ioDeviceDigitalWritePort(IoAbstractionRef ioDev, pinid_t pinOnPort, uint8_t portVal) { ioDev->writePort(pinOnPort, portVal); }

inline uint8_t ioDeviceDigitalReadPort(IoAbstractionRef ioDev, pinid_t pinOnPort) { return ioDev->readPort(pinOnPort);  }
 
#define asIoRef(x) (&(x))
 
#endif // _IO_ABSTRACTION_CORE_TYPES