flash_efc.h

Go to the documentation of this file.

/*
 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
 */

#ifndef FLASH_H_INCLUDED
#define FLASH_H_INCLUDED

#include "compiler.h"
#include "efc.h"


#ifdef __cplusplus
 extern "C" {
#endif


typedef enum flash_rc {
        FLASH_RC_OK = 0,        
        FLASH_RC_YES = 1,       
        FLASH_RC_NO = 0,        
        FLASH_RC_ERROR = 0x10,  
        FLASH_RC_INVALID,       
        FLASH_RC_NOT_SUPPORT = 0xFFFFFFFF    
} flash_rc_t;

typedef enum flash_farg_page_num {
        /* 4 of pages to be erased with EPA command*/
        IFLASH_ERASE_PAGES_4=0,
        /* 8 of pages to be erased with EPA command*/
        IFLASH_ERASE_PAGES_8,
        /* 16 of pages to be erased with EPA command*/
        IFLASH_ERASE_PAGES_16,
        /* 32 of pages to be erased with EPA command*/
        IFLASH_ERASE_PAGES_32,
        /* Parameter is not support */
        IFLASH_ERASE_PAGES_INVALID,
}flash_farg_page_num_t;

#define FLASH_ACCESS_MODE_128    EFC_ACCESS_MODE_128
#define FLASH_ACCESS_MODE_64     EFC_ACCESS_MODE_64

uint32_t flash_init(uint32_t ul_mode, uint32_t ul_fws);
uint32_t flash_set_wait_state(uint32_t ul_address, uint32_t ul_fws);
uint32_t flash_set_wait_state_adaptively(uint32_t ul_address);
uint32_t flash_get_wait_state(uint32_t ul_address);
uint32_t flash_get_descriptor(uint32_t ul_address,
                uint32_t *pul_flash_descriptor, uint32_t ul_size);
uint32_t flash_get_page_count(const uint32_t *pul_flash_descriptor);
uint32_t flash_get_page_count_per_region(const uint32_t *pul_flash_descriptor);
uint32_t flash_get_region_count(const uint32_t *pul_flash_descriptor);
uint32_t flash_erase_all(uint32_t ul_address);

#if (SAM3S8 || SAM3SD8)
uint32_t flash_erase_plane(uint32_t ul_address);
#endif

#if (SAM4S || SAM4E || SAM4N || SAM4C || SAMG || SAM4CP || SAM4CM || \
         SAMV71 || SAMV70 || SAMS70 || SAME70)
uint32_t flash_erase_page(uint32_t ul_address, uint8_t uc_page_num);
uint32_t flash_erase_sector(uint32_t ul_address);
#endif

uint32_t flash_write(uint32_t ul_address, const void *p_buffer,
                uint32_t ul_size, uint32_t ul_erase_flag);
uint32_t flash_lock(uint32_t ul_start, uint32_t ul_end,
                uint32_t *pul_actual_start, uint32_t *pul_actual_end);
uint32_t flash_unlock(uint32_t ul_start, uint32_t ul_end,
                uint32_t *pul_actual_start, uint32_t *pul_actual_end);
uint32_t flash_is_locked(uint32_t ul_start, uint32_t ul_end);
uint32_t flash_set_gpnvm(uint32_t ul_gpnvm);
uint32_t flash_clear_gpnvm(uint32_t ul_gpnvm);
uint32_t flash_is_gpnvm_set(uint32_t ul_gpnvm);
uint32_t flash_enable_security_bit(void);
uint32_t flash_is_security_bit_enabled(void);
uint32_t flash_read_unique_id(uint32_t *pul_data, uint32_t ul_size);

#if (SAM4S || SAM4E || SAM4N || SAM4C || SAMG || SAM4CP || SAM4CM || \
         SAMV71 || SAMV70 || SAMS70 || SAME70)
uint32_t flash_read_user_signature(uint32_t *p_data, uint32_t ul_size);
uint32_t flash_write_user_signature(const void *p_buffer, uint32_t ul_size);
uint32_t flash_erase_user_signature(void);
#endif


#ifdef __cplusplus
}
#endif


#endif /* FLASH_H_INCLUDED */