ptxNscFactory.h

Go to the documentation of this file.

 
#ifndef PTX_NSC_FACTORY_H
#define PTX_NSC_FACTORY_H
 
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptxNSC_Interface.h"
#include "ptx_Fifo_IoRq.h"
#include "ptxNvm.h"
 
#if (defined (PTX_IOT_READER_API) || defined (PTX_POS_READER_API))
    #pragma push_macro("PTX_LIBFUNC")
    #undef PTX_LIBFUNC
    #define PTX_LIBFUNC
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES / INTERNALS
 * ####################################################################################################################
 */
 
typedef enum ptxNscFactory_P
{
    ptxNscFactory_P_Reserved_0,                 
    ptxNscFactory_P_Interface,                  
    ptxNscFactory_P_SpeedInit,                  
    ptxNscFactory_P_SpeedApp,                   
    ptxNscFactory_P_HwFlowControl,              
    ptxNscFactory_P_Type,                       
    ptxNscFactory_P_LogHistory,                 
    ptxNscFactory_P_BusAddress,                 
    ptxNscFactory_P_BufferPoolDbgLog,           
    ptxNscFactory_P_NscBufferSize,              
    ptxNscFactory_P_SetMaxDynLogConns,          
    ptxNscFactory_P_SetInitialNrCredits,        
    ptxNscFactory_P_SetCreditNtfTrigger,        
    ptxNscFactory_P_NSCCommandedBy,             
    ptxNscFactory_P_IrqGpioNum,                 
    ptxNscFactory_P_FTDITrxLog,                 
    ptxNscFactory_P_FTDISerialNumber,           
    /*
     * Item Count:
     *
     * CAUTION:
     *  If the number gets larger than 32 the member InitDefaultBits needs to be changed to a UInt64!
     */
    ptxNscFactory_P_Number
} ptxNscFactory_P_t;
 
typedef enum ptxNscFactoryAboveNsc
{
    ptxNscFactory_Integration,                      
    ptxNscFactory_NCI                               
    /*
     * Increased in case of more layers that can command NSC.
     */
}ptxNscFactoryAboveNsc_t;
 
typedef struct ptxNscFactoryDefaultInit
{
    ptxNscFactory_P_t       Param;                  
    uint8_t                *ParamBuffer;            
    uint32_t                ParamLengthOrValue;     
} ptxNscFactoryDefaultInit_t;
 
typedef struct ptxNscFactory
{
    ptxStatus_Comps_t       CompId;                 
    /*
     * Stack Components
     */
    ptxFifoIoRq_t           FifoIoRq;               
    ptxIoRq_t               IoRq;                   
    struct ptxThread       *ThreadFifoId;           
    struct ptxOsal         *OS;                     
    struct ptxHal          *HAL;                    
    struct ptxNCI          *NCI;                    
    ptxNSC_t               *NSC;                    
    struct ptxHCI          *HCI;                    
    ptxLog_t               *LOG;                    
    ptxNvm_t               *NVM;                    
    /*
     * Parameters. Set with \ref ptxNscFactory_SetParameter or with specific additional API functions.
     */
    uint8_t                *DevName;                
    size_t                  DevNameLength;          
    uint32_t                DevSpeedInit;           
    uint32_t                DevSpeedApp;            
    uint8_t                 HwFlowControl;          
    ptxHal_InterfaceType_t  DevType;                
    uint32_t                LogHistory;             
    uint16_t                BusAddress;             
    uint8_t                 BufferPoolDbgLogEn;     
    size_t                  NscBufferSize;          
    ptxNscFactoryAboveNsc_t NscCommandedBy;         
    uint8_t                 MaxDynLogConns;         
    uint8_t                 InitialNrCredits;       
    uint8_t                 CreditNtfTrigger;       
    uint8_t                 IoInterLogEn;           
    uint32_t                IrqGpioNum;             
    uint8_t                 IsLogExternal;          
    uint8_t                *DevSerialNumber;        
    size_t                  DevSerialNumberLength;  
    /*
     * Init Status Check Helper Variables:
     */
    uint8_t                 InitDefaultCount;       
    uint32_t                InitDefaultBits;        
    uint32_t                InitParamBits;          
} ptxNscFactory_t;
 
typedef struct ptxNscFactoryBuild
{
    struct ptxNCI          *NCI;                    
    ptxNSC_t               *NSC;                    
    struct ptxOsal         *OS;                     
    struct ptxHal          *HAL;                    
    ptxLog_t               *LOG;                    
    struct ptxHCI          *HCI;                    
    ptxNvm_t               *NVM;                    
    void                   *SystemContext;          
    void                   *IntComp;                
    pptxTbInt_GetIORQNtf_t  GetIORQDefault_NSC;     
    pptxTbInt_GetIORQNtf_t  GetIORDefault_NCI;      
} ptxNscFactoryBuild_t;
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
PTX_LIBFUNC ptxStatus_t ptxNscFactory_Init(ptxNscFactory_t *fCtx, struct ptxOsal **osAl, void *sysCtx);
 
PTX_LIBFUNC ptxStatus_t ptxNscFactory_DeInit(ptxNscFactory_t *fCtx);
 
PTX_LIBFUNC ptxStatus_t ptxNscFactory_SetParameter( ptxNscFactory_t *fCtx,
                                                    ptxNscFactory_P_t parType,
                                                    uint8_t *parBuf,
                                                    uint32_t parLenOrValue);
 
PTX_LIBFUNC ptxStatus_t ptxNscFactory_BuildStack(   ptxNscFactory_t *fCtx,
                                                    ptxNscFactoryBuild_t *cComps);
 
PTX_LIBFUNC ptxStatus_t ptxNscFactory_DestroyStack(ptxNscFactory_t *fCtx);
 
PTX_LIBFUNC ptxStatus_t ptxNscFactory_DestroyStack_Finalize(ptxNscFactory_t *fCtx);
 
PTX_LIBFUNC ptxStatus_t ptxNscFactory_SetLogExternal(ptxNscFactory_t *fCtx);
 
PTX_LIBFUNC ptxStatus_t ptxNscFactory_ClearLogExternal(ptxNscFactory_t *fCtx);
 
PTX_LIBFUNC ptxFifoIoRq_t* ptxNscFactory_GetFifo(ptxNscFactory_t *fCtx);
 
 
#ifdef __cplusplus
}
#endif
 
#if (defined (PTX_IOT_READER_API) || defined (PTX_POS_READER_API))
    #pragma pop_macro("PTX_LIBFUNC")
#endif
 
#endif /* Guard */