blob: dd256ecda065ef7fe8713b39e49f7feeb50d12c6 [file] [log] [blame]
rjw6c1fd8f2022-11-30 14:33:01 +08001/*****************************************************************************
2* Copyright Statement:
3* --------------------
4* This software is protected by Copyright and the information contained
5* herein is confidential. The software may not be copied and the information
6* contained herein may not be used or disclosed except with the written
7* permission of MediaTek Inc. (C) 2012
8*
9* BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
10* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
11* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
12* AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
13* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
14* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
15* NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
16* SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
17* SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
18* THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
19* NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
20* SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
21*
22* BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
23* LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
24* AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
25* OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
26* MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
27*
28* THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
29* WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
30* LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
31* RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
32* THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
33*
34*****************************************************************************/
35
36/*******************************************************************************
37 * Filename:
38 * ---------
39 * adt.h
40 *
41 * Project:
42 * --------
43 * MOLY
44 *
45 * Description:
46 * ------------
47 * ADT structure and interface
48 *
49 * Author:
50 * -------
51 * -------
52 *
53 * ==========================================================================
54 * $Log$
55 *
56 * 04 27 2017 yancy.chien
57 * [MOLY00242548] [DHL] Build warning removal
58 * Apply A style.
59 *
60 * 04 27 2017 yancy.chien
61 * [MOLY00242548] [DHL] Build warning removal
62 * Apply A style.
63 *
64 * 05 07 2014 eason.lai
65 * [MOLY00064969] [DHL]expand tab to 4 spaces to have better typesettings
66 * .
67 *
68 * 11 07 2012 ken.liu
69 * [MOLY00005322] TATAKA merge to MOLY
70 * dhl module check-in.
71 ****************************************************************************/
72
73#ifndef _ADT_H
74#define _ADT_H
75
76#include "kal_public_defs.h"
77
78typedef struct adt_node
79{
80 kal_int32 data_len;
81 void *data;
82 struct adt_node *first_child;
83 struct adt_node *next_sibling;
84} adt_node_t;
85
86/**
87 * @brief pack adt tree into bytes
88 * @param root root node of adt tree
89 * @param buf pointer to byte buffer (caller-free)
90 * @return number of packed bytes
91 */
92int adt_pack(adt_node_t *root, unsigned char **buf);
93
94/**
95 * @brief unpack adt tree from bytes
96 * @param root root node of adt tree (caller-free)
97 * @param buf byte buffer
98 * @param buf_len length of byte buffer
99 * @return number of bytes processed
100 */
101int adt_unpack(adt_node_t **root, unsigned char *buf, int buf_len);
102
103/**
104 * @brief free adt tree
105 * @param root root node of adt tree
106 */
107void adt_free(adt_node_t *root);
108
109#endif