gprs_flc_kal.h

最新MTK手机软件源码

/*****************************************************************************
*  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:
 * ---------
 *   gprs_flc_kal.h
 *
 * Project:
 * --------
 *   Maui_Software
 *
 * Description:
 * ------------
 *   This file provides the function declarations used for gprs flow
 *   control implementation.
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/

/********************************************************************************
*  Copyright Statement:
*  --------------------
*
*  This product has been developed using a protocol stack
*  developed by Sasken Communication Technologies Limited.
*
********************************************************************************/



#ifndef _GPRS_FLC_KAL_H
#define _GPRS_FLC_KAL_H

/*************************************************************************
 * Include header files
 *************************************************************************/
#include "kal_release.h"
#include "app_ltlcom.h"
#include "app_buff_alloc.h"
#include "stack_utils.h"
#include "gprs_flc_kal_data_types.h"
#include "init_time_cfg.h"
#include "flc_perf_tunable_struct.h"
#include "stack_config.h"
#include "ps_config.h"

/*************************************************************************
 * Exported Data Declaration
 *************************************************************************/
extern perf_tunable_struct flc_perf_params;


/*************************************************************************
 * Exported Function Prototypes
 *************************************************************************/
/* Interface between Flow control and Stack */
kal_bool gprs_ps_mem_initialize(void);

kal_bool gprs_flc_activate_context(gprs_flc_data_type_enum data_type,
                                   gprs_flc_sapi_type_enum sapi_type,
                                   gprs_flc_dir_enum dir,
                                   kal_uint8 context_id);

void gprs_flc_deactivate_context(gprs_flc_data_type_enum data_type,
                                 gprs_flc_sapi_type_enum sapi_type,
                                 gprs_flc_dir_enum dir,
                                 kal_uint8 context_id);

kal_uint32
gprs_flc_shrink_context_memory (gprs_flc_data_type_enum data_type,
                              gprs_flc_sapi_type_enum sapi_type,
                              gprs_flc_dir_enum dir,
							  kal_uint8 context_id);

kal_bool gprs_flc_grow_context_memory(gprs_flc_data_type_enum data_type,
                                      gprs_flc_sapi_type_enum sapi_type,
                                      gprs_flc_dir_enum dir,
									  kal_uint8 context_id,
                                      kal_uint32 requested_size_for_ul,
                                      kal_uint32 requested_size_for_dl,
                                      kal_uint32 *blocked_size_for_ul,
                                      kal_uint32 *blocked_size_for_dl);

void gprs_flc_xid_ind(gprs_flc_data_type_enum data_type,
                      gprs_flc_sapi_type_enum sapi_type,
                      gprs_flc_dir_enum dir,
                      kal_uint32 accepted_size,
                      kal_bool success_failure);

void gprs_flc_rnr_rr_ind(gprs_flc_data_type_enum data_type,
                         gprs_flc_sapi_type_enum sapi_type,
                         gprs_flc_dir_enum dir,
                         gprs_flc_stack_trigger_enum rnr_rr);

kal_bool gprs_flc_reset(void);

void gprs_flc_deinit(void);

/* Interface between Memory Manager and Stack  */
#if 0
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
#endif

void* gprs_flc_int_get_peer_buff(gprs_flc_data_type_enum data_type,
                             gprs_flc_sapi_type_enum sapi_type,
                             gprs_flc_dir_enum dir,
                             kal_uint8 context_id,
                             kal_uint16 pdu_len,
                             kal_uint16 header_size,
                             kal_uint16 tail_size,
                             gprs_flc_pool_presence_enum *is_pool_created,
                             kal_uint32 line);

void gprs_flc_int_free_peer_buff(gprs_flc_data_type_enum data_type,
                             gprs_flc_sapi_type_enum sapi_type,
                             gprs_flc_dir_enum dir,
                             kal_uint8 context_id,
                             peer_buff_struct *buff_ptr,
                             kal_uint32 line);

#if 0
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
#endif

kal_bool gprs_flc_is_peer_buff_from_flc (   peer_buff_struct *buff_ptr);


void* gprs_flc_get_buffer(gprs_flc_pool_id_enum apppdu_buff_type,
                          kal_uint16 size);

void gprs_flc_free_buffer(gprs_flc_pool_id_enum apppdu_buff_type,
                          void *buff_ptr);

void gprs_flc_flush_mem_queue(gprs_flc_data_type_enum data_type,
                             gprs_flc_sapi_type_enum sapi_type,
                             gprs_flc_dir_enum dir,
							 kal_uint8 context_id);

void gprs_flc_dl_ack_packet_size_modify(gprs_flc_sapi_type_enum sapi_type,
                                       kal_uint16 packet_size);

void* gprs_stack_app_get_buff(kal_uint16 size);

void  gprs_stack_app_free_buff(void * buff_ptr);

/* John Tang 2003/02/24. */
kal_bool gprs_flc_is_flc_context_activated(gprs_flc_data_type_enum data_type,
                              gprs_flc_sapi_type_enum sapi_type,
                              gprs_flc_dir_enum temp_dir,
                              kal_uint8 context_id );

kal_uint32 gprs_flc_query_pool_occupy(gprs_flc_data_type_enum data_type,
								gprs_flc_sapi_type_enum sapi_type,
								gprs_flc_dir_enum dir,
								kal_uint8 context_id,
								gprs_flc_pool_presence_enum *is_pool_created,
								kal_uint32 *total_pool_size);

kal_uint32
gprs_flc_query_fix_size_pool_occupy(gprs_flc_data_type_enum data_type,
                           gprs_flc_sapi_type_enum sapi_type,
                           gprs_flc_dir_enum dir,
                           kal_uint8 context_id,
                           gprs_flc_pool_presence_enum *is_pool_created,
                           kal_uint16	*available_half_blocks,
                           kal_uint16	*available_full_blocks);

kal_bool gprs_flc_pool_status_report(kal_uint8 mem_id,
									kal_uint8 req_mod);

kal_bool flc_em_get_pool_status(kal_uint8 pool_id,
		  						   void *status);
#if 0
/* under construction !*/
#endif

#ifdef DEBUG_FLC
void gprs_flc_print_stats(gprs_flc_data_type_enum data_type);
#endif /* DEBUG_FLC */

#define gprs_flc_get_peer_buff_debug gprs_flc_int_get_peer_buff 
#define gprs_flc_free_peer_buff_debug gprs_flc_int_free_peer_buff 

#define gprs_flc_get_peer_buff(_data_type_, _sapi_type_, _dir_, _context_id_,\
                               _pdu_len, _header_size_, _tail_size_, is_pool_created)\
        gprs_flc_int_get_peer_buff(_data_type_, _sapi_type_, _dir_, _context_id_,\
                               _pdu_len, _header_size_, _tail_size_, is_pool_created, __LINE__)

#define gprs_flc_free_peer_buff(_data_type_, _sapi_type_, _dir_, _context_id_, _buff_ptr_)\
        gprs_flc_int_free_peer_buff(_data_type_, _sapi_type_, _dir_, _context_id_, _buff_ptr_, __LINE__) 

#endif /* _GPRS_FLC_KAL_H */