EEPROM library for fav-button
Fork of M0_EEPROM_test by
IAP.h@0:09bfe87fd66a, 2012-05-11 (annotated)
- Committer:
- okini3939
- Date:
- Fri May 11 00:40:02 2012 +0000
- Revision:
- 0:09bfe87fd66a
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
okini3939 | 0:09bfe87fd66a | 1 | /** IAP : internal Flash memory access library |
okini3939 | 0:09bfe87fd66a | 2 | * |
okini3939 | 0:09bfe87fd66a | 3 | * The internal Flash memory access is described in the LPC1768 usermanual. |
okini3939 | 0:09bfe87fd66a | 4 | * http://www.nxp.com/documents/user_manual/UM10360.pdf |
okini3939 | 0:09bfe87fd66a | 5 | * |
okini3939 | 0:09bfe87fd66a | 6 | * Chapter 2: "LPC17xx Memory map" |
okini3939 | 0:09bfe87fd66a | 7 | * Chapter 32: "LPC17xx Flash memory interface and programming" |
okini3939 | 0:09bfe87fd66a | 8 | * refering Rev. 01 - 4 January 2010 |
okini3939 | 0:09bfe87fd66a | 9 | * |
okini3939 | 0:09bfe87fd66a | 10 | * Released under the MIT License: http://mbed.org/license/mit |
okini3939 | 0:09bfe87fd66a | 11 | * |
okini3939 | 0:09bfe87fd66a | 12 | * revision 1.0 09-Mar-2010 1st release |
okini3939 | 0:09bfe87fd66a | 13 | * revision 1.1 12-Mar-2010 chaged: to make possible to reserve flash area for user |
okini3939 | 0:09bfe87fd66a | 14 | * it can be set by USER_FLASH_AREA_START and USER_FLASH_AREA_SIZE in IAP.h |
okini3939 | 0:09bfe87fd66a | 15 | * |
okini3939 | 0:09bfe87fd66a | 16 | * by Tedd OKANO http://mbed.org/users/okano/notebook/iap-in-application-programming-internal-flash-eras/ |
okini3939 | 0:09bfe87fd66a | 17 | * modified by Suga (supported to LPC11U24) |
okini3939 | 0:09bfe87fd66a | 18 | */ |
okini3939 | 0:09bfe87fd66a | 19 | |
okini3939 | 0:09bfe87fd66a | 20 | #ifndef MBED_IAP |
okini3939 | 0:09bfe87fd66a | 21 | #define MBED_IAP |
okini3939 | 0:09bfe87fd66a | 22 | |
okini3939 | 0:09bfe87fd66a | 23 | #include "mbed.h" |
okini3939 | 0:09bfe87fd66a | 24 | |
okini3939 | 0:09bfe87fd66a | 25 | #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368) |
okini3939 | 0:09bfe87fd66a | 26 | #define USER_FLASH_AREA_START FLASH_SECTOR_29 |
okini3939 | 0:09bfe87fd66a | 27 | #define USER_FLASH_AREA_SIZE (FLASH_SECTOR_SIZE_16_TO_29 * 1) |
okini3939 | 0:09bfe87fd66a | 28 | #elif defined(TARGET_LPC11U24) |
okini3939 | 0:09bfe87fd66a | 29 | #define USER_FLASH_AREA_START FLASH_SECTOR_7 |
okini3939 | 0:09bfe87fd66a | 30 | #define USER_FLASH_AREA_SIZE (FLASH_SECTOR_SIZE_0_TO_15 * 1) |
okini3939 | 0:09bfe87fd66a | 31 | #endif |
okini3939 | 0:09bfe87fd66a | 32 | |
okini3939 | 0:09bfe87fd66a | 33 | /* |
okini3939 | 0:09bfe87fd66a | 34 | * memory map information is available in next URL also. |
okini3939 | 0:09bfe87fd66a | 35 | * http://mbed.org/projects/libraries/svn/mbed/trunk/LPC1768/LPC17xx.h |
okini3939 | 0:09bfe87fd66a | 36 | */ |
okini3939 | 0:09bfe87fd66a | 37 | |
okini3939 | 0:09bfe87fd66a | 38 | /** Table for start adress of sectors |
okini3939 | 0:09bfe87fd66a | 39 | * |
okini3939 | 0:09bfe87fd66a | 40 | * LPC1768 internal flash memory sector numbers and addresses |
okini3939 | 0:09bfe87fd66a | 41 | * |
okini3939 | 0:09bfe87fd66a | 42 | * LPC1768 flash memory are and sector number/size |
okini3939 | 0:09bfe87fd66a | 43 | * Table 568 "Sectors in a LPC17xx device", Section 5. "Sector numbers", usermanual |
okini3939 | 0:09bfe87fd66a | 44 | * |
okini3939 | 0:09bfe87fd66a | 45 | * 0x00000000 - 0x0007FFFF flash (29 sectors) |
okini3939 | 0:09bfe87fd66a | 46 | * |
okini3939 | 0:09bfe87fd66a | 47 | * Sector0: 0x00000000 - 0x00000FFF 4K |
okini3939 | 0:09bfe87fd66a | 48 | * Sector1: 0x00001000 - 0x00001FFF 4K |
okini3939 | 0:09bfe87fd66a | 49 | * Sector2: 0x00002000 - 0x00002FFF 4K |
okini3939 | 0:09bfe87fd66a | 50 | * Sector3: 0x00003000 - 0x00003FFF 4K |
okini3939 | 0:09bfe87fd66a | 51 | * Sector4: 0x00004000 - 0x00004FFF 4K |
okini3939 | 0:09bfe87fd66a | 52 | * Sector5: 0x00005000 - 0x00005FFF 4K |
okini3939 | 0:09bfe87fd66a | 53 | * Sector6: 0x00006000 - 0x00006FFF 4K |
okini3939 | 0:09bfe87fd66a | 54 | * Sector7: 0x00007000 - 0x00007FFF 4K |
okini3939 | 0:09bfe87fd66a | 55 | * Sector8: 0x00008000 - 0x00008FFF 4K |
okini3939 | 0:09bfe87fd66a | 56 | * Sector9: 0x00009000 - 0x00009FFF 4K |
okini3939 | 0:09bfe87fd66a | 57 | * Sector10: 0x0000A000 - 0x0000AFFF 4K |
okini3939 | 0:09bfe87fd66a | 58 | * Sector11: 0x0000B000 - 0x0000BFFF 4K |
okini3939 | 0:09bfe87fd66a | 59 | * Sector12: 0x0000C000 - 0x0000CFFF 4K |
okini3939 | 0:09bfe87fd66a | 60 | * Sector13: 0x0000D000 - 0x0000DFFF 4K |
okini3939 | 0:09bfe87fd66a | 61 | * Sector14: 0x0000E000 - 0x0000EFFF 4K |
okini3939 | 0:09bfe87fd66a | 62 | * Sector15: 0x0000F000 - 0x0000FFFF 4K |
okini3939 | 0:09bfe87fd66a | 63 | * |
okini3939 | 0:09bfe87fd66a | 64 | * Sector16: 0x00010000 - 0x00017FFF 32K |
okini3939 | 0:09bfe87fd66a | 65 | * Sector17: 0x00018000 - 0x0001FFFF 32K |
okini3939 | 0:09bfe87fd66a | 66 | * Sector18: 0x00020000 - 0x00027FFF 32K |
okini3939 | 0:09bfe87fd66a | 67 | * Sector19: 0x00028000 - 0x0002FFFF 32K |
okini3939 | 0:09bfe87fd66a | 68 | * Sector20: 0x00030000 - 0x00037FFF 32K |
okini3939 | 0:09bfe87fd66a | 69 | * Sector21: 0x00038000 - 0x0003FFFF 32K |
okini3939 | 0:09bfe87fd66a | 70 | * Sector22: 0x00040000 - 0x00047FFF 32K |
okini3939 | 0:09bfe87fd66a | 71 | * Sector23: 0x00048000 - 0x0004FFFF 32K |
okini3939 | 0:09bfe87fd66a | 72 | * Sector24: 0x00050000 - 0x00057FFF 32K |
okini3939 | 0:09bfe87fd66a | 73 | * Sector25: 0x00058000 - 0x0005FFFF 32K |
okini3939 | 0:09bfe87fd66a | 74 | * Sector26: 0x00060000 - 0x00067FFF 32K |
okini3939 | 0:09bfe87fd66a | 75 | * Sector27: 0x00068000 - 0x0006FFFF 32K |
okini3939 | 0:09bfe87fd66a | 76 | * Sector28: 0x00070000 - 0x00077FFF 32K |
okini3939 | 0:09bfe87fd66a | 77 | * Sector29: 0x00078000 - 0x0007FFFF 32K |
okini3939 | 0:09bfe87fd66a | 78 | */ |
okini3939 | 0:09bfe87fd66a | 79 | |
okini3939 | 0:09bfe87fd66a | 80 | #define FLASH_SECTOR_0 0x00000000 |
okini3939 | 0:09bfe87fd66a | 81 | #define FLASH_SECTOR_1 0x00001000 |
okini3939 | 0:09bfe87fd66a | 82 | #define FLASH_SECTOR_2 0x00002000 |
okini3939 | 0:09bfe87fd66a | 83 | #define FLASH_SECTOR_3 0x00003000 |
okini3939 | 0:09bfe87fd66a | 84 | #define FLASH_SECTOR_4 0x00004000 |
okini3939 | 0:09bfe87fd66a | 85 | #define FLASH_SECTOR_5 0x00005000 |
okini3939 | 0:09bfe87fd66a | 86 | #define FLASH_SECTOR_6 0x00006000 |
okini3939 | 0:09bfe87fd66a | 87 | #define FLASH_SECTOR_7 0x00007000 |
okini3939 | 0:09bfe87fd66a | 88 | #define FLASH_SECTOR_8 0x00008000 |
okini3939 | 0:09bfe87fd66a | 89 | #define FLASH_SECTOR_9 0x00009000 |
okini3939 | 0:09bfe87fd66a | 90 | #define FLASH_SECTOR_10 0x0000A000 |
okini3939 | 0:09bfe87fd66a | 91 | #define FLASH_SECTOR_11 0x0000B000 |
okini3939 | 0:09bfe87fd66a | 92 | #define FLASH_SECTOR_12 0x0000C000 |
okini3939 | 0:09bfe87fd66a | 93 | #define FLASH_SECTOR_13 0x0000D000 |
okini3939 | 0:09bfe87fd66a | 94 | #define FLASH_SECTOR_14 0x0000E000 |
okini3939 | 0:09bfe87fd66a | 95 | #define FLASH_SECTOR_15 0x0000F000 |
okini3939 | 0:09bfe87fd66a | 96 | #define FLASH_SECTOR_16 0x00010000 |
okini3939 | 0:09bfe87fd66a | 97 | #define FLASH_SECTOR_17 0x00018000 |
okini3939 | 0:09bfe87fd66a | 98 | #define FLASH_SECTOR_18 0x00020000 |
okini3939 | 0:09bfe87fd66a | 99 | #define FLASH_SECTOR_19 0x00028000 |
okini3939 | 0:09bfe87fd66a | 100 | #define FLASH_SECTOR_20 0x00030000 |
okini3939 | 0:09bfe87fd66a | 101 | #define FLASH_SECTOR_21 0x00038000 |
okini3939 | 0:09bfe87fd66a | 102 | #define FLASH_SECTOR_22 0x00040000 |
okini3939 | 0:09bfe87fd66a | 103 | #define FLASH_SECTOR_23 0x00048000 |
okini3939 | 0:09bfe87fd66a | 104 | #define FLASH_SECTOR_24 0x00050000 |
okini3939 | 0:09bfe87fd66a | 105 | #define FLASH_SECTOR_25 0x00058000 |
okini3939 | 0:09bfe87fd66a | 106 | #define FLASH_SECTOR_26 0x00060000 |
okini3939 | 0:09bfe87fd66a | 107 | #define FLASH_SECTOR_27 0x00068000 |
okini3939 | 0:09bfe87fd66a | 108 | #define FLASH_SECTOR_28 0x00070000 |
okini3939 | 0:09bfe87fd66a | 109 | #define FLASH_SECTOR_29 0x00078000 |
okini3939 | 0:09bfe87fd66a | 110 | |
okini3939 | 0:09bfe87fd66a | 111 | #define FLASH_SECTOR_SIZE_0_TO_15 ( 4 * 1024) |
okini3939 | 0:09bfe87fd66a | 112 | #define FLASH_SECTOR_SIZE_16_TO_29 (32 * 1024) |
okini3939 | 0:09bfe87fd66a | 113 | |
okini3939 | 0:09bfe87fd66a | 114 | static char * sector_start_adress[] = { |
okini3939 | 0:09bfe87fd66a | 115 | (char *)FLASH_SECTOR_0, |
okini3939 | 0:09bfe87fd66a | 116 | (char *)FLASH_SECTOR_1, |
okini3939 | 0:09bfe87fd66a | 117 | (char *)FLASH_SECTOR_2, |
okini3939 | 0:09bfe87fd66a | 118 | (char *)FLASH_SECTOR_3, |
okini3939 | 0:09bfe87fd66a | 119 | (char *)FLASH_SECTOR_4, |
okini3939 | 0:09bfe87fd66a | 120 | (char *)FLASH_SECTOR_5, |
okini3939 | 0:09bfe87fd66a | 121 | (char *)FLASH_SECTOR_6, |
okini3939 | 0:09bfe87fd66a | 122 | (char *)FLASH_SECTOR_7, |
okini3939 | 0:09bfe87fd66a | 123 | #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368) |
okini3939 | 0:09bfe87fd66a | 124 | (char *)FLASH_SECTOR_8, |
okini3939 | 0:09bfe87fd66a | 125 | (char *)FLASH_SECTOR_9, |
okini3939 | 0:09bfe87fd66a | 126 | (char *)FLASH_SECTOR_10, |
okini3939 | 0:09bfe87fd66a | 127 | (char *)FLASH_SECTOR_11, |
okini3939 | 0:09bfe87fd66a | 128 | (char *)FLASH_SECTOR_12, |
okini3939 | 0:09bfe87fd66a | 129 | (char *)FLASH_SECTOR_13, |
okini3939 | 0:09bfe87fd66a | 130 | (char *)FLASH_SECTOR_14, |
okini3939 | 0:09bfe87fd66a | 131 | (char *)FLASH_SECTOR_15, |
okini3939 | 0:09bfe87fd66a | 132 | (char *)FLASH_SECTOR_16, |
okini3939 | 0:09bfe87fd66a | 133 | (char *)FLASH_SECTOR_17, |
okini3939 | 0:09bfe87fd66a | 134 | (char *)FLASH_SECTOR_18, |
okini3939 | 0:09bfe87fd66a | 135 | (char *)FLASH_SECTOR_19, |
okini3939 | 0:09bfe87fd66a | 136 | (char *)FLASH_SECTOR_20, |
okini3939 | 0:09bfe87fd66a | 137 | (char *)FLASH_SECTOR_21, |
okini3939 | 0:09bfe87fd66a | 138 | (char *)FLASH_SECTOR_22, |
okini3939 | 0:09bfe87fd66a | 139 | (char *)FLASH_SECTOR_23, |
okini3939 | 0:09bfe87fd66a | 140 | (char *)FLASH_SECTOR_24, |
okini3939 | 0:09bfe87fd66a | 141 | (char *)FLASH_SECTOR_25, |
okini3939 | 0:09bfe87fd66a | 142 | (char *)FLASH_SECTOR_26, |
okini3939 | 0:09bfe87fd66a | 143 | (char *)FLASH_SECTOR_27, |
okini3939 | 0:09bfe87fd66a | 144 | (char *)FLASH_SECTOR_28, |
okini3939 | 0:09bfe87fd66a | 145 | (char *)FLASH_SECTOR_29 |
okini3939 | 0:09bfe87fd66a | 146 | #endif |
okini3939 | 0:09bfe87fd66a | 147 | }; |
okini3939 | 0:09bfe87fd66a | 148 | |
okini3939 | 0:09bfe87fd66a | 149 | |
okini3939 | 0:09bfe87fd66a | 150 | /** Error code by IAP routine |
okini3939 | 0:09bfe87fd66a | 151 | * |
okini3939 | 0:09bfe87fd66a | 152 | * Table 588 "ISP Return Codes Summary", Section 7.15 "ISP Return Codes", usermanual |
okini3939 | 0:09bfe87fd66a | 153 | */ |
okini3939 | 0:09bfe87fd66a | 154 | |
okini3939 | 0:09bfe87fd66a | 155 | enum error_code |
okini3939 | 0:09bfe87fd66a | 156 | { |
okini3939 | 0:09bfe87fd66a | 157 | CMD_SUCCESS, |
okini3939 | 0:09bfe87fd66a | 158 | INVALID_COMMAND, |
okini3939 | 0:09bfe87fd66a | 159 | SRC_ADDR_ERROR, |
okini3939 | 0:09bfe87fd66a | 160 | DST_ADDR_ERROR, |
okini3939 | 0:09bfe87fd66a | 161 | SRC_ADDR_NOT_MAPPED, |
okini3939 | 0:09bfe87fd66a | 162 | DST_ADDR_NOT_MAPPED, |
okini3939 | 0:09bfe87fd66a | 163 | COUNT_ERROR, |
okini3939 | 0:09bfe87fd66a | 164 | INVALID_SECTOR, |
okini3939 | 0:09bfe87fd66a | 165 | SECTOR_NOT_BLANK, |
okini3939 | 0:09bfe87fd66a | 166 | SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION, |
okini3939 | 0:09bfe87fd66a | 167 | COMPARE_ERROR, |
okini3939 | 0:09bfe87fd66a | 168 | BUSY, |
okini3939 | 0:09bfe87fd66a | 169 | PARAM_ERROR, |
okini3939 | 0:09bfe87fd66a | 170 | ADDR_ERROR, |
okini3939 | 0:09bfe87fd66a | 171 | ADDR_NOT_MAPPED, |
okini3939 | 0:09bfe87fd66a | 172 | CMD_LOCKED, |
okini3939 | 0:09bfe87fd66a | 173 | INVALID_CODE, |
okini3939 | 0:09bfe87fd66a | 174 | INVALID_BAUD_RATE, |
okini3939 | 0:09bfe87fd66a | 175 | INVALID_STOP_BIT, |
okini3939 | 0:09bfe87fd66a | 176 | CODE_READ_PROTECTION_ENABLED |
okini3939 | 0:09bfe87fd66a | 177 | }; |
okini3939 | 0:09bfe87fd66a | 178 | |
okini3939 | 0:09bfe87fd66a | 179 | |
okini3939 | 0:09bfe87fd66a | 180 | |
okini3939 | 0:09bfe87fd66a | 181 | /* |
okini3939 | 0:09bfe87fd66a | 182 | * IAP routine entry |
okini3939 | 0:09bfe87fd66a | 183 | * |
okini3939 | 0:09bfe87fd66a | 184 | * Chapter 8. "IAP commands", usermanual |
okini3939 | 0:09bfe87fd66a | 185 | */ |
okini3939 | 0:09bfe87fd66a | 186 | |
okini3939 | 0:09bfe87fd66a | 187 | #define IAP_LOCATION 0x1fff1ff1 |
okini3939 | 0:09bfe87fd66a | 188 | typedef void (*IAP_call)(unsigned int [], unsigned int []); |
okini3939 | 0:09bfe87fd66a | 189 | |
okini3939 | 0:09bfe87fd66a | 190 | /** IAP class |
okini3939 | 0:09bfe87fd66a | 191 | * |
okini3939 | 0:09bfe87fd66a | 192 | * Interface for internal flash memory access |
okini3939 | 0:09bfe87fd66a | 193 | */ |
okini3939 | 0:09bfe87fd66a | 194 | |
okini3939 | 0:09bfe87fd66a | 195 | |
okini3939 | 0:09bfe87fd66a | 196 | class IAP { |
okini3939 | 0:09bfe87fd66a | 197 | public: |
okini3939 | 0:09bfe87fd66a | 198 | |
okini3939 | 0:09bfe87fd66a | 199 | /* |
okini3939 | 0:09bfe87fd66a | 200 | * SystemCoreClock ??? : |
okini3939 | 0:09bfe87fd66a | 201 | * http://mbed.org/forum/mbed/topic/229/ |
okini3939 | 0:09bfe87fd66a | 202 | * http://mbed.org/users/simon/programs/SystemCoreClock/16mhsh/ |
okini3939 | 0:09bfe87fd66a | 203 | */ |
okini3939 | 0:09bfe87fd66a | 204 | |
okini3939 | 0:09bfe87fd66a | 205 | |
okini3939 | 0:09bfe87fd66a | 206 | /** Constructor for IAP |
okini3939 | 0:09bfe87fd66a | 207 | * |
okini3939 | 0:09bfe87fd66a | 208 | */ |
okini3939 | 0:09bfe87fd66a | 209 | |
okini3939 | 0:09bfe87fd66a | 210 | IAP() : iap_entry( reinterpret_cast<IAP_call>(IAP_LOCATION) ), cclk_kHz( SystemCoreClock / 1000 ) {} |
okini3939 | 0:09bfe87fd66a | 211 | int read_ID( void ); |
okini3939 | 0:09bfe87fd66a | 212 | int read_serial( void ); |
okini3939 | 0:09bfe87fd66a | 213 | int blank_check( int start, int end ); |
okini3939 | 0:09bfe87fd66a | 214 | int erase( int start, int end ); |
okini3939 | 0:09bfe87fd66a | 215 | int prepare( int start, int end ); |
okini3939 | 0:09bfe87fd66a | 216 | int write( char *source_addr, char *target_addr, int size ); |
okini3939 | 0:09bfe87fd66a | 217 | int compare( char *source_addr, char *target_addr, int size ); |
okini3939 | 0:09bfe87fd66a | 218 | |
okini3939 | 0:09bfe87fd66a | 219 | char *reserved_flash_area_start( void ); |
okini3939 | 0:09bfe87fd66a | 220 | int reserved_flash_area_size( void ); |
okini3939 | 0:09bfe87fd66a | 221 | |
okini3939 | 0:09bfe87fd66a | 222 | #if defined(TARGET_LPC11U24) |
okini3939 | 0:09bfe87fd66a | 223 | int write_eeprom( char *source_addr, char *target_addr, int size ); |
okini3939 | 0:09bfe87fd66a | 224 | int read_eeprom( char *source_addr, char *target_addr, int size ); |
okini3939 | 0:09bfe87fd66a | 225 | #endif |
okini3939 | 0:09bfe87fd66a | 226 | |
okini3939 | 0:09bfe87fd66a | 227 | private: |
okini3939 | 0:09bfe87fd66a | 228 | IAP_call iap_entry; |
okini3939 | 0:09bfe87fd66a | 229 | unsigned int IAP_command[ 5 ]; |
okini3939 | 0:09bfe87fd66a | 230 | unsigned int IAP_result[ 5 ]; |
okini3939 | 0:09bfe87fd66a | 231 | int cclk_kHz; |
okini3939 | 0:09bfe87fd66a | 232 | |
okini3939 | 0:09bfe87fd66a | 233 | //int cpu_clock( void ); |
okini3939 | 0:09bfe87fd66a | 234 | } |
okini3939 | 0:09bfe87fd66a | 235 | ; |
okini3939 | 0:09bfe87fd66a | 236 | |
okini3939 | 0:09bfe87fd66a | 237 | #endif // #ifndef MBED_IAP |