#include "legato.h"
#include "taf_sim_common.h"

Macros
#define	IFGEN_TAF_SIMRSP_PROTOCOL_ID "bd560854534a28c278ac3577550149c1"

#define	IFGEN_TAF_SIMRSP_MSG_SIZE 2068

#define	TAF_SIMRSP_EID_LEN 32

#define	TAF_SIMRSP_EID_BYTES 33

#define	TAF_SIMRSP_MAX_PROFILE 32

#define	TAF_SIMRSP_NAME_LEN 64

#define	TAF_SIMRSP_NAME_BYTES 65

#define	TAF_SIMRSP_SPN_LEN 32

#define	TAF_SIMRSP_SMDP_LEN 1024

#define	TAF_SIMRSP_ICCID_LEN 20

#define	TAF_SIMRSP_ICCID_BYTES 21

#define	TAF_SIMRSP_NICKNAME_LEN 64

#define	TAF_SIMRSP_NICKNAME_BYTES 65

#define	TAF_SIMRSP_ACTIVATION_CODE_LEN 256

#define	TAF_SIMRSP_ACTIVATION_CODE_BYTES 257

#define	TAF_SIMRSP_CODE_LEN 256

#define	TAF_SIMRSP_CODE_BYTES 257

Typedefs
typedef struct taf_simRsp_ProfileListNode *	taf_simRsp_ProfileListNodeRef_t

typedef struct taf_simRsp_ProfileDownloadHandler *	taf_simRsp_ProfileDownloadHandlerRef_t

typedef struct taf_simRsp_ProfileUserConsentHandler *	taf_simRsp_ProfileUserConsentHandlerRef_t

typedef struct taf_simRsp_ProfileConfirmationCodeHandler *	taf_simRsp_ProfileConfirmationCodeHandlerRef_t

typedef void(*	taf_simRsp_ProfileDownloadHandlerFunc_t) (taf_sim_Id_t slotId, taf_simRsp_DownloadStatus_t downloadStatus, taf_simRsp_DownloadErrorCause_t errorCause, void *contextPtr)

typedef void(*	taf_simRsp_ProfileUserConsentHandlerFunc_t) (taf_sim_Id_t slotId, bool userConsentRequired, uint8_t mask, void *contextPtr)

typedef void(*	taf_simRsp_ProfileConfirmationCodeHandlerFunc_t) (taf_sim_Id_t slotId, const char LE_NONNULL profileName, void contextPtr)

Enumerations
enum	taf_simRsp_ProfileType_t { TAF_SIMRSP_UNKNOWN = -1, TAF_SIMRSP_REGULAR = 0, TAF_SIMRSP_EMERGENCY = 1 }

enum	taf_simRsp_IconType_t { TAF_SIMRSP_NONE = 0, TAF_SIMRSP_JPEG = 1, TAF_SIMRSP_PNG = 2 }

enum	taf_simRsp_ProfileClass_t { TAF_SIMRSP_TEST = 0, TAF_SIMRSP_PROVISIONING = 1, TAF_SIMRSP_OPERATIONAL = 2 }

enum	taf_simRsp_PolicyRuleType_t { TAF_SIMRSP_PROFILE_DISABLE_NOT_ALLOWED = 0, TAF_SIMRSP_PROFILE_DELETE_NOT_ALLOWED = 1, TAF_SIMRSP_PROFILE_DELETE_ON_DISABLE = 2 }

enum	taf_simRsp_DownloadStatus_t { TAF_SIMRSP_DOWNLOAD_ERROR = 0, TAF_SIMRSP_DOWNLOAD_INSTALLATION_COMPLETE = 1 }

enum	taf_simRsp_DownloadErrorCause_t { TAF_SIMRSP_GENERIC = 1, TAF_SIMRSP_SIM = 2, TAF_SIMRSP_NETWORK = 3, TAF_SIMRSP_MEMORY = 4, TAF_SIMRSP_UNSUPPORTED_PROFILE_CLASS = 5, TAF_SIMRSP_PPR_NOT_ALLOWED = 6, TAF_SIMRSP_END_USER_REJECTION = 7, TAF_SIMRSP_END_USER_POSTPONED = 8 }

