Doc fixes.

[bertos.git] / mware / pgm.h

diff --git a/mware/pgm.h b/mware/pgm.h
old mode 100755 (executable)
new mode 100644 (file)
index dcce64d..eebe87f
--- a/mware/pgm.h
+++ b/mware/pgm.h
@@ -1,9 +1,33 @@
-/*!
+/**
  * \file
  * <!--
- * Copyright 2004, 2005 Develer S.r.l. (http://www.develer.com/)
- * Copyright 2004 Giovanni Bajo
- * This file is part of DevLib - See README.devlib for information.
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2005 ,2006, 2007 Develer S.r.l. (http://www.develer.com/)
+ *
  * -->
  *
  * \brief Support for reading program memory on Harvard architectures.
@@ -23,7 +47,10 @@
 #ifndef MWARE_PGM_H
 #define MWARE_PGM_H
 
-#include <cpu_detect.h>
+#include <cfg/compiler.h> /* For intXX_t */
+#include <cpu/detect.h>
+#include <cpu/attr.h>     /* For CPU_HARVARD */
+#include <cpu/types.h>    /* For SIZEOF_INT */
 
 #if CPU_AVR
 
@@ -40,7 +67,23 @@
                        ); \
                        __result; \
                })
-       #else
+               #define pgm_read_uint16_t(addr) \
+               ({ \
+                       uint16_t __addr16 = (uint16_t)(addr); \
+                       uint16_t __result; \
+                       __asm__ \
+                       ( \
+                               "lpm %A0, Z+"   "\n\t" \
+                               "lpm %B0, Z"    "\n\t" \
+                               : "=r" (__result), "=z" (__addr16) \
+                               : "1" (__addr16) \
+                       ); \
+                       __result; \
+               })
+
+
+       #else /* !__AVR_ENHANCED__ */
+
                #define pgm_read_char(addr) \
                ({ \
                        uint16_t __addr16 = (uint16_t)(addr); \
@@ -55,10 +98,41 @@
                        ); \
                        __result; \
                })
+               #define pgm_read_uint16_t(addr) \
+               ({ \
+                       uint16_t __addr16 = (uint16_t)(addr); \
+                       uint16_t __result; \
+                       __asm__ \
+                       ( \
+                               "lpm"           "\n\t" \
+                               "mov %A0, r0"   "\n\t" \
+                               "adiw r30, 1"   "\n\t" \
+                               "lpm"           "\n\t" \
+                               "mov %B0, r0"   "\n\t" \
+                               : "=r" (__result), "=z" (__addr16) \
+                               : "1" (__addr16) \
+                               : "r0" \
+                       ); \
+                       __result; \
+               })
+
+       #endif /* !__AVR_ENHANCED__ */
+
+       #if SIZEOF_INT == 2
+               #define pgm_read_int(addr) ((int)pgm_read_uint16_t(addr))
+       #else
+               #error Missing support for CPU word size != 16bit
        #endif
 
+       #ifndef PROGMEM
        #define PROGMEM  __attribute__((__progmem__))
-       #define PSTR(s) ({static const char __c[] PROGMEM = (s); __c;})
+       #endif
+       #ifndef PSTR
+       #define PSTR(s) ({ static const char __c[] PROGMEM = (s); &__c[0]; })
+       #endif
+       #ifndef PFUNC
+       #define PFUNC(x)      x ## _P
+       #endif
 
 #elif CPU_HARVARD
        #error Missing CPU support
@@ -68,11 +142,15 @@
 #define PSTR            /* nothing */
 #endif
 
+#ifndef PFUNC
+#define PFUNC(x) x
+#endif
+
 #ifndef PROGMEM
-#define PROGMEM                /* nothing */
+#define PROGMEM         /* nothing */
 #endif
 
-/*!
+/**
  * \name Types for variables stored in program memory (harvard processors).
  * \{
  */
@@ -85,10 +163,8 @@ typedef PROGMEM int32_t pgm_int32_t;
 typedef PROGMEM uint32_t pgm_uint32_t;
 /*\}*/
 
-/*!
- * \def PGM_READ_CHAR
- * \def PGM_FUNC
- * \def PGM_ATTR
+/**
+ * \name PGM support macros.
  *
  * These macros enable dual compilation of code for both program
  * and data memory.
@@ -115,16 +191,21 @@ typedef PROGMEM uint32_t pgm_uint32_t;
  *     // To be used when invoking inside other PGM_FUNC functions:
  *     PGM_FUNC(lcd_puts)(some_string);
  * \endcode
+ *
+ * \{
  */
 #ifdef _PROGMEM
        #define PGM_READ_CHAR(s) pgm_read_char(s)
-       #define PGM_FUNC(x)      x ## _P
+       #define PGM_FUNC(x)      PFUNC(x)
+       #define PGM_STR(x)       PSTR(x)
        #define PGM_ATTR         PROGMEM
 #else
        #define PGM_READ_CHAR(s) (*(s))
        #define PGM_FUNC(x)      x
+       #define PGM_STR(x)       x
        #define PGM_ATTR         /* nothing */
 #endif
+/* \} */
 
 
 #endif /* MWARE_PGM_H */