mcu/protocol/interface/general/ursp_upds_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) 2019
*
*  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 URSP_UPDS_STRUCT_H
#define URSP_UPDS_STRUCT_H

#include "mcd_l3_inc_struct.h"

typedef enum
{
    UPDS_TYPE_RESERVED = 0x00,
    UPDS_TYPE_URSP     = 0x01,
    UPDS_TYPE_ANDSP    = 0x02
} ue_policy_part_type_enum;

typedef struct
{
    ue_policy_part_type_enum ue_policy_part_type; //No need to read by destination module due to only send URSP to MOD_URSP
    kal_uint16 ue_policy_part_content_len; // Length of content in UE policy part
    kal_uint8 *ue_policy_part_content; // Contents of UE policy part
} ue_policy_part_struct;

typedef struct
{
    kal_uint16 upsc;
    kal_uint16 instruction_order;
    kal_uint8 ue_policy_part_num; // num of UE policy part included in instruction
    ue_policy_part_struct *ue_policy_part; // Array of UE policy part
} ue_policy_instruction_struct;

typedef struct
{
    plmn_id_struct plmn_id;
    kal_uint8 instruction_num; // num of instruction included in 1 sublist
    ue_policy_instruction_struct *instruction; // Array of instruction
} ue_policy_sublist_struct;

typedef struct
{
    kal_uint16 upsc;
    kal_uint16 fail_instruction_order;
    kal_uint8 cause;
 
} ue_policy_result_struct;

typedef struct
{
    plmn_id_struct plmn_id;
    kal_uint8 result_num; // num of result included in subresult
    ue_policy_result_struct *result; // Array of result
} ue_policy_subresult_struct;

typedef struct
{
    plmn_id_struct plmn_id;
    kal_uint8 upsc_num;
    kal_uint16 *upsc;
} upsi_sublist_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8 seq_num;
    kal_uint8 ue_policy_sublist_num; // num of sublist included
    ue_policy_sublist_struct *ue_policy_sublist; // Array of sublist
} ursp_upds_ue_policy_ind_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8 seq_num;
    kal_bool result_success; // If all UE policy execute successfully, then retrun KAL_TRUE
    kal_uint8 ue_policy_subresult_num; // num of subresult included
    ue_policy_subresult_struct *ue_policy_subresult; // Array of subresult
} ursp_upds_ue_policy_rsp_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8 seq_num;
} ursp_upds_get_ue_policy_info_ind_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8 seq_num;
    kal_uint8 upsi_sublist_num; // If this value is 0, no need to create UE_STATE_INDICATION
    upsi_sublist_struct *upsi_sublist;
/*
kal_uint8 os_id_num;
os_id_struct *os_id
*/
} ursp_upds_get_ue_policy_info_rsp_struct;

#endif /* URSP_UPDS_STRUCT_H */