Pkt Basic Exported Macros

Macros
#define	S2LPPktBasicSetPreambleLength(xPreambleLength)   S2LPSetPreambleLength(xPreambleLength)
	Sets the PREAMBLE field length for S2LP Basic packets. More...
#define	S2LPPktBasicGetPreambleLength()   S2LPGetPreambleLength()
	Returns the PREAMBLE field length mode for S2LP Basic packets. More...
#define	S2LPPktBasicSetSyncLength(xSyncLength)   S2LPSetSyncLength((PktSyncLength)xSyncLength)
	Sets the SYNC field length for S2LP Basic packets. More...
#define	S2LPPktBasicGetSyncLength()   S2LPGetSyncLength()
	Returns the SYNC field length for S2LP Basic packets. More...
#define	S2LPPktBasicFilterOnCrc(xNewState)   S2LPPktCommonFilterOnCrc(xNewState)
	Enables or Disables the CRC filtering. More...
#define	S2LPPktBasicWhitening(xNewState)   S2LPWhitening(xNewState)
	Enables or Disables WHITENING for S2LP packets. More...
#define	S2LPPktBasicFec(xNewState)   S2LPFec(xNewState)
	Enables or Disables FEC for S2LP Basic packets. More...
#define	S2LPPktBasicSetSyncWords(lSyncWords, xSyncLength)   S2LPSetSyncWords(lSyncWords, xSyncLength)
	Sets multiple SYNC words for S2LP Basic packets. More...

Detailed Description

Macro Definition Documentation

S2LPPktBasicFec

#define S2LPPktBasicFec

(

xNewState

)

S2LPFec(xNewState)

Parameters

xNewState

new state for FEC mode. This parameter can be S_ENABLE or S_DISABLE.

Return values

None.

Definition at line 214 of file S2LP_PktBasic.h.

S2LPPktBasicFilterOnCrc

#define S2LPPktBasicFilterOnCrc

(

xNewState

)

S2LPPktCommonFilterOnCrc(xNewState)

Parameters

xNewState

new state for CRC_CHECK. This parameter can be S_ENABLE or S_DISABLE.

Return values

None.

Definition at line 196 of file S2LP_PktBasic.h.

S2LPPktBasicGetPreambleLength

#define S2LPPktBasicGetPreambleLength

(

)

S2LPGetPreambleLength()

Parameters

None.

Return values

uint8_t

Preamble field length in bytes.

Definition at line 170 of file S2LP_PktBasic.h.

S2LPPktBasicGetSyncLength

#define S2LPPktBasicGetSyncLength

(

)

S2LPGetSyncLength()

Parameters

None.

Return values

uint8_t

SYNC field length in bytes.

Definition at line 187 of file S2LP_PktBasic.h.

S2LPPktBasicSetPreambleLength

#define S2LPPktBasicSetPreambleLength

(

xPreambleLength

)

S2LPSetPreambleLength(xPreambleLength)

Parameters

xPreambleLength

length of PREAMBLE field in bytes. This parameter can be any value of BasicPreambleLength.

Return values

None.

Definition at line 162 of file S2LP_PktBasic.h.

S2LPPktBasicSetSyncLength

#define S2LPPktBasicSetSyncLength

(

xSyncLength

)

S2LPSetSyncLength((PktSyncLength)xSyncLength)

Parameters

xSyncLength

length of SYNC field in bytes. This parameter can be any value of BasicSyncLength.

Return values

None.

Definition at line 179 of file S2LP_PktBasic.h.

S2LPPktBasicSetSyncWords

#define S2LPPktBasicSetSyncWords	(		lSyncWords,
			xSyncLength
	)		S2LPSetSyncWords(lSyncWords, xSyncLength)

Parameters

lSyncWords	SYNC words to be set with format: 0x|SYNC1|SYNC2|SYNC3|SYNC4|. This parameter is a uint32_t.
xSyncLength	SYNC length in bytes. The 32bit word passed will be stored in the SYNCx registers from the MSb until the number of bytes in xSyncLength has been stored. This parameter is a BasicSyncLength.

Return values

None.

Definition at line 227 of file S2LP_PktBasic.h.

S2LPPktBasicWhitening

#define S2LPPktBasicWhitening

(

xNewState

)

S2LPWhitening(xNewState)

Parameters

xNewState

new state for WHITENING mode. This parameter can be S_ENABLE or S_DISABLE.

Return values

None.

Definition at line 205 of file S2LP_PktBasic.h.