Debian Codegraph @

src/libqmi-glib/qmi-enums.h

raw
1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * libqmi-glib -- GLib/GIO based library to control QMI devices
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301 USA.
19 *
20 * Copyright (C) 2012 Google, Inc.
21 * Copyright (C) 2012-2017 Aleksander Morgado <[email protected]>
22 */
23
24 #ifndef _LIBQMI_GLIB_QMI_ENUMS_H_
25 #define _LIBQMI_GLIB_QMI_ENUMS_H_
26
27 #if !defined (__LIBQMI_GLIB_H_INSIDE__) && !defined (LIBQMI_GLIB_COMPILATION)
28 #error "Only <libqmi-glib.h> can be included directly."
29 #endif
30
31 /**
32 * SECTION: qmi-enums
33 * @title: Common enumerations and flags
34 * @short_description: Common enumerations and flags in the library.
35 *
36 * This section defines common enumerations and flags used in the interface.
37 */
38
39 /**
40 * QmiService:
41 * @QMI_SERVICE_UNKNOWN: Unknown service.
42 * @QMI_SERVICE_CTL: Control service.
43 * @QMI_SERVICE_WDS: Wireless Data Service.
44 * @QMI_SERVICE_DMS: Device Management Service.
45 * @QMI_SERVICE_NAS: Network Access Service.
46 * @QMI_SERVICE_QOS: Quality Of Service service.
47 * @QMI_SERVICE_WMS: Wireless Messaging Service.
48 * @QMI_SERVICE_PDS: Position Determination Service.
49 * @QMI_SERVICE_AUTH: Authentication service.
50 * @QMI_SERVICE_AT: AT service.
51 * @QMI_SERVICE_VOICE: Voice service.
52 * @QMI_SERVICE_CAT2: Card Application Toolkit service (v2).
53 * @QMI_SERVICE_UIM: User Identity Module service.
54 * @QMI_SERVICE_PBM: Phonebook Management service.
55 * @QMI_SERVICE_QCHAT: QCHAT service. Since 1.8.
56 * @QMI_SERVICE_RMTFS: Remote file system service.
57 * @QMI_SERVICE_TEST: Test service. Since 1.8.
58 * @QMI_SERVICE_LOC: Location service (~ PDS v2).
59 * @QMI_SERVICE_SAR: Specific absorption rate service.
60 * @QMI_SERVICE_IMS: IMS settings service. Since 1.8.
61 * @QMI_SERVICE_ADC: Analog to digital converter driver service. Since 1.8.
62 * @QMI_SERVICE_CSD: Core sound driver service. Since 1.8.
63 * @QMI_SERVICE_MFS: Modem embedded file system service. Since 1.8.
64 * @QMI_SERVICE_TIME: Time service. Since 1.8.
65 * @QMI_SERVICE_TS: Thermal sensors service. Since 1.8.
66 * @QMI_SERVICE_TMD: Thermal mitigation device service. Since 1.8.
67 * @QMI_SERVICE_SAP: Service access proxy service. Since 1.8.
68 * @QMI_SERVICE_WDA: Wireless data administrative service. Since 1.8.
69 * @QMI_SERVICE_TSYNC: TSYNC control service. Since 1.8.
70 * @QMI_SERVICE_RFSA: Remote file system access service. Since 1.8.
71 * @QMI_SERVICE_CSVT: Circuit switched videotelephony service. Since 1.8.
72 * @QMI_SERVICE_QCMAP: Qualcomm mobile access point service. Since 1.8.
73 * @QMI_SERVICE_IMSP: IMS presence service. Since 1.8.
74 * @QMI_SERVICE_IMSVT: IMS videotelephony service. Since 1.8.
75 * @QMI_SERVICE_IMSA: IMS application service. Since 1.8.
76 * @QMI_SERVICE_COEX: Coexistence service. Since 1.8.
77 * @QMI_SERVICE_PDC: Persistent device configuration service. Since 1.8.
78 * @QMI_SERVICE_STX: Simultaneous transmit service. Since 1.8.
79 * @QMI_SERVICE_BIT: Bearer independent transport service. Since 1.8.
80 * @QMI_SERVICE_IMSRTP: IMS RTP service. Since 1.8.
81 * @QMI_SERVICE_RFRPE: RF radiated performance enhancement service. Since 1.8.
82 * @QMI_SERVICE_DSD: Data system determination service. Since 1.8.
83 * @QMI_SERVICE_SSCTL: Subsystem control service. Since 1.8.
84 * @QMI_SERVICE_DPM: Data Port Mapper service. Since 1.30.
85 * @QMI_SERVICE_CAT: Card Application Toolkit service (v1).
86 * @QMI_SERVICE_RMS: Remote Management Service.
87 * @QMI_SERVICE_OMA: Open Mobile Alliance device management service.
88 * @QMI_SERVICE_FOX: Foxconn General Modem Service. Since 1.32.
89 * @QMI_SERVICE_SSC: Snapdragon Sensore Core Service. Since 1.34.
90 * @QMI_SERVICE_FOTA: Firmware Over The Air service. Since 1.24.
91 * @QMI_SERVICE_GMS: Telit General Modem Service. Since 1.24.
92 * @QMI_SERVICE_GAS: Telit General Application Service. Since 1.24.
93 * @QMI_SERVICE_ATR: Telit AT Relay Service. Since 1.34.
94 * @QMI_SERVICE_IMSDCM: IMS dcm. Since 1.37.
95 *
96 * QMI services.
97 *
98 * Since: 1.0
99 */
100 typedef enum { /*< since=1.0 >*/
101 QMI_SERVICE_UNKNOWN = -1,
102 QMI_SERVICE_CTL = 0x00,
103 QMI_SERVICE_WDS = 0x01,
104 QMI_SERVICE_DMS = 0x02,
105 QMI_SERVICE_NAS = 0x03,
106 QMI_SERVICE_QOS = 0x04,
107 QMI_SERVICE_WMS = 0x05,
108 QMI_SERVICE_PDS = 0x06,
109 QMI_SERVICE_AUTH = 0x07,
110 QMI_SERVICE_AT = 0x08,
111 QMI_SERVICE_VOICE = 0x09,
112 QMI_SERVICE_CAT2 = 0x0A,
113 QMI_SERVICE_UIM = 0x0B,
114 QMI_SERVICE_PBM = 0x0C,
115 QMI_SERVICE_QCHAT = 0x0D,
116 QMI_SERVICE_RMTFS = 0x0E,
117 QMI_SERVICE_TEST = 0x0F,
118 QMI_SERVICE_LOC = 0x10,
119 QMI_SERVICE_SAR = 0x11,
120 QMI_SERVICE_IMS = 0x12,
121 QMI_SERVICE_ADC = 0x13,
122 QMI_SERVICE_CSD = 0x14,
123 QMI_SERVICE_MFS = 0x15,
124 QMI_SERVICE_TIME = 0x16,
125 QMI_SERVICE_TS = 0x17,
126 QMI_SERVICE_TMD = 0x18,
127 QMI_SERVICE_SAP = 0x19,
128 QMI_SERVICE_WDA = 0x1A,
129 QMI_SERVICE_TSYNC = 0x1B,
130 QMI_SERVICE_RFSA = 0x1C,
131 QMI_SERVICE_CSVT = 0x1D,
132 QMI_SERVICE_QCMAP = 0x1E,
133 QMI_SERVICE_IMSP = 0x1F,
134 QMI_SERVICE_IMSVT = 0x20,
135 QMI_SERVICE_IMSA = 0x21,
136 QMI_SERVICE_COEX = 0x22,
137 /* 0x23, reserved */
138 QMI_SERVICE_PDC = 0x24,
139 /* 0x25, reserved */
140 QMI_SERVICE_STX = 0x26,
141 QMI_SERVICE_BIT = 0x27,
142 QMI_SERVICE_IMSRTP = 0x28,
143 QMI_SERVICE_RFRPE = 0x29,
144 QMI_SERVICE_DSD = 0x2A,
145 QMI_SERVICE_SSCTL = 0x2B,
146 QMI_SERVICE_DPM = 0x2F,
147 QMI_SERVICE_CAT = 0xE0,
148 QMI_SERVICE_RMS = 0xE1,
149 QMI_SERVICE_OMA = 0xE2,
150 QMI_SERVICE_FOX = 0xE3,
151 QMI_SERVICE_FOTA = 0xE6,
152 QMI_SERVICE_GMS = 0xE7,
153 QMI_SERVICE_GAS = 0xE8,
154 QMI_SERVICE_ATR = 0xED,
155 QMI_SERVICE_SSC = 0x190,
156 QMI_SERVICE_IMSDCM = 0x302,
157 } QmiService;
158
159 /**
160 * QmiEndian:
161 * @QMI_ENDIAN_LITTLE: Little endian.
162 * @QMI_ENDIAN_BIG: Big endian.
163 *
164 * Type of endianness.
165 *
166 * Since: 1.0
167 */
168 typedef enum { /*< since=1.28 >*/ /* the get_string() helper and QmiEndian type added in 1.28 */
169 QMI_ENDIAN_LITTLE = 0,
170 QMI_ENDIAN_BIG = 1
171 } QmiEndian;
172
173 /**
174 * QmiDataEndpointType:
175 * @QMI_DATA_ENDPOINT_TYPE_UNKNOWN: Unknown. Since 1.30.
176 * @QMI_DATA_ENDPOINT_TYPE_HSIC: High-speed inter-chip interface. Since 1.30.
177 * @QMI_DATA_ENDPOINT_TYPE_HSUSB: High-speed USB.
178 * @QMI_DATA_ENDPOINT_TYPE_PCIE: PCIe. Since 1.28.
179 * @QMI_DATA_ENDPOINT_TYPE_EMBEDDED: Embedded. Since 1.28.
180 * @QMI_DATA_ENDPOINT_TYPE_BAM_DMUX: BAM/DMUX. Since 1.30.
181 * @QMI_DATA_ENDPOINT_TYPE_UNDEFINED: Undefined.
182 *
183 * Data Endpoint Type.
184 *
185 * Since: 1.18
186 */
187 typedef enum { /*< since=1.18 >*/
188 QMI_DATA_ENDPOINT_TYPE_UNKNOWN = 0x00,
189 QMI_DATA_ENDPOINT_TYPE_HSIC = 0x01,
190 QMI_DATA_ENDPOINT_TYPE_HSUSB = 0x02,
191 QMI_DATA_ENDPOINT_TYPE_PCIE = 0x03,
192 QMI_DATA_ENDPOINT_TYPE_EMBEDDED = 0x04,
193 QMI_DATA_ENDPOINT_TYPE_BAM_DMUX = 0x05,
194 QMI_DATA_ENDPOINT_TYPE_UNDEFINED = 0xFF,
195 } QmiDataEndpointType;
196
197 /**
198 * QmiSioPort:
199 * @QMI_SIO_PORT_NONE: Invalid port number.
200 * @QMI_SIO_PORT_A2_MUX_RMNET0: A2 MUX (BAM-DMUX) port for rmnet0.
201 * @QMI_SIO_PORT_A2_MUX_RMNET1: A2 MUX (BAM-DMUX) port for rmnet1.
202 * @QMI_SIO_PORT_A2_MUX_RMNET2: A2 MUX (BAM-DMUX) port for rmnet2.
203 * @QMI_SIO_PORT_A2_MUX_RMNET3: A2 MUX (BAM-DMUX) port for rmnet3.
204 * @QMI_SIO_PORT_A2_MUX_RMNET4: A2 MUX (BAM-DMUX) port for rmnet4.
205 * @QMI_SIO_PORT_A2_MUX_RMNET5: A2 MUX (BAM-DMUX) port for rmnet5.
206 * @QMI_SIO_PORT_A2_MUX_RMNET6: A2 MUX (BAM-DMUX) port for rmnet6.
207 * @QMI_SIO_PORT_A2_MUX_RMNET7: A2 MUX (BAM-DMUX) port for rmnet7.
208 *
209 * SIO (serial I/O) port numbers. All ports available in the modem have a SIO
210 * port number. This enum is incomplete, only few port numbers are publicly
211 * known.
212 *
213 * Since: 1.28
214 */
215 typedef enum { /*< since=1.28 >*/
216 QMI_SIO_PORT_NONE = 0x0000,
217 QMI_SIO_PORT_A2_MUX_RMNET0 = 0x0e04,
218 QMI_SIO_PORT_A2_MUX_RMNET1 = 0x0e05,
219 QMI_SIO_PORT_A2_MUX_RMNET2 = 0x0e06,
220 QMI_SIO_PORT_A2_MUX_RMNET3 = 0x0e07,
221 QMI_SIO_PORT_A2_MUX_RMNET4 = 0x0e08,
222 QMI_SIO_PORT_A2_MUX_RMNET5 = 0x0e09,
223 QMI_SIO_PORT_A2_MUX_RMNET6 = 0x0e0a,
224 QMI_SIO_PORT_A2_MUX_RMNET7 = 0x0e0b,
225 } QmiSioPort;
226
227 /**
228 * QmiSubscriptionType:
229 * @QMI_SUBSCRIPTION_TYPE_DEFAULT: Default.
230 * @QMI_SUBSCRIPTION_TYPE_PRIMARY: Primary
231 * @QMI_SUBSCRIPTION_TYPE_SECONDARY: Secondary.
232 * @QMI_SUBSCRIPTION_TYPE_TERITIARY: Teritiary.
233 * @QMI_SUBSCRIPTION_TYPE_ANY: Any.
234 *
235 * Subscription Type
236 *
237 * Since: 1.37
238 */
239 typedef enum { /*< since=1.37 >*/
240 QMI_SUBSCRIPTION_TYPE_DEFAULT = 0x00,
241 QMI_SUBSCRIPTION_TYPE_PRIMARY = 0x01,
242 QMI_SUBSCRIPTION_TYPE_SECONDARY = 0x02,
243 QMI_SUBSCRIPTION_TYPE_TERITIARY = 0x03,
244 QMI_SUBSCRIPTION_TYPE_ANY = 0xff,
245 } QmiSubscriptionType;
246
247 #endif /* _LIBQMI_GLIB_QMI_ENUMS_H_ */