metawatch/F5xx_F6xx_Core_Lib/HAL_FLASH.h

   1 /*******************************************************************************
   2  *
   3  * HAL_FLASH.h
   4  * Flash Library for flash memory controller of MSP430F5xx/6xx family
   5  *
   6  *
   7  * Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com/
   8  *
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *
  14  *    Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  *
  17  *    Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the
  20  *    distribution.
  21  *
  22  *    Neither the name of Texas Instruments Incorporated nor the names of
  23  *    its contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  27  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  28  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  29  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  30  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  32  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  33  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  34  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  35  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  36  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37  *
  38  * Created: Version 1.0 11/24/2009
  39  * Updated: Version 2.0 01/18/2011
  40  *
  41  ******************************************************************************/
  42
  43 #ifndef HAL_FLASH_H
  44 #define HAL_FLASH_H
  45
  46 //******************************************************************************
  47 // Defines
  48 //******************************************************************************
  49
  50 #define FLASH_STATUS_OK     0
  51 #define FLASH_STATUS_ERROR  1
  52
  53 /*******************************************************************************
  54  * \brief   Erase a single segment of the flash memory
  55  *
  56  * \param *Flash_ptr    Pointer into the flash segment to erase
  57  ******************************************************************************/
  58 extern void Flash_SegmentErase(unsigned int *Flash_ptr);
  59
  60 /*******************************************************************************
  61  * \brief   Erase Check of the flash memory
  62  *
  63  * \param *Flash_ptr    Pointer into the flash segment to erase
  64  * \param len           give the len in word
  65  ******************************************************************************/
  66 extern unsigned char Flash_EraseCheck(unsigned int *Flash_ptr, unsigned int len);
  67
  68 /*******************************************************************************
  69  * \brief   Write data into the flash memory (Byte format)
  70  *
  71  * \param *Data_ptr     Pointer to the Data to write
  72  * \param *Flash_ptr    Pointer into the flash to write data to
  73  * \param count         number of data to write
  74  ******************************************************************************/
  75 extern void FlashWrite_8(unsigned char *Data_ptr, unsigned char *Flash_ptr, unsigned int count);
  76
  77 /*******************************************************************************
  78  * \brief   Write data into the flash memory (Word format)
  79  *
  80  * \param *Data_ptr     Pointer to the Data to write
  81  * \param *Flash_ptr    Pointer into the flash to write data to
  82  * \param count         number of data to write
  83  ******************************************************************************/
  84 extern void FlashWrite_16(unsigned int *Data_ptr, unsigned int *Flash_ptr, unsigned int count);
  85
  86 /*******************************************************************************
  87  * \brief   Write data into the flash memory (Long format)
  88  *
  89  * \param *Data_ptr     Pointer to the Data to write
  90  * \param *Flash_ptr    Pointer into the flash to write data to
  91  * \param count         number of data to write
  92  ******************************************************************************/
  93 extern void FlashWrite_32(unsigned long *Data_ptr, unsigned long *Flash_ptr, unsigned int count);
  94
  95 /*******************************************************************************
  96  * \brief   Fill data into the flash memory (Long format)
  97  *
  98  * \param value         Pointer to the Data to write
  99  * \param *Flash_ptr    pointer into the flash to write data to
 100  * \param count         number of data to write (= byte * 4)
 101  ******************************************************************************/
 102 extern void FlashMemoryFill_32(unsigned long value, unsigned long *Flash_ptr, unsigned int count);
 103
 104 #endif /* HAL_FLASH_H */