enum	taf_simRsp_UserConsentReasonType_t { TAF_SIMRSP_USER_REJECTION = 0, TAF_SIMRSP_USER_POSTPONED = 1 }

Functions
LE_SHARED bool	ifgen_taf_simRsp_HasLocalBinding (void)

LE_SHARED void	ifgen_taf_simRsp_InitCommonData (void)

LE_SHARED void	ifgen_taf_simRsp_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)

LE_SHARED le_result_t	ifgen_taf_simRsp_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)

LE_SHARED taf_simRsp_ProfileDownloadHandlerRef_t	ifgen_taf_simRsp_AddProfileDownloadHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileDownloadHandlerFunc_t handlerPtr, void *contextPtr)

LE_SHARED void	ifgen_taf_simRsp_RemoveProfileDownloadHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileDownloadHandlerRef_t handlerRef)

LE_SHARED taf_simRsp_ProfileUserConsentHandlerRef_t	ifgen_taf_simRsp_AddProfileUserConsentHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileUserConsentHandlerFunc_t handlerPtr, void *contextPtr)

LE_SHARED void	ifgen_taf_simRsp_RemoveProfileUserConsentHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileUserConsentHandlerRef_t handlerRef)

LE_SHARED taf_simRsp_ProfileConfirmationCodeHandlerRef_t	ifgen_taf_simRsp_AddProfileConfirmationCodeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileConfirmationCodeHandlerFunc_t handlerPtr, void *contextPtr)

LE_SHARED void	ifgen_taf_simRsp_RemoveProfileConfirmationCodeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileConfirmationCodeHandlerRef_t handlerRef)

LE_SHARED le_result_t	ifgen_taf_simRsp_GetEID (le_msg_SessionRef_t _ifgen_sessionRef, taf_sim_Id_t slotId, char *eid, size_t eidSize)

LE_SHARED le_result_t	ifgen_taf_simRsp_AddProfile (le_msg_SessionRef_t _ifgen_sessionRef, taf_sim_Id_t slotId, const char LE_NONNULL activationCode, const char LE_NONNULL confirmationCode, bool userConsentSupported)

LE_SHARED le_result_t	ifgen_taf_simRsp_DeleteProfile (le_msg_SessionRef_t _ifgen_sessionRef, taf_sim_Id_t slotId, uint32_t profileId)

LE_SHARED le_result_t	ifgen_taf_simRsp_SetProfile (le_msg_SessionRef_t _ifgen_sessionRef, taf_sim_Id_t slotId, uint32_t profileId, bool enable)

LE_SHARED le_result_t	ifgen_taf_simRsp_UpdateNickName (le_msg_SessionRef_t _ifgen_sessionRef, taf_sim_Id_t slotId, uint32_t profileId, const char *LE_NONNULL nickName)

LE_SHARED le_result_t	ifgen_taf_simRsp_GetProfileList (le_msg_SessionRef_t _ifgen_sessionRef, taf_sim_Id_t slotId, taf_simRsp_ProfileListNodeRef_t profileListPtr, size_t profileListSizePtr)

LE_SHARED le_result_t	ifgen_taf_simRsp_SetServerAddress (le_msg_SessionRef_t _ifgen_sessionRef, taf_sim_Id_t slotId, const char *LE_NONNULL smdpAdress)

LE_SHARED le_result_t	ifgen_taf_simRsp_GetServerAddress (le_msg_SessionRef_t _ifgen_sessionRef, taf_sim_Id_t slotId, char smdpAdress, size_t smdpAdressSize, char smdsdress, size_t smdsdressSize)

LE_SHARED le_result_t	ifgen_taf_simRsp_ProvideUserConsent (le_msg_SessionRef_t _ifgen_sessionRef, taf_sim_Id_t slotId, bool userConsent, taf_simRsp_UserConsentReasonType_t reason)

LE_SHARED le_result_t	ifgen_taf_simRsp_ProvideConfirmationCode (le_msg_SessionRef_t _ifgen_sessionRef, taf_sim_Id_t slotId, const char *LE_NONNULL code)

LE_SHARED taf_simRsp_ProfileListNodeRef_t	ifgen_taf_simRsp_GetProfile (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t index)

LE_SHARED uint32_t	ifgen_taf_simRsp_GetProfileIndex (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileListNodeRef_t profileRef)

