drivers/efc/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 EFC_H_INCLUDED
#define EFC_H_INCLUDED

#include "compiler.h"


#ifdef __cplusplus
extern "C" {
#endif


typedef enum efc_rc {
        EFC_RC_OK = 0,      
        EFC_RC_YES = 0,     
        EFC_RC_NO = 1,      
        EFC_RC_ERROR = 1,   
        EFC_RC_INVALID,     
        EFC_RC_NOT_SUPPORT = 0xFFFFFFFF 
} efc_rc_t;

#define EFC_FCMD_GETD    0x00  
#define EFC_FCMD_WP      0x01  
#define EFC_FCMD_WPL     0x02  
#define EFC_FCMD_EWP     0x03  
#define EFC_FCMD_EWPL    0x04  
#define EFC_FCMD_EA      0x05  
#if (SAM3S8 || SAM3SD8)
#define EFC_FCMD_EPL     0x06  
#endif
#if (SAM4S || SAM4E || SAM4N || SAM4C || SAMG || SAM4CP || SAM4CM || \
         SAMV71 || SAMV70 || SAMS70 || SAME70)
#define EFC_FCMD_EPA     0x07  
#endif
#define EFC_FCMD_SLB     0x08  
#define EFC_FCMD_CLB     0x09  
#define EFC_FCMD_GLB     0x0A  
#define EFC_FCMD_SGPB    0x0B  
#define EFC_FCMD_CGPB    0x0C  
#define EFC_FCMD_GGPB    0x0D  
#define EFC_FCMD_STUI    0x0E  
#define EFC_FCMD_SPUI    0x0F  
#if (!SAM3U && !SAM3SD8 && !SAM3S8)
#define EFC_FCMD_GCALB   0x10  
#endif
#if (SAM4S || SAM4E || SAM4N || SAM4C || SAMG || SAM4CP || SAM4CM || \
         SAMV71 || SAMV70 || SAMS70 || SAME70)
#define EFC_FCMD_ES      0x11  
#define EFC_FCMD_WUS     0x12  
#define EFC_FCMD_EUS     0x13  
#define EFC_FCMD_STUS    0x14  
#define EFC_FCMD_SPUS    0x15  
#endif

#define CHIP_FLASH_IAP_ADDRESS  (IROM_ADDR + 8)

#define EFC_ACCESS_MODE_128    0
#define EFC_ACCESS_MODE_64     EEFC_FMR_FAM

uint32_t efc_init(Efc *p_efc, uint32_t ul_access_mode, uint32_t ul_fws);
#if (SAM4S || SAM4E || SAM4N || SAM4C || SAMG || SAM4CP || SAM4CM || \
         SAMV71 || SAMV70 || SAMS70 || SAME70)
void efc_enable_cloe(Efc *p_efc);
void efc_disable_cloe(Efc *p_efc);
#endif
void efc_enable_frdy_interrupt(Efc *p_efc);
void efc_disable_frdy_interrupt(Efc *p_efc);
#if (SAMV71 || SAMV70 || SAMS70 || SAME70)
void efc_enable_write_protection(Efc *p_efc);
void efc_disable_write_protection(Efc *p_efc);
#else
void efc_set_flash_access_mode(Efc *p_efc, uint32_t ul_mode);
uint32_t efc_get_flash_access_mode(Efc *p_efc);
#endif
void efc_set_wait_state(Efc *p_efc, uint32_t ul_fws);
uint32_t efc_get_wait_state(Efc *p_efc);
uint32_t efc_perform_command(Efc *p_efc, uint32_t ul_command,
                uint32_t ul_argument);
uint32_t efc_get_status(Efc *p_efc);
uint32_t efc_get_result(Efc *p_efc);
uint32_t efc_perform_read_sequence(Efc *p_efc,
                uint32_t ul_cmd_st, uint32_t ul_cmd_sp,
                uint32_t *p_ul_buf, uint32_t ul_size);


#ifdef __cplusplus
}
#endif


#endif /* EFC_H_INCLUDED */