mcu/protocol/interface/general/ratdm_enl2_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).
*
*****************************************************************************/
#ifndef RATDM_ENL2_STRUCT_H
#define RATDM_ENL2_STRUCT_H

#include "kal_general_types.h"
#include "kal_public_defs.h"

#include "enl2_sap_common.h"
#include "upcm_did.h"

#include "ue_testmode_struct.h"

#define RATDM_ENPDCP_MAX_NUM_DRB 32
#define RATDM_ENPDCP_MAX_NUM_ROLLBACK_NAS_SIT 1 /// for NSA, 1 DRB map to only 1 EPSB
#define RATDM_ENPDCP_INVALID_RB_IDX 0xFF

#define ENPDCP_SAP_MAX_QOS_FLOWS_PER_PDU_SESSION    64
#define RATDM_ENPDCP_MAX_NUM_PDU_SESSION            16
#define ENPDCP_MAX_FLOW_NUM_PER_DRB                 64

/**
 * @brief the NAS SIT information of new arriaval uplink data for LTE and NR Layer 2 modules
 */
typedef struct
{
    kal_uint32 total_size; ///< Total size in byte of the new arrival data
    kal_uint16 start_idx; ///< The start index of new arrival data in the NAS SIT
    kal_uint16 cnt; ///< Number of new arrival data
} ratdm_enl2_ul_data_struct;

/**
 * @brief MSG_ID_RATDM_ENPDCP_DATA_REQ, MSG_ID_RATDM_SDAP_DATA_REQ
 *
 * The new data arrival of uplink data from RATDM to EN-L2.
 */
typedef struct
{
    LOCAL_PARA_HDR

    enpdcp_cn_generation_enum cn_generation;
    kal_uint8 ebi;
    kal_uint8 pdu_session_id;
    kal_uint8 qfi;
    kal_uint16 sit_tbl_idx; ///< NAS SIT table index
    kal_uint8 rb_idx;       ///< valid only for loopback mode A. Invalid value (0xFF) for other scenarios.

    ratdm_enl2_ul_data_struct data_pri; ///< Priority data list
    ratdm_enl2_ul_data_struct data_nml; ///< Normal data list
} ratdm_enpdcp_data_req_struct, ratdm_sdap_data_req_struct;

typedef struct
{
    LOCAL_PARA_HDR

    kal_uint32 num;                                 /* num of rb */
    kal_uint32 rb_idx[RATDM_ENPDCP_MAX_NUM_DRB];    /* RB Index (0~15, 19~34)*/
} ratdm_enpdcp_data_disc_req_struct;

// MSG_ID_RATDM_ENPDCP_SIT_FULL_REQ
typedef struct
{
    LOCAL_PARA_HDR
    enpdcp_cn_generation_enum cn_generation;
    kal_uint8 ebi;
    kal_uint8 pdu_session_id;
    kal_uint8 qfi;
} ratdm_enpdcp_sit_full_req_struct;


// MSG_ID_RATDM_ENPDCP_5QI_UPDATE_REQ
typedef struct
{
    LOCAL_PARA_HDR

    kal_uint8 psi;
    kal_uint8 num_qfi;
    kal_uint8 qfi[ENPDCP_SAP_MAX_QOS_FLOWS_PER_PDU_SESSION];
    kal_uint8 vqi[ENPDCP_SAP_MAX_QOS_FLOWS_PER_PDU_SESSION];
} ratdm_enpdcp_5qi_update_req_struct;

/**
 * @brief MSG_ID_RATDM_ENPDCP_UL_DATA_REDIR_IND
 *
 * Uplink Rollback (Redirect) data from ENPDCP to RATDM due to inter-RAT change.
 */
