mcu/protocol/interface/l4misc/l4bpdn_tcm_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) 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:
 * ---------
 *   l4bpdn_tcm_struct.h
 *
 * Project:
 * --------
 *   
 *
 * Description:
 * ------------
 *
 *
 * Author:
 * -------
 *  
 *   
 *
 * ==========================================================================
 * $Log$
 *
 * 09 22 2021 stun.wu
 * [MOLY00728968] [ZM62] AT+EGPCO to get MSISDN
 *
 * 09 17 2021 judy.zhu
 * [MOLY00704256] [VzW] 5G Ultra Wideband icon display
 * 	
 * 	Patch back from NR15.R3.MP branch
 * 	.
 *
 * 09 08 2021 judy.zhu
 * [MOLY00704256] [VzW] 5G Ultra Wideband icon display
 * 	
 * 	[VzW]5G Ultra Wideband icon display feature patch back
 * 	
 * 	.
 *
 * 04 19 2019 yu-hsin.lin
 * [MOLY00399993] [Gen97][VMOLY] interworking withN26 features
 * [MPD][Code] merge from 7781298, l4 ps with n26
 *
 * 03 26 2019 yu-hsin.lin
 * [MOLY00393456] [Gen97][VMOLY] 45G InterRAT & interSystem feature
 * [VMOLY][MPD][Interface] L4_PS Gen97 irat withou n26
 *
 * 12 14 2018 poying.chuang
 * [MOLY00372635] [VMOLY] L4/TCM/TFTLIB/VGSM phase2 check-in
 * 	
 * 	- [L4] Phase 2 - Interfaces .
 *
 * 08 17 2018 poying.chuang
 * [MOLY00346763] [6297] Gen97 L4 PS Check-In
 * 	
 * 	- interfaces .
 *
 * 05 21 2018 praveen.komatiguntla
 * [MOLY00327084] [EIGER][MT3967]PS Data Off feature: PDP Modify procedure to update the PS Data Off Statusto NW side.
 * PS Data off feature - L4/TCM changes.
 *
 * 12 11 2017 poying.chuang
 * [MOLY00294886] [MT6763][Bianco][O1][MP2][TMO][simulator][in-house][Anritsu][Protocol_IMS & VoLTE][50905][L_IMS_VoLTE_6752_1]
 * .
 *
 * 04 05 2017 poying.chuang
 * [MOLY00209737] [MT6293] LWTG and C2K L4 integration check in
 * [M3] Merge CL up to 3677934 - interface .
 *
 * 02 20 2017 poying.chuang
 * [MOLY00209737] [MT6293] LWTG and C2K L4 integration check in
 * 	
 * 	- [M2] l4bpdn/tcm - interface (up to CL 3474533) .
 *
 ****************************************************************************/


#ifndef  _L4BPDN_TCM_STRUCT_H
#define  _L4BPDN_TCM_STRUCT_H

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

#include "tftlib_common_enum.h"
#include "tftlib_common_struct.h"

#include "ps_public_enum_public.h"
#include "l3_inc_enums_public.h"
#include "ps_public_struct.h"


#if __GROUP_L4BPDN_TCM_INTERFACE_DEFINE_AND_SUB_STRUCT__ || 1

#define L4BPDN_TCM_PCSCF_4_TO_8_SIZE 5
#define L4BPDN_TCM_BEARER_NUM 15

#define L4BPDN_TCM_PDU_ADDR_LIFETIME_SIZE 2

typedef struct {
    pdp_addr_type_enum type;
    pdp_addr_len_enum  len;
    kal_uint8          val[IPV4V6_ADDR_LEN];
} l4bpdn_tcm_ip_addr_struct;

typedef struct {
    kal_uint8 mcc1;
    kal_uint8 mcc2;
    kal_uint8 mcc3; 
    kal_uint8 mnc1;
    kal_uint8 mnc2; 
    kal_uint8 mnc3; 
} l4bpdn_tcm_plmn_id_struct;

typedef struct {
    kal_uint8 context_id;   /* CID */

    /**
     * In 5G, indicate PDU session id 
     * Otherwise, simply fill-in 0 (or the mapped PDU session id?) */
    kal_uint8   pdu_session_id;
   
    /** 
     * In 5G, indicate QoS flow id (qfi) 
     * Otherwise, indicate nsapi(23G) or ebi(4G) */
    kal_uint8   bearer_id;

    ps_cause_enum cause;
} l4bpdn_tcm_deact_id_struct;

