mware/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 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Support for reading program memory on Harvard architectures.
  34  *
  35  * Support is currently provided for AVR microcontrollers only.
  36  *
  37  * These macros allow building code twice, with and without
  38  * pgm support (e.g.: strcpy() and strcpy_P()).
  39  *
  40  * Set the _PROGMEM predefine to compile in conditional
  41  * program-memory support.
  42  *
  43  *
  44  * \note This module contains code ripped out from avr-libc,
  45  *       which is distributed under a 3-clause BSD license.
  46  */
  47 #ifndef MWARE_PGM_H
  48 #define MWARE_PGM_H
  49
  50 #include <cfg/compiler.h> /* For intXX_t */
  51 #include <cpu/detect.h>
  52 #include <cpu/attr.h>     /* For CPU_HARVARD */
  53 #include <cpu/types.h>    /* For SIZEOF_INT */
  54
  55 #if CPU_AVR
  56
  57         #ifdef __AVR_ENHANCED__
  58                 #define pgm_read_char(addr) \
  59                 ({ \
  60                         uint16_t __addr16 = (uint16_t)(addr); \
  61                         uint8_t __result; \
  62                         __asm__ \
  63                         ( \
  64                                 "lpm %0, Z" "\n\t" \
  65                                 : "=r" (__result) \
  66                                 : "z" (__addr16) \
  67                         ); \
  68                         __result; \
  69                 })
  70                 #define pgm_read_uint16_t(addr) \
  71                 ({ \
  72                         uint16_t __addr16 = (uint16_t)(addr); \
  73                         uint16_t __result; \
  74                         __asm__ \
  75                         ( \
  76                                 "lpm %A0, Z+"   "\n\t" \
  77                                 "lpm %B0, Z"    "\n\t" \
  78                                 : "=r" (__result), "=z" (__addr16) \
  79                                 : "1" (__addr16) \
  80                         ); \
  81                         __result; \
  82                 })
  83
  84
  85         #else /* !__AVR_ENHANCED__ */
  86
  87                 #define pgm_read_char(addr) \
  88                 ({ \
  89                         uint16_t __addr16 = (uint16_t)(addr); \
  90                         uint8_t __result; \
  91                         __asm__ \
  92                         ( \
  93                                 "lpm" "\n\t" \
  94                                 "mov %0, r0" "\n\t" \
  95                                 : "=r" (__result) \
  96                                 : "z" (__addr16) \
  97                                 : "r0" \
  98                         ); \
  99                         __result; \
 100                 })
 101                 #define pgm_read_uint16_t(addr) \
 102                 ({ \
 103                         uint16_t __addr16 = (uint16_t)(addr); \
 104                         uint16_t __result; \
 105                         __asm__ \
 106                         ( \
 107                                 "lpm"           "\n\t" \
 108                                 "mov %A0, r0"   "\n\t" \
 109                                 "adiw r30, 1"   "\n\t" \
 110                                 "lpm"           "\n\t" \
 111                                 "mov %B0, r0"   "\n\t" \
 112                                 : "=r" (__result), "=z" (__addr16) \
 113                                 : "1" (__addr16) \
 114                                 : "r0" \
 115                         ); \
 116                         __result; \
 117                 })
 118
 119         #endif /* !__AVR_ENHANCED__ */
 120
 121         #if SIZEOF_INT == 2
 122                 #define pgm_read_int(addr) ((int)pgm_read_uint16_t(addr))
 123         #else
 124                 #error Missing support for CPU word size != 16bit
 125         #endif
 126
 127         #ifndef PROGMEM
 128         #define PROGMEM  __attribute__((__progmem__))
 129         #endif
 130         #ifndef PSTR
 131         #define PSTR(s) ({ static const char __c[] PROGMEM = (s); &__c[0]; })
 132         #endif
 133         #ifndef PFUNC
 134         #define PFUNC(x)      x ## _P
 135         #endif
 136
 137 #elif CPU_HARVARD
 138         #error Missing CPU support
 139 #endif
 140
 141 #ifndef PSTR
 142 #define PSTR            /* nothing */
 143 #endif
 144
 145 #ifndef PFUNC
 146 #define PFUNC(x) x
 147 #endif
 148
 149 #ifndef PROGMEM
 150 #define PROGMEM         /* nothing */
 151 #endif
 152
 153 /**
 154  * \name Types for variables stored in program memory (harvard processors).
 155  * \{
 156  */
 157 typedef PROGMEM char pgm_char;
 158 typedef PROGMEM int8_t pgm_int8_t;
 159 typedef PROGMEM uint8_t pgm_uint8_t;
 160 typedef PROGMEM int16_t pgm_int16_t;
 161 typedef PROGMEM uint16_t pgm_uint16_t;
 162 typedef PROGMEM int32_t pgm_int32_t;
 163 typedef PROGMEM uint32_t pgm_uint32_t;
 164 /*\}*/
 165
 166 /**
 167  * \name PGM support macros.
 168  *
 169  * These macros enable dual compilation of code for both program
 170  * and data memory.
 171  *
 172  * Such a function may be defined like this:
 173  *
 174  * \code
 175  *      void PGM_FUNC(lcd_puts)(PGM_ATTR const char *str)
 176  *      {
 177  *              char c;
 178  *              while ((c = PGM_READ_CHAR(str++))
 179  *                      lcd_putchar(c);
 180  *      }
 181  * \endcode
 182  *
 183  * The above code can be compiled twice: once with the _PROGMEM preprocessor
 184  * symbol defined, and once without.  The two object modules can then be
 185  * linked in the same application for use by client code:
 186  *
 187  * \code
 188  *      lcd_puts("Hello, world!");
 189  *      lcd_puts_P(PSTR("Hello, world!"));
 190  *
 191  *      // To be used when invoking inside other PGM_FUNC functions:
 192  *      PGM_FUNC(lcd_puts)(some_string);
 193  * \endcode
 194  *
 195  * \{
 196  */
 197 #ifdef _PROGMEM
 198         #define PGM_READ_CHAR(s) pgm_read_char(s)
 199         #define PGM_FUNC(x)      PFUNC(x)
 200         #define PGM_STR(x)       PSTR(x)
 201         #define PGM_ATTR         PROGMEM
 202 #else
 203         #define PGM_READ_CHAR(s) (*(s))
 204         #define PGM_FUNC(x)      x
 205         #define PGM_STR(x)       x
 206         #define PGM_ATTR         /* nothing */
 207 #endif
 208 /* \} */
 209
 210
 211 #endif /* MWARE_PGM_H */