fastled_progmem.h

Go to the documentation of this file.

#pragma once
 
#include "platforms/is_platform.h"  // ok platform headers
#include "fl/stl/int.h"  // ok platform headers
 
#if defined(__EMSCRIPTEN__) || defined(FASTLED_TESTING) || defined(FASTLED_STUB_IMPL)
#include "platforms/null_progmem.h"  // ok platform headers
#elif defined(ESP8266)
#include "platforms/esp/8266/progmem_esp8266.h"  // ok platform headers
#elif defined(FL_IS_STM32)
#include "platforms/arm/stm32/progmem_stm32.h"  // ok platform headers
#else
 
 
 

 
 
 
// This block is used for Doxygen documentation generation,
// so that the Doxygen parser will be able to find the macros
// included without a defined platform
#ifdef FASTLED_DOXYGEN
#define FASTLED_USE_PROGMEM 1
#endif

 
 
#if (FASTLED_USE_PROGMEM == 1) || defined(FASTLED_DOXYGEN)
#ifndef FASTLED_INCLUDE_PGMSPACE
#define FASTLED_INCLUDE_PGMSPACE 1
#endif
 
#if FASTLED_INCLUDE_PGMSPACE == 1
// IWYU pragma: begin_keep
#include <avr/pgmspace.h>
// IWYU pragma: end_keep
#endif

#if defined(__IMXRT1062__)
#define FL_PROGMEM
#else
#define FL_PROGMEM                PROGMEM
#endif
 


#define FL_PGM_READ_BYTE_NEAR(x)  (pgm_read_byte_near(x))
#define FL_PGM_READ_WORD_NEAR(x)  (pgm_read_word_near(x))
#define FL_PGM_READ_DWORD_NEAR(x) (pgm_read_dword_near(x))

 
// Aligned PROGMEM reads using AVR pgm_read_* functions.
#define FL_PGM_READ_WORD_ALIGNED(addr) ((fl::u16)pgm_read_word_near(addr))
#define FL_PGM_READ_DWORD_ALIGNED(addr) ((fl::u32)pgm_read_dword_near(addr))
 
// Workaround for http://gcc.gnu.org/bugzilla/show_bug.cgi?id=34734
#if __GNUC__ < 4 || (__GNUC__ == 4 && (__GNUC_MINOR__ < 6))
#ifdef FASTLED_AVR
#ifdef PROGMEM
#undef PROGMEM
#define PROGMEM __attribute__((section(".progmem.data")))
#endif
#endif
#endif
 
#else
// If FASTLED_USE_PROGMEM is 0 or undefined,
// we'll use regular memory (RAM) access.
 
#include "platforms/null_progmem.h"
 
#endif

 
#ifndef FL_ALIGN_PROGMEM
#if defined(FL_IS_ARM) || defined(ESP32) || defined(FASTLED_DOXYGEN)
#define FL_ALIGN_PROGMEM(N)  __attribute__ ((aligned (N)))
#else
#define FL_ALIGN_PROGMEM(N)
#endif
#endif
 
#endif  // platform progmem selection