| /***************************************************************************** |
| * 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_erlcul_msg.h |
| * |
| * Project: |
| * -------- |
| * MOLY |
| * |
| * Description: |
| * ------------ |
| * ERRC-ERLCUL SAP file |
| * This file defines the structures and enumerations for the SAP between ERRC and ERLCUL |
| * |
| * Author: |
| * ------- |
| * ------- |
| * |
| * ========================================================================== |
| * $Log$ |
| * |
| * 04 15 2020 lien-chih.hsu |
| * [MOLY00505240] [6297] EN-DC gaming HO enhancement |
| * |
| * [Gen97][R3MP][CHM] Gaming - Bring (earfcn,pci) in rlcul_config_req |
| * |
| * 12 04 2019 sh.pan |
| * [MOLY00462979] [Gen97]MOB/MEAS/NL1MOB 1001DEV to VMOLY patch back |
| * |
| * . |
| * |
| * 11 13 2019 tsung-ming.lee |
| * [MOLY00441387] [Gen97][ERRC][MOB] NSA& LTE Gaming cell list for mobility enhancement |
| * |
| * -new gaming proposal. |
| * |
| * 09 19 2019 tsung-ming.lee |
| * [MOLY00441387] [Gen97][ERRC][MOB] NSA& LTE Gaming cell list for mobility enhancement |
| * [NSA]Gaming cell offset. |
| * |
| * 07 24 2018 slifer.hsueh |
| * [MOLY00341790] [MT6295] UDC feature patch back |
| * Add udc_en field in errc_erlcul_rb_cfg_struct |
| * |
| * 02 06 2017 peter.yu |
| * [MOLY00207733] [MT6293][EL2] ERLCDL development |
| * [M-SIM] Sync R-SIM related interfaces, remove redundant message IDs related to ERLC. |
| * |
| * 09 26 2016 slifer.hsueh |
| * [MOLY00205085] [MT6293][EL2] ERLC source codes integration from DEV to TRUNK |
| * ERLC source codes integration from DEV to TRUNK |
| * |
| * 08 04 2016 wei.liao |
| * [MOLY00194969] [MT6293][EL2] ERLC-UL source codes integration from LTE to RD domain |
| * 1.Bug fix: Setup function ptr for retx port. |
| * 2.Bug fix: Fix lsf/rf info registeration for nack. |
| * 3.Add timer enum and config setting in ERLCUL for R13 |
| * 4.Init D_ADDR=NULL to prevent the case first desc is normal |
| * (original queue encounter CLDMBA buffer shortage and stop processing)g |
| * |
| * 07 27 2016 jeremy.chen |
| * [MOLY00190683] [UMOLYA][6293] EL2 merge back to UMOLYA TRUNK & PS DEV |
| * [EL2][RD domain] Sync latest EL2 from LTE domain |
| * |
| * 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 |
| * |
| * 04 08 2015 katie.tseng |
| * [MOLY00104186] [UMOLY] UMOLY code maintenance. |
| * 1. March 2015 MOLY CR sync on ERLC-DL: (1) VoLTE early RLF (2) log reduction |
| * 2. RLC gtest UT fix: set/reset gERLC_Trap_Msg_EN at setup() and teardown() |
| * |
| * 01 22 2014 jeremy.chen |
| * [MOLY00054589] [MT6290E2] add RLF indication from ERLC-DL |
| * rename ERRC_ERLCUL_STATUS_IND to ERRC_ERLC_RLF_IND and modify the interface for both ERLC-UL and ERLC-DL use |
| * |
| * 02 18 2013 jeremy.chen |
| * [MOLY00007127] [MT7208] EL2 enhancement in MOLY |
| * update the comments. |
| ****************************************************************************/ |
| |
| /// @author mtk01733 |
| /// @date 08/10/11 |
| |
| #ifndef _MTK_LTE_ERRC_ERLCUL_SAP_H_ |
| #define _MTK_LTE_ERRC_ERLCUL_SAP_H_ |
| |
| |
| #include "el2_sap_common.h" |
| |
| |
| /*-------------------------------------------------------------------------- |
| * MSG_ID_ERRC_ERLCUL_CONFIG_REQ (enum) |
| *--------------------------------------------------------------------------*/ |
| |
| /// t-PollRetransmit |
| typedef enum |
| { |
| T_POLL_RETX_MS5 = 0x00, |
| T_POLL_RETX_MS10 = 0x01, |
| T_POLL_RETX_MS15 = 0x02, |
| T_POLL_RETX_MS20 = 0x03, |
| T_POLL_RETX_MS25 = 0x04, |
| T_POLL_RETX_MS30 = 0x05, |
| T_POLL_RETX_MS35 = 0x06, |
| T_POLL_RETX_MS40 = 0x07, |
| T_POLL_RETX_MS45 = 0x08, |
| T_POLL_RETX_MS50 = 0x09, |
| T_POLL_RETX_MS55 = 0x0A, |
| T_POLL_RETX_MS60 = 0x0B, |
| T_POLL_RETX_MS65 = 0x0C, |
| T_POLL_RETX_MS70 = 0x0D, |
| T_POLL_RETX_MS75 = 0x0E, |
| T_POLL_RETX_MS80 = 0x0F, |
| T_POLL_RETX_MS85 = 0x10, |
| T_POLL_RETX_MS90 = 0x11, |
| T_POLL_RETX_MS95 = 0x12, |
| T_POLL_RETX_MS100 = 0x13, |
| T_POLL_RETX_MS105 = 0x14, |
| T_POLL_RETX_MS110 = 0x15, |
| T_POLL_RETX_MS115 = 0x16, |
| T_POLL_RETX_MS120 = 0x17, |
| T_POLL_RETX_MS125 = 0x18, |
| T_POLL_RETX_MS130 = 0x19, |
| T_POLL_RETX_MS135 = 0x1A, |
| T_POLL_RETX_MS140 = 0x1B, |
| T_POLL_RETX_MS145 = 0x1C, |
| T_POLL_RETX_MS150 = 0x1D, |
| T_POLL_RETX_MS155 = 0x1E, |
| T_POLL_RETX_MS160 = 0x1F, |
| T_POLL_RETX_MS165 = 0x20, |
| T_POLL_RETX_MS170 = 0x21, |
| T_POLL_RETX_MS175 = 0x22, |
| T_POLL_RETX_MS180 = 0x23, |
| T_POLL_RETX_MS185 = 0x24, |
| T_POLL_RETX_MS190 = 0x25, |
| T_POLL_RETX_MS195 = 0x26, |
| T_POLL_RETX_MS200 = 0x27, |
| T_POLL_RETX_MS205 = 0x28, |
| T_POLL_RETX_MS210 = 0x29, |
| T_POLL_RETX_MS215 = 0x2A, |
| T_POLL_RETX_MS220 = 0x2B, |
| T_POLL_RETX_MS225 = 0x2C, |
| T_POLL_RETX_MS230 = 0x2D, |
| T_POLL_RETX_MS235 = 0x2E, |
| T_POLL_RETX_MS240 = 0x2F, |
| T_POLL_RETX_MS245 = 0x30, |
| T_POLL_RETX_MS250 = 0x31, |
| T_POLL_RETX_MS300 = 0x32, |
| T_POLL_RETX_MS350 = 0x33, |
| T_POLL_RETX_MS400 = 0x34, |
| T_POLL_RETX_MS450 = 0x35, |
| T_POLL_RETX_MS500 = 0x36, |
| T_POLL_RETX_MS800 = 0x37, |
| T_POLL_RETX_MS1000 = 0x38, |
| T_POLL_RETX_MS2000 = 0x39, |
| T_POLL_RETX_MS4000 = 0x3A |
| |
| } errc_erlcul_t_pollretx_enum; |
| |
| /// Poll PDU counter |
| typedef enum |
| { |
| POLL_PDU_P4 = 0x00, |
| POLL_PDU_P8 = 0x01, |
| POLL_PDU_P16 = 0x02, |
| POLL_PDU_P32 = 0x03, |
| POLL_PDU_P64 = 0x04, |
| POLL_PDU_P128 = 0x05, |
| POLL_PDU_P256 = 0x06, |
| POLL_PDU_PINF = 0x07 |
| } errc_erlcul_poll_pdu_enum; |
| |
| |
| /// Poll byte counter |
| typedef enum |
| { |
| POLL_BYTE_KB25 = 0x00, |
| POLL_BYTE_KB50 = 0x01, |
| POLL_BYTE_KB75 = 0x02, |
| POLL_BYTE_KB100 = 0x03, |
| POLL_BYTE_KB125 = 0x04, |
| POLL_BYTE_KB250 = 0x05, |
| POLL_BYTE_KB375 = 0x06, |
| POLL_BYTE_KB500 = 0x07, |
| POLL_BYTE_KB750 = 0x08, |
| POLL_BYTE_KB1000 = 0x09, |
| POLL_BYTE_KB1250 = 0x0A, |
| POLL_BYTE_KB1500 = 0x0B, |
| POLL_BYTE_KB2000 = 0x0C, |
| POLL_BYTE_KB3000 = 0x0D, |
| POLL_BYTE_KBINF = 0x0E |
| |
| } errc_erlcul_poll_byte_enum; |
| |
| |
| /// maximum retranmsission threshold |
| typedef enum |
| { |
| MAX_RETX_T1 = 0x00, |
| MAX_RETX_T2 = 0x01, |
| MAX_RETX_T3 = 0x02, |
| MAX_RETX_T4 = 0x03, |
| MAX_RETX_T6 = 0x04, |
| MAX_RETX_T8 = 0x05, |
| MAX_RETX_T16 = 0x06, |
| MAX_RETX_T32 = 0x07 |
| |
| } errc_erlcul_max_retx_enum; |
| |
| |
| |
| /// PDCP SN length |
| typedef enum |
| { |
| PDCP_SN_LEN_05 = 05, // PDCP SN length = 05 bits (SRB) |
| PDCP_SN_LEN_07 = 07, // PDCP SN length = 07 bits (DRB UM) |
| PDCP_SN_LEN_12 = 12, // PDCP SN length = 12 bits (DRB AM or UM) |
| PDCP_SN_LEN_15 = 15, // PDCP SN length = 15 bits (DRB AM) |
| // PDCP_SN_LEN_18 = 18, // PDCP SN length = 18 bits (DRB AM) |
| |
| } errc_erlcul_pdcp_sn_len_enum; |
| |
| typedef enum |
| { |
| CELL_STATUS_INVALID = 0, |
| CELL_STATUS_NEW = 1, |
| CELL_STATUS_LONG_GOOD = 2, |
| CELL_STATUS_GOOD = 3, |
| CELL_STATUS_BAD = 4, |
| CELL_STATUS_VERY_BAD = 5, |
| CELL_STATUS_LONG_VERY_BAD = 6 |
| } errc_erlcul_gaming_status_enum; |
| |
| /*-------------------------------------------------------------------------- |
| * MSG_ID_ERRC_ERLCUL_CONFIG_REQ (struct) |
| *--------------------------------------------------------------------------*/ |
| |
| /// configuration AM entity (transmitting side) |
| typedef struct |
| { |
| errc_erlcul_t_pollretx_enum t_pollretx; |
| errc_erlcul_poll_pdu_enum poll_pdu; |
| errc_erlcul_poll_byte_enum poll_byte; |
| errc_erlcul_max_retx_enum max_retx; |
| kal_bool li_field_len_15_bit; |
| } errc_erlcul_am_struct; |
| |
| |
| /// configuration for UL UM entity |
| typedef struct |
| { |
| errc_erlc_sn_field_len_enum snf_len; |
| |
| } errc_erlcul_um_struct; |
| |
| |
| /// UL RB configuration (for RB establish/re-establish/re-configure) |
| typedef struct |
| { |
| errc_el2_rbid_enum rbid; |
| kal_uint8 lcid; |
| kal_uint8 rb_idx; |
| |
| // implementation note |
| // -------------------------------------------------------- |
| // In MT6293, ERLCUL will assign PDCP SN for PDCP data PDU. |
| // Therefore, ERLCUL must obtain PDCP SN length from configuration. |
| // ---------------------------------------------------------------- |
| // pdcp_sn_len = PDCP_SN_LEN_05/07/12/15 |
| |
| errc_erlcul_pdcp_sn_len_enum pdcp_sn_len; |
| |
| // implementation note |
| // ---------------------------------------------------------------- |
| // In MT6293, ERLCUL will describe PDCP data PDU depending on ROHC. |
| // Therefore, ERLCUL must identify ROHC enable status from configuration. |
| // ---------------------------------------------------------------------- |
| // rohc_en = ROHC enable? KAL_TRUE: KAL_FALSE |
| |
| kal_bool rohc_en; |
| |
| errc_erlc_rb_mode_enum mode; |
| errc_erlc_rb_type_enum type; |
| |
| /// RLC configuration |
| union { |
| errc_erlcul_am_struct am_cfg; |
| errc_erlcul_um_struct um_cfg; |
| } am_um_cfg; |
| |
| /// logical channel configuration |
| errc_el2_lch_cfg lch_cfg; |
| |
| /// eps bearer id, valid only when DRB and ERLC_MODE_EST/REEST/RECFG |
| kal_uint8 eps_br_id; |
| |
| // implementation note |
| // ---------------------------------------------------------------- |
| // In MT6293, ERLCUL will describe PDCP data PDU depending on UDC. |
| // Therefore, ERLCUL must identify such enable status from configuration. |
| // ---------------------------------------------------------------------- |
| // udc_en = UDC enable? KAL_TRUE: KAL_FALSE |
| |
| kal_bool udc_en; |
| |
| kal_uint16 rsvd_2; |
| |
| } errc_erlcul_rb_cfg_struct; |
| |
| |
| /// UL RB configuration (for RB release) |
| typedef struct |
| { |
| kal_uint8 rb_idx; ///< RB index |
| errc_el2_rbid_enum rbid; ///< RBID |
| kal_bool ho_failure; ///< if HO failure, remove the new RB. |
| kal_uint8 rsvd; |
| |
| } errc_erlcul_rb_rel_struct; |
| |
| |
| /// 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_erlcul_rb_cfg_struct est_rb[MAX_NUM_RLC_CONFIG_RB]; |
| |
| /** RB configurations for the RB to be modified */ |
| errc_erlcul_rb_cfg_struct mod_rb[MAX_NUM_RLC_CONFIG_RB]; |
| |
| /** RB configurations for the RB to be released */ |
| errc_erlcul_rb_rel_struct rel_rb[MAX_NUM_RLC_CONFIG_RB]; |
| |
| kal_uint16 pci; |
| kal_uint32 earfcn; |
| |
| } errc_erlcul_config_req_struct; |
| |
| |
| |
| /*-------------------------------------------------------------------------- |
| * MSG_ID_ERRC_ERLCUL_CONFIG_CNF |
| *--------------------------------------------------------------------------*/ |
| |
| typedef struct |
| { |
| LOCAL_PARA_HDR |
| |
| errc_el2_cfg_result_enum result; |
| |
| } errc_erlcul_config_cnf_struct; |
| |
| |
| |
| /*-------------------------------------------------------------------------- |
| * MSG_ID_ERRC_ERLCUL_SRB1_ACK_REQ |
| *--------------------------------------------------------------------------*/ |
| |
| typedef struct |
| { |
| LOCAL_PARA_HDR |
| |
| /// report control flag |
| /// - KAL_TRUE: start report |
| /// - KAL_FALSE: stop report |
| kal_bool report; |
| |
| kal_uint8 rsvd_1; |
| kal_uint16 rsvd_2; |
| |
| } errc_erlcul_srb1_ack_req_struct; |
| |
| |
| /*-------------------------------------------------------------------------- |
| * MSG_ID_ERLCUL_ERRC_SRB1_ACK_CNF |
| *--------------------------------------------------------------------------*/ |
| // no local parameters |
| |
| |
| /*-------------------------------------------------------------------------- |
| * MSG_ID_ERRC_ERLCUL_SWITCH_VIRTUAL_CONNECTED_REQ |
| *--------------------------------------------------------------------------*/ |
| typedef struct |
| { |
| LOCAL_PARA_HDR |
| errc_el2_switch_virtual_connected_enum status; |
| |
| } errc_erlcul_switch_virtual_connected_req_struct; |
| |
| /*-------------------------------------------------------------------------- |
| * MSG_ID_ERRC_ERLCUL_SWITCH_VIRTUAL_CONNECTED_CNF |
| *--------------------------------------------------------------------------*/ |
| |
| //no contents in this CNF, success only |
| |
| /*-------------------------------------------------------------------------- |
| * MSG_ID_ERRC_ERLCUL_GAMING_CELL_INFO_NTF |
| *--------------------------------------------------------------------------*/ |
| |
| #define MAX_REPORTED_CELL_NUM (10) |
| |
| typedef struct |
| { |
| kal_uint16 pci; |
| kal_uint16 rsvd; |
| kal_uint32 earfcn; |
| errc_erlcul_gaming_status_enum cell_status; |
| |
| } errc_erlcul_gaming_cell_info_struct; |
| |
| typedef struct |
| { |
| LOCAL_PARA_HDR |
| |
| kal_uint16 cell_num; |
| kal_uint16 rsvd; |
| errc_erlcul_gaming_cell_info_struct cell_info[MAX_REPORTED_CELL_NUM]; |
| |
| } errc_erlcul_gaming_cell_info_ntf_struct; |
| |
| #endif |