CC3200 Peripheral Driver Library User's Guide  1.2.0
flash.h
1 //*****************************************************************************
2 //
3 // flash.h
4 //
5 // Prototypes for the flash driver.
6 //
7 // Copyright (C) 2014 Texas Instruments Incorporated - https://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 //*****************************************************************************
39 
40 #ifndef __FLASH_H__
41 #define __FLASH_H__
42 
43 //*****************************************************************************
44 //
45 // If building with a C++ compiler, make all of the definitions in this header
46 // have a C binding.
47 //
48 //*****************************************************************************
49 #ifdef __cplusplus
50 extern "C"
51 {
52 #endif
53 
54 //*****************************************************************************
55 //
56 // Values that can be passed to FlashProtectSet(), and returned by
57 // FlashProtectGet().
58 //
59 //*****************************************************************************
60 typedef enum
61 {
62  FlashReadWrite, // Flash can be read and written
63  FlashReadOnly, // Flash can only be read
64  FlashExecuteOnly // Flash can only be executed
65 }
66 tFlashProtection;
67 
68 //*****************************************************************************
69 //
70 // Values passed to FlashIntEnable(), FlashIntDisable() and FlashIntClear() and
71 // returned from FlashIntStatus().
72 //
73 //*****************************************************************************
74 #define FLASH_INT_PROGRAM 0x00000002 // Programming Interrupt Mask
75 #define FLASH_INT_ACCESS 0x00000001 // Access Interrupt Mask
76 #define FLASH_INT_EEPROM 0x00000004 // EEPROM Interrupt Mask
77 #define FLASH_INT_VOLTAGE_ERR 0x00000200 // Voltage Error Interrupt Mask
78 #define FLASH_INT_DATA_ERR 0x00000400 // Invalid Data Interrupt Mask
79 #define FLASH_INT_ERASE_ERR 0x00000800 // Erase Error Interrupt Mask
80 #define FLASH_INT_PROGRAM_ERR 0x00002000 // Program Verify Error Interrupt Mask
81 
82 
83 //*****************************************************************************
84 //
85 // Prototypes for the APIs.
86 //
87 //*****************************************************************************
88 extern void FlashDisable(void);
89 extern long FlashErase(unsigned long ulAddress);
90 extern void FlashEraseNonBlocking(unsigned long ulAddress);
91 extern long FlashMassErase(void);
92 extern void FlashMassEraseNonBlocking(void);
93 extern long FlashProgram(unsigned long *pulData, unsigned long ulAddress,
94  unsigned long ulCount);
95 extern long FlashProgramNonBlocking(unsigned long *pulData,
96  unsigned long ulAddress,
97  unsigned long ulCount);
98 extern void FlashIntRegister(void (*pfnHandler)(void));
99 extern void FlashIntUnregister(void);
100 extern void FlashIntEnable(unsigned long ulIntFlags);
101 extern void FlashIntDisable(unsigned long ulIntFlags);
102 extern unsigned long FlashIntStatus(tBoolean bMasked);
103 extern void FlashIntClear(unsigned long ulIntFlags);
104 extern tFlashProtection FlashProtectGet(unsigned long ulAddress);
105 
106 //*****************************************************************************
107 //
108 // Mark the end of the C bindings section for C++ compilers.
109 //
110 //*****************************************************************************
111 #ifdef __cplusplus
112 }
113 #endif
114 
115 #endif // __FLASH_H__
long FlashProgram(unsigned long *pulData, unsigned long ulAddress, unsigned long ulCount)
Definition: flash.c:375
long FlashErase(unsigned long ulAddress)
Definition: flash.c:187
long FlashProgramNonBlocking(unsigned long *pulData, unsigned long ulAddress, unsigned long ulCount)
Definition: flash.c:520
void FlashIntUnregister(void)
Definition: flash.c:735
void FlashIntRegister(void(*pfnHandler)(void))
Definition: flash.c:707
void FlashIntEnable(unsigned long ulIntFlags)
Definition: flash.c:763
void FlashDisable(void)
Definition: flash.c:129
void FlashEraseNonBlocking(unsigned long ulAddress)
Definition: flash.c:251
void FlashIntClear(unsigned long ulIntFlags)
Definition: flash.c:850
tFlashProtection FlashProtectGet(unsigned long ulAddress)
Definition: flash.c:623
void FlashIntDisable(unsigned long ulIntFlags)
Definition: flash.c:786
void FlashMassEraseNonBlocking(void)
Definition: flash.c:333
unsigned long FlashIntStatus(tBoolean bMasked)
Definition: flash.c:810
long FlashMassErase(void)
Definition: flash.c:283