// TODO: possible batch multiple QFI in one DATA-REQ
typedef struct
{
    LOCAL_PARA_HDR

    enpdcp_cn_generation_enum cn_generation;
    kal_uint8 nas_bearer_num;
    kal_uint8 ebi;
    kal_uint8 pdu_session_id;
    kal_uint8 qfi[ENPDCP_MAX_FLOW_NUM_PER_DRB];
    kal_uint16 sit_tbl_idx[ENPDCP_MAX_FLOW_NUM_PER_DRB];  ///< NAS SIT table index
    kal_uint16 rollback_start_nml[ENPDCP_MAX_FLOW_NUM_PER_DRB]; ///< The start index of normal SIT
    kal_uint16 rollback_end_nml[ENPDCP_MAX_FLOW_NUM_PER_DRB]; ///< The end index of normal SIT
    kal_uint16 rollback_start_pri[ENPDCP_MAX_FLOW_NUM_PER_DRB]; ///< The start index of priority SIT
    kal_uint16 rollback_end_pri[ENPDCP_MAX_FLOW_NUM_PER_DRB]; ///< The end index of priority SIT
} ratdm_enpdcp_ul_data_redir_ind_struct;

typedef struct
{
    enpdcp_cn_generation_enum cn_generation;
    kal_uint8 ebi; ///< valid when CN generation is EPC
    kal_uint8 pdu_session_id; ///< valid when CN generation is 5G
    upcm_did    *p_head;
    upcm_did    *p_tail;
} enpdcp_deliver_data_struct;

typedef struct
{
    LOCAL_PARA_HDR

    kal_uint32 num;
    enpdcp_deliver_data_struct data[RATDM_ENPDCP_MAX_NUM_DRB];
} ratdm_enpdcp_data_ind_struct;


// MSG_ID_RATDM_ENPDCP_PDU_SESSION_RB_STATUS_IND
typedef struct
{
    LOCAL_PARA_HDR

    kal_uint8 num_psi;
    kal_uint8 psi[RATDM_ENPDCP_MAX_NUM_PDU_SESSION];
    kal_bool rb_exist[RATDM_ENPDCP_MAX_NUM_PDU_SESSION];
} ratdm_enpdcp_pdu_session_rb_status_ind_struct;

// MSG_ID_RATDM_ENPDCP_DL_PATH_SWITCH_REQ
typedef struct
{
    LOCAL_PARA_HDR

    enpdcp_cn_generation_enum cn_generation;
    /* Bit set to 1 all DRBs are SW path.   */
    kal_bool force_all_drb;    
    
    kal_bool is_force_indirect_path;

    /* Bit set to 1 iff the corresponding EPSB or PDU session is SW path. Depend on cn_generation: EBI or PSI
     * LSB: for EBI / PSI 0
     * MSB: for EBI / PSI 15
     */
    kal_uint16 indirect_path_bearer_bmp;   

    /* Valid when cn_generation is 5G.
     * indirect_path_5g_qfi[1] = b'100; // PSI 1 QFI 2 is SW path.
     */
    kal_uint64 indirect_path_5g_qfi[RATDM_ENPDCP_MAX_NUM_PDU_SESSION];

    // TODO: retire
    kal_uint8 ebi; // to be removed
    kal_uint8 pdu_session_id; // to be removed
    kal_uint8 qfi; // to be removed
} ratdm_enpdcp_dl_path_switch_req_struct;

// MSG_ID_RATDM_ENPDCP_TESTLOOP_IND
typedef testloop_cfg_struct ratdm_enpdcp_testloop_ind_struct;

#define ENPDCP_RATDM_DATA_IND_HIGH_THRESHOLD (20)
#define ENPDCP_RATDM_DATA_IND_LOW_THRESHOLD (10)
/**
 * @brief increasing data-ind-consumer counter
 *        and send DATA-IND-RESUME-REQ if producer-consumer is lower than threshold
 *
 * @param protocol_idx protocol index of caller
 * 
 * @return void
 */
void enpdcp_ratdm_data_ind_consume(kal_uint8 protocol_idx);

#endif /* RATDM_ENL2_STRUCT_H */