uim.h

Go to the documentation of this file.

#ifndef __LITEQMI_UIM_H__
#define __LITEQMI_UIM_H__

#ifdef __cplusplus
extern "C" {
#endif

#include "common.h"
#include <stdint.h>

#define UIM_UINT8_MAX_STRING_SZ 255
#define UIM_MAX_DESCRIPTION_LENGTH 255
#define UIM_MAX_NO_OF_SLOTS 5
#define UIM_MAX_NO_OF_APPLICATIONS 10
#define MAX_NO_OF_SLOTS        5
#define MAX_NO_OF_APPLICATIONS 10
#define MAX_DESCRIPTION_LENGTH 255
#define MAX_SLOTS_STATUS       255
#define MAX_ICCID_LENGTH       255
#define UIM_MAX_CONTENT_LENGTH 1024
#define UIM_MAX_ACTIVE_PERS_FEATURES   12


typedef struct
{
    uint8_t appType;
    uint8_t appState;
    uint8_t persoState;
    uint8_t persoFeature;
    uint8_t persoRetries;
    uint8_t persoUnblockRetries;
    uint8_t aidLength;
    uint8_t aidVal[UIM_MAX_DESCRIPTION_LENGTH];
    uint8_t univPin;
    uint8_t pin1State;
    uint8_t pin1Retries;
    uint8_t puk1Retries;
    uint8_t pin2State;
    uint8_t pin2Retries;
    uint8_t puk2Retries;
} uim_appStatus;


typedef struct
{
    uint8_t      cardState;
    uint8_t      upinState;
    uint8_t      upinRetries;
    uint8_t      upukRetries;
    uint8_t      errorState;
    uint8_t      numApp;
    uim_appStatus AppStatus[UIM_MAX_NO_OF_APPLICATIONS];
} uim_slotInfo;


typedef struct
{
    uint16_t     indexGwPri;
    uint16_t     index1xPri;
    uint16_t     indexGwSec;
    uint16_t     index1xSec;
    uint8_t     numSlot;
    uim_slotInfo SlotInfo[UIM_MAX_NO_OF_SLOTS];
} uim_cardStatus;

typedef struct
{
    uint8_t hotSwapLength;
    uint8_t hotSwap[UIM_MAX_DESCRIPTION_LENGTH];
} uim_hotSwapStatus;

typedef struct{
    uim_cardStatus *pCardStatus;
    uim_hotSwapStatus *pHotSwapStatus;
    uint16_t Tlvresult;
}unpack_uim_GetCardStatus_t;

typedef struct
{
    uint8_t pin1Len;
    uint8_t pin1Val[UIM_MAX_DESCRIPTION_LENGTH];
} uim_encryptedPIN1;

typedef struct
{
    uint8_t verifyLeft;
    uint8_t unblockLeft;
} uim_remainingRetries;

typedef struct
{
    uint8_t   sessionType;
    uint8_t   aidLength;
    uint8_t   aid[UIM_MAX_DESCRIPTION_LENGTH];
} uim_sessionInformation ;

typedef struct{
    uint8_t pinID;
    uint8_t pinLen;
    uint8_t pinVal[UIM_MAX_DESCRIPTION_LENGTH];
} uim_verifyUIMPIN;

typedef struct{
    uint8_t pinID;
    uint8_t pukLen;
    uint8_t pukVal[UIM_MAX_DESCRIPTION_LENGTH];
    uint8_t newPINLen;
    uint8_t newPINVal[UIM_MAX_DESCRIPTION_LENGTH];
} uim_unblockUIMPIN;

typedef struct
{
    uint8_t sw1;
    uint8_t sw2;
} uim_cardResult;

typedef struct
{
    uint8_t pinID;
    uint8_t pinOperation;
    uint8_t pinLength;
    uint8_t pinValue[UIM_MAX_DESCRIPTION_LENGTH];
} uim_setPINProtection;

typedef struct{
    uint8_t pinID;
    uint8_t oldPINLen;
    uint8_t oldPINVal[UIM_MAX_DESCRIPTION_LENGTH];
    uint8_t pinLen;
    uint8_t pinVal[UIM_MAX_DESCRIPTION_LENGTH];
} uim_changeUIMPIN;

typedef struct {
    uint16_t  fileID;
    uint8_t  pathLen;
    uint16_t  path[UIM_UINT8_MAX_STRING_SZ];
} uim_fileInfo;


typedef struct
{
    uint8_t   sessionType;
    uint8_t   aidLength;
    uint8_t   aid[255];
} uim_UIMSessionInformation ;

typedef struct
{
    uint16_t offset;
    uint16_t length;
} uim_readTransparentInfo;


typedef struct
{
    uint16_t contentLen;
    uint8_t content[UIM_UINT8_MAX_STRING_SZ];
} uim_readResult;


int pack_uim_GetCardStatus(
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen,
    void     *reqArg
);

int unpack_uim_GetCardStatus(
    uint8_t *pResp,
    uint16_t respLen,
    unpack_uim_GetCardStatus_t *pOutput
);

typedef struct{
    uim_encryptedPIN1    *pEncryptedPIN1;
    uint32_t *pIndicationToken;
    uint8_t *pKeyReferenceID;
    uim_sessionInformation sessionInfo;
    uim_verifyUIMPIN      verifyPIN;
    uint16_t Tlvresult;
}pack_uim_VerifyPin_t;

typedef struct{
    uim_remainingRetries *pRemainingRetries;
    uim_encryptedPIN1    *pEncryptedPIN1;
    uint32_t *pIndicationToken;
    uint16_t Tlvresult;
}unpack_uim_VerifyPin_t;


int pack_uim_VerifyPin(
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen,
    pack_uim_VerifyPin_t *reqArg
);

int unpack_uim_VerifyPin(
    uint8_t *pResp,
    uint16_t respLen,
    unpack_uim_VerifyPin_t *pOutput
);

typedef struct{
    uim_encryptedPIN1    EncryptedPIN1;
    uint32_t *pIndicationToken;
    uint8_t *pKeyReferenceID;
    uim_sessionInformation sessionInfo;
    uim_unblockUIMPIN pinProtection;
    uint16_t Tlvresult;
}pack_uim_UnblockPin_t;

typedef struct{
    uim_remainingRetries *pRemainingRetries;
    uim_encryptedPIN1    *pEncryptedPIN1;
    uint32_t *pIndicationToken;
    uint16_t Tlvresult;
}unpack_uim_UnblockPin_t;


int pack_uim_UnblockPin(
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen,
    pack_uim_UnblockPin_t *reqArg
);

int unpack_uim_UnblockPin(
    uint8_t *pResp,
    uint16_t respLen,
    unpack_uim_UnblockPin_t *pOutput
);

typedef struct{
    uim_encryptedPIN1    EncryptedPIN1;
    uint32_t *pIndicationToken;
    uint8_t *pKeyReferenceID;
    uim_sessionInformation sessionInfo;
    uim_setPINProtection      pinProtection;
    uint16_t Tlvresult;
}pack_uim_SetPinProtection_t;

typedef struct{
    uim_remainingRetries *pRemainingRetries;
    uim_encryptedPIN1    *pEncryptedPIN1;
    uint32_t *pIndicationToken;
    uint16_t Tlvresult;
}unpack_uim_SetPinProtection_t;


int pack_uim_SetPinProtection(
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen,
    pack_uim_SetPinProtection_t *reqArg
);

int unpack_uim_SetPinProtection(
    uint8_t *pResp,
    uint16_t respLen,
    unpack_uim_SetPinProtection_t *pOutput
);

typedef struct{
    uim_encryptedPIN1    EncryptedPIN1;
    uint32_t *pIndicationToken;
    uint8_t *pKeyReferenceID;
    uim_sessionInformation sessionInfo;
    uim_changeUIMPIN      changePIN;
    uint16_t Tlvresult;
}pack_uim_ChangePin_t;

typedef struct{
    uim_remainingRetries *pRemainingRetries;
    uim_encryptedPIN1    *pEncryptedPIN1;
    uint32_t *pIndicationToken;
    uint16_t Tlvresult;
}unpack_uim_ChangePin_t;


int pack_uim_ChangePin(
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen,
    pack_uim_ChangePin_t *reqArg
);

int unpack_uim_ChangePin(
    uint8_t *pResp,
    uint16_t respLen,
    unpack_uim_ChangePin_t *pOutput
);


typedef struct{
    uim_sessionInformation sessionInfo;
    uim_fileInfo              fileIndex;
    uim_readTransparentInfo   readTransparent;
    uint32_t                 *pIndicationToken;
    uint8_t                  *pEncryptData;
    uint16_t Tlvresult;
}pack_uim_ReadTransparent_t;

typedef struct{
    uim_cardResult  *pCardResult;
    uim_readResult  *pReadResult;
    uint32_t        *pIndicationToken;
    uint8_t         *pEncryptedData;
    uint16_t Tlvresult;
}unpack_uim_ReadTransparent_t;


int pack_uim_ReadTransparent(
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen,
    pack_uim_ReadTransparent_t *reqArg
);

int unpack_uim_ReadTransparent(
    uint8_t *pResp,
    uint16_t respLen,
    unpack_uim_ReadTransparent_t *pOutput
);

typedef struct{
    uint32_t eventMask;
}pack_uim_SLQSUIMEventRegister_t;

int pack_uim_SLQSUIMEventRegister (
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen,
    pack_uim_SLQSUIMEventRegister_t *reqArg
);

typedef struct{
    uint32_t eventMask;
}unpack_uim_SLQSUIMEventRegister_t;

int unpack_uim_SLQSUIMEventRegister(
    uint8_t *pResp,
    uint16_t respLen,
    unpack_uim_SLQSUIMEventRegister_t *pOutput
);

typedef struct
{
    uint8_t appType;
    uint8_t appState;
    uint8_t persoState;
    uint8_t persoFeature;
    uint8_t persoRetries;
    uint8_t persoUnblockRetries;
    uint8_t aidLength;
    uint8_t aidVal[MAX_DESCRIPTION_LENGTH];
    uint8_t univPin;
    uint8_t pin1State;
    uint8_t pin1Retries;
    uint8_t puk1Retries;
    uint8_t pin2State;
    uint8_t pin2Retries;
    uint8_t puk2Retries;
} appStats;

typedef struct
{
    uint8_t      cardState;
    uint8_t      upinState;
    uint8_t      upinRetries;
    uint8_t      upukRetries;
    uint8_t      errorState;
    uint8_t      numApp;
    appStats    AppStatus[MAX_NO_OF_APPLICATIONS];
} slotInf;
typedef struct{
    uim_cardStatus *pCardStatus;
}unpack_uim_SLQSUIMSetStatusChangeCallBack_ind_t;

int unpack_uim_SLQSUIMSetStatusChangeCallBack_ind(
    uint8_t *pResp,
    uint16_t respLen,
    unpack_uim_SLQSUIMSetStatusChangeCallBack_ind_t *pOutput
);

int pack_uim_SLQSUIMGetSlotsStatus (
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen
);

typedef struct
{
    uint32_t   uPhyCardStatus;
    uint32_t   uPhySlotStatus;
    uint8_t    bLogicalSlot;
    uint8_t    bICCIDLength;
    uint8_t    bICCID[MAX_ICCID_LENGTH];
}slot_t;

typedef struct
{
    slot_t uimSlotStatus[MAX_SLOTS_STATUS];
}slots_t;

typedef struct{
    uint8_t    *pNumberOfPhySlot;
    slots_t    *pUimSlotsStatus;
}unpack_uim_SLQSUIMGetSlotsStatus_t;

int unpack_uim_SLQSUIMGetSlotsStatus(
    uint8_t *pResp,
    uint16_t respLen,
    unpack_uim_SLQSUIMGetSlotsStatus_t *pOutput
);

typedef struct{
    uint8_t bLogicalSlot;
    uint32_t ulPhysicalSlot;
}pack_uim_SLQSUIMSwitchSlot_t;

int pack_uim_SLQSUIMSwitchSlot (
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen,
    pack_uim_SLQSUIMSwitchSlot_t *reqArg
);

int unpack_uim_SLQSUIMSwitchSlot(
    uint8_t *pResp,
    uint16_t respLen
);

typedef struct{
    slots_t slotsstatusChange;
    uint8_t bNumberOfPhySlots;
}unpack_uim_SetUimSlotStatusChangeCallback_ind_t;

int unpack_uim_SetUimSlotStatusChangeCallback_ind(
    uint8_t *pResp,
    uint16_t respLen,
    unpack_uim_SetUimSlotStatusChangeCallback_ind_t *pOutput
);

typedef struct{
    uint8_t slot;
    uint8_t *pIgnoreHotSwapSwitch;
}pack_uim_SLQSUIMPowerUp_t;

int pack_uim_SLQSUIMPowerUp (
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen,
    pack_uim_SLQSUIMPowerUp_t *reqArg
);

int unpack_uim_SLQSUIMPowerUp(
    uint8_t *pResp,
    uint16_t respLen
);

typedef struct{
    uint8_t slot;
}pack_uim_SLQSUIMPowerDown_t;

int pack_uim_SLQSUIMPowerDown (
    pack_qmi_t  *pCtx,
    uint8_t *pReqBuf,
    uint16_t *pLen,
    pack_uim_SLQSUIMPowerDown_t *reqArg
);

int unpack_uim_SLQSUIMPowerDown(
    uint8_t *pResp,
    uint16_t respLen
);

int pack_uim_SLQSUIMReset(
    pack_qmi_t  *pCtx,
    uint8_t     *pReqBuf,
    uint16_t    *pLen
);

int unpack_uim_SLQSUIMReset(
    uint8_t  *pResp,
    uint16_t respLen
);

typedef struct
{
    uim_sessionInformation sessionInfo;
    uint8_t                OKtoRefresh;
} pack_uim_SLQSUIMRefreshOK_t;

int pack_uim_SLQSUIMRefreshOK (
    pack_qmi_t  *pCtx,
    uint8_t     *pReqBuf,
    uint16_t    *pLen,
    pack_uim_SLQSUIMRefreshOK_t *reqArg
);

int unpack_uim_SLQSUIMRefreshOK(
    uint8_t  *pResp,
    uint16_t respLen
);

typedef struct
{
    uint8_t     registerFlag;
    uint8_t     voteForInit;
    uint16_t    numFiles;
    uim_fileInfo arrfileInfo[MAX_DESCRIPTION_LENGTH];
} uim_registerRefresh;

typedef struct
{
    uim_sessionInformation sessionInfo;
    uim_registerRefresh    regRefresh;
} pack_uim_SLQSUIMRefreshRegister_t;

int pack_uim_SLQSUIMRefreshRegister(
    pack_qmi_t  *pCtx,
    uint8_t     *pReqBuf,
    uint16_t    *pLen,
    pack_uim_SLQSUIMRefreshRegister_t *reqArg
);

int unpack_uim_SLQSUIMRefreshRegister(
    uint8_t  *pResp,
    uint16_t respLen
);

typedef struct
{
    uim_sessionInformation  sessionInfo;
    uint8_t                 refreshComplete;
} pack_uim_SLQSUIMRefreshComplete_t;

int pack_uim_SLQSUIMRefreshComplete(
    pack_qmi_t  *pCtx,
    uint8_t     *pReqBuf,
    uint16_t    *pLen,
    pack_uim_SLQSUIMRefreshComplete_t *reqArg
);

int unpack_uim_SLQSUIMRefreshComplete(
    uint8_t  *pResp,
    uint16_t respLen
);

typedef struct
{
    uint8_t      stage;
    uint8_t      mode;
    uint8_t      sessionType;
    uint8_t      aidLength;
    uint8_t      aid[MAX_DESCRIPTION_LENGTH];
    uint16_t     numOfFiles;
    uim_fileInfo arrfileInfo[MAX_DESCRIPTION_LENGTH];
} uim_refreshevent;

typedef struct
{
    uim_sessionInformation sessionInfo;
} pack_uim_SLQSUIMRefreshGetLastEvent_t;

typedef struct
{
    uim_refreshevent *pRefreshEvent;
} unpack_uim_SLQSUIMRefreshGetLastEvent_t;

int pack_uim_SLQSUIMRefreshGetLastEvent(
    pack_qmi_t  *pCtx,
    uint8_t     *pReqBuf,
    uint16_t    *pLen,
    pack_uim_SLQSUIMRefreshGetLastEvent_t *reqArg
);

int unpack_uim_SLQSUIMRefreshGetLastEvent(
    uint8_t  *pResp,
    uint16_t respLen,
    unpack_uim_SLQSUIMRefreshGetLastEvent_t *pOutput
);

typedef struct
{
    uim_sessionInformation sessionInfo;
    uim_fileInfo           fileIndex;
    uint32_t               *pIndicationToken;
} pack_uim_SLQSUIMGetFileAttributes_t;

typedef struct
{
    uint16_t  fileSize;
    uint16_t  fileID;
    uint8_t   fileType;
    uint16_t  recordSize;
    uint16_t  recordCount;
    uint8_t   secRead;
    uint16_t  secReadMask;
    uint8_t   secWrite;
    uint16_t  secWriteMask;
    uint8_t   secIncrease;
    uint16_t  secIncreaseMask;
    uint8_t   secDeactivate;
    uint16_t  secDeactivateMask;
    uint8_t   secActivate;
    uint16_t  secActivateMask;
    uint16_t  rawLen;
    uint8_t   rawValue[MAX_DESCRIPTION_LENGTH];
} uim_fileAttributes;

typedef struct
{
    uim_cardResult     *pCardResult;
    uim_fileAttributes *pFileAttributes;
    uint32_t           *pIndicationToken;
} unpack_uim_SLQSUIMGetFileAttributes_t;

int pack_uim_SLQSUIMGetFileAttributes(
    pack_qmi_t  *pCtx,
    uint8_t     *pReqBuf,
    uint16_t    *pLen,
    pack_uim_SLQSUIMGetFileAttributes_t *reqArg
);

int unpack_uim_SLQSUIMGetFileAttributes(
    uint8_t  *pResp,
    uint16_t respLen,
    unpack_uim_SLQSUIMGetFileAttributes_t *pOutput
);

typedef struct{
    uint8_t  feature;
    uint8_t  operation;
    uint8_t  ckLen;
    uint8_t  ckVal[MAX_DESCRIPTION_LENGTH];
} uim_depersonalizationInformation;

typedef struct
{
    uim_depersonalizationInformation depersonilisationInfo;
} pack_uim_SLQSUIMDepersonalization_t;

typedef struct
{
    uim_remainingRetries *pRemainingRetries;
} unpack_uim_SLQSUIMDepersonalization_t;

int pack_uim_SLQSUIMDepersonalization(
    pack_qmi_t  *pCtx,
    uint8_t     *pReqBuf,
    uint16_t    *pLen,
    pack_uim_SLQSUIMDepersonalization_t *reqArg
);

int unpack_uim_SLQSUIMDepersonalization(
    uint8_t  *pResp,
    uint16_t respLen,
    unpack_uim_SLQSUIMDepersonalization_t *pOutput
);

typedef struct
{
    uint8_t  context;
    uint16_t dataLen;
    uint8_t  data[UIM_MAX_CONTENT_LENGTH];
} uim_authenticationData;

typedef struct
{
    uim_sessionInformation sessionInfo;
    uim_authenticationData authData;
    uint32_t               *pIndicationToken;
} pack_uim_SLQSUIMAuthenticate_t;

typedef struct
{
    uint16_t contentLen;
    uint8_t  content[UIM_MAX_CONTENT_LENGTH];
} uim_authenticateResult;

typedef struct
{
    uim_cardResult            *pCardResult;
    uim_authenticateResult    *pAuthenticateResult;
    uint32_t                  *pIndicationToken;
} unpack_uim_SLQSUIMAuthenticate_t;

int pack_uim_SLQSUIMAuthenticate(
    pack_qmi_t  *pCtx,
    uint8_t     *pReqBuf,
    uint16_t    *pLen,
    pack_uim_SLQSUIMAuthenticate_t *reqArg
);

int unpack_uim_SLQSUIMAuthenticate(
    uint8_t  *pResp,
    uint16_t respLen,
    unpack_uim_SLQSUIMAuthenticate_t *pOutput
);

typedef struct
{
    uint8_t numFeatures;
    uint8_t feature[UIM_MAX_ACTIVE_PERS_FEATURES];
    uint8_t verifyLeft[UIM_MAX_ACTIVE_PERS_FEATURES];
    uint8_t unblockLeft[UIM_MAX_ACTIVE_PERS_FEATURES];
} uim_personalizationStatus;

typedef struct
{
    uint32_t *pConfigurationMask;
} pack_uim_SLQSUIMGetConfiguration_t;

typedef struct
{
    uint8_t                   *pAutoSelection;
    uim_personalizationStatus *pPersonalizationStatus;
    uint8_t                   *pHaltSubscription;
} unpack_uim_SLQSUIMGetConfiguration_t;

int pack_uim_SLQSUIMGetConfiguration(
    pack_qmi_t  *pCtx,
    uint8_t     *pReqBuf,
    uint16_t    *pLen,
    pack_uim_SLQSUIMGetConfiguration_t *reqArg
);

int unpack_uim_SLQSUIMGetConfiguration(
    uint8_t  *pResp,
    uint16_t respLen,
    unpack_uim_SLQSUIMGetConfiguration_t *pOutput
);

typedef struct
{
    uint8_t          TlvPresent;
    uim_refreshevent refreshEvent;
} unpack_uim_SLQSUIMRefreshCallback_Ind_t;

int unpack_uim_SLQSUIMRefreshCallback_Ind(
    uint8_t  *pResp,
    uint16_t respLen,
    unpack_uim_SLQSUIMRefreshCallback_Ind_t *pOutput
);


#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif