blob: 4596c7147c9b2767668a96db06cb9865415e7460 [file] [log] [blame]
yu.dongc33b3072024-08-21 23:14:49 -07001/*****************************************************************************
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 * ltm.h
40 *
41 * Project:
42 * --------
43 * MOLY
44 *
45 * Description:
46 * ------------
47 *
48 *
49 * Author:
50 * -------
51 * -------
52 *
53 *
54 * ==========================================================================
55 * $Log$
56 *
57 * 12 17 2012 moja.hsu
58 * [MOLY00007625] Maintain code
59 * adjust interface usage.
60 ****************************************************************************/
61/*
62 * =====================================================================================
63 *
64 * Filename: ltm.h
65 *
66 * Description: LTM (LTE traffic manager exported header file)
67 *
68 * Created: 2011/10/28 ¤U¤È 07:03:55
69 * Author: mtk01641 (moja)
70 * =====================================================================================
71 */
72#ifndef LTM_INC
73#define LTM_INC
74
75#include "kal_public_api.h"
76#include "ratcommon.h"
77
78/*
79 * lte tick source notify callback prototype.
80 * is_lte_tick: KAL_TRUE - has LTE tick.
81 * KAL_FLAE - may no LTE tick.
82 */
83typedef void (*ltm_multi_notify_lte_tick_f)(kal_bool is_lte_tick);
84
85/**
86 * @brief ltm_multiinit
87 * Init LTM module.
88 *
89 * @return TRUE
90 */
91kal_bool ltm_multi_init(void);
92
93/**
94 * @brief ltm_multiinit
95 * Reset LTM module.
96 *
97 * @return TRUE
98 */
99kal_bool ltm_multi_reset(void);
100
101/**
102 * @brief ltm_multion_ilm
103 * Receive ILM message
104 *
105 * @param ilm
106 */
107void ltm_multi_on_ilm(ilm_struct *p_ilm);
108
109/**
110 * @brief ltm_multircv_ul_sdu
111 * Receive UL SDUs. UL SDU are GPD list.
112 *
113 * @param ebi EPSB ID
114 * @param p_head SDU list head. (GPD based)
115 * @param p_tail SDU list tail. (GPD based)
116 */
117void ltm_multi_rcv_ul_sdu(kal_uint32 ebi, ratcmn_ul_sdu_t *p_sdus);
118
119/**
120 * @brief ltm_multireg_cbk_notify_lte_tick
121 * Register callback function.
122 * For get if there is a LTE tick source.
123 *
124 * @param pf_notify callback function.
125 */
126void ltm_multi_reg_cbk_notify_lte_tick(ltm_multi_notify_lte_tick_f pf_notify);
127
128/**
129 * @brief ltm_multireg_cbk_dlvr_dl_sdu
130 * Register callback for deliver DL SDUs.
131 *
132 * @param pf_dlvr_sdu
133 */
134void ltm_multi_reg_cbk_dlvr_dl_sdu(ratcmn_dlvr_dl_sdu_f pf_dlvr_sdu);
135
136/**
137 * @brief ltm_multi_reg_cbk_hook_ul
138 * Register callback for LTE UL traffic.
139 *
140 * @param pf_hook
141 */
142void ltm_multi_reg_cbk_hook_ul(ratcmn_hook_ul_f pf_hook);
143
144/**
145 * @brief ltm_multi_reg_cbk_rollback_ul_sdu
146 * Register callback for LTE UL traffic rollback.
147 *
148 * @param pf_hook
149 */
150void ltm_multi_reg_cbk_rollback_ul_sdu(ratcmn_rollback_sdu_f pf_rollback);
151#endif /* ----- #ifndef LTM_INC ----- */
152