LE_SHARED taf_simRsp_ProfileType_t	ifgen_taf_simRsp_GetProfileType (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileListNodeRef_t profileRef)

LE_SHARED le_result_t	ifgen_taf_simRsp_GetIccid (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileListNodeRef_t profileRef, char *iccid, size_t iccidSize)

LE_SHARED bool	ifgen_taf_simRsp_GetProfileActiveStatus (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileListNodeRef_t profileRef)

LE_SHARED le_result_t	ifgen_taf_simRsp_GetNickName (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileListNodeRef_t profileRef, char *nickName, size_t nickNameSize)

LE_SHARED le_result_t	ifgen_taf_simRsp_GetName (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileListNodeRef_t profileRef, char *name, size_t nameSize)

LE_SHARED le_result_t	ifgen_taf_simRsp_GetSpn (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileListNodeRef_t profileRef, char *spn, size_t spnSize)

LE_SHARED taf_simRsp_IconType_t	ifgen_taf_simRsp_GetIconType (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileListNodeRef_t profileRef)

LE_SHARED taf_simRsp_ProfileClass_t	ifgen_taf_simRsp_GetProfileClass (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileListNodeRef_t profileRef)

LE_SHARED uint32_t	ifgen_taf_simRsp_GetMask (le_msg_SessionRef_t _ifgen_sessionRef, taf_simRsp_ProfileListNodeRef_t profileRef)

Macro Definition Documentation

◆ IFGEN_TAF_SIMRSP_PROTOCOL_ID

#define IFGEN_TAF_SIMRSP_PROTOCOL_ID "bd560854534a28c278ac3577550149c1"

◆ IFGEN_TAF_SIMRSP_MSG_SIZE

#define IFGEN_TAF_SIMRSP_MSG_SIZE 2068

◆ TAF_SIMRSP_EID_LEN

#define TAF_SIMRSP_EID_LEN 32

◆ TAF_SIMRSP_EID_BYTES

#define TAF_SIMRSP_EID_BYTES 33

◆ TAF_SIMRSP_MAX_PROFILE

#define TAF_SIMRSP_MAX_PROFILE 32

◆ TAF_SIMRSP_NAME_LEN

#define TAF_SIMRSP_NAME_LEN 64

◆ TAF_SIMRSP_NAME_BYTES

#define TAF_SIMRSP_NAME_BYTES 65

◆ TAF_SIMRSP_SPN_LEN

#define TAF_SIMRSP_SPN_LEN 32

◆ TAF_SIMRSP_SMDP_LEN

#define TAF_SIMRSP_SMDP_LEN 1024

◆ TAF_SIMRSP_ICCID_LEN

#define TAF_SIMRSP_ICCID_LEN 20

◆ TAF_SIMRSP_ICCID_BYTES

#define TAF_SIMRSP_ICCID_BYTES 21

◆ TAF_SIMRSP_NICKNAME_LEN

#define TAF_SIMRSP_NICKNAME_LEN 64

◆ TAF_SIMRSP_NICKNAME_BYTES

#define TAF_SIMRSP_NICKNAME_BYTES 65

◆ TAF_SIMRSP_ACTIVATION_CODE_LEN

#define TAF_SIMRSP_ACTIVATION_CODE_LEN 256

◆ TAF_SIMRSP_ACTIVATION_CODE_BYTES

#define TAF_SIMRSP_ACTIVATION_CODE_BYTES 257

◆ TAF_SIMRSP_CODE_LEN

#define TAF_SIMRSP_CODE_LEN 256

◆ TAF_SIMRSP_CODE_BYTES

#define TAF_SIMRSP_CODE_BYTES 257

Typedef Documentation

◆ taf_simRsp_ProfileListNodeRef_t

typedef struct taf_simRsp_ProfileListNode* taf_simRsp_ProfileListNodeRef_t

◆ taf_simRsp_ProfileDownloadHandlerRef_t

typedef struct taf_simRsp_ProfileDownloadHandler* taf_simRsp_ProfileDownloadHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_simRsp_ProfileDownload'

◆ taf_simRsp_ProfileUserConsentHandlerRef_t

typedef struct taf_simRsp_ProfileUserConsentHandler* taf_simRsp_ProfileUserConsentHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_simRsp_ProfileUserConsent'

