pa_ecall.h File Reference

#include "legato.h"
#include "interfaces.h"

Go to the source code of this file.

Typedefs
typedef void(*	pa_ecall_EventHandlerFunc_t )(le_ecall_State_t *statePtr)

Enumerations
enum	pa_ecall_MsdTxMode_t { PA_ECALL_TX_MODE_PULL, PA_ECALL_TX_MODE_PUSH }

Functions
le_event_HandlerRef_t	pa_ecall_AddEventHandler (pa_ecall_EventHandlerFunc_t handlerFuncPtr)
void	pa_ecall_RemoveEventHandler (le_event_HandlerRef_t handlerRef)
le_result_t	pa_ecall_SetPsapNumber (char psap[LE_MDMDEFS_PHONE_NUM_MAX_LEN])
le_result_t	pa_ecall_SetMaxRedialAttempts (uint32_t redialAttemptsCount)
le_result_t	pa_ecall_SetMsdTxMode (pa_ecall_MsdTxMode_t mode)
le_result_t	pa_ecall_LoadMsd (uint8_t *msdPtr, size_t msdSize)
le_result_t	pa_ecall_StartTest (void)
le_result_t	pa_ecall_StartAutomatic (void)
le_result_t	pa_ecall_StartManual (void)
le_result_t	pa_ecall_End (void)

Detailed Description

Legato Modem eCall Platform Adapter API include file.

Copyright (C) Sierra Wireless, Inc. 2014. Use of this work is subject to license.

Typedef Documentation

typedef void(* pa_ecall_EventHandlerFunc_t)(le_ecall_State_t *statePtr)

A handler that is called whenever a eCall event is received by the modem.

Enumeration Type Documentation

enum pa_ecall_MsdTxMode_t

Enumeration used to specify the mode of transmission.

Enumerator
PA_ECALL_TX_MODE_PULL	Pull mode (modem/host waits for MSD request from PSAP to send MSD).
PA_ECALL_TX_MODE_PUSH	Push mode (modem/host sends MSD to PSAP right after eCall is connected).

Function Documentation

le_event_HandlerRef_t pa_ecall_AddEventHandler

(

pa_ecall_EventHandlerFunc_t

handlerFuncPtr

)

This function must be called to register a handler for eCall event notifications.

Returns

A handler reference, which is only needed for later removal of the handler.

Note

Doesn't return on failure, so there's no need to check the return value for errors.

Parameters

[in]

handlerFuncPtr

The event handler function.

le_result_t pa_ecall_End

(

void

)

This function must be called to end a eCall.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.

le_result_t pa_ecall_LoadMsd	(	uint8_t *	msdPtr,
		size_t	msdSize
	)

This function must be called to load the Minimum Set of Data for the eCall.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.

Parameters

[in]	msdPtr	Encoded Msd
[in]	msdSize	msd buffer size

void pa_ecall_RemoveEventHandler

(

le_event_HandlerRef_t

handlerRef

)

This function must be called to unregister the handler for eCalls handling.

Note

Doesn't return on failure, so there's no need to check the return value for errors.

le_result_t pa_ecall_SetMaxRedialAttempts

(

uint32_t

redialAttemptsCount

)

This function must be called to set the maximum redial attempt when an ecall failed.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.

Parameters

[in]

redialAttemptsCount

Number of redial attempt

le_result_t pa_ecall_SetMsdTxMode

(

pa_ecall_MsdTxMode_t

mode

)

This function must be called to set push/pull transmission mode.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.

le_result_t pa_ecall_SetPsapNumber

(

char

psap[LE_MDMDEFS_PHONE_NUM_MAX_LEN]

)

This function must be called to set the Public Safely Answering Point number.

Returns

LE_FAULT The function failed.

LE_OVERFLOW psap number is too long.

LE_OK The function succeed.

Parameters

[in]

psap

Public Safely Answering Point number

le_result_t pa_ecall_StartAutomatic

(

void

)

This function must be called to start an automatic eCall.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.

le_result_t pa_ecall_StartManual

(

void

)

This function must be called to start a manual eCall.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.

le_result_t pa_ecall_StartTest

(

void

)

This function must be called to start an eCall test.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.