/*================================================================
  Copyright (c) 2021, Quectel Wireless Solutions Co., Ltd. All rights reserved.
  Quectel Wireless Solutions Proprietary and Confidential.
=================================================================*/
/*
 * @Author: Pony.ma 
 * @Date: 2020-01-08 09:25:22 
 * @Last Modified by:   Pony.ma 
 * @Last Modified time: 2020-01-08 09:25:22 
 */


#ifndef _QL_SIM_H
#define _QL_SIM_H

#include "quec_cust_feature.h"
#include "quec_debug.h"
#include "ql_gpio.h"

#if defined(QUEC_DUAL_SIM_SUPPORT) || defined(QUEC_PS_SINGLE_PHYSICAL_DUAL_SIM_SUPPORT)
typedef enum
{
	QL_SIM_0,
	QL_SIM_1,
	NUM_OF_QL_SIM
}CMSimID_ex;

typedef void (*SwitchSimDoneCb)(UINT8);
#endif

#define QL_SIM_MCC_LEN      4   /**  Length of the MCC. */
#define QL_SIM_MNC_MAX      4   /**  Maximum length of the MNC. */
#define QL_SIM_PLMN_NUM_MAX 24  /**  Maximum number of PLMN data sets. */

typedef void (*sim_detect_calback)(PIN_LEVEL_E pinlevel);



typedef enum 
{
	QL_SIM_SUCCESS,
	QL_SIM_GENERIC_FAILURE,
}QL_SIM_ERROR_CODE;



typedef struct 
{
    uint8_t mcc[QL_SIM_MCC_LEN];  /**< MCC value in ASCII characters.*/
    uint8_t mnc[QL_SIM_MNC_MAX];  /**< MNC value in ASCII characters.*/
}QL_SIM_PLMN_INFO;  

typedef struct 
{
    unsigned int          preferred_operator_list_num;                    /**< Must be set to the number of elements in preferred_operator_list. */
    QL_SIM_PLMN_INFO    preferred_operator_list[QL_SIM_PLMN_NUM_MAX];   /**< Preferred operator list. */
}QL_SIM_PREFERRED_OPERATOR_LIST;    /* Message */

#define QL_SIM_PIN_LEN_MAX  16   /**  Maximum length of PIN data. */ 
typedef struct 
{
    uint8_t                     pin_value[QL_SIM_PIN_LEN_MAX];  /*  Value of the PIN */
}QL_SIM_VERIFY_PIN_INFO;  

typedef struct 
{
    uint8_t                     old_pin_value[QL_SIM_PIN_LEN_MAX];  /**< Value of the old PIN as a sequence of ASCII characters. */
    uint8_t                     new_pin_value[QL_SIM_PIN_LEN_MAX];  /**< Value of the new PIN as a sequence of ASCII characters. */
}QL_SIM_CHANGE_PIN_INFO; 

typedef struct 
{
    uint8_t                     puk_value[QL_SIM_PIN_LEN_MAX];      /**< Value of the PUK as a sequence of ASCII characters. */
    uint8_t                     new_pin_value[QL_SIM_PIN_LEN_MAX];  /**< Value of the new PIN as a sequence of ASCII characters. */
}QL_SIM_UNBLOCK_PIN_INFO;  

typedef enum 
{
    QL_SIM_CARD_TYPE_UNKNOWN  = 0,    /**<  Unidentified card type.  */
    QL_SIM_CARD_TYPE_ICC      = 1,    /**<  Card of SIM or RUIM type.  */
    QL_SIM_CARD_TYPE_UICC     = 2,    /**<  Card of USIM or CSIM type.  */
}QL_SIM_CARD_TYPE;  
	
typedef enum 
{
   QL_SIM_STATUS_NOT_INSERTED,
   QL_SIM_STATUS_READY,
   QL_SIM_STATUS_SIM_PIN,
   QL_SIM_STATUS_SIM_PUK,
   QL_SIM_STATUS_PH_SIM_LOCK_PIN,
   QL_SIM_STATUS_PH_SIM_LOCK_PUK,
   QL_SIM_STATUS_PH_FSIM_PIN,
   QL_SIM_STATUS_PH_FSIM_PUK,
   QL_SIM_STATUS_SIM_PIN2,
   QL_SIM_STATUS_SIM_PUK2,
   QL_SIM_STATUS_PH_NET_PIN,
   QL_SIM_STATUS_PH_NET_PUK,
   QL_SIM_STATUS_PH_NET_SUB_PIN,
   QL_SIM_STATUS_PH_NET_SUB_PUK,
   QL_SIM_STATUS_PH_SP_PIN,
   QL_SIM_STATUS_PH_SP_PUK,
   QL_SIM_STATUS_PH_CORP_PIN,
   QL_SIM_STATUS_PH_CORP_PUK,
   QL_SIM_STATUS_BUSY,
   QL_SIM_STATUS_BLOCKED,
   QL_SIM_STATUS_UNKNOWN
}QL_SIM_STATUS;    /**< Card state. */

