mcu/protocol/interface/l4misc/l4c2phb_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).
*
*****************************************************************************/

/*******************************************************************************
 * Filename:
 * ---------
 *	l4c2phb_struct.h
 *
 * Project:
 * --------
 *   MAUI
 *
 * Description:
 * ------------
 *   This file is intends for structure definition between PHB and L4C.
 *
 * Author:
 * -------
 * -------
 *
 *==============================================================================
 *******************************************************************************/

/********************************************************************************
*  Copyright Statement:
*  --------------------
*
*  This product has been developed using a protocol stack
*  developed by Sasken Communication Technologies Limited.
*
********************************************************************************/


/*******************************************************************************
*  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) 2002
*
*******************************************************************************
 *  FILENAME : l4c2phb_struct.h
 *  SYNOPSIS : Functions for encoding/decoding.
 *
 *                      R E V I S I O N    H I S T O R Y
 *
 */
#ifndef _L4C2PHB_STRUCT_H
#define _L4C2PHB_STRUCT_H

//#include "l4c2uem_struct.h"
#include "l4c_aux_struct.h"
//#include "kal_non_specific_general_types.h"
//#include "common_nvram_editor_data_item.h"
#include "l4c2phb_enums.h"

#include "ps_public_enum.h"
#include "kal_general_types.h"
#include "nvram_editor_data_item.h"
#include "l4_nvram_editor.h"
#include "ps_public_struct.h"
#include "kal_public_defs.h"

#include "sim_ps_enum.h"

#ifndef NVRAM_PHB_SIZE
#define NVRAM_PHB_SIZE (54+MAX_PS_NAME_SIZE)
#endif
#ifndef PHB_EMAIL_SIZE
#define PHB_EMAIL_SIZE 66
#endif

#ifndef PHB_ANR_SIZE
#define PHB_ANR_SIZE 49
#endif

typedef struct {
    kal_uint16 index; /* index maintained by PHB*/
    phb_storage_enum storage; /* phb_storage_enum; Physical storage*/
    phb_type_enum type; /* amanda add */
    kal_uint8 num_index; 
    kal_uint8 aas_id; 
    kal_uint16 record_index; /* Record index in physical storage*/
    l4_name_struct alpha_id; /* Alpha identifier*/
    l4_addr_bcd_struct tel_number; /* Telephone number*/
    kal_uint8 cap_cnf_id; /* Capability/Configuration identifier*/
} phb_entry_struct;

typedef struct {
    kal_uint16 no_array;
    kal_uint16 array_size;
    phb_entry_struct *array; /* Array of raw data entry(ies), each element is type of phb_entry_struct.*/
} l4cphb_phb_entry_array_struct;

typedef struct {
    kal_uint16 record_index; /* Record index in physical storage*/
    kal_uint16 adn_record_index; /* adn record index */
    kal_uint8 anr_type; /* ANRA, ANRB or ANRC */
    kal_uint8 aas_id; /* anr alhpha id identifier */
    l4_addr_bcd_struct tel_number; /* Telephone number*/
    kal_uint8 cap_cnf_id; /* Capability/Configuration identifier*/
} phb_anr_struct;

typedef struct {
    LOCAL_PARA_HDR
    sim_dn_enum dn_type; /* Dial number type*/
    kal_bool is_fdn_change;
} l4cphb_startup_req_struct;

/* EF descriptor */

typedef struct { 
    LOCAL_PARA_HDR
    kal_uint8 result; /* phb_errno_enum; Operation result*/
    /* obsolete */
    kal_uint16 adn_size;
    kal_uint16 phb_size;
    kal_uint8 adn_alpha_length;
    kal_uint8 fdn_alpha_length;
    kal_uint8 bdn_alpha_length;
    kal_uint8 msisdn_alpha_length;
    kal_uint8 email_length; 
     /* obsolete */
    kal_uint8 is_sim_refresh;
    l4c_phb_desc_struct desc[PHB_TYPE_TOTAL]; /* start from (PHB_NONE + 1) */
} l4cphb_startup_cnf_struct;

