Files | Macros | Typedefs | Enumerations | Functions
Utils

Interface header file for the Utilities. More...

+ Collaboration diagram for Utils:

Files

file  XDK_Utils.h
 

Macros

#define XDK_NETWORK_IPV4(add_3, add_2, add_1, add_0)
 

Typedefs

typedef enum Utils_NVMMacInfo_E Utils_NVMMacInfo_T
 Typedef to represent theNvm Data Info. More...
 

Enumerations

enum  Utils_NVMMacInfo_E
 Enum to represent the Nvm Data Info. More...
 

Functions

Retcode_T Utils_ConvertIpStringToNumber (const char *ipDottedQuad, uint32_t *ipAddress)
 Convert human readable IPv4 address to UINT32 which is in big endian format. More...
 
Retcode_T Utils_GetMacInfoFromNVM (Utils_NVMMacInfo_T nvmMacInfo, uint8_t *data)
 This function reads the BLE/wifi MAC address from NVM module. More...
 
Retcode_T Utils_GetXdkAppVersion (uint8_t *appVersion)
 This function to Get the Version string of XDK application. More...
 
Retcode_T Utils_GetXdkVersionString (uint8_t *verstring)
 This function to Get the Version string by combining the XDK SW Release (XdkVersion_GetVersion) i.e., Workbench Release version & Fota Container Application Firmware Version So, the combined Version Information will be like (i.e., vAA.BB.CC-aa.bb.cc ) More...
 
void Utils_PrintResetCause (void)
 This function prints if last reset was caused due to watchdog timer. More...
 

Detailed Description

Macro Definition Documentation

#define XDK_NETWORK_IPV4 (   add_3,
  add_2,
  add_1,
  add_0 
)
Value:
((((uint32_t)add_0 << 24) & 0xFF000000) | \
(((uint32_t)add_1 << 16) & 0xFF0000) | \
(((uint32_t)add_2 << 8) & 0xFF00) | \
((uint32_t)add_3 & 0xFF) )

Typedef Documentation

Enumeration Type Documentation

Enumerator
UTILS_BLE_MAC_DATA 
UTILS_WIFI_MAC_DATA 

Function Documentation

Retcode_T Utils_ConvertIpStringToNumber ( const char *  ipDottedQuad,
uint32_t *  ipAddress 
)
Parameters
[in]ipDottedQuadInput C string e.g. "192.168.0.1"
[out]ipAddressipAddress pointer to variable to hold the ip data
Returns
RETCODE_OK in case of success RETCODE_NULL_POINTER when the ipDottedQuad or ipAddress is NULL RETCODE_INVALID_PARAM when the parameter is invalid

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T Utils_GetMacInfoFromNVM ( Utils_NVMMacInfo_T  nvmMacInfo,
uint8_t *  data 
)
Parameters
[in]nvmMacInfomedium(BLE/WIFI) whose data should be read from NVM.
[in]dataPointer to the buffer to store data.
Returns
RETCODE_OK in success scenario, error case otherwise
Note
The buffer length for MAC address for BLE and WIFI is 6 bytes

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Utils_GetXdkAppVersion ( uint8_t *  verstring)
Parameters
[out]verstring- XDK Version string of application defined by makefile .
Note
  • XDK App version, AA - Major; BB - Minor; CC - Patch
Returns
RETCODE_OK if success, or an error code otherwise.

This function to Get the Version string of XDK application.

Parameters
[out]verstring- Firmware Version (i.e., 1.5.0). It reads sw version from MAJOR_SW_NO, MINOR_SW_NO, PATCH_SW_NO macros defined in make file.

+ Here is the call graph for this function:

Retcode_T Utils_GetXdkVersionString ( uint8_t *  verstring)
Parameters
[out]verstring- XDK Version string.For Fota support XDK SW, verstring = vAA.BB.CC-aa.bb.cc, XDK Version string.For Fota support XDK SW, verstring = vAA.BB.CC-aa.bb.cc, .
Note
  • XDK SW Release version, AA - Major; BB - Minor; CC - Patch
  • Application Firmware Version aa - Major; bb - Minor; cc - Patch
  • If Fota supported XDK SW, then verstring = vAA.BB.CC-aa.bb.cc. for without Fota supported XDK SW verstring = vAA.BB.CC-xx.xx.xx
  • xx.xx.xx means not applicable.
Returns
RETCODE_OK if success, or an error code otherwise.

This function to Get the Version string by combining the XDK SW Release (XdkVersion_GetVersion) i.e., Workbench Release version & Fota Container Application Firmware Version So, the combined Version Information will be like (i.e., vAA.BB.CC-aa.bb.cc )

Parameters
[out]versionNo- Firmware Version (i.e., 3.0.1-0.0.1 if new bootloader or 3.0.1-xx.xx.xx for old bootloader).

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void Utils_PrintResetCause ( void  )

Refer interface header for description

+ Here is the caller graph for this function:


This documentation file has been automatically generated on Wed May 6 2020 20:45:20 by doxygen 1.8.8