mcu/protocol/interface/general/l4bsbp_public_api.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) 2014
*
*  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:
 * ------------
 *   l4bsbp_public_api.h
 *
 * Project:
 * ------------
 *   MOLY
 *
 * Description:
 * ------------
 *   This file defines functions/enums for external module usage.
 *
 * Author:
 * -----------
 * -------
 *
 *===========================================================
 * $Log$
 *
 * 09 06 2019 titi.wu
 * [MOLY00431999] [97] code sync
 * 	
 * 	.
 *
 * 06 12 2018 peter-sl.yeh
 * [MOLY00332770] DSBP reconfig modification and SIM trans_id addition for DSBP
 * .
 *
 * 06 12 2018 peter-sl.yeh
 * [MOLY00332770] DSBP reconfig modification and SIM trans_id addition for DSBP
 * .
 *
 * 05 17 2018 peter-sl.yeh
 * [MOLY00326718] [Gen93] Add SBP API to get operator by PLMN ID
 * .
 *
 *
 *****************************************************************************/

#ifndef _L4BSBP_PUBLIC_API_H_
#define _L4BSBP_PUBLIC_API_H_

#include "kal_general_types.h"
#include "sim_exported_enum.h"


#ifndef L4BSBP_DSBP_MODE_DEFINED
#define L4BSBP_DSBP_MODE_DEFINED
typedef enum
{
    L4BSBP_DSBP_MODE_NONE,
    L4BSBP_DSBP_MODE_1,
    L4BSBP_DSBP_MODE_2,       
} l4bsbp_dsbp_mode_enum;
#endif

typedef enum
{
   L4BSBP_DSBP_STATUS_NONE,
   L4BSBP_DSBP_STATUS_LEVEL1_DSBP_ONDOING,
   L4BSBP_DSBP_STATUS_LEVEL2_DSBP_ONDOING,
} l4bsbp_dsbp_status_enum;

/*****************************************************************************
* FUNCTION
*   l4bsbp_get_dsbp_status()
*
* DESCRIPTION
*   This function is used to get current D-SBP procedure status.
*
* PARAMETERS
*   ps_id         [IN]    protocol stack ID
*
* RETURNS
*   l4bsbp_dsbp_status_enum
*****************************************************************************/
extern l4bsbp_dsbp_status_enum l4bsbp_get_dsbp_status(protocol_id_enum ps_id);

/*****************************************************************************
 * FUNCTION
 *  l4bsbp_expected_efun_state
 *
 * DESCRIPTION
 *  Compute expected EFUN state according to the D-SBP status
 *
 * PARAMETERS
 *  current_efun   [IN] current EFUN state
 *
 * RETURNS
 *  kal_uint8 expected EFUN state 
 *
 *****************************************************************************/
extern kal_uint8 l4bsbp_expected_efun_state(kal_uint8 current_efun);

/*****************************************************************************
 * FUNCTION
 *  l4bsbp_get_operator_by_plmn_id
 *
 * DESCRIPTION
 *  get SBP ID by PLMN ID (MCC+MNC)
 *
 * PARAMETERS
 *  plmn    [IN]    PLMN ID in integer format, ex. 460-01 = 46001
 *
 * RETURNS
 *  void
 *
 *****************************************************************************/
extern kal_uint32 l4bsbp_get_operator_by_plmn_id(kal_uint32 plmn_id);

/*****************************************************************************
 * FUNCTION
 *  l4bsbp_get_ap_dsbp_mode
 *
 * DESCRIPTION
 *  get AP DSBP Mode (None, Mode_1, Mode2)
 *
 * PARAMETERS
 *  ilm_ptr [IN]
 *
 * RETURNS
 *  void
 *
 *****************************************************************************/
extern l4bsbp_dsbp_mode_enum l4bsbp_get_ap_dsbp_mode(void);

/*****************************************************************************
 * FUNCTION
 *  l4bsbp_get_mcc_mnc_for_current_sim_sbp_id
 *
 * DESCRIPTION
 *  get MCC/MNC for current used SIM SBP ID.
 *  Please contact with SBP owner to make sure you could use this API.
 *
 * PARAMETERS
 *  current_ps_id   [IN] Current PS ID
 *  mcc[L4BSBP_MAX_MCC_MNC_LEN]                [IN] MCC for current used SIM SBP ID
 *  mnc[L4BSBP_MAX_MCC_MNC_LEN]                [IN] MNC for current used SIM SBP ID
 *
 *
 * RETURNS
 *  Void
 *
 *****************************************************************************/
extern void l4bsbp_get_mcc_mnc_for_current_sim_sbp_id(protocol_id_enum current_ps_id, kal_uint8 *mcc, kal_uint8 *mnc);


#endif // _VDM_EXTERNAL_LIB_H_