LinuxQMISDK-Lite  SLQS04.00.23
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Typedefs | Functions
swioma.h File Reference

Go to the source code of this file.

Data Structures

struct  pack_swioma_SLQSOMADMStartSession_t
 
struct  unpack_swioma_SLQSOMADMStartSession_t
 
struct  pack_swioma_SLQSOMADMCancelSession_t
 
struct  unpack_swioma_SLQSOMADMGetSettings_t
 
struct  pack_swioma_SLQSOMADMSetSettings_t
 
struct  pack_swioma_SLQSOMADMSendSelection_t
 
struct  pack_swioma_SLQSOMADMGetSessionInfo_t
 
struct  unpack_swioma_SLQSOMADMGetSessionInfo_t
 
struct  unpack_omaDmFotaTlv_t
 
struct  unpack_omaDmConfigTlv_t
 
struct  unpack_omaDmNotificationsTlv_t
 
struct  unpack_swioma_SLQSOMADMAlertCallback_ind_t
 

Macros

#define LITEQMI_MAX_SWIOMA_STR_LEN   255
 

Typedefs

typedef unpack_result_t unpack_swioma_SLQSOMADMCancelSession_t
 
typedef unpack_result_t unpack_swioma_SLQSOMADMSetSettings_t
 
typedef unpack_result_t unpack_swioma_SLQSOMADMSendSelection_t
 
typedef unpack_result_t unpack_swioma_SLQSOMADMAlertCallback_t
 

Functions

int pack_swioma_SLQSOMADMStartSession (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen, pack_swioma_SLQSOMADMStartSession_t reqParam)
 
int unpack_swioma_SLQSOMADMStartSession (uint8_t *pResp, uint16_t respLen, unpack_swioma_SLQSOMADMStartSession_t *pOutput)
 
int pack_swioma_SLQSOMADMCancelSession (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen, pack_swioma_SLQSOMADMCancelSession_t reqParam)
 
int unpack_swioma_SLQSOMADMCancelSession (uint8_t *pResp, uint16_t respLen, unpack_swioma_SLQSOMADMCancelSession_t *pOutput)
 
int pack_swioma_SLQSOMADMGetSettings (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen)
 
int unpack_swioma_SLQSOMADMGetSettings (uint8_t *pResp, uint16_t respLen, unpack_swioma_SLQSOMADMGetSettings_t *pOutput)
 
int pack_swioma_SLQSOMADMSetSettings (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen, pack_swioma_SLQSOMADMSetSettings_t reqParam)
 
int unpack_swioma_SLQSOMADMSetSettings (uint8_t *pResp, uint16_t respLen, unpack_swioma_SLQSOMADMSetSettings_t *pOutput)
 
int pack_swioma_SLQSOMADMSendSelection (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen, pack_swioma_SLQSOMADMSendSelection_t reqParam)
 
int unpack_swioma_SLQSOMADMSendSelection (uint8_t *pResp, uint16_t respLen, unpack_swioma_SLQSOMADMSendSelection_t *pOutput)
 
int pack_swioma_SLQSOMADMGetSessionInfo (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen, pack_swioma_SLQSOMADMGetSessionInfo_t reqParam)
 
int unpack_swioma_SLQSOMADMGetSessionInfo (uint8_t *pResp, uint16_t respLen, unpack_swioma_SLQSOMADMGetSessionInfo_t *pOutput)
 
int pack_swioma_SLQSOMADMAlertCallback (pack_qmi_t *pCtx, uint8_t *pReqBuf, uint16_t *pLen)
 
int unpack_swioma_SLQSOMADMAlertCallback (uint8_t *pResp, uint16_t respLen, unpack_swioma_SLQSOMADMAlertCallback_t *pOutput)
 
int unpack_swioma_SLQSOMADMAlertCallback_ind (uint8_t *pResp, uint16_t respLen, unpack_swioma_SLQSOMADMAlertCallback_ind_t *pOutput)
 

Macro Definition Documentation

#define LITEQMI_MAX_SWIOMA_STR_LEN   255

Typedef Documentation

Function Documentation

int pack_swioma_SLQSOMADMAlertCallback ( pack_qmi_t pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen 
)

Function to pack QMI command to enable the SWIOMADM network-initiated alert callback function. This maps to SetSLQSOMADMAlertCallback

Parameters
pCtx[out]
pReqBuf[in,out]
  • Buffer for packed QMI command to be provided by the host application
  • Minimum expected size is 2048 bytes
pLen[in,out]
  • On input, size of pReqBuf
  • On ouptut, number of bytes actually packed
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
int pack_swioma_SLQSOMADMCancelSession ( pack_qmi_t pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen,
pack_swioma_SLQSOMADMCancelSession_t  reqParam 
)

Function to pack cancel OMA-DM session command This maps to SLQSOMADMCancelSession

Parameters
pCtx[out]
pReqBuf[in,out]
  • Buffer for packed QMI command to be provided by the host application
  • Minimum expected size is 2048 bytes
pLen[in,out]
  • On input, size of pReqBuf
  • On output, number of bytes actually packed
reqParam[in]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
int pack_swioma_SLQSOMADMGetSessionInfo ( pack_qmi_t pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen,
pack_swioma_SLQSOMADMGetSessionInfo_t  reqParam 
)

Function to pack QMI command to return information related to the current (or previous if no session is active) OMA-DM session. This maps to SLQSOMADMGetSessionInfo

Parameters
pCtx[out]
pReqBuf[in,out]
  • Buffer for packed QMI command to be provided by the host application
  • Minimum expected size is 2048 bytes
pLen[in,out]
  • On input, size of pReqBuf
  • On ouptut, number of bytes actually packed
