common.h

Go to the documentation of this file.

#ifndef __COMMON_H
#define __COMMON_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#define SDU_HDR_LEN (3)
#define MINREQBKLEN (2048)
#define MSGID_AND_LEN    (4)
#define MSGID_DONT_CARE (0xffff)

#ifndef UNUSEDPARAM
#define UNUSEDPARAM( x ) (void)x
#endif 

#define DEAULT_LOC_TIMEOUT_IN_SEC 2
#define SDK_VALIDATE_INPUT_PACK_PARAM(pCtx, pBuf, pLen ) \
    if ((pCtx == NULL) || (pBuf == NULL) || (pLen == NULL) ) \
        {\
        liteqmi_log(eLOG_DEBUG,"[  pack] %s parameter NULL\n",__func__); \
        return eQCWWAN_ERR_INVALID_ARG; \
        }

#define SDK_VALIDATE_INPUT_PACK_PARAM_AND_FILL_XID(pCtx, pBuf, pLen ) \
    if ((pCtx == NULL) || (pBuf == NULL) || (pLen == NULL) ) \
        {\
        liteqmi_log(eLOG_DEBUG,"[  pack] %s parameter NULL\n",__func__); \
        return eQCWWAN_ERR_INVALID_ARG; \
        } \
    if (pCtx->xid == 0) \
       return eQCWWAN_ERR_INVALID_XID; \
    pBuf[0] = eREQ; \
    pBuf[1] = pCtx->xid & 0xff; \
    pBuf[2] = pCtx->xid >> 8;

#define SDK_VALIDATE_INPUT_UNPACK_PARAM(pResp, respLen, pOutput ) \
    if ((pResp == NULL) || (respLen == 0) || (pOutput == NULL) ) \
        {\
        liteqmi_log(eLOG_DEBUG,"[ unpack] %s parameter NULL or invalid\n",__func__); \
        return eQCWWAN_ERR_INVALID_ARG; \
        }

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

extern logger glog;
extern uint8_t gloglvl;

enum eLOG_LEVEL{
    eLOG_INFO,
    eLOG_DEBUG,
    eLOG_WARN,
    eLOG_FATAL
};

enum eTimeout
{
    eTIMEOUT_2_S        = 2000,
    eTIMEOUT_5_S        = 5000,
    eTIMEOUT_8_S        = 8000,
    eTIMEOUT_10_S       = 10000,
    eTIMEOUT_20_S       = 20000,
    eTIMEOUT_30_S       = 30000,
    eTIMEOUT_60_S       = 60000,
    eTIMEOUT_300_S      = 300000,
    eTIMEOUT_DEFAULT    = eTIMEOUT_8_S
};

enum eQMI_SVC{
    eCTL,
    eWDS,
    eDMS,
    eNAS=3,
    eQOS,
    eSMS=5,
    ePDS=0x06,
    eVOICE=0x09,
    eCAT=0x0A,
    eUIM=0x0B,
    eLOC=0x10,
    eSAR=0x11,
    eIMS=0x12,    // 012 IMS Service
    eTMD=0x18,
    eIMSA=0x21,
    eRMS=225,
    eSWIOMA=240,
    eAUDIO=241,
    eSWIM2MCMD=243,     // 0xF3 SWI M2M general commands
    eSWIM2MCMD_AVC2=0xfd,     // 0xFD SWI M2M general commands
    eSWIOMAEXT=244,
    eSWIAUDIO= 245,     // 245 Swi Audio service
    eSWILOC=246,
};

enum msgtype{
    eREQ=0,
    eRSP=2,
    eIND=4
};

typedef struct{
    uint16_t    xid;
    int         timeout;
    uint16_t    msgid;
    uint8_t     svc;
} pack_qmi_t;

typedef struct{
    enum msgtype    type;
    uint16_t        msgid;
    uint16_t        xid;
} unpack_qmi_t;

uint16_t helper_get_xid(uint8_t *qmi_resp);

uint16_t helper_get_error_code(uint8_t *qmi_resp);
char* helper_get_error_reason(uint16_t retVal);

const char* helper_get_resp_ctx(
        uint8_t svc,
        uint8_t *pbuf,
        uint32_t len,
        unpack_qmi_t *pCtx
        );

unsigned unpack_result_code_only(
        uint8_t  *pMdmResp);

int helper_set_log_func(logger func);

void liteqmi_log(
        uint8_t lvl,
        const char* fmt, ...
        );

int helper_set_log_lvl(uint8_t lvl);

//internal helper for pack/unpack function
void fill_sdu_hdr(
        pack_qmi_t *pCtx,
        uint8_t *pReqBuf
        );

void fill_pack_ctx(
        pack_qmi_t *pCtx,
        uint8_t *pReqBuf,
        uint16_t *pLen,
        uint8_t svc,
        int timeout
        );
char* get_version();

char* liteqmi_GetVersion();

void liteqmi_helper_decode7bitAsciiEncString(
        uint8_t *encoded_str,
        uint8_t encoded_len,
        uint8_t *decoded_str
        );

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

#endif