Pkt STack Exported Macros

Macros
#define	S2LPPktStackSetPreambleLength(xPreambleLength)   S2LPSetPreambleLength(xPreambleLength)
	Sets the PREAMBLE Length mode for S2LP STack packets. More...
#define	S2LPPktStackGetPreambleLength()   S2LPGetPreambleLength()
	Returns the PREAMBLE Length mode for S2LP STack packets. More...
#define	S2LPPktStackSetSyncLength(xSyncLength)   S2LPSetSyncLength((PktSyncLength)xSyncLength)
	Sets the SYNC Length for S2LP STack packets. More...
#define	S2LPPktStackGetSyncLength()   S2LPGetSyncLength()
	Returns the SYNC Length for S2LP STack packets. More...
#define	S2LPPktStackFilterOnCrc(xNewState)   S2LPPktCommonFilterOnCrc(xNewState)
	Enables or Disables the CRC filtering. More...
#define	S2LPPktStackWhitening(xNewState)   S2LPWhitening(xNewState)
	Enables or Disables WHITENING for S2LP STack packets. More...
#define	S2LPPktStackFec(xNewState)   S2LPFec(xNewState)
	Enables or Disables FEC for S2LP STack packets. More...
#define	S2LPPktStackSetSyncWords(lSyncWords, xSyncLength)   S2LPSetSyncWords(lSyncWords,xSyncLength)
	Sets multiple SYNC words for S2LP STack packets. More...

Detailed Description

Macro Definition Documentation

S2LPPktStackFec

#define S2LPPktStackFec

(

xNewState

)

S2LPFec(xNewState)

Enables or Disables FEC for S2LP STack packets.

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_PktStack.h.

S2LPPktStackFilterOnCrc

#define S2LPPktStackFilterOnCrc

(

xNewState

)

S2LPPktCommonFilterOnCrc(xNewState)

Enables or Disables the CRC filtering.

Parameters

xNewState

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

Return values

None.

Definition at line 195 of file S2LP_PktStack.h.

S2LPPktStackGetPreambleLength

#define S2LPPktStackGetPreambleLength

(

)

S2LPGetPreambleLength()

Returns the PREAMBLE Length mode for S2LP STack packets.

Parameters

None.

Return values

uint8_t

Preamble length in bytes.

Definition at line 168 of file S2LP_PktStack.h.

S2LPPktStackGetSyncLength

#define S2LPPktStackGetSyncLength

(

)

S2LPGetSyncLength()

Returns the SYNC Length for S2LP STack packets.

Parameters

None.

Return values

uint8_t

Sync length in bytes.

Definition at line 185 of file S2LP_PktStack.h.

S2LPPktStackSetPreambleLength

#define S2LPPktStackSetPreambleLength

(

xPreambleLength

)

S2LPSetPreambleLength(xPreambleLength)

Sets the PREAMBLE Length mode for S2LP STack packets.

Parameters

xPreambleLength

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

Return values

None.

Definition at line 160 of file S2LP_PktStack.h.

S2LPPktStackSetSyncLength

#define S2LPPktStackSetSyncLength

(

xSyncLength

)

S2LPSetSyncLength((PktSyncLength)xSyncLength)

Sets the SYNC Length for S2LP STack packets.

Parameters

xSyncLength

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

Return values

None.

Definition at line 177 of file S2LP_PktStack.h.

S2LPPktStackSetSyncWords

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

Sets multiple SYNC words for S2LP STack packets.

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 StackSyncLength.

Return values

None.

Definition at line 226 of file S2LP_PktStack.h.

S2LPPktStackWhitening

#define S2LPPktStackWhitening

(

xNewState

)

S2LPWhitening(xNewState)

Enables or Disables WHITENING for S2LP STack packets.

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_PktStack.h.