reqParam[in]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
int pack_swioma_SLQSOMADMGetSettings ( pack_qmi_t pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen 
)

Function to pack command to retrieve the OMA-DM settings from the device. This maps to SLQSOMADMGetSettings2

Parameters
pCtx[out]
pReqBuf[in,out]
  • Buffer for packed QMI command to be provided by the host application
  • Minimum expected size is 2048 bytes
pLen[in,out]
  • On input, size of pReqBuf
  • On output, number of bytes actually packed
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
int pack_swioma_SLQSOMADMSendSelection ( pack_qmi_t pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen,
pack_swioma_SLQSOMADMSendSelection_t  reqParam 
)

Function to pack OMA-DM send selection command This maps to SLQSOMADMSendSelection2

Parameters
pCtx[out]
pReqBuf[in,out]
  • Buffer for packed QMI command to be provided by the host application
  • Minimum expected size is 2048 bytes
pLen[in,out]
  • On input, size of pReqBuf
  • On ouptut, number of bytes actually packed
reqParam[in]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
int pack_swioma_SLQSOMADMSetSettings ( pack_qmi_t pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen,
pack_swioma_SLQSOMADMSetSettings_t  reqParam 
)

Function to pack OMA-DM set settings command This maps to SLQSOMADMSetSettings3

Parameters
pCtx[out]
pReqBuf[in,out]
  • Buffer for packed QMI command to be provided by the host application
  • Minimum expected size is 2048 bytes
pLen[in,out]
  • On input, size of pReqBuf
  • On ouptut, number of bytes actually packed
reqParam[in]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
int pack_swioma_SLQSOMADMStartSession ( pack_qmi_t pCtx,
uint8_t *  pReqBuf,
uint16_t *  pLen,
pack_swioma_SLQSOMADMStartSession_t  reqParam 
)

Function to pack Start OMA-DM session command This maps to SLQSOMADMStartSession2

Parameters
pCtx[out]
pReqBuf[in,out]
  • Buffer for packed QMI command to be provided by the host application
  • Minimum expected size is 2048 bytes
pLen[in,out]
  • On input, size of pReqBuf
  • On ouptut, number of bytes actually packed
reqParam[in]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
int unpack_swioma_SLQSOMADMAlertCallback ( uint8_t *  pResp,
uint16_t  respLen,
unpack_swioma_SLQSOMADMAlertCallback_t pOutput 
)

Function to unpack response of QMI command to enable the SWIOMADM network-initiated alert callback function. This maps to SetSLQSOMADMAlertCallback

Parameters
pResp[in]
  • Response from modem
respLen[in]
  • Length of pResp from modem
pOutput[out]
  • response unpacked
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
  • Please use eQMI_SWIOMA_EVENT_IND indication to identify this event from SWIOMA service read function
int unpack_swioma_SLQSOMADMAlertCallback_ind ( uint8_t *  pResp,
uint16_t  respLen,
unpack_swioma_SLQSOMADMAlertCallback_ind_t pOutput 
)

Function to unpack SWIOMADM alert indications This maps to SetSLQSOMADMAlertCallback

Parameters
pResp[in]
  • Response from modem
respLen[in]
  • Length of pResp from modem
pOutput[out]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
int unpack_swioma_SLQSOMADMCancelSession ( uint8_t *  pResp,
uint16_t  respLen,
unpack_swioma_SLQSOMADMCancelSession_t pOutput 
)

Function to pack cancel OMA-DM session command This maps to SLQSOMADMCancelSession

Parameters
pResp[in]
  • Response from modem
respLen[in]
  • Length of pResp from modem
pOutput[out]
  • response unpacked
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
int unpack_swioma_SLQSOMADMGetSessionInfo ( uint8_t *  pResp,
uint16_t  respLen,
unpack_swioma_SLQSOMADMGetSessionInfo_t pOutput 
)

Function to unpack information related to the current (or previous if no session is active) OMA-DM session. This maps to SLQSOMADMGetSessionInfo

Parameters
pResp[in]
  • Response from modem
respLen[in]
  • Length of pResp from modem
pOutput[out]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
int unpack_swioma_SLQSOMADMGetSettings ( uint8_t *  pResp,
uint16_t  respLen,
unpack_swioma_SLQSOMADMGetSettings_t pOutput 
)

Function to unpack OMA-DM get settings response from modem This maps to SLQSOMADMGetSettings2

Parameters
pResp[in]
  • Response from modem
respLen[in]
  • Length of pResp from modem
pOutput[out]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
int unpack_swioma_SLQSOMADMSendSelection ( uint8_t *  pResp,
uint16_t  respLen,
unpack_swioma_SLQSOMADMSendSelection_t pOutput 
)

Function to unpack OMA-DM send selection command This maps to SLQSOMADMSendSelection2

Parameters
pResp[in]
  • Response from modem
respLen[in]
  • Length of pResp from modem
pOutput[out]
  • response unpacked
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
int unpack_swioma_SLQSOMADMSetSettings ( uint8_t *  pResp,
uint16_t  respLen,
unpack_swioma_SLQSOMADMSetSettings_t pOutput 
)

Function to unpack OMA-DM set settings command This maps to SLQSOMADMSetSettings3

Parameters
pResp[in]
  • Response from modem
respLen[in]
  • Length of pResp from modem
pOutput[out]
  • response unpacked
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
int unpack_swioma_SLQSOMADMStartSession ( uint8_t *  pResp,
uint16_t  respLen,
unpack_swioma_SLQSOMADMStartSession_t pOutput 
)

Function to unpack Start OMA-DM session response from modem This maps to SLQSOMADMStartSession2

Parameters
pResp[in]
  • Response from modem
respLen[in]
  • Length of pResp from modem
pOutput[out]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values

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