Introduction

This module contains APIs to program and use the HyperRAM module on the board . See HyperRam for more details.

Data Structures
struct	HyperRam_Attrs
	HyperRam device attributes, these are filled by SysCfg based on the HyperRam device that is selected. More...

struct	HyperRam_Config
	HyperRam driver configuration, these are filled by SysCfg based on the HyperRam device that is selected. More...

Functions
void	HyperRam_init (void)
	This function initializes the HYPERBUS module. More...

void	HyperRam_deinit (void)
	This function de-initializes the HYPERBUS module. More...

HYPERRAM_Handle	HyperRam_open (uint32_t instanceId)
	Open HyperRam driver. More...

void	HyperRam_close (HYPERRAM_Handle handle)
	Close HyperRam driver. More...

Typedefs
typedef void *	HYPERRAM_Handle
	Handle to the HYPERRAM driver returned by HyperRam_open() More...

Typedef Documentation

◆ HYPERRAM_Handle

typedef void* HYPERRAM_Handle

Handle to the HYPERRAM driver returned by HyperRam_open()

Function Documentation

◆ HyperRam_init()

void HyperRam_init ( void )

This function initializes the HYPERBUS module.

◆ HyperRam_deinit()

void HyperRam_deinit ( void )

This function de-initializes the HYPERBUS module.

◆ HyperRam_open()

HYPERRAM_Handle HyperRam_open ( uint32_t instanceId )

Open HyperRam driver.

Make sure the SOC peripheral driver is opened before calling this API. Drivers_open function generated by SysCfg opens the underlying SOC peripheral driver, e.g HYPERBUS.

Internally this API also reads the device and manufacture ID and checks if it matches the expected value for the HYPERRAM device, if there is mismatch then NULL is returned.

Global variables HYPERRAM_Config gHyperRamConfig[] and uint32_t gHyperRamConfigNum is instantiated by SysCfg to describe the HYPERRAM configuration based on user selection in SysCfg.

Parameters

instanceId [in] Index within HyperRam_Config gHyperRamConfig[] denoting the HyperRam driver to open

Returns: Handle to HyperRam driver which should be used in subsequent API call; NULL in case of failure

◆ HyperRam_close()

void HyperRam_close ( HYPERRAM_Handle handle )

Close HyperRam driver.

Parameters

handle [in] HyperRam driver handle from HyperRam_open