Linux SDK (lite-fw)  MBPL_SDK_R25_ENG3
fms.h File Reference
#include "common.h"

Go to the source code of this file.

Data Structures

struct  CarrierImage_t
 
struct  pack_fms_GetImagesPreference_t
 
struct  FMSImageElement
 
struct  FMSPrefImageList
 
struct  unpack_fms_GetImagesPreference_t
 
struct  pack_fms_GetStoredImages_t
 
struct  FMSImageIdElement
 
struct  FMSImageIDEntries
 
struct  FMSImageList
 
struct  unpack_fms_GetStoredImages_t
 
struct  pack_fms_SetImagesPreference_t
 
struct  unpack_fms_SetImagesPreference_t
 
struct  pack_fms_DeleteStoredImage_t
 

Macros

#define FMS_GOBI_MBN_IMG_ID_SIZE   16
 
#define LITE_TOTAL_IMAGE_ID_STRING_SIZE   100
 
#define FMS_GOBI_MBN_IMG_ID_STR_LEN   LITE_TOTAL_IMAGE_ID_STRING_SIZE
 
#define FMS_GOBI_MBN_BUILD_ID_STR_LEN   LITE_TOTAL_IMAGE_ID_STRING_SIZE
 
#define FMS_GOBI_LISTENTRIES_MAX   2
 
#define FMS_MAX_IMAGE_PREFERENCE_IMAGE_SIZE   255
 
#define FMS_MAX_IMAGE_ID_ELEMENT   50
 
#define FMS_IMAGE_ID_MAX_ENTRIES   2
 
#define FMS_FW_PRI_BUILD_MATCH_LEN   11
 
#define FMS_IMAGE_ID_IMG_ID_LEN   16
 
#define FMS_IMAGE_ID_BUILD_ID_LEN   32
 
#define FMS_IMAGE_ID_MDM_IMGTYPE   0x0
 
#define FMS_IMAGE_ID_PRI_IMGTYPE   0x1
 
#define AUTO_SIM_MDM_IMG_ID   "000.000_000"
 
#define AUTO_SIM_MDM_BLD_ID   "00.00.00.00_AUTO-SIM"
 
#define AUTO_SIM_PRI_IMG_ID   "000.000_000"
 
#define AUTO_SIM_PRI_BLD_ID   "00.00.00.00_AUTO-SIM"
 
#define FORCE_DOWNLOAD_DISABLED   0
 
#define FORCE_DOWNLOAD_ENABLED   1
 
#define MDM_SLOT_MODEM_DECIDE   0xFF
 

Typedefs

typedef unpack_result_t unpack_fms_DeleteStoredImage_t
 

Functions

int pack_fms_GetImagesPreference (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen, pack_fms_GetImagesPreference_t *reqArg)
 
int unpack_fms_GetImagesPreference (uint8_t *pResp, uint16_t respLen, unpack_fms_GetImagesPreference_t *pOutput)
 
int pack_fms_GetStoredImages (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen, pack_fms_GetStoredImages_t *reqArg)
 
int unpack_fms_GetStoredImages (uint8_t *pResp, uint16_t respLen, unpack_fms_GetStoredImages_t *pOutput)
 
int pack_fms_SetImagesPreference (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen, pack_fms_SetImagesPreference_t *reqArg)
 
int unpack_fms_SetImagesPreference (uint8_t *pResp, uint16_t respLen, unpack_fms_SetImagesPreference_t *pOutput)
 
uint32_t GetValidFwPriCombinations (FMSImageList *pStoredImageList, uint32_t *pValidCombinationSize, CarrierImage_t *pValidCombinations)
 
int pack_fms_DeleteStoredImage (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen, pack_fms_DeleteStoredImage_t *pReqParam)
 
int unpack_fms_DeleteStoredImage (uint8_t *pResp, uint16_t respLen, unpack_fms_DeleteStoredImage_t *pOutput)
 

Function Documentation

◆ GetValidFwPriCombinations()

uint32_t GetValidFwPriCombinations ( FMSImageList pStoredImageList,
uint32_t *  pValidCombinationSize,
CarrierImage_t pValidCombinations 
)

This API distills valid Firmware/PRI combinations from GetStoredImages result

Parameters
[in]pStoredImageList
[in,out]pValidCombinationSize
  • number of combination passed in and returned
[out]pValidCombinations
Returns
  • eQCWWAN_ERR_INVALID_ARG - Invalid parameters
  • eQCWWAN_ERR_BUFFER_SZ - No enough element to store combinatons returned
See also
See qmerrno.h for eQCWWAN_xxx error values

◆ pack_fms_DeleteStoredImage()

int pack_fms_DeleteStoredImage ( pack_qmi_t *  pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen,
pack_fms_DeleteStoredImage_t pReqParam 
)

Pack function for deleting a specified stored image.

Parameters
[in,out]pCtxqmi request context
[out]pReqBufqmi request buffer
[out]pLenqmi request length
[in]pReqParamrequest prarmeters
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also
See qmerrno.h for eQCWWAN_xxx error values

◆ pack_fms_GetImagesPreference()

int pack_fms_GetImagesPreference ( pack_qmi_t *  pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen,
pack_fms_GetImagesPreference_t reqArg 
)

Get Images Preference pack

Parameters
[in,out]pCtxqmi request context
[out]pReqBufqmi request buffer
[out]pLenqmi request length
[in]reqArgrequest parameter

◆ pack_fms_GetStoredImages()

int pack_fms_GetStoredImages ( pack_qmi_t *  pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen,
pack_fms_GetStoredImages_t reqArg 
)

Get Images Preference pack

Parameters
[in,out]pCtxqmi request context
[out]pReqBufqmi request buffer
[out]pLenqmi request length
[in]reqArgrequest parameter

◆ pack_fms_SetImagesPreference()

int pack_fms_SetImagesPreference ( pack_qmi_t *  pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen,
pack_fms_SetImagesPreference_t reqArg 
)

Set Images Preference pack

Parameters
[in,out]pCtxqmi request context
[out]pReqBufqmi request buffer
[out]pLenqmi request length
[in]reqArgrequest parameter

◆ unpack_fms_DeleteStoredImage()

int unpack_fms_DeleteStoredImage ( uint8_t *  pResp,
uint16_t  respLen,
unpack_fms_DeleteStoredImage_t *  pOutput 
)

Unpack function for deleting a specified image.

Parameters
[in]pRespqmi response from modem
[in]respLenqmi response length
[out]pOutputresponse unpacked
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also
See qmerrno.h for eQCWWAN_xxx error values

◆ unpack_fms_GetImagesPreference()

int unpack_fms_GetImagesPreference ( uint8_t *  pResp,
uint16_t  respLen,
unpack_fms_GetImagesPreference_t pOutput 
)

Get Images Preference unpack

Parameters
[in]pRespqmi response
[in]respLenqmi response length
[out]pOutputunpacked response

◆ unpack_fms_GetStoredImages()

int unpack_fms_GetStoredImages ( uint8_t *  pResp,
uint16_t  respLen,
unpack_fms_GetStoredImages_t pOutput 
)

Get Images Preference unpack

Parameters
[in]pRespqmi response
[in]respLenqmi response length
[out]pOutputunpacked response

◆ unpack_fms_SetImagesPreference()

int unpack_fms_SetImagesPreference ( uint8_t *  pResp,
uint16_t  respLen,
unpack_fms_SetImagesPreference_t pOutput 
)

Set Images Preference unpack

Parameters
[in]pRespqmi response
[in]respLenqmi response length
[out]pOutputunpacked response