◆ taf_simRsp_ProfileConfirmationCodeHandlerRef_t

typedef struct taf_simRsp_ProfileConfirmationCodeHandler* taf_simRsp_ProfileConfirmationCodeHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_simRsp_ProfileConfirmationCode'

◆ taf_simRsp_ProfileDownloadHandlerFunc_t

typedef void(* taf_simRsp_ProfileDownloadHandlerFunc_t) (taf_sim_Id_t slotId, taf_simRsp_DownloadStatus_t downloadStatus, taf_simRsp_DownloadErrorCause_t errorCause, void *contextPtr)

Handler for profile download.

◆ taf_simRsp_ProfileUserConsentHandlerFunc_t

typedef void(* taf_simRsp_ProfileUserConsentHandlerFunc_t) (taf_sim_Id_t slotId, bool userConsentRequired, uint8_t mask, void *contextPtr)

Handler for consent of profile management.

◆ taf_simRsp_ProfileConfirmationCodeHandlerFunc_t

typedef void(* taf_simRsp_ProfileConfirmationCodeHandlerFunc_t) (taf_sim_Id_t slotId, const char *LE_NONNULL profileName, void *contextPtr)

Handler for confirmation code of profile.

Enumeration Type Documentation

◆ taf_simRsp_ProfileType_t

enum taf_simRsp_ProfileType_t

Indicates card's profile type.

Enumerator
TAF_SIMRSP_UNKNOWN
TAF_SIMRSP_REGULAR	Regular profile.
TAF_SIMRSP_EMERGENCY	Emergency profile.

◆ taf_simRsp_IconType_t

enum taf_simRsp_IconType_t

Indicates the profile's icon type.

Enumerator
TAF_SIMRSP_NONE	No icon information.
TAF_SIMRSP_JPEG	JPEG icon.
TAF_SIMRSP_PNG	PNG icon.

◆ taf_simRsp_ProfileClass_t

enum taf_simRsp_ProfileClass_t

Indicates the profile's class.

Enumerator
TAF_SIMRSP_TEST	Test profile.
TAF_SIMRSP_PROVISIONING	Provisioning profile.
TAF_SIMRSP_OPERATIONAL	Operational profile.

◆ taf_simRsp_PolicyRuleType_t

enum taf_simRsp_PolicyRuleType_t

Defines profile policy rules (PPR). Each value represents the corresponding bit for the PprMask bitset.

Enumerator
TAF_SIMRSP_PROFILE_DISABLE_NOT_ALLOWED	Disabling the profile is not allowed.
TAF_SIMRSP_PROFILE_DELETE_NOT_ALLOWED	Deletion of the profile is not allowed.
TAF_SIMRSP_PROFILE_DELETE_ON_DISABLE	Deletion of the profile is required when it is successfully disabled.

◆ taf_simRsp_DownloadStatus_t

enum taf_simRsp_DownloadStatus_t

Indicates the profile download status.

Enumerator
TAF_SIMRSP_DOWNLOAD_ERROR	Profile download error.
TAF_SIMRSP_DOWNLOAD_INSTALLATION_COMPLETE	Profile download and installation is complete.

◆ taf_simRsp_DownloadErrorCause_t

enum taf_simRsp_DownloadErrorCause_t

Indicates the profile download error cause.

Enumerator
TAF_SIMRSP_GENERIC	Generic error.
TAF_SIMRSP_SIM	Error from the SIM card.
TAF_SIMRSP_NETWORK	Error from the network.
TAF_SIMRSP_MEMORY	Error due to no memory.
TAF_SIMRSP_UNSUPPORTED_PROFILE_CLASS	Unsupported profile class.
TAF_SIMRSP_PPR_NOT_ALLOWED	Profile policy rules not allowed.
TAF_SIMRSP_END_USER_REJECTION	End user rejection.
TAF_SIMRSP_END_USER_POSTPONED	End user postponed.

◆ taf_simRsp_UserConsentReasonType_t

enum taf_simRsp_UserConsentReasonType_t

Indicates the user consent reason type.

Enumerator
TAF_SIMRSP_USER_REJECTION	End user rejection.
TAF_SIMRSP_USER_POSTPONED	End user postponed.

