USIM Service
[Mobile Services]

Detailed Description

This service groups the USIM functions.

Data Structures

struct _AlpMblUsimCardFile

struct _AlpMblUsimList

struct _AlpMblUsimTrustedCertificates

Defines

#define ALP_MBL_USIM_NOTIFICATION_CARD_FILE_OPERATION_RESULT   ((AlpMblNotificationId) 2)

#define ALP_MBL_USIM_NOTIFICATION_FILE_CHANGE   ((AlpMblNotificationId) 3)

#define ALP_MBL_USIM_NOTIFICATION_NEW_SIM_CARD   ((AlpMblNotificationId) 5)

notification broadcasted when the inserted sim card is not the same than the previous one

#define ALP_MBL_USIM_NOTIFICATION_USIM_ID_CHANGE   ((AlpMblNotificationId) 1)

#define ALP_MBL_USIM_NOTIFICATION_USIM_STATUS_CHANGE   ((AlpMblNotificationId) 4)

#define ALP_MBL_USIM_PROVISIONING_FILE_BOOTSTRAP   ((AlpMblUsimProvisioningFileType) 1)

#define ALP_MBL_USIM_PROVISIONING_FILE_CONFIG1   ((AlpMblUsimProvisioningFileType) 2)

#define ALP_MBL_USIM_PROVISIONING_FILE_CONFIG2   ((AlpMblUsimProvisioningFileType) 3)

#define ALP_MBL_USIM_PROVISIONING_FILE_UNKNOWN   ((AlpMblUsimProvisioningFileType) 0)

> Provisioning file type

#define ALP_MBL_USIM_STATUS_CARD_INSERTED   ((AlpMblUsimStatus) 4)

the UICC is inserted after the device boot sequence

#define ALP_MBL_USIM_STATUS_CARD_POWERED_OFF   ((AlpMblUsimStatus) 2)

the UICC is powered OFF

#define ALP_MBL_USIM_STATUS_CARD_POWERED_ON   ((AlpMblUsimStatus) 1)

the UICC is powered ON

#define ALP_MBL_USIM_STATUS_CARD_REMOVED   ((AlpMblUsimStatus) 3)

the UICC is removed after the device boot sequence

#define ALP_MBL_USIM_STATUS_CARD_RESETED   ((AlpMblUsimStatus) 6)

the UICC is reseted

#define ALP_MBL_USIM_STATUS_LOCKED   ((AlpMblUsimStatus) 9)

The SIM card is locked.

#define ALP_MBL_USIM_STATUS_NAA_REINITIALIZED   ((AlpMblUsimStatus) 7)

the Network Access Application is reinitialized

#define ALP_MBL_USIM_STATUS_NO_CARD   ((AlpMblUsimStatus) 8)

There is no smart card inserted in the device during the boot sequence.

#define ALP_MBL_USIM_STATUS_READY   ((AlpMblUsimStatus) 10)

The SIM card is ready.

#define ALP_MBL_USIM_STATUS_UNKNOWN   ((AlpMblUsimStatus) 11)

The USIM status is not defined yet.

Typedefs

typedef char AlpMblISOName [2]

typedef _AlpMblUsimCardFile AlpMblUsimCardFile

typedef void(* AlpMblUsimCardFileOperationResultCallbackPtr )(void *iUserDataP, AlpMblUsimCardFile *CardFileP, alp_status_t err)

to be notified when the result from a get card file request is available (asynchronous response)

typedef char AlpMblUsimCardId [21]

card identification number (retrieved from EF ICCID at MF-level)

typedef void(* AlpMblUsimFileChangeCallbackPtr )(void *iUserDataP, AlpMblUsatRefreshFileList *ioFileListP)

to be notified when USIM files are modified during an application, so as to re-read EF's data from UICC

typedef unsigned char AlpMblUsimId

typedef void(* AlpMblUsimIdChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblUsimId iPrevious, AlpMblUsimId iCurrent)

to be notified when the USIM application is changed

typedef _AlpMblUsimList AlpMblUsimList

