Program Listing for File platform.h

↰ Return to documentation for file (src/knx/platform.h)

#pragma once

#include <stdint.h>
#include <stddef.h>
#include "save_restore.h"

#ifndef KNX_FLASH_CALLBACK
    #ifndef KNX_FLASH_SIZE
        #define KNX_FLASH_SIZE 1024
        #pragma warning "KNX_FLASH_SIZE not defined, using 1024"
    #endif
#endif

#ifdef KNX_FLASH_CALLBACK
    #ifndef KNX_FLASH_SIZE
        #define KNX_FLASH_SIZE 0
    #endif
    typedef uint32_t (*FlashCallbackSize)();
    typedef uint8_t* (*FlashCallbackRead)();
    typedef uint32_t (*FlashCallbackWrite)(uint32_t relativeAddress, uint8_t* buffer, size_t len);
    typedef void (*FlashCallbackCommit)();
#endif

enum NvMemoryType
{
    Eeprom,
    Flash,
    Callback
};

class Platform
{
    public:
        virtual ~Platform() {}
        // ip config
        virtual uint32_t currentIpAddress();
        virtual uint32_t currentSubnetMask();
        virtual uint32_t currentDefaultGateway();
        virtual void macAddress(uint8_t* data);

        // unique serial number
        virtual uint32_t uniqueSerialNumber();

        // basic stuff
        virtual void restart() = 0;
        virtual void fatalError() = 0;

        //multicast socket
        virtual void setupMultiCast(uint32_t addr, uint16_t port);
        virtual void closeMultiCast();
        virtual bool sendBytesMultiCast(uint8_t* buffer, uint16_t len);
        virtual int readBytesMultiCast(uint8_t* buffer, uint16_t maxLen);
        virtual int readBytesMultiCast(uint8_t* buffer, uint16_t maxLen, uint32_t& src_addr, uint16_t& src_port);

        //unicast socket
        virtual bool sendBytesUniCast(uint32_t addr, uint16_t port, uint8_t* buffer, uint16_t len);

        //UART
        virtual void setupUart();
        virtual void closeUart();
        virtual int uartAvailable();
        virtual size_t writeUart(const uint8_t data);
        virtual size_t writeUart(const uint8_t* buffer, size_t size);
        virtual int readUart();
        virtual size_t readBytesUart(uint8_t* buffer, size_t length);
        virtual bool overflowUart();
        virtual void flushUart();

        // SPI
        virtual void setupSpi();
        virtual void closeSpi();
        virtual int readWriteSpi(uint8_t* data, size_t len);

        //Memory

        // --- Overwrite these methods in the device-plattform to use the EEPROM Emulation API for UserMemory ----
        //
        // --- changes to the UserMemory are written directly into the address space starting at getEepromBuffer
        // --- commitToEeprom must save this to a non-volatile area if neccessary
        virtual uint8_t* getEepromBuffer(uint32_t size);
        virtual void commitToEeprom();
        // -------------------------------------------------------------------------------------------------------

        virtual uint8_t* getNonVolatileMemoryStart();
        virtual size_t getNonVolatileMemorySize();
        virtual void commitNonVolatileMemory();
        // address is relative to start of nonvolatile memory
        virtual uint32_t writeNonVolatileMemory(uint32_t relativeAddress, uint8_t* buffer, size_t size);
        virtual uint32_t readNonVolatileMemory(uint32_t relativeAddress, uint8_t* buffer, size_t size);
        virtual uint32_t writeNonVolatileMemory(uint32_t relativeAddress, uint8_t value, size_t repeat);

        NvMemoryType NonVolatileMemoryType();
        void NonVolatileMemoryType(NvMemoryType type);

        // --- Overwrite these methods in the device-plattform to use flash memory handling by the knx stack ---
        // --- also set _memoryType = Flash in the device-plattform's contructor
        // --- optional: overwrite writeBufferedEraseBlock() in the device-plattform to reduce overhead when flashing multiple pages

        // size of one flash page in bytes
        virtual size_t flashPageSize();

#ifdef KNX_FLASH_CALLBACK
        void registerFlashCallbacks(
            FlashCallbackSize callbackFlashSize,
            FlashCallbackRead callbackFlashRead,
            FlashCallbackWrite callbackFlashWrite,
            FlashCallbackCommit callbackFlashCommit);

        FlashCallbackSize callbackFlashSize();
        FlashCallbackRead callbackFlashRead();
        FlashCallbackWrite callbackFlashWrite();
        FlashCallbackCommit callbackFlashCommit();
#endif

    protected:
        // size of one EraseBlock in pages
        virtual size_t flashEraseBlockSize();
        // start of user flash aligned to start of an erase block
        virtual uint8_t* userFlashStart();
        // size of the user flash in EraseBlocks
        virtual size_t userFlashSizeEraseBlocks();
        //relativ to userFlashStart
        virtual void flashErase(uint16_t eraseBlockNum);
        //write a single page to flash (pageNumber relative to userFashStart
        virtual void flashWritePage(uint16_t pageNumber, uint8_t* data);


        // -------------------------------------------------------------------------------------------------------

        NvMemoryType _memoryType = Eeprom;

        void loadEraseblockContaining(uint32_t relativeAddress);
        int32_t getEraseBlockNumberOf(uint32_t relativeAddress);
        // writes _eraseblockBuffer to flash
        virtual void writeBufferedEraseBlock();
        // copies a EraseBlock into the _eraseblockBuffer
        void bufferEraseBlock(int32_t eraseBlockNumber);

        // in theory we would have to use this buffer for memory reads too,
        // but because ets always restarts the device after programming it
        // we can ignore this issue
        uint8_t* _eraseblockBuffer = nullptr;
        int32_t _bufferedEraseblockNumber = -1;
        bool _bufferedEraseblockDirty = false;

#ifdef KNX_FLASH_CALLBACK
        FlashCallbackSize _callbackFlashSize = nullptr;
        FlashCallbackRead _callbackFlashRead = nullptr;
        FlashCallbackWrite _callbackFlashWrite = nullptr;
        FlashCallbackCommit _callbackFlashCommit = nullptr;
#endif
};