taf_pm_common.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */
#ifndef TAF_PM_COMMON_H_INCLUDE_GUARD
#define TAF_PM_COMMON_H_INCLUDE_GUARD


#include "legato.h"

#define IFGEN_TAF_PM_PROTOCOL_ID "11fc3c7788db78006a1a65f8c66f03ba"
#define IFGEN_TAF_PM_MSG_SIZE 48



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_PM_TAG_LEN 31

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_PM_TAG_LEN_BYTES 32

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_PM_MACHINE_NAME_LEN 32

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_PM_REF_COUNT 1

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_PM_STATE_UNKNOWN = 0,
    TAF_PM_STATE_RESUME = 1,
    TAF_PM_STATE_SUSPEND = 2,
    TAF_PM_STATE_SHUTDOWN = 3,
    TAF_PM_STATE_ALL_ACKED = 4,
    TAF_PM_STATE_ALL_WAKELOCKS_RELEASED = 5
}
taf_pm_State_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_PM_SUCCESS = 0,
    TAF_PM_FAILED = 1,
    TAF_PM_EXPIRED = 2
}
taf_pm_Status_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_PM_PVM = 0
}
taf_pm_NadVm_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_PM_READY = 0,
    TAF_PM_NOT_READY = 1
}
taf_pm_ClientAck_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_pm_PowerState* taf_pm_PowerStateRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_pm_StateChangeHandler* taf_pm_StateChangeHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_pm_StateChangeExHandler* taf_pm_StateChangeExHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_pm_WakeupSource* taf_pm_WakeupSourceRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_pm_VMList* taf_pm_VMListRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_pm_StateChangeHandlerFunc_t)
(
        taf_pm_State_t state,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_pm_StateChangeExHandlerFunc_t)
(
        taf_pm_PowerStateRef_t powerStateRef,
        taf_pm_NadVm_t vm,
        taf_pm_State_t state,
        void* contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_pm_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_pm_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_pm_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_pm_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_pm_StateChangeHandlerRef_t ifgen_taf_pm_AddStateChangeHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_StateChangeHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_pm_RemoveStateChangeHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_StateChangeHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_pm_StateChangeExHandlerRef_t ifgen_taf_pm_AddStateChangeExHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_StateChangeExHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_pm_RemoveStateChangeExHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_StateChangeExHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_pm_WakeupSourceRef_t ifgen_taf_pm_NewWakeupSource
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint32_t createOpts,
        const char* LE_NONNULL wsTag
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_pm_StayAwake
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_WakeupSourceRef_t wsRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_pm_Relax
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_WakeupSourceRef_t wsRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_pm_State_t ifgen_taf_pm_GetPowerState
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_pm_SetAllVMPowerState
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_State_t state
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_pm_SetVMPowerState
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_State_t state,
        const char* LE_NONNULL machineName
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_pm_VMListRef_t ifgen_taf_pm_GetMachineList
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_pm_GetFirstMachineName
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_VMListRef_t vmListRef,
        char* name,
        size_t nameSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_pm_GetNextMachineName
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_VMListRef_t vmListRef,
        char* name,
        size_t nameSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_pm_DeleteMachineList
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_VMListRef_t vmLsitRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_pm_SendStateChangeAck
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_pm_PowerStateRef_t powerStateRef,
        taf_pm_State_t state,
        taf_pm_NadVm_t vm,
        taf_pm_ClientAck_t ack
);

#endif // TAF_PM_COMMON_H_INCLUDE_GUARD