Debian Codegraph @

src/libqmi-glib/qmi-enums-pds.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_PDS_H_
25 #define _LIBQMI_GLIB_QMI_ENUMS_PDS_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-pds
33 * @title: PDS enumerations and flags
34 * @short_description: Enumerations and flags in the PDS service.
35 *
36 * This section defines enumerations and flags used in the PDS service
37 * interface.
38 */
39
40 /*****************************************************************************/
41 /* Helper enums for the 'QMI PDS Event Report' indication */
42
43 /**
44 * QmiPdsOperationMode:
45 * @QMI_PDS_OPERATION_MODE_UNKNOWN: Unknown (position not fixed yet).
46 * @QMI_PDS_OPERATION_MODE_STANDALONE: Standalone.
47 * @QMI_PDS_OPERATION_MODE_MS_BASED: Mobile Station Based (MSB) A-GPS.
48 * @QMI_PDS_OPERATION_MODE_MS_ASSISTED: Mobile Station Assisted (MSA) A-GPS.
49 *
50 * Operation mode used to compute the position.
51 *
52 * Since: 1.0
53 */
54 typedef enum { /*< since=1.0 >*/
55 QMI_PDS_OPERATION_MODE_UNKNOWN = -1,
56 QMI_PDS_OPERATION_MODE_STANDALONE = 0,
57 QMI_PDS_OPERATION_MODE_MS_BASED = 1,
58 QMI_PDS_OPERATION_MODE_MS_ASSISTED = 2
59 } QmiPdsOperationMode;
60
61 /**
62 * QmiPdsPositionSessionStatus:
63 * @QMI_PDS_POSITION_SESSION_STATUS_SUCCESS: Success.
64 * @QMI_PDS_POSITION_SESSION_STATUS_IN_PROGRESS: In progress.
65 * @QMI_PDS_POSITION_SESSION_STATUS_GENERAL_FAILURE: General failure.
66 * @QMI_PDS_POSITION_SESSION_STATUS_TIMEOUT: Timeout.
67 * @QMI_PDS_POSITION_SESSION_STATUS_USER_ENDED_SESSION: User ended session.
68 * @QMI_PDS_POSITION_SESSION_STATUS_BAD_PARAMETER: Bad parameter.
69 * @QMI_PDS_POSITION_SESSION_STATUS_PHONE_OFFLINE: Phone is offline.
70 * @QMI_PDS_POSITION_SESSION_STATUS_ENGINE_LOCKED: Engine locked.
71 * @QMI_PDS_POSITION_SESSION_STATUS_E911_SESSION_IN_PROGRESS: Emergency call in progress.
72 *
73 * Status of the positioning session.
74 *
75 * Since: 1.0
76 */
77 typedef enum { /*< since=1.0 >*/
78 QMI_PDS_POSITION_SESSION_STATUS_SUCCESS = 0x00,
79 QMI_PDS_POSITION_SESSION_STATUS_IN_PROGRESS = 0x01,
80 QMI_PDS_POSITION_SESSION_STATUS_GENERAL_FAILURE = 0x02,
81 QMI_PDS_POSITION_SESSION_STATUS_TIMEOUT = 0x03,
82 QMI_PDS_POSITION_SESSION_STATUS_USER_ENDED_SESSION = 0x04,
83 QMI_PDS_POSITION_SESSION_STATUS_BAD_PARAMETER = 0x05,
84 QMI_PDS_POSITION_SESSION_STATUS_PHONE_OFFLINE = 0x06,
85 QMI_PDS_POSITION_SESSION_STATUS_ENGINE_LOCKED = 0x07,
86 QMI_PDS_POSITION_SESSION_STATUS_E911_SESSION_IN_PROGRESS = 0x08
87 } QmiPdsPositionSessionStatus;
88
89 /**
90 * QmiPdsDataValid:
91 * @QMI_PDS_DATA_VALID_TIMESTAMP_CALENDAR: Timestamp calendar (GPS time).
92 * @QMI_PDS_DATA_VALID_TIMESTAMP_UTC: Timestamp (UTC).
93 * @QMI_PDS_DATA_VALID_LEAP_SECONDS: Leap seconds.
94 * @QMI_PDS_DATA_VALID_TIME_UNCERTAINTY: Time uncertainty.
95 * @QMI_PDS_DATA_VALID_LATITUDE: Latitude.
96 * @QMI_PDS_DATA_VALID_LONGITUDE: Longitude.
97 * @QMI_PDS_DATA_VALID_ELLIPSOID_ALTITUDE: Ellipsoid altitude.
98 * @QMI_PDS_DATA_VALID_MEAN_SEA_LEVEL_ALTITUDE: Mean sea level altitude.
99 * @QMI_PDS_DATA_VALID_HORIZONTAL_SPEED: Horizontal speed.
100 * @QMI_PDS_DATA_VALID_VERTICAL_SPEED: Vertical speed.
101 * @QMI_PDS_DATA_VALID_HEADING: Heading.
102 * @QMI_PDS_DATA_VALID_HORIZONTAL_UNCERTAINTY_CIRCULAR: Horizontal uncertainty circular.
103 * @QMI_PDS_DATA_VALID_HORIZONTAL_UNCERTAINTY_ELLIPSE_SEMI_MAJOR: Horizontal uncertainty ellipse semi-major.
104 * @QMI_PDS_DATA_VALID_HORIZONTAL_UNCERTAINTY_ELLIPSE_SEMI_MINOR: Horizontal uncertainty ellipse semi-minor.
105 * @QMI_PDS_DATA_VALID_HORIZONTAL_UNCERTAINTY_ELLIPSE_ORIENT_AZIMUTH: Horizontal uncertainty ellipse orient azimuth.
106 * @QMI_PDS_DATA_VALID_VERTICAL_UNCERTAINTY: Vertical uncertainty.
107 * @QMI_PDS_DATA_VALID_HORIZONTAL_VELOCITY_UNCERTAINTY: Horizontal velocity uncertainty.
108 * @QMI_PDS_DATA_VALID_VERTICAL_VELOCITY_UNCERTAINTY: Vertical velocity uncertainty.
109 * @QMI_PDS_DATA_VALID_HORIZONTAL_CONFIDENCE: Horizontal confidence.
110 * @QMI_PDS_DATA_VALID_POSITION_DOP: Position dillution of precision.
111 * @QMI_PDS_DATA_VALID_HORIZONTAL_DOP: Horizontal dillution of precision.
112 * @QMI_PDS_DATA_VALID_VERTICAL_DOP: Vertical dillution of precision.
113 * @QMI_PDS_DATA_VALID_OPERATING_MODE: Operating mode.
114 *
115 * Flags to indicate which position data parameters are valid.
116 *
117 * Since: 1.0
118 */
119 typedef enum { /*< since=1.0 >*/
120 QMI_PDS_DATA_VALID_TIMESTAMP_CALENDAR = 1 << 0,
121 QMI_PDS_DATA_VALID_TIMESTAMP_UTC = 1 << 1,
122 QMI_PDS_DATA_VALID_LEAP_SECONDS = 1 << 2,
123 QMI_PDS_DATA_VALID_TIME_UNCERTAINTY = 1 << 3,
124 QMI_PDS_DATA_VALID_LATITUDE = 1 << 4,
125 QMI_PDS_DATA_VALID_LONGITUDE = 1 << 5,
126 QMI_PDS_DATA_VALID_ELLIPSOID_ALTITUDE = 1 << 6,
127 QMI_PDS_DATA_VALID_MEAN_SEA_LEVEL_ALTITUDE = 1 << 7,
128 QMI_PDS_DATA_VALID_HORIZONTAL_SPEED = 1 << 8,
129 QMI_PDS_DATA_VALID_VERTICAL_SPEED = 1 << 9,
130 QMI_PDS_DATA_VALID_HEADING = 1 << 10,
131 QMI_PDS_DATA_VALID_HORIZONTAL_UNCERTAINTY_CIRCULAR = 1 << 11,
132 QMI_PDS_DATA_VALID_HORIZONTAL_UNCERTAINTY_ELLIPSE_SEMI_MAJOR = 1 << 12,
133 QMI_PDS_DATA_VALID_HORIZONTAL_UNCERTAINTY_ELLIPSE_SEMI_MINOR = 1 << 13,
134 QMI_PDS_DATA_VALID_HORIZONTAL_UNCERTAINTY_ELLIPSE_ORIENT_AZIMUTH = 1 << 14,
135 QMI_PDS_DATA_VALID_VERTICAL_UNCERTAINTY = 1 << 15,
136 QMI_PDS_DATA_VALID_HORIZONTAL_VELOCITY_UNCERTAINTY = 1 << 16,
137 QMI_PDS_DATA_VALID_VERTICAL_VELOCITY_UNCERTAINTY = 1 << 17,
138 QMI_PDS_DATA_VALID_HORIZONTAL_CONFIDENCE = 1 << 18,
139 QMI_PDS_DATA_VALID_POSITION_DOP = 1 << 19,
140 QMI_PDS_DATA_VALID_HORIZONTAL_DOP = 1 << 20,
141 QMI_PDS_DATA_VALID_VERTICAL_DOP = 1 << 21,
142 QMI_PDS_DATA_VALID_OPERATING_MODE = 1 << 22
143 } QmiPdsDataValid;
144
145 /*****************************************************************************/
146 /* Helper enums for the 'QMI PDS Get GPS Service State' request/response */
147
148 /**
149 * QmiPdsTrackingSessionState:
150 * @QMI_PDS_TRACKING_SESSION_STATE_UNKNOWN: Unknown state.
151 * @QMI_PDS_TRACKING_SESSION_STATE_INACTIVE: Session inactive.
152 * @QMI_PDS_TRACKING_SESSION_STATE_ACTIVE: Session active.
153 *
154 * State of the tracking session.
155 *
156 * Since: 1.0
157 */
158 typedef enum { /*< since=1.0 >*/
159 QMI_PDS_TRACKING_SESSION_STATE_UNKNOWN = 0,
160 QMI_PDS_TRACKING_SESSION_STATE_INACTIVE = 1,
161 QMI_PDS_TRACKING_SESSION_STATE_ACTIVE = 2
162 } QmiPdsTrackingSessionState;
163
164 /*****************************************************************************/
165 /* Helper enums for the 'QMI PDS Get Default Tracking Session' request/response */
166
167 /**
168 * QmiPdsOperatingMode:
169 * @QMI_PDS_OPERATING_MODE_STANDALONE: Standalone (GPS only).
170 * @QMI_PDS_OPERATING_MODE_MS_BASED: Mobile Station Based (MSB) A-GPS
171 * @QMI_PDS_OPERATING_MODE_MS_ASSISTED: Mobile Station Assisted (MSA) A-GPS.
172 *
173 * GPS operating mode.
174 *
175 * Since: 1.12
176 */
177 typedef enum { /*< since=1.12 >*/
178 QMI_PDS_OPERATING_MODE_STANDALONE = 0,
179 QMI_PDS_OPERATING_MODE_MS_BASED = 1,
180 QMI_PDS_OPERATING_MODE_MS_ASSISTED = 2,
181 } QmiPdsOperatingMode;
182
183 /*****************************************************************************/
184 /* Helper enums for the 'QMI PDS Get AGPS Config' request/response */
185
186 /**
187 * QmiPdsNetworkMode:
188 * @QMI_PDS_NETWORK_MODE_UMTS: UMTS.
189 * @QMI_PDS_NETWORK_MODE_CDMA: CDMA.
190 *
191 * Network mode used during the A-GPS setup.
192 *
193 * Since: 1.12
194 */
195 typedef enum { /*< since=1.12 >*/
196 QMI_PDS_NETWORK_MODE_UMTS = 0,
197 QMI_PDS_NETWORK_MODE_CDMA = 1,
198 } QmiPdsNetworkMode;
199
200 #endif /* _LIBQMI_GLIB_QMI_ENUMS_PDS_H_ */