HYPERBUS Driver API/interface file.
Go to the source code of this file.
Data Structures | |
struct | HYPERBUS_MemCfg |
Memory Configuration Structure. More... | |
struct | HYPERBUS_fssDataIf |
FSS Data Interface Structure. More... | |
struct | HYPERBUS_fssHandle |
FSS Handle Structure. More... | |
struct | HYPERBUS_MemTiming |
Register structure for the Memory Timing Register. More... | |
struct | HYPERBUS_Attrs |
HYPERBUS instance attributes - used during init time. More... | |
struct | HYPERBUS_Object |
HYPERBUS driver object. More... | |
struct | HYPERBUS_Config |
HYPERBUS driver configuration structure. More... | |
Macros | |
#define | HYPERBUS_MEM_OFFSET 0U |
Memory offset for HYPERBUS controller. More... | |
#define | HYPERBUS_MCR_CONFIGURABLE_CS_LOW_TIME 0x1U |
Memory Configuration Register defines. More... | |
#define | HYPERBUS_MCR_NO_CONFIGURABLE_CS_LOW_TIME 0x0U |
#define | HYPERBUS_MCR_MAXLEN_2_BYTE 0x0U |
Maximum Length defines. More... | |
#define | HYPERBUS_MCR_MAXLEN_4_BYTE 0x1U |
#define | HYPERBUS_MCR_MAXLEN_6_BYTE 0x2U |
#define | HYPERBUS_MCR_MAXLEN_1024_BYTE 0x1FFU |
#define | HYPERBUS_MCR_MERGE_WRAP_INCR 0x1U |
Memory Configuration Register defines. More... | |
#define | HYPERBUS_MCR_NO_MERGE_WRAP_INCR 0x0U |
#define | HYPERBUS_MCR_ASYMM_CACHE_SUPPORT 0x1U |
Memory Configuration Register defines. More... | |
#define | HYPERBUS_MCR_NO_ASYMM_CACHE_SUPPORT 0x0U |
#define | HYPERBUS_MCR_MEM_SPACE 0x0U |
Memory Configuration Register defines. More... | |
#define | HYPERBUS_MCR_CR_SPACE 0x1U |
#define | HYPERBUS_MCR_HYPERFLASH 0x0U |
Memory Configuration Register defines. More... | |
#define | HYPERBUS_MCR_HYPERRAM 0x1U |
#define | HYPERBUS_MCR_WRAPSIZE_NONE 0x0U |
Memory Configuration Register defines. More... | |
#define | HYPERBUS_MCR_WRAPSIZE_64B 0x1U |
#define | HYPERBUS_MCR_WRAPSIZE_16B 0x2U |
#define | HYPERBUS_MCR_WRAPSIZE_32B 0x3U |
Chip Selects | |
#define | HYPERBUS_CS0 (0U) |
#define | HYPERBUS_CS1 (1U) |
Typedefs | |
typedef void * | HYPERBUS_Handle |
A handle that is returned from a HYPERBUS_open() call. More... | |
Enumerations | |
enum | HYPERBUS_Devicetype { HYPERBUS_DEVICETYPE_HYPERRAM, HYPERBUS_DEVICETYPE_NONE, HYPERBUS_DEVICETYPE_HYPERFLASH } |
Enum for device type. More... | |
Functions | |
void | HYPERBUS_init (void) |
This function initializes the HYPERBUS module. More... | |
void | HYPERBUS_deinit (void) |
This function de-initializes the HYPERBUS module. More... | |
HYPERBUS_Handle | HYPERBUS_open (uint32_t index) |
This function opens a given HYPERBUS peripheral. More... | |
void | HYPERBUS_close (HYPERBUS_Handle handle) |
Function to close a HYPERBUS peripheral specified by the HYPERBUS handle. More... | |
HYPERBUS_Handle | HYPERBUS_getHandle (uint32_t index) |
This function returns the handle of an open HYPERBUS Instance from the instance index. More... | |
uint32_t | HYPERBUS_getHyperBusDataBaseAddr (HYPERBUS_Handle handle) |
This function gets the SOC mapped data base address of the HyperRam. More... | |
static uint32_t | HYPERBUS_makeMemCfg (HYPERBUS_Handle handle, HYPERBUS_MemCfg *pHyperBusMemCfg) |
This function returns the memory configuration of the HYPERBUS Instance. More... | |
static uint32_t | HYPERBUS_makeMemTiming (HYPERBUS_Handle handle, HYPERBUS_MemTiming *pHyperBusMemTiming) |
This function returns the memory Timings of the HYPERBUS Instance. More... | |
Variables | |
HYPERBUS_Config | gHyperBusConfig [] |
Externally defined driver configuration array. More... | |
uint32_t | gHyperBusConfigNum |
Externally defined driver configuration array size. More... | |