Diff: IAP.cpp

Revision:

7:c8bf974ecb33

Parent:

6:f794a51897b8

Parent:

4:cee1a2a734c9

Child:

8:1d79b2bb1131

--- a/IAP.cpp	Mon Sep 29 23:03:30 2014 +0000
+++ b/IAP.cpp	Tue Mar 10 04:19:23 2015 +0000
@@ -1,6 +1,6 @@
 /**    IAP : internal Flash memory access library
  *
- *        The internal Flash memory access is described in the LPC1768 and LPC11U24 usermanual. 
+ *        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
  *
@@ -8,12 +8,12 @@
  *                    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
@@ -22,6 +22,9 @@
  *        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"
@@ -32,12 +35,11 @@
 
 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));
 
 /*
@@ -45,28 +47,23 @@
  *  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_LPC11U24)
-            IAPCommand_EEPROM_Write = 61,
-            IAPCommand_EEPROM_Read,
+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)
+    IAPCommand_EEPROM_Write = 61,
+    IAPCommand_EEPROM_Read,
+#elif defined(TARGET_LPC81X) || defined(TARGET_LPC82X)
+    IAPCommand_Erase_page = 59,
 #endif
-        };
-
-
-/** Reinvoke ISP
- *
- *  @return    error code
- */
+};
 
 int IAP::reinvoke_isp( void ) {
     __disable_irq();
@@ -78,29 +75,21 @@
     return ( (int)IAP_result[ 0 ] );
 }
 
-
 /** Read part identification number
  *
  *  @return    device ID
  *  @see       read_serial()
  */
-
-int IAP::read_ID( void ) {
+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;
     
@@ -110,15 +99,8 @@
     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 ) {
+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)
@@ -128,15 +110,8 @@
     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 ) {
+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)
@@ -147,34 +122,19 @@
     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 ) {
+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 ) {
+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.
@@ -186,16 +146,8 @@
     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 ) {
+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.
@@ -206,82 +158,64 @@
     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::read_BootVer(void) {
+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]);
 }
 
-/** 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 );
 }
 
-#if defined(TARGET_LPC11U24)
-/** Copy RAM to EEPROM (LPC11U24)
- *  
- *  @param    source_addr    Source RAM address from which data bytes are to be read.
- *  @param    target_addr    Destination EEPROM address where data bytes are to be written.
- *  @param    size           Number of bytes to be written.
- *  @return   error code: CMD_SUCCESS | SRC_ADDR_NOT_MAPPED | DST_ADDR_NOT_MAPPED
- *  Remark: The top 64 bytes of the EEPROM memory are reserved and cannot be written to.
- */
-int IAP::write_eeprom( char *source_addr, char *target_addr, int size ) {
+#if defined(TARGET_LPC11UXX)
+
+int IAP::write_eeprom( char *source_addr, char *target_addr, int size )
+{
     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 ] );
 }
- 
-/** Copy EEPROM to RAM (LPC11U24)
- *  
- *  @param    source_addr    Source EEPROM address from which data bytes are to be read.
- *  @param    target_addr    Destination RAM address where data bytes are to be written.
- *  @param    size           Number of bytes to be written.
- *  @return   error code: CMD_SUCCESS | SRC_ADDR_NOT_MAPPED | DST_ADDR_NOT_MAPPED
- *  Remark: The top 64 bytes of the EEPROM memory are reserved and cannot be written to.
- */
-int IAP::read_eeprom( char *source_addr, char *target_addr, int size ) {
+
+int IAP::read_eeprom( char *source_addr, char *target_addr, int size )
+{
     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