1 /*
2  *  Copyright (C) 2016 Texas Instruments Incorporated - http://www.ti.com/
3  *
4  *  Redistribution and use in source and binary forms, with or without
5  *  modification, are permitted provided that the following conditions
6  *  are met:
7  *
8  *    Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  *    Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the
14  *    distribution.
15  *
16  *    Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
33 //*****************************************************************************
34 //
35 //  flash.h
36 //
37 //  Prototypes for the flash driver.
38 //
39 //*****************************************************************************
40 
41 #ifndef __FLASH_H__
42 #define __FLASH_H__
43 
44 //*****************************************************************************
45 //
46 // If building with a C++ compiler, make all of the definitions in this header
47 // have a C binding.
48 //
49 //*****************************************************************************
50 #ifdef __cplusplus
51 extern "C"
52 {
53 #endif
54 
55 //*****************************************************************************
56 //
57 // Values that can be passed to FlashProtectSet(), and returned by
58 // FlashProtectGet().
59 //
60 //*****************************************************************************
61 typedef enum
62 {
63     FlashReadWrite,                         // Flash can be read and written
64     FlashReadOnly,                          // Flash can only be read
65     FlashExecuteOnly                        // Flash can only be executed
66 }
67 tFlashProtection;
68 
69 //*****************************************************************************
70 //
71 // Values passed to FlashIntEnable(), FlashIntDisable() and FlashIntClear() and
72 // returned from FlashIntStatus().
73 //
74 //*****************************************************************************
75 #define FLASH_INT_PROGRAM     0x00000002 // Programming Interrupt Mask
76 #define FLASH_INT_ACCESS      0x00000001 // Access Interrupt Mask
77 #define FLASH_INT_EEPROM      0x00000004 // EEPROM Interrupt Mask
78 #define FLASH_INT_VOLTAGE_ERR 0x00000200 // Voltage Error Interrupt Mask
79 #define FLASH_INT_DATA_ERR    0x00000400 // Invalid Data Interrupt Mask
80 #define FLASH_INT_ERASE_ERR   0x00000800 // Erase Error Interrupt Mask
81 #define FLASH_INT_PROGRAM_ERR 0x00002000 // Program Verify Error Interrupt Mask
82 
83 
84 //*****************************************************************************
85 //
86 // Prototypes for the APIs.
87 //
88 //*****************************************************************************
89 extern void FlashDisable(void);
90 extern long FlashErase(unsigned long ulAddress);
91 extern void FlashEraseNonBlocking(unsigned long ulAddress);
92 extern long FlashMassErase(void);
93 extern void FlashMassEraseNonBlocking(void);
94 extern long FlashProgram(unsigned long *pulData, unsigned long ulAddress,
95                          unsigned long ulCount);
96 extern long FlashProgramNonBlocking(unsigned long *pulData,
97                                     unsigned long ulAddress,
98                                     unsigned long ulCount);
99 extern void FlashIntRegister(void (*pfnHandler)(void));
100 extern void FlashIntUnregister(void);
101 extern void FlashIntEnable(unsigned long ulIntFlags);
102 extern void FlashIntDisable(unsigned long ulIntFlags);
103 extern unsigned long FlashIntStatus(tBoolean bMasked);
104 extern void FlashIntClear(unsigned long ulIntFlags);
105 extern tFlashProtection FlashProtectGet(unsigned long ulAddress);
106 
107 //*****************************************************************************
108 //
109 // Mark the end of the C bindings section for C++ compilers.
110 //
111 //*****************************************************************************
112 #ifdef __cplusplus
113 }
114 #endif
115 
116 #endif // __FLASH_H__
117