iap_fkt.c

/*

Andreas Weschenfelder

22.07.07

IAP-Functions

*/

#include <stdio.h>

/*

 * Choose sector and address

 *

 * The sector address depends on the processor type.

 * The LPC213x uses 4KB for the first 8 sectors, all

 * others use 8KB. If sector is <8, then the address

 * is sector*0x2000 (sector*0x1000 for the LPC213x).

 */

#define SECT  7

#ifdef lc2138    //-> =2148? -> nachschauen

#define ADDR  0x7000

#else

  #ifdef lc2148

  #define ADDR  0x7000

  #else

  #define ADDR  0xe000

  #endif

#endif

//#define _XTAL 12000000    

//in khz?!?

#define _XTAL 12000

//IAP-Commands

#define  PREPARE_SECTOR_FOR_WRITE_OPERATION  50

#define  COPY_RAM_TO_FLASH          51

#define  ERASE_SECTOR            52

#define  BLANK_CHECK_SECTOR          53

#define READ_PART_ID            54

#define  READ_BOOT_CODE_VERSION        55

#define COMPARE                56  

//ISP_READ_MEMORY_CMD

//ISP_Go <address> <mode>

//PartIDs

#define PART_ID_LPC2141 0x0402FF01

#define PART_ID_LPC2142 0x0402FF11 

#define PART_ID_LPC2144 0x0402FF12 

#define PART_ID_LPC2146 0x0402FF23 

#define PART_ID_LPC2148 0x0402FF25 

//IAP-Status-Codes

#define CMD_SUCCESS      0   //Command is executed successfully.

#define INVALID_COMMAND   1  //Invalid command.

#define SRC_ADDR_ERROR     2  //Source address is not on a word boundary.

#define DST_ADDR_ERROR     3  //Destination address is not on a correct boundary.

#define SRC_ADDR_NOT_MAPPED 4  //Source address is not mapped in the memory map. Count value is taken in to consideration where applicable.

#define DST_ADDR_NOT_MAPPED 5  //Destination address is not mapped in the memory map. Count value is taken in to consideration where applicable.

#define COUNT_ERROR     6  //Byte count is not multiple of 4 or is not a permitted value.

#define INVALID_SECTOR     7  //Sector number is invalid

#define SECTOR_NOT_BLANK   8  //Sector is not blank.

#define SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION 9  //Command to prepare sector for write operation was not executed.

#define COMPARE_ERROR     10  //Source and destination data is not same.

#define BUSY         11  //Flash programming hardware interface is busy

static unsigned long iap_cmd[5];      // IAP command table

static unsigned long iap_res[3];      //     result  table

static long iap(long code, long p1, long p2, long p3, long p4);

static void part_id(void);

static void s_write(void);

static void s_erase(void);

long blank_check_sector(long tmp_sect1, long tmp_sect2);

long compare(long tmp_adr_dst,long tmp_adr_src, long tmp_size);

long erase(long tmp_sect1, long tmp_sect2 );

long copy_ram_to_flash( long tmp_adr_dst,long tmp_adr_src, long tmp_size );

long prepare_sector( long tmp_sect1, long tmp_sect2 );

long read_boot_code_version(void);

void _pll_off(void);

void _pll_on(void) ;

/*

 * Call IAP function.

 *

 * Note: Direct XTAL mode is required

 * for IAP functions (PLL turned off)!

 *

 * Return status.

 */

static long iap(long code, long p1, long p2, long p3, long p4)

{

iap_cmd[0] = code;        // set command code

iap_cmd[1] = p1;        //     1st param

iap_cmd[2] = p2;        //     2nd param

iap_cmd[3] = p3;        //     3rd param

iap_cmd[4] = p4;        //     4th param

//TODO

// Sicher stellen, dass alle daten uebertragen wurden; 

// wird hier mit der warteschleife mit UART-Interrupt gemacht...

//  while (!(Intern_u0lsr&0x40)) ;      // transmit last char

_pll_off();          // disconnect PLL

((void (*)())0x7ffffff1)(iap_cmd, iap_res);  // IAP entry point

_pll_on();          // re-connect PLL

return *iap_res;        // return status

}

/*Read part ID.

Input:      Command:  code: 54

Parameters:   None

Return:      Code CMD_SUCCESS |

Result:      Result0: Part Identification Number (see Table 21–302 “LPC214x Part Identification numbers” on page 307 for details)

Description:  This command is used to read the part identification number.

*/

static void part_id(void)

{

if (iap(READ_PART_ID, 0, 0, 0, 0)) 

  {

  putstring_serial0("\n\r-- Error - Reading part ID --\n\r");

  return;

  }

if (iap_res[1]==PART_ID_LPC2148)

  {putstring_serial0("\n\rPart ID: LPC2148\n\r");}

  else

  {

  putstring_serial0("\n\rPart ID (no LPC2148): ");

  put_int2str(iap_res[1]);

  putstring_serial0("\n\r");

  }

}

/*Read boot code version.

Input:      Command:  code: 55

Parameters:   None

Return:      Code CMD_SUCCESS |

Result:      Result0: 2 bytes of boot code version number in ASCII format. It is to be interpreted as <byte1(Major)>.<byte0(Minor)>

Description:  This command is used to read the boot code version number.

*/

long read_boot_code_version(void)

{

return iap(READ_BOOT_CODE_VERSION, 0, 0, 0, 0);

}

static void version(void)

{

if (read_boot_code_version()) 

  {

  putstring_serial0("-- Error - Reading boot code version --");

  return;

  }

putstring_serial0("\n\rBoot code version: ");

put_int2str((unsigned char)(iap_res[1]>>8));

putstring_serial0(".");

put_int2str((unsigned char)iap_res[1]);

putstring_serial0("\n\r");

}

/*

 * Write sector.

 */

static void s_write(void)

{

static char data[512] = {'T','E','S','T'};      // data buffer

// If not blank, dump sector data.

if (iap(BLANK_CHECK_SECTOR, SECT, SECT, 0, 0) == SECTOR_NOT_BLANK) 

  {

  putstring_serial0("\nSector not blank!\n");

  return;

  }

putstring_serial0("\n\rEnter data (single RETURN to abort):");

if (prepare_sector( SECT, SECT ))

  {

  putstring_serial0("\n\r-- Error: PREPARE_SECTOR_FOR_WRITE_OPERATION: ");

  return;

  }

if (copy_ram_to_flash( ADDR, (long)data, sizeof(data)))

  {

  putstring_serial0("\n\r-- Error: COPY_RAM_TO_FLASH: ");

  put_int2str((int)copy_ram_to_flash( ADDR, (long)data, sizeof(data)));

  putstring_serial0(" --\n\r");

  return;

  }

if (compare(ADDR,(long)data, sizeof(data)))

  {

  putstring_serial0("\n\r-- Error: COMPARE --\n\r");

  return;

  }

putstring_serial0("\n\rData successfully written.\n\r");

}

/*Copy Ram to Flash

Input:       Command:   code: 51

        Param0:    (DST): Destination Flash address where data bytes are to be written. This address should be a 256 byte boundary.

        Param1:    (SRC): Source RAM address from which data bytes are to be read. This address should be a word boundary.

        Param2:   Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.

        Param3:   System Clock Frequency (CCLK) in kHz.

Return:      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 |

Result:      None

Description:  This command is used to program the flash memory. The affected sectors should

        be prepared first by calling "Prepare Sector for Write Operation" command. The

        affected sectors are automatically protected again once the copy command is

        successfully executed. The boot sector can not be written by this command.

*/

long copy_ram_to_flash( long tmp_adr_dst,long tmp_adr_src, long tmp_size )

{

return iap(COPY_RAM_TO_FLASH, tmp_adr_dst, tmp_adr_src, tmp_size, _XTAL);

}

/*Compare

Input:      Command:  code: 56

        Param0:    (DST): Starting Flash or RAM address of data bytes to be compared. This address should be a word boundary.

        Param1:    (SRC): Starting Flash or RAM address of data bytes to be compared. This address should be a word boundary.

        Param2:    Number of bytes to be compared; should be a multiple of 4.

Return:      Code CMD_SUCCESS |

        COMPARE_ERROR |

        COUNT_ERROR (Byte count is not a multiple of 4) |

        ADDR_ERROR |

        ADDR_NOT_MAPPED

Result:      Result0: Offset of the first mismatch if the Status Code is COMPARE_ERROR.

Description:  This command is used to compare the memory contents at two locations.

        The result may not be correct when the source or destination includes any

        of the first 64 bytes starting from address zero. The first 64 bytes can be

        re-mapped to RAM.

*/

