1 //*****************************************************************************
2 //
3 // flash.h - Prototypes for the flash driver.
4 //
5 // Copyright (c) 2005-2012 Texas Instruments Incorporated.  All rights reserved.
6 // Software License Agreement
7 //
8 //   Redistribution and use in source and binary forms, with or without
9 //   modification, are permitted provided that the following conditions
10 //   are met:
11 //
12 //   Redistributions of source code must retain the above copyright
13 //   notice, this list of conditions and the following disclaimer.
14 //
15 //   Redistributions in binary form must reproduce the above copyright
16 //   notice, this list of conditions and the following disclaimer in the
17 //   documentation and/or other materials provided with the
18 //   distribution.
19 //
20 //   Neither the name of Texas Instruments Incorporated nor the names of
21 //   its contributors may be used to endorse or promote products derived
22 //   from this software without specific prior written permission.
23 //
24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 //
36 // This is part of revision 9453 of the Stellaris Peripheral Driver Library.
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 // Prototypes for the APIs.
85 //
86 //*****************************************************************************
87 extern unsigned long FlashUsecGet(void);
88 extern void FlashUsecSet(unsigned long ulClocks);
89 extern long FlashErase(unsigned long ulAddress);
90 extern long FlashProgram(unsigned long *pulData, unsigned long ulAddress,
91                          unsigned long ulCount);
92 extern tFlashProtection FlashProtectGet(unsigned long ulAddress);
93 extern long FlashProtectSet(unsigned long ulAddress,
94                             tFlashProtection eProtect);
95 extern long FlashProtectSave(void);
96 extern long FlashUserGet(unsigned long *pulUser0, unsigned long *pulUser1);
97 extern long FlashUserSet(unsigned long ulUser0, unsigned long ulUser1);
98 extern long FlashUserSave(void);
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 
106 //*****************************************************************************
107 //
108 // Deprecated function names.  These definitions ensure backwards compatibility
109 // but new code should avoid using deprecated function names since these will
110 // be removed at some point in the future.
111 //
112 //*****************************************************************************
113 #ifndef DEPRECATED
114 #define FlashIntGetStatus       FlashIntStatus
115 #endif
116 
117 //*****************************************************************************
118 //
119 // Mark the end of the C bindings section for C++ compilers.
120 //
121 //*****************************************************************************
122 #ifdef __cplusplus
123 }
124 #endif
125 
126 #endif // __FLASH_H__
127