supported LPC11U35

Fork of IAP by Tedd OKANO

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