blob: aaeb4b74fd0f5cf6f74be5a795eff1d2e8ffb10d [file] [log] [blame]
/*****************************************************************************
* 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) 2012
*
* 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:
* ---------
* errc_erlcdl_msg.h
*
* Project:
* --------
* MOLY
*
* Description:
* ------------
* ERRC-ERLCDL SAP header file.
* This file defines the structures and enumerations for the SAP between ERRC and ERLCDL
*
* Author:
* -------
* -------
*
* ==========================================================================
* $Log$
*
* 02 06 2017 peter.yu
* [MOLY00207733] [MT6293][EL2] ERLCDL development
* [M-SIM] Sync R-SIM related interfaces, remove redundant message IDs related to ERLC.
*
* 10 07 2016 chih-cheng.yang
* [MOLY00206307] [MT6293][NWSIM][Regression][FDD][TC_17_4_1] error in CONN_CHM_LPBK_CNF
* fix loop mode C
*
* 10 06 2016 chih-cheng.yang
* [MOLY00206307] [MT6293][NWSIM][Regression][FDD][TC_17_4_1] error in CONN_CHM_LPBK_CNF
* changes for loop mode C
*
* 09 26 2016 slifer.hsueh
* [MOLY00205085] [MT6293][EL2] ERLC source codes integration from DEV to TRUNK
* ERLC source codes integration from DEV to TRUNK
*
* 01 04 2016 tero.miettinen
* [MOLY00155820] ERRC UMOLY updates
* NVRAM IF, ERRC - EL2 IF and ERRC update for 15 bit RLC LI field length.
*
* 07 03 2015 chi-chung.lin
* [MOLY00123918] [MT6291] Modify CHM code to provide eps_br_id in errc_erlcdl_rb_cfg_struct/errc_erlcul_rb_cfg_struct and fix compile warning
* [CHM] Code sync. from TK6291_DEV
*
* 02 02 2015 chi-chung.lin
* [MOLY00068710] [MT6291_DEV] Sync MOLY to MT6291_DEV
* MOLY->UMOLY code sync.
*
* 11 11 2014 yiting.cheng
* [MOLY00084042] [UMOLY] merge UMOLY_DEV to UMOLY trunk
* .
*
* 09 19 2014 chi-chung.lin
* [MOLY00073836] [MT6291][ERRC][CHM] LTE-A CHM development code check-in
* [CHM] MBMS interface check in
****************************************************************************/
/// @author mtk01733
/// @date 08/10/11
#ifndef _MTK_LTE_ERRC_ERLCDL_SAP_H_
#define _MTK_LTE_ERRC_ERLCDL_SAP_H_
#include "el2_sap_common.h"
#include "common_def.h"
/*--------------------------------------------------------------------------
* MSG_ID_ERLCDL_ERRC_CCCH_DATA_IND
*--------------------------------------------------------------------------*/
// no local parameters
/*--------------------------------------------------------------------------
* MSG_ID_ERRC_ERLCDL_CONFIG_REQ (enum)
*--------------------------------------------------------------------------*/
// t-Reordering
typedef enum
{
T_REORDER_MS0 = 0x00,
T_REORDER_MS5 = 0x01,
T_REORDER_MS10 = 0x02,
T_REORDER_MS15 = 0x03,
T_REORDER_MS20 = 0x04,
T_REORDER_MS25 = 0x05,
T_REORDER_MS30 = 0x06,
T_REORDER_MS35 = 0x07,
T_REORDER_MS40 = 0x08,
T_REORDER_MS45 = 0x09,
T_REORDER_MS50 = 0x0A,
T_REORDER_MS55 = 0x0B,
T_REORDER_MS60 = 0x0C,
T_REORDER_MS65 = 0x0D,
T_REORDER_MS70 = 0x0E,
T_REORDER_MS75 = 0x0F,
T_REORDER_MS80 = 0x10,
T_REORDER_MS85 = 0x11,
T_REORDER_MS90 = 0x12,
T_REORDER_MS95 = 0x13,
T_REORDER_MS100 = 0x14,
T_REORDER_MS110 = 0x15,
T_REORDER_MS120 = 0x16,
T_REORDER_MS130 = 0x17,
T_REORDER_MS140 = 0x18,
T_REORDER_MS150 = 0x19,
T_REORDER_MS160 = 0x1A,
T_REORDER_MS170 = 0x1B,
T_REORDER_MS180 = 0x1C,
T_REORDER_MS190 = 0x1D,
T_REORDER_MS200 = 0x1E,
T_REORDER_MS1600 = 0x1F
} errc_erlcdl_t_reorder_enum;
// t-StatusProhibit
typedef enum
{
T_STUS_PROH_MS0 = 0x00,
T_STUS_PROH_MS5 = 0x01,
T_STUS_PROH_MS10 = 0x02,
T_STUS_PROH_MS15 = 0x03,
T_STUS_PROH_MS20 = 0x04,
T_STUS_PROH_MS25 = 0x05,
T_STUS_PROH_MS30 = 0x06,
T_STUS_PROH_MS35 = 0x07,
T_STUS_PROH_MS40 = 0x08,
T_STUS_PROH_MS45 = 0x09,
T_STUS_PROH_MS50 = 0x0A,
T_STUS_PROH_MS55 = 0x0B,
T_STUS_PROH_MS60 = 0x0C,
T_STUS_PROH_MS65 = 0x0D,
T_STUS_PROH_MS70 = 0x0E,
T_STUS_PROH_MS75 = 0x0F,
T_STUS_PROH_MS80 = 0x10,
T_STUS_PROH_MS85 = 0x11,
T_STUS_PROH_MS90 = 0x12,
T_STUS_PROH_MS95 = 0x13,
T_STUS_PROH_MS100 = 0x14,
T_STUS_PROH_MS105 = 0x15,
T_STUS_PROH_MS110 = 0x16,
T_STUS_PROH_MS115 = 0x17,
T_STUS_PROH_MS120 = 0x18,
T_STUS_PROH_MS125 = 0x19,
T_STUS_PROH_MS130 = 0x1A,
T_STUS_PROH_MS135 = 0x1B,
T_STUS_PROH_MS140 = 0x1C,
T_STUS_PROH_MS145 = 0x1D,
T_STUS_PROH_MS150 = 0x1E,
T_STUS_PROH_MS155 = 0x1F,
T_STUS_PROH_MS160 = 0x20,
T_STUS_PROH_MS165 = 0x21,
T_STUS_PROH_MS170 = 0x22,
T_STUS_PROH_MS175 = 0x23,
T_STUS_PROH_MS180 = 0x24,
T_STUS_PROH_MS185 = 0x25,
T_STUS_PROH_MS190 = 0x26,
T_STUS_PROH_MS195 = 0x27,
T_STUS_PROH_MS200 = 0x28,
T_STUS_PROH_MS205 = 0x29,
T_STUS_PROH_MS210 = 0x2A,
T_STUS_PROH_MS215 = 0x2B,
T_STUS_PROH_MS220 = 0x2C,
T_STUS_PROH_MS225 = 0x2D,
T_STUS_PROH_MS230 = 0x2E,
T_STUS_PROH_MS235 = 0x2F,
T_STUS_PROH_MS240 = 0x30,
T_STUS_PROH_MS245 = 0x31,
T_STUS_PROH_MS250 = 0x32,
T_STUS_PROH_MS300 = 0x33,
T_STUS_PROH_MS350 = 0x34,
T_STUS_PROH_MS400 = 0x35,
T_STUS_PROH_MS450 = 0x36,
T_STUS_PROH_MS500 = 0x37,
T_STUS_PROH_MS800 = 0x38,
T_STUS_PROH_MS1000 = 0x39,
T_STUS_PROH_MS1200 = 0x3A,
T_STUS_PROH_MS1600 = 0x3B,
T_STUS_PROH_MS2000 = 0x3C,
T_STUS_PROH_MS2400 = 0x3D,
} errc_erlcdl_t_stus_proh_enum;
/*--------------------------------------------------------------------------
* MSG_ID_ERRC_ERLCDL_CONFIG_REQ (struct)
*--------------------------------------------------------------------------*/
/// structure for AM entity (receiving side)
typedef struct
{
errc_erlcdl_t_reorder_enum t_reorder;
errc_erlcdl_t_stus_proh_enum t_stus_proh;
kal_bool li_field_len_15_bit;
} errc_erlcdl_am_struct;
/// configuration for DL UM entity
typedef struct
{
errc_erlc_sn_field_len_enum snf_len;
errc_erlcdl_t_reorder_enum t_reorder;
kal_uint8 flag_pdcp_long_sn;
kal_uint8 rsvd[3];
} errc_erlcdl_um_struct;
/// DL RB configuration (for RB establish/re-establish/re-configure)
typedef struct
{
errc_el2_rbid_enum rbid;
kal_uint8 lcid;
kal_uint8 rb_idx;
kal_uint8 rsvd;
errc_erlc_rb_mode_enum mode;
errc_erlc_rb_type_enum type;
/// RLC configuration
union {
errc_erlcdl_am_struct am_cfg;
errc_erlcdl_um_struct um_cfg;
} am_um_cfg;
/// eps bearer id, valid only when DRB and ERLC_MODE_EST/REEST/RECFG
kal_uint8 eps_br_id;
} errc_erlcdl_rb_cfg_struct;
/// DL RB configuration (for RB release)
typedef struct
{
kal_uint8 rb_idx; ///< RB index
errc_el2_rbid_enum rbid;
kal_bool ho_failure; ///< if HO failure, remove the new RB.
kal_uint8 rsvd;
} errc_erlcdl_rb_rel_struct;
/* CHM MBMS support start */
typedef struct
{
kal_uint8 mcch_idx;
} errc_erlcdl_mcch_cfg_struct;
typedef struct
{
kal_uint8 mcch_idx;
} errc_erlcdl_mcch_rel_struct;
typedef struct
{
// numbered by eRRC and not from NW,
// If one carrier is supported, range 0~7
// If two carriers are supported, range 0~15
kal_uint8 mrb_idx;
kal_uint8 loop_mode_c;
} errc_erlcdl_mrb_cfg_struct;
typedef struct
{
kal_uint8 mrb_idx;
} errc_erlcdl_mrb_rel_struct;
/* CHM MBMS support end */
/// MSG_ID_ERRC_ERLCDL_CONFIG_REQ structure
typedef struct
{
LOCAL_PARA_HDR
kal_uint8 n_est_rb; // the number of RBs to be established
kal_uint8 n_mod_rb; // the number of RBs to be modified
kal_uint8 n_rel_rb; // the number of RBs to be released
kal_uint8 rsvd;
/** RB configurations for the RB to be established */
errc_erlcdl_rb_cfg_struct est_rb[MAX_NUM_RLC_CONFIG_RB];
/** RB configurations for the RB to be modified */
errc_erlcdl_rb_cfg_struct mod_rb[MAX_NUM_RLC_CONFIG_RB];
/** RB configurations for the RB to be released */
errc_erlcdl_rb_rel_struct rel_rb[MAX_NUM_RLC_CONFIG_RB];
/* CHM MBMS support start */
kal_uint8 n_est_mcch[MAX_EMBMS_FREQ_SUPPORT];
kal_uint8 n_rel_mcch[MAX_EMBMS_FREQ_SUPPORT];
errc_erlcdl_mcch_cfg_struct est_mcch[MAX_EMBMS_FREQ_SUPPORT][MAX_EMBMS_MCCH_SUPPORT];
errc_erlcdl_mcch_rel_struct rel_mcch[MAX_EMBMS_FREQ_SUPPORT][MAX_EMBMS_MCCH_SUPPORT];
kal_uint8 n_est_mrb[MAX_EMBMS_FREQ_SUPPORT];
kal_uint8 n_rel_mrb[MAX_EMBMS_FREQ_SUPPORT];
errc_erlcdl_mrb_cfg_struct est_mrb[MAX_EMBMS_FREQ_SUPPORT][MAX_EMBMS_MRB_SUPPORT];
errc_erlcdl_mrb_rel_struct rel_mrb[MAX_EMBMS_FREQ_SUPPORT][MAX_EMBMS_MRB_SUPPORT];
/* CHM MBMS support end */
} errc_erlcdl_config_req_struct;
/*--------------------------------------------------------------------------
* MSG_ID_ERRC_ERLCDL_CONFIG_CNF
* MSG_ID_ERRC_ERLCDL_TEST_CNF
*--------------------------------------------------------------------------*/
/// MSG_ID_ERRC_ERLCDL_CONFIG_CNF structure
/// MSG_ID_ERRC_ERLCDL_TEST_CNF structure
typedef struct
{
LOCAL_PARA_HDR
errc_el2_cfg_result_enum result;
} errc_erlcdl_config_cnf_struct;
/*--------------------------------------------------------------------------
* MSG_ID_ERRC_ERLCDL_SWITCH_VIRTUAL_CONNECTED_REQ
*--------------------------------------------------------------------------*/
typedef struct
{
LOCAL_PARA_HDR
errc_el2_switch_virtual_connected_enum status;
} errc_erlcdl_switch_virtual_connected_req_struct;
/*--------------------------------------------------------------------------
* MSG_ID_ERRC_ERLCDL_SWITCH_VIRTUAL_CONNECTED_CNF
*--------------------------------------------------------------------------*/
//no contents in this CNF, success only
/*--------------------------------------------------------------------------
* MSG_ID_ERRC_ERLCDL_TESTG_REQ (enum)
*--------------------------------------------------------------------------*/
typedef enum
{
ERLCDL_SAP_LB_CMD_MODE_C_DEACTIVATE = 0,
ERLCDL_SAP_LB_CMD_MODE_C_ACTIVATE,
ERLCDL_SAP_LB_CMD_MODE_NUM,
ERLCDL_SAP_LB_CMD_PAD = 0X7FFFFFFF
}erlcdl_lb_cmd_enum;
/*--------------------------------------------------------------------------
* MSG_ID_ERRC_ERLCDL_TEST_REQ (struct)
*--------------------------------------------------------------------------*/
typedef struct
{
LOCAL_PARA_HDR
kal_uint8 ci;
kal_uint8 mrb_idx;
erlcdl_lb_cmd_enum cmd;
}errc_erlcdl_test_req_struct;
/*--------------------------------------------------------------------------
* MSG_ID_ERRC_ERLCDL_TEST_CNF
*--------------------------------------------------------------------------*/
/// MSG_ID_ERRC_ERLCDL_CONFIG_CNF structure
/// MSG_ID_ERRC_ERLCDL_TEST_CNF structure
typedef struct
{
LOCAL_PARA_HDR
errc_el2_cfg_result_enum result;
} errc_erlcdl_test_cnf_struct;
/*--------------------------------------------------------------------------
* MSG_ID_ERRC_ERLCDL_MTCH_PC_CNF (struct)
*--------------------------------------------------------------------------*/
typedef struct
{
LOCAL_PARA_HDR
kal_uint32 packet_count;
} errc_erlcdl_mtch_pc_cnf_struct;
#endif