Added support for the WNC M14A2A Cellular LTE Data Module.
Dependencies: WNC14A2AInterface
Pkt Common Private Functions
[SPIRIT_PktCommon]
Functions | |
void | SpiritPktCommonSetControlLength (PktControlLength xControlLength) |
Sets the CONTROL field length for SPIRIT packets. | |
uint8_t | SpiritPktCommonGetControlLength (void) |
Returns the CONTROL field length for SPIRIT packets. | |
void | SpiritPktCommonSetPreambleLength (PktPreambleLength xPreambleLength) |
Sets the PREAMBLE field Length mode for SPIRIT packets. | |
uint8_t | SpiritPktCommonGetPreambleLength (void) |
Returns the PREAMBLE field Length mode for SPIRIT packets. | |
void | SpiritPktCommonSetSyncLength (PktSyncLength xSyncLength) |
Sets the SYNC field Length for SPIRIT packets. | |
uint8_t | SpiritPktCommonGetSyncLength (void) |
Returns the SYNC field Length for SPIRIT packets. | |
void | SpiritPktCommonSetFixVarLength (PktFixVarLength xFixVarLength) |
Sets fixed or variable payload length mode for SPIRIT packets. | |
void | SpiritPktCommonFilterOnCrc (SpiritFunctionalState xNewState) |
Enables or Disables the filtering on CRC. | |
SpiritFunctionalState | SpiritPktCommonGetFilterOnCrc (void) |
Returns the CRC filtering enable bit. | |
void | SpiritPktCommonSetCrcMode (PktCrcMode xCrcMode) |
Sets the CRC mode for SPIRIT packets. | |
PktCrcMode | SpiritPktCommonGetCrcMode (void) |
Returns the CRC mode for SPIRIT packets. | |
void | SpiritPktCommonWhitening (SpiritFunctionalState xNewState) |
Enables or Disables WHITENING for SPIRIT packets. | |
void | SpiritPktCommonFec (SpiritFunctionalState xNewState) |
Enables or Disables FEC for SPIRIT packets. | |
void | SpiritPktCommonSetSyncxWord (PktSyncX xSyncX, uint8_t cSyncWord) |
Sets a specific SYNC word for SPIRIT packets. | |
uint8_t | SpiritPktCommonGetSyncxWord (PktSyncX xSyncX) |
Returns a specific SYNC word for SPIRIT packets. | |
void | SpiritPktCommonSetSyncWords (uint32_t lSyncWords, PktSyncLength xSyncLength) |
Sets multiple SYNC words for SPIRIT packets. | |
uint32_t | SpiritPktCommonGetSyncWords (PktSyncLength xSyncLength) |
Returns multiple SYNC words for SPIRIT packets. | |
uint8_t | SpiritPktCommonGetVarLengthWidth (void) |
Returns the variable length width (in number of bits). | |
void | SpiritPktCommonSetDestinationAddress (uint8_t cAddress) |
Sets the destination address for the Tx packet. | |
uint8_t | SpiritPktCommonGetTransmittedDestAddress (void) |
Returns the settled destination address. | |
void | SpiritPktCommonSetMyAddress (uint8_t cAddress) |
Sets the node my address. | |
uint8_t | SpiritPktCommonGetMyAddress (void) |
Returns the address of the present node. | |
void | SpiritPktCommonSetBroadcastAddress (uint8_t cAddress) |
Sets the broadcast address. | |
uint8_t | SpiritPktCommonGetBroadcastAddress (void) |
Returns the broadcast address. | |
void | SpiritPktCommonSetMulticastAddress (uint8_t cAddress) |
Sets the multicast address. | |
uint8_t | SpiritPktCommonGetMulticastAddress (void) |
Returns the multicast address. | |
void | SpiritPktCommonSetCtrlMask (uint32_t lMask) |
Sets the control mask. | |
uint32_t | SpiritPktCommonGetCtrlMask (void) |
Returns the control mask. | |
void | SpiritPktCommonSetCtrlReference (uint32_t lReference) |
Sets the control field reference. | |
uint32_t | SpiritPktCommonGetCtrlReference (void) |
Returns the control field reference. | |
void | SpiritPktCommonSetTransmittedCtrlField (uint32_t lField) |
Sets the TX control field. | |
uint32_t | SpiritPktCommonGetTransmittedCtrlField (void) |
Returns the Tx control field. | |
void | SpiritPktCommonFilterOnMyAddress (SpiritFunctionalState xNewState) |
If enabled RX packet is accepted if its destination address matches with My address. | |
void | SpiritPktCommonFilterOnMulticastAddress (SpiritFunctionalState xNewState) |
If enabled RX packet is accepted if its destination address matches with multicast address. | |
void | SpiritPktCommonFilterOnBroadcastAddress (SpiritFunctionalState xNewState) |
If enabled RX packet is accepted if its destination address matches with broadcast address. | |
SpiritFunctionalState | SpiritPktCommonGetFilterOnMyAddress (void) |
Returns the enable bit of the my address filtering. | |
SpiritFunctionalState | SpiritPktCommonGetFilterOnMulticastAddress (void) |
Returns the enable bit of the multicast address filtering. | |
SpiritFunctionalState | SpiritPktCommonGetFilterOnBroadcastAddress (void) |
Returns the enable bit of the broadcast address filtering. | |
uint8_t | SpiritPktCommonGetReceivedDestAddress (void) |
Returns the destination address of the received packet. | |
uint32_t | SpiritPktCommonGetReceivedCtrlField (void) |
Returns the control field of the received packet. | |
void | SpiritPktCommonGetReceivedCrcField (uint8_t *cCrcFieldVect) |
Returns the CRC field of the received packet. | |
void | SpiritPktCommonAutoAck (SpiritFunctionalState xAutoAck, SpiritFunctionalState xPiggybacking) |
Sets the AUTO ACKNOLEDGEMENT mechanism on the receiver. | |
void | SpiritPktCommonRequireAck (SpiritFunctionalState xNewState) |
Sets the AUTO ACKNOLEDGEMENT mechanism on the transmitter. | |
void | SpiritPktCommonSetTransmittedSeqNumberReload (uint8_t cSeqNumberReload) |
Sets the TX sequence number to be used to start counting. | |
void | SpiritPktCommonSetNMaxReTx (PktNMaxReTx xNMaxReTx) |
Sets the TX sequence number to be used to start counting. | |
uint8_t | SpiritPktCommonGetNMaxReTx (void) |
Returns the max number of automatic retransmission. | |
SpiritFunctionalState | SpiritPktCommonGetTxAckRequest (void) |
Returns the TX ACK request. | |
uint8_t | SpiritPktCommonGetReceivedSourceAddress (void) |
Returns the source address of the received packet. | |
uint8_t | SpiritPktCommonGetReceivedSeqNumber (void) |
Returns the sequence number of the received packet. | |
uint8_t | SpiritPktCommonGetReceivedNackRx (void) |
Returns the Nack bit of the received packet. | |
uint8_t | SpiritPktCommonGetTransmittedSeqNumber (void) |
Returns the sequence number of the transmitted packet. | |
uint8_t | SpiritPktCommonGetNReTx (void) |
Returns the number of retransmission done on the transmitted packet. | |
void | SpiritPktCommonFilterOnControlField (SpiritFunctionalState xNewState) |
If enabled RX packet is accepted only if the masked control field matches the masked control field reference (CONTROL_MASK & CONTROL_FIELD_REF == CONTROL_MASK & RX_CONTROL_FIELD). | |
SpiritFunctionalState | SpiritPktCommonGetFilterOnControlField (void) |
Returns the enable bit of the control field filtering. |
Function Documentation
void SpiritPktCommonAutoAck | ( | SpiritFunctionalState | xAutoAck, |
SpiritFunctionalState | xPiggybacking | ||
) |
Sets the AUTO ACKNOLEDGEMENT mechanism on the receiver.
When the feature is enabled and a data packet has been correctly received, then an acknowledgement packet is sent back to the originator of the received packet. If the PIGGYBACKING bit is also set, payload data will be read from the FIFO; otherwise an empty packet is sent only containing the source and destination addresses and the sequence number of the packet being acknowledged.
- Parameters:
-
xAutoAck new state for autoack. This parameter can be: S_ENABLE or S_DISABLE. xPiggybacking new state for autoack. This parameter can be: S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 1127 of file SPIRIT_PktCommon.c.
void SpiritPktCommonFec | ( | SpiritFunctionalState | xNewState ) |
Enables or Disables FEC for SPIRIT packets.
- Parameters:
-
xNewState new state for FEC mode. This parameter can be S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 408 of file SPIRIT_PktCommon.c.
void SpiritPktCommonFilterOnBroadcastAddress | ( | SpiritFunctionalState | xNewState ) |
If enabled RX packet is accepted if its destination address matches with broadcast address.
- Parameters:
-
xNewState new state for DEST_VS_BROADCAST_ADDRESS. This parameter can be S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 935 of file SPIRIT_PktCommon.c.
void SpiritPktCommonFilterOnControlField | ( | SpiritFunctionalState | xNewState ) |
If enabled RX packet is accepted only if the masked control field matches the masked control field reference (CONTROL_MASK & CONTROL_FIELD_REF == CONTROL_MASK & RX_CONTROL_FIELD).
- Parameters:
-
xNewState new state for Control filtering enable bit. This parameter can be S_ENABLE or S_DISABLE.
- Return values:
-
None.
- Note:
- This filtering control is enabled by default but the control mask is by default set to 0. As a matter of fact the user has to enable the control filtering bit after the packet initialization because the PktInit routine disables it.
Definition at line 1387 of file SPIRIT_PktCommon.c.
void SpiritPktCommonFilterOnCrc | ( | SpiritFunctionalState | xNewState ) |
Enables or Disables the filtering on CRC.
- Parameters:
-
xNewState new state for CRC_CHECK. This parameter can be S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 274 of file SPIRIT_PktCommon.c.
void SpiritPktCommonFilterOnMulticastAddress | ( | SpiritFunctionalState | xNewState ) |
If enabled RX packet is accepted if its destination address matches with multicast address.
- Parameters:
-
xNewState new state for DEST_VS_MULTICAST_ADDRESS. This parameter can be S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 903 of file SPIRIT_PktCommon.c.
void SpiritPktCommonFilterOnMyAddress | ( | SpiritFunctionalState | xNewState ) |
If enabled RX packet is accepted if its destination address matches with My address.
- Parameters:
-
xNewState new state for DEST_VS_SOURCE_ADDRESS. This parameter can be S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 870 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetBroadcastAddress | ( | void | ) |
Returns the broadcast address.
- Parameters:
-
None.
- Return values:
-
uint8_t Broadcast address.
Definition at line 676 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetControlLength | ( | void | ) |
Returns the CONTROL field length for SPIRIT packets.
- Parameters:
-
None.
- Return values:
-
uint8_t Control field length.
Definition at line 142 of file SPIRIT_PktCommon.c.
PktCrcMode SpiritPktCommonGetCrcMode | ( | void | ) |
Returns the CRC mode for SPIRIT packets.
- Parameters:
-
None.
- Return values:
-
PktCrcMode Crc mode.
Definition at line 357 of file SPIRIT_PktCommon.c.
uint32_t SpiritPktCommonGetCtrlMask | ( | void | ) |
Returns the control mask.
The 1 bits of the CONTROL_MASK indicate the bits to be used in filtering. (All 0s no filtering)
- Parameters:
-
None.
- Return values:
-
uint32_t Control mask.
Definition at line 751 of file SPIRIT_PktCommon.c.
uint32_t SpiritPktCommonGetCtrlReference | ( | void | ) |
Returns the control field reference.
- Parameters:
-
None.
- Return values:
-
uint32_t Control reference.
Definition at line 798 of file SPIRIT_PktCommon.c.
SpiritFunctionalState SpiritPktCommonGetFilterOnBroadcastAddress | ( | void | ) |
Returns the enable bit of the broadcast address filtering.
- Parameters:
-
None.
- Return values:
-
SpiritFunctionalState This parameter can be S_ENABLE or S_DISABLE.
Definition at line 1014 of file SPIRIT_PktCommon.c.
SpiritFunctionalState SpiritPktCommonGetFilterOnControlField | ( | void | ) |
Returns the enable bit of the control field filtering.
- Parameters:
-
None.
- Return values:
-
SpiritFunctionalState This parameter can be S_ENABLE or S_DISABLE.
Definition at line 1419 of file SPIRIT_PktCommon.c.
SpiritFunctionalState SpiritPktCommonGetFilterOnCrc | ( | void | ) |
Returns the CRC filtering enable bit.
- Parameters:
-
None.
- Return values:
-
SpiritFunctionalState CRC filtering.
Definition at line 305 of file SPIRIT_PktCommon.c.
SpiritFunctionalState SpiritPktCommonGetFilterOnMulticastAddress | ( | void | ) |
Returns the enable bit of the multicast address filtering.
- Parameters:
-
None.
- Return values:
-
SpiritFunctionalState This parameter can be S_ENABLE or S_DISABLE.
Definition at line 990 of file SPIRIT_PktCommon.c.
SpiritFunctionalState SpiritPktCommonGetFilterOnMyAddress | ( | void | ) |
Returns the enable bit of the my address filtering.
- Parameters:
-
None.
- Return values:
-
SpiritFunctionalState This parameter can be S_ENABLE or S_DISABLE.
Definition at line 966 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetMulticastAddress | ( | void | ) |
Returns the multicast address.
- Parameters:
-
None.
- Return values:
-
uint8_t Multicast address.
Definition at line 709 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetMyAddress | ( | void | ) |
Returns the address of the present node.
- Parameters:
-
None.
- Return values:
-
uint8_t My address (address of this node).
Definition at line 643 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetNMaxReTx | ( | void | ) |
Returns the max number of automatic retransmission.
- Parameters:
-
None.
- Return values:
-
uint8_t Max number of retransmissions. This parameter is an uint8_t.
Definition at line 1256 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetNReTx | ( | void | ) |
Returns the number of retransmission done on the transmitted packet.
- Parameters:
-
None.
- Return values:
-
uint8_t Number of retransmissions done until now.
Definition at line 1364 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetPreambleLength | ( | void | ) |
Returns the PREAMBLE field Length mode for SPIRIT packets.
- Parameters:
-
None.
- Return values:
-
uint8_t Preamble field length in bytes.
Definition at line 184 of file SPIRIT_PktCommon.c.
void SpiritPktCommonGetReceivedCrcField | ( | uint8_t * | cCrcFieldVect ) |
Returns the CRC field of the received packet.
- Parameters:
-
cCrcFieldVect array in which the CRC field has to be stored. This parameter is an uint8_t array of 3 elements.
- Return values:
-
None.
Definition at line 1082 of file SPIRIT_PktCommon.c.
uint32_t SpiritPktCommonGetReceivedCtrlField | ( | void | ) |
Returns the control field of the received packet.
- Parameters:
-
None.
- Return values:
-
uint32_t Received control field.
Definition at line 1057 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetReceivedDestAddress | ( | void | ) |
Returns the destination address of the received packet.
- Parameters:
-
None.
- Return values:
-
uint8_t Destination address of the received address.
Definition at line 1039 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetReceivedNackRx | ( | void | ) |
Returns the Nack bit of the received packet.
- Parameters:
-
None.
- Return values:
-
uint8_t Value of the Nack bit.
Definition at line 1328 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetReceivedSeqNumber | ( | void | ) |
Returns the sequence number of the received packet.
- Parameters:
-
None.
- Return values:
-
uint8_t Received Sequence number.
Definition at line 1310 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetReceivedSourceAddress | ( | void | ) |
Returns the source address of the received packet.
- Parameters:
-
None.
- Return values:
-
uint8_t Source address of the received packet.
Definition at line 1292 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetSyncLength | ( | void | ) |
Returns the SYNC field Length for SPIRIT packets.
- Parameters:
-
None.
- Return values:
-
uint8_t Sync field length in bytes.
Definition at line 228 of file SPIRIT_PktCommon.c.
uint32_t SpiritPktCommonGetSyncWords | ( | PktSyncLength | xSyncLength ) |
Returns multiple SYNC words for SPIRIT packets.
- Parameters:
-
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 pointer to PktSyncLength.
- Return values:
-
uint32_t Sync words. The format of the read 32 bit word is 0x|SYNC1|SYNC2|SYNC3|SYNC4|.
Definition at line 550 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetSyncxWord | ( | PktSyncX | xSyncX ) |
Returns a specific SYNC word for SPIRIT packets.
- Parameters:
-
xSyncX SYNC word number to be get. This parameter can be any value of PktSyncX.
- Return values:
-
uint8_t Sync word x.
Definition at line 478 of file SPIRIT_PktCommon.c.
uint32_t SpiritPktCommonGetTransmittedCtrlField | ( | void | ) |
Returns the Tx control field.
- Parameters:
-
None.
- Return values:
-
uint32_t Control field of the transmitted packet.
Definition at line 844 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetTransmittedDestAddress | ( | void | ) |
Returns the settled destination address.
- Parameters:
-
None.
- Return values:
-
uint8_t Transmitted destination address.
Definition at line 610 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetTransmittedSeqNumber | ( | void | ) |
Returns the sequence number of the transmitted packet.
- Parameters:
-
None.
- Return values:
-
uint8_t Sequence number of the transmitted packet.
Definition at line 1346 of file SPIRIT_PktCommon.c.
SpiritFunctionalState SpiritPktCommonGetTxAckRequest | ( | void | ) |
Returns the TX ACK request.
- Parameters:
-
None.
- Return values:
-
uint8_t Max number of retransmissions. This parameter is an uint8_t.
Definition at line 1274 of file SPIRIT_PktCommon.c.
uint8_t SpiritPktCommonGetVarLengthWidth | ( | void | ) |
Returns the variable length width (in number of bits).
- Parameters:
-
None.
- Return values:
-
uint8_t Variable length width in bits.
Definition at line 578 of file SPIRIT_PktCommon.c.
void SpiritPktCommonRequireAck | ( | SpiritFunctionalState | xNewState ) |
Sets the AUTO ACKNOLEDGEMENT mechanism on the transmitter.
On the transmitter side, the NACK_TX field can be used to require or not an acknowledgment for each individual packet: if NACK_TX is set to "1" then acknowledgment will not be required; if NACK_TX is set to "0" then acknowledgment will be required.
- Parameters:
-
xNewState new state for TX_AUTOACK. This parameter can be: S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 1175 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetBroadcastAddress | ( | uint8_t | cAddress ) |
Sets the broadcast address.
If the destination address extracted from the received packet is equal to the content of the BROADCAST_ADDR register, then the packet is accepted.
- Parameters:
-
cAddress Broadcast address. This parameter is an uint8_t.
- Return values:
-
None.
Definition at line 663 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetControlLength | ( | PktControlLength | xControlLength ) |
Sets the CONTROL field length for SPIRIT packets.
- Parameters:
-
xControlLength length of CONTROL field in bytes. This parameter can be any value of PktControlLength.
- Return values:
-
None.
Definition at line 118 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetCrcMode | ( | PktCrcMode | xCrcMode ) |
Sets the CRC mode for SPIRIT packets.
- Parameters:
-
xCrcMode length of CRC field in bytes. This parameter can be any value of PktCrcMode.
- Return values:
-
None.
Definition at line 332 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetCtrlMask | ( | uint32_t | lMask ) |
Sets the control mask.
The 1 bits of the CONTROL_MASK indicate the bits to be used in filtering. (All 0s no filtering)
- Parameters:
-
lMask Control mask. This parameter is an uint32_t.
- Return values:
-
None.
Definition at line 729 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetCtrlReference | ( | uint32_t | lReference ) |
Sets the control field reference.
If the bits enabled by the CONTROL_MASK match the ones of the control fields extracted from the received packet then the packet is accepted.
- Parameters:
-
lReference Control reference. This parameter is an uint32_t.
- Return values:
-
None.
Definition at line 777 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetDestinationAddress | ( | uint8_t | cAddress ) |
Sets the destination address for the Tx packet.
- Parameters:
-
cAddress Destination address. This parameter is an uint8_t.
- Return values:
-
None.
Definition at line 597 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetFixVarLength | ( | PktFixVarLength | xFixVarLength ) |
Sets fixed or variable payload length mode for SPIRIT packets.
- Parameters:
-
xFixVarLength variable or fixed length. PKT_FIXED_LENGTH_VAR -> variable (the length is extracted from the received packet). PKT_FIXED_LENGTH_FIX -> fix (the length is set by PCKTLEN0 and PCKTLEN1).
- Return values:
-
None.
Definition at line 248 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetMulticastAddress | ( | uint8_t | cAddress ) |
Sets the multicast address.
When the multicast filtering is on, if the destination address extracted from the received packet is equal to the content of the MULTICAST_ADDR register, then the packet is accepted.
- Parameters:
-
cAddress Multicast address. This parameter is an uint8_t.
- Return values:
-
None.
Definition at line 696 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetMyAddress | ( | uint8_t | cAddress ) |
Sets the node my address.
When the filtering on my address is on, if the destination address extracted from the received packet is equal to the content of the my address, then the packet is accepted (this is the address of the node).
- Parameters:
-
cAddress Address of the present node. This parameter is an uint8_t.
- Return values:
-
None.
Definition at line 630 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetNMaxReTx | ( | PktNMaxReTx | xNMaxReTx ) |
Sets the TX sequence number to be used to start counting.
- Parameters:
-
cSeqNumberReload new value for Tx seq number reload. This parameter can be: S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 1230 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetPreambleLength | ( | PktPreambleLength | xPreambleLength ) |
Sets the PREAMBLE field Length mode for SPIRIT packets.
- Parameters:
-
xPreambleLength length of PREAMBLE field in bytes. This parameter can be any value of PktPreambleLength.
- Return values:
-
None.
Definition at line 160 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetSyncLength | ( | PktSyncLength | xSyncLength ) |
Sets the SYNC field Length for SPIRIT packets.
- Parameters:
-
xSyncLength length of SYNC field in bytes. This parameter can be any value of PktSyncLength.
- Return values:
-
None.
Definition at line 203 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetSyncWords | ( | uint32_t | lSyncWords, |
PktSyncLength | xSyncLength | ||
) |
Sets multiple SYNC words for SPIRIT 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 PktSyncLength.
- Return values:
-
None.
Definition at line 520 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetSyncxWord | ( | PktSyncX | xSyncX, |
uint8_t | cSyncWord | ||
) |
Sets a specific SYNC word for SPIRIT packets.
- Parameters:
-
xSyncX SYNC word number to be set. This parameter can be any value of PktSyncX. cSyncWord SYNC word. This parameter is an uint8_t.
- Return values:
-
None.
Definition at line 442 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetTransmittedCtrlField | ( | uint32_t | lField ) |
Sets the TX control field.
- Parameters:
-
lField Tx contro field. This parameter is an uint32_t.
- Return values:
-
None.
Definition at line 823 of file SPIRIT_PktCommon.c.
void SpiritPktCommonSetTransmittedSeqNumberReload | ( | uint8_t | cSeqNumberReload ) |
Sets the TX sequence number to be used to start counting.
- Parameters:
-
cSeqNumberReload new value for Tx seq number reload.
- Return values:
-
None.
Definition at line 1206 of file SPIRIT_PktCommon.c.
void SpiritPktCommonWhitening | ( | SpiritFunctionalState | xNewState ) |
Enables or Disables WHITENING for SPIRIT packets.
- Parameters:
-
xNewState new state for WHITENING mode. This parameter can be S_ENABLE or S_DISABLE.
- Return values:
-
None.
Definition at line 376 of file SPIRIT_PktCommon.c.
Generated on Tue Jul 12 2022 19:09:06 by 1.7.2