Change filename and macros from AT91SAM3.. to SAM3.. to conform to Atmel's official...

[bertos.git] / bertos / cpu / cortex-m3 / io / sam3_nvic.h

diff --git a/bertos/cpu/cortex-m3/io/sam3_nvic.h b/bertos/cpu/cortex-m3/io/sam3_nvic.h
index 0ac366c2e7f2aaad23abe45666b7612376ab3a1b..7b8d6eab44263d0d2d3448d9c02dedea7c3ad45a 100644 (file)
--- a/bertos/cpu/cortex-m3/io/sam3_nvic.h
+++ b/bertos/cpu/cortex-m3/io/sam3_nvic.h
@@ -30,7 +30,14 @@
  *
  * -->
  *
- * \brief AT91SAM3 NVIC hardware.
+ * \brief Atmel SAM3 NVIC hardware.
+ *
+ * This file does not follow the BeRTOS AT91 register naming convention,
+ * because the NVIC subsystem is in common with other Cortex-M3 ports.
+ * Take care when using bit definition macros, they don't define bit numbers
+ * but values, i.e. you must not use BV().  Moreover register names have
+ * the _R suffix and offsets don't have the _OFF one.
+ * Someday we will fix this incoherence...
  */
 
 #ifndef SAM3_NVIC_H