mcu/interface/protocol/dispatcher/dispatcher_if.h

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*******************************************************************************
 * Filename:
 * ---------
 *   dispatcher_if.h
 *
 * Project:
 * --------
 *   VMOLY
 *
 * Description:
 * ------------
 *   Dispatcher interface.
 *
 * Author:
 * -------
 * -------
 *
 *******************************************************************************/

#ifndef __DISPATCHER_IF_H
#define __DISPATCHER_IF_H

#include "kal_public_api.h"
#include "qmu_bm.h"
#include "lhif_if.h"
#include "upcm.h"

typedef void (*dispatcher_dlvr_dl_did_f)(kal_uint32 pdn_id, upcm_did* p_head, upcm_did* p_tail, kal_uint8 protocol_idx);

/**
 * @brief dispatcher_init Dispatcher module.
 *
 * @return TRUE  
 */

kal_bool dispatcher_init(void);

/**
 * @brief dispatcher_on_ilm 
 * Receive ILM message
 *
 * @param ilm
 */
void dispatcher_on_ilm(ilm_struct *ilm);

/**
 * @brief dispatcher_reset 
 * Reset Dispatcher module.
 *
 * @return TRUE  
 */
kal_bool dispatcher_reset(void);

/**
 * @brief dispatcher_rcv_ul_gpd_by_pdn 
 * Receive UL data, data are in GPD list.
 *
 * @param ip_type ip type.
 * @param pdn_id PDN Connection ID
 * @param p_head list head. (GPD based)
 * @param p_tail list tail. (GPD based)
 * @param protocol_idx SIMID identifier
 */
void dispatcher_rcv_ul_gpd_by_pdn(ip_type_e ip_type, kal_uint32 pdn_id, qbm_gpd* p_head, qbm_gpd* p_tail, kal_uint8 protocol_idx);

/**
 * @brief dispatcher_rcv_ul_meta_queue 
 * Receive UL data, LHIF Q index based.
 *
 * @param start_idx startidx for Q for updated data
 * @param end_idx endidx of Q for updated data
 * @param queue_type LHIF Q type
 */
void dispatcher_rcv_ul_meta_queue(kal_uint16 start_idx, kal_uint16 end_idx, LHIF_QUEUE_TYPE queue_type);


//API to register IPCORE DL callback function
void dispatcher_reg_cbk_dlvr_dl_did(dispatcher_dlvr_dl_did_f pf_dlvr_did);

/**
 * @brief dispatcher_on_dl_did_cbk from wtunnel 
 * Receive DL data, DID format.
 *
 * @param bearer_id bearer for the data
 * @param p_head list head.  (DID based)
 * @param p_tail list tail.  (DID based)
 * @param protocol_idx simid identifier
 */
void dispatcher_on_dl_did_cbk(kal_uint8 bearer_id, upcm_did* p_head, upcm_did* p_tail, kal_uint8 protocol_idx);


/**
 * @brief dispatcher_rcv_ul_gpd_by_ebi 
 * Receive UL data, data are in GPD list.
 *
 * @param ebi bearer id
 * @param p_head list head. (GPD based)
 * @param p_tail list tail. (GPD based)
 * @param protocol_idx SIMID identifier
 */
void dispatcher_rcv_ul_gpd_by_ebi(kal_uint32 ebi, qbm_gpd* p_head, qbm_gpd* p_tail, kal_uint8 protocol_idx);

#if defined(__SENSITIVE_DATA_MOSAIC__)
/**
 * @brief dispatcher_module_clean
 * clean sensitive context 
 *
 * @param 
 */
void dispatcher_module_clean();
#endif

#endif /* __DISPATCHER_IF_H */