csl_proxy.h File Reference

Introduction

Header file containing various enumerations, structure definitions and function declarations for the proxy IP.

---

(C) Copyright 2016-2020, Texas Instruments, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Texas Instruments Incorpoproxyed nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Go to the source code of this file.

Proxy queue access modes
This enumerator defines valid queue access modes
#define	CSL_PROXY_QUEUE_ACCESS_MODE_HEAD   (CSL_PROXY_TARGET0_PROXY_CTL_MODE_VAL_HEAD)
#define	CSL_PROXY_QUEUE_ACCESS_MODE_TAIL   (CSL_PROXY_TARGET0_PROXY_CTL_MODE_VAL_TAIL)
#define	CSL_PROXY_QUEUE_ACCESS_MODE_PEEK_HEAD   (CSL_PROXY_TARGET0_PROXY_CTL_MODE_VAL_PEEK_HEAD)
#define	CSL_PROXY_QUEUE_ACCESS_MODE_PEEK_TAIL   (CSL_PROXY_TARGET0_PROXY_CTL_MODE_VAL_PEEK_TAIL)
typedef uint32_t	CSL_ProxyQueueAccessMode

Data Structures
struct	CSL_ProxyThreadCfg
	This structure contains configuration parameters for each proxy thread. More...
struct	CSL_ProxyTargetParams
	This structure contains configuration parameters for each proxy target. More...
struct	CSL_ProxyCfg
	This structure contains configuration parameters for the proxy IP. More...

Macros
#define	CSL_PROXY_GLOBAL_ERR_EVT_DISABLE   ((uint32_t) 0xFFFFU)

Typedefs
typedef void(*	CSL_ProxyMemAccessCbFxnPtr) (uintptr_t addr, uint8_t *pAppData, uint32_t elemSizeBytes, uint32_t elemCnt)
	Callback function used to write/read to/from memory. More...

Functions
static uint32_t	CSL_proxyEncodeElementSize (uint32_t elSz)
uint32_t	CSL_proxyGetRevision (const CSL_ProxyCfg *pProxyCfg)
	Return revision of the Proxy module. More...
uint32_t	CSL_proxyGetNumThreads (const CSL_ProxyCfg *pProxyCfg)
	Get number of threads supported. More...
int32_t	CSL_proxyCfgGlobalErrEvtNum (const CSL_ProxyCfg *pProxyCfg, uint32_t globalErrEvtNum)
	Configure the event number used for global errors. More...
int32_t	CSL_proxyCfgThread (CSL_ProxyCfg *pProxyCfg, uint32_t targetNum, uint32_t threadNum, const CSL_ProxyThreadCfg *pThreadCfg)
	Configure a proxy thread. More...
int32_t	CSL_proxyCfgThreadErrEvtNum (CSL_ProxyCfg *pProxyCfg, uint32_t targetNum, uint32_t threadNum, uint32_t errEvtNum)
	Configure a proxy thread's error event number. More...
uint32_t	CSL_proxyGetMaxMsgSize (const CSL_ProxyCfg *pProxyCfg, uint32_t targetNum)
	Get maximim message size. More...
uintptr_t	CSL_proxyGetDataAddr (const CSL_ProxyCfg *pProxyCfg, uint32_t targetNum, uint32_t threadNum, uint32_t numBytes)
	Get the read/write data address for the specified thread. More...
void	CSL_proxyAccessTarget (CSL_ProxyCfg *pProxyCfg, uint32_t targetNum, uint32_t threadNum, uint8_t *pData, uint32_t numBytes, CSL_ProxyMemAccessCbFxnPtr fpMemAccess)
	Access (read/write) from/to the specified thread. More...
static void	CSL_proxySetQueueAccessMode (const CSL_ProxyCfg *pProxyCfg, uint32_t targetNum, uint32_t threadNum, CSL_ProxyQueueAccessMode mode)
	Set the queue access mode. More...
static void	CSL_proxySetQueueParms (const CSL_ProxyCfg *pProxyCfg, uint32_t targetNum, uint32_t threadNum, uint32_t queueNum, uint32_t elSz, CSL_ProxyQueueAccessMode mode)
	Set the queue parameters. More...
static uint32_t	CSL_proxyIsThreadError (const CSL_ProxyCfg *pProxyCfg, uint32_t targetNum, uint32_t threadNum)
	Get thread error status. More...
static void	CSL_proxyClrThreadError (const CSL_ProxyCfg *pProxyCfg, uint32_t targetNum, uint32_t threadNum)
	Clear thread error status. More...

Function Documentation

CSL_proxyEncodeElementSize()

static uint32_t CSL_proxyEncodeElementSize ( uint32_t  elSz )

inlinestatic