Added support for the WNC M14A2A Cellular LTE Data Module.
Dependencies: WNC14A2AInterface
SPIRIT_PktCommon.c File Reference
Configuration and management of the common features of SPIRIT packets. More...
Go to the source code of this file.
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. |
Detailed Description
Configuration and management of the common features of SPIRIT packets.
- Version:
- 3.2.2
- Date:
- 08-July-2015
- Attention:
© COPYRIGHT(c) 2015 STMicroelectronics
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Definition in file SPIRIT_PktCommon.c.
Generated on Tue Jul 12 2022 19:09:04 by 1.7.2