taf_diagReset_common.h File Reference

#include "legato.h"
#include "taf_types_common.h"

Go to the source code of this file.

Macros
#define	IFGEN_TAF_DIAGRESET_PROTOCOL_ID   "662812db93a1a97ae797a023b9e09734"
#define	IFGEN_TAF_DIAGRESET_MSG_SIZE   16

Typedefs
typedef struct taf_diagReset_Service *	taf_diagReset_ServiceRef_t
typedef struct taf_diagReset_RxMsg *	taf_diagReset_RxMsgRef_t
typedef struct taf_diagReset_RxMsgHandler *	taf_diagReset_RxMsgHandlerRef_t
typedef void(*	taf_diagReset_RxMsgHandlerFunc_t) (taf_diagReset_RxMsgRef_t rxMsgRef, taf_diagReset_Type_t resetType, void *contextPtr)

Enumerations
enum	taf_diagReset_Type_t {   TAF_DIAGRESET_HARD_RESET = 1, TAF_DIAGRESET_KEY_OFF_ON_RESET = 2, TAF_DIAGRESET_SOFT_RESET = 3, TAF_DIAGRESET_ENABLE_RAPID_POWER_SHUTDOWN_RESET = 4,   TAF_DIAGRESET_DISABLE_RAPID_POWER_SHUTDOWN_RESET = 5, TAF_DIAGRESET_ALL_RESET = 255 }
enum	taf_diagReset_ErrorCode_t { TAF_DIAGRESET_NO_ERROR = 0, TAF_DIAGRESET_CONDITIONS_NOT_CORRECT = 34 }

Functions
LE_SHARED bool	ifgen_taf_diagReset_HasLocalBinding (void)
LE_SHARED void	ifgen_taf_diagReset_InitCommonData (void)
LE_SHARED void	ifgen_taf_diagReset_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
LE_SHARED le_result_t	ifgen_taf_diagReset_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
LE_SHARED taf_diagReset_ServiceRef_t	ifgen_taf_diagReset_GetService (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagReset_Type_t resetType)
LE_SHARED taf_diagReset_RxMsgHandlerRef_t	ifgen_taf_diagReset_AddRxMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagReset_ServiceRef_t svcRef, taf_diagReset_RxMsgHandlerFunc_t handlerPtr, void *contextPtr)
LE_SHARED void	ifgen_taf_diagReset_RemoveRxMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagReset_RxMsgHandlerRef_t handlerRef)
LE_SHARED le_result_t	ifgen_taf_diagReset_SendResp (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagReset_RxMsgRef_t rxMsgRef, taf_diagReset_ErrorCode_t errCode)
LE_SHARED le_result_t	ifgen_taf_diagReset_RemoveSvc (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagReset_ServiceRef_t svcRef)

Macro Definition Documentation

IFGEN_TAF_DIAGRESET_PROTOCOL_ID

#define IFGEN_TAF_DIAGRESET_PROTOCOL_ID   "662812db93a1a97ae797a023b9e09734"

IFGEN_TAF_DIAGRESET_MSG_SIZE

#define IFGEN_TAF_DIAGRESET_MSG_SIZE   16

Typedef Documentation

taf_diagReset_ServiceRef_t

typedef struct taf_diagReset_Service* taf_diagReset_ServiceRef_t

Reference to the Reset service.

taf_diagReset_RxMsgRef_t

typedef struct taf_diagReset_RxMsg* taf_diagReset_RxMsgRef_t

Reference to the Reset received request message.

taf_diagReset_RxMsgHandlerRef_t

typedef struct taf_diagReset_RxMsgHandler* taf_diagReset_RxMsgHandlerRef_t

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

taf_diagReset_RxMsgHandlerFunc_t

typedef void(* taf_diagReset_RxMsgHandlerFunc_t) (taf_diagReset_RxMsgRef_t rxMsgRef, taf_diagReset_Type_t resetType, void *contextPtr)

Handler for a Rx Reset message.