Function Documentation

◆ ifgen_taf_simRsp_HasLocalBinding()

LE_SHARED bool ifgen_taf_simRsp_HasLocalBinding ( void )

Get if this client bound locally.

◆ ifgen_taf_simRsp_InitCommonData()

LE_SHARED void ifgen_taf_simRsp_InitCommonData ( void )

Init data that is common across all threads

◆ ifgen_taf_simRsp_CleanupCommonData()

LE_SHARED void ifgen_taf_simRsp_CleanupCommonData ( le_msg_SessionRef_t _ifgen_sessionRef )

Cleanup the data of a session

◆ ifgen_taf_simRsp_OpenSession()

LE_SHARED le_result_t ifgen_taf_simRsp_OpenSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		bool	isBlocking
	)

Perform common initialization and open a session

◆ ifgen_taf_simRsp_AddProfileDownloadHandler()

LE_SHARED taf_simRsp_ProfileDownloadHandlerRef_t ifgen_taf_simRsp_AddProfileDownloadHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileDownloadHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_simRsp_ProfileDownload'

Event for profile download.

Parameters

[in]	handlerPtr	Handler for profile download.
[in]	contextPtr

◆ ifgen_taf_simRsp_RemoveProfileDownloadHandler()

LE_SHARED void ifgen_taf_simRsp_RemoveProfileDownloadHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileDownloadHandlerRef_t	handlerRef
	)

Remove handler function for EVENT 'taf_simRsp_ProfileDownload'

Parameters

[in] handlerRef

◆ ifgen_taf_simRsp_AddProfileUserConsentHandler()

LE_SHARED taf_simRsp_ProfileUserConsentHandlerRef_t ifgen_taf_simRsp_AddProfileUserConsentHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileUserConsentHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_simRsp_ProfileUserConsent'

User consent of profile management.

Parameters

[in]	handlerPtr	Handler of user consent.
[in]	contextPtr

◆ ifgen_taf_simRsp_RemoveProfileUserConsentHandler()

LE_SHARED void ifgen_taf_simRsp_RemoveProfileUserConsentHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileUserConsentHandlerRef_t	handlerRef
	)

Remove handler function for EVENT 'taf_simRsp_ProfileUserConsent'

Parameters

[in] handlerRef

◆ ifgen_taf_simRsp_AddProfileConfirmationCodeHandler()

LE_SHARED taf_simRsp_ProfileConfirmationCodeHandlerRef_t ifgen_taf_simRsp_AddProfileConfirmationCodeHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileConfirmationCodeHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_simRsp_ProfileConfirmationCode'

Event for confirmation code of profile.

Parameters

[in]	handlerPtr	Handler of profile confirmation code.
[in]	contextPtr

◆ ifgen_taf_simRsp_RemoveProfileConfirmationCodeHandler()

LE_SHARED void ifgen_taf_simRsp_RemoveProfileConfirmationCodeHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileConfirmationCodeHandlerRef_t	handlerRef
	)

Remove handler function for EVENT 'taf_simRsp_ProfileConfirmationCode'

Parameters

[in] handlerRef

◆ ifgen_taf_simRsp_GetEID()

LE_SHARED le_result_t ifgen_taf_simRsp_GetEID	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_sim_Id_t	slotId,
		char *	eid,
		size_t	eidSize
	)

Request eUICC identifier (EID) for the slot.

Returns

LE_OK – Succeeded.
LE_FAULT – Failed.

Parameters

[in]	slotId	SIM slot ID.
[out]	eid	EID as output.
[in]	eidSize

◆ ifgen_taf_simRsp_AddProfile()

LE_SHARED le_result_t ifgen_taf_simRsp_AddProfile	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_sim_Id_t	slotId,
		const char *LE_NONNULL	activationCode,
		const char *LE_NONNULL	confirmationCode,
		bool	userConsentSupported
	)

Adds a new profile to the eUICC card and downloads and installs the profile on the eUICC.

Returns

LE_OK – Succeeded.
LE_FAULT – Failed.

Parameters

[in]	slotId	SIM slot ID.
[in]	activationCode	Activation code.
[in]	confirmationCode	Confirmation code.
[in]	userConsentSupported	Whether user consent is

