S2LP_PacketHandler.h

Go to the documentation of this file.

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __S2LP_PKT_COMMON_H
#define __S2LP_PKT_COMMON_H

/* Includes ------------------------------------------------------------------*/

#include "S2LP_Regs.h"
#include "S2LP_Types.h"

#ifdef __cplusplus
 extern "C" {
#endif


typedef enum {
  PKT_NO_CRC               = 0x00, 
  PKT_CRC_MODE_8BITS       = 0x20, 
  PKT_CRC_MODE_16BITS_1    = 0x40, 
  PKT_CRC_MODE_16BITS_2    = 0x60, 
  PKT_CRC_MODE_24BITS      = 0x80, 
  PKT_CRC_MODE_32BITS      = 0xA0, 
} PktCrcMode;


typedef enum
{
  NORMAL_TX_MODE = 0x00,          
  DIRECT_TX_FIFO_MODE = 0x04,     
  DIRECT_TX_GPIO_MODE = 0x08,     
  PN9_TX_MODE = 0x0C              
} DirectTx;


typedef enum
{
  NORMAL_RX_MODE = 0x00,          
  DIRECT_RX_FIFO_MODE = 0x10,     
  DIRECT_RX_GPIO_MODE = 0x20      
} DirectRx;


#define S2LPSetPreambleLengthByte(xPreambleLength)      S2LPSetPreambleLength(4*xPreambleLength)
#define S2LPSetSyncLengthByte(cSyncLength)              S2LPSetSyncLength(8*cSyncLength)

#define IS_PREAMBLE_LEN(VAL)  (VAL<=1024)
#define IS_SYNC_LEN(VAL)      (VAL<=64)

#define IS_PKT_LEN_FIELD_WID(LENGTH)   ((LENGTH == PKT_LENGTH_FIELD_1BYTE) || \
                                        (LENGTH == PKT_LENGTH_FIELD_2BYTE))


#define IS_PKT_CRC_MODE(MODE)   ((MODE == PKT_NO_CRC) || \
                                (MODE == PKT_CRC_MODE_8BITS)  || \
                                (MODE == PKT_CRC_MODE_16BITS_1)  || \
                                (MODE == PKT_CRC_MODE_16BITS_2) || \
                                (MODE == PKT_CRC_MODE_24BITS))

void S2LPSetPreambleLength(uint16_t cPreambleLength);
uint16_t S2LPGetPreambleLength(void);
void S2LPSetSyncLength(uint8_t cSyncLength);
uint8_t S2LPGetSyncLength(void);
void S2LPSetSyncWords(uint32_t lSyncWords, uint8_t xSyncLength);
void S2LPGetSyncWords(uint32_t* lSyncWords, uint8_t* cSyncLength);
void S2LPPacketHandlerWhitening(SFunctionalState xNewState);
void S2LPPacketHandlerFec(SFunctionalState xNewState);
void S2LPPacketHandler3OutOf6(SFunctionalState xNewState);
void S2LPPacketHandlerManchester(SFunctionalState xNewState);
uint8_t S2LPGetPacketFormat(void);
void S2LPPktCommonFilterOnCrc(SFunctionalState xNewState);
uint8_t S2LPGetReceivedDestinationAddress(void);
uint8_t S2LPGetReceivedSourceAddress(void);
uint8_t S2LPGetMyAddress(void);
uint8_t S2LPGetBroadcastAddress(void);
uint8_t S2LPGetMulticastAddress(void);
uint8_t S2LPGetRxSourceMask(void);
uint8_t S2LPGetRxSourceReferenceAddress(void);
void S2LPPacketHandlerSetTxMode(DirectTx xNewState);
void S2LPPacketHandlerSetRxMode(DirectRx xNewState);
DirectTx S2LPPacketHandlerGetTxMode(void);
DirectRx S2LPPacketHandlerGetRxMode(void);
uint8_t S2LPPacketHandlerGetTransmittedSeqNumber(void);
void S2LPPacketHandlerSetExtendedLenField(SFunctionalState xExtendedLenField);
void S2LPPacketHandlerSwap4FSKSymbol(SFunctionalState xSwapSymbol);
void S2LPPacketHandlerSwapFifoEndianess(SFunctionalState xEnableSwap);
void S2LPPacketHandlerSwapPreamblePattern(SFunctionalState xEnableSwap);
void S2LPPacketHandlerSetCrcMode(PktCrcMode xPktCrcMode);
PktCrcMode S2LPPacketHandlerGetCrcMode(void);
void S2LPPacketHandlerSelectSecondarySync(SFunctionalState xSecondarySync);
void S2LPPacketHandlerSetAutoPcktFilter(SFunctionalState xNewState);
void S2LPPacketHandlerSetRxPersistentMode(SFunctionalState xNewState);
void S2LPPacketHandlerSetSrcAddrFlt(SFunctionalState xNewState);
void S2LPPacketHandlerSetVariableLength(SFunctionalState xVarLen);
void S2LPSetDualSyncWords(uint32_t lSyncWords);
void S2LPGetDualSyncWords(uint32_t* lSyncWords);
void S2LPSetRxSourceMask(uint8_t address);
void S2LPSetRxSourceReferenceAddress(uint8_t address);
void S2LPSetBroadcastAddress(uint8_t address);
void S2LPSetMulticastAddress(uint8_t address);
void S2LPSetMyAddress(uint8_t address);
uint8_t S2LPGetMyAddress(void);


#ifdef __cplusplus
}
#endif

#endif

/******************* (C) COPYRIGHT 2016 STMicroelectronics *****END OF FILE****/