flash_001.h

Go to the documentation of this file.

/*
 * @brief  Flash/EEPROM programming
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __FLASH_EEPROM_001_H
#define __FLASH_EEPROM_001_H

#include "sys_config.h"
#include "cmsis.h"

#ifdef __cplusplus
extern "C" {
#endif

#if defined(CHIP_LPC1347)
#define ERASE_PAGE_SUPPORT
#define EEPROM_RW_SUPPORT
#endif

#define FLASH_PARAMETER_NUM     (5)

#define FLASH_RESULT_NUM        (4)

typedef void (*FLASH_ENTRY_T)(unsigned int[], unsigned int[]);

typedef enum {
 FLASH_PREPARE = 50,    
 FLASH_COPY_RAM_TO_FLASH = 51, 
 FLASH_ERASE = 52,    
 FLASH_BLANK_CHECK = 53,   
 FLASH_READ_PART_ID = 54,  
 FLASH_READ_BOOT_VER = 55,  
 FLASH_COMPARE = 56,    
 FLASH_REINVOKE_ISP = 57,  
 FLASH_READ_UID = 58,   
#if defined(ERASE_PAGE_SUPPORT)
 FLASH_ERASE_PAGE = 59,   
#endif
#if defined(EEPROM_RW_SUPPORT)
 FLASH_EEPROM_WRITE = 61,  
 FLASH_EEPROM_READ = 62,   
#endif
}  FLASH_CMD_CODE_T;

typedef enum {
 CMD_SUCCESS,    
 INVALID_COMMAND,   
 SRC_ADDR_ERROR,    
 DST_ADDR_ERROR,    
 SRC_ADDR_NOT_MAPPED,  
 DST_ADDR_NOT_MAPPED,  
 COUNT_ERROR,    
 INVALID_SECTOR,    
 SECTOR_NOT_BLANK,    
 SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION, 
 COMPARE_ERROR,    
 BUSY,      
} FLASH_STATUS_CODE_T;

typedef struct {
 uint32_t cmd;   
 uint32_t pParams[FLASH_PARAMETER_NUM]; 
} FLASH_COMMAND_T;

typedef struct {
 uint32_t status;  
 uint32_t pResult[FLASH_RESULT_NUM];  
} FLASH_OUTPUT_T;

/* Flash Programming Command Description
   Command                  Parameters              Return Code                                 Result
   ----------------------------------------------------------------------------------------------------------
   FLASH_PREPARE            Start Sector Number     CMD_SUCCESS                                 None
                            End Sector Number       BUSY
                                                    INVALID_SECTOR
   FLASH_COPY_RAM2FLASH     Destination Flash Addr  CMD_SUCCESS                                 None
                            Source RAM Addr         SRC_ADDR_ERROR
                            Number of bytes written SRC_ADDR_NOT_MAPPED
                            CCLK in kHz             DST_ADDR_NOT_MAPPED
                                                    COUNT_ERROR
                                                    SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION
                                                    BUSY
   FLASH_ERASE              Start Sector Number     CMD_SUCCESS                                 None
                            Emd Sector Number       BUSY
                            CCLK in kHz             SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION
                                                    INVALID_SECTOR
   FLASH_BLANK_CHECK        Start Sector Number     CMD_SUCCESS                                 Non Blank Sector Offset(if Status code is SECTOR_NOT_BLANK)
                            End Sector Number       BUSY                                        Content of non blank word location
                                                    SECTOR_NOT_BLANK
                                                    INVALID_SECTOR
   FLASH_READ_PART_ID       None                    CMD_SUCCESS                                 Part ID
   FLASH_READ_BOOT_VER      None                    CMD_SUCCESS                                 <byte1(Major)>.<byte0(Minor)>
   FLASH_COMPARE            Destination Addr        CMD_SUCCESS                                 Offset of the first mismatch
                            Source Address          COMPARE_ERROR
                            Number of bytes compared COUNT_ERROR
                                                    ADDR_ERROR
                                                    ADDR_NOT_MAPPED
   FLASH_REINVOKE_ISP       None                    None                                        None
   FLASH_READ_UID           None                    CMD_SUCCESS                                 The first 32-bit word
                                                                                                The second 32-bit word.
                                                                                                The third 32-bit word.
                                                                                                The fourth 32-bit word
   FLASH_ERASE_PAGE         Start Page Number       CMD_SUCCESS                                 None
                            End Page Number         BUSY
                            CCLK in kHz             SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION
                                                    INVALID_SECTOR
   FLASH_EEPROM_WRITE       EEPROM Addr             CMD_SUCCESS                                 None
                            RAM Addr                SRC_ADDR_NOT_MAPPED
                            Number of bytes written DST_ADDR_NOT_MAPPED
                            CCLK in kHz
   FLASH_EEPROM_READ        EEPROM Addr             CMD_SUCCESS                                 None
                            RAM Addr                SRC_ADDR_NOT_MAPPED
                            Number of bytes read    DST_ADDR_NOT_MAPPED
                            CCLK in kHz
 */

