Dave Tech / Mbed 2 deprecated EepromTest

11u24 Eeprom utility.

Dependencies:   TextLCD mbed

IAP.cpp@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 #include "mbed.h"
kstech 0:e2b0ee19db2b 21 #include "IAP.h"
kstech 0:e2b0ee19db2b 22
kstech 0:e2b0ee19db2b 23 #define USER_FLASH_AREA_START_STR( x ) STR( x )
kstech 0:e2b0ee19db2b 24 #define STR( x ) #x
kstech 0:e2b0ee19db2b 25
kstech 0:e2b0ee19db2b 26 unsigned char user_area[ USER_FLASH_AREA_SIZE ] __attribute__((section( ".ARM.__at_" USER_FLASH_AREA_START_STR( USER_FLASH_AREA_START ) ), zero_init));
kstech 0:e2b0ee19db2b 27
kstech 0:e2b0ee19db2b 28
kstech 0:e2b0ee19db2b 29 /*
kstech 0:e2b0ee19db2b 30 * Reserve of flash area is explained by Igor. Please refer next URL
kstech 0:e2b0ee19db2b 31 * http://mbed.org/users/okano/notebook/iap-in-application-programming-internal-flash-eras/?page=1#comment-271
kstech 0:e2b0ee19db2b 32 */
kstech 0:e2b0ee19db2b 33
kstech 0:e2b0ee19db2b 34 //unsigned char user_area[ size ] __attribute__((section(".ARM.__at_0x78000"), zero_init));
kstech 0:e2b0ee19db2b 35
kstech 0:e2b0ee19db2b 36 /*
kstech 0:e2b0ee19db2b 37 * IAP command codes
kstech 0:e2b0ee19db2b 38 * Table 589. "IAP Command Summary", Chapter 8. "IAP commands", usermanual
kstech 0:e2b0ee19db2b 39 */
kstech 0:e2b0ee19db2b 40
kstech 0:e2b0ee19db2b 41 enum command_code
kstech 0:e2b0ee19db2b 42 {
kstech 0:e2b0ee19db2b 43 IAPCommand_Prepare_sector_for_write_operation = 50,
kstech 0:e2b0ee19db2b 44 IAPCommand_Copy_RAM_to_Flash,
kstech 0:e2b0ee19db2b 45 IAPCommand_Erase_sector,
kstech 0:e2b0ee19db2b 46 IAPCommand_Blank_check_sector,
kstech 0:e2b0ee19db2b 47 IAPCommand_Read_part_ID,
kstech 0:e2b0ee19db2b 48 IAPCommand_Read_Boot_Code_version,
kstech 0:e2b0ee19db2b 49 IAPCommand_Compare,
kstech 0:e2b0ee19db2b 50 IAPCommand_Reinvoke_ISP,
kstech 0:e2b0ee19db2b 51 IAPCommand_Read_device_serial_number,
kstech 0:e2b0ee19db2b 52 IAPCommand_EEPROM_Write = 61,
kstech 0:e2b0ee19db2b 53 IAPCommand_EEPROM_Read,
kstech 0:e2b0ee19db2b 54 };
kstech 0:e2b0ee19db2b 55
kstech 0:e2b0ee19db2b 56
kstech 0:e2b0ee19db2b 57 /** Read part identification number
kstech 0:e2b0ee19db2b 58 *
kstech 0:e2b0ee19db2b 59 * @return device ID
kstech 0:e2b0ee19db2b 60 * @see read_serial()
kstech 0:e2b0ee19db2b 61 */
kstech 0:e2b0ee19db2b 62
kstech 0:e2b0ee19db2b 63 int IAP::read_ID( void ) {
kstech 0:e2b0ee19db2b 64 IAP_command[ 0 ] = IAPCommand_Read_part_ID;
kstech 0:e2b0ee19db2b 65
kstech 0:e2b0ee19db2b 66 iap_entry( IAP_command, IAP_result );
kstech 0:e2b0ee19db2b 67
kstech 0:e2b0ee19db2b 68 // return ( (int)IAP_result[ 0 ] );
kstech 0:e2b0ee19db2b 69 return ( (int)IAP_result[ 1 ] ); // to return the number itself (this command always returns CMD_SUCCESS)
kstech 0:e2b0ee19db2b 70 }
kstech 0:e2b0ee19db2b 71
kstech 0:e2b0ee19db2b 72
kstech 0:e2b0ee19db2b 73 /** Read device serial number
kstech 0:e2b0ee19db2b 74 *
kstech 0:e2b0ee19db2b 75 * @return device serial number
kstech 0:e2b0ee19db2b 76 * @see read_ID()
kstech 0:e2b0ee19db2b 77 */
kstech 0:e2b0ee19db2b 78
kstech 0:e2b0ee19db2b 79 int IAP::read_serial( void ) {
kstech 0:e2b0ee19db2b 80 IAP_command[ 0 ] = IAPCommand_Read_device_serial_number;
kstech 0:e2b0ee19db2b 81
kstech 0:e2b0ee19db2b 82 iap_entry( IAP_command, IAP_result );
kstech 0:e2b0ee19db2b 83
kstech 0:e2b0ee19db2b 84 // return ( (int)IAP_result[ 0 ] );
kstech 0:e2b0ee19db2b 85 return ( (int)IAP_result[ 1 ] ); // to return the number itself (this command always returns CMD_SUCCESS)
kstech 0:e2b0ee19db2b 86 }
kstech 0:e2b0ee19db2b 87
kstech 0:e2b0ee19db2b 88
kstech 0:e2b0ee19db2b 89 /** Blank check sector(s)
kstech 0:e2b0ee19db2b 90 *
kstech 0:e2b0ee19db2b 91 * @param start a Start Sector Number
kstech 0:e2b0ee19db2b 92 * @param end an End Sector Number (should be greater than or equal to start sector number).
kstech 0:e2b0ee19db2b 93 * @return error code: CMD_SUCCESS | BUSY | SECTOR_NOT_BLANK | INVALID_SECTOR
kstech 0:e2b0ee19db2b 94 */
kstech 0:e2b0ee19db2b 95
kstech 0:e2b0ee19db2b 96 int IAP::blank_check( int start, int end ) {
kstech 0:e2b0ee19db2b 97 IAP_command[ 0 ] = IAPCommand_Blank_check_sector;
kstech 0:e2b0ee19db2b 98 IAP_command[ 1 ] = (unsigned int)start; // Start Sector Number
kstech 0:e2b0ee19db2b 99 IAP_command[ 2 ] = (unsigned int)end; // End Sector Number (should be greater than or equal to start sector number)
kstech 0:e2b0ee19db2b 100
kstech 0:e2b0ee19db2b 101 iap_entry( IAP_command, IAP_result );
kstech 0:e2b0ee19db2b 102
kstech 0:e2b0ee19db2b 103 return ( (int)IAP_result[ 0 ] );
kstech 0:e2b0ee19db2b 104 }
kstech 0:e2b0ee19db2b 105
kstech 0:e2b0ee19db2b 106
kstech 0:e2b0ee19db2b 107 /** Erase Sector(s)
kstech 0:e2b0ee19db2b 108 *
kstech 0:e2b0ee19db2b 109 * @param start a Start Sector Number
kstech 0:e2b0ee19db2b 110 * @param end an End Sector Number (should be greater than or equal to start sector number).
kstech 0:e2b0ee19db2b 111 * @return error code: CMD_SUCCESS | BUSY | SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION | INVALID_SECTOR
kstech 0:e2b0ee19db2b 112 */
kstech 0:e2b0ee19db2b 113
kstech 0:e2b0ee19db2b 114 int IAP::erase( int start, int end ) {
kstech 0:e2b0ee19db2b 115 IAP_command[ 0 ] = IAPCommand_Erase_sector;
kstech 0:e2b0ee19db2b 116 IAP_command[ 1 ] = (unsigned int)start; // Start Sector Number
kstech 0:e2b0ee19db2b 117 IAP_command[ 2 ] = (unsigned int)end; // End Sector Number (should be greater than or equal to start sector number)
kstech 0:e2b0ee19db2b 118 IAP_command[ 3 ] = cclk_kHz; // CPU Clock Frequency (CCLK) in kHz
kstech 0:e2b0ee19db2b 119
kstech 0:e2b0ee19db2b 120 iap_entry( IAP_command, IAP_result );
kstech 0:e2b0ee19db2b 121
kstech 0:e2b0ee19db2b 122 return ( (int)IAP_result[ 0 ] );
kstech 0:e2b0ee19db2b 123 }
kstech 0:e2b0ee19db2b 124
kstech 0:e2b0ee19db2b 125
kstech 0:e2b0ee19db2b 126 /** Prepare sector(s) for write operation
kstech 0:e2b0ee19db2b 127 *
kstech 0:e2b0ee19db2b 128 * @param start a Start Sector Number
kstech 0:e2b0ee19db2b 129 * @param end an End Sector Number (should be greater than or equal to start sector number).
kstech 0:e2b0ee19db2b 130 * @return error code: CMD_SUCCESS | BUSY | INVALID_SECTOR
kstech 0:e2b0ee19db2b 131 */
kstech 0:e2b0ee19db2b 132
kstech 0:e2b0ee19db2b 133 int IAP::prepare( int start, int end ) {
kstech 0:e2b0ee19db2b 134 IAP_command[ 0 ] = IAPCommand_Prepare_sector_for_write_operation;
kstech 0:e2b0ee19db2b 135 IAP_command[ 1 ] = (unsigned int)start; // Start Sector Number
kstech 0:e2b0ee19db2b 136 IAP_command[ 2 ] = (unsigned int)end; // End Sector Number (should be greater than or equal to start sector number).
kstech 0:e2b0ee19db2b 137
kstech 0:e2b0ee19db2b 138 iap_entry( IAP_command, IAP_result );
kstech 0:e2b0ee19db2b 139
kstech 0:e2b0ee19db2b 140 return ( (int)IAP_result[ 0 ] );
kstech 0:e2b0ee19db2b 141 }
kstech 0:e2b0ee19db2b 142
kstech 0:e2b0ee19db2b 143
kstech 0:e2b0ee19db2b 144 /** Copy RAM to Flash
kstech 0:e2b0ee19db2b 145 *
kstech 0:e2b0ee19db2b 146 * @param source_addr Source RAM address from which data bytes are to be read. This address should be a word boundary.
kstech 0:e2b0ee19db2b 147 * @param target_addr Destination flash address where data bytes are to be written. This address should be a 256 byte boundary.
kstech 0:e2b0ee19db2b 148 * @param size Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.
kstech 0:e2b0ee19db2b 149 * @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
kstech 0:e2b0ee19db2b 150 */
kstech 0:e2b0ee19db2b 151
kstech 0:e2b0ee19db2b 152 int IAP::write( char *source_addr, char *target_addr, int size ) {
kstech 0:e2b0ee19db2b 153 IAP_command[ 0 ] = IAPCommand_Copy_RAM_to_Flash;
kstech 0:e2b0ee19db2b 154 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.
kstech 0:e2b0ee19db2b 155 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.
kstech 0:e2b0ee19db2b 156 IAP_command[ 3 ] = size; // Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.
kstech 0:e2b0ee19db2b 157 IAP_command[ 4 ] = cclk_kHz; // CPU Clock Frequency (CCLK) in kHz.
kstech 0:e2b0ee19db2b 158
kstech 0:e2b0ee19db2b 159 iap_entry( IAP_command, IAP_result );
kstech 0:e2b0ee19db2b 160
kstech 0:e2b0ee19db2b 161 return ( (int)IAP_result[ 0 ] );
kstech 0:e2b0ee19db2b 162 }
kstech 0:e2b0ee19db2b 163
kstech 0:e2b0ee19db2b 164
kstech 0:e2b0ee19db2b 165 /** Compare <address1> <address2> <no of bytes>
kstech 0:e2b0ee19db2b 166 *
kstech 0:e2b0ee19db2b 167 * @param source_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
kstech 0:e2b0ee19db2b 168 * @param target_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
kstech 0:e2b0ee19db2b 169 * @param size Number of bytes to be compared; should be a multiple of 4.
kstech 0:e2b0ee19db2b 170 * @return error code: CMD_SUCCESS | COMPARE_ERROR | COUNT_ERROR (Byte count is not a multiple of 4) | ADDR_ERROR | ADDR_NOT_MAPPED
kstech 0:e2b0ee19db2b 171 */
kstech 0:e2b0ee19db2b 172
kstech 0:e2b0ee19db2b 173 int IAP::compare( char *source_addr, char *target_addr, int size ) {
kstech 0:e2b0ee19db2b 174 IAP_command[ 0 ] = IAPCommand_Compare;
kstech 0:e2b0ee19db2b 175 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.
kstech 0:e2b0ee19db2b 176 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.
kstech 0:e2b0ee19db2b 177 IAP_command[ 3 ] = size; // Number of bytes to be compared; should be a multiple of 4.
kstech 0:e2b0ee19db2b 178
kstech 0:e2b0ee19db2b 179 iap_entry( IAP_command, IAP_result );
kstech 0:e2b0ee19db2b 180
kstech 0:e2b0ee19db2b 181 return ( (int)IAP_result[ 0 ] );
kstech 0:e2b0ee19db2b 182 }
kstech 0:e2b0ee19db2b 183
kstech 0:e2b0ee19db2b 184
kstech 0:e2b0ee19db2b 185 /** Get user reserved flash start address
kstech 0:e2b0ee19db2b 186 *
kstech 0:e2b0ee19db2b 187 * @return start address of user reserved flash memory
kstech 0:e2b0ee19db2b 188 * @see reserved_flash_area_size()
kstech 0:e2b0ee19db2b 189 */
kstech 0:e2b0ee19db2b 190
kstech 0:e2b0ee19db2b 191 char * IAP::reserved_flash_area_start( void )
kstech 0:e2b0ee19db2b 192 {
kstech 0:e2b0ee19db2b 193 return ( (char *)USER_FLASH_AREA_START );
kstech 0:e2b0ee19db2b 194 }
kstech 0:e2b0ee19db2b 195
kstech 0:e2b0ee19db2b 196
kstech 0:e2b0ee19db2b 197 /** Get user reserved flash size
kstech 0:e2b0ee19db2b 198 *
kstech 0:e2b0ee19db2b 199 * @return size of user reserved flash memory
kstech 0:e2b0ee19db2b 200 * @see reserved_flash_area_start()
kstech 0:e2b0ee19db2b 201 */
kstech 0:e2b0ee19db2b 202
kstech 0:e2b0ee19db2b 203 int IAP::reserved_flash_area_size( void )
kstech 0:e2b0ee19db2b 204 {
kstech 0:e2b0ee19db2b 205 return ( USER_FLASH_AREA_SIZE );
kstech 0:e2b0ee19db2b 206 }
kstech 0:e2b0ee19db2b 207
kstech 0:e2b0ee19db2b 208 #if defined(TARGET_LPC11U24)
kstech 0:e2b0ee19db2b 209 /** Copy RAM to EEPROM (LPC11U24)
kstech 0:e2b0ee19db2b 210 *
kstech 0:e2b0ee19db2b 211 * @param source_addr Source RAM address from which data bytes are to be read.
kstech 0:e2b0ee19db2b 212 * @param target_addr Destination EEPROM address where data bytes are to be written.
kstech 0:e2b0ee19db2b 213 * @param size Number of bytes to be written.
kstech 0:e2b0ee19db2b 214 * @return error code: CMD_SUCCESS | SRC_ADDR_NOT_MAPPED | DST_ADDR_NOT_MAPPED
kstech 0:e2b0ee19db2b 215 * Remark: The top 64 bytes of the EEPROM memory are reserved and cannot be written to.
kstech 0:e2b0ee19db2b 216 */
kstech 0:e2b0ee19db2b 217 int IAP::write_eeprom( char *source_addr, char *target_addr, int size ) {
kstech 0:e2b0ee19db2b 218 IAP_command[ 0 ] = IAPCommand_EEPROM_Write;
kstech 0:e2b0ee19db2b 219 IAP_command[ 1 ] = (unsigned int)target_addr; // Destination EEPROM address where data bytes are to be written. This address should be a 256 byte boundary.
kstech 0:e2b0ee19db2b 220 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.
kstech 0:e2b0ee19db2b 221 IAP_command[ 3 ] = size; // Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.
kstech 0:e2b0ee19db2b 222 IAP_command[ 4 ] = cclk_kHz; // CPU Clock Frequency (CCLK) in kHz.
kstech 0:e2b0ee19db2b 223
kstech 0:e2b0ee19db2b 224 iap_entry( IAP_command, IAP_result );
kstech 0:e2b0ee19db2b 225
kstech 0:e2b0ee19db2b 226 return ( (int)IAP_result[ 0 ] );
kstech 0:e2b0ee19db2b 227 }
kstech 0:e2b0ee19db2b 228
kstech 0:e2b0ee19db2b 229 /** Copy EEPROM to RAM (LPC11U24)
kstech 0:e2b0ee19db2b 230 *
kstech 0:e2b0ee19db2b 231 * @param source_addr Source EEPROM address from which data bytes are to be read.
kstech 0:e2b0ee19db2b 232 * @param target_addr Destination RAM address where data bytes are to be written.
kstech 0:e2b0ee19db2b 233 * @param size Number of bytes to be written.
kstech 0:e2b0ee19db2b 234 * @return error code: CMD_SUCCESS | SRC_ADDR_NOT_MAPPED | DST_ADDR_NOT_MAPPED
kstech 0:e2b0ee19db2b 235 * Remark: The top 64 bytes of the EEPROM memory are reserved and cannot be written to.
kstech 0:e2b0ee19db2b 236 */
kstech 0:e2b0ee19db2b 237 int IAP::read_eeprom( char *source_addr, char *target_addr, int size ) {
kstech 0:e2b0ee19db2b 238 IAP_command[ 0 ] = IAPCommand_EEPROM_Read;
kstech 0:e2b0ee19db2b 239 IAP_command[ 1 ] = (unsigned int)source_addr; // Source EEPROM address from which data bytes are to be read. This address should be a word boundary.
kstech 0:e2b0ee19db2b 240 IAP_command[ 2 ] = (unsigned int)target_addr; // Destination RAM address where data bytes are to be written. This address should be a 256 byte boundary.
kstech 0:e2b0ee19db2b 241 IAP_command[ 3 ] = size; // Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.
kstech 0:e2b0ee19db2b 242 IAP_command[ 4 ] = cclk_kHz; // CPU Clock Frequency (CCLK) in kHz.
kstech 0:e2b0ee19db2b 243
kstech 0:e2b0ee19db2b 244 iap_entry( IAP_command, IAP_result );
kstech 0:e2b0ee19db2b 245
kstech 0:e2b0ee19db2b 246 return ( (int)IAP_result[ 0 ] );
kstech 0:e2b0ee19db2b 247 }
kstech 0:e2b0ee19db2b 248 #endif