IAP class library for LPC1768, LPC11U24, LPC1114, LPC1347, LPC1549, LPC812 and LPC824
Fork of IAP by
IAP.cpp
- Committer:
- yuhki50
- Date:
- 2016-05-03
- Revision:
- 10:56f1e488b250
- Parent:
- 9:f33e8f9a3677
File content as of revision 10:56f1e488b250:
/** IAP : internal Flash memory access library
*
* The internal Flash memory access is described in the LPC1768 and LPC11U24 usermanual.
* http://www.nxp.com/documents/user_manual/UM10360.pdf
* http://www.nxp.com/documents/user_manual/UM10462.pdf
*
* LPC1768 --
* Chapter 2: "LPC17xx Memory map"
* Chapter 32: "LPC17xx Flash memory interface and programming"
* refering Rev. 01 - 4 January 2010
*
* LPC11U24 --
* Chapter 2: "LPC11Uxx Memory mapping"
* Chapter 20: "LPC11Uxx Flash programming firmware"
* refering Rev. 03 - 16 July 2012
*
* 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
* revision 2.0 26-Nov-2012 LPC11U24 code added
* revision 2.1 26-Nov-2012 EEPROM access code imported from Suga koubou san's (http://mbed.org/users/okini3939/) library
* http://mbed.org/users/okini3939/code/M0_EEPROM_test/
* revision 3.0 09-Jan-2015 LPC812 and LPC824 support added
* revision 3.1 13-Jan-2015 LPC1114 support added
* revision 3.1.1 16-Jan-2015 Target MCU name changed for better compatibility across the platforms
*/
#include "mbed.h"
#include "IAP.h"
#define USER_FLASH_AREA_START_STR( x ) STR( x )
#define STR( x ) #x
#if not (defined(TARGET_LPC13XX) || defined(TARGET_LPC15XX))
unsigned char user_area[ USER_FLASH_AREA_SIZE ] __attribute__((section( ".ARM.__at_" USER_FLASH_AREA_START_STR( USER_FLASH_AREA_START ) ), zero_init));
#endif
/*
* 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,
#if defined(TARGET_LPC11UXX) || defined(TARGET_LPC13XX) || defined(TARGET_LPC15XX)
IAPCommand_EEPROM_Write = 61,
IAPCommand_EEPROM_Read,
#elif defined(TARGET_LPC81X) || defined(TARGET_LPC82X)
IAPCommand_Erase_page = 59,
#endif
};
int IAP::reinvoke_isp( void ) {
__disable_irq();
IAP_command[ 0 ] = IAPCommand_Reinvoke_ISP;
iap_entry( IAP_command, IAP_result );
return ( (int)IAP_result[ 0 ] );
}
/** 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)
}
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)
}
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 ] );
}
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 ] );
}
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 ] );
}
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 ] );
}
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 ] );
}
int IAP::read_BootVer(void)
{
IAP_command[0] = IAPCommand_Read_Boot_Code_version;
IAP_result[1] = 0; // not sure if in high or low bits.
iap_entry(IAP_command, IAP_result);
return ((int)IAP_result[1]);
}
char * IAP::reserved_flash_area_start( void )
{
return ( (char *)USER_FLASH_AREA_START );
}
int IAP::reserved_flash_area_size( void )
{
return ( USER_FLASH_AREA_SIZE );
}
#if defined(TARGET_LPC11UXX) || defined(TARGET_LPC13XX) || defined(TARGET_LPC15XX)
void IAP::init_eeprom()
{
#if defined(TARGET_LPC15XX)
__disable_irq();
LPC_SYSCON->SYSAHBCLKCTRL0 |= 1 << 9;
LPC_SYSCON->PRESETCTRL0 |= 1 << 9;
LPC_SYSCON->PRESETCTRL0 &= ~(1 << 9);
__enable_irq();
#endif
}
int IAP::write_eeprom( char *source_addr, char *target_addr, int size )
{
init_eeprom();
IAP_command[ 0 ] = IAPCommand_EEPROM_Write;
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.
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 ] );
}
int IAP::read_eeprom( char *source_addr, char *target_addr, int size )
{
init_eeprom();
IAP_command[ 0 ] = IAPCommand_EEPROM_Read;
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.
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.
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 ] );
}
#elif defined(TARGET_LPC81X) || defined(TARGET_LPC82X)
int IAP::erase_page( int start, int end )
{
IAP_command[ 0 ] = IAPCommand_Erase_page;
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 ] );
}
#endif
Taguchi Yuuki