typedef void(* AlpMblUsimNewSimCardCallbackPtr )(void *iUserDataP, AlpMblUsimCardId iCardIdentification)

typedef char AlpMblUsimProvisioningFilePath [256]

typedef unsigned char AlpMblUsimProvisioningFileType

> path of the provisioning file image retrieved from the WAP provisioning file structure present in the smart card.

typedef unsigned char AlpMblUsimStatus

typedef void(* AlpMblUsimStatusChangeCallbackPtr )(void *iUserDataP, AlpMblUsimId iUsimId, AlpMblUsimStatus iPrevious, AlpMblUsimStatus iCurrent)

typedef _AlpMblUsimTrustedCertificates AlpMblUsimTrustedCertificates

> path of one trusted certificate retrieved from the WAP provisioning file structure present in the smart card.

typedef char AlpMblUsimTrustedCertificatesPath [256]

> type of the provisioning file (Bootstrap, Config1 or Config2, see ALP_MBL_USIM_PROVISIONING_FILE_X)

Functions

alp_status_t alp_mbl_usim_get_default_usim_id (AlpMblUsimId *oDefaultUsimIdP)

alp_status_t alp_mbl_usim_get_provisioning_file (AlpMblUsimId iUsimId, AlpMblUsimProvisioningFileType iProvisioningFileType, AlpMblUsimProvisioningFilePath *oProvisioningFilePathP)

alp_status_t alp_mbl_usim_get_usim_ids (AlpMblUsimList *oUsimListP)

alp_status_t alp_mbl_usim_perform_card_file_operation (AlpMblUsimId iUsimId, AlpMblUsimCardFile *ioCardFileP)

alp_status_t alp_mbl_usim_select_usim_id (AlpMblContextId iMobileContextId, AlpMblUsimId iUsimId)

Define Documentation

#define ALP_MBL_USIM_NOTIFICATION_CARD_FILE_OPERATION_RESULT ((AlpMblNotificationId) 2)

#define ALP_MBL_USIM_NOTIFICATION_FILE_CHANGE ((AlpMblNotificationId) 3)

#define ALP_MBL_USIM_NOTIFICATION_NEW_SIM_CARD ((AlpMblNotificationId) 5)

notification broadcasted when the inserted sim card is not the same than the previous one

#define ALP_MBL_USIM_NOTIFICATION_USIM_ID_CHANGE ((AlpMblNotificationId) 1)

#define ALP_MBL_USIM_NOTIFICATION_USIM_STATUS_CHANGE ((AlpMblNotificationId) 4)

#define ALP_MBL_USIM_PROVISIONING_FILE_BOOTSTRAP ((AlpMblUsimProvisioningFileType) 1)

#define ALP_MBL_USIM_PROVISIONING_FILE_CONFIG1 ((AlpMblUsimProvisioningFileType) 2)

#define ALP_MBL_USIM_PROVISIONING_FILE_CONFIG2 ((AlpMblUsimProvisioningFileType) 3)

#define ALP_MBL_USIM_PROVISIONING_FILE_UNKNOWN ((AlpMblUsimProvisioningFileType) 0)

> Provisioning file type

#define ALP_MBL_USIM_STATUS_CARD_INSERTED ((AlpMblUsimStatus) 4)

the UICC is inserted after the device boot sequence

#define ALP_MBL_USIM_STATUS_CARD_POWERED_OFF ((AlpMblUsimStatus) 2)

the UICC is powered OFF

#define ALP_MBL_USIM_STATUS_CARD_POWERED_ON ((AlpMblUsimStatus) 1)

the UICC is powered ON

#define ALP_MBL_USIM_STATUS_CARD_REMOVED ((AlpMblUsimStatus) 3)

the UICC is removed after the device boot sequence

#define ALP_MBL_USIM_STATUS_CARD_RESETED ((AlpMblUsimStatus) 6)

the UICC is reseted

#define ALP_MBL_USIM_STATUS_LOCKED ((AlpMblUsimStatus) 9)

The SIM card is locked.