long compare(long tmp_adr_dst,long tmp_adr_src, long tmp_size)

{

return iap(COMPARE, tmp_adr_dst, tmp_adr_src, tmp_size, 0);

} 

// Erase sector.

static void s_erase(void)

{

// If blank, skip erase.

if (!blank_check_sector(SECT,SECT))

  {

  putstring_serial0("\n\rSector already blank!\n\r");

  return;

  }

if (prepare_sector( SECT, SECT ))

  {putstring_serial0("\n\r-- Error: PREPARE_SECTOR_FOR_WRITE_OPERATION --\n\r");

  return;}

if (erase( SECT, SECT ))

  {putstring_serial0("\n\r-- Error: ERASE_SECTOR --\n\r");

  return;}

if (blank_check_sector(SECT,SECT)) 

  {putstring_serial0("\n\r-- Error: BLANK_CHECK_SECTOR --\n\r");

  return;}

putstring_serial0("\n\rSector successfully erased.\n\r");

}

/*Prepare sector(s) for write operation

Input:      Command:  code: 50

        Param0:    Start Sector Number

        Param1:    End Sector Number (should be greater than or equal to start sector number).

Return       Code CMD_SUCCESS |

        BUSY |

        INVALID_SECTOR

Result       None

Description:   This command must be executed before executing "Copy RAM to Flash" or

        "Erase Sector(s)" command. Successful execution of the "Copy RAM to Flash" or

        "Erase Sector(s)" command causes relevant sectors to be protected again. The

        boot sector can not be prepared by this command.

*/

long prepare_sector( long tmp_sect1, long tmp_sect2 )

{

return iap(PREPARE_SECTOR_FOR_WRITE_OPERATION, tmp_sect1, tmp_sect2, 0, 0);

}

/*erase

Input:        Command:   code: 52

          Param0:    Start Sector Number

          Param1:   End Sector Number (should be greater than or equal to start sector number).

          Param2:   System Clock Frequency (CCLK) in kHz.

Return:        Code CMD_SUCCESS |

          BUSY |

          SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION |

          INVALID_SECTOR

Result:        None

Description:    This command is used to erase a sector or multiple sectors of on-chip Flash

          memory. The boot sector can not be erased by this command.

*/

long erase(long tmp_sect1, long tmp_sect2 )

{

return iap(ERASE_SECTOR, tmp_sect1, tmp_sect2, _XTAL, 0);

}

/*Blank Check Sector

Input:        Command:  code: 53

          Param0:   Start Sector Number

          Param1:   End Sector Number (should be greater than or equal to start sector number).

Return:        Code CMD_SUCCESS |

          BUSY |

          SECTOR_NOT_BLANK |

          INVALID_SECTOR

Result:        Result0:   Offset of the first non blank word location if the Status Code is SECTOR_NOT_BLANK.

          Result1:   Contents of non blank word location.

Description:    This command is used to blank check a sector or multiple sectors of on-chip Flash

          memory. To blank check a single sector use the same "Start" and "End" sector numbers.

*/

long blank_check_sector(long tmp_sect1, long tmp_sect2)

{

return iap(BLANK_CHECK_SECTOR, tmp_sect1, tmp_sect2, 0, 0);

}

/*

 * Switch CPU to standard XTAL

 */

void _pll_off(void) 

{

//TODO

  PLLCON = 0x00;

  feed();

}

/*

 * Switch to Original CPU-XTAL

 */

void _pll_on(void) 

{

//TODO

  // Enabling the PLL */  

  PLLCON = 0x1;

  feed();

  // Wait for the PLL to lock to set frequency

  while(!(PLLSTAT & 0x400)) ;

  // Connect the PLL as the clock source

  PLLCON = 0x3;

  feed();

}