typedef struct {
    LOCAL_PARA_HDR
    l4c_phb_desc_struct desc[PHB_TYPE_TOTAL];
} l4cphb_startup_begin_ind_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 src_id; /* Required for L4C*/
    phb_type_enum type; /* phb_type_enum; Type of phone number entries*/
    phb_storage_enum storage; /* Specifies storage*/
    kal_uint8 num_index; 
    kal_uint16 index; /* Index of phone number entries*/
    kal_uint16 record_index; /* Record index of physical storage*/
    kal_uint16 total; /* Number of entries to read*/
} l4cphb_read_req_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 src_id; /* The 'src_id' of the corresponding reqest is forwarded back in this field.*/
    phb_errno_enum result; /* phb_errno_enum; Operation result*/
    kal_uint16 cause;
    kal_uint16 total; /* Number of entries*/
} l4cphb_read_cnf_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 src_id; /* Required for L4C*/
    phb_type_enum type; /* phb_type_enum; Type of phone number entries*/
    kal_uint16 total; /* Number of entires to piggyback*/
} l4cphb_write_req_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 src_id; /* The `src_id' of the corresponding reqest is forwarded back in this field.*/
    phb_errno_enum result; /* phb_errno_enum; Operation result*/
    kal_uint16 cause;
    kal_uint16 total; /* Number of entries*/
    kal_uint16 old_index;
} l4cphb_write_cnf_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 src_id; /* Required for L4C*/
    phb_type_enum type; /* phb_type_enum; Type of phone number entries*/
    kal_uint8 num_index;
    phb_storage_enum storage;
    kal_uint8 total_piggyback; /* Number of entires to piggyback*/
    kal_uint16 index; /* Index of phone number entries*/
    kal_uint16 total; /* Number of entries*/
    kal_uint16 record_index;
} l4cphb_delete_req_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 src_id; /* The 'src_id' of the corresponding reqest is forwarded back in this field.*/
    phb_errno_enum result; /* phb_errno_enum; Operation result*/
    kal_uint16 cause;
    kal_uint16 total; /* Number of entries*/
    phb_type_enum type;    
    kal_uint16 old_index;
} l4cphb_delete_cnf_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 src_id; /* Required for L4C*/
    kal_uint16 total; /* Number of entires to piggyback*/
    phb_type_enum type; /* phb_type_enum; Type of phone number entries*/
    phb_query_method_enum pattern_tag;
    union {
        l4_name_struct alpha_id;
        l4_addr_bcd_struct tel_number;
    } pattern_value;
} l4cphb_search_req_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 src_id; /* The 'src_id' of the corresponding reqest is forwarded back in this field.*/
    phb_errno_enum result; /* phb_errno_enum; Operation result*/
    kal_uint16 cause;
    kal_uint16 total; /* Number of entries*/
} l4cphb_search_cnf_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 src_id; /* Required for L4C*/
    l4_addr_bcd_struct tel_number; /* The telephone number to be approved*/
    kal_uint8 is_retrieve; /* Whether retrieving the hit entry of the given number is required*/
    l4c_phb_approval_type_enum approval_type; /* l4c_phb_approval_type_enum */
} l4cphb_approve_req_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 src_id; /* The `src_id' of the corresponding reqest is forwarded back in this field.*/
    phb_errno_enum result; /* phb_errno_enum; Operation result*/
    kal_uint16 cause;
    phb_type_enum type; /* phb_type_enum; Type of phone number entries*/
    kal_uint8 esc;
} l4cphb_approve_cnf_struct;


typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8 src_id;
    l4_addr_bcd_struct   number;
} l4cphb_fdn_get_name_req_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8 src_id;
    phb_errno_enum result;
    kal_uint16 cause;
    l4_name_struct alpha_id;
} l4cphb_fdn_get_name_cnf_struct;

/* __REL5__ */
typedef struct {
    kal_uint8 category;
    l4_addr_bcd_struct tel_number;
}l4_ecc_number_struct;

typedef struct {
    LOCAL_PARA_HDR
    kal_uint8 no_ecc;
    l4_ecc_number_struct ecc_list[16];
}l4cphb_update_nw_ecc_req_struct;

typedef struct {
    kal_uint8 max_name_len;
    kal_uint8 max_num_len;
    kal_uint16 free_num;
    kal_uint16 total_num;
    kal_uint16 ext_free_num;    
}l4cphb_file_info_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8 src_id;
    phb_type_enum type;
    kal_uint16 record_index;
    kal_uint8 occurrence;
} l4cphb_read_usim_req_struct;

typedef l4cphb_read_usim_req_struct l4cphb_write_usim_req_struct;
typedef l4cphb_read_usim_req_struct l4cphb_delete_usim_req_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8 src_id;
    phb_errno_enum result;
    kal_uint16 cause;
    phb_type_enum type;
    kal_uint16 record_index;
    kal_uint8 occurrence;
} l4cphb_read_usim_cnf_struct;

typedef l4cphb_read_usim_cnf_struct l4cphb_write_usim_cnf_struct;
typedef l4cphb_read_usim_cnf_struct l4cphb_delete_usim_cnf_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8 src_id;
    kal_uint8 file_bitmap[PHB_TYPE_TOTAL];
    kal_uint16 record_index;
} l4cphb_check_write_usim_entry_req_struct;

typedef struct
{
    LOCAL_PARA_HDR
    kal_uint8 src_id;
    phb_errno_enum result;
    kal_uint8 occurrence;
    kal_uint16 record_index;
} l4cphb_check_write_usim_entry_cnf_struct;


//MSG_ID_L4C_PHB_UT_REQ
typedef struct
{
    LOCAL_PARA_HDR
    kal_bool                        update_phb_user;
    kal_uint32                      phb_user;

    kal_bool                        update_phb_current_action;
    kal_uint16                      phb_current_action;

    kal_bool                        update_phb_ready_flag;
    kal_bool                        phb_ready_flag;
    
    //l4_number_struct                l4cphb_approve_req_string;

    kal_bool                        update_phb_update_from_crsm;
    kal_bool                        phb_update_from_crsm; // update PHB record if CRSM is used

    kal_bool                        update_phb_approve_ussd;
    kal_bool                        phb_approve_ussd;

    kal_bool                        update_is_fdn_change;
    kal_bool                        is_fdn_change;

}l4c_phb_ut_req_struct;


#endif