AM275 FreeRTOS SDK  11.01.00
HyperRam

The driver takes care of all sequencing necessary to perform writes across pages and the application need not take care of the programming intricacies.

Features Supported

  • Provides API to return HyperRam attributes like handle etc
  • API to get device ID

SysConfig Features

Note
It is strongly recommend to use SysConfig where it is available instead of using direct SW API calls. This will help simplify the SW application and also catch common mistakes early in the development cycle.
  • Option to select HyperRam based on board
  • Option to give corresponding CR1, ID0, ID1 values of HyperRam Registers
  • Supported HyperRam devices
    • S80KS5122

Features NOT Supported

NA

Important Usage Guidelines

  • For the HyperRam region, the MPU Region Access Control Register should be set to Cacheable, Bufferable, and Non-shared for better performance.
  • For the following HyperRam register regions, the MPU Region Access Control Register memory type should be set to Strongly Ordered to ensure that writes to the HyperRam registers occur in the expected sequence:
    • For IDENTIFICATION registers(ID0, ID1) of HyperRam at offset 0x0
    • For CONFIGURATION registers(CR0, CR1) of HyperRam at offset 0x1000

Example Usage

Include the below file to access the APIs

#include <stdio.h>
#include <board/hyperRam.h>

HyperRam open API

gHyperRamHandle = HyperRam_open(0);
DebugP_assert(gHyperRamHandle != NULL);

HyperRam close API

HyperRam_close(gHyperRamHandle);

API

APIs for HYPERRAM

hyperRam.h
This file contains structure, typedefs, functions and prototypes used for Hyperram.
HyperRam_close
void HyperRam_close(HYPERRAM_Handle handle)
Close HyperRam driver.
DebugP_assert
#define DebugP_assert(expression)
Function to call for assert check.
Definition: DebugP.h:183
HyperRam_open
HYPERRAM_Handle HyperRam_open(uint32_t instanceId)
Open HyperRam driver.