le_update_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 LE_UPDATE_COMMON_H_INCLUDE_GUARD
#define LE_UPDATE_COMMON_H_INCLUDE_GUARD


#include "legato.h"

// Interface specific includes
#include "le_limit_common.h"

#define IFGEN_LE_UPDATE_PROTOCOL_ID "17cd65c5c26efb8f22650432980df70f"
#define IFGEN_LE_UPDATE_MSG_SIZE 48



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_UPDATE_STATE_UNPACKING = 0,
    LE_UPDATE_STATE_DOWNLOAD_SUCCESS = 1,
    LE_UPDATE_STATE_APPLYING = 2,
    LE_UPDATE_STATE_SUCCESS = 3,
    LE_UPDATE_STATE_FAILED = 4
}
le_update_State_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_UPDATE_ERR_NONE = 0,
    LE_UPDATE_ERR_BAD_PACKAGE = 1,
    LE_UPDATE_ERR_INTERNAL_ERROR = 2,
    LE_UPDATE_ERR_SECURITY_FAILURE = 3
}
le_update_ErrorCode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_update_ProgressHandler* le_update_ProgressHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_update_ProgressHandlerFunc_t)
(
        le_update_State_t updateState,
        uint32_t percentDone,
        void* contextPtr
);


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_update_InitCommonData
(
    void
);


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


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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_update_ProgressHandlerRef_t ifgen_le_update_AddProgressHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_update_ProgressHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_le_update_RemoveProgressHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        le_update_ProgressHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_update_Start
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        int fd
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_update_Install
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_update_ErrorCode_t ifgen_le_update_GetErrorCode
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED int32_t ifgen_le_update_GetCurrentSysIndex
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_le_update_GetSystemHash
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        int32_t systemIndex,
        char* hashStr,
        size_t hashStrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED int32_t ifgen_le_update_GetPreviousSystemIndex
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        int32_t systemIndex
);

#endif // LE_UPDATE_COMMON_H_INCLUDE_GUARD