typedef struct {
    kal_uint8   apn_length;
    kal_uint8   apn[MAX_APN_LEN];
    kal_bool    src_addr_sb_net_mask_present;
    kal_uint8   src_addr_sb_net_mask[IPV4_ADDR_LEN * 2];
    kal_bool    ipv6_src_addr_sb_net_mask_present;
    kal_uint8   ipv6_src_addr_sb_net_mask[IPV6_ADDR_LEN * 2];
    kal_bool    gw_addr_present;
    kal_uint8   gw_addr[IPV4_ADDR_LEN];
    kal_bool    ipv6_gw_addr_present;
    kal_uint8   ipv6_gw_addr[IPV6_ADDR_LEN];
    kal_bool    dns_present;
    kal_uint8   dns[IPV4_ADDR_LEN];
    kal_bool    dns2_present;
    kal_uint8   dns2[IPV4_ADDR_LEN];
    kal_bool    dns3_present;
    kal_uint8   dns3[IPV4_ADDR_LEN];    
    kal_bool    ipv6_dns_present;
    kal_uint8   ipv6_dns[IPV6_ADDR_LEN];
    kal_bool    ipv6_dns2_present;
    kal_uint8   ipv6_dns2[IPV6_ADDR_LEN];
    kal_bool    ipv6_dns3_present;
    kal_uint8   ipv6_dns3[IPV6_ADDR_LEN];    
    kal_bool    p_cscf_prim_addr_present;
    kal_uint8   p_cscf_prim_addr[IPV4_ADDR_LEN];
    kal_bool    p_cscf_sec_addr_present;
    kal_uint8   p_cscf_sec_addr[IPV4_ADDR_LEN];
    kal_bool    p_cscf_third_addr_present;
    kal_uint8   p_cscf_third_addr[IPV4_ADDR_LEN];
    kal_bool    ipv6_p_cscf_prim_addr_present;
    kal_uint8   ipv6_p_cscf_prim_addr[IPV6_ADDR_LEN];
    kal_bool    ipv6_p_cscf_sec_addr_present;
    kal_uint8   ipv6_p_cscf_sec_addr[IPV6_ADDR_LEN];
    kal_bool    ipv6_p_cscf_third_addr_present;
    kal_uint8   ipv6_p_cscf_third_addr[IPV6_ADDR_LEN];
    kal_bool    im_cn_signalling_flag_present;
    kal_uint8   im_cn_signalling_flag;
    kal_bool    lipa_indication_present; // indicates that the PDP context provides connectivity using a LIPA PDN connection
    kal_uint8   lipa_indication;
    kal_bool    v4_mtu_present;          // shows the IPv4 MTU size in octets 
    kal_uint16  v4_mtu;
    kal_bool    wlan_offload_present;    // indicates whether traffic can be offloaded using the specified PDN connection via a WLAN or not 
    kal_uint8   wlan_offload;
    kal_bool    local_addr_ind_present;  // indicates whether or not the MS and the network support local IP address in TFTs 
    kal_uint8   local_addr_ind;
    kal_bool    p_cscf_fourth_to_eighth_addr_present[L4BPDN_TCM_PCSCF_4_TO_8_SIZE];         //add for CT support 8 p-cscf address requirement
    kal_uint8   p_cscf_fourth_to_eighth_addr[L4BPDN_TCM_PCSCF_4_TO_8_SIZE][IPV4_ADDR_LEN];  //add for CT support 8 p-cscf address requirement
    kal_bool    ipv6_p_cscf_fourth_to_eighth_addr_present[L4BPDN_TCM_PCSCF_4_TO_8_SIZE];        //add for CT support 8 p-cscf address requirement
    kal_uint8   ipv6_p_cscf_fourth_to_eighth_addr[L4BPDN_TCM_PCSCF_4_TO_8_SIZE][IPV6_ADDR_LEN]; //add for CT support 8 p-cscf address requirement
    kal_bool    ps_data_off_support_present; 
    kal_uint8   ps_data_off_support;
    kal_bool                    ssc_mode_present;
    l4c_tcm_ssc_mode_enum       ssc_mode;
    kal_bool                    s_nssai_present;
    l4c_tcm_s_nssai_struct      s_nssai; 
    kal_bool                    access_type_present;
    l4c_tcm_access_type_enum    access_type; 
    kal_uint32                  rq_timer_value_in_sec;
    l4c_tcm_always_on_pdu_enum  always_on_pdu_by_nw;
} l4bpdn_tcm_pdp_rdp_info_struct;

