PDK API Guide for J721E
CSL_RingAccRingCfg Struct Reference

Detailed Description

CSL_RingAccRingCfg contains information to configure a ring.

Data Fields

void * virtBase
 
uint64_t physBase
 
CSL_RingAccRingMode mode
 
uint32_t elCnt
 
uint32_t elSz
 
uint32_t evtNum
 
uint32_t credSecure
 
uint32_t credPriv
 
uint32_t credPrivId
 
uint32_t credVirtId
 
uint32_t ringNum
 
struct CSL_RingAccRing_t * pPair
 
uint32_t rwIdx
 
int32_t waiting
 
uint32_t occ
 

Field Documentation

◆ virtBase

void* CSL_RingAccRingCfg::virtBase

Virtual base address of the ring memory

◆ physBase

uint64_t CSL_RingAccRingCfg::physBase

Physical base address of the ring memory

◆ mode

CSL_RingAccRingMode CSL_RingAccRingCfg::mode

Ring mode

◆ elCnt

uint32_t CSL_RingAccRingCfg::elCnt

Ring element count

◆ elSz

uint32_t CSL_RingAccRingCfg::elSz

Ring element size (4,8,16,32,64,128,256)

◆ evtNum

uint32_t CSL_RingAccRingCfg::evtNum

Event number for the ring

◆ credSecure

uint32_t CSL_RingAccRingCfg::credSecure

Ring credential: Secure attribute (0=non-secure, all other values=secure)

◆ credPriv

uint32_t CSL_RingAccRingCfg::credPriv

Ring credential: Privilege attribute (0=user, 1=supervisor, 2=hypervisor, 3=hypervisor supervisor)

◆ credPrivId

uint32_t CSL_RingAccRingCfg::credPrivId

Ring credential: Privilege ID attribute. If credPrivId==CSL_RINGACC_CRED_PASSTHRU (0xFFFFFFFFU), then priv ID is not replaced and existing value is passed through.

◆ credVirtId

uint32_t CSL_RingAccRingCfg::credVirtId

Ring credential: Virtual ID attribute. If credVirtId==CSL_RINGACC_CRED_PASSTHRU (0xFFFFFFFFU), then virtual ID is not replaced and existing value is passed through.

◆ ringNum

uint32_t CSL_RingAccRingCfg::ringNum

(Private) Ring number (0-1023)

◆ pPair

struct CSL_RingAccRing_t* CSL_RingAccRingCfg::pPair

(Private) Pointer to paired ring (if any) or NULL

◆ rwIdx

uint32_t CSL_RingAccRingCfg::rwIdx

(Private) Current read/write index

◆ waiting

int32_t CSL_RingAccRingCfg::waiting

(Private) Entry cnt that need COMMIT(tx) or ACK(rx)

◆ occ

uint32_t CSL_RingAccRingCfg::occ

(Private) Ring occupancy count