ptxNSC_Thread.h

Go to the documentation of this file.

 
#ifndef PTXNSC_THREAD_H
#define PTXNSC_THREAD_H
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptx_IoRq.h"
#include "ptxNSC_InterfaceTypes.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES / INTERNALS
 * ####################################################################################################################
 */
 
#define PTX_NSC_HW_CONTROL_MODE                 0x00    
#define PTX_NSC_HW_PROTOCOL_MODE                0x01    
#define PTX_NSC_PAUSE_STATE_RUNNING             0x00    
#define PTX_NSC_PAUSE_STATE_PAUSEDBYAPP         0x01    
#define PTX_NSC_PAUSE_STATE_PAUSEDBYSTACK       0x02    
#define PTX_NSC_THREAD_PAUSED_LOCALLY           0x01    
#define PTX_NSC_THREAD_NOT_PAUSED_LOCALLY       0x00    
#define PTX_NSC_READ_0_LEN                      1       
#define PTX_NSC_READ_1_LEN                      1       
#define PTX_NSC_READ_1_LEN_POS                  0       
#define PTX_NSC_READ_LEN_ACK                    0       
#define PTX_NSC_READ_LEN_1                      1       
/*
 * Forward declaration
 */
struct ptxNSC;
 
typedef enum ptxNscThread_FrameType
{
    ptxNscThread_FrameType_UNDEFINED,
    ptxNscThread_FrameType_RSP,
    ptxNscThread_FrameType_ACK,
    ptxNscThread_FrameType_NTF,
    /* */
    ptxNscThread_FrameType_MAX
} ptxNscThread_FrameType_t;
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxNsc_ThreadCreate(struct ptxNSC *nscCtx);
 
ptxStatus_t ptxNsc_ThreadShutdown(struct ptxNSC *nscCtx);
 
ptxStatus_t ptxNsc_ThreadPause(struct ptxNSC *nscCtx, ptxNSC_Pause_Options pauseMode);
 
ptxStatus_t ptxNsc_Thread_ProcessNsc (struct ptxNSC *nscCtx, ptxBufferPool_Item_t *bufferItem);
 
ptxStatus_t ptxNSC_WaitGetRspBuffer(struct ptxNSC *nscCtx,  ptxIoRq_t *ioRqItem, ptxBufferPool_Item_t **bufferItem);
 
ptxStatus_t ptxNSC_WaitGetRspBuffer_NotIoRq(struct ptxNSC *nscCtx, ptxBufferPool_Item_t **bufferItem);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */