PDK API Guide for J721E
Proxy CSL-FL

Introduction

===========================================================================

Introduction

Overview This is the CSL-FL API documentation for the Secure Proxy module.

The following procedure describes how to properly use this CSL-FL API:

  1. Allocate and initialize an array of CSL_ProxyTargetParams structures, one for each proxy target. A pointer to this array of structures is passed in the CSL_ProxyCfg structure.

    This array of structures would be initialized as follows for the navss_main, which has a single ringacc target:

    CSL_ProxyTargetParams navssMainProxyTargetCfg[] = { // Target 0: ringacc0 { (CSL_proxy_target0Regs *)0x000033000000UL, // pTargetRegs 3072U, // numChns 512U // chnSizeBytes } };

  2. Allocate and initialize the CSL_ProxyCfg structure. A pointer to this structure is passed to all proxy API functions.

    This structure would be initialized as follows for the navss_main:

    CSL_ProxyCfg navssMainProxyCfg = { (CSL_proxyRegs *)0x000031120000UL, // pGlbRegs (CSL_proxy_cfgRegs *)0x000033400000UL, // pCfgRegs 64, // bufferSizeBytes 1, // numTargets navssMainProxyTargetCfg, // pProxyTargetParams };

  3. Each proxy data flow (between the host and a target queue) requires a proxy thread. A proxy thread is simply a logical, bi-directional connection between the proxy IP block and a target queue. For each of these threads... a) Initialize the CSL_ProxyThreadCfg structure b) Call CSL_proxyCfgThread to configure the thread c) Call CSL_proxyCfgThreadErrEvtNum to configure the thread error event number

    The CSL_proxyGetNumThreads function can be called to determine the number of threads supported by this proxy.

  4. Once the threads are configured, you can then write to or read from a target channel (queue) corresponding to a thread by calling CSL_proxySetQueueAccessMode to set the queue access mode, or CSL_proxySetQueueParms to set all the queue parameters, and then CSL_proxyAccessTarget to perform the data write or read.
  5. The following functions can be called to query and service events related to a thread: o CSL_proxyIsThreadError o CSL_proxyClrThreadError

References


Sub Modules

 PROXY Data Structures
 
 PROXY Enumerated Data Types
 
 PROXY Functions