Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
IAP.cpp
- Committer:
- okano
- Date:
- 2010-03-12
- Revision:
- 0:b802bd2f4cc9
File content as of revision 0:b802bd2f4cc9:
/** IAP : internal Flash memory access library
*
* The internal Flash memory access is described in the LPC1768 usermanual.
* http://www.nxp.com/documents/user_manual/UM10360.pdf
*
* Chapter 2: "LPC17xx Memory map"
* Chapter 32: "LPC17xx Flash memory interface and programming"
* refering Rev. 01 - 4 January 2010
*
* Released under the MIT License: http://mbed.org/license/mit
*
* revision 1.0 09-Mar-2010 1st release
* revision 1.1 12-Mar-2010 chaged: to make possible to reserve flash area for user
* it can be set by USER_FLASH_AREA_START and USER_FLASH_AREA_SIZE in IAP.h
*/
#include "mbed.h"
#include "IAP.h"
#define USER_FLASH_AREA_START_STR( x ) STR( x )
#define STR( x ) #x
unsigned char user_area[ USER_FLASH_AREA_SIZE ] __attribute__((section( ".ARM.__at_" USER_FLASH_AREA_START_STR( USER_FLASH_AREA_START ) ), zero_init));
/*
* Reserve of flash area is explained by Igor. Please refer next URL
* http://mbed.org/users/okano/notebook/iap-in-application-programming-internal-flash-eras/?page=1#comment-271
*/
//unsigned char user_area[ size ] __attribute__((section(".ARM.__at_0x78000"), zero_init));
/*
* IAP command codes
* Table 589. "IAP Command Summary", Chapter 8. "IAP commands", usermanual
*/
enum command_code
{
IAPCommand_Prepare_sector_for_write_operation = 50,
IAPCommand_Copy_RAM_to_Flash,
IAPCommand_Erase_sector,
IAPCommand_Blank_check_sector,
IAPCommand_Read_part_ID,
IAPCommand_Read_Boot_Code_version,
IAPCommand_Compare,
IAPCommand_Reinvoke_ISP,
IAPCommand_Read_device_serial_number
};
/** Read part identification number
*
* @return device ID
* @see read_serial()
*/
int IAP::read_ID( void ) {
IAP_command[ 0 ] = IAPCommand_Read_part_ID;
iap_entry( IAP_command, IAP_result );
// return ( (int)IAP_result[ 0 ] );
return ( (int)IAP_result[ 1 ] ); // to return the number itself (this command always returns CMD_SUCCESS)
}
/** Read device serial number
*
* @return device serial number
* @see read_ID()
*/
int IAP::read_serial( void ) {
IAP_command[ 0 ] = IAPCommand_Read_device_serial_number;
iap_entry( IAP_command, IAP_result );
// return ( (int)IAP_result[ 0 ] );
return ( (int)IAP_result[ 1 ] ); // to return the number itself (this command always returns CMD_SUCCESS)
}
/** Blank check sector(s)
*
* @param start a Start Sector Number
* @param end an End Sector Number (should be greater than or equal to start sector number).
* @return error code: CMD_SUCCESS | BUSY | SECTOR_NOT_BLANK | INVALID_SECTOR
*/
int IAP::blank_check( int start, int end ) {
IAP_command[ 0 ] = IAPCommand_Blank_check_sector;
IAP_command[ 1 ] = (unsigned int)start; // Start Sector Number
IAP_command[ 2 ] = (unsigned int)end; // End Sector Number (should be greater than or equal to start sector number)
iap_entry( IAP_command, IAP_result );
return ( (int)IAP_result[ 0 ] );
}
/** Erase Sector(s)
*
* @param start a Start Sector Number
* @param end an End Sector Number (should be greater than or equal to start sector number).
* @return error code: CMD_SUCCESS | BUSY | SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION | INVALID_SECTOR
*/
int IAP::erase( int start, int end ) {
IAP_command[ 0 ] = IAPCommand_Erase_sector;
IAP_command[ 1 ] = (unsigned int)start; // Start Sector Number
IAP_command[ 2 ] = (unsigned int)end; // End Sector Number (should be greater than or equal to start sector number)
IAP_command[ 3 ] = cclk_kHz; // CPU Clock Frequency (CCLK) in kHz
iap_entry( IAP_command, IAP_result );
return ( (int)IAP_result[ 0 ] );
}
/** Prepare sector(s) for write operation
*
* @param start a Start Sector Number
* @param end an End Sector Number (should be greater than or equal to start sector number).
* @return error code: CMD_SUCCESS | BUSY | INVALID_SECTOR
*/
int IAP::prepare( int start, int end ) {
IAP_command[ 0 ] = IAPCommand_Prepare_sector_for_write_operation;
IAP_command[ 1 ] = (unsigned int)start; // Start Sector Number
IAP_command[ 2 ] = (unsigned int)end; // End Sector Number (should be greater than or equal to start sector number).
iap_entry( IAP_command, IAP_result );
return ( (int)IAP_result[ 0 ] );
}
/** Copy RAM to Flash
*
* @param source_addr Source RAM address from which data bytes are to be read. This address should be a word boundary.
* @param target_addr Destination flash address where data bytes are to be written. This address should be a 256 byte boundary.
* @param size Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.
* @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
*/
int IAP::write( char *source_addr, char *target_addr, int size ) {
IAP_command[ 0 ] = IAPCommand_Copy_RAM_to_Flash;
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.
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.
IAP_command[ 3 ] = size; // Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.
IAP_command[ 4 ] = cclk_kHz; // CPU Clock Frequency (CCLK) in kHz.
iap_entry( IAP_command, IAP_result );
return ( (int)IAP_result[ 0 ] );
}
/** Compare <address1> <address2> <no of bytes>
*
* @param source_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
* @param target_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
* @param size Number of bytes to be compared; should be a multiple of 4.
* @return error code: CMD_SUCCESS | COMPARE_ERROR | COUNT_ERROR (Byte count is not a multiple of 4) | ADDR_ERROR | ADDR_NOT_MAPPED
*/
int IAP::compare( char *source_addr, char *target_addr, int size ) {
IAP_command[ 0 ] = IAPCommand_Compare;
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.
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.
IAP_command[ 3 ] = size; // Number of bytes to be compared; should be a multiple of 4.
iap_entry( IAP_command, IAP_result );
return ( (int)IAP_result[ 0 ] );
}
/** Get user reserved flash start address
*
* @return start address of user reserved flash memory
* @see reserved_flash_area_size()
*/
char * IAP::reserved_flash_area_start( void )
{
return ( (char *)USER_FLASH_AREA_START );
}
/** Get user reserved flash size
*
* @return size of user reserved flash memory
* @see reserved_flash_area_start()
*/
int IAP::reserved_flash_area_size( void )
{
return ( USER_FLASH_AREA_SIZE );
}
IAP (In-Application Programming)