Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
Go to the source code of this file.
le_msg_ServiceRef_t taf_radio_GetServiceRef | ( | void | ) |
Get the server service reference
le_msg_SessionRef_t taf_radio_GetClientSessionRef | ( | void | ) |
Get the client session reference for the current message
void taf_radio_AdvertiseService | ( | void | ) |
Initialize the server and advertise the service.
taf_radio_NetRegRejectHandlerRef_t taf_radio_AddNetRegRejectHandler | ( | taf_radio_NetRegRejectHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
The preferred operator list reference. The preferred operator reference. The signal metrics reference. The network scan information list reference. The network scan information reference. The cell information reference. The neighbor cell reference. The PCI network scan information list reference. The PCI network scan information reference. The PLMN information reference. IMS reference. Network status reference. Radio Access Technology (RAT). RAT service status. Circuit-Switched capabilities. Network reject cause. Network registration state. Service domain state. Signal type enum. IMS registration status. IMS service type. IMS service status. PDP error enum. Operating mode enum. DCNR (Dual Connectivity with NR) Restriction status on 5G NR Cell Info change status RAT bitmask. 2G/3G band bit mask (64 bits) IMS indication bitmask. Network status indication bitmask. Network rejection indication structure. RAT change indication structure. Network registration state indication structure. Handler for manual selection. Handler for network registration rejection. Handler for RAT change. Handler for network registration state. Handler for packet switched state changes. Handler for signal strength change. Handler for IMS registration status change. Handler for network scan. Handler for PCI network scan. Handler for operating mode change. Handler for network status. Handler for IMS status change. Handler for cell info change. Reference type used by Add/Remove functions for EVENT 'taf_radio_NetRegReject' Reference type used by Add/Remove functions for EVENT 'taf_radio_RatChange' Reference type used by Add/Remove functions for EVENT 'taf_radio_NetRegStateEvent' Reference type used by Add/Remove functions for EVENT 'taf_radio_PacketSwitchedChange' Reference type used by Add/Remove functions for EVENT 'taf_radio_SignalStrengthChange' Reference type used by Add/Remove functions for EVENT 'taf_radio_ImsRegStatusChange' Reference type used by Add/Remove functions for EVENT 'taf_radio_OpModeChange' Reference type used by Add/Remove functions for EVENT 'taf_radio_NetStatusChange' Reference type used by Add/Remove functions for EVENT 'taf_radio_ImsStatusChange' Reference type used by Add/Remove functions for EVENT 'taf_radio_CellInfoChange' Add handler function for EVENT 'taf_radio_NetRegReject'
Event to report network registration rejection.
Add handler function for EVENT 'taf_radio_NetRegReject'
Event to report network registration rejection.
[in] | handlerPtr | Handler for network registration rejection. |
[in] | contextPtr |
void taf_radio_RemoveNetRegRejectHandler | ( | taf_radio_NetRegRejectHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_radio_NetRegReject'
[in] | handlerRef |
taf_radio_RatChangeHandlerRef_t taf_radio_AddRatChangeHandler | ( | taf_radio_RatChangeHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_radio_RatChange'
Event to report RAT change.
[in] | handlerPtr | Handler for RAT change. |
[in] | contextPtr |
void taf_radio_RemoveRatChangeHandler | ( | taf_radio_RatChangeHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_radio_RatChange'
[in] | handlerRef |
taf_radio_NetRegStateEventHandlerRef_t taf_radio_AddNetRegStateEventHandler | ( | taf_radio_NetRegStateHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_radio_NetRegStateEvent'
Event to report network registration state.
[in] | handlerPtr | Handler for network registration state. |
[in] | contextPtr |
void taf_radio_RemoveNetRegStateEventHandler | ( | taf_radio_NetRegStateEventHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_radio_NetRegStateEvent'
[in] | handlerRef |
taf_radio_PacketSwitchedChangeHandlerRef_t taf_radio_AddPacketSwitchedChangeHandler | ( | taf_radio_PacketSwitchedChangeHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_radio_PacketSwitchedChange'
Event to report packet switched state changes.
[in] | handlerPtr | Handler for packet switched state changes. |
[in] | contextPtr |
void taf_radio_RemovePacketSwitchedChangeHandler | ( | taf_radio_PacketSwitchedChangeHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_radio_PacketSwitchedChange'
[in] | handlerRef |
taf_radio_SignalStrengthChangeHandlerRef_t taf_radio_AddSignalStrengthChangeHandler | ( | taf_radio_Rat_t | rat, |
taf_radio_SignalStrengthChangeHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_radio_SignalStrengthChange'
Event to report signal strength change.
[in] | rat | Radio Access Technology. |
[in] | handlerPtr | Handler for signal strength change. |
[in] | contextPtr |
void taf_radio_RemoveSignalStrengthChangeHandler | ( | taf_radio_SignalStrengthChangeHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_radio_SignalStrengthChange'
[in] | handlerRef |
taf_radio_ImsRegStatusChangeHandlerRef_t taf_radio_AddImsRegStatusChangeHandler | ( | taf_radio_ImsRegStatusChangeHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_radio_ImsRegStatusChange'
Event to report IMS registration status.
[in] | handlerPtr | Handler for IMS registration status change. |
[in] | contextPtr |
void taf_radio_RemoveImsRegStatusChangeHandler | ( | taf_radio_ImsRegStatusChangeHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_radio_ImsRegStatusChange'
[in] | handlerRef |
taf_radio_OpModeChangeHandlerRef_t taf_radio_AddOpModeChangeHandler | ( | taf_radio_OpModeChangeHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_radio_OpModeChange'
Event to report operating mode changes.
[in] | handlerPtr | Handler for operating mode changes. |
[in] | contextPtr |
void taf_radio_RemoveOpModeChangeHandler | ( | taf_radio_OpModeChangeHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_radio_OpModeChange'
[in] | handlerRef |
taf_radio_NetStatusChangeHandlerRef_t taf_radio_AddNetStatusChangeHandler | ( | taf_radio_NetStatusHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_radio_NetStatusChange'
Event to report network status changes.
[in] | handlerPtr | Handler for network status changes. |
[in] | contextPtr |
void taf_radio_RemoveNetStatusChangeHandler | ( | taf_radio_NetStatusChangeHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_radio_NetStatusChange'
[in] | handlerRef |
taf_radio_ImsStatusChangeHandlerRef_t taf_radio_AddImsStatusChangeHandler | ( | taf_radio_ImsStatusChangeHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_radio_ImsStatusChange'
Event to report IMS status.
[in] | handlerPtr | Handler for IMS status change. |
[in] | contextPtr |
void taf_radio_RemoveImsStatusChangeHandler | ( | taf_radio_ImsStatusChangeHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_radio_ImsStatusChange'
[in] | handlerRef |
taf_radio_CellInfoChangeHandlerRef_t taf_radio_AddCellInfoChangeHandler | ( | taf_radio_CellInfoChangeHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_radio_CellInfoChange'
Event to report cell info change.
[in] | handlerPtr | Handler for registered cell info change. |
[in] | contextPtr |
void taf_radio_RemoveCellInfoChangeHandler | ( | taf_radio_CellInfoChangeHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_radio_CellInfoChange'
[in] | handlerRef |
le_result_t taf_radio_SetRadioPower | ( | le_onoff_t | power, |
uint8_t | phoneId | ||
) |
Sets the radio power state.
[in] | power | Power state. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetRadioPower | ( | le_onoff_t * | powerPtr, |
uint8_t | phoneId | ||
) |
Gets the radio power state.
[out] | powerPtr | Power state. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_SetAutomaticRegisterMode | ( | uint8_t | phoneId | ) |
Registers to network using automatic mode.
[in] | phoneId | Phone ID. |
le_result_t taf_radio_SetManualRegisterMode | ( | const char *LE_NONNULL | mcc, |
const char *LE_NONNULL | mnc, | ||
uint8_t | phoneId | ||
) |
Registers to network using manual mode.
[in] | mcc | MCC. |
[in] | mnc | MNC. |
[in] | phoneId | Phone ID. |
void taf_radio_SetManualRegisterModeAsync | ( | const char *LE_NONNULL | mcc, |
const char *LE_NONNULL | mnc, | ||
taf_radio_ManualSelectionHandlerFunc_t | handlerPtr, | ||
void * | contextPtr, | ||
uint8_t | phoneId | ||
) |
Registers to network asynchronously using manual mode.
[in] | mcc | MCC. |
[in] | mnc | MNC. |
[in] | handlerPtr | Handler for manual selection. |
[in] | contextPtr | |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetRegisterMode | ( | bool * | isManualPtrPtr, |
char * | mccPtr, | ||
size_t | mccPtrSize, | ||
char * | mncPtr, | ||
size_t | mncPtrSize, | ||
uint8_t | phoneId | ||
) |
Gets the network registration mode.
[out] | isManualPtrPtr | True if manual, false if automatic. |
[out] | mccPtr | MCC. |
[in] | mccPtrSize | |
[out] | mncPtr | MNC. |
[in] | mncPtrSize | |
[in] | phoneId | Phone ID. |
int32_t taf_radio_GetPlatformSpecificRegistrationErrorCode | ( | void | ) |
Gets platform-specific network registration error code.
le_result_t taf_radio_GetBandCapabilities | ( | taf_radio_BandBitMask_t * | bandMaskPtrPtr, |
uint8_t | phoneId | ||
) |
Gets 2G/3G band capabilities.
[out] | bandMaskPtrPtr | 2G/3G band capabilities. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetLteBandCapabilities | ( | uint64_t * | bandMaskPtrPtr, |
size_t * | bandMaskPtrSizePtr, | ||
uint8_t | phoneId | ||
) |
Gets LTE band capabilities.
[out] | bandMaskPtrPtr | LTE band capabilities. |
[in,out] | bandMaskPtrSizePtr | |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_SetBandPreferences | ( | taf_radio_BandBitMask_t | bandMask, |
uint8_t | phoneId | ||
) |
Sets 2G/3G band preferences.
[in] | bandMask | 2G/3G band preferences. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetBandPreferences | ( | taf_radio_BandBitMask_t * | bandMaskPtrPtr, |
uint8_t | phoneId | ||
) |
Gets 2G/3G band preferences.
[out] | bandMaskPtrPtr | 2G/3G band preferences. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_SetLteBandPreferences | ( | const uint64_t * | bandMaskPtr, |
size_t | bandMaskSize, | ||
uint8_t | phoneId | ||
) |
Sets LTE band preferences.
[in] | bandMaskPtr | LTE band preferences. |
[in] | bandMaskSize | |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetLteBandPreferences | ( | uint64_t * | bandMaskPtr, |
size_t * | bandMaskSizePtr, | ||
uint8_t | phoneId | ||
) |
Gets LTE band preferences.
[out] | bandMaskPtr | LTE band preferences. |
[in,out] | bandMaskSizePtr | |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_AddPreferredOperator | ( | const char *LE_NONNULL | mcc, |
const char *LE_NONNULL | mnc, | ||
taf_radio_RatBitMask_t | ratMask, | ||
uint8_t | phoneId | ||
) |
Adds a preferred operator.
[in] | mcc | MCC. |
[in] | mnc | MNC. |
[in] | ratMask | RAT bitmask, applicable for GSM/UMTS/LTE/NR5G. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_RemovePreferredOperator | ( | const char *LE_NONNULL | mcc, |
const char *LE_NONNULL | mnc, | ||
uint8_t | phoneId | ||
) |
Removes a preferred operator.
[in] | mcc | MCC. |
[in] | mnc | MNC. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_DeletePreferredOperatorsList | ( | taf_radio_PreferredOperatorListRef_t | preferredOperatorListRef | ) |
Deletes the preferred operators list.
[in] | preferredOperatorListRef | The preferred operators list reference. |
taf_radio_PreferredOperatorListRef_t taf_radio_GetPreferredOperatorsList | ( | uint8_t | phoneId | ) |
Creates a preferred operators list.
[in] | phoneId | Phone ID. |
taf_radio_PreferredOperatorRef_t taf_radio_GetFirstPreferredOperator | ( | taf_radio_PreferredOperatorListRef_t | preferredOperatorListRef | ) |
Gets the first preferred operator.
[in] | preferredOperatorListRef | The preferred operators list reference. |
taf_radio_PreferredOperatorRef_t taf_radio_GetNextPreferredOperator | ( | taf_radio_PreferredOperatorListRef_t | preferredOperatorListRef | ) |
Gets the next preferred operator based on the current position in the list.
[in] | preferredOperatorListRef | The preferred operators list reference. |
le_result_t taf_radio_GetPreferredOperatorDetails | ( | taf_radio_PreferredOperatorRef_t | preferredOperatorRef, |
char * | mccPtr, | ||
size_t | mccPtrSize, | ||
char * | mncPtr, | ||
size_t | mncPtrSize, | ||
taf_radio_RatBitMask_t * | ratMaskPtr | ||
) |
Gets the details of the given preferred operator.
[in] | preferredOperatorRef | The preferred operator reference. |
[out] | mccPtr | MCC. |
[in] | mccPtrSize | |
[out] | mncPtr | MNC. |
[in] | mncPtrSize | |
[out] | ratMaskPtr | RAT bitmask. |
le_result_t taf_radio_GetRadioAccessTechInUse | ( | taf_radio_Rat_t * | ratPtr, |
uint8_t | phoneId | ||
) |
Gets the RAT in use.
[out] | ratPtr | RAT in use. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_SetRatPreferences | ( | taf_radio_RatBitMask_t | ratMask, |
uint8_t | phoneId | ||
) |
Sets the RAT preferences.
[in] | ratMask | Bitmask for RAT prefences. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetRatPreferences | ( | taf_radio_RatBitMask_t * | ratMaskPtrPtr, |
uint8_t | phoneId | ||
) |
Gets the RAT preferences.
[out] | ratMaskPtrPtr | Bitmask for RAT prefences. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetNetRegState | ( | taf_radio_NetRegState_t * | statePtr, |
uint8_t | phoneId | ||
) |
Gets the network registration state.
[out] | statePtr | Network registration state. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetPacketSwitchedState | ( | taf_radio_NetRegState_t * | statePtr, |
uint8_t | phoneId | ||
) |
Gets the packet switch state.
[out] | statePtr | Packet switch state. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_SetSignalStrengthIndThresholds | ( | taf_radio_SigType_t | sigType, |
int32_t | lowerRangeThreshold, | ||
int32_t | upperRangeThreshold, | ||
uint8_t | phoneId | ||
) |
Sets signal strength indication thresholds.
[in] | sigType | Signal type. |
[in] | lowerRangeThreshold | Lower range threshold in 0.1 dBm. |
[in] | upperRangeThreshold | Upper range threshold in 0.1 dBm. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_SetSignalStrengthIndDelta | ( | taf_radio_SigType_t | sigType, |
uint16_t | delta, | ||
uint8_t | phoneId | ||
) |
Sets signal strength indication delta.
[in] | sigType | Signal type. |
[in] | delta | Delta in uints of 0.1 dBm |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetSignalQual | ( | uint32_t * | qualityPtr, |
uint8_t | phoneId | ||
) |
Gets the signal quality.
[out] | qualityPtr | Signal qulity level, ranges from 1 to 5, 0 is unknown. |
[in] | phoneId | Phone ID. |
taf_radio_MetricsRef_t taf_radio_MeasureSignalMetrics | ( | uint8_t | phoneId | ) |
Creates signal metrics.
[in] | phoneId | Phone ID. |
le_result_t taf_radio_DeleteSignalMetrics | ( | taf_radio_MetricsRef_t | MetricsRef | ) |
Deletes signal metrics.
[in] | MetricsRef | The signal metrics reference. |
taf_radio_RatBitMask_t taf_radio_GetRatOfSignalMetrics | ( | taf_radio_MetricsRef_t | MetricsRef | ) |
Gets RAT bitmask of signal metrics.
[in] | MetricsRef | The signal metrics reference. |
le_result_t taf_radio_GetGsmSignalMetrics | ( | taf_radio_MetricsRef_t | MetricsRef, |
int32_t * | rssiPtr, | ||
uint32_t * | berPtr | ||
) |
Gets GSM signal metrics.
[in] | MetricsRef | The signal metrics reference. |
[out] | rssiPtr | Received signal strength indicator in dBm. |
[out] | berPtr | Bit error rate, valid from 0 to 7. |
le_result_t taf_radio_GetUmtsSignalMetrics | ( | taf_radio_MetricsRef_t | MetricsRef, |
int32_t * | ssPtr, | ||
uint32_t * | berPtr, | ||
int32_t * | rscpPtr | ||
) |
Gets UMTS signal metrics.
[in] | MetricsRef | The signal metrics reference. |
[out] | ssPtr | Signal strength in dBm. |
[out] | berPtr | WCDMA bit error rate, valid from 0 to 7, 0x7FFFFFFF is unavailable. |
[out] | rscpPtr | Receive signal channel power in dBm. |
le_result_t taf_radio_GetLteSignalMetrics | ( | taf_radio_MetricsRef_t | MetricsRef, |
int32_t * | ssPtr, | ||
int32_t * | rsrqPtr, | ||
int32_t * | rsrpPtr, | ||
int32_t * | snrPtr | ||
) |
Gets LTE signal metrics.
[in] | MetricsRef | The signal metrics reference. |
[out] | ssPtr | Signal strength in dBm. |
[out] | rsrqPtr | Reference signal receive quality in dB. |
[out] | rsrpPtr | Reference signal receive power in dBm. |
[out] | snrPtr | Signal-to-noise ratio in units of 0.1 dB. |
le_result_t taf_radio_GetCdmaSignalMetrics | ( | taf_radio_MetricsRef_t | MetricsRef, |
int32_t * | ssPtr, | ||
int32_t * | ecioPtr, | ||
int32_t * | snrPtr, | ||
int32_t * | ioPtr | ||
) |
Gets CDMA signal metrics.
[in] | MetricsRef | The signal metrics reference. |
[out] | ssPtr | Signal strength in dBm. |
[out] | ecioPtr | CDMA Ec/Io in dB. |
[out] | snrPtr | EVDO signal-to-noise ratio in dB. |
[out] | ioPtr | EVDO Ec/Io in dB. |
le_result_t taf_radio_GetNr5gSignalMetrics | ( | taf_radio_MetricsRef_t | MetricsRef, |
int32_t * | rsrqPtr, | ||
int32_t * | rsrpPtr, | ||
int32_t * | snrPtr | ||
) |
Gets NR5G signal metrics.
[in] | MetricsRef | The signal metrics reference. |
[out] | rsrqPtr | Reference Signal Receive Quality in dB. |
[out] | rsrpPtr | Reference Signal Receive Power in dBm. |
[out] | snrPtr | Signal-to-Noise Ratio in units of 0.1 dB. |
uint32_t taf_radio_GetServingCellId | ( | uint8_t | phoneId | ) |
Gets cell ID.
[in] | phoneId | Phone ID. |
uint64_t taf_radio_GetServingNrCellId | ( | uint8_t | phoneId | ) |
Gets NR cell ID.
[in] | phoneId | Phone ID. |
uint32_t taf_radio_GetServingCellLocAreaCode | ( | uint8_t | phoneId | ) |
Gets the location area code.
[in] | phoneId | Phone ID. |
uint16_t taf_radio_GetServingCellLteTracAreaCode | ( | uint8_t | phoneId | ) |
Gets the LTE tracking area code.
[in] | phoneId | Phone ID. |
int32_t taf_radio_GetServingCellNrTracAreaCode | ( | uint8_t | phoneId | ) |
Gets the NR tracking area code.
[in] | phoneId | Phone ID. |
uint32_t taf_radio_GetServingCellEarfcn | ( | uint8_t | phoneId | ) |
Gets E-UTRA absolute radio frequency channel number.
[in] | phoneId | Phone ID. |
int32_t taf_radio_GetServingCellNrArfcn | ( | uint8_t | phoneId | ) |
Gets NR absolute radio frequency channel number.
[in] | phoneId | Phone ID. |
uint32_t taf_radio_GetServingCellTimingAdvance | ( | uint8_t | phoneId | ) |
Gets timing advance.
[in] | phoneId | Phone ID. |
uint16_t taf_radio_GetPhysicalServingLteCellId | ( | uint8_t | phoneId | ) |
Gets physical LTE cell ID.
[in] | phoneId | Phone ID. |
uint32_t taf_radio_GetPhysicalServingNrCellId | ( | uint8_t | phoneId | ) |
Gets physical NR5G cell ID.
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetServingCellGsmBsic | ( | uint8_t * | bsicPtr, |
uint8_t | phoneId | ||
) |
Gets the GSM base station identity code.
[out] | bsicPtr | GSM base station identity code. |
[in] | phoneId | Phone ID. |
uint16_t taf_radio_GetServingCellScramblingCode | ( | uint8_t | phoneId | ) |
Gets the primary scrambling code.
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetCurrentNetworkName | ( | char * | nameStr, |
size_t | nameStrSize, | ||
uint8_t | phoneId | ||
) |
Gets the current network's short name.
[out] | nameStr | Current network's short name. |
[in] | nameStrSize | |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetCurrentNetworkMccMnc | ( | char * | mccStr, |
size_t | mccStrSize, | ||
char * | mncStr, | ||
size_t | mncStrSize, | ||
uint8_t | phoneId | ||
) |
Gets the current MCC and MNC.
[out] | mccStr | MCC. |
[in] | mccStrSize | |
[out] | mncStr | MNC. |
[in] | mncStrSize | |
[in] | phoneId | Phone ID. |
taf_radio_ScanInformationListRef_t taf_radio_PerformCellularNetworkScan | ( | uint8_t | phoneId | ) |
Performs celluar network scan and gets the network scan information list reference.
[in] | phoneId | Phone ID. |
void taf_radio_PerformCellularNetworkScanAsync | ( | taf_radio_CellularNetworkScanHandlerFunc_t | handlerPtr, |
void * | contextPtr, | ||
uint8_t | phoneId | ||
) |
Asynchronously performs a celluar network scan.
[in] | handlerPtr | Handler for network scan. |
[in] | contextPtr | |
[in] | phoneId | Phone ID. |
taf_radio_ScanInformationRef_t taf_radio_GetFirstCellularNetworkScan | ( | taf_radio_ScanInformationListRef_t | scanInformationListRef | ) |
Gets the reference of the first operator in the network scan information list.
[in] | scanInformationListRef | The network scan information list reference. |
taf_radio_ScanInformationRef_t taf_radio_GetNextCellularNetworkScan | ( | taf_radio_ScanInformationListRef_t | scanInformationListRef | ) |
Gets the reference of the next operator based on the current position in the network scan information list.
[in] | scanInformationListRef | The network scan information list reference. |
le_result_t taf_radio_DeleteCellularNetworkScan | ( | taf_radio_ScanInformationListRef_t | scanInformationListRef | ) |
Deletes the network scan information list reference.
[in] | scanInformationListRef | The network scan information list reference. |
le_result_t taf_radio_GetCellularNetworkMccMnc | ( | taf_radio_ScanInformationRef_t | scanInformationRef, |
char * | mccPtr, | ||
size_t | mccPtrSize, | ||
char * | mncPtr, | ||
size_t | mncPtrSize | ||
) |
Gets MCC and MNC of a network scan operator.
[in] | scanInformationRef | The scan information list reference. |
[out] | mccPtr | MCC. |
[in] | mccPtrSize | |
[out] | mncPtr | MNC. |
[in] | mncPtrSize |
le_result_t taf_radio_GetCellularNetworkName | ( | taf_radio_ScanInformationRef_t | scanInformationRef, |
char * | namePtr, | ||
size_t | namePtrSize | ||
) |
Gets the network name of a network scan operator.
[in] | scanInformationRef | The scan information list reference. |
[out] | namePtr | Network name. |
[in] | namePtrSize |
taf_radio_Rat_t taf_radio_GetCellularNetworkRat | ( | taf_radio_ScanInformationRef_t | scanInformationRef | ) |
Gets Radio Access Technology of a network scan operator.
[in] | scanInformationRef | The scan information list reference. |
bool taf_radio_IsCellularNetworkInUse | ( | taf_radio_ScanInformationRef_t | scanInformationRef | ) |
Checks if a scan operator's network is in use.
[in] | scanInformationRef | The network scan operator reference. |
bool taf_radio_IsCellularNetworkAvailable | ( | taf_radio_ScanInformationRef_t | scanInformationRef | ) |
Checks if the scan operator's network is available.
[in] | scanInformationRef | The network scan operator reference. |
bool taf_radio_IsCellularNetworkHome | ( | taf_radio_ScanInformationRef_t | scanInformationRef | ) |
Checks if scan operator is home network.
[in] | scanInformationRef | The network scan operator reference. |
bool taf_radio_IsCellularNetworkForbidden | ( | taf_radio_ScanInformationRef_t | scanInformationRef | ) |
Checks if scan operator's network is forbidden.
[in] | scanInformationRef | The network scan operator reference. |
taf_radio_PciScanInformationListRef_t taf_radio_PerformPciNetworkScan | ( | taf_radio_RatBitMask_t | ratMask, |
uint8_t | phoneId | ||
) |
Performs celluar network scan with Physical Cell ID.
[in] | ratMask | Radio Access Technology bitmask. |
[in] | phoneId | Phone ID. |
void taf_radio_PerformPciNetworkScanAsync | ( | taf_radio_RatBitMask_t | ratMask, |
taf_radio_PciNetworkScanHandlerFunc_t | handlerPtr, | ||
void * | contextPtr, | ||
uint8_t | phoneId | ||
) |
Asynchronously performs celluar network scan with physical cell ID.
[in] | ratMask | Radio Access Technology bitmask. |
[in] | handlerPtr | Handler for PCI network scan. |
[in] | contextPtr | |
[in] | phoneId | Phone ID. |
taf_radio_PciScanInformationRef_t taf_radio_GetFirstPciScanInfo | ( | taf_radio_PciScanInformationListRef_t | scanInformationListRef | ) |
Gets the first reference in the PCI network scan information list.
[in] | scanInformationListRef | PCI network scan information list reference. |
taf_radio_PciScanInformationRef_t taf_radio_GetNextPciScanInfo | ( | taf_radio_PciScanInformationListRef_t | scanInformationListRef | ) |
Gets the next reference in the PCI network scan information list.
[in] | scanInformationListRef | PCI network scan information list reference. |
le_result_t taf_radio_DeletePciNetworkScan | ( | taf_radio_PciScanInformationListRef_t | scanInformationListRef | ) |
Deletes the PCI network scan information list reference.
[in] | scanInformationListRef | PCI network scan information list reference. |
taf_radio_PlmnInformationRef_t taf_radio_GetFirstPlmnInfo | ( | taf_radio_PciScanInformationRef_t | pciScanInformationRef | ) |
Gets the first reference of PLMN info of PCI network scan information.
[in] | pciScanInformationRef | PCI network scan information reference. |
taf_radio_PlmnInformationRef_t taf_radio_GetNextPlmnInfo | ( | taf_radio_PciScanInformationRef_t | pciScanInformationRef | ) |
Gets the next reference of PLMN info of PCI network scan information.
[in] | pciScanInformationRef | PCI network scan information reference. |
uint16_t taf_radio_GetPciScanCellId | ( | taf_radio_PciScanInformationRef_t | pciScanInformationRef | ) |
Gets the cell ID of PCI network scan information.
[in] | pciScanInformationRef | PCI network scan information reference. |
uint32_t taf_radio_GetPciScanGlobalCellId | ( | taf_radio_PciScanInformationRef_t | pciScanInformationRef | ) |
Gets the global cell ID of PCI network scan information.
[in] | pciScanInformationRef | PCI network scan information reference. |
le_result_t taf_radio_GetPciScanMccMnc | ( | taf_radio_PlmnInformationRef_t | plmnRef, |
char * | mccPtr, | ||
size_t | mccPtrSize, | ||
char * | mncPtr, | ||
size_t | mncPtrSize | ||
) |
Gets PLMN network MCC and MNC of PCI network scan information.
[in] | plmnRef | PLMN information reference. |
[out] | mccPtr | MCC. |
[in] | mccPtrSize | |
[out] | mncPtr | MNC. |
[in] | mncPtrSize |
taf_radio_NeighborCellsRef_t taf_radio_GetNeighborCellsInfo | ( | uint8_t | phoneId | ) |
Gets neighbor cells information.
[in] | phoneId | Phone ID. |
le_result_t taf_radio_DeleteNeighborCellsInfo | ( | taf_radio_NeighborCellsRef_t | ngbrCellsRef | ) |
Deletes neighbor cells information.
[in] | ngbrCellsRef | Neighbor cells reference. |
taf_radio_CellInfoRef_t taf_radio_GetFirstNeighborCellInfo | ( | taf_radio_NeighborCellsRef_t | ngbrCellsRef | ) |
Gets the first neighbor cell information.
[in] | ngbrCellsRef | Neighbor cells reference. |
taf_radio_CellInfoRef_t taf_radio_GetNextNeighborCellInfo | ( | taf_radio_NeighborCellsRef_t | ngbrCellsRef | ) |
Gets the next neighbor cell information.
[in] | ngbrCellsRef | Neighbor cells reference. |
uint64_t taf_radio_GetNeighborCellId | ( | taf_radio_CellInfoRef_t | ngbrCellInfoRef | ) |
Gets neighbor Cell ID.
[in] | ngbrCellInfoRef | Cell information reference. |
uint32_t taf_radio_GetNeighborCellLocAreaCode | ( | taf_radio_CellInfoRef_t | ngbrCellInfoRef | ) |
Gets Location Area Code of neighbor cell.
[in] | ngbrCellInfoRef | Neighboring cell information reference. |
int32_t taf_radio_GetNeighborCellRxLevel | ( | taf_radio_CellInfoRef_t | ngbrCellInfoRef | ) |
Gets signal strength of neighbor cell.
[in] | ngbrCellInfoRef | Neighbor cell information reference. |
taf_radio_Rat_t taf_radio_GetNeighborCellRat | ( | taf_radio_CellInfoRef_t | ngbrCellInfoRef | ) |
Gets Radio Access Technology of neighbor cell.
[in] | ngbrCellInfoRef | Neighbor cell information reference. |
uint16_t taf_radio_GetPhysicalNeighborLteCellId | ( | taf_radio_CellInfoRef_t | ngbrCellInfoRef | ) |
Gets Physical Cell ID of neighbor LTE cell.
[in] | ngbrCellInfoRef | Neighbor cell information reference |
uint32_t taf_radio_GetPhysicalNeighborNrCellId | ( | taf_radio_CellInfoRef_t | ngbrCellInfoRef | ) |
Gets Physical Cell ID of neighbor NR5G cell.
[in] | ngbrCellInfoRef | Neighbor cell information reference |
le_result_t taf_radio_GetNeighborCellGsmBsic | ( | taf_radio_CellInfoRef_t | ngbrCellInfoRef, |
uint8_t * | bsicPtr | ||
) |
Gets Base Station Identity Code of neighbor GSM cell.
[in] | ngbrCellInfoRef | Neighbor cell information reference |
[out] | bsicPtr | Base Station Identity Code |
taf_radio_NetStatusRef_t taf_radio_GetNetStatus | ( | uint8_t | phoneId | ) |
Gets the network status reference.
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetRatSvcStatus | ( | taf_radio_NetStatusRef_t | netRef, |
taf_radio_RatSvcStatus_t * | statusPtr | ||
) |
Gets the RAT service status.
[in] | netRef | Network status reference. |
[out] | statusPtr | RAT service status. |
le_result_t taf_radio_GetLteCsCap | ( | taf_radio_NetStatusRef_t | netRef, |
taf_radio_CsCap_t * | capabilityPtr | ||
) |
Gets the CS capabilitiy of LTE network.
[in] | netRef | Network status reference. |
[out] | capabilityPtr | CS capabilitiy of LTE network. |
taf_radio_ImsRef_t taf_radio_GetIms | ( | uint8_t | phoneId | ) |
Gets the IMS reference.
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetImsRegStatus | ( | taf_radio_ImsRegStatus_t * | statusPtr, |
uint8_t | phoneId | ||
) |
Gets the IMS registration status.
[out] | statusPtr | IMS registration status. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetImsSvcStatus | ( | taf_radio_ImsRef_t | imsRef, |
taf_radio_ImsSvcType_t | service, | ||
taf_radio_ImsSvcStatus_t * | statusPtr | ||
) |
Gets the IMS service status.
[in] | imsRef | IMS reference. |
[in] | service | IMS service type. |
[out] | statusPtr | IMS service status. |
le_result_t taf_radio_GetImsPdpError | ( | taf_radio_ImsRef_t | imsRef, |
taf_radio_PdpError_t * | errorPtr | ||
) |
Gets the PDP error code.
[in] | imsRef | IMS reference. |
[out] | errorPtr | PDP error code. |
le_result_t taf_radio_SetImsSvcCfg | ( | taf_radio_ImsRef_t | imsRef, |
taf_radio_ImsSvcType_t | service, | ||
bool | enable | ||
) |
Sets the IMS service enablement configuration parameters.
[in] | imsRef | IMS reference. |
[in] | service | IMS service type. |
[in] | enable | True if enabling service, false if disabling service. |
le_result_t taf_radio_GetImsSvcCfg | ( | taf_radio_ImsRef_t | imsRef, |
taf_radio_ImsSvcType_t | service, | ||
bool * | enablePtr | ||
) |
Gets the IMS service enablement configuration parameters.
[in] | imsRef | IMS reference. |
[in] | service | IMS service type. |
[out] | enablePtr | True if service is enabled, false if service is disabled. |
le_result_t taf_radio_SetImsUserAgent | ( | taf_radio_ImsRef_t | imsRef, |
const char *LE_NONNULL | userAgent | ||
) |
Sets the user agent.
[in] | imsRef | IMS reference. |
[in] | userAgent | User agent string to be sent with SIP message. |
le_result_t taf_radio_GetImsUserAgent | ( | taf_radio_ImsRef_t | imsRef, |
char * | userAgent, | ||
size_t | userAgentSize | ||
) |
Gets the user agent.
[in] | imsRef | IMS reference. |
[out] | userAgent | User agent string to be sent with SIP message. |
[in] | userAgentSize |
le_result_t taf_radio_GetNrDualConnectivityStatus | ( | taf_radio_NREndcAvailability_t * | statusEndcPtr, |
taf_radio_NRDcnrRestriction_t * | statusDcnrPtr, | ||
uint8_t | phoneId | ||
) |
Gets the DCNR and ENDC mode status.
[out] | statusEndcPtr | ENDC availability status. |
[out] | statusDcnrPtr | DCNR restriction status. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetCurrentNetworkLongName | ( | char * | longNameStr, |
size_t | longNameStrSize, | ||
uint8_t | phoneId | ||
) |
Gets the long name of the network.
[out] | longNameStr | Long network name. |
[in] | longNameStrSize | |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_GetHardwareSimConfig | ( | uint8_t * | totalSimCountPtr, |
uint8_t * | maxActiveSimsPtr | ||
) |
Gets the details of the total SIM count and maximum active SIM count.
[out] | totalSimCountPtr | The maximum number of SIMs supported simultaneously. |
[out] | maxActiveSimsPtr | The maximum number of SIMs that can be active simultaneously. |
le_result_t taf_radio_GetHardwareSimRatCapabilities | ( | taf_radio_RatBitMask_t * | deviceRatCapMaskPtr, |
taf_radio_RatBitMask_t * | simRatCapMaskPtr, | ||
uint8_t | phoneId | ||
) |
Gets the RAT capabilities supported by hardware and SIM based on a given phone ID.
[out] | deviceRatCapMaskPtr | Device RAT capability bitmask. |
[out] | simRatCapMaskPtr | SIM RAT capability bitmask. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_SetSignalStrengthIndHysteresis | ( | taf_radio_SigType_t | sigType, |
uint16_t | hysteresis, | ||
uint8_t | phoneId | ||
) |
Sets the hysteresis in units of 0.1 dBm. which is an optional parameter for signal strength indication.
[in] | sigType | Signal type. |
[in] | hysteresis | Hysteresis dBm in units of 0.1 dBm. |
[in] | phoneId | Phone ID. |
le_result_t taf_radio_SetSignalStrengthIndHysteresisTimer | ( | uint16_t | hysteresisTimer, |
uint8_t | phoneId | ||
) |
Sets the hysteresis time in milliseconds which is an optional parameter for signal strength indication.
[in] | hysteresisTimer | Hysteresis time in milliseconds. |
[in] | phoneId | Phone ID. |