typedef struct {
    /* v4 dns -> Contained in l4bpdn_tcm_prim_pdp_rdp_info_struct */ 
    /* v6 dns -> Contained in l4bpdn_tcm_prim_pdp_rdp_info_struct */ 
    /* v4 mtu -> Contained in l4bpdn_tcm_prim_pdp_rdp_info_struct */ 

    kal_bool  msisdn_present;
    kal_uint8 msisdn[MAX_MSISDN_LEN];
    kal_uint8 msisdn_len;

    /* pdu address lifetime */
    kal_bool  pdu_addr_lifetime_present;
    kal_uint8 pdu_addr_lifetime[L4BPDN_TCM_PDU_ADDR_LIFETIME_SIZE]; 

    /**************************************** 
     * Operator Specific PCOs in VZW: Start *
     ****************************************/
    /* 0xFF00 */ 
    kal_bool pdn_application_access_control_present; 
    l4bpdn_tcm_plmn_id_struct pdn_application_access_control_plmnid;
    kal_uint8 pdn_application_access_control_action;

    /* 0xFF01 */ 
    kal_bool epdg_v6_plmnid_present;
    l4bpdn_tcm_plmn_id_struct epdg_v6_plmnid; 
    kal_bool  epdg_v6_addr_present;
    kal_uint8 epdg_v6_addr[IPV6_ADDR_LEN];
    kal_bool  epdg_v6_addr2_present;
    kal_uint8 epdg_v6_addr2[IPV6_ADDR_LEN];

    /* 0xFF02 */
    kal_bool  epdg_v4_plmnid_present; 
    l4bpdn_tcm_plmn_id_struct epdg_v4_plmnid; 
    kal_bool  epdg_v4_addr_present;
    kal_uint8 epdg_v4_addr[IPV4_ADDR_LEN];
    kal_bool  epdg_v4_addr2_present;
    kal_uint8 epdg_v4_addr2[IPV4_ADDR_LEN];

    /* 0xFF03 */
    kal_bool  vzw_5guw_present; 
    kal_uint8 vzw_5guw; 
    /**************************************** 
     * Operator Specific PCOs in VZW: End   *
     ****************************************/
} l4bpdn_tcm_pco_rdp_info_struct;

#endif // __GROUP_L4BPDN_TCM_INTERFACE_DEFINE_AND_SUB_STRUCT__

typedef struct {
    LOCAL_PARA_HDR

    kal_uint8 context_id;

    /**
     * Indicate how to interpret the below ids: pdu_session_id, bearer_id, linked_bearer_id */
    kal_bool is_5g_id; 

    /** 
     * In 5G, indicate PDU session id 
     * Otherwise, simply fill-in 0 (or the mapped PDU session id?) */
    kal_uint8 pdu_session_id;
   
    /**
     * In 5G, indicate QoS flow id (qfi) 
     * Otherwise, indicate nsapi(23G) or ebi(4G) */
    kal_uint8 bearer_id;

    /** 
     * If the PDP is secondary, indicate UPCM which primary PDP context the bearer is linked with. 
     * If the PDP is primary, indicate the linked_nspai = nsapi.
     * If in 5G, indicate the qfi which contains default qos rule */
    kal_uint8 linked_bearer_id;

    /**
     * TFTLIB output: pkt_filter_act_list_struct  
     * - Needs to convert to pkt_filters_act_list_node_struct for UPCM use 
     * - In 5G, the conversion is done by VGSM 
     * - In 234G, the conversions are done by UGTCM and ETCM, respectively */
    pkt_filters_act_list_node_struct *pf_action_list_node;

    /* Address acquired by PDP context activation. */
    l4bpdn_tcm_ip_addr_struct ip_addr;

    kal_bool pdp_rdp_present;
    l4bpdn_tcm_pdp_rdp_info_struct pdp_rdp;
} l4bpdn_tcm_bearer_act_ind_struct;

