FakePgmSpace.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * FakePgmSpace.h - Support for reading flash memory
 *
 ****/
 
#pragma once
 
#include <stdio.h>
#include <esp_attr.h>
#include <sys/pgmspace.h>
 
#include "m_printf.h"
#include <c_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define IS_ALIGNED(_x) (((uint32_t)(_x)&3) == 0)
 
#define ALIGNUP4(n) (((n) + 3) & ~3)
 
#define ALIGNDOWN4(n) ((n) & ~3)
 
#define printf_P_heap(f_P, ...)                                                                                        \
    (__extension__({                                                                                                   \
        char* __localF = (char*)malloc(strlen_P(f_P) + 1);                                                             \
        strcpy_P(__localF, f_P);                                                                                       \
        int __result = os_printf_plus(__localF, ##__VA_ARGS__);                                                        \
        free(__localF);                                                                                                \
        __result;                                                                                                      \
    }))
 
#define printf_P_stack(f_P, ...)                                                                                       \
    (__extension__({                                                                                                   \
        char __localF[256];                                                                                            \
        strncpy_P(__localF, f_P, sizeof(__localF));                                                                    \
        __localF[sizeof(__localF) - 1] = '\0';                                                                         \
        m_printf(__localF, ##__VA_ARGS__);                                                                             \
    }))
 
#ifdef ARCH_ESP8266
// ESP8266 requires byte-aligned flash accesses for format string...
#define printf_P(fmt, ...) printf_P_stack(fmt, ##__VA_ARGS__)
#else
// ... but other architectures do not
#define printf_P(fmt, ...) m_printf(fmt, ##__VA_ARGS__)
#endif
 
#define PSTR_COUNTED(str)                                                                                              \
    (__extension__({                                                                                                   \
        static const char __pstr__[] PROGMEM = str;                                                                    \
        &__pstr__[0];                                                                                                  \
    }))
 
#ifdef ARCH_ESP8266
#define _F(str)                                                                                                        \
    (__extension__({                                                                                                   \
        DEFINE_PSTR_LOCAL(__pstr__, str);                                                                              \
        LOAD_PSTR(buf, __pstr__);                                                                                      \
        buf;                                                                                                           \
    }))
#else
#define _F(str) (str)
#endif
 
void* memcpy_aligned(void* dst, const void* src, unsigned len);
 
int memcmp_aligned(const void* ptr1, const void* ptr2, unsigned len);
 
#define DEFINE_PSTR(name, str) const char name[] PROGMEM_PSTR = str;
 
#define DEFINE_PSTR_LOCAL(name, str) static DEFINE_PSTR(name, str)
 
#define DECLARE_PSTR(name) extern const char name[];
 
#define LOAD_PSTR(name, flash_str)                                                                                     \
    char name[ALIGNUP4(sizeof(flash_str))] __attribute__((aligned(4)));                                                \
    memcpy_aligned(name, flash_str, sizeof(flash_str));
 
#define _FLOAD(pstr)                                                                                                   \
    (__extension__({                                                                                                   \
        LOAD_PSTR(_buf, pstr);                                                                                         \
        _buf;                                                                                                          \
    }))
 
#define PSTR_ARRAY(name, str)                                                                                          \
    DEFINE_PSTR_LOCAL(__pstr__##name, str);                                                                            \
    LOAD_PSTR(name, __pstr__##name)
 
#ifdef __cplusplus
}
#endif