easy-connect-wnc

Avnet » Code » Documentation

Avnet / easy-connect-wnc

Added support for the WNC M14A2A Cellular LTE Data Module.

Dependencies: WNC14A2AInterface

Embed: (wiki syntax)

« Back to documentation index

SPIRIT_PktBasic.c File Reference

Configuration and management of SPIRIT Basic packets. More...

Go to the source code of this file.

Functions
void	SpiritPktBasicInit (PktBasicInit *pxPktBasicInit)
	Initializes the SPIRIT Basic packet according to the specified parameters in the PktBasicInit struct.
void	SpiritPktBasicGetInfo (PktBasicInit *pxPktBasicInit)
	Returns the SPIRIT Basic packet structure according to the specified parameters in the registers.
void	SpiritPktBasicAddressesInit (PktBasicAddressesInit *pxPktBasicAddresses)
	Initializes the SPIRIT Basic packet addresses according to the specified parameters in the PktBasicAddressesInit struct.
void	SpiritPktBasicGetAddressesInfo (PktBasicAddressesInit *pxPktBasicAddresses)
	Returns the SPIRIT Basic packet addresses structure according to the specified parameters in the registers.
void	SpiritPktBasicSetFormat (void)
	Configures the Basic packet format as packet used by SPIRIT.
void	SpiritPktBasicAddressField (SpiritFunctionalState xAddressField)
	Sets the address length for SPIRIT Basic packets.
SpiritFunctionalState	SpiritPktBasicGetAddressField (void)
	Specifies if the Address field for SPIRIT Basic packets is enabled or disabled.
void	SpiritPktBasicSetPayloadLength (uint16_t nPayloadLength)
	Sets the payload length for SPIRIT Basic packets.
uint16_t	SpiritPktBasicGetPayloadLength (void)
	Returns the payload length for SPIRIT Basic packets.
uint16_t	SpiritPktBasicGetReceivedPktLength (void)
	Returns the packet length field of the received packet.
void	SpiritPktBasicSetVarLengthWidth (uint16_t nMaxPayloadLength, SpiritFunctionalState xAddressField, BasicControlLength xControlLength)
	Computes and sets the variable payload length for SPIRIT Basic packets.

Detailed Description

Configuration and management of SPIRIT Basic packets.

Author:: VMA division - AMS

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_PktBasic.c.