Dave Tech / Mbed 2 deprecated EepromTest

11u24 Eeprom utility.

Dependencies:   TextLCD mbed

IAP.h@0:e2b0ee19db2b, 2014-09-26 (annotated)

Committer:
kstech
Date:
Fri Sep 26 09:22:57 2014 +0000
Revision:
0:e2b0ee19db2b
11u24 Eeprom utility

Who changed what in which revision?

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