1 /* 2 * This file is part of the openHiTLS project. 3 * 4 * openHiTLS is licensed under the Mulan PSL v2. 5 * You can use this software according to the terms and conditions of the Mulan PSL v2. 6 * You may obtain a copy of Mulan PSL v2 at: 7 * 8 * http://license.coscl.org.cn/MulanPSL2 9 * 10 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, 11 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, 12 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. 13 * See the Mulan PSL v2 for more details. 14 */ 15 16 #ifndef TLV_H 17 #define TLV_H 18 19 #include "hitls_build.h" 20 #ifdef HITLS_BSL_TLV 21 22 #include <stdint.h> 23 24 #ifdef __cplusplus 25 extern "C" { 26 #endif 27 28 #define TLV_HEADER_LENGTH (sizeof(uint32_t) + sizeof(uint32_t)) 29 30 typedef struct { 31 uint32_t type; 32 uint32_t length; 33 uint8_t *value; 34 } BSL_Tlv; 35 36 /** 37 * @ingroup bsl_tlv 38 * @brief Construct a TLV message based on the TLV structure. 39 * 40 * @param tlv [IN] TLV structure 41 * @param buffer [OUT] Message memory 42 * @param bufLen [IN] Memory length 43 * @param usedLen [OUT] Message length 44 * 45 * @retval BSL_SUCCESS successfully created. 46 * @retval BSL_TLV_ERR_BAD_PARAM Parameter incorrect 47 * @retval BSL_MEMCPY_FAIL Memory Copy Failure 48 */ 49 int32_t BSL_TLV_Pack(const BSL_Tlv *tlv, uint8_t *buffer, uint32_t bufLen, uint32_t *usedLen); 50 51 /** 52 * @ingroup bsl_tlv 53 * @brief Parse the TLV message of the specified type and generate the TLV structure. 54 * 55 * @param wantType [IN] TLV type 56 * @param data [IN] TLV message memory 57 * @param dataLen [IN] Message length 58 * @param tlv [OUT] TLV Structure 59 * @param readLen [OUT] Length of the parsed message 60 * 61 * @retval BSL_SUCCESS parsed successfully. 62 * @retval BSL_TLV_ERR_BAD_PARAM Parameter incorrect 63 * @retval BSL_MEMCPY_FAIL Memory Copy Failure 64 * @retval BSL_TLV_ERR_NO_WANT_TYPE No TLV found 65 */ 66 int32_t BSL_TLV_Parse(uint32_t wantType, const uint8_t *data, uint32_t dataLen, BSL_Tlv *tlv, uint32_t *readLen); 67 68 /** 69 * @ingroup bsl_tlv 70 * @brief Find the TLV of the specified type 71 * and calculate the offset from the memory start address to the TLV data. 72 * 73 * @param wantType [IN] TLV type 74 * @param data [IN] TLV message memory 75 * @param dataLen [IN] Message length 76 * @param offset [OUT] TLV data offset 77 * @param length [OUT] Data length 78 * 79 * @retval BSL_SUCCESS succeeded. 80 * @retval BSL_TLV_ERR_BAD_PARAM Parameter incorrect 81 * @retval BSL_TLV_ERR_NO_WANT_TYPE No TLV found 82 */ 83 int32_t BSL_TLV_FindValuePos(uint32_t wantType, const uint8_t *data, uint32_t dataLen, 84 uint32_t *offset, uint32_t *length); 85 86 #ifdef __cplusplus 87 } 88 #endif 89 #endif /* HITLS_BSL_TLV */ 90 #endif // TLV_H 91