#define QL_SIM_ICCID_LEN 10
#define QL_SIM_IMSI_LEN 16

typedef struct {
    //QL_SIM_STATUS card_status;
    char imsi[QL_SIM_IMSI_LEN];
    UINT8 iccid[QL_SIM_ICCID_LEN*2+1];
    QL_SIM_STATUS card_status;
} QL_SIMCARD_INFO;
//mia.zhong @20201130 新增接口获取卡信息 end

typedef struct 
{
    uint8_t                         pin1_num_retries;       /**<   Number of PIN 1 retries. */
    uint8_t                         puk1_num_retries;       /**<   Number of PUK 1 retries. */
    uint8_t                         pin2_num_retries;       /**<   Number of PIN 2 retries. */
    uint8_t                         puk2_num_retries;       /**<   Number of PUK 2 retries. */
}QL_SIM_CARD_PIN_INFO; 



typedef struct 
{
    QL_SIM_CARD_TYPE      card_type; // SIM card type
    QL_SIM_STATUS     card_state;  //SIM card state
    QL_SIM_CARD_PIN_INFO  card_pin_info; // PIN info
}QL_SIM_CARD_INFO; 

typedef enum 
{
    QL_SIM_FILE_TYPE_UNKNOWN      = 0,/**<  Unknown file type  */
    QL_SIM_FILE_TYPE_TRANSPARENT  = 1,/**< File structure consisting of a sequence of bytes.  */
    QL_SIM_FILE_TYPE_CYCLIC       = 2,/**< File structure consisting of a sequence of records, each containing the same fixed size in 
                                                     chronological order. Once all the records have been used, the oldest data is overwritten.  */
    QL_SIM_FILE_TYPE_LINEAR_FIXED  = 3,    /**< File structure consisting of a sequence of records, each containing the same fixed size.  */
}QL_SIM_FILE_TYPE;

typedef enum 
{
    QL_SIM_FILE_ACCESS_TYPE_ALWAYS      =0,
    QL_SIM_FILE_ACCESS_TYPE_CHV1        =1,
    QL_SIM_FILE_ACCESS_TYPE_CHV2        =2,
    QL_SIM_FILE_ACCESS_TYPE_ADM         =3,
}QL_SIM_FILE_ACCESS_TYPE;
	
typedef struct 
{
    QL_SIM_FILE_ACCESS_TYPE read_access;
    QL_SIM_FILE_ACCESS_TYPE update_access;
}QL_SIM_FILE_ACCESS_INFO;

typedef enum 
{
    QL_SIM_FILE_STATUS_INVALID      =0,
    QL_SIM_FILE_STATUS_EFFECTIVE    =1,
}QL_SIM_FILE_STATUS;


typedef struct 
{
    unsigned int                id;
    QL_SIM_FILE_TYPE            type;    /**<   File type: */
    QL_SIM_FILE_ACCESS_INFO     access;    /**<   File access conditions: */
    QL_SIM_FILE_STATUS          status;    /**<   File status: */
    unsigned int                size;      /**<   Size of transparent files.*/
    unsigned int                record_len;    /**<   Size of each cyclic or linear fixed file record.*/
    unsigned int                record_count;   /**<   Number of cyclic or linear fixed file records.*/
}QL_SIM_FILE_INFO; 

typedef struct 
{
    int sw1;
    int sw2;
}QL_SIM_FILE_OPERATION_RET;

#define QL_SIM_DATA_LEN_MAX     255
typedef struct 
{
    unsigned int    data_len;                        /**< Must be set to the number of elements in data. */
    uint8_t     data[QL_SIM_DATA_LEN_MAX];       /**< Data retrieved from the card. */
}QL_SIM_CARD_FILE_DATA; 

