Files
zTC1/mico-os/libraries/utilities/TLVUtils.h

82 lines
2.3 KiB
C

/**
******************************************************************************
* @file TLVUtils.h
* @author William Xu
* @version V1.0.0
* @date 05-May-2014
* @brief This header contains function prototypes that assist in TLV parsing
* and creation.
******************************************************************************
*
* The MIT License
* Copyright (c) 2014 MXCHIP Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is furnished
* to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
******************************************************************************
*/
#ifndef __TLVUtils_h__
#define __TLVUtils_h__
#include "common.h"
/** @addtogroup MICO_Middleware_Interface
* @{
*/
/** @defgroup MICO_TLV_Utils MiCO TLV Utils
* @brief Provide APIs for TLV Functions
* @{
*/
/**
* @brief ?
*
* @param inSrc: ?
* @param inEnd: ?
* @param outID: ?
* @param outData: ?
* @param outLen: ?
* @param outNext: ?
*
* @return kNoErr : on success.
* @return kGeneralErr : if an error occurred
*/
OSStatus TLVGetNext(
const uint8_t * inSrc,
const uint8_t * inEnd,
uint8_t * outID,
const uint8_t ** outData,
size_t * outLen,
const uint8_t ** outNext );
/**
* @}
*/
/**
* @}
*/
#endif // __TLVUtils_h__