bertos/cpu/cortex-m3/io/sam3_flash.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 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Atmel SAM3 enhanced embedded flash controller definitions.
  34  */
  35
  36 #ifndef SAM3_FLASH_H
  37 #define SAM3_FLASH_H
  38
  39 /**
  40  * EEFC base register address.
  41  */
  42 #define EEFC_BASE  0x400E0A00
  43
  44 /**
  45  * EFC register offsets.
  46  */
  47 /*\{*/
  48 #define EEFC_FMR_OFF  0x0   ///< Flash Mode Register
  49 #define EEFC_FCR_OFF  0x4   ///< Flash Command Register
  50 #define EEFC_FSR_OFF  0x8   ///< Flash Status Register
  51 #define EEFC_FRR_OFF  0xC   ///< Flash Result Register
  52 /*\}*/
  53
  54 /**
  55  * EEFC registers.
  56  */
  57 /*\{*/
  58 #define EEFC_FMR  (*((reg32_t *)(EEFC_BASE + EEFC_FMR_OFF)))  ///< Flash Mode Register
  59 #define EEFC_FCR  (*((reg32_t *)(EEFC_BASE + EEFC_FCR_OFF)))  ///< Flash Command Register
  60 #define EEFC_FSR  (*((reg32_t *)(EEFC_BASE + EEFC_FSR_OFF)))  ///< Flash Status Register
  61 #define EEFC_FRR  (*((reg32_t *)(EEFC_BASE + EEFC_FRR_OFF)))  ///< Flash Result Register
  62 /*\}*/
  63
  64
  65
  66 /**
  67  * Defines for bit fields in EEFC_FMR register.
  68  */
  69 /*\{*/
  70 #define EEFC_FMR_FRDY        0                       ///< Ready Interrupt Enable
  71 #define EEFC_FMR_FWS_SHIFT   8
  72 #define EEFC_FMR_FWS_MASK    (0xf << EEFC_FMR_FWS_SHIFT) ///< Flash Wait State
  73 #define EEFC_FMR_FWS(value)  (EEFC_FMR_FWS_MASK & ((value) << EEFC_FMR_FWS_SHIFT))
  74 #define EEFC_FMR_FAM         24                      ///< Flash Access Mode
  75 /*\}*/
  76
  77 /**
  78  * Defines for bit fields in EEFC_FCR register.
  79  */
  80 /*\{*/
  81 #define EEFC_FCR_FCMD_MASK    0xff                        ///< Flash Command
  82 #define EEFC_FCR_FCMD(value)  (EEFC_FCR_FCMD_MASK & (value))
  83 #define EEFC_FCR_FARG_SHIFT   8
  84 #define EEFC_FCR_FARG_MASK    (0xffff << EEFC_FCR_FARG_SHIFT) ///< Flash Command Argument
  85 #define EEFC_FCR_FARG(value)  (EEFC_FCR_FARG_MASK & ((value) << EEFC_FCR_FARG_SHIFT))
  86 #define EEFC_FCR_FKEY_SHIFT   24
  87 #define EEFC_FCR_FKEY_MASK    (0xff << EEFC_FCR_FKEY_SHIFT)   ///< Flash Writing Protection Key
  88 #define EEFC_FCR_FKEY(value)  (EEFC_FCR_FKEY_MASK & ((value) << EEFC_FCR_FKEY_SHIFT))
  89 /*\}*/
  90
  91 /**
  92  * Defines for bit fields in EEFC_FSR register.
  93  */
  94 /*\{*/
  95 #define EEFC_FSR_FRDY       0  ///< Flash Ready Status
  96 #define EEFC_FSR_FCMDE      1  ///< Flash Command Error Status
  97 #define EEFC_FSR_FLOCKE     2  ///< Flash Lock Error Status
  98 /*\}*/
  99
 100 #endif /* SAM3_FLASH_H */