mcu/protocol/interface/general/sm_ratdm_struct.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:
 * ---------
 *   sm_ratdm_struct.h
 *
 * Project:
 * --------
 *   MONZA
 *
 * Description:
 * ------------
 *
 *
 * Author:
 * -------
 * -------
 *
 ******************************************************************************/

#ifndef SM_RATDM_STRUCT_H
#define SM_RATDM_STRUCT_H

#include "kal_general_types.h"
#include "mcd_l3_inc_gprs_struct.h"
#include "l3_inc_local.h"
#include "esm_ratdm_struct.h"
#include "kal_public_defs.h"


typedef struct {
    LOCAL_PARA_HDR  
    kal_uint8 no_of_nsapis;
    kal_uint8 nsapi_list[11];
    kal_bool  need_sm_modify;
} sm_ratdm_rab_activate_ind_struct;

typedef struct {
    NSAPI_STRUCT_HDR // LOCAL_PARA_HDR + kal_uint8 nsapi (SM code assume nsapi is the first parameter of some primitive)    
    kal_uint8 is_successful;
} sm_ratdm_rab_activate_rsp_struct;

typedef struct {
    NSAPI_STRUCT_HDR // LOCAL_PARA_HDR + kal_uint8 nsapi (SM code assume nsapi is the first parameter of some primitive)
    /* 23G ralated parameters */ 
    kal_uint8 llc_sapi;
    qos_struct qos_negotiated;
    kal_uint8 radio_priority;
    kal_uint8 pfi;

    /* 4G ralated parameters */
    esm_qci_enum qci;
} sm_ratdm_activate_req_struct;

typedef struct {
    NSAPI_STRUCT_HDR // LOCAL_PARA_HDR + kal_uint8 nsapi (SM code assume nsapi is the first parameter of some primitive)    
} sm_ratdm_activate_cnf_struct;

typedef struct {
    LOCAL_PARA_HDR  
    kal_uint8 no_of_nsapis;
    kal_uint8 nsapi_list[11];
    kal_uint8 cause;
    kal_bool xid_neg_indicator[11];
    kal_bool MMiRAT[11]; // This parameter is used by SM to inform RATDM the reason to establish this context: 
                         // if TRUE, means this context is transferred from 4G, 
                         // if FALSE, means this context is established by user trigger
} sm_ratdm_deactivate_req_struct;

typedef struct {
    LOCAL_PARA_HDR  
    kal_uint8 no_of_nsapis;
    kal_uint8 nsapi_list[11];
#ifdef __DIALUP_GPRS_COUNTER_SUPPORT__
    kal_uint64 tx_data_amount[11]; // new field for gprs call history
    kal_uint64 rx_data_amount[11]; // new field for gprs call history
#endif	
} sm_ratdm_deactivate_cnf_struct;

typedef struct {
    LOCAL_PARA_HDR  
    kal_uint8 no_of_nsapis;
    kal_uint8 nsapi_list[11];
} sm_ratdm_rab_deactivate_ind_struct;

typedef struct {
    NSAPI_STRUCT_HDR // LOCAL_PARA_HDR + kal_uint8 nsapi (SM code assume nsapi is the first parameter of some primitive)
    /* 23G ralated parameters */
    kal_bool is_radio_priority_present;
    kal_uint8 radio_priority;

    kal_bool is_llc_sapi_present;
    kal_uint8 llc_sapi;

    kal_bool is_qos_negotiated_present;
    qos_struct qos_negotiated;

    kal_bool is_pfi_present;
    kal_uint8 pfi;

    /* 4G ralated parameters */
    esm_qci_enum qci;
} sm_ratdm_modify_req_struct;

typedef struct {
    NSAPI_STRUCT_HDR // LOCAL_PARA_HDR + kal_uint8 nsapi (SM code assume nsapi is the first parameter of some primitive)    
} sm_ratdm_modify_cnf_struct;

typedef struct {
    NSAPI_STRUCT_HDR // LOCAL_PARA_HDR + kal_uint8 nsapi (SM code assume nsapi is the first parameter of some primitive)    
    kal_uint8 cause;
} sm_ratdm_status_ind_struct;

// The primitive is used to indicate RATDM that upper layer (UPCM, IPCore¡Ketc) configuration is done, 
// and downlink packet data can now route to upper layer if they were queued in RATDM or lower layer. 
// Although current RATDM does not queue any DL data, 
// we decide to align 4G design and still send this primitive for future possible usage
typedef struct {
    NSAPI_STRUCT_HDR // LOCAL_PARA_HDR + kal_uint8 nsapi (SM code assume nsapi is the first parameter of some primitive)    
} sm_ratdm_allow_dl_packet_ind_struct;

#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 !*/
#endif // ~ #if 0


#endif /* SM_RATDM_STRUCT_H */