HPM SDK
HPMicro Software Development Kit
XPI RAM driver APIs

XPI RAM ROM APIs. More...

Data Structures

struct  xpi_ram_config_option_t
 XPI RAM configuration option The ROM SW can detect the FLASH configuration based on the following structure specified by the end-user. More...
 
struct  device_config_t
 XPI RAM device configuration structure. More...
 
struct  xpi_ram_info_t
 XPI RAM information structure. More...
 
struct  xpi_ram_config_t
 XPI RAM configuration structure. More...
 

Macros

#define XPI_RAM_CFG_OPTION_TAG   (0xfcf91U)
 XPI RAM configuration option tag. More...
 
#define XPI_RAM_CFG_TAG   (0x4D415258U)
 XPI RAM Configuration block tag. More...
 

Enumerations

enum  { xpi_ram_safe_clk_freq = 1 }
 XPI RAM safe frequency option. More...
 
enum  { xpi_ram_type_apmemory_x8 = 0 , xpi_ram_type_hyperram = 1 , xpi_ram_type_apmemory_x4 = 2 }
 XPI RAM type options. More...
 
enum  { xpi_ram_option_misc_hyperram_3v0 , xpi_ram_option_misc_hyperram_1v8 }
 HyperRAM voltage options. More...
 
enum  { xpi_ram_default_max_cs_low_time_us = 4 }
 XPI RAM maximum CS low time definition. More...
 
enum  { xpi_ram_opi = (3U) , xpi_ram_qpi = (2U) }
 XPI RAM pad definitions. More...
 
enum  { xpi_ram_cfg_cmd_type_generic = 1 , xpi_ram_cfg_cmd_type_spi2xpi = 2 }
 XPI RAM Configuration command type. More...
 

Detailed Description

XPI RAM ROM APIs.

Macro Definition Documentation

◆ XPI_RAM_CFG_OPTION_TAG

#define XPI_RAM_CFG_OPTION_TAG   (0xfcf91U)

#include <drivers/inc/hpm_romapi_xpi_ram_def.h>

XPI RAM configuration option tag.

◆ XPI_RAM_CFG_TAG

#define XPI_RAM_CFG_TAG   (0x4D415258U)

#include <drivers/inc/hpm_romapi_xpi_ram_def.h>

XPI RAM Configuration block tag.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

#include <drivers/inc/hpm_romapi_xpi_ram_def.h>

XPI RAM safe frequency option.

Enumerator
xpi_ram_safe_clk_freq 

◆ anonymous enum

anonymous enum

#include <drivers/inc/hpm_romapi_xpi_ram_def.h>

XPI RAM type options.

Enumerator
xpi_ram_type_apmemory_x8 

APMemory PSRAM X8

xpi_ram_type_hyperram 

HyperRAM

xpi_ram_type_apmemory_x4 

APMemory PSRAM X4

◆ anonymous enum

anonymous enum

#include <drivers/inc/hpm_romapi_xpi_ram_def.h>

HyperRAM voltage options.

Enumerator
xpi_ram_option_misc_hyperram_3v0 
xpi_ram_option_misc_hyperram_1v8 

◆ anonymous enum

anonymous enum

#include <drivers/inc/hpm_romapi_xpi_ram_def.h>

XPI RAM maximum CS low time definition.

Enumerator
xpi_ram_default_max_cs_low_time_us 

Default Maximum CS low internal is 4us

◆ anonymous enum

anonymous enum

#include <drivers/inc/hpm_romapi_xpi_ram_def.h>

XPI RAM pad definitions.

Enumerator
xpi_ram_opi 

Octal pads XPI RAM PAD option: Octal pads

xpi_ram_qpi 

Quad pads XPI RAM PAD option: Quad pads

◆ anonymous enum

anonymous enum

#include <drivers/inc/hpm_romapi_xpi_ram_def.h>

XPI RAM Configuration command type.

Enumerator
xpi_ram_cfg_cmd_type_generic 

Generic configuration command

xpi_ram_cfg_cmd_type_spi2xpi 

SPI to XPI configuration command