| b.liu | 8583dce | 2024-04-03 13:30:08 +0800 | [diff] [blame^] | 1 | #define QSER_SIM_IMSI_LEN_MAX 16 /** Maximum length of IMSI data. */
|
| 2 | #define QSER_SIM_ICCID_LEN_MAX 20 /** Maximum length of ICCID data. */
|
| 3 |
|
| 4 |
|
| 5 | typedef enum
|
| 6 | {
|
| 7 | E_QSER_SUCCESS = 0, /**< Success. */
|
| 8 | E_QSER_ERROR_BADPARM = 4, /**< Bad parameter. */
|
| 9 | }E_QSER_ERROR_CODE_T;
|
| 10 |
|
| 11 | typedef enum
|
| 12 | {
|
| 13 | QSER_SIM_SLOT_ID_1 = 0xB01, /**< Identify card in slot 1. */
|
| 14 | QSER_SIM_SLOT_ID_2 = 0xB02, /**< Identify card in slot 2. */
|
| 15 | }QSER_SIM_SLOT_ID_TYPE_T;
|
| 16 |
|
| 17 | typedef enum
|
| 18 | {
|
| 19 | QSER_SIM_APP_TYPE_UNKNOWN = 0xB00, /**< Unknown application type */
|
| 20 | QSER_SIM_APP_TYPE_3GPP = 0xB01, /**< Identify the SIM/USIM application on the card. */
|
| 21 | QSER_SIM_APP_TYPE_3GPP2 = 0xB02, /**< Identify the RUIM/CSIM application on the card. */
|
| 22 | QSER_SIM_APP_TYPE_ISIM = 0xB03, /**< Identify the ISIM application on the card. */
|
| 23 | }QSER_SIM_APP_TYPE_T;
|
| 24 |
|
| 25 | typedef struct
|
| 26 | {
|
| 27 | QSER_SIM_SLOT_ID_TYPE_T e_slot_id; /**< Indicates the slot to be used. */
|
| 28 | QSER_SIM_APP_TYPE_T e_app; /**< Indicates the type of the application. */
|
| 29 | }QSER_SIM_APP_ID_INFO_T; /* Type */
|
| 30 |
|
| 31 | #define QSER_SIM_PIN_LEN_MAX 8+1 /** Maximum length of PIN data. */
|
| 32 |
|
| 33 | typedef enum
|
| 34 | {
|
| 35 | QSER_SIM_PIN_ID_1 = 0xB01, /**< Level 1 user verification. */
|
| 36 | QSER_SIM_PIN_ID_2 = 0xB02, /**< Level 2 user verification. */
|
| 37 | }QSER_SIM_PIN_ID_TYPE_T;
|
| 38 |
|
| 39 | typedef struct
|
| 40 | {
|
| 41 | QSER_SIM_APP_ID_INFO_T app_info; /**< Application identification information. */
|
| 42 | QSER_SIM_PIN_ID_TYPE_T pin_id; /**< PIN ID. */
|
| 43 | uint32_t pin_value_len; /**< Must be set to the number of elements in pin_value. */
|
| 44 | char pin_value[QSER_SIM_PIN_LEN_MAX]; /* Value of the PIN */
|
| 45 | }QSER_SIM_VERIFY_PIN_INFO_T;
|
| 46 |
|
| 47 | typedef struct
|
| 48 | {
|
| 49 | QSER_SIM_APP_ID_INFO_T app_info; /**< Application identification information. */
|
| 50 | QSER_SIM_PIN_ID_TYPE_T pin_id; /**< PIN ID. */
|
| 51 | uint32_t old_pin_value_len; /**< Must be set to the number of elements in old_pin_value. */
|
| 52 | char old_pin_value[QSER_SIM_PIN_LEN_MAX]; /**< Value of the old PIN as a sequence of ASCII characters. */
|
| 53 | uint32_t new_pin_value_len; /**< Must be set to the number of elements in new_pin_value. */
|
| 54 | char new_pin_value[QSER_SIM_PIN_LEN_MAX]; /**< Value of the new PIN as a sequence of ASCII characters. */
|
| 55 | }QSER_SIM_CHANGE_PIN_INFO_T;
|
| 56 |
|
| 57 | typedef struct
|
| 58 | {
|
| 59 | QSER_SIM_APP_ID_INFO_T app_info; /**< Application identification information. */
|
| 60 | QSER_SIM_PIN_ID_TYPE_T pin_id; /**< PIN ID. */
|
| 61 | uint32_t puk_value_len; /**< Must be set to the number of elements in puk_value. */
|
| 62 | char puk_value[QSER_SIM_PIN_LEN_MAX]; /**< Value of the PUK as a sequence of ASCII characters. */
|
| 63 | uint32_t new_pin_value_len; /**< Must be set to the number of elements in new_pin_value. */
|
| 64 | char new_pin_value[QSER_SIM_PIN_LEN_MAX]; /**< Value of the new PIN as a sequence of ASCII characters. */
|
| 65 | }QSER_SIM_UNBLOCK_PIN_INFO_T;
|
| 66 |
|
| 67 | /** Enables the PIN on an application. */
|
| 68 | typedef QSER_SIM_VERIFY_PIN_INFO_T QSER_SIM_ENABLE_PIN_INFO_T; //Same
|
| 69 |
|
| 70 | /** Disables the PIN of an application, */
|
| 71 | typedef QSER_SIM_VERIFY_PIN_INFO_T QSER_SIM_DISABLE_PIN_INFO_T; //Same
|
| 72 |
|
| 73 |
|
| 74 | typedef enum
|
| 75 | {
|
| 76 | QSER_SIM_PERSO_FEATURE_TYPE_UNKNOWN = 0xB00, /**< Unknown personalization feature. */
|
| 77 | QSER_SIM_PERSO_FEATURE_TYPE_3GPP_NETWORK = 0xB01, /**< Featurization based on 3GPP MCC and MNC. */
|
| 78 | QSER_SIM_PERSO_FEATURE_TYPE_3GPP_NETWORK_SUBSET = 0xB02, /**< Featurization based on 3GPP MCC, MNC, and IMSI digits 6 and 7. */
|
| 79 | QSER_SIM_PERSO_FEATURE_TYPE_3GPP_SERVICE_PROVIDER = 0xB03, /**< Featurization based on 3GPP MCC, MNC, and GID1. */
|
| 80 | QSER_SIM_PERSO_FEATURE_TYPE_3GPP_CORPORATE = 0xB04, /**< Featurization based on 3GPP MCC, MNC, GID1, and GID2. */
|
| 81 | QSER_SIM_PERSO_FEATURE_TYPE_3GPP_SIM = 0xB05, /**< Featurization based on the 3GPP IMSI. */
|
| 82 | QSER_SIM_PERSO_FEATURE_TYPE_3GPP2_NETWORK_TYPE_1 = 0xB06, /**< Featurization based on 3GPP2 MCC and MNC. */
|
| 83 | QSER_SIM_PERSO_FEATURE_TYPE_3GPP2_NETWORK_TYPE_2 = 0xB07, /**< Featurization based on 3GPP2 IRM code. */
|
| 84 | QSER_SIM_PERSO_FEATURE_TYPE_3GPP2_RUIM = 0xB08, /**< Featurization based on 3GPP2 IMSI_M. */
|
| 85 | }QSER_SIM_PERSO_FEATURE_TYPE_T;
|
| 86 |
|
| 87 | typedef enum
|
| 88 | {
|
| 89 | QSER_SIM_CARD_STATE_UNKNOWN = 0xB01, /**< Card state unknown. */
|
| 90 | QSER_SIM_CARD_STATE_ABSENT = 0xB02, /**< Card is absent. */
|
| 91 | QSER_SIM_CARD_STATE_PRESENT = 0xB03, /**< Card is present. */
|
| 92 | QSER_SIM_CARD_STATE_ERROR_UNKNOWN = 0xB04, /**< Unknown error state. */
|
| 93 | QSER_SIM_CARD_STATE_ERROR_POWER_DOWN = 0xB05, /**< Power down. */
|
| 94 | QSER_SIM_CARD_STATE_ERROR_POLL_ERROR = 0xB06, /**< Poll error. */
|
| 95 | QSER_SIM_CARD_STATE_ERROR_NO_ATR_RECEIVED = 0xB07, /**< Failed to receive an answer to reset. */
|
| 96 | QSER_SIM_CARD_STATE_ERROR_VOLT_MISMATCH = 0xB08, /**< Voltage mismatch. */
|
| 97 | QSER_SIM_CARD_STATE_ERROR_PARITY_ERROR = 0xB09, /**< Parity error. */
|
| 98 | QSER_SIM_CARD_STATE_ERROR_SIM_TECHNICAL_PROBLEMS= 0xB0A, /**< Card returned technical problems. */
|
| 99 | }QSER_SIM_CARD_STATE_TYPE_T; /**< Card state. */
|
| 100 |
|
| 101 | typedef enum
|
| 102 | {
|
| 103 | QSER_SIM_CARD_TYPE_UNKNOWN = 0xB00, /**< Unidentified card type. */
|
| 104 | QSER_SIM_CARD_TYPE_ICC = 0xB01, /**< Card of SIM or RUIM type. */
|
| 105 | QSER_SIM_CARD_TYPE_UICC = 0xB02, /**< Card of USIM or CSIM type. */
|
| 106 | }QSER_SIM_CARD_TYPE_T;
|
| 107 |
|
| 108 | typedef enum
|
| 109 | {
|
| 110 | QSER_SIM_PROV_STATE_NONE = 0xB00, /**< Nonprovisioning. */
|
| 111 | QSER_SIM_PROV_STATE_PRI = 0xB01, /**< Primary provisioning subscription. */
|
| 112 | QSER_SIM_PROV_STATE_SEC = 0xB02, /**< Secondary provisioning subscription. */
|
| 113 | }QSER_SIM_SUBSCRIPTION_TYPE_T;
|
| 114 |
|
| 115 | typedef enum
|
| 116 | {
|
| 117 | QSER_SIM_APP_STATE_UNKNOWN = 0xB00, /**< Application state unknown. */
|
| 118 | QSER_SIM_APP_STATE_DETECTED = 0xB01, /**< Detected state. */
|
| 119 | QSER_SIM_APP_STATE_PIN1_REQ = 0xB02, /**< PIN1 required. */
|
| 120 | QSER_SIM_APP_STATE_PUK1_REQ = 0xB03, /**< PUK1 required. */
|
| 121 | QSER_SIM_APP_STATE_INITALIZATING = 0xB04, /**< Initializing. */
|
| 122 | QSER_SIM_APP_STATE_PERSO_CK_REQ = 0xB05, /**< Personalization control key required. */
|
| 123 | QSER_SIM_APP_STATE_PERSO_PUK_REQ = 0xB06, /**< Personalization unblock key required. */
|
| 124 | QSER_SIM_APP_STATE_PERSO_PERMANENTLY_BLOCKED= 0xB07, /**< Personalization is permanently blocked. */
|
| 125 | QSER_SIM_APP_STATE_PIN1_PERM_BLOCKED = 0xB08, /**< PIN1 is permanently blocked. */
|
| 126 | QSER_SIM_APP_STATE_ILLEGAL = 0xB09, /**< Illegal application state. */
|
| 127 | QSER_SIM_APP_STATE_READY = 0xB0A, /**< Application ready state. @newpage */
|
| 128 | }QSER_SIM_APP_STATE_TYPE_T;
|
| 129 |
|
| 130 | typedef enum
|
| 131 | {
|
| 132 | QSER_SIM_PIN_STATE_UNKNOWN = 0xB01, /**< Unknown PIN state. */
|
| 133 | QSER_SIM_PIN_STATE_ENABLED_NOT_VERIFIED = 0xB02, /**< PIN required, but has not been verified. */
|
| 134 | QSER_SIM_PIN_STATE_ENABLED_VERIFIED = 0xB03, /**< PIN required and has been verified. */
|
| 135 | QSER_SIM_PIN_STATE_DISABLED = 0xB04, /**< PIN not required. */
|
| 136 | QSER_SIM_PIN_STATE_BLOCKED = 0xB05, /**< PIN verification has failed too many times and is blocked. Recoverable through PUK verification. */
|
| 137 | QSER_SIM_PIN_STATE_PERMANENTLY_BLOCKED = 0xB06, /**< PUK verification has failed too many times and is not recoverable. */
|
| 138 | }QSER_SIM_PIN_STATE_TYPE_T;
|
| 139 |
|
| 140 | typedef struct
|
| 141 | {
|
| 142 | QSER_SIM_SUBSCRIPTION_TYPE_T subscription; /**< Type of subscription (i.e., primary, secondary, etc.). */
|
| 143 | QSER_SIM_APP_STATE_TYPE_T app_state; /**< Current state of the application. */
|
| 144 | QSER_SIM_PERSO_FEATURE_TYPE_T perso_feature; /**< Current personalization state and feature enabled. */
|
| 145 | uint8_t perso_retries; /**< Number of personalization retries. */
|
| 146 | uint8_t perso_unblock_retries; /**< Number of personalization unblock retries. */
|
| 147 | QSER_SIM_PIN_STATE_TYPE_T pin1_state; /**< Current PIN 1 state. */
|
| 148 | uint8_t pin1_num_retries; /**< Number of PIN 1 retries. */
|
| 149 | uint8_t puk1_num_retries; /**< Number of PUK 1 retries. */
|
| 150 | QSER_SIM_PIN_STATE_TYPE_T pin2_state; /**< Current PIN 2 state. */
|
| 151 | uint8_t pin2_num_retries; /**< Number of PIN 2 retries. */
|
| 152 | uint8_t puk2_num_retries; /**< Number of PUK 2 retries. */
|
| 153 | }QSER_SIM_CARD_APP_INFO_T;
|
| 154 |
|
| 155 | typedef struct
|
| 156 | {
|
| 157 | QSER_SIM_CARD_APP_INFO_T app_3gpp; /**< Stores 3GPP application information. */
|
| 158 | QSER_SIM_CARD_APP_INFO_T app_3gpp2; /**< Stores 3GPP2 application information. */
|
| 159 | QSER_SIM_CARD_APP_INFO_T app_isim; /**< Stores ISIM application information. */
|
| 160 | }QSER_SIM_CARD_ALL_APP_INFO_T;
|
| 161 |
|
| 162 | typedef struct
|
| 163 | {
|
| 164 | QSER_SIM_CARD_STATE_TYPE_T e_card_state;/**< Current card and card error state. */
|
| 165 | QSER_SIM_CARD_TYPE_T e_card_type; /**< Card type. */
|
| 166 | QSER_SIM_CARD_ALL_APP_INFO_T card_app_info; /**< Stores all relevant application information. */
|
| 167 | }QSER_SIM_CARD_STATUS_INFO_T;
|
| 168 | typedef QSER_SIM_CARD_STATUS_INFO_T* QSER_SIM_MsgRef;
|
| 169 | /* Callback function registered to qser_sim_addrxmsghandler, msgRef contains the detail msg infor */
|
| 170 | typedef void (*QSER_SIM_RxMsgHandlerFunc_t)(QSER_SIM_MsgRef msgRef);
|
| 171 |
|