IAP class library for LPC1768, LPC11U24, LPC1114, LPC812 and LPC824

Dependents:   MakerBotServer SystemManagement IAP_testing Arch_Pro_TCPSocket ... more

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers IAP.h Source File

IAP.h

00001 /**    IAP : internal Flash memory access library
00002  *
00003  *        The internal Flash memory access is described in the LPC1768 and LPC11U24 usermanual.
00004  *            http://www.nxp.com/documents/user_manual/UM10360.pdf
00005  *            http://www.nxp.com/documents/user_manual/UM10462.pdf
00006  *
00007  *               LPC1768 --
00008  *                    Chapter  2: "LPC17xx Memory map"
00009  *                    Chapter 32: "LPC17xx Flash memory interface and programming"
00010  *                    refering Rev. 01 - 4 January 2010
00011  *
00012  *               LPC11U24 --
00013  *                    Chapter  2: "LPC11Uxx Memory mapping"
00014  *                    Chapter 20: "LPC11Uxx Flash programming firmware"
00015  *                    refering Rev. 03 - 16 July 2012
00016  *
00017  *        Released under the MIT License: http://mbed.org/license/mit
00018  *
00019  *        revision 1.0  09-Mar-2010   1st release
00020  *        revision 1.1  12-Mar-2010   chaged: to make possible to reserve flash area for user
00021  *                                            it can be set by USER_FLASH_AREA_START and USER_FLASH_AREA_SIZE in IAP.h
00022  *        revision 2.0  26-Nov-2012   LPC11U24 code added
00023  *        revision 2.1  26-Nov-2012   EEPROM access code imported from Suga koubou san's (http://mbed.org/users/okini3939/) library
00024  *                                            http://mbed.org/users/okini3939/code/M0_EEPROM_test/
00025  *        revision 3.0  09-Jan-2015   LPC812 and LPC824 support added
00026  *        revision 3.1  13-Jan-2015   LPC1114 support added
00027  *        revision 3.1.1 16-Jan-2015  Target MCU name changed for better compatibility across the platforms
00028  *        revision 3.1.2 10-Mar-2015  merged with pull requests. reinvoke_isp() added and modified read_serial() to return a pointer.
00029  *        revision 3.1.3 16-Aug-2018  "write_page" function added for LPC81X/LPC82X
00030  */
00031 
00032 
00033 #ifndef        MBED_IAP
00034 #define        MBED_IAP
00035 
00036 #include    "mbed.h"
00037 
00038 #if defined(TARGET_LPC176X)
00039 
00040 #define     USER_FLASH_AREA_START   FLASH_SECTOR_29
00041 #define     USER_FLASH_AREA_SIZE    (FLASH_SECTOR_SIZE_16_TO_29 * 1)
00042 
00043 /*
00044  *  memory map information is available in next URL also.
00045  *    http://mbed.org/projects/libraries/svn/mbed/trunk/LPC1768/LPC17xx.h
00046  */
00047 
00048 /**    Table for start adress of sectors
00049  *
00050  *        LPC1768 internal flash memory sector numbers and addresses
00051  *
00052  *        LPC1768 flash memory are and sector number/size
00053  *        Table 568 "Sectors in a LPC17xx device", Section 5. "Sector numbers", usermanual
00054  *
00055  *        0x00000000 - 0x0007FFFF        flash (29 sectors)
00056  *
00057  *      Sector0:     0x00000000 - 0x00000FFF        4K
00058  *      Sector1:     0x00001000 - 0x00001FFF        4K
00059  *      Sector2:     0x00002000 - 0x00002FFF        4K
00060  *      Sector3:     0x00003000 - 0x00003FFF        4K
00061  *      Sector4:     0x00004000 - 0x00004FFF        4K
00062  *      Sector5:     0x00005000 - 0x00005FFF        4K
00063  *      Sector6:     0x00006000 - 0x00006FFF        4K
00064  *      Sector7:     0x00007000 - 0x00007FFF        4K
00065  *      Sector8:     0x00008000 - 0x00008FFF        4K
00066  *      Sector9:     0x00009000 - 0x00009FFF        4K
00067  *      Sector10:    0x0000A000 - 0x0000AFFF        4K
00068  *      Sector11:    0x0000B000 - 0x0000BFFF        4K
00069  *      Sector12:    0x0000C000 - 0x0000CFFF        4K
00070  *      Sector13:    0x0000D000 - 0x0000DFFF        4K
00071  *      Sector14:    0x0000E000 - 0x0000EFFF        4K
00072  *      Sector15:    0x0000F000 - 0x0000FFFF        4K
00073  *
00074  *      Sector16:    0x00010000 - 0x00017FFF        32K
00075  *      Sector17:    0x00018000 - 0x0001FFFF        32K
00076  *      Sector18:    0x00020000 - 0x00027FFF        32K
00077  *      Sector19:    0x00028000 - 0x0002FFFF        32K
00078  *      Sector20:    0x00030000 - 0x00037FFF        32K
00079  *      Sector21:    0x00038000 - 0x0003FFFF        32K
00080  *      Sector22:    0x00040000 - 0x00047FFF        32K
00081  *      Sector23:    0x00048000 - 0x0004FFFF        32K
00082  *      Sector24:    0x00050000 - 0x00057FFF        32K
00083  *      Sector25:    0x00058000 - 0x0005FFFF        32K
00084  *      Sector26:    0x00060000 - 0x00067FFF        32K
00085  *      Sector27:    0x00068000 - 0x0006FFFF        32K
00086  *      Sector28:    0x00070000 - 0x00077FFF        32K
00087  *      Sector29:    0x00078000 - 0x0007FFFF        32K
00088  */
00089 
00090 #define     FLASH_SECTOR_0       0x00000000
00091 #define     FLASH_SECTOR_1       0x00001000
00092 #define     FLASH_SECTOR_2       0x00002000
00093 #define     FLASH_SECTOR_3       0x00003000
00094 #define     FLASH_SECTOR_4       0x00004000
00095 #define     FLASH_SECTOR_5       0x00005000
00096 #define     FLASH_SECTOR_6       0x00006000
00097 #define     FLASH_SECTOR_7       0x00007000
00098 #define     FLASH_SECTOR_8       0x00008000
00099 #define     FLASH_SECTOR_9       0x00009000
00100 #define     FLASH_SECTOR_10      0x0000A000
00101 #define     FLASH_SECTOR_11      0x0000B000
00102 #define     FLASH_SECTOR_12      0x0000C000
00103 #define     FLASH_SECTOR_13      0x0000D000
00104 #define     FLASH_SECTOR_14      0x0000E000
00105 #define     FLASH_SECTOR_15      0x0000F000
00106 #define     FLASH_SECTOR_16      0x00010000
00107 #define     FLASH_SECTOR_17      0x00018000
00108 #define     FLASH_SECTOR_18      0x00020000
00109 #define     FLASH_SECTOR_19      0x00028000
00110 #define     FLASH_SECTOR_20      0x00030000
00111 #define     FLASH_SECTOR_21      0x00038000
00112 #define     FLASH_SECTOR_22      0x00040000
00113 #define     FLASH_SECTOR_23      0x00048000
00114 #define     FLASH_SECTOR_24      0x00050000
00115 #define     FLASH_SECTOR_25      0x00058000
00116 #define     FLASH_SECTOR_26      0x00060000
00117 #define     FLASH_SECTOR_27      0x00068000
00118 #define     FLASH_SECTOR_28      0x00070000
00119 #define     FLASH_SECTOR_29      0x00078000
00120 #define     FLASH_SECTOR_SIZE_0_TO_15    ( 4 * 1024)
00121 #define     FLASH_SECTOR_SIZE_16_TO_29   (32 * 1024)
00122 
00123 static char * sector_start_adress[]    = {
00124     (char *)FLASH_SECTOR_0,
00125     (char *)FLASH_SECTOR_1,
00126     (char *)FLASH_SECTOR_2,
00127     (char *)FLASH_SECTOR_3,
00128     (char *)FLASH_SECTOR_4,
00129     (char *)FLASH_SECTOR_5,
00130     (char *)FLASH_SECTOR_6,
00131     (char *)FLASH_SECTOR_7,
00132     (char *)FLASH_SECTOR_8,
00133     (char *)FLASH_SECTOR_9,
00134     (char *)FLASH_SECTOR_10,
00135     (char *)FLASH_SECTOR_11,
00136     (char *)FLASH_SECTOR_12,
00137     (char *)FLASH_SECTOR_13,
00138     (char *)FLASH_SECTOR_14,
00139     (char *)FLASH_SECTOR_15,
00140     (char *)FLASH_SECTOR_16,
00141     (char *)FLASH_SECTOR_17,
00142     (char *)FLASH_SECTOR_18,
00143     (char *)FLASH_SECTOR_19,
00144     (char *)FLASH_SECTOR_20,
00145     (char *)FLASH_SECTOR_21,
00146     (char *)FLASH_SECTOR_22,
00147     (char *)FLASH_SECTOR_23,
00148     (char *)FLASH_SECTOR_24,
00149     (char *)FLASH_SECTOR_25,
00150     (char *)FLASH_SECTOR_26,
00151     (char *)FLASH_SECTOR_27,
00152     (char *)FLASH_SECTOR_28,
00153     (char *)FLASH_SECTOR_29
00154 };
00155 
00156 #elif defined(TARGET_LPC11UXX) || defined(TARGET_LPC11XX)
00157 
00158 #define     USER_FLASH_AREA_START   FLASH_SECTOR_7
00159 #define     USER_FLASH_AREA_SIZE    (FLASH_SECTOR_SIZE * 1)
00160 
00161 /**    Table for start adress of sectors
00162  *
00163  *        LPC11U24 internal flash memory sector numbers and addresses
00164  *
00165  *        LPC11U24 flash memory are and sector number/size
00166  *        Table 334 "LPC11U1x/2x flash sectors", Section 20. "Sector numbers", usermanual
00167  *
00168  *        0x00000000 - 0x00007FFF        flash (8 sectors)
00169  *
00170  *      Sector0:     0x00000000 - 0x00000FFF        4K
00171  *      Sector1:     0x00001000 - 0x00001FFF        4K
00172  *      Sector2:     0x00002000 - 0x00002FFF        4K
00173  *      Sector3:     0x00003000 - 0x00003FFF        4K
00174  *      Sector4:     0x00004000 - 0x00004FFF        4K
00175  *      Sector5:     0x00005000 - 0x00005FFF        4K
00176  *      Sector6:     0x00006000 - 0x00006FFF        4K
00177  *      Sector7:     0x00007000 - 0x00007FFF        4K
00178  */
00179 
00180 #define     FLASH_SECTOR_0       0x00000000
00181 #define     FLASH_SECTOR_1       0x00001000
00182 #define     FLASH_SECTOR_2       0x00002000
00183 #define     FLASH_SECTOR_3       0x00003000
00184 #define     FLASH_SECTOR_4       0x00004000
00185 #define     FLASH_SECTOR_5       0x00005000
00186 #define     FLASH_SECTOR_6       0x00006000
00187 #define     FLASH_SECTOR_7       0x00007000
00188 #define     FLASH_SECTOR_SIZE    (4 * 1024)
00189 
00190 static char * sector_start_adress[]    = {
00191     (char *)FLASH_SECTOR_0,
00192     (char *)FLASH_SECTOR_1,
00193     (char *)FLASH_SECTOR_2,
00194     (char *)FLASH_SECTOR_3,
00195     (char *)FLASH_SECTOR_4,
00196     (char *)FLASH_SECTOR_5,
00197     (char *)FLASH_SECTOR_6,
00198     (char *)FLASH_SECTOR_7,
00199 };
00200 
00201 #elif defined(TARGET_LPC81X) || defined(TARGET_LPC82X)
00202 
00203 #define     USER_FLASH_AREA_START   FLASH_SECTOR_15
00204 #define     USER_FLASH_AREA_SIZE    (FLASH_SECTOR_SIZE * 1)
00205 
00206 /**    Table for start adress of sectors
00207  *
00208  *        LPC812/LPC824 internal flash memory sector numbers and addresses
00209  *
00210  *        0x00000000 - 0x00003FFF        flash (16 sectors for LPC812)
00211  *        0x00000000 - 0x00007FFF        flash (32 sectors for LPC824)
00212  *
00213  *      Sector0:     0x00000000 - 0x000003FF        1K
00214  *      Sector1:     0x00000400 - 0x000007FF        1K
00215  *      Sector2:     0x00000800 - 0x00000BFF        1K
00216  *      Sector3:     0x00000C00 - 0x00000FFF        1K
00217  *      Sector4:     0x00001000 - 0x000013FF        1K
00218  *      Sector5:     0x00001400 - 0x000017FF        1K
00219  *      Sector6:     0x00001800 - 0x00001BFF        1K
00220  *      Sector7:     0x00001C00 - 0x00001FFF        1K
00221  *      Sector8:     0x00002000 - 0x000023FF        1K
00222  *      Sector9:     0x00002400 - 0x000027FF        1K
00223  *      Sector10:    0x00002800 - 0x00002BFF        1K
00224  *      Sector11:    0x00002C00 - 0x00002FFF        1K
00225  *      Sector12:    0x00003000 - 0x000033FF        1K
00226  *      Sector13:    0x00003400 - 0x000037FF        1K
00227  *      Sector14:    0x00003800 - 0x00003BFF        1K
00228  *      Sector15:    0x00003C00 - 0x00003FFF        1K
00229  *      Sector16:    0x00004000 - 0x000043FF        1K  (LPC824 only)
00230  *      Sector17:    0x00004400 - 0x000047FF        1K  (LPC824 only)
00231  *      Sector18:    0x00004800 - 0x00004BFF        1K  (LPC824 only)
00232  *      Sector19:    0x00004C00 - 0x00004FFF        1K  (LPC824 only)
00233  *      Sector20:    0x00005000 - 0x000053FF        1K  (LPC824 only)
00234  *      Sector21:    0x00005400 - 0x000057FF        1K  (LPC824 only)
00235  *      Sector22:    0x00005800 - 0x00005BFF        1K  (LPC824 only)
00236  *      Sector23:    0x00005C00 - 0x00005FFF        1K  (LPC824 only)
00237  *      Sector24:    0x00006000 - 0x000063FF        1K  (LPC824 only)
00238  *      Sector25:    0x00006400 - 0x000067FF        1K  (LPC824 only)
00239  *      Sector26:    0x00006800 - 0x00006BFF        1K  (LPC824 only)
00240  *      Sector27:    0x00006C00 - 0x00006FFF        1K  (LPC824 only)
00241  *      Sector28:    0x00007000 - 0x000073FF        1K  (LPC824 only)
00242  *      Sector29:    0x00007400 - 0x000077FF        1K  (LPC824 only)
00243  *      Sector30:    0x00007800 - 0x00007BFF        1K  (LPC824 only)
00244  *      Sector31:    0x00007C00 - 0x00007FFF        1K  (LPC824 only)
00245  */
00246 
00247 #define     FLASH_SECTOR_0       0x00000000
00248 #define     FLASH_SECTOR_1       0x00000400
00249 #define     FLASH_SECTOR_2       0x00000800
00250 #define     FLASH_SECTOR_3       0x00000C00
00251 #define     FLASH_SECTOR_4       0x00001000
00252 #define     FLASH_SECTOR_5       0x00001400
00253 #define     FLASH_SECTOR_6       0x00001800
00254 #define     FLASH_SECTOR_7       0x00001C00
00255 #define     FLASH_SECTOR_8       0x00002000
00256 #define     FLASH_SECTOR_9       0x00002400
00257 #define     FLASH_SECTOR_10      0x00002800
00258 #define     FLASH_SECTOR_11      0x00002C00
00259 #define     FLASH_SECTOR_12      0x00003000
00260 #define     FLASH_SECTOR_13      0x00003400
00261 #define     FLASH_SECTOR_14      0x00003800
00262 #define     FLASH_SECTOR_15      0x00003C00
00263 #define     FLASH_SECTOR_16      0x00004000     //  for LPC824 only
00264 #define     FLASH_SECTOR_17      0x00004400     //  for LPC824 only
00265 #define     FLASH_SECTOR_18      0x00004800     //  for LPC824 only
00266 #define     FLASH_SECTOR_19      0x00004C00     //  for LPC824 only
00267 #define     FLASH_SECTOR_20      0x00005000     //  for LPC824 only
00268 #define     FLASH_SECTOR_21      0x00005400     //  for LPC824 only
00269 #define     FLASH_SECTOR_22      0x00005800     //  for LPC824 only
00270 #define     FLASH_SECTOR_23      0x00005C00     //  for LPC824 only
00271 #define     FLASH_SECTOR_24      0x00006000     //  for LPC824 only
00272 #define     FLASH_SECTOR_25      0x00006400     //  for LPC824 only
00273 #define     FLASH_SECTOR_26      0x00006800     //  for LPC824 only
00274 #define     FLASH_SECTOR_27      0x00006C00     //  for LPC824 only
00275 #define     FLASH_SECTOR_28      0x00007000     //  for LPC824 only
00276 #define     FLASH_SECTOR_29      0x00007400     //  for LPC824 only
00277 #define     FLASH_SECTOR_30      0x00007800     //  for LPC824 only
00278 #define     FLASH_SECTOR_31      0x00007C00     //  for LPC824 only
00279 #define     FLASH_SECTOR_SIZE    (1 * 1024)
00280 
00281 static char * sector_start_adress[]    = {
00282     (char *)FLASH_SECTOR_0,
00283     (char *)FLASH_SECTOR_1,
00284     (char *)FLASH_SECTOR_2,
00285     (char *)FLASH_SECTOR_3,
00286     (char *)FLASH_SECTOR_4,
00287     (char *)FLASH_SECTOR_5,
00288     (char *)FLASH_SECTOR_6,
00289     (char *)FLASH_SECTOR_7,
00290     (char *)FLASH_SECTOR_8,
00291     (char *)FLASH_SECTOR_9,
00292     (char *)FLASH_SECTOR_10,
00293     (char *)FLASH_SECTOR_11,
00294     (char *)FLASH_SECTOR_12,
00295     (char *)FLASH_SECTOR_13,
00296     (char *)FLASH_SECTOR_14,
00297     (char *)FLASH_SECTOR_15,
00298     (char *)FLASH_SECTOR_16,     //  for LPC824 only
00299     (char *)FLASH_SECTOR_17,     //  for LPC824 only
00300     (char *)FLASH_SECTOR_18,     //  for LPC824 only
00301     (char *)FLASH_SECTOR_19,     //  for LPC824 only
00302     (char *)FLASH_SECTOR_20,     //  for LPC824 only
00303     (char *)FLASH_SECTOR_21,     //  for LPC824 only
00304     (char *)FLASH_SECTOR_22,     //  for LPC824 only
00305     (char *)FLASH_SECTOR_23,     //  for LPC824 only
00306     (char *)FLASH_SECTOR_24,     //  for LPC824 only
00307     (char *)FLASH_SECTOR_25,     //  for LPC824 only
00308     (char *)FLASH_SECTOR_26,     //  for LPC824 only
00309     (char *)FLASH_SECTOR_27,     //  for LPC824 only
00310     (char *)FLASH_SECTOR_28,     //  for LPC824 only
00311     (char *)FLASH_SECTOR_29,     //  for LPC824 only
00312     (char *)FLASH_SECTOR_30,     //  for LPC824 only
00313     (char *)FLASH_SECTOR_31     //  for LPC824 only
00314 };
00315 
00316 #endif
00317 
00318 /**    Error code by IAP routine
00319  *
00320  *        Table 588 "ISP Return Codes Summary", Section 7.15 "ISP Return Codes", usermanual
00321  */
00322 
00323 enum error_code {
00324     CMD_SUCCESS,
00325     INVALID_COMMAND,
00326     SRC_ADDR_ERROR,
00327     DST_ADDR_ERROR,
00328     SRC_ADDR_NOT_MAPPED,
00329     DST_ADDR_NOT_MAPPED,
00330     COUNT_ERROR,
00331     INVALID_SECTOR,
00332     SECTOR_NOT_BLANK,
00333     SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION,
00334     COMPARE_ERROR,
00335     BUSY,
00336     PARAM_ERROR,
00337     ADDR_ERROR,
00338     ADDR_NOT_MAPPED,
00339     CMD_LOCKED,
00340     INVALID_CODE,
00341     INVALID_BAUD_RATE,
00342     INVALID_STOP_BIT,
00343     CODE_READ_PROTECTION_ENABLED
00344 };
00345 
00346 
00347 
00348 /*
00349  *  IAP routine entry
00350  *
00351  *        "IAP commands"
00352  */
00353 
00354 #define     IAP_LOCATION    0x1fff1ff1
00355 typedef     void (*IAP_call)(unsigned int [], unsigned int []);
00356 
00357 
00358 /**    IAP class
00359  *
00360  *        Interface for internal flash memory access
00361  */
00362 
00363 class IAP
00364 {
00365 public:
00366 
00367     /**    Constructor for IAP
00368      *
00369      */
00370     IAP() : iap_entry( reinterpret_cast<IAP_call>(IAP_LOCATION) ), cclk_kHz( SystemCoreClock / 1000 ) {}
00371 
00372     /** Reinvoke ISP
00373      *
00374      *  @return    error code
00375      */
00376     int reinvoke_isp( void );
00377 
00378     /** Read part identification number
00379      *
00380      *  @return    device ID
00381      *  @see       read_serial()
00382      */
00383     int read_ID( void );
00384 
00385     /** Read device serial number
00386      *
00387      *  @return    device serial number
00388      *  @see       read_ID()
00389      */
00390     int *read_serial( void );
00391 
00392     /** Blank check sector(s)
00393      *
00394      *  @param    start    a Start Sector Number
00395      *  @param    end      an End Sector Number (should be greater than or equal to start sector number).
00396      *  @return error code: CMD_SUCCESS | BUSY | SECTOR_NOT_BLANK | INVALID_SECTOR
00397      */
00398     int blank_check( int start, int end );
00399 
00400     /** Erase Sector(s)
00401      *
00402      *  @param    start    a Start Sector Number
00403      *  @param    end      an End Sector Number (should be greater than or equal to start sector number).
00404      *  @return   error code: CMD_SUCCESS | BUSY | SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION | INVALID_SECTOR
00405      */
00406     int erase( int start, int end );
00407 
00408     /** Prepare sector(s) for write operation
00409      *
00410      *  @param    start    a Start Sector Number
00411      *  @param    end      an End Sector Number (should be greater than or equal to start sector number).
00412      *  @return   error code: CMD_SUCCESS | BUSY | INVALID_SECTOR
00413      */
00414     int prepare( int start, int end );
00415 
00416     /** Copy RAM to Flash
00417      *
00418      *  @param    source_addr    Source RAM address from which data bytes are to be read. This address should be a word boundary.
00419      *  @param    target_addr    Destination flash address where data bytes are to be written. This address should be a 256 byte boundary.
00420      *  @param    size           Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.
00421      *  @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
00422      */
00423     int write( char *source_addr, char *target_addr, int size );
00424 
00425     /** Compare <address1> <address2> <no of bytes>
00426      *
00427      *  @param    source_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
00428      *  @param    target_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary.
00429      *  @param    size         Number of bytes to be compared; should be a multiple of 4.
00430      *  @return   error code: CMD_SUCCESS | COMPARE_ERROR | COUNT_ERROR (Byte count is not a multiple of 4) | ADDR_ERROR | ADDR_NOT_MAPPED
00431      */
00432     int compare( char *source_addr, char *target_addr, int size );
00433 
00434     /** Read Boot code version number
00435      *
00436      *  @return   2 bytes of boot code version number
00437      */
00438     int read_BootVer( void );
00439 
00440     /** Get user reserved flash start address
00441      *
00442      *  @return    start address of user reserved flash memory
00443      *  @see       reserved_flash_area_size()
00444      */
00445 
00446     char *reserved_flash_area_start( void );
00447 
00448     /** Get user reserved flash size
00449      *
00450      *  @return    size of user reserved flash memory
00451      *  @see       reserved_flash_area_start()
00452      */
00453     int   reserved_flash_area_size( void );
00454 
00455 #if defined(TARGET_LPC11UXX)
00456 
00457     /** Copy RAM to EEPROM (LPC11U24)
00458      *
00459      *  @param    source_addr    Source RAM address from which data bytes are to be read.
00460      *  @param    target_addr    Destination EEPROM address where data bytes are to be written.
00461      *  @param    size           Number of bytes to be written.
00462      *  @return   error code: CMD_SUCCESS | SRC_ADDR_NOT_MAPPED | DST_ADDR_NOT_MAPPED
00463      *  Remark: The top 64 bytes of the EEPROM memory are reserved and cannot be written to.
00464      */
00465     int write_eeprom( char *source_addr, char *target_addr, int size );
00466 
00467     /** Copy EEPROM to RAM (LPC11U24)
00468      *
00469      *  @param    source_addr    Source EEPROM address from which data bytes are to be read.
00470      *  @param    target_addr    Destination RAM address where data bytes are to be written.
00471      *  @param    size           Number of bytes to be written.
00472      *  @return   error code: CMD_SUCCESS | SRC_ADDR_NOT_MAPPED | DST_ADDR_NOT_MAPPED
00473      *  Remark: The top 64 bytes of the EEPROM memory are reserved and cannot be written to.
00474      */
00475     int read_eeprom( char *source_addr, char *target_addr, int size );
00476 
00477 #elif defined(TARGET_LPC81X) || defined(TARGET_LPC82X)
00478 #define LPC8XX_SCTR_SIZE   1024
00479 #define LPC8XX_PAGE_SIZE   64
00480 
00481     /** Erase page(s) (LPC812, LPC824)
00482      *
00483      *  @param    start    Start page number.
00484      *  @param    end      End page number (should be greater than or equal to start page).
00485      *  @return   error code: CMD_SUCCESS | BUSY | SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION | INVALID_SECTOR
00486      */
00487     int erase_page( int start, int end );
00488 
00489     /** Write page (LPC812, LPC824)
00490      *
00491      *  @param    source_addr   Source EEPROM address from which data bytes are to be read.
00492      *  @param    target_page   Target page number.
00493      *  @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 BUSY | INVALID_SECTOR (error from parepare command)
00494      */
00495     int write_page( char *source_addr, int target_page );
00496 
00497 #endif
00498 
00499 private:
00500     IAP_call        iap_entry;
00501     unsigned int    IAP_command[ 5 ];
00502     unsigned int    IAP_result[ 5 ];
00503     int             cclk_kHz;
00504 }
00505 ;
00506 
00507 #endif    //  #ifndef  MBED_IAP