◆ ifgen_taf_simRsp_DeleteProfile()

LE_SHARED le_result_t ifgen_taf_simRsp_DeleteProfile	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_sim_Id_t	slotId,
		uint32_t	profileId
	)

Deletes a profile from the eUICC card.

Returns

LE_OK – Succeeded.
LE_FAULT – Failed.

Parameters

[in]	slotId	SIM slot ID.
[in]	profileId	Profile ID.

◆ ifgen_taf_simRsp_SetProfile()

LE_SHARED le_result_t ifgen_taf_simRsp_SetProfile	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_sim_Id_t	slotId,
		uint32_t	profileId,
		bool	enable
	)

Enables or disables the profile which allows switching another profile on the eUICC card.

Returns

LE_OK – Succeeded.
LE_FAULT – Failed.

Parameters

[in]	slotId	SIM slot ID.
[in]	profileId	Profile ID.
[in]	enable	Enabled or not; true if enabling, false if disabling.

◆ ifgen_taf_simRsp_UpdateNickName()

LE_SHARED le_result_t ifgen_taf_simRsp_UpdateNickName	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_sim_Id_t	slotId,
		uint32_t	profileId,
		const char *LE_NONNULL	nickName
	)

Updates the profile's nick name.

Returns

LE_OK – Succeeded.
LE_FAULT – Failed.

Parameters

[in]	slotId	SIM slot ID.
[in]	profileId	Profile ID.
[in]	nickName	Nick name.

◆ ifgen_taf_simRsp_GetProfileList()

LE_SHARED le_result_t ifgen_taf_simRsp_GetProfileList	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_sim_Id_t	slotId,
		taf_simRsp_ProfileListNodeRef_t *	profileListPtr,
		size_t *	profileListSizePtr
	)

Requests a list of profiles supported by the eUICC card.

Returns

LE_OK – Succeeded.
LE_FAULT– Failed.

Parameters

[in]	slotId	SIM slot ID.
[out]	profileListPtr	Profile list as output.
[in,out]	profileListSizePtr

◆ ifgen_taf_simRsp_SetServerAddress()

LE_SHARED le_result_t ifgen_taf_simRsp_SetServerAddress	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_sim_Id_t	slotId,
		const char *LE_NONNULL	smdpAdress
	)

Sets the Subscription Manager Data Preparation (SM-DP+) address on the eUICC. If the SM-DP+ address length is zero then the existing SM-DP+ address on the eUICC is removed.

Returns

LE_OK – Succeeded.
LE_FAULT – Failed.

Parameters

[in]	slotId	SIM slot ID.
[in]	smdpAdress	SM-DP+ address.

◆ ifgen_taf_simRsp_GetServerAddress()

LE_SHARED le_result_t ifgen_taf_simRsp_GetServerAddress	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_sim_Id_t	slotId,
		char *	smdpAdress,
		size_t	smdpAdressSize,
		char *	smdsdress,
		size_t	smdsdressSize
	)

Gets the SM-DP+ address and the Subscription Manager Discovery Server (SMDS) address configured on the eUICC.

Returns

LE_OK – Succeeded.
LE_FAULT – Failed.

Parameters

[in]	slotId	SIM slot ID.
[out]	smdpAdress	SM-DP+ address.
[in]	smdpAdressSize
[out]	smdsdress	SMDS address.
[in]	smdsdressSize

◆ ifgen_taf_simRsp_ProvideUserConsent()

LE_SHARED le_result_t ifgen_taf_simRsp_ProvideUserConsent	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_sim_Id_t	slotId,
		bool	userConsent,
		taf_simRsp_UserConsentReasonType_t	reason
	)

Provides user consent required for downloading and installing a profile. This API should be called in response to a ProfileUserConsent event.

Returns

LE_OK – Succeeded.
LE_FAULT – Failed.

Parameters

[in]	slotId	SIM slot ID.
[in]	userConsent	User consent.
[in]	reason	User consent reason.

◆ ifgen_taf_simRsp_ProvideConfirmationCode()

LE_SHARED le_result_t ifgen_taf_simRsp_ProvideConfirmationCode	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_sim_Id_t	slotId,
		const char *LE_NONNULL	code
	)

Provides the confirmation code required for downloading and installing the profile. This API should be called in response to a ProfileConfirmationCode event.

