taf_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 TAF_UPDATE_COMMON_H_INCLUDE_GUARD
#define TAF_UPDATE_COMMON_H_INCLUDE_GUARD


#include "legato.h"

#define IFGEN_TAF_UPDATE_PROTOCOL_ID "9ddb9401551a87263257c46e4225b031"
#define IFGEN_TAF_UPDATE_MSG_SIZE 272



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_UPDATE_MAX_PKG_NAME_LEN 48

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_UPDATE_FILE_PATH_LEN 256

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_UPDATE_SESSION_NAME_LEN 32

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_update_Session* taf_update_SessionRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_UPDATE_IDLE = 0,
    TAF_UPDATE_DOWNLOADING = 1,
    TAF_UPDATE_DOWNLOAD_PAUSED = 2,
    TAF_UPDATE_DOWNLOAD_SUCCESS = 3,
    TAF_UPDATE_DOWNLOAD_FAIL = 4,
    TAF_UPDATE_INSTALLING = 5,
    TAF_UPDATE_INSTALL_SUCCESS = 6,
    TAF_UPDATE_INSTALL_FAIL = 7,
    TAF_UPDATE_PROBATION = 8,
    TAF_UPDATE_PROBATION_SUCCESS = 9,
    TAF_UPDATE_PROBATION_FAIL = 10,
    TAF_UPDATE_ROLLBACK = 11,
    TAF_UPDATE_ROLLBACK_SUCCESS = 12,
    TAF_UPDATE_ROLLBACK_FAIL = 13,
    TAF_UPDATE_SYNCHRONIZING = 14,
    TAF_UPDATE_SYNC_SUCCESS = 15,
    TAF_UPDATE_SYNC_FAIL = 16,
    TAF_UPDATE_REPORTING = 17
}
taf_update_State_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_UPDATE_NONE = 0,
    TAF_UPDATE_BAD_PACKAGE = 1,
    TAF_UPDATE_INTERNAL_ERROR = 2,
    TAF_UPDATE_SECURITY_FAILURE = 3,
    TAF_UPDATE_PACKAGE_NOT_FOUND = 4,
    TAF_UPDATE_APP_NOT_RUNNING = 5
}
taf_update_Error_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_UPDATE_FOTA = 0,
    TAF_UPDATE_SOTA = 1,
    TAF_UPDATE_NON_QOTA = 2
}
taf_update_OTA_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_UPDATE_PACKAGE_TYPE_QOTA_PACKAGE = 0,
    TAF_UPDATE_PACKAGE_TYPE_NAD_ZIP = 1,
    TAF_UPDATE_PACKAGE_TYPE_TELAF_APP = 2,
    TAF_UPDATE_PACKAGE_TYPE_UAPI_PACKAGE = 3,
    TAF_UPDATE_PACKAGE_TYPE_UNKNOWN = 4
}
taf_update_PackageType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_UPDATE_BANK_A = 0,
    TAF_UPDATE_BANK_B = 1,
    TAF_UPDATE_BANK_UNKNOWN = 2
}
taf_update_Bank_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct
{
    taf_update_State_t state;
    taf_update_Error_t error;
    uint32_t percent;
    taf_update_OTA_t ota;
    char name[32 + 1];
}
taf_update_StateInd_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_update_StateHandler* taf_update_StateHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_update_StateHandlerFunc_t)
(
        const taf_update_StateInd_t * LE_NONNULL stateIndPtr,
        void* contextPtr
);


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_update_InitCommonData
(
    void
);


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


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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_update_StateHandlerRef_t ifgen_taf_update_AddStateHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_StateHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_update_RemoveStateHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_StateHandlerRef_t handlerRef
);

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_Install
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_OTA_t ota,
        const char* LE_NONNULL name
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_GetDownloadSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL cfgFile,
        taf_update_SessionRef_t* sessionPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_StartDownload
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_PauseDownload
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_ResumeDownload
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_CancelDownload
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_GetInstallationSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_PackageType_t pkgType,
        const char* LE_NONNULL cfgFile,
        taf_update_SessionRef_t* sessionPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_InstallPreCheck
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session,
        const char* LE_NONNULL manifest
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_StartInstall
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session,
        const char* LE_NONNULL pkgPath
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_InstallPostCheck
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_GetActiveBank
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session,
        taf_update_Bank_t* bankPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_VerifyActivation
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session,
        const char* LE_NONNULL manifest
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_Rollback
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_update_Sync
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_update_SessionRef_t session
);

#endif // TAF_UPDATE_COMMON_H_INCLUDE_GUARD