git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_SAMV71_Xplained_IAR_Keil/libchip_samv7/include/flashd.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         SAM Software Package License\r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2012, 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 /**\r
  31  * \file\r
  32  *\r
  33  * The flash driver provides the unified interface for flash program operations.\r
  34  *\r
  35  */\r
  36 \r
  37 #ifndef _FLASHD_\r
  38 #define _FLASHD_\r
  39 \r
  40 #include <stdint.h>\r
  41 \r
  42 #ifdef __cplusplus\r
  43  extern "C" {\r
  44 #endif\r
  45    \r
  46 #define GPNVBit_SecurityBit     0\r
  47 #define GPNVBit_BootMode        1\r
  48 #define GPNVBit_TCMBit1         6\r
  49 #define GPNVBit_TCMBit2         7\r
  50 \r
  51 /*----------------------------------------------------------------------------\r
  52  *        Exported functions\r
  53  *----------------------------------------------------------------------------*/\r
  54 \r
  55 extern void FLASHD_Initialize( uint32_t dwMCk, uint32_t dwUseIAP ) ;\r
  56 \r
  57 extern uint32_t FLASHD_Erase( uint32_t dwAddress ) ;\r
  58 \r
  59 extern uint32_t FLASHD_EraseSector( uint32_t dwAddress ) ;\r
  60 \r
  61 extern uint32_t FLASHD_ErasePages( uint32_t dwAddress, uint32_t dwPageNum ) ;\r
  62 \r
  63 extern uint32_t FLASHD_Write( uint32_t dwAddress, const void *pvBuffer, \r
  64                 uint32_t dwSize ) ;\r
  65 \r
  66 extern uint32_t FLASHD_Lock( uint32_t dwStart, uint32_t dwEnd, \r
  67                 uint32_t *pdwActualStart, uint32_t *pdwActualEnd ) ;\r
  68 \r
  69 extern uint32_t FLASHD_Unlock( uint32_t dwStart, uint32_t dwEnd, \r
  70                 uint32_t *pdwActualStart, uint32_t *pdwActualEnd ) ;\r
  71 \r
  72 extern uint32_t FLASHD_IsLocked( uint32_t dwStart, uint32_t dwEnd ) ;\r
  73 \r
  74 extern uint32_t FLASHD_SetGPNVM( uint8_t gpnvm ) ;\r
  75 \r
  76 extern uint32_t FLASHD_ClearGPNVM( uint8_t gpnvm ) ;\r
  77 \r
  78 extern uint32_t FLASHD_IsGPNVMSet( uint8_t gpnvm ) ;\r
  79 \r
  80 #define FLASHD_IsSecurityBitSet() FLASHD_IsGPNVMSet( 0 )\r
  81 \r
  82 #define FLASHD_SetSecurityBit()   FLASHD_SetGPNVM( 0 )\r
  83 \r
  84 extern uint32_t FLASHD_ReadUniqueID( uint32_t* pdwUniqueID ) ;\r
  85 \r
  86 #ifdef __cplusplus\r
  87 }\r
  88 #endif\r
  89 \r
  90 #endif /* #ifndef _FLASHD_ */\r
  91 \r