Returns

LE_OK – Succeeded.
LE_FAULT – Failed.

Parameters

[in]	slotId	SIM slot ID.
[in]	code	Confirmation code.

◆ ifgen_taf_simRsp_GetProfile()

LE_SHARED taf_simRsp_ProfileListNodeRef_t ifgen_taf_simRsp_GetProfile	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		uint32_t	index
	)

Returns the opaque type (ProfileListNode) reference for a profile, specified using the profile index.

Returns

ProfileListNode type reference – Succeeded.
NULL – Failed.

Parameters

[in] index Profile index.

◆ ifgen_taf_simRsp_GetProfileIndex()

LE_SHARED uint32_t ifgen_taf_simRsp_GetProfileIndex	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileListNodeRef_t	profileRef
	)

Returns profileIndex for a profile, specified using the ProfileListNode type reference.

Returns

uint32_t type profile index.

Parameters

[in] profileRef

◆ ifgen_taf_simRsp_GetProfileType()

LE_SHARED taf_simRsp_ProfileType_t ifgen_taf_simRsp_GetProfileType	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileListNodeRef_t	profileRef
	)

Returns the profile type for a profile, specified using the ProfileListNode type reference.

Returns

ProfileType type.

Parameters

[in] profileRef

◆ ifgen_taf_simRsp_GetIccid()

LE_SHARED le_result_t ifgen_taf_simRsp_GetIccid	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileListNodeRef_t	profileRef,
		char *	iccid,
		size_t	iccidSize
	)

Gets the ICCID for a profile, specified using the ProfileListNode type reference.

Returns

LE_OK – Successful in getting ICCID.
LE_FAULT – Failure in getting the ICCID.

Parameters

[in]	profileRef
[out]	iccid
[in]	iccidSize

◆ ifgen_taf_simRsp_GetProfileActiveStatus()

LE_SHARED bool ifgen_taf_simRsp_GetProfileActiveStatus	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileListNodeRef_t	profileRef
	)

Returns whether or not the specified profile is active.

Returns

True – Profile is active.
FaLSE – Profile is inactive or not found.

Parameters

[in] profileRef

◆ ifgen_taf_simRsp_GetNickName()

LE_SHARED le_result_t ifgen_taf_simRsp_GetNickName	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileListNodeRef_t	profileRef,
		char *	nickName,
		size_t	nickNameSize
	)

Gets the nickname for the specified profile.

Returns

LE_OK – Successful.
LE_FAULT – Error occurred while getting the nickname.

Parameters

[in]	profileRef
[out]	nickName
[in]	nickNameSize

◆ ifgen_taf_simRsp_GetName()

LE_SHARED le_result_t ifgen_taf_simRsp_GetName	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileListNodeRef_t	profileRef,
		char *	name,
		size_t	nameSize
	)

Gets the name for the specified profile.

Returns

LE_OK – Successful.
LE_FAULT – Error occurred while getting the name.

Parameters

[in]	profileRef
[out]	name
[in]	nameSize

◆ ifgen_taf_simRsp_GetSpn()

LE_SHARED le_result_t ifgen_taf_simRsp_GetSpn	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileListNodeRef_t	profileRef,
		char *	spn,
		size_t	spnSize
	)

Gets the SPN for the specified profile.

Returns

LE_OK - Successful
LE_FAULT - Error occurred while getting the SPN.

Parameters

[in]	profileRef
[out]	spn
[in]	spnSize

◆ ifgen_taf_simRsp_GetIconType()

LE_SHARED taf_simRsp_IconType_t ifgen_taf_simRsp_GetIconType	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileListNodeRef_t	profileRef
	)

Gets the Icon type for the specified profile.

Returns

IconType

Parameters

[in] profileRef

◆ ifgen_taf_simRsp_GetProfileClass()

LE_SHARED taf_simRsp_ProfileClass_t ifgen_taf_simRsp_GetProfileClass	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileListNodeRef_t	profileRef
	)

Gets the ProfileClass for the specified profile.

Returns

ProfileClass

Parameters

[in] profileRef

◆ ifgen_taf_simRsp_GetMask()

