git.sur5r.net Git - freertos/blob - Demo/Common/drivers/Atmel/at91lib/peripherals/eefc/eefc.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         ATMEL Microcontroller Software Support \r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2008, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 #ifndef EEFC_H\r
  31 #define EEFC_H\r
  32 \r
  33 //------------------------------------------------------------------------------\r
  34 //         Headers\r
  35 //------------------------------------------------------------------------------\r
  36 \r
  37 #include <board.h>\r
  38 \r
  39 #ifdef BOARD_FLASH_EEFC\r
  40 \r
  41 //------------------------------------------------------------------------------\r
  42 //         Constants\r
  43 //------------------------------------------------------------------------------\r
  44 \r
  45 /// Number of GPNVMs available on each chip.\r
  46 #if defined(at91sam7l64) || defined(at91sam7l128)\r
  47 \r
  48     #define EFC_NUM_GPNVMS          2\r
  49 \r
  50 #elif defined(at91sam9xe128) || defined(at91sam9xe256) || defined(at91sam9xe512)\r
  51 \r
  52     #define EFC_NUM_GPNVMS          17\r
  53 #endif\r
  54 \r
  55 //------------------------------------------------------------------------------\r
  56 //         Types\r
  57 //------------------------------------------------------------------------------\r
  58 \r
  59 // Needed when EEFC is integrated in MC.\r
  60 #if !defined(AT91C_BASE_EFC) && defined(AT91C_BASE_MC)\r
  61 typedef struct _AT91S_EFC {\r
  62         AT91_REG         EFC_FMR;       // EFC Flash Mode Register\r
  63         AT91_REG         EFC_FCR;       // EFC Flash Command Register\r
  64         AT91_REG         EFC_FSR;       // EFC Flash Status Register\r
  65         AT91_REG         EFC_FRR;       // EFC Flash Result Register\r
  66         AT91_REG         EFC_FVR;       // EFC Flash Version Register\r
  67 } AT91S_EFC, *AT91PS_EFC;\r
  68 \r
  69 #define AT91C_EFC_FRDY              AT91C_MC_FRDY\r
  70 #define AT91C_EFC_FWS               AT91C_MC_FWS\r
  71 #define AT91C_EFC_FWS_0WS           AT91C_MC_FWS_0WS\r
  72 #define AT91C_EFC_FWS_1WS           AT91C_MC_FWS_1WS\r
  73 #define AT91C_EFC_FWS_2WS           AT91C_MC_FWS_2WS\r
  74 #define AT91C_EFC_FWS_3WS           AT91C_MC_FWS_3WS\r
  75 #define AT91C_EFC_FCMD              AT91C_MC_FCMD\r
  76 #define AT91C_EFC_FCMD_GETD         AT91C_MC_FCMD_GETD\r
  77 #define AT91C_EFC_FCMD_WP           AT91C_MC_FCMD_WP  \r
  78 #define AT91C_EFC_FCMD_WPL          AT91C_MC_FCMD_WPL \r
  79 #define AT91C_EFC_FCMD_EWP          AT91C_MC_FCMD_EWP \r
  80 #define AT91C_EFC_FCMD_EWPL         AT91C_MC_FCMD_EWPL\r
  81 #define AT91C_EFC_FCMD_EA           AT91C_MC_FCMD_EA  \r
  82 #define AT91C_EFC_FCMD_EPL          AT91C_MC_FCMD_EPL \r
  83 #define AT91C_EFC_FCMD_EPA          AT91C_MC_FCMD_EPA \r
  84 #define AT91C_EFC_FCMD_SLB          AT91C_MC_FCMD_SLB \r
  85 #define AT91C_EFC_FCMD_CLB          AT91C_MC_FCMD_CLB \r
  86 #define AT91C_EFC_FCMD_GLB          AT91C_MC_FCMD_GLB \r
  87 #define AT91C_EFC_FCMD_SFB          AT91C_MC_FCMD_SFB \r
  88 #define AT91C_EFC_FCMD_CFB          AT91C_MC_FCMD_CFB \r
  89 #define AT91C_EFC_FCMD_GFB          AT91C_MC_FCMD_GFB \r
  90 #define AT91C_EFC_FARG              AT91C_MC_FARG     \r
  91 #define AT91C_EFC_FKEY              AT91C_MC_FKEY     \r
  92 #define AT91C_EFC_FRDY_S            AT91C_MC_FRDY_S   \r
  93 #define AT91C_EFC_FCMDE             AT91C_MC_FCMDE   \r
  94 #define AT91C_EFC_LOCKE             AT91C_MC_LOCKE    \r
  95 #define AT91C_EFC_FVALUE            AT91C_MC_FVALUE   \r
  96 \r
  97 #define AT91C_BASE_EFC              (AT91_CAST(AT91PS_EFC)      0xFFFFFF60)    \r
  98 \r
  99 #endif //#if !defined(AT91C_BASE_EFC) && defined(AT91C_BASE_MC)\r
 100 \r
 101 //------------------------------------------------------------------------------\r
 102 //         Functions\r
 103 //------------------------------------------------------------------------------\r
 104 \r
 105 extern void EFC_EnableFrdyIt(void);\r
 106 \r
 107 extern void EFC_DisableFrdyIt(void);\r
 108 \r
 109 extern void EFC_TranslateAddress(\r
 110     unsigned int address,\r
 111     unsigned short *pPage,\r
 112     unsigned short *pOffset);\r
 113 \r
 114 extern void EFC_ComputeAddress(\r
 115     unsigned short page,\r
 116     unsigned short offset,\r
 117     unsigned int *pAddress);\r
 118 \r
 119 extern void EFC_StartCommand(\r
 120     unsigned char command,\r
 121     unsigned short argument);\r
 122 \r
 123 extern unsigned char EFC_PerformCommand(\r
 124     unsigned char command,\r
 125     unsigned short argument);\r
 126 \r
 127 extern unsigned int EFC_GetStatus(void);\r
 128 \r
 129 extern unsigned int EFC_GetResult(void);\r
 130 \r
 131 #endif //#ifdef BOARD_FLASH_EEFC\r
 132 #endif //#ifndef EEFC_H\r
 133 \r