typedef enum
{
    QL_SIM_PHONE_BOOK_STORAGE_DC,
    QL_SIM_PHONE_BOOK_STORAGE_EN,
    QL_SIM_PHONE_BOOK_STORAGE_FD,
    QL_SIM_PHONE_BOOK_STORAGE_LD,
    QL_SIM_PHONE_BOOK_STORAGE_MC,
    QL_SIM_PHONE_BOOK_STORAGE_ME,
    QL_SIM_PHONE_BOOK_STORAGE_MT,
    QL_SIM_PHONE_BOOK_STORAGE_ON,
    QL_SIM_PHONE_BOOK_STORAGE_RC,
    QL_SIM_PHONE_BOOK_STORAGE_SM,
    QL_SIM_PHONE_BOOK_STORAGE_AP,
    QL_SIM_PHONE_BOOK_STORAGE_MBDN,
    QL_SIM_PHONE_BOOK_STORAGE_MN,
    QL_SIM_PHONE_BOOK_STORAGE_SDN,
    QL_SIM_PHONE_BOOK_STORAGE_ICI,
    QL_SIM_PHONE_BOOK_STORAGE_OCI,
}QL_SIM_PHONE_BOOK_STORAGE;

#define QL_SIM_PHONE_BOOK_RECORDS_MAX_COUNT 20

typedef struct 
{ // when write, if phonenum is empty, it means to delete this item specified by index  
    int          index;  // the record index in phone book
    uint8_t      username[32];   //  username
    uint8_t      phonenum[24];   //  Phone number, it can include '+'*/
}QL_SIM_PHONE_BOOK_RECORD_INFO;


typedef struct 
{
    int record_count;  //the count of record
    QL_SIM_PHONE_BOOK_RECORD_INFO record[QL_SIM_PHONE_BOOK_RECORDS_MAX_COUNT]; // the list of record
}QL_SIM_PHONE_BOOK_RECORDS_INFO;

#if defined(QUEC_DUAL_SIM_SUPPORT) || defined(QUEC_PS_SINGLE_PHYSICAL_DUAL_SIM_SUPPORT) || defined(QUEC_DUAL_SINGLE_PS_SUPPORT)
#if defined(QUEC_DUAL_SINGLE_PS_SUPPORT)
/*****************************************************************
* Function: ql_sim_get_cur_SimId
*
* Description:
* 	get current sim ID
* 
* Parameters:
* 	
* 	
* Return:
* 	0--sim1
*	1--sim2
*
*****************************************************************/
extern int ql_sim_get_cur_SimId(void);

/*****************************************************************
* Function: ql_sim_switch_card
*
* Description:
* 	switch current sim card 
* 
* Parameters:
* 	simID--what you want to set now
* 	
* Return:
* 	0--success
*  -1--fail
*
*****************************************************************/
extern int ql_sim_switch_card(int simID);
#endif

