SwiApiCmBasic.h

Go to the documentation of this file.

#ifndef __SWIAPI_CM
#define __SWIAPI_CM

#ifdef __cplusplus
extern "C" {
#endif

/* include files */
#include "SwiDataTypes.h"
#include "SwiRcodes.h"


/* defines */
#define LENGTH_MaxPPPString                 33
#define LENGTH_IPAddress                    16
#define LENGTH_LogFileName                 128
#define LENGTH_SdkPathName                 128
#define LENGTH_CommPort                      7
#define LENGTH_UsbdVersion                  85
#define LENGTH_UsbdBuildDate                 9
#define LENGTH_BootBuildDate                 9
#define NUMVALUE_WIMAX                   80216
#define MAX_NOTIF_LIST                     122
#define LENGTH_DriverName                  100
#define LENGTH_MacAddress                    6
#define LENGTH_ProductName                  20
#define LENGTH_ModemName                    75
#define LENGTH_HardwareId                   50
#define MAX_NUM_LBS_SV                      12
#define LENGTH_TimeStamp                    16
#define MAX_BAND_GROUPS                     50
#define MAX_BAND_LIST                       50
#define MAX_AIR_SERVERS                     50  /* Must be < than a frame. */
#define LENGTH_ProductStr                   16
#define MAX_OBJRNGINFOBLOCKS                35
#define LENGTH_PortName                     80

/* enum declarations */

enum SWI_TYPE_Device
{
      SWI_DEVICE_None         = 0,  
      /* PC Cards */
      SWI_DEVICE_AC550,             
      SWI_DEVICE_AC575,             
      SWI_DEVICE_AC580,             
      SWI_DEVICE_AC595,             
      SWI_DEVICE_AC597,             
      SWI_DEVICE_AC710  = 100,      
      SWI_DEVICE_AC750,             
      SWI_DEVICE_AC775,             
      SWI_DEVICE_AC850,             
      SWI_DEVICE_AC860,             
      SWI_DEVICE_AC875,             
      SWI_DEVICE_AC880,             
      SWI_DEVICE_AC881,             
      /* Embedded Modules */
      SWI_DEVICE_MC5720 = 200,      
      SWI_DEVICE_MC5725,            
      SWI_DEVICE_MC5727,            
      SWI_DEVICE_MC5728,            
      SWI_DEVICE_SL501X,            
      SWI_DEVICE_MC8755 = 300,      
      SWI_DEVICE_MC8765,            
      SWI_DEVICE_MC8775,            
      SWI_DEVICE_MC8780,            
      SWI_DEVICE_MC8781,            
      SWI_DEVICE_MC8785,            
      SWI_DEVICE_MC8790,            
      SWI_DEVICE_MC8791,            
      SWI_DEVICE_MC8700,            
      SWI_DEVICE_MC8704,            
      SWI_DEVICE_MC8705,            
      SWI_DEVICE_MC8777,            
      SWI_DEVICE_MC8790V,           
      SWI_DEVICE_MC8801,            
      SWI_DEVICE_SL8080,            
      SWI_DEVICE_SL8081,            
      SWI_DEVICE_SL8082,            
      SWI_DEVICE_SL8083,            
      SWI_DEVICE_SL8084,            
      SWI_DEVICE_SL8085,            
      SWI_DEVICE_SL8090,            
      SWI_DEVICE_SL8091,            
      SWI_DEVICE_SL8092,            
      SWI_DEVICE_SL8093,            
      SWI_DEVICE_EM5625 = 400,      
      SWI_DEVICE_EM5725,            
      SWI_DEVICE_EM8780 = 500,      
      SWI_DEVICE_EM8781,            
      SWI_DEVICE_M81A,              
      SWI_DEVICE_M81B,              
      /* MP */
      SWI_DEVICE_MP555  = 600,      
      SWI_DEVICE_MP595,             
      SWI_DEVICE_MP750  = 700,      
      SWI_DEVICE_MP775,             
      SWI_DEVICE_MP875,             
      SWI_DEVICE_MP880,             
      SWI_DEVICE_MP881,             
      /* ExpressCards */
      SWI_DEVICE_AC597E = 1000,     
      SWI_DEVICE_AC598E,            
      SWI_DEVICE_AC875E = 1100,     
      SWI_DEVICE_AC880E,            
      SWI_DEVICE_AC881E,            
      SWI_DEVICE_AC885E,            
      SWI_DEVICE_AC886E,            
      /* USB Modems */
      SWI_DEVICE_AC595U = 1200,     
      SWI_DEVICE_T598,              
      SWI_DEVICE_T11,               
      SWI_DEVICE_AC802,             
      SWI_DEVICE_AC875U = 1300,     
      SWI_DEVICE_AC880U,            
      SWI_DEVICE_AC881U,            
      SWI_DEVICE_C885,              
      SWI_DEVICE_C886,              
      SWI_DEVICE_C888,              
      SWI_DEVICE_C889,              
      SWI_DEVICE_K888,              
      SWI_DEVICE_K889,              
      SWI_DEVICE_C22,               
      SWI_DEVICE_C23,               
      SWI_DEVICE_K22,               
      SWI_DEVICE_K23,               
      SWI_DEVICE_USB303,            
      SWI_DEVICE_USB304,            
      SWI_DEVICE_USB305,            
      SWI_DEVICE_USB306,            
      SWI_DEVICE_USB307,            
      SWI_DEVICE_USB308,            
      SWI_DEVICE_CHspa  = 1399,     
      /* Mass Storage */
      SWI_DEVICE_MassStorage  = 2000,   
      /* Other - This value is used for determining if a Product string is
       * provide instead of the usual Device type for newer modems using 
       * unified VID/PID. The API will translate the string to a device type.
       */
      SWI_DEVICE_UNIFIEDPID         
};

/* structure declarations */

struct SWI_STRUCT_Logging
{
    swi_uint32     sizeStruct;

    swi_char  szFileName[LENGTH_LogFileName];

    swi_bool           bEnable;
};

struct SWI_STRUCT_SdkPath
{
    swi_uint32     sizeStruct;

    swi_char  szSdkPath[LENGTH_SdkPathName];

    swi_bool           bEnable;
};

struct SWI_STRUCT_ApiStartup
{
 
    swi_uint32                    sizeStruct;
 
    struct SWI_STRUCT_Logging     sLogging;

    struct SWI_STRUCT_SdkPath     sSdkPath;
};


struct SWI_STRUCT_UsbdInfo
{
    swi_uint32 sizeStruct;

    swi_char szVersion[LENGTH_UsbdVersion];

    swi_char szBuildDate[LENGTH_UsbdBuildDate];
};

struct SWI_STRUCT_PriInfo
{
    swi_uint32  sizeStruct;

    swi_uint32  nMajorVer;

    swi_uint32  nMinorVer;

    swi_uint32 nSubMinorVer;

    swi_uint32 nSubOemVer;

    swi_uint32 nSkuId;
};

struct SWI_STRUCT_ModemType
{
    swi_uint32 sizeStruct;          

    swi_uint16 nModemType;

    swi_uint32 nWirelessTech;

    swi_char szProductName[LENGTH_ProductStr];
};

enum SWI_TYPE_WirelessTech
{
    SWI_WIRELESSTECH_Unknown,
    SWI_WIRELESSTECH_Cdma,
    SWI_WIRELESSTECH_Gsm,
    SWI_WIRELESSTECH_Wifi,
    SWI_WIRELESSTECH_Wimax
};

enum SWI_TYPE_ProductClass
{
    SWI_PRODUCTCLASS_Unknown,
    SWI_PRODUCTCLASS_PcCard,
    SWI_PRODUCTCLASS_Embedded,
    SWI_PRODUCTCLASS_Mp
};

struct SWI_STRUCT_AirServer
{
    swi_uint32 sizeStruct;     

    swi_uint8 ClientMac[LENGTH_MacAddress];   

    swi_uint8  ServerMac[LENGTH_MacAddress];   

    enum SWI_TYPE_Device eDevice;    
};

struct SWI_STRUCT_AirServerExtended
{
    swi_uint32 sizeStruct;

    swi_char szProductName[LENGTH_ProductName];

    enum SWI_TYPE_ProductClass   eProductClass;

    enum SWI_TYPE_WirelessTech eWirelessTech;
        
    swi_char szModemName[LENGTH_ModemName];
    
    swi_char szHardwareId[LENGTH_HardwareId];
};

struct SWI_STRUCT_AirServerList
{
    swi_uint32                     sizeStruct;

    swi_uint32                     nNumber;

    struct SWI_STRUCT_AirServer    AirServers[MAX_AIR_SERVERS];
};

struct SWI_STRUCT_AirServerChange
{
    swi_uint32                  sizeStruct;                    

    struct SWI_STRUCT_AirServer AirServer;

    swi_bool                    bInsert;
};

enum SWI_TYPE_DeviceInformationType
{    
    SWI_DEVICEINFORMATION_Technology = 1, 
    SWI_DEVICEINFORMATION_Product,        
    SWI_DEVICEINFORMATION_FrmDwlProtocol, 
    SWI_DEVICEINFORMATION_DeviceReEnum,    
    SWI_DEVICEINFORMATION_CNSsupported    
};

enum SWI_TYPE_RequestStatus
{    
    SWI_REQUESTSTATUS_SUCCESS,
    SWI_REQUESTSTATUS_UnknownType,
    SWI_REQUESTSTATUS_GenFailure
};

enum SWI_TYPE_Technology
{    
    SWI_TECHNOLOGY_Unknown,
    SWI_TECHNOLOGY_CDMA,
    SWI_TECHNOLOGY_GSM
};

enum SWI_TYPE_FrmDlwProtocol
{
    SWI_FRMDLWPROTOCOL_One,

    SWI_FRMDLWPROTOCOL_Two  
};

enum SWI_TYPE_DeviceReEnum
{
    SWI_DEVICEREENUM_Trigger_Remove,

    SWI_DEVICEREENUM_Trigger_NoRemove
};
enum SWI_TYPE_CNSsupported
{
    SWI_CNSSUPPORTED_Yes,

    SWI_CNSSUPPORTED_No
};
struct SWI_STRUCT_DeviceInformation_Request
{   
    swi_uint32                          sizeStruct;
    swi_uint32                          Version;
    enum SWI_TYPE_DeviceInformationType eDeviceInformationType; 
};

struct SWI_STRUCT_DeviceInformation_Response
{   
    swi_uint32                          sizeStruct;
    swi_uint32                          Version;

    enum SWI_TYPE_RequestStatus         eRequestStatus;

    enum SWI_TYPE_DeviceInformationType eDeviceInformationType;
    swi_uint32                          nLength;

    enum SWI_TYPE_Technology            eTechnology;

    swi_char                            szProduct[LENGTH_ProductStr];

    enum SWI_TYPE_FrmDlwProtocol        eFrmDlwProtocol;
    enum SWI_TYPE_DeviceReEnum          eDeviceReEnum;

    enum SWI_TYPE_CNSsupported          eCNSsupported;
};

struct SWI_STRUCT_HeartBeat
{
    swi_uint32    sizeStruct;            
   
};

enum SWI_TYPE_Month
{
    SWI_MONTH_Jan   = 0x01, 
    SWI_MONTH_Feb,          
    SWI_MONTH_Mar,          
    SWI_MONTH_Apr,          
    SWI_MONTH_May,          
    SWI_MONTH_Jun,          
    SWI_MONTH_Jul,          
    SWI_MONTH_Aug,          
    SWI_MONTH_Sep,          
    SWI_MONTH_Oct,          
    SWI_MONTH_Nov,          
    SWI_MONTH_Dec           
};

enum SWI_TYPE_WeekDay
{
    SWI_WEEKDAY_Mon,    
    SWI_WEEKDAY_Tue,    
    SWI_WEEKDAY_Wed,    
    SWI_WEEKDAY_Thu,    
    SWI_WEEKDAY_Fri,    
    SWI_WEEKDAY_Sat,    
    SWI_WEEKDAY_Sun     
};

enum SWI_TYPE_DaylightSavings
{
    SWI_DAYLIGHTSAVINGS_None,           
    SWI_DAYLIGHTSAVINGS_PlusOneHour,    
    SWI_DAYLIGHTSAVINGS_PlusTwoHour     
};

struct SWI_STRUCT_DeviceTime
{
    swi_uint32 sizeStruct;
    
    swi_uint32 nYear;
    
    enum SWI_TYPE_Month eMonth;
    
    swi_uint32 nDay;
    
    enum SWI_TYPE_WeekDay eWeekDay;

    swi_uint32 nHour;

    swi_uint32 nMinute;

    swi_uint32 nSecond;

    swi_int32 nTimeZone;

    enum SWI_TYPE_DaylightSavings eDaylightSavings;
};

#define LENGTH_ImgInfoVer       85  
#define LENGTH_ImgInfoRelDate   9   
#define LENGTH_ImgInfoProdType  5   
#define LENGTH_ImgInfoImgType   5   
typedef enum 
{
    FLASHIMGINFORESULT_Success,             
    FLASHIMGINFORESULT_UnsupportedImgType,  
    FLASHIMGINFORESULT_ImgNotFound         
} TYPE_FlashImgInfo_Result;

struct SWI_STRUCT_FlashImgInfo
{
    swi_int32   sizeStruct;
    
    swi_char szImageType[LENGTH_ImgInfoImgType];
    
    TYPE_FlashImgInfo_Result eResult;
    
    swi_char szVersion[LENGTH_ImgInfoVer];
    
    swi_char szRelDate[LENGTH_ImgInfoRelDate];
    
    swi_char szProdType[LENGTH_ImgInfoProdType];
    
    swi_int32   nImgSize;
};

enum SWI_TYPE_ObjIdRngSpecifier
{
    OBJIDRNGSPECIFIER_Cwe,      
    OBJIDRNGSPECIFIER_CweLbs,   
    OBJIDRNGSPECIFIER_Gprs,     
    OBJIDRNGSPECIFIER_Cdma,     
    OBJIDRNGSPECIFIER_Mp,       
    OBJIDRNGSPECIFIER_Umts,     
    OBJIDRNGSPECIFIER_CweDm     
};
struct SWI_STRUCT_OBJRNGREV_InfoBlock
{
    swi_int32 sizeStuct;
    
    enum SWI_TYPE_ObjIdRngSpecifier eRngSpecifier;
    
    swi_int32 nModemReverseObjRevNum;
    
    swi_int32 nModemForwardObjRevNum;
    
    swi_int32 nApiObjRevNum;
};

struct SWI_STRUCT_ObjRngRev
{
    swi_int32 sizeStruct;     
    
    swi_int32 NumOfEntries;
    
    struct SWI_STRUCT_OBJRNGREV_InfoBlock arInfoBlock[MAX_OBJRNGINFOBLOCKS];
};

enum SWI_TYPE_RadioPowerMode
{
    SWI_RADIOPOWERMODE_Low,     
    SWI_RADIOPOWERMODE_Online  
};

enum SWI_TYPE_RadioPowerReason
{
    SWI_RADIOPOWERREASON_WDISABLE = 0x0001,

    SWI_RADIOPOWERREASON_UserRequest = 0x0002,

    SWI_RADIOPOWERREASON_Temperature = 0x0004,

    SWI_RADIOPOWERREASON_Battery = 0x0008
};

enum SWI_TYPE_ModuleReqReason
{
    SWI_MODULEREQREASON_NoReason,

    SWI_MODULEREQREASON_Temperature,

    SWI_MODULEREQREASON_Battery,

    SWI_MODULEREQREASON_Network,

    SWI_MODULEREQREASON_Other
};

struct SWI_STRUCT_RadioPower
{
    swi_uint32 sizeStruct;

    enum SWI_TYPE_RadioPowerMode eMode;

    swi_uint32 nLowPowerReason;

    swi_bool bModuleReqPowerDown;
    
    enum SWI_TYPE_ModuleReqReason eRequestReason;
};

enum SWI_TYPE_RadioTempState
{
    SWI_RADIOTEMPSTATE_Normal,      
    SWI_RADIOTEMPSTATE_HighWarning, 
    SWI_RADIOTEMPSTATE_HighCrit,    
    SWI_RADIOTEMPSTATE_LowCrit     
};

struct SWI_STRUCT_RadioTempState
{
    swi_uint32 sizeStruct;
    
    enum SWI_TYPE_RadioTempState eState;
    
    swi_uint32 nCurrent;
};

enum SWI_TYPE_RadioBatteryState
{
    SWI_RADIOBATTERYSTATE_Normal,     
    SWI_RADIOBATTERYSTATE_LowWarning, 
    SWI_RADIOBATTERYSTATE_LowCrit,    
    SWI_RADIOBATTERYSTATE_HighCrit   
};

struct SWI_STRUCT_RadioBattery
{
    swi_uint32 sizeStruct;

    enum SWI_TYPE_RadioBatteryState eState;
    
    swi_uint32 nCurrent;
};
enum SWI_TYPE_RadioType
{
    SWI_RADIOTYPE_1xrtt,     
    SWI_RADIOTYPE_Evdo,      
    SWI_RADIOTYPE_GsmWcdma  
};

enum SWI_TYPE_RadioBand
{
    SWI_RADIOBAND_CdmaClass0 = 0x00,    
    SWI_RADIOBAND_CdmaClass1,           
    SWI_RADIOBAND_CdmaClass2,           
    SWI_RADIOBAND_CdmaClass3,           
    SWI_RADIOBAND_CdmaClass4,           
    SWI_RADIOBAND_CdmaClass5,           
    SWI_RADIOBAND_CdmaClass6,           
    SWI_RADIOBAND_CdmaClass7,           
    SWI_RADIOBAND_CdmaClass8,           
    SWI_RADIOBAND_CdmaClass9,           
    SWI_RADIOBAND_CdmaClass10,          
    SWI_RADIOBAND_CdmaClass11,          
    SWI_RADIOBAND_CdmaClass12,          
    SWI_RADIOBAND_Gsm450     = 0x28,    
    SWI_RADIOBAND_Gsm480,               
    SWI_RADIOBAND_Gsm750,               
    SWI_RADIOBAND_Gsm850,               
    SWI_RADIOBAND_GsmEGsm900,           
    SWI_RADIOBAND_GsmPGsm900,           
    SWI_RADIOBAND_GsmRGsm900,           
    SWI_RADIOBAND_GsmDcs1800,           
    SWI_RADIOBAND_GsmPcs1900,           
    SWI_RADIOBAND_WcdmaIImt2000 = 0x50, 
    SWI_RADIOBAND_WcdmaIIPcs1900,       
    SWI_RADIOBAND_WcdmaIIIDcs1800,      
    SWI_RADIOBAND_WcdmaIV1700,          
    SWI_RADIOBAND_WcdmaV850,            
    SWI_RADIOBAND_WcdmaVI800,           
    SWI_RADIOBAND_WcdmaVII2600,         
    SWI_RADIOBAND_WcdmaVIII900,         
    SWI_RADIOBAND_WcdmaIX1700,          
    SWI_RADIOBAND_Invalid      = 0xFF   
};

struct SWI_STRUCT_RadioBandInfo
{
    enum SWI_TYPE_RadioType eType;

    enum SWI_TYPE_RadioBand eBand;
};

struct SWI_STRUCT_RadioBandList
{
    swi_uint32 sizeStruct;

    swi_uint32 nNumBands;

    struct SWI_STRUCT_RadioBandInfo sList[MAX_BAND_LIST];   
};

#define SWI_RADIOBANDGROUP_CdmaClass0A    0x0000000000000001ull

#define SWI_RADIOBANDGROUP_CdmaClass0B    0x0000000000000002ull

#define SWI_RADIOBANDGROUP_CdmaClass0ABo  0x0000000000000003ull

#define SWI_RADIOBANDGROUP_CdmaClass1     0x0000000000000004ull

#define SWI_RADIOBANDGROUP_CdmaClass2     0x0000000000000008ull

#define SWI_RADIOBANDGROUP_CdmaClass3     0x0000000000000010ull

#define SWI_RADIOBANDGROUP_CdmaClass4     0x0000000000000020ull

#define SWI_RADIOBANDGROUP_CdmaClass5     0x0000000000000040ull

#define SWI_RADIOBANDGROUP_CdmaClass6     0x0000000000000080ull

#define SWI_RADIOBANDGROUP_CdmaClass7     0x0000000000000100ull

#define SWI_RADIOBANDGROUP_CdmaClass8     0x0000000000000200ull

#define SWI_RADIOBANDGROUP_CdmaClass9     0x0000000000000400ull

#define SWI_RADIOBANDGROUP_CdmaClass10    0x0000000000000800ull

#define SWI_RADIOBANDGROUP_CdmaClass11    0x0000000000001000ull

#define SWI_RADIOBANDGROUP_CdmaClass12    0x0000000000002000ull

#define SWI_RADIOBANDGROUP_CdmaPcsCellular   0x0000000000000007ull

#define SWI_RADIOBANDGROUP_Gsm450         0x0000000000010000ull

#define SWI_RADIOBANDGROUP_Gsm480         0x0000000000020000ull

#define SWI_RADIOBANDGROUP_Gsm750         0x0000000000040000ull

#define SWI_RADIOBANDGROUP_Gsm850         0x0000000000080000ull

#define SWI_RADIOBANDGROUP_GsmRGsm900     0x0000000000100000ull

#define SWI_RADIOBANDGROUP_GsmPcs1900     0x0000000000200000ull

#define SWI_RADIOBANDGROUP_GsmDcs1800     0x0000000000400000ull

#define SWI_RADIOBANDGROUP_GsmEGsm900     0x0000000000800000ull

#define SWI_RADIOBANDGROUP_GsmPGsm900     0x0000000001000000ull

#define SWI_RADIOBANDGROUP_GsmPcs850      0x0000000000280000ull

#define SWI_RADIOBANDGROUP_GsmEGsmDcs     0x0000000001C00000ull

#define SWI_RADIOBANDGROUP_GsmAll         0x0000000001E80000ull

#define SWI_RADIOBANDGROUP_WcdmaIImt2000  0x0000000100000000ull

#define SWI_RADIOBANDGROUP_WcdmaIIPcs1900   0x0000000200000000ull

#define SWI_RADIOBANDGROUP_WcdmaIII1700   0x0000000400000000ull

#define SWI_RADIOBANDGROUP_WcdmaIV1700    0x0000000800000000ull

#define SWI_RADIOBANDGROUP_WcdmaV850      0x0000001000000000ull

#define SWI_RADIOBANDGROUP_WcdmaVI800     0x0000002000000000ull

#define SWI_RADIOBANDGROUP_WcdmaVII2600   0x0000004000000000ull

#define SWI_RADIOBANDGROUP_WcdmaVIII900   0x0000008000000000ull

#define SWI_RADIOBANDGROUP_WcdmaEu     0x0000008100000000ull

#define SWI_RADIOBANDGROUP_WcdmaIX1700    0x0000010000000000ull

#define SWI_RADIOBANDGROUP_WcdmaNa        0x0000001200000000ull

#define SWI_RADIOBANDGROUP_WcdmaGsmEu     0x0000000101C00000ull

#define SWI_RADIOBANDGROUP_WcdmaGsmNa     0x0000001200280000ull

#define SWI_RADIOBANDGROUP_WcdmaAustralia   0x0000001100000000ull

#define SWI_RADIOBANDGROUP_WcdmaAustrailiaGsmEu    0x0000001101C00000ull

#define SWI_RADIOBANDGROUP_WcdmaJapan     0x0000002100000000ull

#define SWI_RADIOBANDGROUP_WcdmaAll_EarlyMC8700    0x0000001300000000ull

#define SWI_RADIOBANDGROUP_WcdmaAll_AC503_MC8700    0x000000b300000000ull

#define SWI_RADIOBANDGROUP_AutoBand       0xFFFFFFFFFFFFFFFFull

struct SWI_STRUCT_RadioBandConfig
{
    swi_uint32 sizeStruct;
    
    swi_uint64 nLastSelected;

    swi_uint32 nNumInGroup;

    swi_uint64 arBandSetting[MAX_BAND_GROUPS];
};

struct SWI_STRUCT_UsbPortName
{
    swi_uint32 sizeStruct;     

    swi_uint8  HipPort[LENGTH_PortName];
     
    swi_uint8  DiagPort[LENGTH_PortName];
     
    swi_uint8  NmeaPort[LENGTH_PortName];
     
    swi_uint8  AtCmdPort[LENGTH_PortName];
     
    swi_uint8  Data1Port[LENGTH_PortName];
     
    swi_uint8  Data2Port[LENGTH_PortName];
     
    swi_uint8  Data3Port[LENGTH_PortName];
    
    swi_uint8  DirectIPPort[LENGTH_PortName];
    
    swi_uint8  QMIPort[LENGTH_PortName];
    
    swi_uint8  MassStoragePort[LENGTH_PortName];
};

#define SWI_FILENAME_LEN                    8
#if defined(CNS_FILENAME_LEN) && SWI_FILENAME_LEN != CNS_FILENAME_LEN
#error CNS and SWI definition mismatch
#endif

#define SWI_API_UNLOCK_PWD_LEN              10
#if defined(CNS_API_UNLOCK_PWD_LEN) && \
    SWI_API_UNLOCK_PWD_LEN != CNS_API_UNLOCK_PWD_LEN
#error CNS and SWI definition mismatch
#endif

typedef enum eUpdateFromFileStatus
{
    FILE_UPDATE_SUCCESS,    
    FILE_NOT_FOUND,         
    FILE_INCORRECT_SIZE,    
    FILE_INCORRECT_HEADER,  
    FILE_INVALID_REVISION  
}UpdateFromFileStatus;

typedef struct SWI_STRUCT_NVUpdateFromFile
{
    swi_uint32 sizeStruct;        
    swi_uint8 szFileName[SWI_FILENAME_LEN];
    
    UpdateFromFileStatus nStatus;       
    swi_uint32 nItemsUpdated;           
    swi_uint32 nItemsSipped;            
}SWI_STRUCT_NVUpdateFromFile;

typedef enum eApiUnlockLevel
{
    API_UNLOCK_OEM,     
    API_UNLOCK_SWI     
}ApiUnlockLevel;

typedef enum eApiUnlockResult
{
    API_UNLOCK_SUCCESS,     
    API_UNLOCK_PWD_INVALID 
}ApiUnlockResult;

typedef struct SWI_STRUCT_ApiUnlock
{
    swi_uint32 sizeStruct;

    ApiUnlockLevel nLevel;      
    swi_uint8 nPasswordLen;     
    swi_uint8 szPassword[SWI_API_UNLOCK_PWD_LEN];   
    ApiUnlockResult nResult;    
}SWI_STRUCT_ApiUnlock;

typedef enum SWI_TYPE_RDA_SUPPORT_STATUS
{
    RDA_STATUS_NOT_SUPPORTED  = 0,  
    RDA_STATUS_DISABLED       = 1,  
    RDA_STATUS_ENABLED        = 2   
}SWI_TYPE_RDA_SUPPORT_STATUS;

#define SWI_RDA_NAME_MAX        69  
#define SWI_RDA_VERSION_MAX     32  
typedef struct SWI_STRUCT_RDA_SUPPORT
{
    swi_uint32 sizeStruct;

    swi_uint8  nRDASupport;         
    swi_uint8  nNameLength;                     
    swi_uint8  Name[SWI_RDA_NAME_MAX];          
    swi_uint8  nVersionLength;                  
    swi_uint8  Version[SWI_RDA_VERSION_MAX];    
}SWI_STRUCT_RDA_SUPPORT;

typedef enum SWI_TYPE_REMOVABLE_MEDIA
{
    REMOVABLE_MEDIA_MINI_SD   = 0x0001,     
    REMOVABLE_MEDIA_MICRO_SD  = 0x0002     
}SWI_TYPE_REMOVABLE_MEDIA;

typedef struct SWI_STRUCT_RM_CONFIG
{
    swi_uint32 sizeStruct;
    
    swi_uint16 nFeatureSupportMask;

    swi_uint16 nFeatureEnableMask;
}SWI_STRUCT_RM_CONFIG;

typedef struct SWI_STRUCT_RM_CONFIG_SET
{
    swi_uint32 sizeStruct;

    swi_uint16 nRMFeature;

    swi_uint8  bEnable;
}SWI_STRUCT_RM_CONFIG_SET;

struct SWI_STRUCT_GetSwocCfg
{
    swi_uint32 sizeStruct;

    swi_uint16 FeatureSupport;

    swi_uint16 FeatureState;

    swi_uint16 FeatureCap;

    swi_uint16 LockReq;
};

/* Function prototypes */
extern SWI_API SWI_RCODE SwiApiStartup(
    struct SWI_STRUCT_ApiStartup *pOpenParams);

extern SWI_API SWI_RCODE SwiTerminateSDK( void );

extern SWI_API SWI_RCODE SwiGetFirmwareVersion(
    swi_charp szFWVersion, 
    swi_uint32 sizeBuffer, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetFirmwareBuildDate(
    swi_charp szBuildDate, 
    swi_uint32 sizeBuffer, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetHardwareVersion(
    swi_charp szHWVersion, 
    swi_uint32 sizeBuffer, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetBootVersion(
    swi_charp szBVVersion, 
    swi_uint32 sizeBuffer, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetBootloaderBuildDate(
    swi_charp szBLBldDate, 
    swi_uint32 *nLength, 
    swi_uint32 Timeout);

extern SWI_API SWI_RCODE SwiGetRadioPower(
    struct SWI_STRUCT_RadioPower *pRadioPower, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiSetRadioPower(
    struct SWI_STRUCT_RadioPower* pRadioPower, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetRadioTempState(
    struct SWI_STRUCT_RadioTempState *pRadioTemp,
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetRadioBattery(
    struct SWI_STRUCT_RadioBattery *pRadioBattery,
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetCurrentRadioBand(
    struct SWI_STRUCT_RadioBandList *pRadioBand, 
    swi_int32  timeout);

extern SWI_API SWI_RCODE SwiGetRadioBandCfg(
    struct SWI_STRUCT_RadioBandConfig *pRadioBand, 
    swi_int32  timeout);

extern SWI_API SWI_RCODE SwiSetRadioBandCfg(
    swi_uint64 nRadioBandGroup, 
    swi_int32  timeout);

extern SWI_API SWI_RCODE SwiGetUsbdInfo(
    struct SWI_STRUCT_UsbdInfo* pUsbdInfo, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetPriInfo(
    struct SWI_STRUCT_PriInfo* pPriInfo, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetModemType(
    struct SWI_STRUCT_ModemType* pSwiModemType,
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetDeviceTime(
    struct SWI_STRUCT_DeviceTime* pDeviceTime,
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetDeviceID(
    swi_charp pszDeviceID,
    swi_uint32 sizeBuffer,
    swi_uint32  timeout);

extern SWI_API SWI_RCODE SwiGetFlashImgInfo(
    struct SWI_STRUCT_FlashImgInfo* pFlashImgInfo, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetObjRngRev(
    struct SWI_STRUCT_ObjRngRev *ObjRngRevp, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetAvailAirServers(
    struct SWI_STRUCT_AirServerList *sList);

extern SWI_API SWI_RCODE SwiGetBootAndHoldMode(
    swi_bool *pbootnhold, swi_uint32 timeout );
    
extern SWI_API void SwiGetLastError(
    swi_char *szError, 
    swi_uint32 sizeBuffer);

extern SWI_API SWI_RCODE SwiGetUsbPortName(
    struct SWI_STRUCT_UsbPortName *sPortNamep);

extern SWI_API SWI_RCODE SwiNVUpdateFromFile(
            SWI_STRUCT_NVUpdateFromFile *pNVUpdateFromFile, 
            swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiApiUnlock(SWI_STRUCT_ApiUnlock *pApiUnlock, 
                               swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetRemoteDiagAgentSupport(
        SWI_STRUCT_RDA_SUPPORT *psRDA, 
        swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiSetRemoteDiagAgentEnable(swi_uint8 bEnable, 
                                              swi_uint8 *pStatus, 
                                              swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetRemovableMediaSupport(
        SWI_STRUCT_RM_CONFIG *psRM, 
        swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiSetRemovableMediaSupport(
        const SWI_STRUCT_RM_CONFIG_SET *psRM, 
        swi_uint8 *pStatus, 
        swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiSoftModemReset(void);

extern SWI_API SWI_RCODE SwiResetToBootHold( swi_uint32 timeout );

extern SWI_API SWI_RCODE SwiGetSdkVersion(swi_charp *sdkversionpp);

extern SWI_API SWI_RCODE SwiGetDeviceInformation(
    struct SWI_STRUCT_DeviceInformation_Request *sDeviceInformation_Requestp, 
    struct SWI_STRUCT_DeviceInformation_Response *sDeviceInformation_Responsep,
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetSwocCfg(
    struct SWI_STRUCT_GetSwocCfg* pSwocCfg,
    swi_uint32 timeout);

extern SWI_RCODE SwiIntSendnWaitUsbPortNameRequest(
    struct SWI_STRUCT_UsbPortName *sPortNamep );

extern void SwiUpkDeviceInformationResp(
    swi_uint8 *paramfieldp, 
    struct SWI_STRUCT_DeviceInformation_Response *pDeviceInfo );

extern void SwiUpkSwocCfg (
    swi_uint8 *paramfieldp,
    struct SWI_STRUCT_GetSwocCfg *pSwocCfg );

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

#endif /* __SWIAPI_CM */

/* 
 * $Log: SwiApiCmBasic.h,v $
 */