LinuxQMISDK  (NOTAG)
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
qaGobiApiUim.h
Go to the documentation of this file.
1 
9 /*
10  * Copyright: © 2012-2015 Sierra Wireless, Inc. all rights reserved
11  */
12 #ifndef __GOBI_API_UIM_H__
13 #define __GOBI_API_UIM_H__
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 #define MAX_DESCRIPTION_LENGTH 255
20 #define MAX_CONTENT_LENGTH 1024
21 #define MAX_NO_OF_APPLICATIONS 10
22 #define MAX_NO_OF_SLOTS 5
23 #define MAX_PUK_LENGTH 8
24 #define MAX_PATH_LENGTH 255
25 #define MAX_ICCID_LENGTH 255
26 #define MAX_SLOTS_STATUS 255
27 
46 
57 typedef struct
58 {
61 
79 ULONG SLQSUIMPowerDown ( UIMPowerDownReq *pUIMPowerDownReq );
80 
96 typedef struct {
100 } fileInfo;
101 
155 typedef struct
156 {
165 
268 typedef struct
269 {
285 } appStatus;
286 
338 typedef struct
339 {
347 } slotInfo;
348 
389 typedef struct
390 {
397 } cardStatus;
398 
414 typedef struct
415 {
418 } hotSwapStatus;
419 
433 typedef struct
434 {
438 
458 ULONG SLQSUIMGetCardStatus ( UIMGetCardStatusResp *pUIMGetCardStatusResp );
459 
485 typedef struct
486 {
491 
516 typedef struct
517 {
523 
549 typedef struct
550 {
556 
573 typedef struct
574 {
578 
593 typedef struct
594 {
597 } encryptedPIN1;
598 
618 typedef struct
619 {
623 } UIMPinResp;
624 
652  UIMSetPinProtectionReq *pUIMSetPinProtectionReq,
653  UIMPinResp *pUIMSetPinProtectionResp );
654 
674 typedef struct{
678 } verifyUIMPIN;
679 
708 typedef struct
709 {
716 
741 ULONG SLQSUIMVerifyPin ( UIMVerifyPinReq *pUIMVerifyPinReq,
742  UIMPinResp *pUIMVerifyPinResp );
743 
770 typedef struct{
776 } changeUIMPIN;
777 
803 typedef struct
804 {
810 
837 ULONG SLQSUIMChangePin ( UIMChangePinReq *pUIMChangePinReq,
838  UIMPinResp *pUIMChangePinResp );
839 
864 typedef struct{
870 } unblockUIMPIN;
871 
897 typedef struct
898 {
904 
930 ULONG SLQSUIMUnblockPin ( UIMUnblockPinReq *pUIMUnblockPinReq,
931  UIMPinResp *pUIMUnblockPinResp );
932 
945 typedef struct
946 {
949 
971  UIMEventRegisterReqResp *pUIMEventRegisterReqResp );
972 
985 typedef struct
986 {
990 
1010  UIMRefreshOKReq *pUIMRefreshOKReq );
1011 
1037 typedef struct
1038 {
1043 } registerRefresh;
1044 
1058 typedef struct
1059 {
1063 
1088  UIMRefreshRegisterReq *pUIMRefreshRegisterReq );
1089 
1104 typedef struct
1105 {
1109 
1110 
1129  UIMRefreshCompleteReq *pUIMRefreshCompleteReq );
1130 
1138 typedef struct
1139 {
1142 
1151 typedef struct
1152 {
1155 
1181  UIMRefreshGetLastEventReq *pUIMRefreshGetLastEventReq,
1182  UIMRefreshGetLastEventResp *pUIMRefreshGetLastEventResp );
1183 
1202 typedef struct
1203 {
1208 
1219 typedef struct
1220 {
1223 } cardResult;
1224 
1337 typedef struct
1338 {
1356 } fileAttributes;
1357 
1376 typedef struct
1377 {
1382 
1408  UIMGetFileAttributesReq *pUIMGetFileAttributesReq,
1409  UIMGetFileAttributesResp *pUIMGetFileAttributesResp );
1410 
1441 typedef struct{
1447 
1456 typedef struct
1457 {
1460 
1471 typedef struct
1472 {
1475 
1497  UIMDepersonalizationReq *pUIMDepersonilizationReq,
1498  UIMDepersonalizationResp *pUIMDepersonilizationResp );
1499 
1546 typedef struct
1547 {
1552 
1571 typedef struct
1572 {
1577 
1589 typedef struct
1590 {
1594 
1613 typedef struct
1614 {
1619 
1643 ULONG SLQSUIMAuthenticate ( UIMAuthenticateReq *pUIMAuthenticateReq,
1644  UIMAuthenticateResp *pUIMAuthenticateResp);
1655 typedef struct
1656 {
1659 } readResult;
1660 
1672 typedef struct
1673 {
1677 
1703 typedef struct
1704 {
1711 
1734 typedef struct
1735 {
1741 
1766  UIMReadTransparentReq *pUIMReadTransparentReq,
1767  UIMReadTransparentResp *pUIMReadTransparentResp );
1768 
1785 typedef struct
1786 {
1789 } UIMPowerUpReq;
1790 
1808 ULONG SLQSUIMPowerUp ( UIMPowerUpReq *pUIMPowerUpReq );
1809 
1841 typedef struct
1842 {
1848 }UIMSlotStatus;
1849 
1858 typedef struct
1859 {
1862 
1874 typedef struct
1875 {
1879 
1895 
1896 
1918 typedef struct
1919 {
1923 
1940 
1941 
1942 #ifdef __cplusplus
1943 } /* extern "C" { */
1944 #endif
1945 
1946 #endif /* __GOBI_API_UIM_H__ */
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:1738
Definition: qaGobiApiUim.h:1104
BYTE numSlot
Definition: qaGobiApiUim.h:395
hotSwapStatus * pHotSwapStatus
Definition: qaGobiApiUim.h:436
ULONG SLQSUIMReset()
BYTE pinLen
Definition: qaGobiApiUim.h:676
BYTE cardState
Definition: qaGobiApiUim.h:340
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:1204
BYTE pathLen
Definition: qaGobiApiUim.h:98
cardStatus * pCardStatus
Definition: qaGobiApiUim.h:435
readTransparentInfo readTransparent
Definition: qaGobiApiUim.h:1707
Definition: qaGobiApiUim.h:708
Definition: qaGobiApiUim.h:485
BYTE * pNumberOfPhySlot
Definition: qaGobiApiUim.h:1876
WORD numOfFiles
Definition: qaGobiApiUim.h:162
BYTE voteForInit
Definition: qaGobiApiUim.h:1040
Definition: qaGobiApiUim.h:803
BYTE registerFlag
Definition: qaGobiApiUim.h:1039
BYTE upukRetries
Definition: qaGobiApiUim.h:343
ULONG SLQSUIMDepersonalization(UIMDepersonalizationReq *pUIMDepersonilizationReq, UIMDepersonalizationResp *pUIMDepersonilizationResp)
WORD length
Definition: qaGobiApiUim.h:1675
BYTE persoUnblockRetries
Definition: qaGobiApiUim.h:275
BYTE puk1Retries
Definition: qaGobiApiUim.h:281
Definition: qaGobiApiUim.h:618
WORD indexGwSec
Definition: qaGobiApiUim.h:393
BYTE univPin
Definition: qaGobiApiUim.h:278
BYTE pin1Retries
Definition: qaGobiApiUim.h:280
Definition: qaGobiApiUim.h:1785
WORD secActivateMask
Definition: qaGobiApiUim.h:1353
Definition: qaGobiApiUim.h:1037
unsigned char BYTE
Definition: SwiDataTypes.h:28
encryptedPIN1 * pEncryptedPIN1
Definition: qaGobiApiUim.h:712
changeUIMPIN changePIN
Definition: qaGobiApiUim.h:806
Definition: qaGobiApiUim.h:573
ULONG eventMask
Definition: qaGobiApiUim.h:947
cardResult * pCardResult
Definition: qaGobiApiUim.h:1736
BYTE pin1Len
Definition: qaGobiApiUim.h:595
BYTE secRead
Definition: qaGobiApiUim.h:1344
WORD secWriteMask
Definition: qaGobiApiUim.h:1347
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:1153
Definition: qaGobiApiUim.h:1219
BYTE * pKeyReferenceID
Definition: qaGobiApiUim.h:901
BYTE secIncrease
Definition: qaGobiApiUim.h:1348
WORD offset
Definition: qaGobiApiUim.h:1674
BYTE fileType
Definition: qaGobiApiUim.h:1341
Definition: qaGobiApiUim.h:1546
BYTE feature
Definition: qaGobiApiUim.h:1442
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:710
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:1575
Definition: qaGobiApiUim.h:414
depersonalizationInformation depersonilisationInfo
Definition: qaGobiApiUim.h:1458
WORD secIncreaseMask
Definition: qaGobiApiUim.h:1349
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:1380
BYTE mode
Definition: qaGobiApiUim.h:158
WORD contentLen
Definition: qaGobiApiUim.h:1591
Definition: qaGobiApiUim.h:1874
readResult * pReadResult
Definition: qaGobiApiUim.h:1737
BYTE sw1
Definition: qaGobiApiUim.h:1221
WORD dataLen
Definition: qaGobiApiUim.h:1549
WORD secDeactivateMask
Definition: qaGobiApiUim.h:1351
BYTE secWrite
Definition: qaGobiApiUim.h:1346
ULONG uPhyCardStatus
Definition: qaGobiApiUim.h:1843
BYTE persoState
Definition: qaGobiApiUim.h:272
Definition: qaGobiApiUim.h:1613
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:1617
ULONG SLQSUIMAuthenticate(UIMAuthenticateReq *pUIMAuthenticateReq, UIMAuthenticateResp *pUIMAuthenticateResp)
BYTE pin1State
Definition: qaGobiApiUim.h:279
BYTE * pIgnoreHotSwapSwitch
Definition: qaGobiApiUim.h:1788
BYTE sw2
Definition: qaGobiApiUim.h:1222
BYTE pin2Retries
Definition: qaGobiApiUim.h:283
Definition: qaGobiApiUim.h:1672
ULONG SLQSUIMPowerUp(UIMPowerUpReq *pUIMPowerUpReq)
BYTE pinID
Definition: qaGobiApiUim.h:518
BYTE context
Definition: qaGobiApiUim.h:1548
BYTE upinState
Definition: qaGobiApiUim.h:341
BYTE pukLen
Definition: qaGobiApiUim.h:866
verifyUIMPIN verifyPIN
Definition: qaGobiApiUim.h:711
BYTE bICCIDLength
Definition: qaGobiApiUim.h:1846
BYTE * pEncryptedData
Definition: qaGobiApiUim.h:1739
BYTE slot
Definition: qaGobiApiUim.h:59
ULONG uPhySlotStatus
Definition: qaGobiApiUim.h:1844
Definition: qaGobiApiUim.h:897
BYTE persoRetries
Definition: qaGobiApiUim.h:274
ULONG SLQSUIMRefreshComplete(UIMRefreshCompleteReq *pUIMRefreshCompleteReq)
BYTE pinLen
Definition: qaGobiApiUim.h:774
Definition: qaGobiApiUim.h:1058
BYTE aidLength
Definition: qaGobiApiUim.h:488
BYTE appType
Definition: qaGobiApiUim.h:270
BYTE pinID
Definition: qaGobiApiUim.h:865
Definition: qaGobiApiUim.h:1858
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:551
setPINProtection pinProtection
Definition: qaGobiApiUim.h:552
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:902
ULONG SLQSUIMRefreshRegister(UIMRefreshRegisterReq *pUIMRefreshRegisterReq)
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:805
Definition: qaGobiApiUim.h:338
Definition: qaGobiApiUim.h:985
authenticateResult * pAuthenticateResult
Definition: qaGobiApiUim.h:1616
WORD fileID
Definition: qaGobiApiUim.h:97
BYTE verifyLeft
Definition: qaGobiApiUim.h:575
WORD recordCount
Definition: qaGobiApiUim.h:1343
BYTE hotSwapLength
Definition: qaGobiApiUim.h:416
Definition: qaGobiApiUim.h:864
BYTE unblockLeft
Definition: qaGobiApiUim.h:576
ULONG SLQSUIMSetPinProtection(UIMSetPinProtectionReq *pUIMSetPinProtectionReq, UIMPinResp *pUIMSetPinProtectionResp)
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:1705
Definition: qaGobiApiUim.h:1151
BYTE oldPINLen
Definition: qaGobiApiUim.h:772
BYTE operation
Definition: qaGobiApiUim.h:1443
BYTE secDeactivate
Definition: qaGobiApiUim.h:1350
WORD rawLen
Definition: qaGobiApiUim.h:1354
Definition: qaGobiApiUim.h:1202
Definition: qaGobiApiUim.h:1138
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:1206
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:808
BYTE * pKeyReferenceID
Definition: qaGobiApiUim.h:713
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:1708
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:1106
#define MAX_ICCID_LENGTH
Definition: qaGobiApiUim.h:25
Definition: qaGobiApiUim.h:155
Definition: qaGobiApiUim.h:1376
Definition: qaGobiApiUim.h:433
fileInfo fileIndex
Definition: qaGobiApiUim.h:1706
ULONG SLQSUIMGetSlotsStatus(UIMGetSlotsStatusResp *pResp)
BYTE sessionType
Definition: qaGobiApiUim.h:159
BYTE sessionType
Definition: qaGobiApiUim.h:487
WORD fileSize
Definition: qaGobiApiUim.h:1339
encryptedPIN1 * pEncryptedPIN1
Definition: qaGobiApiUim.h:621
ULONG SLQSUIMGetCardStatus(UIMGetCardStatusResp *pUIMGetCardStatusResp)
Definition: qaGobiApiUim.h:945
cardResult * pCardResult
Definition: qaGobiApiUim.h:1615
Definition: qaGobiApiUim.h:1337
BYTE pin2State
Definition: qaGobiApiUim.h:282
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:987
BYTE pinOperation
Definition: qaGobiApiUim.h:519
unblockUIMPIN unblockPIN
Definition: qaGobiApiUim.h:900
ULONG SLQSUIMSwitchSlot(UIMSwitchSlotReq *pReq)
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:1060
Definition: qaGobiApiUim.h:1655
Definition: qaGobiApiUim.h:1703
ULONG SLQSUIMRefreshGetLastEvent(UIMRefreshGetLastEventReq *pUIMRefreshGetLastEventReq, UIMRefreshGetLastEventResp *pUIMRefreshGetLastEventResp)
BYTE puk2Retries
Definition: qaGobiApiUim.h:284
unsigned long ULONG
Definition: SwiDataTypes.h:25
BYTE * pKeyReferenceID
Definition: qaGobiApiUim.h:807
BYTE upinRetries
Definition: qaGobiApiUim.h:342
BYTE bLogicalSlot
Definition: qaGobiApiUim.h:1845
BYTE newPINLen
Definition: qaGobiApiUim.h:868
WORD recordSize
Definition: qaGobiApiUim.h:1342
ULONG ulPhysicalSlot
Definition: qaGobiApiUim.h:1921
WORD fileID
Definition: qaGobiApiUim.h:1340
Definition: qaGobiApiUim.h:268
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:622
ULONG SLQSUIMChangePin(UIMChangePinReq *pUIMChangePinReq, UIMPinResp *pUIMChangePinResp)
Definition: qaGobiApiUim.h:1441
registerRefresh regRefresh
Definition: qaGobiApiUim.h:1061
Definition: qaGobiApiUim.h:1841
BYTE * pKeyReferenceID
Definition: qaGobiApiUim.h:553
BYTE numApp
Definition: qaGobiApiUim.h:345
WORD index1xSec
Definition: qaGobiApiUim.h:394
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:1573
ULONG SLQSUIMVerifyPin(UIMVerifyPinReq *pUIMVerifyPinReq, UIMPinResp *pUIMVerifyPinResp)
WORD numFiles
Definition: qaGobiApiUim.h:1041
WORD contentLen
Definition: qaGobiApiUim.h:1657
BYTE ckLen
Definition: qaGobiApiUim.h:1444
BYTE appState
Definition: qaGobiApiUim.h:271
BYTE secActivate
Definition: qaGobiApiUim.h:1352
WORD indexGwPri
Definition: qaGobiApiUim.h:391
#define MAX_DESCRIPTION_LENGTH
Definition: qaGobiApiUim.h:19
Definition: qaGobiApiUim.h:593
BYTE * pEncryptData
Definition: qaGobiApiUim.h:1709
#define MAX_NO_OF_SLOTS
Definition: qaGobiApiUim.h:22
Definition: qaGobiApiUim.h:1571
Definition: qaGobiApiUim.h:57
BYTE aidLength
Definition: qaGobiApiUim.h:276
BYTE OKtoRefresh
Definition: qaGobiApiUim.h:988
#define MAX_NO_OF_APPLICATIONS
Definition: qaGobiApiUim.h:21
Definition: qaGobiApiUim.h:1734
ULONG SLQSUIMUnblockPin(UIMUnblockPinReq *pUIMUnblockPinReq, UIMPinResp *pUIMUnblockPinResp)
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:714
BYTE aidLength
Definition: qaGobiApiUim.h:160
BYTE pinLength
Definition: qaGobiApiUim.h:520
Definition: qaGobiApiUim.h:389
WORD secReadMask
Definition: qaGobiApiUim.h:1345
Definition: qaGobiApiUim.h:770
Definition: qaGobiApiUim.h:1918
ULONG SLQSUIMPowerDown(UIMPowerDownReq *pUIMPowerDownReq)
BYTE slot
Definition: qaGobiApiUim.h:1787
#define MAX_CONTENT_LENGTH
Definition: qaGobiApiUim.h:20
UIMSessionInformation sessionInfo
Definition: qaGobiApiUim.h:899
BYTE errorState
Definition: qaGobiApiUim.h:344
BYTE persoFeature
Definition: qaGobiApiUim.h:273
ULONG SLQSUIMEventRegister(UIMEventRegisterReqResp *pUIMEventRegisterReqResp)
UIMRefreshEvent * pRefreshEvent
Definition: qaGobiApiUim.h:1140
Definition: qaGobiApiUim.h:1471
Definition: qaGobiApiUim.h:1456
BYTE pinID
Definition: qaGobiApiUim.h:771
BYTE pinID
Definition: qaGobiApiUim.h:675
#define MAX_PATH_LENGTH
Definition: qaGobiApiUim.h:24
BYTE bLogicalSlot
Definition: qaGobiApiUim.h:1920
#define MAX_SLOTS_STATUS
Definition: qaGobiApiUim.h:26
fileAttributes * pFileAttributes
Definition: qaGobiApiUim.h:1379
BYTE stage
Definition: qaGobiApiUim.h:157
unsigned short WORD
Definition: SwiDataTypes.h:30
remainingRetries * pRemainingRetries
Definition: qaGobiApiUim.h:620
WORD index1xPri
Definition: qaGobiApiUim.h:392
Definition: qaGobiApiUim.h:516
Definition: qaGobiApiUim.h:96
ULONG SLQSUIMGetFileAttributes(UIMGetFileAttributesReq *pUIMGetFileAttributesReq, UIMGetFileAttributesResp *pUIMGetFileAttributesResp)
UIMSlotsStatus * pUimSlotsStatus
Definition: qaGobiApiUim.h:1877
ULONG * pIndicationToken
Definition: qaGobiApiUim.h:554
authenticationData authData
Definition: qaGobiApiUim.h:1574
fileInfo fileIndex
Definition: qaGobiApiUim.h:1205
remainingRetries * pRemainingRetries
Definition: qaGobiApiUim.h:1473
Definition: qaGobiApiUim.h:1589
BYTE refreshComplete
Definition: qaGobiApiUim.h:1107
Definition: qaGobiApiUim.h:674
cardResult * pCardResult
Definition: qaGobiApiUim.h:1378
ULONG SLQSUIMRefreshOK(UIMRefreshOKReq *pUIMRefreshOKReq)
ULONG SLQSUIMReadTransparent(UIMReadTransparentReq *pUIMReadTransparentReq, UIMReadTransparentResp *pUIMReadTransparentResp)
Definition: qaGobiApiUim.h:549

Copyright (c) 2011-2015 Sierra Wireless, Inc. All rights reserved