Flash.h

Go to the documentation of this file.

/*
MIT License
 
Copyright (c) 2018 Brian T. Park
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#ifndef AUNIT_FLASH_H
#define AUNIT_FLASH_H
 
class __FlashStringHelper;
 
#define AUNIT_FPSTR(pstr) reinterpret_cast<const __FlashStringHelper *>(pstr)
 
#if defined(ARDUINO_ARCH_AVR)
 
  #include <avr/pgmspace.h>
  #define AUNIT_F(x) F(x)
 
// Seeeduino SAMD21 Core is buggy, so we have to hack around it. Unfortunately,
// the Seeeduino core does not define an identifier for the following boards, so
// they are not supported:
//  * Wio lite MG126
//  * Wio GPS Board
//  * Wio LTE CAT.1
#elif defined(SEEED_XIAO_M0) \
  || defined(SEEEDUINO_ZERO) \
  || defined(SEEED_FEMTO_M0) \
  || defined(SEEEDUINO_LORAWAN) \
  || defined(SEEED_WIO_TERMINAL) \
  || defined(SEEED_GROVE_UI_WIRELESS)
 
  #include <avr/pgmspace.h>
 
  // Seeeduino (as of 1.8.4) provides an incorrect definition of FPSTR()
  // so we have to clobber it.
  #undef FPSTR
  #define FPSTR(p) (reinterpret_cast<const __FlashStringHelper *>(p))
  #define AUNIT_F(x) F(x)
 
// The following should work for Adafruit SAMD core, and other third party SAMD
// (SparkFun?) cores which are less buggy. The Arduino SAMD Core breaks
// backwards compatibility for versions >= 1.8.10. It is blacklisted by the time
// we get here.
#elif defined(ARDUINO_ARCH_SAMD)
 
  #include <avr/pgmspace.h>
  #define AUNIT_F(x) F(x)
 
#elif defined(ESP8266)
 
  #include <pgmspace.h>
  #define AUNIT_F(x) F(x)
 
#elif defined(ESP32)
 
  #include <pgmspace.h>
  #define AUNIT_F(x) F(x)
 
  // ESP32 cores don't seem to define SERIAL_PORT_MONITOR
  #if ! defined(SERIAL_PORT_MONITOR)
    #define SERIAL_PORT_MONITOR Serial
  #endif
 
#elif defined(ARDUINO_ARCH_STM32)
 
  #include <avr/pgmspace.h>
  #define AUNIT_F(x) F(x)
 
#elif defined(EPOXY_DUINO)
 
  #include <pgmspace.h>
  #define AUNIT_F(x) F(x)
 
#elif defined(TEENSYDUINO)
 
  #include <pgmspace.h>
  #define AUNIT_F(x) F(x)
 
#else
 
  #warning Untested platform, AUnit may still work...
 
  #include <avr/pgmspace.h>
  #define AUNIT_F(x) F(x)
 
  #if ! defined(SERIAL_PORT_MONITOR)
    #define SERIAL_PORT_MONITOR Serial
  #endif
 
#endif
 
#endif // AUNIT_FLASH_H