Tedd OKANO / Mbed 2 deprecated __IAP_sector28write

IAP program sample to write sector28 (address 0x00070000)

Dependencies:   mbed

IAP.cpp@0:34dda9d8ed01, 2012-01-20 (annotated)

Committer:
okano
Date:
Fri Jan 20 08:56:34 2012 +0000
Revision:
0:34dda9d8ed01
Just a sample to confirm the behavior

Who changed what in which revision?

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