environment_interface.h

Go to the documentation of this file.

#ifndef VITROIO_SDK_ENVIRONMENT_INTERFACE_H
#define VITROIO_SDK_ENVIRONMENT_INTERFACE_H
 
#include <mbed.h>
 
#include <vitroio-sdk/types.h>
#include <vitroio-sdk/consts.h>
 
namespace vitroio
{
 
namespace sdk
{
 
namespace impl
{
 
#define VITROIO_ENVIRONMENT_INTERFACE_BOOT_REGION_A 0x0A
#define VITROIO_ENVIRONMENT_INTERFACE_BOOT_REGION_B 0x0B
 
class FlashInterface;
 
class EnvironmentInterface : private NonCopyable<EnvironmentInterface>
{
public:
    enum Variable
    {
        ENVVAR_CURRENT_BOOT_REGION,
        ENVVAR_NEXT_BOOT_REGION,
        ENVVAR_TIMESTAMP
    };
 
    explicit EnvironmentInterface(FlashInterface* flash, FlashSpace flashSpace);
 
    ~EnvironmentInterface();
 
    bool isValid() const;
 
    int save();
 
    uint32_t getVariable(Variable variable) const;
    void getVariableIOKeys(uint8_t* retValue, uint32_t offset, uint32_t bytes) const;
    void setVariable(Variable variable, uint32_t value);
    void setVariableIOKeys(uint8_t* value, uint32_t offset, uint32_t bytes);
 
private:
    bool valid_;
 
    FlashInterface* flash_;
    FlashSpace flashSpace_;
    uint8_t environment_[VITROIO_CONSTS_ENVIRONMENT_REQUIRED_FLASH_SIZE];
 
    void setDefaults();
 
    // Auxiliary method for internal usage to avoid double allocating of buffer
    // (prevent memory fragmentation).
    // Method assumes that the buffer size is minimum maxSectorSize of flash.
    int save(uint8_t* buffer);
 
    uint32_t getVariable(uint32_t offset, uint32_t bytes) const;
    void setVariable(uint32_t value, uint32_t offset, uint32_t bytes);
};
 
} // namespace impl
 
} // namespace sdk
 
} // namespace vitroio
 
#endif // VITROIO_SDK_ENVIRONMENT_INTERFACE_H