Enumeration Type Documentation

taf_diagReset_Type_t

enum taf_diagReset_Type_t

Reset type.

Enumerator
TAF_DIAGRESET_HARD_RESET	Power-on/start-up sequence.
TAF_DIAGRESET_KEY_OFF_ON_RESET	Key-off-on sequence.
TAF_DIAGRESET_SOFT_RESET	Resart application program.
TAF_DIAGRESET_ENABLE_RAPID_POWER_SHUTDOWN_RESET	Enable the 'rapid power shut down' function.
TAF_DIAGRESET_DISABLE_RAPID_POWER_SHUTDOWN_RESET	Disable the 'rapid power shut down' function.
TAF_DIAGRESET_ALL_RESET	Include all of the reset types.

taf_diagReset_ErrorCode_t

enum taf_diagReset_ErrorCode_t

Error code for Reset.

Enumerator
TAF_DIAGRESET_NO_ERROR
TAF_DIAGRESET_CONDITIONS_NOT_CORRECT

Function Documentation

ifgen_taf_diagReset_HasLocalBinding()

LE_SHARED bool ifgen_taf_diagReset_HasLocalBinding

(

void

)

Get if this client bound locally.

ifgen_taf_diagReset_InitCommonData()

LE_SHARED void ifgen_taf_diagReset_InitCommonData

(

void

)

Init data that is common across all threads

ifgen_taf_diagReset_CleanupCommonData()

LE_SHARED void ifgen_taf_diagReset_CleanupCommonData

(

le_msg_SessionRef_t

_ifgen_sessionRef

)

Cleanup the data of a session

ifgen_taf_diagReset_OpenSession()

LE_SHARED le_result_t ifgen_taf_diagReset_OpenSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		bool	isBlocking
	)

Perform common initialization and open a session

ifgen_taf_diagReset_GetService()

LE_SHARED taf_diagReset_ServiceRef_t ifgen_taf_diagReset_GetService	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_diagReset_Type_t	resetType
	)

Gets the reference to a Reset service, if there's no Reset service, a new one will be created.

Returns

• Reference to the service instance.
• NULL if not allowed to create the service.

Note

The process exits if an invalid reference is passed.

Parameters

[in]

resetType

ifgen_taf_diagReset_AddRxMsgHandler()

LE_SHARED taf_diagReset_RxMsgHandlerRef_t ifgen_taf_diagReset_AddRxMsgHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_diagReset_ServiceRef_t	svcRef,
		taf_diagReset_RxMsgHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_diagReset_RxMsg'

This event provides information on Rx Reset message.

Parameters

[in]	svcRef	Service reference.
[in]	handlerPtr	Received message handler.
[in]	contextPtr

ifgen_taf_diagReset_RemoveRxMsgHandler()

LE_SHARED void ifgen_taf_diagReset_RemoveRxMsgHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_diagReset_RxMsgHandlerRef_t	handlerRef
	)

Remove handler function for EVENT 'taf_diagReset_RxMsg'

Parameters

[in]

handlerRef

ifgen_taf_diagReset_SendResp()

LE_SHARED le_result_t ifgen_taf_diagReset_SendResp	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_diagReset_RxMsgRef_t	rxMsgRef,
		taf_diagReset_ErrorCode_t	errCode
	)

Sends a response message for the Rx Reset message.

Note

This function must be called to send a response if receiving a message.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Invalid rxMsgRef.
• LE_NOT_FOUND – Reference not found.
• LE_FAULT – Failed.

Note

The process exits if an invalid reference is passed.

Parameters

[in]	rxMsgRef	Received message reference.
[in]	errCode	Error code type.

ifgen_taf_diagReset_RemoveSvc()

LE_SHARED le_result_t ifgen_taf_diagReset_RemoveSvc	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_diagReset_ServiceRef_t	svcRef
	)

Removes the Reset service.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Invalid svcRef.

Parameters

[in]

svcRef

Service reference.