LE_SHARED uint32_t ifgen_taf_simRsp_GetMask	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_simRsp_ProfileListNodeRef_t	profileRef
	)

Gets the Mask for the specified profile.

Returns

uint32 – Mask for the profile specified.

Parameters

[in] profileRef

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ IFGEN_TAF_SIMRSP_PROTOCOL_ID

◆ IFGEN_TAF_SIMRSP_MSG_SIZE

◆ TAF_SIMRSP_EID_LEN

◆ TAF_SIMRSP_EID_BYTES

◆ TAF_SIMRSP_MAX_PROFILE

◆ TAF_SIMRSP_NAME_LEN

◆ TAF_SIMRSP_NAME_BYTES

◆ TAF_SIMRSP_SPN_LEN

◆ TAF_SIMRSP_SMDP_LEN

◆ TAF_SIMRSP_ICCID_LEN

◆ TAF_SIMRSP_ICCID_BYTES

◆ TAF_SIMRSP_NICKNAME_LEN

◆ TAF_SIMRSP_NICKNAME_BYTES

◆ TAF_SIMRSP_ACTIVATION_CODE_LEN

◆ TAF_SIMRSP_ACTIVATION_CODE_BYTES

◆ TAF_SIMRSP_CODE_LEN

◆ TAF_SIMRSP_CODE_BYTES

Typedef Documentation

◆ taf_simRsp_ProfileListNodeRef_t

◆ taf_simRsp_ProfileDownloadHandlerRef_t

◆ taf_simRsp_ProfileUserConsentHandlerRef_t

◆ taf_simRsp_ProfileConfirmationCodeHandlerRef_t

◆ taf_simRsp_ProfileDownloadHandlerFunc_t

◆ taf_simRsp_ProfileUserConsentHandlerFunc_t

◆ taf_simRsp_ProfileConfirmationCodeHandlerFunc_t

Enumeration Type Documentation

◆ taf_simRsp_ProfileType_t

◆ taf_simRsp_IconType_t

◆ taf_simRsp_ProfileClass_t

◆ taf_simRsp_PolicyRuleType_t

◆ taf_simRsp_DownloadStatus_t

◆ taf_simRsp_DownloadErrorCause_t

◆ taf_simRsp_UserConsentReasonType_t

Function Documentation

◆ ifgen_taf_simRsp_HasLocalBinding()

◆ ifgen_taf_simRsp_InitCommonData()

◆ ifgen_taf_simRsp_CleanupCommonData()

◆ ifgen_taf_simRsp_OpenSession()

◆ ifgen_taf_simRsp_AddProfileDownloadHandler()

◆ ifgen_taf_simRsp_RemoveProfileDownloadHandler()

◆ ifgen_taf_simRsp_AddProfileUserConsentHandler()

◆ ifgen_taf_simRsp_RemoveProfileUserConsentHandler()

◆ ifgen_taf_simRsp_AddProfileConfirmationCodeHandler()

◆ ifgen_taf_simRsp_RemoveProfileConfirmationCodeHandler()

◆ ifgen_taf_simRsp_GetEID()

◆ ifgen_taf_simRsp_AddProfile()

◆ ifgen_taf_simRsp_DeleteProfile()

◆ ifgen_taf_simRsp_SetProfile()

◆ ifgen_taf_simRsp_UpdateNickName()

◆ ifgen_taf_simRsp_GetProfileList()

◆ ifgen_taf_simRsp_SetServerAddress()

◆ ifgen_taf_simRsp_GetServerAddress()

◆ ifgen_taf_simRsp_ProvideUserConsent()

◆ ifgen_taf_simRsp_ProvideConfirmationCode()

◆ ifgen_taf_simRsp_GetProfile()

◆ ifgen_taf_simRsp_GetProfileIndex()

◆ ifgen_taf_simRsp_GetProfileType()

◆ ifgen_taf_simRsp_GetIccid()

◆ ifgen_taf_simRsp_GetProfileActiveStatus()

◆ ifgen_taf_simRsp_GetNickName()

◆ ifgen_taf_simRsp_GetName()

◆ ifgen_taf_simRsp_GetSpn()

◆ ifgen_taf_simRsp_GetIconType()

◆ ifgen_taf_simRsp_GetProfileClass()

◆ ifgen_taf_simRsp_GetMask()