MSP430 Peripheral Driver Library: fram.h Source File

Go to the documentation of this file.
00001 #ifndef __MSP430WARE_FRAM_H__
00002 #define __MSP430WARE_FRAM_H__
00003 
00004 
00005 //*****************************************************************************
00006 //
00007 //The following are the defines to include the required modules for this
00008 //peripheral in msp430xgeneric.h file
00009 //
00010 //*****************************************************************************
00011 #define __MSP430_HAS_FRAM_FR5XX__
00012 
00013 
00014 //*****************************************************************************
00015 //
00016 //The following are values that can be passed to the FRAM_enableInterrupt,
00017 //FRAM_disableInterrupt, API as the mask parameter.
00018 //
00019 //*****************************************************************************
00020 
00021 #define FRAM_PUC_ON_UNCORRECTABLE_BIT           UBDRSTEN
00022 #define FRAM_UNCORRECTABLE_BIT_INTERUPT         UBDIEN
00023 #define FRAM_CORRECTABLE_BIT_INTERRUPT          CBDIEN
00024 #define FRAM_ACCESS_VIOLATION_INTERRUPT         ACCVIE
00025 #define FRAM_ACCESS_TIME_ERROR_INTERUPT         ACCTEIE
00026 #define FRAM_PUC_ON_DOUBLE_BIT_ERROR            SBDRSTEN
00027 #define FRAM_DOUBLE_BIT_ERROR_INTERUPT          DBDIEN
00028 #define FRAM_SINGLE_BIT_ERROR_INTERUPT          SBDIEN
00029 
00030 
00031 //*****************************************************************************
00032 //
00033 //The following are values that can be passed to the FRAM_getInterruptStatus
00034 //API as the mask parameter.
00035 //
00036 //*****************************************************************************
00037 
00038 #define FRAM_ACCESS_TIME_ERROR_FLAG                     ACCTEIFG
00039 #define FRAM_UNCORRECTABLE_BIT_FLAG                     UBDIFG
00040 #define FRAM_CORRECTABLE_BIT_FLAG                       CBDIFG
00041 #define FRAM_ACCESS_VIOLATION_FLAG                      ACCVIFG
00042 #define FRAM_SINGLE_BIT_ERROR_FLAG                      SBDIFG
00043 #define FRAM_DOUBLE_BIT_ERROR_FLAG                      DBDIFG
00044 
00045 //*****************************************************************************
00046 //
00047 //The following are values that are returned by FRAM_isBusy().
00048 //
00049 //*****************************************************************************
00050 #define FRAM_NOTBUSY (0x0)
00051 #define FRAM_BUSY    (0x1)
00052 
00053 //*****************************************************************************
00054 //
00055 //Prototypes for the APIs.
00056 //
00057 //*****************************************************************************
00058 
00059 extern void FRAM_write8(unsigned int baseAddress,
00060                 unsigned char *dataPtr,
00061                 unsigned char *framPtr,
00062                 unsigned int numberOfBytes);
00063 
00064 extern void FRAM_write16(unsigned int baseAddress,
00065                  unsigned int *dataPtr,
00066                  unsigned int *framPtr,
00067                  unsigned int numberOfBytes);
00068 
00069 extern void FRAM_write32(unsigned int baseAddress,
00070                 unsigned long *dataPtr,
00071                 unsigned long *framPtr,
00072                 unsigned int numberOfBytes);
00073 
00074 extern void FRAM_memoryFill32(unsigned int baseAddress,
00075                  unsigned long value,
00076                  unsigned long *framPtr,
00077                  unsigned int count);
00078 
00079 extern void FRAM_enableInterrupt (unsigned int baseAddress,
00080                 unsigned char interruptMask);
00081 
00082 extern unsigned char FRAM_getInterruptStatus(unsigned int baseAddress,
00083                 unsigned int interruptFlagMask);
00084 
00085 extern void FRAM_disableInterrupt(unsigned int baseAddress,
00086                 unsigned int interruptMask);
00087 
00088 extern unsigned short FRAM_isBusy(unsigned int baseAddress);
00089 
00090 #endif