#if defined(QUEC_DUAL_SIM_SUPPORT) || defined(QUEC_PS_SINGLE_PHYSICAL_DUAL_SIM_SUPPORT) 
/*****************************************************************
* mia.zhong @20200929
* Function: ql_sim_switch_card_ex
*
* Description:
* 	switch current sim card 
* 
* Parameters:
* 	simID--the simcard you want to set now
*   callbk--when switch sim done, will run it
* 	
* Return:
* 	0--success
*  -1--fail
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_switch_card_ex(CMSimID_ex simID, SwitchSimDoneCb cb);

//mia.zhong @20201130 新增接口获取卡信息
extern QL_SIM_ERROR_CODE ql_sim_get_simcard_info(QL_SIMCARD_INFO *pt_info, CMSimID_ex sim_id);
#endif

#endif

/*****************************************************************
* Function: ql_sim_get_imsi
*
* Description:
* 	获取 SIM 卡的 IMSI。
* 
* Parameters:
* 	imsi	  		[out] 		SIM 卡的 IMSI，字符串。  
* 	imsi_len	  	[in] 		imsi 数组的长度。
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_get_imsi(char *imsi,size_t imsi_len);


/*****************************************************************
* Function: ql_sim_get_iccid
*
* Description:
* 	获取 SIM 卡的 ICCID。
* 
* Parameters:
* 	iccid	  		[out] 		SIM 卡的 ICCID，字符串。 
* 	iccid_len	  	[in] 		iccid 数组的长度。  
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_get_iccid(char *iccid,size_t iccid_len);


/*****************************************************************
* Function: ql_sim_get_phonenumber
*
* Description:
* 	获取 SIM 卡本机号码。 
* 
* Parameters:
* 	phonenumber	  		[out] 	SIM 卡本机号码，字符串。  
* 	phonenumber_len	  	[in] 	phonenumber 数组的长度。  
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_get_phonenumber(char *phonenumber,size_t phonenumber_len);


/*****************************************************************
* Function: ql_sim_verify_pin
*
* Description:
* 	当 SIM 状态为请求 PIN/PIN2，输入 PIN/PIN2 码，进行验证。 
* 
* Parameters:
* 	pt_info	  			[in] 	PIN/PIN2 码，见 QL_SIM_VERIFY_PIN_INFO。 
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_verify_pin(QL_SIM_VERIFY_PIN_INFO       *pt_info); // [IN] PIN/PIN2


/*****************************************************************
* Function: ql_sim_change_pin
*
* Description:
* 	更改 SIM 卡的 PIN 码
* 
* Parameters:
* 	pt_info	  			[in] 	输入旧的 PIN 和新的 PIN，见 QL_SIM_CHANGE_PIN_INFO。  
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_change_pin(QL_SIM_CHANGE_PIN_INFO       *pt_info );  // [IN] PIN


/*****************************************************************
* Function: ql_sim_unblock_pin
*
* Description:
* 	当多次错误输入 PIN/PIN2 码后，SIM 卡状态为请求 PUK/PUK2 时，
*	输入 PUK/PUK2 码和新的 PIN/PIN2 码进行解锁。
* 
* Parameters: 
* 	pt_info	  			[in] 	输入 PUK/PUK2 码和新的 PIN/PIN2 码，见 QL_SIM_UNBLOCK_PIN_INFO。  
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_unblock_pin(QL_SIM_UNBLOCK_PIN_INFO       *pt_info);// [IN] input PUK/PUK2 and new PIN/PIN2


/*****************************************************************
* Function: ql_sim_enable_pin
*
* Description:
* 	启用 SIM 卡 PIN 码验证。 
* 
* Parameters: 
* 	pt_info			  	[in] 	输入 PIN 码，见 QL_SIM_VERIFY_PIN_INFO。 
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_enable_pin(QL_SIM_VERIFY_PIN_INFO       *pt_info);// [IN] PIN


/*****************************************************************
* Function: ql_sim_disable_pin
*
* Description:
* 	关闭 SIM 卡 PIN 码验证
* 
* Parameters:
* 	pt_info	  			[in] 	输入 PIN 码，见 QL_SIM_VERIFY_PIN_INFO。 
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_disable_pin(QL_SIM_VERIFY_PIN_INFO       *pt_info );  // [IN] PIN 


/*****************************************************************
* Function: ql_sim_get_card_status
*
* Description:
* 	获取 SIM 卡状态信息。
* 
* Parameters:
* 	card_status	  		[out] 	返回 SIM 卡类型信息，见 QL_SIM_STATUS 
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_get_card_status(int         *card_status);///< [OUT] sim card status info output


/*****************************************************************
* Function: ql_sim_read_phonebook_record
*
* Description:
* 	获取 SIM 卡上指定电话本中的一条或多条电话号码记录。 
* 
* Parameters:
* 	storage	  		[in] 	需要读取电话号码记录的电话本存储位置。见 QL_SIM_PHONE_BOOK_STORAGE 。 
* 	start_index	  	[in] 	需要读取电话号码记录的起始编号。start_index 为 0 表示不使用编号获取电话号码记录。  
* 	end_index	  	[in] 	需要读取电话号码记录的结束编号。  
* 	username	  	[in] 	当 start_index 为 0 时有效，电话号码中的用户名。  
* 	records	  		[out] 	返回电话号码记录列表，见 QL_SIM_PHONE_BOOK_RECORDS_INFO。  
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_read_phonebook_record
(
    QL_SIM_PHONE_BOOK_STORAGE storage, //IN the storage position of the phone book
    int start_index,
    int end_index,
    char *username,
    QL_SIM_PHONE_BOOK_RECORDS_INFO   *records  // the list of records 
);


/*****************************************************************
* Function: ql_sim_write_phonebook_record
*
* Description:
* 	获取 SIM 卡上指定电话本中的一条或多条电话号码记录。 
* 
* Parameters:
* 	storage	  		[in] 	需要读取电话号码记录的电话本存储位置。   
* 	record	  		[in] 	需要写入的电话号码记录，见 QL_SIM_PHONE_BOOK_RECORD_INFO。 
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
extern QL_SIM_ERROR_CODE ql_sim_write_phonebook_record
(
    QL_SIM_PHONE_BOOK_STORAGE storage, //IN the storage position of the phone book
    QL_SIM_PHONE_BOOK_RECORD_INFO   *record //IN  a record
);


/*****************************************************************
* Function: ql_sim_config_detect
*
* Description:
* 	配置SIM卡热插拔功能。 
* 
* Parameters:
* 	detenable	  		[in] 	是否使能SIM 检测(0--不使能,1--使能)。   
* 	insertlevel	  		[in] 	SIM卡插入时候的SIM卡脚电平(0--低电平,1--高电平) 
*   detectcallback      [in]    当检测到SIM卡检测脚有跳变,这个callback会被执行
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/
QL_SIM_ERROR_CODE ql_sim_config_hot_plug_detect(unsigned char detenable,PIN_LEVEL_E insertlevel,sim_detect_calback detectcallback);

/*****************************************************************
* Function: ql_sim1_detect_gpio_config
*
* Description:
* 	配置SIM卡热插拔功能检测引脚。 
* 
* Parameters:
* 	detect_gpio			[in] 	功能检测引脚,根据硬件型号决定对应的GPIO引脚(不是模组PIN脚号)
* Return:
* 	QL_SIM_SUCCESS				成功。
*	QL_SIM_GENERIC_FAILURE		失败。
*
*****************************************************************/

