Sciserver TI-RTOS APIs

Introduction

Files
file	sciserver_tirtos.h
	This file contains prototypes for APIs contained as a part of SCISERVER as well as the structures of their arguments for building an TI-RTOS Application.

Data Structures
struct	Sciserver_TirtosCfgPrms_t
	Sciserver App Configuration Parameters. More...

Functions
int32_t	Sciserver_tirtosInit (Sciserver_TirtosCfgPrms_t *pPrms)
	Sciserver TI-RTOS Application Init. More...
void	Sciserver_tirtosDeinit (void)
	Sciserver TI-RTOS Application Deinit. More...
void	Sciserver_tirtosUserMsgHwiFxn (uintptr_t arg)
	Sciserver TI-RTOS Application hardware interrupt function. More...
void	Sciserver_tirtosUnRegisterIntr (void)
	Sciserver TI-RTOS Application unregister interrupt. More...
void	Sciserver_tirtosUserMsgTask (void *arg0, void *arg1)
	Sciserver TI-RTOS Application user message task. More...
static int32_t	Sciserver_tirtosInitPrms_Init (Sciserver_TirtosCfgPrms_t *pPrms)
	Initialize the init params for SCISERVER. More...

Macros
#define	SCISERVER_DEBUG_LOG_LEVEL_0   (0U)
#define	SCISERVER_DEBUG_LOG_LEVEL_1   (1U)
#define	SCISERVER_EN_DEBUG_LOG_LEVEL   (SCISERVER_DEBUG_LOG_LEVEL_0)

Macro Definition Documentation

SCISERVER_DEBUG_LOG_LEVEL_0

#define SCISERVER_DEBUG_LOG_LEVEL_0   (0U)

SCISERVER_DEBUG_LOG_LEVEL_1

#define SCISERVER_DEBUG_LOG_LEVEL_1   (1U)

Disables debug logs

SCISERVER_EN_DEBUG_LOG_LEVEL

#define SCISERVER_EN_DEBUG_LOG_LEVEL   (SCISERVER_DEBUG_LOG_LEVEL_0)

Enables level 1 of debug logs Enable SCI server logs

Function Documentation

Sciserver_tirtosInit()

int32_t Sciserver_tirtosInit

(

Sciserver_TirtosCfgPrms_t *

pPrms

)

Sciserver TI-RTOS Application Init.

    NOTE: If this function is called form a Task Context
    (i.e, not from main / after starting the Schedular),
    the callee Task should be of priority higher than  
    max of passed init param(pPrms) Task priorities
    i.e Sciserver_TirtosCfgPrms_t->taskPriority[x]

Parameters

pPrms

Pointer to Sciserver_TirtosCfgPrms_t

Returns

CSL_PASS if the init has happened correctly. CSL_EFAIL if otherwise.

Sciserver_tirtosDeinit()

void Sciserver_tirtosDeinit

(

void

)

Sciserver TI-RTOS Application Deinit.

Returns

None

Sciserver_tirtosUserMsgHwiFxn()

void Sciserver_tirtosUserMsgHwiFxn

(

uintptr_t

arg

)

Sciserver TI-RTOS Application hardware interrupt function.

Parameters

arg	Pointer to data needed for Sciserver HWI operation

Returns

None

Sciserver_tirtosUnRegisterIntr()

void Sciserver_tirtosUnRegisterIntr

(

void

)

Sciserver TI-RTOS Application unregister interrupt.

Returns

None

Sciserver_tirtosUserMsgTask()

void Sciserver_tirtosUserMsgTask	(	void *	arg0,
		void *	arg1
	)

Sciserver TI-RTOS Application user message task.

Parameters

arg0	Pointer to data needed for secure task operation.
arg1	Dummy argument

Returns

None

Sciserver_tirtosInitPrms_Init()

static int32_t Sciserver_tirtosInitPrms_Init ( Sciserver_TirtosCfgPrms_t *  pPrms )

static

Initialize the init params for SCISERVER.

Parameters

pPrms

Pointer to the init parameters.

Returns

CSL_PASS if init Params are initialized with some default. CSL_EFAIL otherwise.