.gitignore build/ directories
[project/uqmi.git] / qmi-enums-pds.h
index 258911c6c1f2ced47e64e0af12f7d8dccb26e856..b3fbc0df317d6b9dd5ee60a74211136bed30ed2f 100644 (file)
@@ -18,6 +18,7 @@
  * Boston, MA 02110-1301 USA.
  *
  * Copyright (C) 2012 Google Inc.
+ * Copyright (C) 2012-2017 Aleksander Morgado <aleksander@aleksander.es>
  */
 
 #ifndef _LIBQMI_GLIB_QMI_ENUMS_PDS_H_
@@ -25,7 +26,6 @@
 
 /**
  * SECTION: qmi-enums-pds
- * @title: PDS enumerations and flags
  *
  * This section defines enumerations and flags used in the PDS service
  * interface.
  * QmiPdsOperationMode:
  * @QMI_PDS_OPERATION_MODE_UNKNOWN: Unknown (position not fixed yet).
  * @QMI_PDS_OPERATION_MODE_STANDALONE: Standalone.
- * @QMI_PDS_OPERATION_MODE_MS_BASED: MS based.
- * @QMI_PDS_OPERATION_MODE_MS_ASSISTED: MS assisted.
+ * @QMI_PDS_OPERATION_MODE_MS_BASED: Mobile Station Based (MSB) A-GPS.
+ * @QMI_PDS_OPERATION_MODE_MS_ASSISTED: Mobile Station Assisted (MSA) A-GPS.
  *
  * Operation mode used to compute the position.
+ *
+ * Since: 1.0
  */
-typedef enum {
+typedef enum { /*< since=1.0 >*/
     QMI_PDS_OPERATION_MODE_UNKNOWN     = -1,
     QMI_PDS_OPERATION_MODE_STANDALONE  =  0,
     QMI_PDS_OPERATION_MODE_MS_BASED    =  1,
@@ -63,8 +65,10 @@ typedef enum {
  * @QMI_PDS_POSITION_SESSION_STATUS_E911_SESSION_IN_PROGRESS: Emergency call in progress.
  *
  * Status of the positioning session.
+ *
+ * Since: 1.0
  */
-typedef enum {
+typedef enum { /*< since=1.0 >*/
     QMI_PDS_POSITION_SESSION_STATUS_SUCCESS                  = 0x00,
     QMI_PDS_POSITION_SESSION_STATUS_IN_PROGRESS              = 0x01,
     QMI_PDS_POSITION_SESSION_STATUS_GENERAL_FAILURE          = 0x02,
@@ -103,8 +107,10 @@ typedef enum {
  * @QMI_PDS_DATA_VALID_OPERATING_MODE: Operating mode.
  *
  * Flags to indicate which position data parameters are valid.
+ *
+ * Since: 1.0
  */
-typedef enum {
+typedef enum { /*< since=1.0 >*/
     QMI_PDS_DATA_VALID_TIMESTAMP_CALENDAR      = 1 << 0,
     QMI_PDS_DATA_VALID_TIMESTAMP_UTC           = 1 << 1,
     QMI_PDS_DATA_VALID_LEAP_SECONDS            = 1 << 2,
@@ -140,11 +146,49 @@ typedef enum {
  * @QMI_PDS_TRACKING_SESSION_STATE_ACTIVE: Session active.
  *
  * State of the tracking session.
+ *
+ * Since: 1.0
  */
-typedef enum {
+typedef enum { /*< since=1.0 >*/
     QMI_PDS_TRACKING_SESSION_STATE_UNKNOWN  = 0,
     QMI_PDS_TRACKING_SESSION_STATE_INACTIVE = 1,
     QMI_PDS_TRACKING_SESSION_STATE_ACTIVE   = 2
 } QmiPdsTrackingSessionState;
 
+/*****************************************************************************/
+/* Helper enums for the 'QMI PDS Get Default Tracking Session' request/response */
+
+/**
+ * QmiPdsOperatingMode:
+ * @QMI_PDS_OPERATING_MODE_STANDALONE: Standalone (GPS only).
+ * @QMI_PDS_OPERATING_MODE_MS_BASED: Mobile Station Based (MSB) A-GPS
+ * @QMI_PDS_OPERATING_MODE_MS_ASSISTED: Mobile Station Assisted (MSA) A-GPS.
+ *
+ * GPS operating mode.
+ *
+ * Since: 1.12
+ */
+typedef enum { /*< since=1.12 >*/
+    QMI_PDS_OPERATING_MODE_STANDALONE  = 0,
+    QMI_PDS_OPERATING_MODE_MS_BASED    = 1,
+    QMI_PDS_OPERATING_MODE_MS_ASSISTED = 2,
+} QmiPdsOperatingMode;
+
+/*****************************************************************************/
+/* Helper enums for the 'QMI PDS Get AGPS Config' request/response */
+
+/**
+ * QmiPdsNetworkMode:
+ * @QMI_PDS_NETWORK_MODE_UMTS: UMTS.
+ * @QMI_PDS_NETWORK_MODE_CDMA: CDMA.
+ *
+ * Network mode used during the A-GPS setup.
+ *
+ * Since: 1.12
+ */
+typedef enum { /*< since=1.12 >*/
+    QMI_PDS_NETWORK_MODE_UMTS = 0,
+    QMI_PDS_NETWORK_MODE_CDMA = 1,
+} QmiPdsNetworkMode;
+
 #endif /* _LIBQMI_GLIB_QMI_ENUMS_PDS_H_ */