ptxNSC_Hal.h

Go to the documentation of this file.

 
#ifndef COMPS_NSC_PTXNSC_HAL_H_
#define COMPS_NSC_PTXNSC_HAL_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptxNSC_InternalTypes.h"
#include "ptxHal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
 
#define PTX_NSC_HAL_PAYLOAD_LENGTH_WI_MAX               (252u)         
#define PTX_NSC_HAL_WRITE_INSTRUCTION_MASK              (0x04u)        
#define PTX_NSC_HAL_WRITE_RANDOM_ADDRESS_MASK           (0x05u)        
#define PTX_NSC_HAL_READ_BUFFER_MASK                    (0x03u)        
#define PTX_NSC_HAL_WRITE_BUFFER_MASK                   (0x07u)        
#define PTX_NSC_HAL_READ_RANDOM_ADDRESS_MASK            (0x01u)        
#define PTX_NSC_HAL_READ_CONTINUOUS_ADDRESS_MASK        (0x02u)        
#define PTX_NSC_HAL_WRITE_CONTINUOUS_ADDRESS_MASK       (0x06u)        
#define PTX_NSC_HAL_BUFFER_ADDRESS_MASK                 (0x1Fu)        
#define PTX_NSC_HAL_ADDRESS_RAM_INITIAL                 (0x0000u)      
#define PTX_NSC_HAL_ADDRES_RAM_END                      (0x0FFFu)      
#define PTX_NSC_HAL_ADDRESS_SFR_INITIAL                 (0x1000u)      
#define PTX_NSC_HAL_ADDRES_SFR_END                      (0x10FFu)      
struct ptxNSC;
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxNSC_Hal_WriteBuffer_Async(struct ptxNSC *nscCtx, uint8_t addressOfBuffer, uint8_t* pPayload, size_t txLen );
 
ptxStatus_t ptxNSC_Hal_WriteRawData (struct ptxNSC *nscCtx, uint8_t* pPayload, size_t txLen );
 
ptxStatus_t ptxNSC_Hal_WriteInstruction_Synchronous (struct ptxNSC *nscCtx, uint16_t address, uint8_t* pPayload, size_t txLen );
 
ptxStatus_t ptxNSC_Hal_WRA (struct ptxNSC *nscCtx, uint16_t address, uint8_t value);
 
ptxStatus_t ptxNSC_Hal_WRA_HwAck (struct ptxNSC *nscCtx, uint16_t address, uint8_t value);
 
ptxStatus_t ptxNSC_Hal_WriteRandomAddressMulti_Synchronous (struct ptxNSC *nscCtx, ptxTypes_WRA_t *pWRA);
 
ptxStatus_t ptxNSC_Hal_WriteContinuousAddress_Synchronous (struct ptxNSC *nscCtx, uint16_t address, uint8_t *value, size_t length);
 
ptxStatus_t ptxNSC_Hal_WriteBuffer_Synchronous(struct ptxNSC *nscCtx, uint8_t addressOfBuffer, uint8_t* pPayload, size_t txLen );
 
ptxStatus_t ptxNSC_Hal_ReadRandomAddress_Synchronous (struct ptxNSC *nscCtx, uint16_t address, uint8_t *value);
 
ptxStatus_t ptxNSC_Hal_WriteInstruction_Framing (struct ptxNSC *nscCtx, uint16_t address, uint8_t* pPayload, size_t txLen );
 
ptxStatus_t ptxNSC_Hal_ReadBuffer_Synchronous (struct ptxNSC *nscCtx, uint8_t *payload, size_t *length);
 
ptxStatus_t ptxNSC_Hal_ReadContinuousAddress_Synchronous (struct ptxNSC *nscCtx, uint16_t address, size_t length, uint8_t *bytesReceived);
 
ptxHal_InterfaceType_t ptxNSC_Hal_GetActiveIfType (struct ptxNSC *nscCtx);
 
ptxStatus_t ptxNSC_Hal_Cancel(struct ptxNSC *nscCtx);
 
ptxStatus_t ptxNSC_Hal_TRx(struct ptxNSC *nscCtx, uint8_t *txBuf[], size_t txLen[], size_t numBuffers, uint8_t *rxBuf, size_t *rxLen);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */