ptx_IoRq.h

Go to the documentation of this file.

 
#ifndef PTX_IO_RQ_H
#define PTX_IO_RQ_H
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptx_Platform.h"
#include "ptx_Status.h"
#include "ptxBufferPool.h"
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES / INTERNALS
 * ####################################################################################################################
 */
 
#define PTX_IORQ_EMPTY                              0               
#define PTX_IORQ_NUM_STACK_LOCATIONS                8               
#define PTX_IORQ_DATA_POP                           ((size_t)-1)    
#define PTX_IORQ_STATE_DISPOSED                     (uint8_t)0      
#define PTX_IORQ_STATE_LOCKED                       (uint8_t)1      
#define PTX_IORQ_STATE_LOCKED_RELEASE_BUFFER        (uint8_t)2      
#define PTX_IORQ_STATE_INVALID                      (uint8_t)0xFF   
struct ptxIoRq;
 
struct ptxOsal;
 
struct ptxLog;
 
typedef void (*pptxIoRqCompletion_t)(struct ptxIoRq *ioRq, void *cplUpperLayer, void *data, size_t dataLength, ptxStatus_t cplStatus);
 
typedef struct ptxIoRq
{
    pptxIoRqCompletion_t            IoCompletion[PTX_IORQ_NUM_STACK_LOCATIONS];     
    void                           *Layer[PTX_IORQ_NUM_STACK_LOCATIONS];            
    void                           *data[PTX_IORQ_NUM_STACK_LOCATIONS];             
    size_t                          dataLength[PTX_IORQ_NUM_STACK_LOCATIONS];       
    uint8_t                         Type;                                           
    uint8_t                         N;                                              
    uint8_t                         State;                                          
    ptxBufferPool_Item_t           *bufferItem;                                     
} ptxIoRq_t;
 
typedef ptxStatus_t (*pptxIoRq_Init_t) (ptxIoRq_t *ioCpl);
 
typedef ptxStatus_t (*pptxIoRq_Push_t) (ptxIoRq_t *ioCpl, pptxIoRqCompletion_t ioCompletionFn, uint8_t *ioData, uint8_t dataLength, void *ioCompletionComp);
 
typedef ptxStatus_t (*pptxIoRq_Pop_t) (ptxIoRq_t *ioCpl, pptxIoRqCompletion_t *ioCompletionFn, void **ioData, uint8_t *ioDataLength, void **ioCompletionComp);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
struct ptxIoRq *ptxIoRq_GetItem(struct ptxOsal *osalCtx);
 
void ptxIoRq_ReturnItem(struct ptxOsal *osalCtx, struct ptxIoRq *ioRqItem);
 
ptxStatus_t ptxIoRq_Init(ptxIoRq_t *ioCpl);
 
ptxStatus_t ptxIoRq_Push(ptxIoRq_t *ioCpl, pptxIoRqCompletion_t ioCompletionFn, void *ioData, size_t ioDataLength, void *ioCompletionComp);
 
ptxStatus_t ptxIoRq_Pop(ptxIoRq_t *ioCpl, pptxIoRqCompletion_t *ioCompletionFn, void **ioData, size_t *ioDataLength, void **ioCompletionComp);
 
ptxStatus_t ptxIoRq_SetItemState(struct ptxIoRq *ioRqItem, uint8_t ioState);
 
ptxStatus_t ptxIoRq_CallCompletion(
        pptxIoRqCompletion_t followingCompletion,
        struct ptxIoRq *ioRq,
        void *cplUpperLayer,
        void *data,
        size_t dataLength,
        ptxStatus_t cplStatus);
 
ptxStatus_t ptxIoRq_PopCallCompletion(
        struct ptxIoRq *ioRq,
        struct ptxLog *logComp,
        void *ioData,
        size_t ioDataLength,
        ptxStatus_t cplStatus);
 
ptxStatus_t ptxIoRq_SetPoolItem(ptxIoRq_t *ioRqItem, ptxBufferPool_Item_t *bufferItem);
 
ptxBufferPool_Item_t *ptxIoRq_GetPoolItem(ptxIoRq_t *ioRqItem);
 
 // grp_stack_io
 
#ifdef __cplusplus
}
#endif
 
#endif