PDK API Guide for J721E
sciserver.h File Reference

Introduction

This file contains prototypes for APIs contained as a part of SCISERVER as well as the structures of their arguments.

Go to the source code of this file.

Semaphore Ids to be used for the user and DM tasks.

#define SCISERVER_SEMAPHORE_USER_HI   (uint32_t)0
 
#define SCISERVER_SEMAPHORE_USER_LO   (uint32_t)1
 
#define SCISERVER_SEMAPHORE_USER_DM   (uint32_t)2
 
#define SCISERVER_SEMAPHORE_MAX_CNT   (uint32_t)3
 
typedef uint32_t Sciserver_SemaphoreIds
 Semaphore Ids to be used for the user and DM tasks. More...
 

Task Ids to be used for the user and DM tasks.

#define SCISERVER_TASK_USER_HI   (uint32_t)0
 
#define SCISERVER_TASK_USER_LO   (uint32_t)1
 
#define SCISERVER_TASK_MAX_CNT   (uint32_t)2
 
typedef uint32_t Sciserver_TaskIds
 Task Ids to be used for the user and DM tasks. More...
 

Data Structures

struct  Sciserver_CfgPrms_t
 Sciserver Configuration Parameters. More...
 
struct  Sciserver_msgData
 Contains data about the message needed to idetify the sender and route the message response back to the proper location. More...
 
struct  Sciserver_taskState
 Contains data needed for Sciserver task operation. More...
 
struct  Sciserver_hwiData
 Contains data needed for Sciserver HWI operation. More...
 
struct  Sciserver_taskData
 Contains data needed for secure task operation. More...
 

Macros

#define SCISERVER_CTRL_CMD_HALT   (0xA5)
 
#define SCISERVER_CTRL_CMD_RUN   (0x5A)
 
#define SCISERVER_PROCESS_STATE_WAIT   (0x5A)
 
#define SCISERVER_PROCESS_STATE_RUN   (0xA5U)
 
#define SCISERVER_FORWARD_MSG   (0x5AU)
 
#define SCISERVER_NO_FORWARD_MSG   (0xA5U)
 
#define SCISERVER_INIT_DONE   (0x69U)
 
#define SCISERVER_INIT_NOT_DONE   (0x96U)
 
#define SCISERVER_HW_QUEUE_SIZE   (52U)
 
#define SCISERVER_HWI_NUM   (5U)
 
#define SCISERVER_SECPROXY_INSTANCE_COUNT   (0x2U)
 

Enumerations

enum  Sciserver_taskStateState { SCISERVER_TASK_PENDING = 0, SCISERVER_TASK_PROCESSING_USER_MSG = 1, SCISERVER_TASK_PROCESSING_SECURE_MSG = 2 }
 

Functions

char * Sciserver_getVersionStr (void)
 Sciserver Get Version String Function. More...
 
char * Sciserver_getRmPmHalVersionStr (void)
 Sciserver Get RM_PM_HAL Version String Function. More...
 
int32_t Sciserver_init (Sciserver_CfgPrms_t *pPrms)
 Sciserver Initialization Function. More...
 
int32_t Sciserver_deinit (void)
 Sciserver De-Initialization Function. More...
 
void Sciserver_setCtrlState (uint8_t state)
 Sciserver Set the Control Command State. More...
 
uint8_t Sciserver_getCtrlState (void)
 Sciserver Get the Control Command State. More...
 
void Sciserver_setProcessState (uint8_t state)
 Sciserver Set the Process State. More...
 
uint8_t Sciserver_getProcessState (void)
 Sciserver Get the Process State. More...
 
int32_t Sciserver_interruptHandler (Sciserver_hwiData *uhd, bool *soft_error)
 Sciserver Interrupt Handler. More...
 
int32_t Sciserver_processtask (Sciserver_taskData *utd)
 Sciserver Process Task Function. More...
 
int32_t Sciserver_initPrms_Init (Sciserver_CfgPrms_t *pPrms)
 Initialize the init params for SCISERVER. More...
 
void Sciserver_socInit (void)
 Sciserver function to implement SoC specific configuration. More...