• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# telephony_radio_type.h
2
3## Overview
4
5Declares the structs for the C APIs of the radio module.
6
7**File to include**: <telephony/core_service/telephony_radio_type.h>
8
9**Library**: libtelephony_radio.so
10
11**System capability**: SystemCapability.Telephony.CoreService
12
13**Since**: 13
14
15**Related module**: [Telephony](capi-telephony.md)
16
17## Summary
18
19### Structs
20
21| Name| typedef Keyword| Description|
22| -- | -- | -- |
23| [Telephony_NetworkState](capi-telephony-telephony-networkstate.md) | Telephony_NetworkState | Defines network status information.|
24
25### Enums
26
27| Name| typedef Keyword| Description|
28| -- | -- | -- |
29| [Telephony_RadioResult](#telephony_radioresult) | Telephony_RadioResult | Result codes.|
30| [Telephony_RegState](#telephony_regstate) | Telephony_RegState | Network registration status of the device.|
31| [Telephony_RadioTechnology](#telephony_radiotechnology) | Telephony_RadioTechnology | Radio access technology (RAT) type of the device.|
32| [Telephony_NsaState](#telephony_nsastate) | Telephony_NsaState | NSA network registration status of the device.|
33
34## Enum Description
35
36### Telephony_RadioResult
37
38```
39enum Telephony_RadioResult
40```
41
42**Description**
43
44Result codes.
45
46**Since**: 13
47
48| Enum Item| Description|
49| -- | -- |
50| TEL_RADIO_SUCCESS = 0 | Operation succeeded.|
51| TEL_RADIO_PERMISSION_DENIED = 201 | Permission denied.|
52| TEL_RADIO_ERR_INVALID_PARAM = 401 | Invalid parameter.|
53| TEL_RADIO_ERR_MARSHALLING_FAILED = 8300001 | Marshaling failed, which is a low-probability error. Try again later when this error occurs.|
54| TEL_RADIO_ERR_SERVICE_CONNECTION_FAILED = 8300002 | Connection error. Try again later when this error occurs.|
55| TEL_RADIO_ERR_OPERATION_FAILED = 8300003 | Operation failed. Try again later when this error occurs.|
56
57### Telephony_RegState
58
59```
60enum Telephony_RegState
61```
62
63**Description**
64
65Network registration status of the device.
66
67**Since**: 13
68
69| Enum Item| Description|
70| -- | -- |
71| TEL_REG_STATE_NO_SERVICE = 0 | The device cannot use any service.|
72| TEL_REG_STATE_IN_SERVICE = 1 | The device can use services normally. |
73| TEL_REG_STATE_EMERGENCY_CALL_ONLY = 2 | The device can use only the emergency call service.|
74| TEL_REG_STATE_POWER_OFF = 3 | The cellular radio service is disabled.|
75
76### Telephony_RadioTechnology
77
78```
79enum Telephony_RadioTechnology
80```
81
82**Description**
83
84RAT type of the device.
85
86**Since**: 13
87
88| Enum Item| Description|
89| -- | -- |
90| TEL_RADIO_TECHNOLOGY_UNKNOWN = 0 | Unknown RAT|
91| TEL_RADIO_TECHNOLOGY_GSM = 1 | Global System for Mobile Communication (GSM)|
92| TEL_RADIO_TECHNOLOGY_1XRTT = 2 | Single-Carrier Radio Transmission Technology (1XRTT)|
93| TEL_RADIO_TECHNOLOGY_WCDMA = 3 | Wideband Code Division Multiple Access (WCDMA)|
94| TEL_RADIO_TECHNOLOGY_HSPA = 4 | High Speed Packet Access (HSPA)|
95| TEL_RADIO_TECHNOLOGY_HSPAP = 5 |  High Speed Packet Access Plus (HSPA+)|
96| TEL_RADIO_TECHNOLOGY_TD_SCDMA = 6 | Time Division-Synchronous Code Division Multiple Access (TD-SCDMA)|
97| TEL_RADIO_TECHNOLOGY_EVDO = 7 | Evolution-Data Optimized (EVDO)|
98| TEL_RADIO_TECHNOLOGY_EHRPD = 8 | Evolved High Rate Package Data (EHRPD)|
99| TEL_RADIO_TECHNOLOGY_LTE = 9 | Long Term Evolution (LTE)|
100| TEL_RADIO_TECHNOLOGY_LTE_CA = 10 | Long Term Evolution_Carrier Aggregation (LTE_CA)|
101| TEL_RADIO_TECHNOLOGY_IWLAN = 11 | Industrial Wireless LAN (IWLAN)|
102| TEL_RADIO_TECHNOLOGY_NR = 12 | New Radio (NR)|
103
104### Telephony_NsaState
105
106```
107enum Telephony_NsaState
108```
109
110**Description**
111
112NSA network registration status of the device.
113
114**Since**: 13
115
116| Enum Item| Description|
117| -- | -- |
118| TEL_NSA_STATE_NOT_SUPPORTED = 1 | The device is in idle or connected state in an LTE cell that does not support NSA.|
119| TEL_NSA_STATE_NO_DETECTED = 2 | The device is in the idle state in an LTE cell that supports NSA but not NR coverage detection.|
120| TEL_NSA_STATE_CONNECTED_DETECTED = 3 | The device is connected to the LTE network in an LTE cell that supports NSA and NR coverage detection.|
121| TEL_NSA_STATE_IDLE_DETECTED = 4 | The device is in the idle state in an LTE cell that supports NSA and NR coverage detection.|
122| TEL_NSA_STATE_DUAL_CONNECTED = 5 | The device is connected to the LTE/NR network in an LTE cell that supports NSA.|
123| TEL_NSA_STATE_SA_ATTACHED = 6 | The device is idle or connected to the NG-RAN cell when being attached to the 5G Core.|
124