typedef struct {
    LOCAL_PARA_HDR

    kal_uint8                  bearer_num;          /* indicate number of nsapi/EBI entries carried in deact_nsapi_list.*/
    l4bpdn_tcm_deact_id_struct deact_id_list[L4BPDN_TCM_BEARER_NUM];   /* CID/NSAPI/EBI list of the deactivated PDP contexts*/
} l4bpdn_tcm_bearer_deact_ind_struct;

typedef struct {
    kal_uint8 context_id;

    /**
     * Indicate how to interpret the below ids: pdu_session_id, bearer_id, linked_bearer_id */
    kal_bool is_5g_id; 

    /** 
     * In 5G, indicate PDU session id 
     * Otherwise, simply fill-in 0 (or the mapped PDU session id?) */
    kal_uint8 pdu_session_id;
   
    /**
     * In 5G, indicate QoS flow id (qfi) 
     * Otherwise, indicate nsapi(23G) or ebi(4G) */
    kal_uint8 bearer_id;

    /** 
     * If the PDP is secondary, indicate UPCM which primary PDP context the bearer is linked with. 
     * If the PDP is primary, indicate the linked_nspai = nsapi.
     * If in 5G, indicate the qfi which contains default qos rule */
    kal_uint8 linked_bearer_id;

    /**
     * TFTLIB output: pkt_filter_act_list_struct  
     * - Needs to convert to pkt_filters_act_list_node_struct for UPCM use 
     * - In 5G, the conversion is done by VGSM 
     * - In 234G, the conversions are done by UGTCM and ETCM, respectively */
    pkt_filters_act_list_node_struct *pf_action_list_node;

    /* Address acquired by PDP context activation. */
    l4bpdn_tcm_ip_addr_struct ip_addr;

    kal_bool pdp_rdp_present;
    l4bpdn_tcm_pdp_rdp_info_struct pdp_rdp;
} l4bpdn_tcm_act_id_struct;


typedef struct {
    LOCAL_PARA_HDR

    /* Indicate UPCM the packet filter modification is triggered by which PDP context/EPS bearer context */
    kal_uint8 context_id;

    /**
     * Indicate how to interpret the below ids: pdu_session_id, bearer_id, linked_bearer_id */
    kal_bool is_5g_id; 

    /**
     * In 5G, indicate PDU session id 
     * Otherwise, simply fill-in 0 (or the mapped PDU session id?) */
    kal_uint8 pdu_session_id;

    /**
     * In 5G, indicate QoS flow id (qfi) 
     * Otherwise, indicate nsapi(23G) or ebi(4G) */    
    kal_uint8 bearer_id;

    /**
     * TFTLIB output: pkt_filter_act_list_struct  
     * - Needs to convert to pkt_filters_act_list_node_struct for UPCM use 
     * - In 5G, the conversion is done by VGSM 
     * - In 234G, the conversions are done by UGTCM and ETCM, respectively */
    pkt_filters_act_list_node_struct *pf_action_list_node;
} l4bpdn_tcm_pf_update_ind_struct;

/* Use this ILM to update PCO RDP info 
 * when it is changed by activate/modify/deactivate procedures */
typedef struct {
    LOCAL_PARA_HDR 

    kal_uint8 context_id;

    l4bpdn_tcm_pco_rdp_info_struct pco_rdp;

    kal_bool pdp_rdp_present;
    l4bpdn_tcm_pdp_rdp_info_struct pdp_rdp;

} l4bpdn_tcm_pco_rdp_update_ind_struct;

typedef struct {
    LOCAL_PARA_HDR 
    
    kal_uint8                        deact_bearer_num;                         /* indicate number of nsapi/EBI entries carried in deact_bearer_list.*/
    l4bpdn_tcm_deact_id_struct       deact_bearer_list[L4BPDN_TCM_BEARER_NUM]; /* CID/NSAPI/EBI list of the deactivated PDP contexts*/

    kal_bool                         is_4g5_irat;
    
    kal_uint8                        act_bearer_num;                           /* indicate number of nsapi/EBI entries carried in act_bearer_list.*/
    l4bpdn_tcm_act_id_struct         act_bearer_list[L4BPDN_TCM_BEARER_NUM];   /* CID/NSAPI/EBI list of the activated PDP contexts*/

} l4bpdn_tcm_45g_irat_bearer_update_ind_struct;

#endif /* _L4BPDN_TCM_STRUCT_H */