SDL API Guide for J7200
sdl_rat.h
Go to the documentation of this file.
1 
39 #ifndef SDL_RAT_H_
40 #define SDL_RAT_H_
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 #include <src/ip/sdl_ip_rat.h>
47 #include <sdl_types.h>
48 #include <tistdtypes.h>
49 #include <stdint.h>
50 #include <stdbool.h>
51 #include <src/sdl/hw_types.h>
52 
53 
54 #if defined (SOC_J721E)
55 #include <include/soc/j721e/sdlr_soc_baseaddress.h>
56 #endif
57 
58 
86 int32_t SDL_RAT_isRegionTranslationEnabled(const SDL_ratRegs *pRatRegs, uint32_t regionIndex);
87 
96 int32_t SDL_RAT_setErrMsgDestId(SDL_ratRegs *pRatRegs, uint32_t destId);
97 
106 int32_t SDL_RAT_getErrMsgDestId(const SDL_ratRegs *pRatRegs, uint32_t *pDestId);
107 
108 
118 int32_t SDL_RAT_enableExceptionLog(SDL_ratRegs *pRatRegs);
119 
120 
129 int32_t SDL_RAT_disableExceptionLog(SDL_ratRegs *pRatRegs);
130 
140 int32_t SDL_RAT_isIntrPending(const SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc);
141 
151 int32_t SDL_RAT_setIntrPending(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc);
152 
162 int32_t SDL_RAT_clrIntrPending(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc);
163 
172 int32_t SDL_RAT_ackIntr(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc);
173 
186 int32_t SDL_RAT_enableIntr(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc);
187 
200 int32_t SDL_RAT_disableIntr(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc);
201 
213 int32_t SDL_RAT_getExceptionInfo(SDL_ratRegs *pRatRegs, SDL_ratExceptionInfo *pExceptionInfo);
214 
224 int32_t SDL_RAT_enableRegionTranslation(SDL_ratRegs *pRatRegs, uint32_t regionIndex);
225 
235 int32_t SDL_RAT_disableRegionTranslation(SDL_ratRegs *pRatRegs, uint32_t regionIndex);
236 
251 int32_t SDL_RAT_configRegionTranslation(SDL_ratRegs *pRatRegs, uint32_t regionIndex,
252  SDL_ratTranslationCfgInfo * pTranslationCfg);
253 
268 int32_t SDL_RAT_verifyConfigRegionTranslation(const SDL_ratRegs *pRatRegs, uint32_t regionIndex,
269  SDL_ratTranslationCfgInfo *pTranslationCfg);
270 
283 int32_t SDL_RAT_getStaticRegs(SDL_ratRegs *pRatRegs, uint32_t regionIndex, SDL_ratStaticRegs * pStaticRegs);
284 
287 #ifdef __cplusplus
288 }
289 #endif
290 
291 #endif
292 
int32_t SDL_RAT_isRegionTranslationEnabled(const SDL_ratRegs *pRatRegs, uint32_t regionIndex)
This function returns the enable status of the specified region address translation.
int32_t SDL_RAT_ackIntr(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc)
This function is used to acknowledge the specified interrupt source.
int32_t SDL_RAT_getExceptionInfo(SDL_ratRegs *pRatRegs, SDL_ratExceptionInfo *pExceptionInfo)
This function is used to get information for the last boundary crossing transaction exception capture...
uint32_t SDL_RAT_intrSrcTypes
Definition: sdl_ip_rat.h:390
int32_t SDL_RAT_setIntrPending(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc)
This function is used to forceably set the pending status of the specified interrupt source...
This structure contains information required to configure an address translation region.
Definition: sdl_ip_rat.h:91
int32_t SDL_RAT_enableExceptionLog(SDL_ratRegs *pRatRegs)
This function enables the exception logging capability. It also enables exception interrupt generatio...
int32_t SDL_RAT_getStaticRegs(SDL_ratRegs *pRatRegs, uint32_t regionIndex, SDL_ratStaticRegs *pStaticRegs)
This function returns the enable status of the specified region address translation.
This structure contains exception status information returned by the SDL_RAT_getExceptionInfo functio...
Definition: sdl_ip_rat.h:411
int32_t SDL_RAT_isIntrPending(const SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc)
This function returns the pending interrupt status of the specified interrupt source.
int32_t SDL_RAT_configRegionTranslation(SDL_ratRegs *pRatRegs, uint32_t regionIndex, SDL_ratTranslationCfgInfo *pTranslationCfg)
This function is used to configure a region address translation for the specified region index...
Header file containing various enumerations, structure definitions and function declarations for the ...
int32_t SDL_RAT_getErrMsgDestId(const SDL_ratRegs *pRatRegs, uint32_t *pDestId)
This function is used to read the destination ID for error messages.
int32_t SDL_RAT_disableIntr(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc)
This function disables the specified interrupt source. This prevents the module&#39;s exception interrupt...
int32_t SDL_RAT_verifyConfigRegionTranslation(const SDL_ratRegs *pRatRegs, uint32_t regionIndex, SDL_ratTranslationCfgInfo *pTranslationCfg)
This function is used to configure a region address translation for the specified region index...
int32_t SDL_RAT_enableIntr(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc)
This function enables the specified interrupt source. It also calls SDL_RAT_enableExceptionLog to ena...
int32_t SDL_RAT_clrIntrPending(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc)
This function is used to clear the pending status of the specified interrupt source.
Definition: sdl_ip_rat.h:65
int32_t SDL_RAT_setErrMsgDestId(SDL_ratRegs *pRatRegs, uint32_t destId)
This function is used to set the destination ID for error messages.
int32_t SDL_RAT_enableRegionTranslation(SDL_ratRegs *pRatRegs, uint32_t regionIndex)
This function enables address translation for the specified region.
int32_t SDL_RAT_disableExceptionLog(SDL_ratRegs *pRatRegs)
This function disables the exception logging capability. It also disables the module&#39;s exception inte...
Definition: sdl_ip_rat.h:102
int32_t SDL_RAT_disableRegionTranslation(SDL_ratRegs *pRatRegs, uint32_t regionIndex)
This function disables address translation for the specified region.