Jack Shao / IAP

IAP class library for LPC1768, LPC11U24, LPC1114, LPC812 and LPC824

Fork of IAP by Tedd OKANO

IAP.cpp@0:ada7fb504504, 2012-11-26 (annotated)

Committer:
okano
Date:
Mon Nov 26 04:00:38 2012 +0000
Revision:
0:ada7fb504504
Child:
1:ff906ad52cf9
IAP class library for LPC1768 and LPC11U24

Who changed what in which revision?

UserRevisionLine numberNew contents of line
okano 0:ada7fb504504 1 /** IAP : internal Flash memory access library
okano 0:ada7fb504504 2 *
okano 0:ada7fb504504 3 * The internal Flash memory access is described in the LPC1768 and LPC11U24 usermanual.
okano 0:ada7fb504504 4 * http://www.nxp.com/documents/user_manual/UM10360.pdf
okano 0:ada7fb504504 5 * http://www.nxp.com/documents/user_manual/UM10462.pdf
okano 0:ada7fb504504 6 *
okano 0:ada7fb504504 7 * LPC1768 --
okano 0:ada7fb504504 8 * Chapter 2: "LPC17xx Memory map"
okano 0:ada7fb504504 9 * Chapter 32: "LPC17xx Flash memory interface and programming"
okano 0:ada7fb504504 10 * refering Rev. 01 - 4 January 2010
okano 0:ada7fb504504 11 *
okano 0:ada7fb504504 12 * LPC11U24 --
okano 0:ada7fb504504 13 * Chapter 2: "LPC11Uxx Memory mapping"
okano 0:ada7fb504504 14 * Chapter 20: "LPC11Uxx Flash programming firmware"
okano 0:ada7fb504504 15 * refering Rev. 03 - 16 July 2012
okano 0:ada7fb504504 16 *
okano 0:ada7fb504504 17 * Released under the MIT License: http://mbed.org/license/mit
okano 0:ada7fb504504 18 *
okano 0:ada7fb504504 19 * revision 1.0 09-Mar-2010 1st release
okano 0:ada7fb504504 20 * revision 1.1 12-Mar-2010 chaged: to make possible to reserve flash area for user
okano 0:ada7fb504504 21 * it can be set by USER_FLASH_AREA_START and USER_FLASH_AREA_SIZE in IAP.h
okano 0:ada7fb504504 22 * revision 2.0 26-Nov.2012 LPC11U24 code added
okano 0:ada7fb504504 23 */
okano 0:ada7fb504504 24
okano 0:ada7fb504504 25 #include "mbed.h"
okano 0:ada7fb504504 26 #include "IAP.h"
okano 0:ada7fb504504 27
okano 0:ada7fb504504 28 #define USER_FLASH_AREA_START_STR( x ) STR( x )
okano 0:ada7fb504504 29 #define STR( x ) #x
okano 0:ada7fb504504 30
okano 0:ada7fb504504 31 unsigned char user_area[ USER_FLASH_AREA_SIZE ] __attribute__((section( ".ARM.__at_" USER_FLASH_AREA_START_STR( USER_FLASH_AREA_START ) ), zero_init));
okano 0:ada7fb504504 32
okano 0:ada7fb504504 33
okano 0:ada7fb504504 34 /*
okano 0:ada7fb504504 35 * Reserve of flash area is explained by Igor. Please refer next URL
okano 0:ada7fb504504 36 * http://mbed.org/users/okano/notebook/iap-in-application-programming-internal-flash-eras/?page=1#comment-271
okano 0:ada7fb504504 37 */
okano 0:ada7fb504504 38
okano 0:ada7fb504504 39 //unsigned char user_area[ size ] __attribute__((section(".ARM.__at_0x78000"), zero_init));
okano 0:ada7fb504504 40
okano 0:ada7fb504504 41 /*
okano 0:ada7fb504504 42 * IAP command codes
okano 0:ada7fb504504 43 * Table 589. "IAP Command Summary", Chapter 8. "IAP commands", usermanual
okano 0:ada7fb504504 44 */
okano 0:ada7fb504504 45
okano 0:ada7fb504504 46 enum command_code
okano 0:ada7fb504504 47 {
okano 0:ada7fb504504 48 IAPCommand_Prepare_sector_for_write_operation = 50,
okano 0:ada7fb504504 49 IAPCommand_Copy_RAM_to_Flash,
okano 0:ada7fb504504 50 IAPCommand_Erase_sector,
okano 0:ada7fb504504 51 IAPCommand_Blank_check_sector,
okano 0:ada7fb504504 52 IAPCommand_Read_part_ID,
okano 0:ada7fb504504 53 IAPCommand_Read_Boot_Code_version,
okano 0:ada7fb504504 54 IAPCommand_Compare,
okano 0:ada7fb504504 55 IAPCommand_Reinvoke_ISP,
okano 0:ada7fb504504 56 IAPCommand_Read_device_serial_number
okano 0:ada7fb504504 57 };
okano 0:ada7fb504504 58
okano 0:ada7fb504504 59
okano 0:ada7fb504504 60 /** Read part identification number
okano 0:ada7fb504504 61 *
okano 0:ada7fb504504 62 * @return device ID
okano 0:ada7fb504504 63 * @see read_serial()
okano 0:ada7fb504504 64 */
okano 0:ada7fb504504 65
okano 0:ada7fb504504 66 int IAP::read_ID( void ) {
okano 0:ada7fb504504 67 IAP_command[ 0 ] = IAPCommand_Read_part_ID;
okano 0:ada7fb504504 68
okano 0:ada7fb504504 69 iap_entry( IAP_command, IAP_result );
okano 0:ada7fb504504 70
okano 0:ada7fb504504 71 // return ( (int)IAP_result[ 0 ] );
okano 0:ada7fb504504 72 return ( (int)IAP_result[ 1 ] ); // to return the number itself (this command always returns CMD_SUCCESS)
okano 0:ada7fb504504 73 }
okano 0:ada7fb504504 74
okano 0:ada7fb504504 75
okano 0:ada7fb504504 76 /** Read device serial number
okano 0:ada7fb504504 77 *
okano 0:ada7fb504504 78 * @return device serial number
okano 0:ada7fb504504 79 * @see read_ID()
okano 0:ada7fb504504 80 */
okano 0:ada7fb504504 81
okano 0:ada7fb504504 82 int IAP::read_serial( void ) {
okano 0:ada7fb504504 83 IAP_command[ 0 ] = IAPCommand_Read_device_serial_number;
okano 0:ada7fb504504 84
okano 0:ada7fb504504 85 iap_entry( IAP_command, IAP_result );
okano 0:ada7fb504504 86
okano 0:ada7fb504504 87 // return ( (int)IAP_result[ 0 ] );
okano 0:ada7fb504504 88 return ( (int)IAP_result[ 1 ] ); // to return the number itself (this command always returns CMD_SUCCESS)
okano 0:ada7fb504504 89 }
okano 0:ada7fb504504 90
okano 0:ada7fb504504 91
okano 0:ada7fb504504 92 /** Blank check sector(s)
okano 0:ada7fb504504 93 *
okano 0:ada7fb504504 94 * @param start a Start Sector Number
okano 0:ada7fb504504 95 * @param end an End Sector Number (should be greater than or equal to start sector number).
okano 0:ada7fb504504 96 * @return error code: CMD_SUCCESS | BUSY | SECTOR_NOT_BLANK | INVALID_SECTOR
okano 0:ada7fb504504 97 */
okano 0:ada7fb504504 98
okano 0:ada7fb504504 99 int IAP::blank_check( int start, int end ) {
okano 0:ada7fb504504 100 IAP_command[ 0 ] = IAPCommand_Blank_check_sector;
okano 0:ada7fb504504 101 IAP_command[ 1 ] = (unsigned int)start; // Start Sector Number
okano 0:ada7fb504504 102 IAP_command[ 2 ] = (unsigned int)end; // End Sector Number (should be greater than or equal to start sector number)
okano 0:ada7fb504504 103
okano 0:ada7fb504504 104 iap_entry( IAP_command, IAP_result );
okano 0:ada7fb504504 105
okano 0:ada7fb504504 106 return ( (int)IAP_result[ 0 ] );
okano 0:ada7fb504504 107 }
okano 0:ada7fb504504 108
okano 0:ada7fb504504 109
okano 0:ada7fb504504 110 /** Erase Sector(s)
okano 0:ada7fb504504 111 *
okano 0:ada7fb504504 112 * @param start a Start Sector Number
okano 0:ada7fb504504 113 * @param end an End Sector Number (should be greater than or equal to start sector number).
okano 0:ada7fb504504 114 * @return error code: CMD_SUCCESS | BUSY | SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION | INVALID_SECTOR
okano 0:ada7fb504504 115 */
okano 0:ada7fb504504 116
okano 0:ada7fb504504 117 int IAP::erase( int start, int end ) {
okano 0:ada7fb504504 118 IAP_command[ 0 ] = IAPCommand_Erase_sector;
okano 0:ada7fb504504 119 IAP_command[ 1 ] = (unsigned int)start; // Start Sector Number
okano 0:ada7fb504504 120 IAP_command[ 2 ] = (unsigned int)end; // End Sector Number (should be greater than or equal to start sector number)
okano 0:ada7fb504504 121 IAP_command[ 3 ] = cclk_kHz; // CPU Clock Frequency (CCLK) in kHz
okano 0:ada7fb504504 122
okano 0:ada7fb504504 123 iap_entry( IAP_command, IAP_result );
okano 0:ada7fb504504 124
okano 0:ada7fb504504 125 return ( (int)IAP_result[ 0 ] );
okano 0:ada7fb504504 126 }
okano 0:ada7fb504504 127
okano 0:ada7fb504504 128
okano 0:ada7fb504504 129 /** Prepare sector(s) for write operation
okano 0:ada7fb504504 130 *
okano 0:ada7fb504504 131 * @param start a Start Sector Number
okano 0:ada7fb504504 132 * @param end an End Sector Number (should be greater than or equal to start sector number).
okano 0:ada7fb504504 133 * @return error code: CMD_SUCCESS | BUSY | INVALID_SECTOR
okano 0:ada7fb504504 134 */
okano 0:ada7fb504504 135
okano 0:ada7fb504504 136 int IAP::prepare( int start, int end ) {
okano 0:ada7fb504504 137 IAP_command[ 0 ] = IAPCommand_Prepare_sector_for_write_operation;
okano 0:ada7fb504504 138 IAP_command[ 1 ] = (unsigned int)start; // Start Sector Number
okano 0:ada7fb504504 139 IAP_command[ 2 ] = (unsigned int)end; // End Sector Number (should be greater than or equal to start sector number).
okano 0:ada7fb504504 140
okano 0:ada7fb504504 141 iap_entry( IAP_command, IAP_result );
okano 0:ada7fb504504 142
okano 0:ada7fb504504 143 return ( (int)IAP_result[ 0 ] );
okano 0:ada7fb504504 144 }
okano 0:ada7fb504504 145
okano 0:ada7fb504504 146
okano 0:ada7fb504504 147 /** Copy RAM to Flash
okano 0:ada7fb504504 148 *
okano 0:ada7fb504504 149 * @param source_addr Source RAM address from which data bytes are to be read. This address should be a word boundary.
okano 0:ada7fb504504 150 * @param target_addr Destination flash address where data bytes are to be written. This address should be a 256 byte boundary.
okano 0:ada7fb504504 151 * @param size Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.
okano 0:ada7fb504504 152 * @return error code: CMD_SUCCESS | SRC_ADDR_ERROR (Address not a word boundary) | DST_ADDR_ERROR (Address not on correct boundary) | SRC_ADDR_NOT_MAPPED | DST_ADDR_NOT_MAPPED | COUNT_ERROR (Byte count is not 256 | 512 | 1024 | 4096) | SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION | BUSY
okano 0:ada7fb504504 153 */
okano 0:ada7fb504504 154
okano 0:ada7fb504504 155 int IAP::write( char *source_addr, char *target_addr, int size ) {
okano 0:ada7fb504504 156 IAP_command[ 0 ] = IAPCommand_Copy_RAM_to_Flash;
okano 0:ada7fb504504 157 IAP_command[ 1 ] = (unsigned int)target_addr; // Destination flash address where data bytes are to be written. This address should be a 256 byte boundary.
okano 0:ada7fb504504 158 IAP_command[ 2 ] = (unsigned int)source_addr; // Source RAM address from which data bytes are to be read. This address should be a word boundary.
okano 0:ada7fb504504 159 IAP_command[ 3 ] = size; // Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.
okano 0:ada7fb504504 160 IAP_command[ 4 ] = cclk_kHz; // CPU Clock Frequency (CCLK) in kHz.
okano 0:ada7fb504504 161
okano 0:ada7fb504504 162 iap_entry( IAP_command, IAP_result );
okano 0:ada7fb504504 163
okano 0:ada7fb504504 164 return ( (int)IAP_result[ 0 ] );
okano 0:ada7fb504504 165 }
okano 0:ada7fb504504 166
okano 0:ada7fb504504 167
okano 0:ada7fb504504 168 /** Compare <address1> <address2> <no of bytes>
okano 0:ada7fb504504 169 *
okano 0:ada7fb504504 170 * @param source_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
okano 0:ada7fb504504 171 * @param target_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
okano 0:ada7fb504504 172 * @param size Number of bytes to be compared; should be a multiple of 4.
okano 0:ada7fb504504 173 * @return error code: CMD_SUCCESS | COMPARE_ERROR | COUNT_ERROR (Byte count is not a multiple of 4) | ADDR_ERROR | ADDR_NOT_MAPPED
okano 0:ada7fb504504 174 */
okano 0:ada7fb504504 175
okano 0:ada7fb504504 176 int IAP::compare( char *source_addr, char *target_addr, int size ) {
okano 0:ada7fb504504 177 IAP_command[ 0 ] = IAPCommand_Compare;
okano 0:ada7fb504504 178 IAP_command[ 1 ] = (unsigned int)target_addr; // Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
okano 0:ada7fb504504 179 IAP_command[ 2 ] = (unsigned int)source_addr; // Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
okano 0:ada7fb504504 180 IAP_command[ 3 ] = size; // Number of bytes to be compared; should be a multiple of 4.
okano 0:ada7fb504504 181
okano 0:ada7fb504504 182 iap_entry( IAP_command, IAP_result );
okano 0:ada7fb504504 183
okano 0:ada7fb504504 184 return ( (int)IAP_result[ 0 ] );
okano 0:ada7fb504504 185 }
okano 0:ada7fb504504 186
okano 0:ada7fb504504 187 /** Compare <address1> <address2> <no of bytes>
okano 0:ada7fb504504 188 *
okano 0:ada7fb504504 189 * @param source_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
okano 0:ada7fb504504 190 * @param target_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
okano 0:ada7fb504504 191 * @param size Number of bytes to be compared; should be a multiple of 4.
okano 0:ada7fb504504 192 * @return error code: CMD_SUCCESS | COMPARE_ERROR | COUNT_ERROR (Byte count is not a multiple of 4) | ADDR_ERROR | ADDR_NOT_MAPPED
okano 0:ada7fb504504 193 */
okano 0:ada7fb504504 194
okano 0:ada7fb504504 195 int IAP::read_BootVer(void) {
okano 0:ada7fb504504 196 IAP_command[0] = IAPCommand_Read_Boot_Code_version;
okano 0:ada7fb504504 197 IAP_result[1] = 0; // not sure if in high or low bits.
okano 0:ada7fb504504 198 iap_entry(IAP_command, IAP_result);
okano 0:ada7fb504504 199 return ((int)IAP_result[1]);
okano 0:ada7fb504504 200 }
okano 0:ada7fb504504 201
okano 0:ada7fb504504 202 /** Get user reserved flash start address
okano 0:ada7fb504504 203 *
okano 0:ada7fb504504 204 * @return start address of user reserved flash memory
okano 0:ada7fb504504 205 * @see reserved_flash_area_size()
okano 0:ada7fb504504 206 */
okano 0:ada7fb504504 207
okano 0:ada7fb504504 208 char * IAP::reserved_flash_area_start( void )
okano 0:ada7fb504504 209 {
okano 0:ada7fb504504 210 return ( (char *)USER_FLASH_AREA_START );
okano 0:ada7fb504504 211 }
okano 0:ada7fb504504 212
okano 0:ada7fb504504 213
okano 0:ada7fb504504 214 /** Get user reserved flash size
okano 0:ada7fb504504 215 *
okano 0:ada7fb504504 216 * @return size of user reserved flash memory
okano 0:ada7fb504504 217 * @see reserved_flash_area_start()
okano 0:ada7fb504504 218 */
okano 0:ada7fb504504 219
okano 0:ada7fb504504 220 int IAP::reserved_flash_area_size( void )
okano 0:ada7fb504504 221 {
okano 0:ada7fb504504 222 return ( USER_FLASH_AREA_SIZE );
okano 0:ada7fb504504 223 }
okano 0:ada7fb504504 224