|
LinuxQMISDK
SLQS03.03.16
|
Network Access Service API function prototypes. More...
Go to the source code of this file.
Macros | |
| #define | SLQS_SS_INFO_LIST_MAX_ELEMENTS 18 |
| #define | MAX_DESCRIPTION_LENGTH 255 |
| #define | SLQS_SYSTEM_ID_SIZE 16 |
| #define | PLMN_LENGTH 3 |
| #define | MAX_SERV_SYSTEM_RADIO_INTERFACES 0x0A |
| #define | MAX_DATA_SRV_CAPABILITIES 0x20 |
| #define | NAM_NAME_LENGTH 12 |
| #define | IMSI_M_S1_LENGTH 7 |
| #define | IMSI_M_S2_LENGTH 3 |
| #define | MAX_PILOT_SETS 0xFF |
| #define | UATISIZE 16 |
| #define | NAS_SIG_INFO_MAX_TDSCDMA_THRESHOLDS_LIST_SIZE 16 |
| #define | NAS_SIG_INFO_MIN_dBm_FLOAT_VALUE -125.0 |
| #define | NAS_SIG_INFO_MIN_dB_FLOAT_VALUE -10.0 |
Typedefs | |
| typedef struct _SlqsNas3GppNetworkRAT_ | SlqsNas3GppNetworkRAT |
| typedef struct _slqsNetworkScanInfo | slqsNetworkScanInfo |
| typedef struct _sysSelectPrefParams | sysSelectPrefParams |
| typedef struct _sysSelectPrefInfo | sysSelectPrefInfo |
Enumerations | |
| enum | _NAMS_RADIO_IF_TECHNOLOGY_ { eNAS_RADIO_IF_GSM = 0x04, eNAS_RADIO_IF_UMTS = 0x05, eNAS_RADIO_IF_LTE = 0x08, eNAS_RADIO_IF_TDSCDMA = 0x09 } |
| enum | NAS_LTE_CPHY_SCELL_STATE { eNAS_LTE_CPHY_SCELL_STATE_DECONFIGURED =0x00, eNAS_LTE_CPHY_SCELL_STATE_CONFIGURED_DEACTIVATED =0x01, eNAS_LTE_CPHY_SCELL_STATE_CONFIGURED_ACTIVATED =0x02 } |
| enum | NAS_LTE_CPHY_CA_BW_NRB { eNAS_LTE_CPHY_CA_BW_NRB_6 =0x00, eNAS_LTE_CPHY_CA_BW_NRB_15 =0x01, eNAS_LTE_CPHY_CA_BW_NRB_25 =0x02, eNAS_LTE_CPHY_CA_BW_NRB_50 =0x03, eNAS_LTE_CPHY_CA_BW_NRB_75 =0x04, eNAS_LTE_CPHY_CA_BW_NRB_100 =0x05 } |
| enum | eSYS_SRV_DOMAIN { eSYS_SRV_DOMAIN_NO_SRV = 0x00, eSYS_SRV_DOMAIN_CS_ONLY = 0x01, eSYS_SRV_DOMAIN_PS_ONLY = 0x02, eSYS_SRV_DOMAIN_CS_PS = 0x03, eSYS_SRV_DOMAIN_CAMPED = 0x04, eSYS_SRV_DOMAIN_UNKNOWN } |
Network Access Service API function prototypes.
| #define IMSI_M_S1_LENGTH 7 |
| #define IMSI_M_S2_LENGTH 3 |
| #define MAX_DATA_SRV_CAPABILITIES 0x20 |
| #define MAX_DESCRIPTION_LENGTH 255 |
| #define MAX_PILOT_SETS 0xFF |
| #define MAX_SERV_SYSTEM_RADIO_INTERFACES 0x0A |
| #define NAM_NAME_LENGTH 12 |
| #define NAS_SIG_INFO_MAX_TDSCDMA_THRESHOLDS_LIST_SIZE 16 |
| #define NAS_SIG_INFO_MIN_dB_FLOAT_VALUE -10.0 |
| #define NAS_SIG_INFO_MIN_dBm_FLOAT_VALUE -125.0 |
| #define PLMN_LENGTH 3 |
| #define SLQS_SS_INFO_LIST_MAX_ELEMENTS 18 |
| #define SLQS_SYSTEM_ID_SIZE 16 |
| #define UATISIZE 16 |
| typedef struct _SlqsNas3GppNetworkRAT_ SlqsNas3GppNetworkRAT |
Contain the 3GPP radio access technology information.
| MCC |
|
| MNC |
|
| RAT |
|
| typedef struct _slqsNetworkScanInfo slqsNetworkScanInfo |
Contain the network scan information.
| pNetworkInfoInstances[IN/OUT] |
|
| pNetworkInfo[OUT] |
|
| pRATInstances[IN/OUT] |
|
| pRATInfo[OUT] |
|
| pPCSDigitInstances[IN/OUT] |
|
| pPCSDigitInfo[OUT] |
|
| pScanResult[OUT] |
|
| typedef struct _sysSelectPrefInfo sysSelectPrefInfo |
Structure for storing the current preferred system selection settings for the device.
| pEmerMode |
|
| pModePref |
|
| pBandPref |
|
| pPRLPref |
|
| pRoamPref |
|
| pLTEBandPref |
|
| pNetSelPref |
|
| pSrvDomainPref |
|
| pGWAcqOrderPref |
|
| typedef struct _sysSelectPrefParams sysSelectPrefParams |
Contain the system selection preferences.
| pEmerMode |
|
| pModePref |
|
| pBandPref |
|
| pPRLPref |
|
| pRoamPref |
|
| pLTEBandPref |
|
| pNetSelPref | - netSelectionPref
|
| pChgDuration |
|
| pMNCIncPCSDigStat |
|
| pSrvDomainPref |
|
| pGWAcqOrderPref |
|
| pRAT |
|
| enum eSYS_SRV_DOMAIN |
Retrieves information about the access overload class (ACCOLC)
| pACCOLC[OUT] |
|
AN-AAA authentication status of the device.
| pStatus[OUT] |
|
| ULONG GetCDMANetworkParameters | ( | BYTE * | pSCI, |
| BYTE * | pSCM, | ||
| BYTE * | pRegHomeSID, | ||
| BYTE * | pRegForeignSID, | ||
| BYTE * | pRegForeignNID, | ||
| BYTE * | pForceRev0, | ||
| BYTE * | pCustomSCP, | ||
| ULONG * | pProtocol, | ||
| ULONG * | pBroadcast, | ||
| ULONG * | pApplication, | ||
| ULONG * | pRoaming | ||
| ) |
Gets the current CDMA network parameters
| pSCI[OUT] |
|
| pSCM[OUT] |
|
| pRegHomeSID[OUT] |
|
| pRegForeignSID[OUT] |
|
| pRegForeignNID[OUT] |
|
| pForceRev0[OUT] |
|
| pCustomSCP[OUT] |
|
| pProtocol[OUT] |
|
| pBroadcast[OUT] |
|
| pApplication[OUT] |
|
| pRoaming[OUT] |
|
| ULONG GetHomeNetwork | ( | WORD * | pMCC, |
| WORD * | pMNC, | ||
| BYTE | nameSize, | ||
| CHAR * | pName, | ||
| WORD * | pSID, | ||
| WORD * | pNID | ||
| ) |
Retrieves information about the home network of the device. For 3GPP2 home network information use GetHomeNetwork3GPP2.
| pMCC[OUT] |
|
| pMNC[OUT] |
|
| nameSize |
|
| pName[OUT] |
|
| pSID[OUT] |
|
| pNID[OUT] |
|
| ULONG GetHomeNetwork3GPP2 | ( | WORD * | pMCC, |
| WORD * | pMNC, | ||
| BYTE | nameSize, | ||
| CHAR * | pName, | ||
| WORD * | pSID, | ||
| WORD * | pNID, | ||
| WORD * | pNw2MCC, | ||
| WORD * | pNw2MNC, | ||
| BYTE * | pNw2DescDisp, | ||
| BYTE * | pNw2DescEnc, | ||
| BYTE * | pNw2DescLen, | ||
| BYTE * | pNw2Name | ||
| ) |
Retrieves information about the home network of the device. It will extract 3GPP2 Network Information also.
| pMCC[OUT] |
|
| pMNC[OUT] |
|
| nameSize |
|
| pName[OUT] |
|
| pSID[OUT] |
|
| pNID[OUT] |
|
| pNw2MCC[OUT] |
|
| pNw2MNC[OUT] |
|
| pNw2DescDisp[OUT] |
|
| pNw2DescDisp[OUT] |
|
| nw2DescLen[OUT] |
|
| pNw2Name[OUT] |
|
| ULONG GetNetworkPreference | ( | ULONG * | pTechnologyPref, |
| ULONG * | pDuration, | ||
| ULONG * | pPersistentTechnologyPref | ||
| ) |
Returns the network registration preference. This API is deprecated on MC73xx/EM73xx modules since firmware version SWI9X15C_05_xx_xx_xx and all EM74xx firmware versions. Please use API SLQSGetSysSelectionPref() for new firmware versions and new modules
| pTechnologyPref[OUT] |
|
| pDuration[OUT] |
|
| pPersistentTechnologyPref[OUT] |
|
| ULONG GetRFInfo | ( | BYTE * | pInstanceSize, |
| struct RFBandInfoElements * | pRFBandInfo | ||
| ) |
Sets the RFInfoList
| pInstanceSize[IN/OUT] |
|
| pInstances[OUT] |
|
| ULONG GetServingNetwork | ( | ULONG * | pRegistrationState, |
| ULONG * | pCSDomain, | ||
| ULONG * | pPSDomain, | ||
| ULONG * | pRAN, | ||
| BYTE * | pRadioIfacesSize, | ||
| BYTE * | pRadioIfaces, | ||
| ULONG * | pRoaming, | ||
| WORD * | pMCC, | ||
| WORD * | pMNC, | ||
| BYTE | nameSize, | ||
| CHAR * | pName | ||
| ) |
Provides information about the system that provides service to the device. This API is deprecated on MC73xx/EM73xx modules since firmware version SWI9X15C_05_xx_xx_xx and all EM74xx firmware versions. Please use API SLQSNasGetSysInfo() for new firmware versions and new modules
| pRegistrationState[OUT] |
|
| pCSDomain[OUT] |
|
| pPSDomain[OUT] |
|
| pRAN[OUT] |
|
| pRadioIfacesSize[IN/OUT] |
|
| pRadioIfaces[OUT] |
|
| pRoaming[OUT] |
|
| pMCC[OUT] |
|
| pMNC[OUT] |
|
| nameSize |
|
| pName[OUT] |
|
Returns information regarding the data capabilities of the system that currently provides service to the device.
| pDataCapsSize[IN/OUT] |
|
| pDataCaps[OUT] |
|
Returns the available signal strengths ( in dBm ) as measured by the device in an array. The API also provides the corresponding radio radio interfaces in an array.
| pArraySizes[IN/OUT] |
|
| pSignalStrength[OUT] |
|
| pRadioInterface[OUT] |
|
Initiates a domain attach/detach of the device. This API is deprecated on MC73xx/EM73xx modules since firmware version SWI9X15C_05_xx_xx_xx and all EM74xx firmware versions. Please use API SLQSSetSysSelectionPref() for new firmware versions and new modules
| action[IN] |
|
Initiates the network registration process. This API is deprecated on MC73xx/EM73xx modules since firmware version SWI9X15C_05_xx_xx_xx and all EM74xx firmware versions. Please use API SLQSSetSysSelectionPref() and SLQSSetBandPreference() for new firmware versions and new modules
| regType |
|
| mcc |
|
| mnc |
|
| rat |
|
Performs scan for available networks.
| pInstanceSize[IN/OUT] |
|
| pInstances[OUT] |
|
Sets the access overload class (ACCOLC)
| spc[IN] |
|
| ACCOLC[IN] |
|
| ULONG SetCDMANetworkParameters | ( | CHAR * | pSPC, |
| BYTE * | pForceRev0, | ||
| BYTE * | pCustomSCP, | ||
| ULONG * | pProtocol, | ||
| ULONG * | pBroadcast, | ||
| ULONG * | pApplication, | ||
| ULONG * | pRoaming | ||
| ) |
Sets the CDMA network parameters. Currently the modified settings will not be utilized until the device has been reset. For this reason, the recommended approach when using SetCDMANetworkParameters is for the application to perform the following steps:
1 - Call SetCDMANetworkParameters() 2 - Call SetPower( 5 ) 3 - Call QCWWANDisconnect() 4 - Reconnect after the device power cycles
| pSPC[IN] |
|
| pForceRev0[IN] |
|
| pCustomSCP[IN] |
|
| pProtocol[IN] |
|
| pBroadcast[IN] |
|
| pApplication[IN] |
|
| pRoaming[IN] |
|
Sets the network registration preference. This API is deprecated on MC73xx/EM73xx modules since firmware version SWI9X15C_05_xx_xx_xx and all EM74xx firmware versions. Please use API SLQSSetSysSelectionPref() for new firmware versions and new modules
| technologyPref[IN] |
|
| duration[IN] |
|
Sets the signal reporting thresholds. This API is deprecated on MC73xx/EM73xx modules since firmware version SWI9X15C_05_xx_xx_xx and all EM74xx firmware versions.
| pSigInfo[IN] |
|
| ULONG SLQSGetErrorRate | ( | GetErrRateResp * | pGetErrRateResp | ) |
This API retrieves current error rate information
| pGetErrRateResp[OUT] |
|
| ULONG SLQSGetOperatorNameData | ( | nasOperatorNameResp * | pOperatorNameData | ) |
Get the operator name data from the network. This API is deprecated on MC73xx/EM73xx modules since firmware version SWI9X15C_05_xx_xx_xx and all EM74xx firmware versions. Please use API SLQSGetPLMNName() for new firmware versions and new modules
| pOperatorNameData[OUT] |
|
| ULONG SLQSGetPLMNName | ( | nasPLMNNameReq * | pPLMNNameReq, |
| nasPLMNNameResp * | pPLMNNameResp | ||
| ) |
Get the operator name data from the network.
| pPLMNNameReq[IN] |
|
| pPLMNNameResp[OUT] |
|
| ULONG SLQSGetServingSystem | ( | qaQmiServingSystemParam * | pServingSystem | ) |
Provides information about the system that provides service to the device. This API is deprecated on MC73xx/EM73xx modules since firmware version SWI9X15C_05_xx_xx_xx and all EM74xx firmware versions. Please use API SLQSNasGetSysInfo() for new firmware versions and new modules. Also report available radio interface technology. If there are more than one radio interface, please choose the right interface(usually the first pair).
| pServingSystem[OUT] |
|
| ULONG SLQSGetSignalStrength | ( | struct slqsSignalStrengthInfo * | pSignalInfo | ) |
Queries the current signal strength as measured by the device. This API is deprecated on MC73xx/EM73xx modules since firmware version SWI9X15C_05_xx_xx_xx and all EM74xx firmware versions. Please use API SLQSNasGetSigInfo() for new firmware versions and new modules
| pSignalInfo[IN/OUT] |
|
| ULONG SLQSGetSysSelectionPref | ( | sysSelectPrefInfo * | pSysSelectPrefInfo | ) |
Queries the different system selection preferences of the device.
| pSysSelectPrefInfo[OUT] |
|
| ULONG SLQSInitiateNetworkRegistration | ( | nasInitNetworkReg * | pNasInitNetRegistrationReg | ) |
Initiates the network registration process.
| pNasInitNetRegistrationReq[IN] |
|
| ULONG SLQSNasConfigSigInfo2 | ( | setSignalStrengthInfo * | pSetSignalStrengthInfo | ) |
Sets the signal strength reporting thresholds
| pSetSignalStrengthInfo[IN] |
|
| ULONG SLQSNasGet3GPP2Subscription | ( | nasGet3GPP2SubscriptionInfoReq * | pGet3GPP2SubsInfoReq, |
| nasGet3GPP2SubscriptionInfoResp * | pGet3GPP2SubsInfoResp | ||
| ) |
This API retrieves 3GPP2 subscription-related information.
| pGet3GPP2SubsInfoReq[IN] |
|
| pGet3GPP2SubsInfoResp[OUT] |
|
| ULONG SLQSNasGetCellLocationInfo | ( | nasCellLocationInfoResp * | pNasCellLocationInfoResp | ) |
This API retrieves cell location-related information
| pNasCellLocationInfoResp[OUT] |
|
| ULONG SLQSNasGetHDRColorCode | ( | nasGetHDRColorCodeResp * | pGetHDRColorCodeResp | ) |
This API retrieves the current HDR color code value.
| pGetHDRColorCodeResp[OUT] |
|
| ULONG SLQSNASGetLTECPHYCaInfo | ( | nasGetLTECphyCa * | pLTECPhyCa | ) |
This API Get LTE CPHY Carrier Info
| pLTECPhyCa[IN] |
|
| ULONG SLQSNasGetSigInfo | ( | nasGetSigInfoResp * | pGetSigInfoResp | ) |
This API queries information regarding the signal strength.
| pGetSigInfoResp[OUT] |
|
| ULONG SLQSNasGetSysInfo | ( | nasGetSysInfoResp * | pGetSysInfoResp | ) |
Provides the system information. This API is preferred when trying to get the service status info and serving system info. The API SLQSGetServingSystem() reports similar NAS information, but it is deprecated. Please refer to the header description of API SLQSGetServingSystem() for more information.
| pGetSysInfoResp[OUT] |
|
| ULONG SLQSNasGetTxRxInfo | ( | nasGetTxRxInfoReq * | pGetTxRxInfoReq, |
| nasGetTxRxInfoResp * | pGetTxRxInfoResp | ||
| ) |
This API retrieves the detailed Tx/Rx information.
| pGetTxRxInfoReq[IN] |
|
| pGetTxRxInfoResp[OUT] |
|
Register/De-register from NAS (Network access service) broadcast indications. Some callbacks would not be invoked if the indications are not registered. The details are provided in the parameter description.
| systemSelectionInd[IN] |
|
| DDTMInd[IN] |
|
| servingSystemInd[IN] |
|
| ULONG SLQSNasIndicationRegisterExt | ( | nasIndicationRegisterReq * | pIndicationRegisterReq | ) |
This API Registers/De-registers for different NAS (Network access service) indications.
| pIndicationRegisterReq[IN] |
|
This API Registers/De-registers for NAS CPHY Carrier Info.
| bStatus[IN] |
|
| ULONG SLQSNASSwiGetChannelLock | ( | nasSwiGetChannelLockResp * | pNasSwiGetChannelLockResp | ) |
This API queries the channel or cell which the UE is locked into.
| pNasSwiGetChannelLock[OUT] |
|
| ULONG SLQSNasSwiIndicationRegister | ( | NasSwiIndReg * | pIndRegReq | ) |
sets the registration state for different QMI_NAS SWI indications
| pIndRegReq[IN] |
|
| ULONG SLQSNasSwiModemStatus | ( | swiModemStatusResp * | pModemStatusResp | ) |
This API requests the device to return the current status of modem.
| pModemStatusResp[OUT] |
|
| ULONG SLQSNASSwiSetChannelLock | ( | nasSwiSetChannelLockReq * | pNasSwiSetChannelLockReq | ) |
This API allows the host to lock the UE to a specific channel or cell.
| pNasSwiSetChannelLockReq[IN] |
|
| ULONG SLQSPerformNetworkScan | ( | slqsNetworkScanInfo * | pNetworkInfo | ) |
Performs scan for available networks and scans for RAT info as well.
| pNetworkInfo[IN/OUT] |
|
Provides information about the band preference.
| bandpreference[IN] |
|
| ULONG SLQSSetSysSelectionPref | ( | sysSelectPrefParams * | pSysSelectPrefParams | ) |
Sets the different system selection preferences of the device.
| pSysSelectPrefParams[IN] |
|
| ULONG SLQSSwiGetHDRPersonality | ( | HDRPersonalityResp * | pHDRPersonalityResp | ) |
This API retrieves HDR Personality related information
| pHDRPersonalityResp[OUT] |
|
| ULONG SLQSSwiGetHDRProtSubtype | ( | HDRProtSubtypResp * | pHDRProtSubtypResp | ) |
This API retrieves HDR Prototype Subtype related information
| pHDRProtSubtypResp[OUT] |
|
| ULONG SLQSSwiGetHRPDStats | ( | GetHRPDStatsResp * | pGetHRPDStatsResp | ) |
This API retrieves currently acquired HRPD system statistics
| pGetHRPDStatsResp[OUT] |
|
| ULONG SLQSSwiGetLteCQI | ( | LteCQIParm * | pLteCQIResp | ) |
This API Fetch CQI parameters for LTE data session
| pLteCQIParm[OUT] |
|
| ULONG SLQSSwiNetworkDebug | ( | NetworkDebugResp * | pNetworkDebugResp | ) |
This API retrieves device and network status details
| pNetworkDebugResp[OUT] |
|
| ULONG SLQSSwiPSDetach | ( | PSDetachReq * | pPSDetachReq | ) |
This API detaches PS connection.
| pPSDetachReq[IN] |
|