#define ALP_MBL_USIM_STATUS_NAA_REINITIALIZED ((AlpMblUsimStatus) 7)

the Network Access Application is reinitialized

#define ALP_MBL_USIM_STATUS_NO_CARD ((AlpMblUsimStatus) 8)

There is no smart card inserted in the device during the boot sequence.

#define ALP_MBL_USIM_STATUS_READY ((AlpMblUsimStatus) 10)

The SIM card is ready.

#define ALP_MBL_USIM_STATUS_UNKNOWN ((AlpMblUsimStatus) 11)

The USIM status is not defined yet.

Typedef Documentation

typedef char AlpMblISOName[2]

typedef struct _AlpMblUsimCardFile AlpMblUsimCardFile

typedef void(* AlpMblUsimCardFileOperationResultCallbackPtr)(void *iUserDataP, AlpMblUsimCardFile *CardFileP, alp_status_t err)

to be notified when the result from a get card file request is available (asynchronous response)

typedef char AlpMblUsimCardId[21]

card identification number (retrieved from EF ICCID at MF-level)

typedef void(* AlpMblUsimFileChangeCallbackPtr)(void *iUserDataP, AlpMblUsatRefreshFileList *ioFileListP)

to be notified when USIM files are modified during an application, so as to re-read EF's data from UICC

typedef unsigned char AlpMblUsimId

typedef void(* AlpMblUsimIdChangeCallbackPtr)(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblUsimId iPrevious, AlpMblUsimId iCurrent)

to be notified when the USIM application is changed

typedef struct _AlpMblUsimList AlpMblUsimList

typedef void(* AlpMblUsimNewSimCardCallbackPtr)(void *iUserDataP, AlpMblUsimCardId iCardIdentification)

Callback prototype for ALP_MBL_USIM_NOTIFICATION_NEW_SIM_CARD notification.
Parameters:

