flashctl.h

Go to the documentation of this file.

//*****************************************************************************
//
// flashctl.h - Driver for the FLASHCTL Module.
//
//*****************************************************************************
 
#ifndef __MSP430WARE_FLASHCTL_H__
#define __MSP430WARE_FLASHCTL_H__
 
#include "inc/hw_memmap.h"
 
#ifdef __MSP430_HAS_FLASH__
 
//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif
 
//*****************************************************************************
//
// The following are values that can be passed to the mask parameter for
// functions: FlashCtl_getStatus() as well as returned by the
// FlashCtl_getStatus() function.
//
//*****************************************************************************
#define FLASHCTL_READY_FOR_NEXT_WRITE                                      WAIT
#define FLASHCTL_ACCESS_VIOLATION_INTERRUPT_FLAG                        ACCVIFG
#define FLASHCTL_PASSWORD_WRITTEN_INCORRECTLY                              KEYV
#define FLASHCTL_BUSY                                                      BUSY
 
//*****************************************************************************
//
// Prototypes for the APIs.
//
//*****************************************************************************
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void FlashCtl_eraseSegment(uint8_t *flash_ptr);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void FlashCtl_eraseBank(uint8_t *flash_ptr);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void FlashCtl_performMassErase(uint8_t *flash_ptr);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern bool FlashCtl_performEraseCheck(uint8_t *flash_ptr,
                                       uint16_t numberOfBytes);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void FlashCtl_write8(uint8_t *data_ptr,
                            uint8_t *flash_ptr,
                            uint16_t count);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void FlashCtl_write16(uint16_t *data_ptr,
                             uint16_t *flash_ptr,
                             uint16_t count);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void FlashCtl_write32(uint32_t *data_ptr,
                             uint32_t *flash_ptr,
                             uint16_t count);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void FlashCtl_fillMemory32(uint32_t value,
                                  uint32_t *flash_ptr,
                                  uint16_t count);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint8_t FlashCtl_getStatus(uint8_t mask);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void FlashCtl_lockInfoA(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void FlashCtl_unlockInfoA(void);
 
//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif
 
#endif
#endif // __MSP430WARE_FLASHCTL_H__