LinuxQMISDK-Lite  SLQS04.00.23
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
lite-fw.h
Go to the documentation of this file.
1 
13 #ifndef _LITE_FW_H_
14 #define _LITE_FW_H_
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 /* Pragmas */
21 #pragma once
22 #include "qmerrno.h"
23 #include "fms.h"
24 #include "dms.h"
25 
26 #define IMG_MASK_MDM (1<<0)
27 #define IMG_MASK_PRI (1<<1)
28 #define IMG_MASK_CLEAR (0x000)
29 #define IMG_MASK_GENERIC (0xFFFF)
30 
31 // Carrier package SKU Info
32 #define LITEFW_CARRIER_PACKAGE_SKU "9999999"
33 #define LITEFW_SKU_STRING_LENGTH 7
34 
35 // Fimware Info String size
36 #define FIRMWARE_INFO_STRING_SIZE 20
37 #define NULL_TERMINATOR_CHAR_SIZE 1
38 #define FIRMWARE_IMAGE_SIZE_MAX 512
39 #define FIRMWARE_BCHVERSTRSIZE 84
40 #define FIRMWARE_BCHDATESIZE 8
41 #define MAX_IMAGE_PRODUCT_LENGTH 10
42 
43 /* error Codes */
45 {
46  eSDP_FWDWL_SUCCESS = 0, // Success
47  eSDP_FWDWL_ERR_GENERAL = 100, // 100 - Generic FW download error
48  eSDP_FWDWL_ERR_SDK, // 101 - SDK specific error. Please check syslog for SDK error codes
49  eSDP_FWDWL_ERR_SET_CBK, // 102 - Error in setting SDK callbacks
50  eSDP_FWDWL_ERR_PATH_TOO_LONG, // 103 - Path is too long
51  eSDP_FWDWL_ERR_PATH_NOT_SPECIFIED, // 104 - Mandatory SDK/FW path not set
52  eSDP_FWDWL_ERR_FW_UPGRADE, // 105 - Post FW download check indicates that the FW upgrade has failed.
53  // For example, PRI not updated as expected, FW version not updated etc
54  eSDP_FWDWL_ERR_INVALID_DEV, // 106 - Invalid device
55  eSDP_FWDWL_ERR_INVALID_PATH, // 107 - Invalid Path or No valid firmware or nvu file exist in the path
56  eSDP_FWDWL_ERR_TIMEOUT, // 108 - Download Process Timeout
57  eSDP_FWDWL_ERR_FAIL, // 109 - Download Process Fail
58  eSDP_FWDWL_ERR_PRI_FAIL, // 110 - Download PRI Fail
59  eSDP_FWDWL_ERR_FW_VERSION_FAIL, // 111 - Download Fail Version Not Match
60  eSDP_FWDWL_ERR_SDP_TIMEOUT, // 112 - SSDP mode timeout
63 };
64 
65 // Match this enum with fw_image_type_e in imudefs.h
67  eFW_TYPE_MBN_GOBI, // Not supported in litefw
68  eFW_TYPE_MBN, // Not supported in litefw
69  eFW_TYPE_CWE, //CWE File
70  eFW_TYPE_NVU, //NVU File
71  eFW_TYPE_SPK, //SPK File
72  eFW_TYPE_INVALID, //Invalid File
73  eFW_TYPE_CWE_NVU, //CWE and NVU
74 };
75 
76 
77 /*************
78  *
79  * Name: litefw_fileimgtype
80  *
81  * Purpose: Enumerate different PRI type
82  *
83  * Members: eFILE_TYPE_NONE - Start of list
84  * eFILE_TYPE_CAR_PRI - Carrier PRI file (file name starts with "9999999_")
85  * eFILE_TYPE_OEM_PRI - OEM PRI file (file name strats with valid SKU such as "1104125_")
86  * eFILE_TYPE_COMPO_PRI - A compound PRI files contain both Carrier PRI and OEM PRI
87  */
89 {
94 };
95 
96 /*************
97  *
98  * Name: litefw_bcimagetype
99  *
100  * Purpose: Enumerate some supported BC image types
101  *
102  * Members: eIMAGE_TYPE_MIN - Start of list
103  * eIMAGE_TYPE_BOOT - boot composite image
104  * eIMAGE_TYPE_APPL - application composite image
105  * eIMAGE_TYPE_AMSS - amss
106  * eIMAGE_TYPE_APPS - apps such as yocto image
107  * eIMAGE_TYPE_FILE - Generic file such as Carrier PRI
108  * eIMAGE_TYPE_SPKG - Sierra package, spk image, OEM PRI image
109  * eIMAGE_TYPE_MODM - modem composite image, modem firmware cwe image
110  * eIMAGE_TYPE_USER - image for 0:USERDATA, e.g. legato
111  * eIMAGE_TYPE_KEYS, - Keystore image, signed key information
112  * eIMAGE_TYPE_MAX - End of list
113  * eIMAGE_TYPE_INVALID - invalid image type
114  * eIMAGE_TYPE_ANY - any image type
115  *
116  * Notes: none
117  *
118  **************/
120 {
133 };
134 
135 
136 /* Model Family */
144 };
145 
146 /* QDL mode */
152 };
153 
154 /* QDL mode Hardware flow control */
160 };
161 
169 void litefw_logsenable(int log_en);
170 
194 typedef struct _litefw_FirmwareInfo_
195 {
203 
214 {
217 
252 {
254  uint8_t imageMask;
266 
283 
299 int litefw_ExtractFirmwarePartNoByPath(char *pImagePath, litefw_FirmwarePartNo *partno);
300 
317 
330 
343 int litefw_getFileType(char* szPath);
344 
372 unsigned int litefw_DownloadFW(char *pImagePath,char *szTTYPath,int iFWImageType, int image_mask, int iModelFamily);
373 
386 int litefw_GetModelFamily(char *pModelString);
387 
398 
399 
406 char* litefw_GetVersion();
407 
408 
421 typedef void (* litefwlogger)(uint8_t lvl, const char* buff);
422 
434 
444 void litefw_SetReadBlockSize(unsigned long lBlockSize);
445 
446 
457 int litefw_switch_9x07_to_downloadmode(char *szTTYPath);
458 
459 
469 int litefw_switch_to_BootHoldMode(char *szTTYPath);
470 
481 int litefw_SetQTLDownloadMode(int iMode);
482 
490 
501 int litefw_SetQTLHWFlowControl(int iMode);
502 
511 
529  char *fullFilePath,
531  uint8_t *pNumOfItems);
532 
533 
534 #define libSDP_GetVersion litefw_GetVersion
535 #define libSDP_CalculateImageMask litefw_CalculateImageMask
536 #define libSDP_getFileType litefw_getFileType
537 #define libSDP_ExtractFirmwareParametersByPath litefw_ExtractFirmwareParametersByPath
538 #define libSDP_GetModelFamily litefw_GetModelFamily
539 #define libSDP_CheckValidFirmwareInfo litefw_CheckValidFirmwareInfo
540 #define libSDP_BuildImagesPreferenceRequest litefw_BuildImagesPreferenceRequest
541 #define libSDP_DownloadFW litefw_DownloadFW
542 #define libsdp_set_log_func litefw_set_log_func
543 #define libsdp_SetReadBlockSize litefw_SetReadBlockSize
544 #define LIBSDP_CARRIER_PACKAGE_SKU LITEFW_CARRIER_PACKAGE_SKU
545 #define LIBSDP_SKU_STRING_LENGTH LITEFW_SKU_STRING_LENGTH
548 
549 #ifdef __cplusplus
550 } /* extern "C" { */
551 #endif
552 
553 #endif // _LITE_FW_H_
554 
struct _litefw_FirmwarePartNo_ litefw_FirmwarePartNo
Definition: lite-fw.h:92
litefw_QDL_FLOW_CONTROLs
Definition: lite-fw.h:155
void litefw_SetReadBlockSize(unsigned long lBlockSize)
eQCWWANError
Definition: qmerrno.h:19
enum litefw_imagetype headerType
Definition: lite-fw.h:255
Definition: lite-fw.h:122
Definition: lite-fw.h:143
Definition: lite-fw.h:55
char * litefw_GetVersion()
Definition: lite-fw.h:93
#define NULL_TERMINATOR_CHAR_SIZE
Definition: lite-fw.h:37
Definition: lite-fw.h:128
Definition: lite-fw.h:67
litefw_fwdwl_error_codes
Definition: lite-fw.h:44
Definition: lite-fw.h:158
int litefw_ExtractFirmwarePartNoByPath(char *pImagePath, litefw_FirmwarePartNo *partno)
char versionStr[84]
Definition: lite-fw.h:263
Definition: lite-fw.h:60
Definition: lite-fw.h:52
Definition: lite-fw.h:91
char szCarrierPriversion_str[20+1]
Definition: lite-fw.h:201
int litefw_CalculateImageMask(unpack_fms_SetImagesPreference_t SetPrefRspFromModem)
char szFwversion_str[20+1]
Definition: lite-fw.h:197
Definition: lite-fw.h:68
Definition: lite-fw.h:54
Definition: lite-fw.h:50
#define FIRMWARE_INFO_STRING_SIZE
Definition: lite-fw.h:36
Definition: lite-fw.h:48
Definition: lite-fw.h:121
int litefw_BuildImagesPreferenceRequest(litefw_FirmwareInfo info, pack_fms_SetImagesPreference_t *pack)
Definition: lite-fw.h:51
enum litefw_fileimgtype imageType
Definition: lite-fw.h:256
Definition: lite-fw.h:130
int litefw_getFileType(char *szPath)
char modelIdStr[20+1]
Definition: lite-fw.h:257
Definition: lite-fw.h:151
Definition: lite-fw.h:69
int litefw_GetQTLDownloadMode()
void(* litefwlogger)(uint8_t lvl, const char *buff)
Definition: lite-fw.h:421
Definition: lite-fw.h:150
Definition: lite-fw.h:149
litefw_imagetype
Definition: lite-fw.h:119
char skuStr[20+1]
Definition: lite-fw.h:259
litefwlogger libsdplogger
Definition: lite-fw.h:547
char priVersionStr[20+1]
Definition: lite-fw.h:262
int litefw_switch_to_BootHoldMode(char *szTTYPath)
Definition: lite-fw.h:71
int litefw_switch_9x07_to_downloadmode(char *szTTYPath)
Definition: lite-fw.h:56
struct _litefw_FirmwareFileInfo litefw_FirmwareFileInfo
uint8_t imageMask
Definition: lite-fw.h:254
char packageIdStr[20+1]
Definition: lite-fw.h:260
char fullPath[512]
Definition: lite-fw.h:253
Definition: lite-fw.h:47
litefw_Fw_Type
Definition: lite-fw.h:66
Definition: lite-fw.h:124
Definition: lite-fw.h:139
char szModelid_str[20+1]
Definition: lite-fw.h:196
Definition: lite-fw.h:59
Definition: lite-fw.h:156
Definition: lite-fw.h:138
char carrierStr[20+1]
Definition: lite-fw.h:261
enum eQCWWANError litefw_SLQSGetFirmwareFileInfo(char *fullFilePath, litefw_FirmwareFileInfo *info, uint8_t *pNumOfItems)
Definition: lite-fw.h:194
void litefw_logsenable(int log_en)
unsigned int litefw_DownloadFW(char *pImagePath, char *szTTYPath, int iFWImageType, int image_mask, int iModelFamily)
#define FIRMWARE_BCHVERSTRSIZE
Definition: lite-fw.h:39
litefw_fileimgtype
Definition: lite-fw.h:88
Definition: lite-fw.h:142
char partNoStr[20+1]
Definition: lite-fw.h:258
Definition: lite-fw.h:62
Definition: lite-fw.h:72
Definition: lite-fw.h:132
int litefw_GetModelFamily(char *pModelString)
Definition: lite-fw.h:129
Definition: lite-fw.h:90
litefw_FirmwareInfo libSDP_FirmwareInfo
Definition: lite-fw.h:546
char szPackageid_str[20+1]
Definition: lite-fw.h:199
Definition: lite-fw.h:140
int litefw_SetQTLHWFlowControl(int iMode)
Definition: lite-fw.h:49
Definition: lite-fw.h:213
Definition: lite-fw.h:126
char szPartno_str[20+1]
Definition: lite-fw.h:215
int litefw_GetQTLHWFlowControl()
struct _litefw_FirmwareInfo_ litefw_FirmwareInfo
Definition: lite-fw.h:46
int litefw_CheckValidFirmwareInfo(litefw_FirmwareInfo info)
char szSku_str[20+1]
Definition: lite-fw.h:198
Definition: lite-fw.h:73
#define FIRMWARE_BCHDATESIZE
Definition: lite-fw.h:40
Definition: lite-fw.h:251
litefw_QDL_MODEs
Definition: lite-fw.h:147
Definition: lite-fw.h:131
Definition: lite-fw.h:58
Definition: lite-fw.h:123
char szCarrier_str[20+1]
Definition: lite-fw.h:200
Definition: lite-fw.h:159
Definition: lite-fw.h:127
int litefw_ExtractFirmwareParametersByPath(char *pImagePath, litefw_FirmwareInfo *info)
char releaseDate[8]
Definition: lite-fw.h:264
int litefw_SetQTLDownloadMode(int iMode)
Definition: lite-fw.h:157
Definition: fms.h:343
int litefw_set_log_func(litefwlogger *func)
Definition: lite-fw.h:148
#define FIRMWARE_IMAGE_SIZE_MAX
Definition: lite-fw.h:38
Definition: lite-fw.h:57
Definition: lite-fw.h:70
litefw_Models
Definition: lite-fw.h:137
Definition: lite-fw.h:125
Definition: lite-fw.h:141

Copyright (c) 2011-2015 Sierra Wireless, Inc. All rights reserved