#include "legato.h"
#include "taf_sim_server.h"
#include "taf_simRsp_common.h"

Functions
le_msg_ServiceRef_t	taf_simRsp_GetServiceRef (void)

le_msg_SessionRef_t	taf_simRsp_GetClientSessionRef (void)

void	taf_simRsp_AdvertiseService (void)

taf_simRsp_ProfileDownloadHandlerRef_t	taf_simRsp_AddProfileDownloadHandler (taf_simRsp_ProfileDownloadHandlerFunc_t handlerPtr, void *contextPtr)

void	taf_simRsp_RemoveProfileDownloadHandler (taf_simRsp_ProfileDownloadHandlerRef_t handlerRef)

taf_simRsp_ProfileUserConsentHandlerRef_t	taf_simRsp_AddProfileUserConsentHandler (taf_simRsp_ProfileUserConsentHandlerFunc_t handlerPtr, void *contextPtr)

void	taf_simRsp_RemoveProfileUserConsentHandler (taf_simRsp_ProfileUserConsentHandlerRef_t handlerRef)

taf_simRsp_ProfileConfirmationCodeHandlerRef_t	taf_simRsp_AddProfileConfirmationCodeHandler (taf_simRsp_ProfileConfirmationCodeHandlerFunc_t handlerPtr, void *contextPtr)

void	taf_simRsp_RemoveProfileConfirmationCodeHandler (taf_simRsp_ProfileConfirmationCodeHandlerRef_t handlerRef)

le_result_t	taf_simRsp_GetEID (taf_sim_Id_t slotId, char *eid, size_t eidSize)

le_result_t	taf_simRsp_AddProfile (taf_sim_Id_t slotId, const char LE_NONNULL activationCode, const char LE_NONNULL confirmationCode, bool userConsentSupported)

le_result_t	taf_simRsp_DeleteProfile (taf_sim_Id_t slotId, uint32_t profileId)

le_result_t	taf_simRsp_SetProfile (taf_sim_Id_t slotId, uint32_t profileId, bool enable)

le_result_t	taf_simRsp_UpdateNickName (taf_sim_Id_t slotId, uint32_t profileId, const char *LE_NONNULL nickName)

le_result_t	taf_simRsp_GetProfileList (taf_sim_Id_t slotId, taf_simRsp_ProfileListNodeRef_t profileListPtr, size_t profileListSizePtr)

le_result_t	taf_simRsp_SetServerAddress (taf_sim_Id_t slotId, const char *LE_NONNULL smdpAdress)

le_result_t	taf_simRsp_GetServerAddress (taf_sim_Id_t slotId, char smdpAdress, size_t smdpAdressSize, char smdsdress, size_t smdsdressSize)

le_result_t	taf_simRsp_ProvideUserConsent (taf_sim_Id_t slotId, bool userConsent, taf_simRsp_UserConsentReasonType_t reason)

le_result_t	taf_simRsp_ProvideConfirmationCode (taf_sim_Id_t slotId, const char *LE_NONNULL code)

taf_simRsp_ProfileListNodeRef_t	taf_simRsp_GetProfile (uint32_t index)

uint32_t	taf_simRsp_GetProfileIndex (taf_simRsp_ProfileListNodeRef_t profileRef)

taf_simRsp_ProfileType_t	taf_simRsp_GetProfileType (taf_simRsp_ProfileListNodeRef_t profileRef)

le_result_t	taf_simRsp_GetIccid (taf_simRsp_ProfileListNodeRef_t profileRef, char *iccid, size_t iccidSize)

bool	taf_simRsp_GetProfileActiveStatus (taf_simRsp_ProfileListNodeRef_t profileRef)

le_result_t	taf_simRsp_GetNickName (taf_simRsp_ProfileListNodeRef_t profileRef, char *nickName, size_t nickNameSize)

le_result_t	taf_simRsp_GetName (taf_simRsp_ProfileListNodeRef_t profileRef, char *name, size_t nameSize)

le_result_t	taf_simRsp_GetSpn (taf_simRsp_ProfileListNodeRef_t profileRef, char *spn, size_t spnSize)

taf_simRsp_IconType_t	taf_simRsp_GetIconType (taf_simRsp_ProfileListNodeRef_t profileRef)

taf_simRsp_ProfileClass_t	taf_simRsp_GetProfileClass (taf_simRsp_ProfileListNodeRef_t profileRef)

uint32_t	taf_simRsp_GetMask (taf_simRsp_ProfileListNodeRef_t profileRef)

Function Documentation

◆ taf_simRsp_GetServiceRef()

le_msg_ServiceRef_t taf_simRsp_GetServiceRef ( void )

Get the server service reference

◆ taf_simRsp_GetClientSessionRef()

le_msg_SessionRef_t taf_simRsp_GetClientSessionRef ( void )

Get the client session reference for the current message

◆ taf_simRsp_AdvertiseService()

void taf_simRsp_AdvertiseService ( void )

Initialize the server and advertise the service.

◆ taf_simRsp_AddProfileDownloadHandler()

taf_simRsp_ProfileDownloadHandlerRef_t taf_simRsp_AddProfileDownloadHandler	(	taf_simRsp_ProfileDownloadHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Indicates card's profile type. Indicates the profile's icon type. Indicates the profile's class. Defines profile policy rules (PPR). Each value represents the corresponding bit for the PprMask bitset. Indicates the profile download status. Indicates the profile download error cause. Indicates the user consent reason type. Handler for profile download. Reference type used by Add/Remove functions for EVENT 'taf_simRsp_ProfileDownload' Handler for consent of profile management. Reference type used by Add/Remove functions for EVENT 'taf_simRsp_ProfileUserConsent' Handler for confirmation code of profile. Reference type used by Add/Remove functions for EVENT 'taf_simRsp_ProfileConfirmationCode' Add handler function for EVENT 'taf_simRsp_ProfileDownload'

Event for profile download.

Add handler function for EVENT 'taf_simRsp_ProfileDownload'

Event for profile download.

Parameters

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

◆ taf_simRsp_RemoveProfileDownloadHandler()

void taf_simRsp_RemoveProfileDownloadHandler ( taf_simRsp_ProfileDownloadHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_simRsp_ProfileDownload'

Parameters

[in] handlerRef

◆ taf_simRsp_AddProfileUserConsentHandler()

taf_simRsp_ProfileUserConsentHandlerRef_t taf_simRsp_AddProfileUserConsentHandler	(	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

◆ taf_simRsp_RemoveProfileUserConsentHandler()

void taf_simRsp_RemoveProfileUserConsentHandler ( taf_simRsp_ProfileUserConsentHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_simRsp_ProfileUserConsent'

Parameters

[in] handlerRef

◆ taf_simRsp_AddProfileConfirmationCodeHandler()

taf_simRsp_ProfileConfirmationCodeHandlerRef_t taf_simRsp_AddProfileConfirmationCodeHandler	(	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

◆ taf_simRsp_RemoveProfileConfirmationCodeHandler()

void taf_simRsp_RemoveProfileConfirmationCodeHandler ( taf_simRsp_ProfileConfirmationCodeHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_simRsp_ProfileConfirmationCode'

Parameters

[in] handlerRef

◆ taf_simRsp_GetEID()

le_result_t taf_simRsp_GetEID	(	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

◆ taf_simRsp_AddProfile()

le_result_t taf_simRsp_AddProfile	(	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

◆ taf_simRsp_DeleteProfile()

le_result_t taf_simRsp_DeleteProfile	(	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.

◆ taf_simRsp_SetProfile()

le_result_t taf_simRsp_SetProfile	(	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.

◆ taf_simRsp_UpdateNickName()

le_result_t taf_simRsp_UpdateNickName	(	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.

◆ taf_simRsp_GetProfileList()

le_result_t taf_simRsp_GetProfileList	(	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

◆ taf_simRsp_SetServerAddress()

le_result_t taf_simRsp_SetServerAddress	(	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.

◆ taf_simRsp_GetServerAddress()

le_result_t taf_simRsp_GetServerAddress	(	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

◆ taf_simRsp_ProvideUserConsent()

le_result_t taf_simRsp_ProvideUserConsent	(	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.

◆ taf_simRsp_ProvideConfirmationCode()

le_result_t taf_simRsp_ProvideConfirmationCode	(	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.

◆ taf_simRsp_GetProfile()

taf_simRsp_ProfileListNodeRef_t taf_simRsp_GetProfile ( 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.

◆ taf_simRsp_GetProfileIndex()

uint32_t taf_simRsp_GetProfileIndex ( 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

◆ taf_simRsp_GetProfileType()

taf_simRsp_ProfileType_t taf_simRsp_GetProfileType ( taf_simRsp_ProfileListNodeRef_t profileRef )

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

Returns

ProfileType type.

Parameters

[in] profileRef

◆ taf_simRsp_GetIccid()

le_result_t taf_simRsp_GetIccid	(	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

◆ taf_simRsp_GetProfileActiveStatus()

bool taf_simRsp_GetProfileActiveStatus ( 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

◆ taf_simRsp_GetNickName()

le_result_t taf_simRsp_GetNickName	(	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

◆ taf_simRsp_GetName()

le_result_t taf_simRsp_GetName	(	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

◆ taf_simRsp_GetSpn()

le_result_t taf_simRsp_GetSpn	(	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

◆ taf_simRsp_GetIconType()

taf_simRsp_IconType_t taf_simRsp_GetIconType ( taf_simRsp_ProfileListNodeRef_t profileRef )

Gets the Icon type for the specified profile.

Returns

IconType

Parameters

[in] profileRef

◆ taf_simRsp_GetProfileClass()

taf_simRsp_ProfileClass_t taf_simRsp_GetProfileClass ( taf_simRsp_ProfileListNodeRef_t profileRef )

Gets the ProfileClass for the specified profile.

Returns

ProfileClass

Parameters

[in] profileRef

◆ taf_simRsp_GetMask()

uint32_t taf_simRsp_GetMask ( taf_simRsp_ProfileListNodeRef_t profileRef )

Gets the Mask for the specified profile.

Returns

uint32 – Mask for the profile specified.

Parameters

[in] profileRef

Functions

Function Documentation

◆ taf_simRsp_GetServiceRef()

◆ taf_simRsp_GetClientSessionRef()

◆ taf_simRsp_AdvertiseService()

◆ taf_simRsp_AddProfileDownloadHandler()

◆ taf_simRsp_RemoveProfileDownloadHandler()

◆ taf_simRsp_AddProfileUserConsentHandler()

◆ taf_simRsp_RemoveProfileUserConsentHandler()

◆ taf_simRsp_AddProfileConfirmationCodeHandler()

◆ taf_simRsp_RemoveProfileConfirmationCodeHandler()

◆ taf_simRsp_GetEID()

◆ taf_simRsp_AddProfile()

◆ taf_simRsp_DeleteProfile()

◆ taf_simRsp_SetProfile()

◆ taf_simRsp_UpdateNickName()

◆ taf_simRsp_GetProfileList()

◆ taf_simRsp_SetServerAddress()

◆ taf_simRsp_GetServerAddress()

◆ taf_simRsp_ProvideUserConsent()

◆ taf_simRsp_ProvideConfirmationCode()

◆ taf_simRsp_GetProfile()

◆ taf_simRsp_GetProfileIndex()

◆ taf_simRsp_GetProfileType()

◆ taf_simRsp_GetIccid()

◆ taf_simRsp_GetProfileActiveStatus()

◆ taf_simRsp_GetNickName()

◆ taf_simRsp_GetName()

◆ taf_simRsp_GetSpn()

◆ taf_simRsp_GetIconType()

◆ taf_simRsp_GetProfileClass()

◆ taf_simRsp_GetMask()