[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

[in] iCardIdentification - Identification number of the new inserted smart card.

Returns:
Nothing.

typedef char AlpMblUsimProvisioningFilePath[256]

typedef unsigned char AlpMblUsimProvisioningFileType

> path of the provisioning file image retrieved from the WAP provisioning file structure present in the smart card.

typedef unsigned char AlpMblUsimStatus

typedef void(* AlpMblUsimStatusChangeCallbackPtr)(void *iUserDataP, AlpMblUsimId iUsimId, AlpMblUsimStatus iPrevious, AlpMblUsimStatus iCurrent)

Callback prototype for ALP_MBL_USIM_NOTIFICATION_USIM_STATUS_CHANGE notification.
Parameters:

[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

[in] iUsimId - Id of the usim that the status has changed.

[in] iPrevious - Previous status of the usim. See ALP_MBL_USIM_STATUS_XXX defines.

[in] iCurrent - New status of the usim. See ALP_MBL_USIM_STATUS_XXX defines.

Returns:
Nothing.

typedef struct _AlpMblUsimTrustedCertificates AlpMblUsimTrustedCertificates

> path of one trusted certificate retrieved from the WAP provisioning file structure present in the smart card.

typedef char AlpMblUsimTrustedCertificatesPath[256]

> type of the provisioning file (Bootstrap, Config1 or Config2, see ALP_MBL_USIM_PROVISIONING_FILE_X)

Function Documentation

alp_status_t alp_mbl_usim_get_default_usim_id ( AlpMblUsimId * oDefaultUsimIdP )

To get the default USIM application identifier.

Parameters:

[out] oDefaultUsimIdP - Usim identifier. If the card supports only one USIM application, the default usimId is equal to one. In a multiapplication environment, the default usimId is the identifier of the last active USIM.

Returns:
ALP_STATUS_OK - The default Usim identifier has been retrieved succesfully
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

alp_status_t alp_mbl_usim_get_provisioning_file ( AlpMblUsimId iUsimId,

AlpMblUsimProvisioningFileType iProvisioningFileType,

AlpMblUsimProvisioningFilePath * oProvisioningFilePathP

)

To get the path where the image of the specified provisioning file is stored.

Parameters:

[in] iUsimId - Usim identifier.

[in] iProvisioningFileType - type of the provisioning file (see ALP_MBL_USIM_PROVISIONING_FILE_X).

[out] oProvisioningFilePathP - Path of provisioning file.

Returns:
ALP_STATUS_VALUE_NOT_AVAILABLE - the provisioning file is not yet copied from the smart card, try upon the notification.
ALP_STATUS_MBL_PROVISIONING_FILE_NOT_PRESENT - the provisioning file is not present in the WAP provisioning file structure in the smart card.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

alp_status_t alp_mbl_usim_get_usim_ids ( AlpMblUsimList * oUsimListP )

Get the list of USIM application identifier if several USIMs are stored in the UICC.

Parameters:

[out] oUsimListP - Pointer to a AlpMblUsimList structure that contains the list of the USIM application identifier

Returns:
ALP_STATUS_OK - The list of USIM application identifier has been retrieved succesfully
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

alp_status_t alp_mbl_usim_perform_card_file_operation ( AlpMblUsimId iUsimId,

AlpMblUsimCardFile * ioCardFileP

)

Gets information about an Elementary File.

Parameters:

[in] iUsimId - Usim identifier.

[in,out] ioCardFileP - Pointer to a AlpMblUsimCardFile structure that identifies the Elementary File to read.

Returns:
ALP_STATUS_VALUE_NOT_AVAILABLE - As this API could take some times (especially when accessing data), the function will return ALP_STATUS_VALUE_NOT_AVAILABLE, and the information will be returned using the notification mechanism.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

alp_status_t alp_mbl_usim_select_usim_id ( AlpMblContextId iMobileContextId,

AlpMblUsimId iUsimId

)

Select the USIM application identifier.

Parameters:

[in] iMobileContextId - The id of the Mobile Context.

[in] iUsimId - Usim identifier (amongst those available on the UICC) to select and to activate.

Returns:
ALP_STATUS_OK - The USIM application has been succesfully selected and activated
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

Generated on Wed Jul 30 07:06:43 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation


Data Structures
struct	_AlpMblUsimCardFile
struct	_AlpMblUsimList
struct	_AlpMblUsimTrustedCertificates
Defines
#define	ALP_MBL_USIM_NOTIFICATION_CARD_FILE_OPERATION_RESULT ((AlpMblNotificationId) 2)
#define	ALP_MBL_USIM_NOTIFICATION_FILE_CHANGE ((AlpMblNotificationId) 3)
#define	ALP_MBL_USIM_NOTIFICATION_NEW_SIM_CARD ((AlpMblNotificationId) 5)
	notification broadcasted when the inserted sim card is not the same than the previous one
#define	ALP_MBL_USIM_NOTIFICATION_USIM_ID_CHANGE ((AlpMblNotificationId) 1)
#define	ALP_MBL_USIM_NOTIFICATION_USIM_STATUS_CHANGE ((AlpMblNotificationId) 4)
#define	ALP_MBL_USIM_PROVISIONING_FILE_BOOTSTRAP ((AlpMblUsimProvisioningFileType) 1)
#define	ALP_MBL_USIM_PROVISIONING_FILE_CONFIG1 ((AlpMblUsimProvisioningFileType) 2)
#define	ALP_MBL_USIM_PROVISIONING_FILE_CONFIG2 ((AlpMblUsimProvisioningFileType) 3)
#define	ALP_MBL_USIM_PROVISIONING_FILE_UNKNOWN ((AlpMblUsimProvisioningFileType) 0)
	> Provisioning file type
#define	ALP_MBL_USIM_STATUS_CARD_INSERTED ((AlpMblUsimStatus) 4)
	the UICC is inserted after the device boot sequence
#define	ALP_MBL_USIM_STATUS_CARD_POWERED_OFF ((AlpMblUsimStatus) 2)
	the UICC is powered OFF
#define	ALP_MBL_USIM_STATUS_CARD_POWERED_ON ((AlpMblUsimStatus) 1)
	the UICC is powered ON
#define	ALP_MBL_USIM_STATUS_CARD_REMOVED ((AlpMblUsimStatus) 3)
	the UICC is removed after the device boot sequence
#define	ALP_MBL_USIM_STATUS_CARD_RESETED ((AlpMblUsimStatus) 6)
	the UICC is reseted
#define	ALP_MBL_USIM_STATUS_LOCKED ((AlpMblUsimStatus) 9)
	The SIM card is locked.
#define	ALP_MBL_USIM_STATUS_NAA_REINITIALIZED ((AlpMblUsimStatus) 7)
	the Network Access Application is reinitialized
#define	ALP_MBL_USIM_STATUS_NO_CARD ((AlpMblUsimStatus) 8)
	There is no smart card inserted in the device during the boot sequence.
#define	ALP_MBL_USIM_STATUS_READY ((AlpMblUsimStatus) 10)
	The SIM card is ready.
#define	ALP_MBL_USIM_STATUS_UNKNOWN ((AlpMblUsimStatus) 11)
	The USIM status is not defined yet.
Typedefs
typedef char	AlpMblISOName [2]
typedef _AlpMblUsimCardFile	AlpMblUsimCardFile
typedef void(*	AlpMblUsimCardFileOperationResultCallbackPtr )(void iUserDataP, AlpMblUsimCardFile CardFileP, alp_status_t err)
	to be notified when the result from a get card file request is available (asynchronous response)
typedef char	AlpMblUsimCardId [21]
	card identification number (retrieved from EF ICCID at MF-level)
typedef void(*	AlpMblUsimFileChangeCallbackPtr )(void iUserDataP, AlpMblUsatRefreshFileList ioFileListP)
	to be notified when USIM files are modified during an application, so as to re-read EF's data from UICC
typedef unsigned char	AlpMblUsimId
typedef void(*	AlpMblUsimIdChangeCallbackPtr )(void *iUserDataP, AlpMblContextId iMobileContextId, AlpMblUsimId iPrevious, AlpMblUsimId iCurrent)
	to be notified when the USIM application is changed
typedef _AlpMblUsimList	AlpMblUsimList
typedef void(*	AlpMblUsimNewSimCardCallbackPtr )(void *iUserDataP, AlpMblUsimCardId iCardIdentification)
typedef char	AlpMblUsimProvisioningFilePath [256]
typedef unsigned char	AlpMblUsimProvisioningFileType
	> path of the provisioning file image retrieved from the WAP provisioning file structure present in the smart card.
typedef unsigned char	AlpMblUsimStatus
typedef void(*	AlpMblUsimStatusChangeCallbackPtr )(void *iUserDataP, AlpMblUsimId iUsimId, AlpMblUsimStatus iPrevious, AlpMblUsimStatus iCurrent)
typedef _AlpMblUsimTrustedCertificates	AlpMblUsimTrustedCertificates
	> path of one trusted certificate retrieved from the WAP provisioning file structure present in the smart card.
typedef char	AlpMblUsimTrustedCertificatesPath [256]
	> type of the provisioning file (Bootstrap, Config1 or Config2, see ALP_MBL_USIM_PROVISIONING_FILE_X)
Functions
alp_status_t	alp_mbl_usim_get_default_usim_id (AlpMblUsimId *oDefaultUsimIdP)
alp_status_t	alp_mbl_usim_get_provisioning_file (AlpMblUsimId iUsimId, AlpMblUsimProvisioningFileType iProvisioningFileType, AlpMblUsimProvisioningFilePath *oProvisioningFilePathP)
alp_status_t	alp_mbl_usim_get_usim_ids (AlpMblUsimList *oUsimListP)
alp_status_t	alp_mbl_usim_perform_card_file_operation (AlpMblUsimId iUsimId, AlpMblUsimCardFile *ioCardFileP)
alp_status_t	alp_mbl_usim_select_usim_id (AlpMblContextId iMobileContextId, AlpMblUsimId iUsimId)

USIM Service [Mobile Services]

Detailed Description

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation

USIM Service
[Mobile Services]