lite-fw.h

Go to the documentation of this file.

#ifndef _LITE_FW_H_
#define _LITE_FW_H_

#ifdef __cplusplus
extern "C" {
#endif

/* Pragmas */
#pragma once
#include "qmerrno.h"
#include "fms.h"
#include "dms.h"

#define IMG_MASK_MDM (1<<0)
#define IMG_MASK_PRI (1<<1)
#define IMG_MASK_CLEAR   (0x000)
#define IMG_MASK_GENERIC (0xFFFF)

// Carrier package SKU Info
#define LITEFW_CARRIER_PACKAGE_SKU "9999999"
#define LITEFW_SKU_STRING_LENGTH   7
#define FIRMWARE_INFO_STRING_SIZE  20

/* error Codes */
enum litefw_fwdwl_error_codes
{
    eSDP_FWDWL_SUCCESS = 0,             //       Success
    eSDP_FWDWL_ERR_GENERAL = 100,       // 100 - Generic FW download error
    eSDP_FWDWL_ERR_SDK,                 // 101 - SDK specific error. Please check syslog for SDK error codes
    eSDP_FWDWL_ERR_SET_CBK,             // 102 - Error in setting SDK callbacks
    eSDP_FWDWL_ERR_PATH_TOO_LONG,       // 103 - Path is too long
    eSDP_FWDWL_ERR_PATH_NOT_SPECIFIED,  // 104 - Mandatory SDK/FW path not set
    eSDP_FWDWL_ERR_FW_UPGRADE,          // 105 - Post FW download check indicates that the FW upgrade has failed. 
                                        //       For example, PRI not updated as expected, FW version not updated etc
    eSDP_FWDWL_ERR_INVALID_DEV,         // 106 - Invalid device
    eSDP_FWDWL_ERR_INVALID_PATH,        // 107 - Invalid Path or No valid firmware or nvu file exist in the path
    eSDP_FWDWL_ERR_TIMEOUT,             // 108 - Download Process Timeout
    eSDP_FWDWL_ERR_FAIL,                // 109 - Download Process Fail
    eSDP_FWDWL_ERR_PRI_FAIL,            // 110 - Download PRI Fail
    eSDP_FWDWL_ERR_FW_VERSION_FAIL,     // 111 - Download Fail Version Not Match
    eSDP_FWDWL_ERR_SDP_TIMEOUT,         // 112 – SSDP mode timeout
    eSDP_FWDWL_ERR_END
};

// Match this enum with fw_image_type_e in imudefs.h
enum litefw_Fw_Type{
    eFW_TYPE_MBN_GOBI, // Not supported in litefw
    eFW_TYPE_MBN,      // Not supported in litefw
    eFW_TYPE_CWE,      //CWE File
    eFW_TYPE_NVU,      //NVU File
    eFW_TYPE_SPK,      //SPK File
    eFW_TYPE_INVALID,  //Invalid File
    eFW_TYPE_CWE_NVU,  //CWE and NVU
};

/* Model Family */
enum litefw_Models{
    eModel_Unknown=-1,
    eModel_9X15=0,
    eModel_WP9X15=1,
    eModel_9X30=2,
    eModel_9x07=3,
    eModel_9x06=4
};

/* QDL mode */
enum litefw_QDL_MODEs{
    eQDL_MODE_Unknown=-1,
    eQDL_MODE_INIT=0,
    eQDL_MODE_TTYUSB=1,
    eQDL_MODE_UART0=2,
};

/* QDL mode Hardware flow control */
enum litefw_QDL_FLOW_CONTROLs{
    eQDL_HW_FLOW_Unknown=-1,
    eQDL_HW_FLOW_INIT=0,
    eQDL_HW_FLOW_ENABLE=1,
    eQDL_HW_FLOW_DISABLE=2,
};

void litefw_logsenable(int log_en);

typedef struct _litefw_FirmwareInfo_
{
    char szModelid_str[FIRMWARE_INFO_STRING_SIZE];
    char szFwversion_str[FIRMWARE_INFO_STRING_SIZE];
    char szSku_str[FIRMWARE_INFO_STRING_SIZE];
    char szPackageid_str[FIRMWARE_INFO_STRING_SIZE];
    char szCarrier_str[FIRMWARE_INFO_STRING_SIZE];
    char szCarrierPriversion_str[FIRMWARE_INFO_STRING_SIZE];
}litefw_FirmwareInfo;

int litefw_ExtractFirmwareParametersByPath(char *pImagePath, litefw_FirmwareInfo *info);

int litefw_BuildImagesPreferenceRequest(litefw_FirmwareInfo info,pack_fms_SetImagesPreference_t *pack);

int litefw_CalculateImageMask (unpack_fms_SetImagesPreference_t SetPrefRspFromModem);

int litefw_getFileType(char* szPath);

unsigned int litefw_DownloadFW(char *pImagePath,char *szTTYPath,int iFWImageType, int image_mask, int iModelFamily);

int litefw_GetModelFamily(char *pModelString);

int litefw_CheckValidFirmwareInfo(litefw_FirmwareInfo info);


char* litefw_GetVersion();


typedef void (* litefwlogger)(uint8_t lvl, const char* buff);

int litefw_set_log_func(litefwlogger func);

void litefw_SetReadBlockSize(unsigned long lBlockSize);


int litefw_switch_9x07_to_downloadmode(char *szTTYPath);


int litefw_switch_to_BootHoldMode(char *szTTYPath);

int litefw_SetQTLDownloadMode(int iMode);

int litefw_GetQTLDownloadMode();

int litefw_SetQTLHWFlowControl(int iMode);

int litefw_GetQTLHWFlowControl();



#define libSDP_GetVersion litefw_GetVersion
#define libSDP_CalculateImageMask litefw_CalculateImageMask
#define libSDP_getFileType litefw_getFileType
#define libSDP_ExtractFirmwareParametersByPath litefw_ExtractFirmwareParametersByPath
#define libSDP_GetModelFamily litefw_GetModelFamily
#define libSDP_CheckValidFirmwareInfo litefw_CheckValidFirmwareInfo
#define libSDP_BuildImagesPreferenceRequest litefw_BuildImagesPreferenceRequest
#define libSDP_DownloadFW litefw_DownloadFW
#define libsdp_set_log_func litefw_set_log_func
#define libsdp_SetReadBlockSize litefw_SetReadBlockSize
#define LIBSDP_CARRIER_PACKAGE_SKU LITEFW_CARRIER_PACKAGE_SKU
#define LIBSDP_SKU_STRING_LENGTH LITEFW_SKU_STRING_LENGTH
typedef litefw_FirmwareInfo libSDP_FirmwareInfo;
typedef litefwlogger libsdplogger;

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif // _LITE_FW_H_