bertos/cpu/pgm.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2005, 2006, 2007, 2008 Develer S.r.l. (http://www.develer.com/)
  30  * -->
  31  *
  32  * \brief Support for reading program memory on Harvard architectures.
  33  *
  34  * Support is currently provided for AVR microcontrollers only.
  35  *
  36  * These macros allow building code twice, with and without
  37  * pgm support (e.g.: strcpy() and strcpy_P()).
  38  *
  39  * Set the _PROGMEM predefine to compile in conditional
  40  * program-memory support.
  41  *
  42  *
  43  * \note This module contains code ripped out from avr-libc,
  44  *       which is distributed under a 3-clause BSD license.
  45  *
  46  * \author Bernie Innocenti <bernie@codewiz.org>
  47  */
  48 #ifndef MWARE_PGM_H
  49 #define MWARE_PGM_H
  50
  51 #include <cfg/compiler.h> /* For intXX_t */
  52 #include <cpu/detect.h>
  53 #include <cpu/attr.h>     /* For CPU_HARVARD */
  54 #include <cpu/types.h>    /* For SIZEOF_INT */
  55
  56 #if CPU_AVR
  57
  58         #ifdef __AVR_ENHANCED__
  59                 #define pgm_read_char(addr) \
  60                 ({ \
  61                         uint16_t __addr16 = (uint16_t)(addr); \
  62                         uint8_t __result; \
  63                         __asm__ \
  64                         ( \
  65                                 "lpm %0, Z" "\n\t" \
  66                                 : "=r" (__result) \
  67                                 : "z" (__addr16) \
  68                         ); \
  69                         __result; \
  70                 })
  71                 #define pgm_read_uint16_t(addr) \
  72                 ({ \
  73                         uint16_t __addr16 = (uint16_t)(addr); \
  74                         uint16_t __result; \
  75                         __asm__ \
  76                         ( \
  77                                 "lpm %A0, Z+"   "\n\t" \
  78                                 "lpm %B0, Z"    "\n\t" \
  79                                 : "=r" (__result), "=z" (__addr16) \
  80                                 : "1" (__addr16) \
  81                         ); \
  82                         __result; \
  83                 })
  84
  85
  86         #else /* !__AVR_ENHANCED__ */
  87
  88                 #define pgm_read_char(addr) \
  89                 ({ \
  90                         uint16_t __addr16 = (uint16_t)(addr); \
  91                         uint8_t __result; \
  92                         __asm__ \
  93                         ( \
  94                                 "lpm" "\n\t" \
  95                                 "mov %0, r0" "\n\t" \
  96                                 : "=r" (__result) \
  97                                 : "z" (__addr16) \
  98                                 : "r0" \
  99                         ); \
 100                         __result; \
 101                 })
 102                 #define pgm_read_uint16_t(addr) \
 103                 ({ \
 104                         uint16_t __addr16 = (uint16_t)(addr); \
 105                         uint16_t __result; \
 106                         __asm__ \
 107                         ( \
 108                                 "lpm"           "\n\t" \
 109                                 "mov %A0, r0"   "\n\t" \
 110                                 "adiw r30, 1"   "\n\t" \
 111                                 "lpm"           "\n\t" \
 112                                 "mov %B0, r0"   "\n\t" \
 113                                 : "=r" (__result), "=z" (__addr16) \
 114                                 : "1" (__addr16) \
 115                                 : "r0" \
 116                         ); \
 117                         __result; \
 118                 })
 119
 120         #endif /* !__AVR_ENHANCED__ */
 121
 122         #if SIZEOF_INT == 2
 123                 #define pgm_read_int(addr) ((int)pgm_read_uint16_t(addr))
 124         #else
 125                 #error Missing support for CPU word size != 16bit
 126         #endif
 127
 128         #ifndef PROGMEM
 129         #define PROGMEM  __attribute__((__progmem__))
 130         #endif
 131         #ifndef PSTR
 132         #define PSTR(s) ({ static const char __c[] PROGMEM = (s); &__c[0]; })
 133         #endif
 134         #ifndef PFUNC
 135         #define PFUNC(x)      x ## _P
 136         #endif
 137
 138 #elif CPU_HARVARD
 139         #error Missing CPU support
 140 #endif
 141
 142 #ifndef PSTR
 143 #define PSTR            /* nothing */
 144 #endif
 145
 146 #ifndef PFUNC
 147 #define PFUNC(x) x
 148 #endif
 149
 150 #ifndef PROGMEM
 151 #define PROGMEM         /* nothing */
 152 #endif
 153
 154 /**
 155  * \name Types for variables stored in program memory (harvard processors).
 156  * \{
 157  */
 158 typedef PROGMEM char pgm_char;
 159 typedef PROGMEM int8_t pgm_int8_t;
 160 typedef PROGMEM uint8_t pgm_uint8_t;
 161 typedef PROGMEM int16_t pgm_int16_t;
 162 typedef PROGMEM uint16_t pgm_uint16_t;
 163 typedef PROGMEM int32_t pgm_int32_t;
 164 typedef PROGMEM uint32_t pgm_uint32_t;
 165 /*\}*/
 166
 167 /**
 168  * \name PGM support macros.
 169  *
 170  * These macros enable dual compilation of code for both program
 171  * and data memory.
 172  *
 173  * Such a function may be defined like this:
 174  *
 175  * \code
 176  *      void PGM_FUNC(lcd_puts)(PGM_ATTR const char *str)
 177  *      {
 178  *              char c;
 179  *              while ((c = PGM_READ_CHAR(str++))
 180  *                      lcd_putchar(c);
 181  *      }
 182  * \endcode
 183  *
 184  * The above code can be compiled twice: once with the _PROGMEM preprocessor
 185  * symbol defined, and once without.  The two object modules can then be
 186  * linked in the same application for use by client code:
 187  *
 188  * \code
 189  *      lcd_puts("Hello, world!");
 190  *      lcd_puts_P(PSTR("Hello, world!"));
 191  *
 192  *      // To be used when invoking inside other PGM_FUNC functions:
 193  *      PGM_FUNC(lcd_puts)(some_string);
 194  * \endcode
 195  *
 196  * \{
 197  */
 198 #ifdef _PROGMEM
 199         #define PGM_READ_CHAR(s) pgm_read_char(s)
 200         #define PGM_FUNC(x)      PFUNC(x)
 201         #define PGM_STR(x)       PSTR(x)
 202         #define PGM_ATTR         PROGMEM
 203 #else
 204         #define PGM_READ_CHAR(s) (*(s))
 205         #define PGM_FUNC(x)      x
 206         #define PGM_STR(x)       x
 207         #define PGM_ATTR         /* nothing */
 208 #endif
 209 /* \} */
 210
 211
 212 #endif /* MWARE_PGM_H */