Tedd OKANO / Mbed 2 deprecated IAP_internal_flash_write

Sample code for how to erase/write LPC1768, LPC11U24, LPC1114, LPC812 and LPC824 internal flash memory. This program uses IAP call of MCU's ROM routines. The IAP library also supports read/write of EEPROM in LPC11U24.

Dependencies:   mbed IAP

Sample code for how to erase/write LPC1768, LPC11U24, LPC1114, LPC812 and LPC824 internal flash memory. This program uses IAP call of MCU's ROM routines.

No filesystem interface available. This program is just an interface to flash erasing and writing. User need manage where to store the data in the flash area.

This IAP library supports read/write of EEPROM in LPC11U24.

More information available in
http://mbed.org/users/okano/notebook/iap-in-application-programming-internal-flash-eras/

main.cpp@4:5705a494169a, 2015-01-13 (annotated)

Committer:
okano
Date:
Tue Jan 13 09:11:47 2015 +0000
Revision:
4:5705a494169a
Parent:
3:63a0993315e5
Child:
5:806960ca964e
ver3.1 : LPC1114 support

Who changed what in which revision?

UserRevisionLine numberNew contents of line
okano 0:b802bd2f4cc9 1 /** IAP demo : demo code for internal Flash memory access library
okano 0:b802bd2f4cc9 2 *
okano 3:63a0993315e5 3 * The internal Flash memory access is described in the LPC1768 and LPC11U24 usermanual.
okano 0:b802bd2f4cc9 4 * http://www.nxp.com/documents/user_manual/UM10360.pdf
okano 1:a85b51eeb446 5 * http://www.nxp.com/documents/user_manual/UM10462.pdf
okano 0:b802bd2f4cc9 6 *
okano 1:a85b51eeb446 7 * LPC1768 --
okano 1:a85b51eeb446 8 * Chapter 2: "LPC17xx Memory map"
okano 1:a85b51eeb446 9 * Chapter 32: "LPC17xx Flash memory interface and programming"
okano 1:a85b51eeb446 10 * refering Rev. 01 - 4 January 2010
okano 3:63a0993315e5 11 *
okano 1:a85b51eeb446 12 * LPC11U24 --
okano 1:a85b51eeb446 13 * Chapter 2: "LPC11Uxx Memory mapping"
okano 1:a85b51eeb446 14 * Chapter 20: "LPC11Uxx Flash programming firmware"
okano 1:a85b51eeb446 15 * refering Rev. 03 - 16 July 2012
okano 3:63a0993315e5 16 *
okano 0:b802bd2f4cc9 17 * This main.cpp demonstrates how the flash can be erased and wrote.
okano 0:b802bd2f4cc9 18 *
okano 0:b802bd2f4cc9 19 * This program tries to...
okano 0:b802bd2f4cc9 20 * 0. read device ID and serial#
okano 0:b802bd2f4cc9 21 * 1. check if the targat sector blank
okano 0:b802bd2f4cc9 22 * 2. erase the sector if it was not blank
okano 0:b802bd2f4cc9 23 * 3. write into the flash (prepare before write)
okano 0:b802bd2f4cc9 24 * 4. verify the data by IAP command
okano 0:b802bd2f4cc9 25 * 5. show the content of the flash
okano 0:b802bd2f4cc9 26 *
okano 3:63a0993315e5 27 * The Flash must be erased as sectors. No overwrite can be done like SRAM.
okano 3:63a0993315e5 28 * So erase should be done in size of 4K or 32K.
okano 0:b802bd2f4cc9 29 *
okano 3:63a0993315e5 30 * Writing sector can be done with size of 256, 512, 1024 or 4096.
okano 3:63a0993315e5 31 * If other size is used, the IAP returns an error.
okano 3:63a0993315e5 32 * The SRAM memory should be allocated in
okano 0:b802bd2f4cc9 33 *
okano 0:b802bd2f4cc9 34 *
okano 1:a85b51eeb446 35 * Released under the MIT License: http://mbed.org/license/mit
okano 0:b802bd2f4cc9 36 *
okano 0:b802bd2f4cc9 37 * revision 1.0 09-Mar-2010 1st release
okano 0:b802bd2f4cc9 38 * revision 1.1 12-Mar-2010 chaged: to make possible to reserve flash area for user
okano 0:b802bd2f4cc9 39 * it can be set by USER_FLASH_AREA_START and USER_FLASH_AREA_SIZE in IAP.h
okano 1:a85b51eeb446 40 * revision 2.0 26-Nov.2012 LPC11U24 code added
okano 2:c22f0c87fee6 41 * revision 2.1 26-Nov-2012 EEPROM access code imported from Suga koubou san's (http://mbed.org/users/okini3939/) library
okano 2:c22f0c87fee6 42 * http://mbed.org/users/okini3939/code/M0_EEPROM_test/
okano 3:63a0993315e5 43 * revision 3.0 09-Jan-2014 LPC812 and LPC824 support added
okano 4:5705a494169a 44 * revision 3.1 13-Jan-2014 LPC1114 support added
okano 0:b802bd2f4cc9 45 */
okano 0:b802bd2f4cc9 46
okano 0:b802bd2f4cc9 47 #include "mbed.h"
okano 0:b802bd2f4cc9 48 #include "IAP.h"
okano 0:b802bd2f4cc9 49
okano 0:b802bd2f4cc9 50 #define MEM_SIZE 256
okano 1:a85b51eeb446 51
okano 1:a85b51eeb446 52 #if defined(TARGET_LPC1768)
okano 1:a85b51eeb446 53 #define TARGET_SECTOR 29 // use sector 29 as target sector if it is on LPC1768
okano 4:5705a494169a 54 #elif defined(TARGET_LPC11U24) || defined(TARGET_LPC1114)
okano 1:a85b51eeb446 55 #define TARGET_SECTOR 7 // use sector 7 as target sector if it is on LPC11U24
okano 2:c22f0c87fee6 56 #define TARGET_EEPROM_ADDRESS 64
okano 3:63a0993315e5 57 #define TARGET_EEPROM_ADDRESS 64
okano 3:63a0993315e5 58 #elif defined(TARGET_LPC812) || defined(TARGET_LPC824)
okano 3:63a0993315e5 59 #define TARGET_SECTOR 15 // use sector 15 as target sector if it is on LPC812
okano 1:a85b51eeb446 60 #endif
okano 0:b802bd2f4cc9 61
okano 0:b802bd2f4cc9 62 void memdump( char *p, int n );
okano 0:b802bd2f4cc9 63 int isprint( int c );
okano 0:b802bd2f4cc9 64
okano 0:b802bd2f4cc9 65 IAP iap;
okano 0:b802bd2f4cc9 66
okano 0:b802bd2f4cc9 67
okano 3:63a0993315e5 68 int main()
okano 3:63a0993315e5 69 {
okano 0:b802bd2f4cc9 70 char mem[ MEM_SIZE ]; // memory, it should be aligned to word boundary
okano 0:b802bd2f4cc9 71 int r;
okano 0:b802bd2f4cc9 72
okano 3:63a0993315e5 73 printf( "\r\n\r\n=== IAP: Flash memory writing test ===\r\n" );
okano 1:a85b51eeb446 74 printf( " device-ID = 0x%08X, serial# = 0x%08X, CPU running %dkHz\r\n", iap.read_ID(), iap.read_serial(), SystemCoreClock / 1000 );
okano 1:a85b51eeb446 75 printf( " user reserved flash area: start_address=0x%08X, size=%d bytes\r\n", iap.reserved_flash_area_start(), iap.reserved_flash_area_size() );
okano 1:a85b51eeb446 76 printf( " read_BootVer=0x%08X\r\r\n", iap.read_BootVer() );
okano 0:b802bd2f4cc9 77
okano 0:b802bd2f4cc9 78 for ( int i = 0; i < MEM_SIZE; i++ )
okano 0:b802bd2f4cc9 79 mem[ i ] = i & 0xFF;
okano 0:b802bd2f4cc9 80
okano 0:b802bd2f4cc9 81 // blank check: The mbed will erase all flash contents after downloading new executable
okano 0:b802bd2f4cc9 82
okano 0:b802bd2f4cc9 83 r = iap.blank_check( TARGET_SECTOR, TARGET_SECTOR );
okano 1:a85b51eeb446 84 printf( "blank check result = 0x%08X\r\n", r );
okano 0:b802bd2f4cc9 85
okano 0:b802bd2f4cc9 86 // erase sector, if required
okano 3:63a0993315e5 87
okano 0:b802bd2f4cc9 88 if ( r == SECTOR_NOT_BLANK ) {
okano 0:b802bd2f4cc9 89 iap.prepare( TARGET_SECTOR, TARGET_SECTOR );
okano 0:b802bd2f4cc9 90 r = iap.erase( TARGET_SECTOR, TARGET_SECTOR );
okano 1:a85b51eeb446 91 printf( "erase result = 0x%08X\r\n", r );
okano 0:b802bd2f4cc9 92 }
okano 3:63a0993315e5 93
okano 0:b802bd2f4cc9 94 // copy RAM to Flash
okano 0:b802bd2f4cc9 95
okano 0:b802bd2f4cc9 96 iap.prepare( TARGET_SECTOR, TARGET_SECTOR );
okano 0:b802bd2f4cc9 97 r = iap.write( mem, sector_start_adress[ TARGET_SECTOR ], MEM_SIZE );
okano 1:a85b51eeb446 98 printf( "copied: SRAM(0x%08X)->Flash(0x%08X) for %d bytes. (result=0x%08X)\r\n", mem, sector_start_adress[ TARGET_SECTOR ], MEM_SIZE, r );
okano 0:b802bd2f4cc9 99
okano 0:b802bd2f4cc9 100 // compare
okano 0:b802bd2f4cc9 101
okano 0:b802bd2f4cc9 102 r = iap.compare( mem, sector_start_adress[ TARGET_SECTOR ], MEM_SIZE );
okano 1:a85b51eeb446 103 printf( "compare result = \"%s\"\r\n", r ? "FAILED" : "OK" );
okano 0:b802bd2f4cc9 104
okano 0:b802bd2f4cc9 105 //#define WRITE_NEXT_BLOCK
okano 0:b802bd2f4cc9 106 #ifdef WRITE_NEXT_BLOCK
okano 0:b802bd2f4cc9 107
okano 0:b802bd2f4cc9 108 // copy RAM to Flash
okano 0:b802bd2f4cc9 109
okano 0:b802bd2f4cc9 110 iap.prepare( TARGET_SECTOR, TARGET_SECTOR );
okano 0:b802bd2f4cc9 111 r = iap.write( mem, sector_start_adress[ TARGET_SECTOR ] + 256, MEM_SIZE );
okano 1:a85b51eeb446 112 printf( "copied: SRAM(0x%08X)->Flash(0x%08X) for %d bytes. (result=0x%08X)\r\n", mem, sector_start_adress[ TARGET_SECTOR ], MEM_SIZE, r );
okano 0:b802bd2f4cc9 113
okano 0:b802bd2f4cc9 114 // compare
okano 0:b802bd2f4cc9 115
okano 0:b802bd2f4cc9 116 r = iap.compare( mem, sector_start_adress[ TARGET_SECTOR ] + 256, MEM_SIZE );
okano 1:a85b51eeb446 117 printf( "compare result = \"%s\"\r\n", r ? "FAILED" : "OK" );
okano 0:b802bd2f4cc9 118
okano 0:b802bd2f4cc9 119 #endif
okano 0:b802bd2f4cc9 120
okano 1:a85b51eeb446 121 printf( "showing the flash contents...\r\n" );
okano 0:b802bd2f4cc9 122 memdump( sector_start_adress[ TARGET_SECTOR ], MEM_SIZE * 3 );
okano 3:63a0993315e5 123
okano 3:63a0993315e5 124
okano 3:63a0993315e5 125 #if defined(TARGET_LPC812) || defined(TARGET_LPC824)
okano 3:63a0993315e5 126 iap.prepare( TARGET_SECTOR, TARGET_SECTOR );
okano 3:63a0993315e5 127 r = iap.erase_page( 241, 241 ); // 241 is page number for sector 7 with 64 byte offset
okano 3:63a0993315e5 128
okano 3:63a0993315e5 129 printf( "\r\nerase page test\r\n" );
okano 3:63a0993315e5 130 printf( "erase page result = \"%s\"\r\n", r ? "FAILED" : "OK" );
okano 3:63a0993315e5 131 printf( "showing memory dump to confirm 0x00003C40 to 0x00003C7F are erased (should be changed to 0xFF)" );
okano 3:63a0993315e5 132
okano 3:63a0993315e5 133 memdump( sector_start_adress[ TARGET_SECTOR ], MEM_SIZE );
okano 3:63a0993315e5 134 #endif
okano 3:63a0993315e5 135
okano 3:63a0993315e5 136
okano 2:c22f0c87fee6 137 #if defined(TARGET_LPC11U24) // SAMPLE OF EEPROM ACCESS (LPC11U24 only)
okano 2:c22f0c87fee6 138 printf( "IAP: EEPROM writing test\r\n" );
okano 2:c22f0c87fee6 139 char mem2[ MEM_SIZE ];
okano 2:c22f0c87fee6 140
okano 2:c22f0c87fee6 141 r = iap.write_eeprom( mem, (char*)TARGET_EEPROM_ADDRESS, MEM_SIZE );
okano 2:c22f0c87fee6 142 printf( "copied: SRAM(0x%08X)->EEPROM(0x%08X) for %d bytes. (result=0x%08X)\r\n", mem, TARGET_EEPROM_ADDRESS, MEM_SIZE, r );
okano 3:63a0993315e5 143
okano 2:c22f0c87fee6 144 r = iap.read_eeprom( (char*)TARGET_EEPROM_ADDRESS, mem2, MEM_SIZE );
okano 2:c22f0c87fee6 145 printf( "copied: EEPROM(0x%08X)->SRAM(0x%08X) for %d bytes. (result=0x%08X)\r\n", TARGET_EEPROM_ADDRESS, mem, MEM_SIZE, r );
okano 3:63a0993315e5 146
okano 2:c22f0c87fee6 147 // compare
okano 2:c22f0c87fee6 148 r = memcmp(mem, mem2, MEM_SIZE);
okano 2:c22f0c87fee6 149 printf( "compare result = \"%s\"\r\n", r ? "FAILED" : "OK" );
okano 3:63a0993315e5 150
okano 2:c22f0c87fee6 151 printf( "showing the EEPROM contents...\r\n" );
okano 2:c22f0c87fee6 152 memdump( mem2, MEM_SIZE );
okano 2:c22f0c87fee6 153 #endif
okano 2:c22f0c87fee6 154
okano 0:b802bd2f4cc9 155 }
okano 0:b802bd2f4cc9 156
okano 0:b802bd2f4cc9 157
okano 3:63a0993315e5 158 void memdump( char *base, int n )
okano 3:63a0993315e5 159 {
okano 0:b802bd2f4cc9 160 unsigned int *p;
okano 0:b802bd2f4cc9 161
okano 0:b802bd2f4cc9 162 printf( " memdump from 0x%08X for %d bytes", (unsigned long)base, n );
okano 0:b802bd2f4cc9 163
okano 0:b802bd2f4cc9 164 p = (unsigned int *)((unsigned int)base & ~(unsigned int)0x3);
okano 0:b802bd2f4cc9 165
okano 0:b802bd2f4cc9 166 for ( int i = 0; i < (n >> 2); i++, p++ ) {
okano 0:b802bd2f4cc9 167 if ( !(i % 4) )
okano 1:a85b51eeb446 168 printf( "\r\n 0x%08X :", (unsigned int)p );
okano 0:b802bd2f4cc9 169
okano 0:b802bd2f4cc9 170 printf( " 0x%08X", *p );
okano 0:b802bd2f4cc9 171 }
okano 0:b802bd2f4cc9 172
okano 1:a85b51eeb446 173 printf( "\r\n" );
okano 0:b802bd2f4cc9 174 }