QL_SIM_ERROR_CODE ql_sim1_detect_gpio_config(unsigned int detect_gpio);

/*****************************************************************
* Function: ql_set_dual_sim_single_imei
*
* Description:
* 	To support dual sim single IMEI 
* 
* Parameters:
* 	enable	  		[in] 	0-Not support dual sim single imei; 1-Support.
*
* Return:
* 	QL_SIM_SUCCESS				Operation success.
*	QL_SIM_GENERIC_FAILURE		Operation failed.
*
* Note: This setting will be saved to nvm and will take effect after reset.
*
*****************************************************************/
QL_SIM_ERROR_CODE ql_set_dual_sim_single_imei(unsigned char enable);

/*****************************************************************
* Function: ql_sim_open_logical_channel
*
* Description:
* 	 该命令用于开启(U)SIM卡的逻辑信道(AT+CCHO)
* 
* Parameters:
* 	dfName	  		[in] 	字符串类型。UICC 中的所有可选应用程序，以1 到16 字节方式编码的DF 名称来引用。
* 	sessionId	  	[out] 	UINT16*类型。智能卡上的目标应用程序使用逻辑信道的会话ID。
*
* Return:
* 	QL_SIM_SUCCESS				Operation success.
*	QL_SIM_GENERIC_FAILURE		Operation failed.
*
*****************************************************************/
QL_SIM_ERROR_CODE ql_sim_open_logical_channel(char *dfName, UINT16* sessionId);

/*****************************************************************
* Function: ql_sim_close_logical_channel
*
* Description:
* 	 该命令使用指定的<sessionID>关闭(U)SIM卡的逻辑信道
* 
* Parameters:
* 	sessionId	  		[in] 	整型。智能卡上的目标应用程序使用逻辑信道的会话ID。
*
* Return:
* 	QL_SIM_SUCCESS				Operation success.
*	QL_SIM_GENERIC_FAILURE		Operation failed.
*
*
*****************************************************************/
QL_SIM_ERROR_CODE ql_sim_close_logical_channel(UINT16 sessionId);

/*****************************************************************
* Function: ql_sim_access_logical_channel
*
* Description:
* 	 该命令用于访问UICC逻辑信道。
* 
* Parameters:
* 	sessionId	  		[in] 	整型。会话ID。用于将APDU 命令发送到UICC 的会话的标识符。智能卡上的目标应用程序使用逻辑信道而非默认信道（信道"0"）时，必须输入该参数向UICC 发送命令。
* 	commandlength	  	[in] 	整型。在 <command> 中发送给TE的字符长度（是命令或响应实际长度的两倍）。
* 	command 	  		[in] 	十六进制字符格式。MT 传递给UICC 的命令。详情可参考3GPP TS 31.101中的 AT+CSCS。
* 	resplength	  		[out] 	UINT16*类型。在<response> 中发送给TE的字符长度（是命令或响应实际长度的两倍）。 
* 	response	  		[out] 	十六进制字符格式。UICC 给MT 传递的命令的响应。详情可参考3GPP TS 31.101中的 AT+CSCS。
* 	
* Return:
* 	QL_SIM_SUCCESS				Operation success.
*	QL_SIM_GENERIC_FAILURE		Operation failed.
*
*
*****************************************************************/
QL_SIM_ERROR_CODE ql_sim_access_logical_channel(UINT16 sessionId, UINT16 commandlength, char *command, UINT16* resplength, char *response);

#endif