WizziLab / modem_ref_v5_3_217

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   modem_ref_helper_for_v5_3_217

Embed: (wiki syntax)

« Back to documentation index

alp_helpers.h File Reference
Functions

alp_helpers.h File Reference

========================================================================={{{ Copyright (c) 2012-2013 WizziLab / All rights reserved / / IMPORTANT: This Software may not be modified, copied or distributed unless / embedded on a WizziLab product. More...

Go to the source code of this file.

Functions

public uint alp_size (u8 op, u32 offset, u32 length)
 Return payload length of most ALP operations.
public u8 alp_encode_length (u8 *p, u32 len)
 Encodes an ALP length/offset field.
public u32 alp_decode_length (u8 **p, u8 *actp)
 Decodes an ALP length/offset field.
public int alp_parse_chunk (u8 **payload, alp_parsed_chunk_t *resp)
 Parses an ALP response payload to a more generic alp_parsed_chunk_t structure.

Detailed Description

========================================================================={{{ Copyright (c) 2012-2013 WizziLab / All rights reserved / / IMPORTANT: This Software may not be modified, copied or distributed unless / embedded on a WizziLab product.

Other than for the foregoing purpose, this / Software and/or its documentation may not be used, reproduced, copied, / prepared derivative works of, modified, performed, distributed, displayed / or sold for any purpose. For the sole purpose of embedding this Software / on a WizziLab product, copy, modification and distribution of this / Software is granted provided that the following conditions are respected: / / Redistributions of source code must retain the above copyright notice, / this list of conditions and the following disclaimer / / 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. / / The name of WizziLab can not 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. / WIZZILAB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, / ENHANCEMENTS OR MODIFICATIONS. / / Should you have any questions regarding your right to use this Software, / contact WizziLab at www.wizzilab.com. / / =========================================================================}}}

Definition in file alp_helpers.h.

Function Documentation

public u32 alp_decode_length ( u8 **  p,
u8 *  actp 
)

Decodes an ALP length/offset field.

Parameters:
p: pointer to the pointer to payload buffer
actp: pointer to ALP's Action Protocol Substitution flag Result amongst alp_actp_substitution_mode_t
Return values:
decodedvalue

Definition at line 115 of file alp_helpers.cpp.

public u8 alp_encode_length ( u8 *  p,
u32  len 
)

Encodes an ALP length/offset field.

Parameters:
p: pointer to the payload buffer
len: value to be encoded
Return values:
resultingpayload size in bytes

Definition at line 75 of file alp_helpers.cpp.

public int alp_parse_chunk ( u8 **  payload,
alp_parsed_chunk_t *  resp 
)

Parses an ALP response payload to a more generic alp_parsed_chunk_t structure.

Parameters:
payload: pointer to the pointer to payload buffer
resp: pointer to alp_parsed_chunk_t structure
Return values:
numberof parsed bytes

Parses an ALP response payload to a more generic alp_parsed_chunk_t structure.

Parameters:
payload: pointer to the pointer to payload buffer
resp: pointer to alp_parsed_chunk_t structure
Return values:
numberof parsed bytes

Definition at line 166 of file alp_helpers.cpp.

public uint alp_size ( u8  op,
u32  offset,
u32  length 
)

Return payload length of most ALP operations.

Parameters:
op: ALP Action amongst alp_opcodes_t
offset: Associated Offset if relevant
size: Associated Size if relevant
Return values:
payloadsize in bytes

Return payload length of most ALP operations.

/ / =========================================================================}}} Return payload length of most ALP operations

Parameters:
op: ALP Action amongst alp_opcodes_t
offset: Associated Offset if relevant
size: Associated Size if relevant
Return values:
payloadsize in bytes

Definition at line 31 of file alp_helpers.cpp.

Generated on Wed Jul 20 2022 12:33:07 by  doxygen 1.7.2