STATIC INLINE void IP_FLASH_Execute(FLASH_ENTRY_T entry, FLASH_COMMAND_T *pCommand, FLASH_OUTPUT_T *pOutput)
{
 (entry) ((unsigned int *) pCommand, (unsigned int *) pOutput);
}

typedef struct {
 uint32_t cmd;  
 uint32_t start;  
 uint32_t end;  
} FLASH_PREPARE_SECTORS_COMMAND_T;

typedef struct {
 uint32_t status;   
} FLASH_PREPARE_SECTORS_OUTPUT_T;

typedef struct {
 uint32_t cmd;  
 uint32_t dst;  
 uint32_t src;  
 uint32_t byteNum; 
 uint32_t cclk;  
} FLASH_COPY_RAM_TO_FLASH_COMMAND_T;

typedef struct {
 uint32_t status;   
} FLASH_COPY_RAM_TO_FLASH_OUTPUT_T;

typedef struct {
 uint32_t cmd;  
 uint32_t start;  
 uint32_t end;  
 uint32_t cclk;  
} FLASH_ERASE_SECTORS_COMMAND_T;

typedef struct {
 uint32_t status;   
} FLASH_ERASE_SECTORS_OUTPUT_T;

typedef struct {
 uint32_t cmd;  
 uint32_t start;  
 uint32_t end;  
} FLASH_BLANK_CHECK_SECTORS_COMMAND_T;

typedef struct {
 uint32_t status;   
 uint32_t firstNonBlankLoc; 
 uint32_t firstNonBlankVal; 
} FLASH_BLANK_CHECK_SECTORS_OUTPUT_T;

typedef struct {
 uint32_t cmd;  
} FLASH_READ_PART_ID_COMMAND_T;

typedef struct {
 uint32_t status; 
 uint32_t partID; 
} FLASH_READ_PART_ID_OUTPUT_T;

typedef struct {
 uint32_t cmd;  
} FLASH_READ_BOOTCODE_VER_COMMAND_T;

typedef struct {
 uint32_t status; 
 uint8_t minor;  
 uint8_t major;  
} FLASH_READ_BOOTCODE_VER_OUTPUT_T;

typedef struct {
 uint32_t cmd;  
 uint32_t dst;  
 uint32_t src;  
 uint32_t byteNum; 
} FLASH_COMPARE_MEM_COMMAND_T;

typedef struct {
 uint32_t status; 
 uint32_t offset; 
} FLASH_COMPARE_MEM_OUTPUT_T;

typedef struct {
 uint32_t cmd;  
} FLASH_REINVOKE_ISP_COMMAND_T;

typedef struct {
 uint32_t status; 
} FLASH_REINVOKE_ISP_OUTPUT_T;

typedef struct {
 uint32_t cmd;  
} FLASH_READ_UID_COMMAND_T;

typedef struct {
 uint32_t status; 
 uint32_t id[4];  
} FLASH_READ_UID_OUTPUT_T;

#if defined(ERASE_PAGE_SUPPORT)

typedef struct {
 uint32_t cmd;  
 uint32_t start;  
 uint32_t end;  
 uint32_t cclk;  
} FLASH_ERASE_PAGES_COMMAND_T;

typedef struct {
 uint32_t status; 
} FLASH_ERASE_PAGES_OUTPUT_T;

#endif /* defined(ERASE_PAGE_SUPPORT) */

#if defined(EEPROM_RW_SUPPORT)

typedef struct {
 uint32_t cmd;   
 uint32_t eepromAddr; 
 uint32_t ramAddr;  
 uint32_t byteNum;  
 uint32_t cclk;   
} EEPROM_WRITE_COMMAND_T;

typedef struct {
 uint32_t status; 
} EEPROM_WRITE_OUTPUT_T;

typedef struct {
 uint32_t cmd;  
 uint32_t eepromAddr; 
 uint32_t ramAddr;  
 uint32_t byteNum;  
 uint32_t cclk;   
} EEPROM_READ_COMMAND_T;

typedef struct {
 uint32_t status; 
} EEPROM_READ_OUTPUT_T;

#endif /* defined(EEPROM_RW_SUPPORT) */

#ifdef __cplusplus
}
#endif

#endif /* __FLASH_EEPROM_001_H */