qmi-enums.h

   1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * uqmi -- tiny QMI support implementation
   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 <aleksander@aleksander.es>
  22  */
  23
  24 #ifndef _LIBQMI_GLIB_QMI_ENUMS_H_
  25 #define _LIBQMI_GLIB_QMI_ENUMS_H_
  26
  27 /**
  28  * SECTION: qmi-enums
  29  *
  30  * This section defines common enumerations and flags used in the interface.
  31  */
  32
  33 /**
  34  * QmiService:
  35  * @QMI_SERVICE_UNKNOWN: Unknown service.
  36  * @QMI_SERVICE_CTL: Control service.
  37  * @QMI_SERVICE_WDS: Wireless Data Service.
  38  * @QMI_SERVICE_DMS: Device Management Service.
  39  * @QMI_SERVICE_NAS: Network Access Service.
  40  * @QMI_SERVICE_QOS: Quality Of Service service.
  41  * @QMI_SERVICE_WMS: Wireless Messaging Service.
  42  * @QMI_SERVICE_PDS: Position Determination Service.
  43  * @QMI_SERVICE_AUTH: Authentication service.
  44  * @QMI_SERVICE_AT: AT service.
  45  * @QMI_SERVICE_VOICE: Voice service.
  46  * @QMI_SERVICE_CAT2: Card Application Toolkit service (v2).
  47  * @QMI_SERVICE_UIM: User Identity Module service.
  48  * @QMI_SERVICE_PBM: Phonebook Management service.
  49  * @QMI_SERVICE_QCHAT: QCHAT service. Since: 1.8.
  50  * @QMI_SERVICE_RMTFS: Remote file system service.
  51  * @QMI_SERVICE_TEST: Test service. Since: 1.8.
  52  * @QMI_SERVICE_LOC: Location service (~ PDS v2).
  53  * @QMI_SERVICE_SAR: Service access proxy service.
  54  * @QMI_SERVICE_IMS: IMS settings service. Since: 1.8.
  55  * @QMI_SERVICE_ADC: Analog to digital converter driver service. Since: 1.8.
  56  * @QMI_SERVICE_CSD: Core sound driver service. Since: 1.8.
  57  * @QMI_SERVICE_MFS: Modem embedded file system service. Since: 1.8.
  58  * @QMI_SERVICE_TIME: Time service. Since: 1.8.
  59  * @QMI_SERVICE_TS: Thermal sensors service. Since: 1.8.
  60  * @QMI_SERVICE_TMD: Thermal mitigation device service. Since: 1.8.
  61  * @QMI_SERVICE_SAP: Service access proxy service. Since: 1.8.
  62  * @QMI_SERVICE_WDA: Wireless data administrative service. Since: 1.8.
  63  * @QMI_SERVICE_TSYNC: TSYNC control service. Since: 1.8.
  64  * @QMI_SERVICE_RFSA: Remote file system access service. Since: 1.8.
  65  * @QMI_SERVICE_CSVT: Circuit switched videotelephony service. Since: 1.8.
  66  * @QMI_SERVICE_QCMAP: Qualcomm mobile access point service. Since: 1.8.
  67  * @QMI_SERVICE_IMSP: IMS presence service. Since: 1.8.
  68  * @QMI_SERVICE_IMSVT: IMS videotelephony service. Since: 1.8.
  69  * @QMI_SERVICE_IMSA: IMS application service. Since: 1.8.
  70  * @QMI_SERVICE_COEX: Coexistence service. Since: 1.8.
  71  * @QMI_SERVICE_PDC: Persistent device configuration service. Since: 1.8.
  72  * @QMI_SERVICE_STX: Simultaneous transmit service. Since: 1.8.
  73  * @QMI_SERVICE_BIT: Bearer independent transport service. Since: 1.8.
  74  * @QMI_SERVICE_IMSRTP: IMS RTP service. Since: 1.8.
  75  * @QMI_SERVICE_RFRPE: RF radiated performance enhancement service. Since: 1.8.
  76  * @QMI_SERVICE_DSD: Data system determination service. Since: 1.8.
  77  * @QMI_SERVICE_SSCTL: Subsystem control service. Since: 1.8.
  78  * @QMI_SERVICE_DPM: Data Port Mapper service. Since: 1.30.
  79  * @QMI_SERVICE_CAT: Card Application Toolkit service (v1).
  80  * @QMI_SERVICE_RMS: Remote Management Service.
  81  * @QMI_SERVICE_OMA: Open Mobile Alliance device management service.
  82  * @QMI_SERVICE_FOTA: Firmware Over The Air service. Since: 1.24.
  83  * @QMI_SERVICE_GMS: Telit General Modem Service. Since: 1.24.
  84  * @QMI_SERVICE_GAS: Telit General Application Service. Since: 1.24.
  85  *
  86  * QMI services.
  87  *
  88  * Since: 1.0
  89  */
  90 typedef enum { /*< since=1.0 >*/
  91     QMI_SERVICE_UNKNOWN = -1,
  92     QMI_SERVICE_CTL     = 0x00,
  93     QMI_SERVICE_WDS     = 0x01,
  94     QMI_SERVICE_DMS     = 0x02,
  95     QMI_SERVICE_NAS     = 0x03,
  96     QMI_SERVICE_QOS     = 0x04,
  97     QMI_SERVICE_WMS     = 0x05,
  98     QMI_SERVICE_PDS     = 0x06,
  99     QMI_SERVICE_AUTH    = 0x07,
 100     QMI_SERVICE_AT      = 0x08,
 101     QMI_SERVICE_VOICE   = 0x09,
 102     QMI_SERVICE_CAT2    = 0x0A,
 103     QMI_SERVICE_UIM     = 0x0B,
 104     QMI_SERVICE_PBM     = 0x0C,
 105     QMI_SERVICE_QCHAT   = 0x0D,
 106     QMI_SERVICE_RMTFS   = 0x0E,
 107     QMI_SERVICE_TEST    = 0x0F,
 108     QMI_SERVICE_LOC     = 0x10,
 109     QMI_SERVICE_SAR     = 0x11,
 110     QMI_SERVICE_IMS     = 0x12,
 111     QMI_SERVICE_ADC     = 0x13,
 112     QMI_SERVICE_CSD     = 0x14,
 113     QMI_SERVICE_MFS     = 0x15,
 114     QMI_SERVICE_TIME    = 0x16,
 115     QMI_SERVICE_TS      = 0x17,
 116     QMI_SERVICE_TMD     = 0x18,
 117     QMI_SERVICE_SAP     = 0x19,
 118     QMI_SERVICE_WDA     = 0x1A,
 119     QMI_SERVICE_TSYNC   = 0x1B,
 120     QMI_SERVICE_RFSA    = 0x1C,
 121     QMI_SERVICE_CSVT    = 0x1D,
 122     QMI_SERVICE_QCMAP   = 0x1E,
 123     QMI_SERVICE_IMSP    = 0x1F,
 124     QMI_SERVICE_IMSVT   = 0x20,
 125     QMI_SERVICE_IMSA    = 0x21,
 126     QMI_SERVICE_COEX    = 0x22,
 127     /* 0x23, reserved */
 128     QMI_SERVICE_PDC     = 0x24,
 129     /* 0x25, reserved */
 130     QMI_SERVICE_STX     = 0x26,
 131     QMI_SERVICE_BIT     = 0x27,
 132     QMI_SERVICE_IMSRTP  = 0x28,
 133     QMI_SERVICE_RFRPE   = 0x29,
 134     QMI_SERVICE_DSD     = 0x2A,
 135     QMI_SERVICE_SSCTL   = 0x2B,
 136     QMI_SERVICE_DPM     = 0x2F,
 137     QMI_SERVICE_CAT     = 0xE0,
 138     QMI_SERVICE_RMS     = 0xE1,
 139     QMI_SERVICE_OMA     = 0xE2,
 140     QMI_SERVICE_FOTA    = 0xE6,
 141     QMI_SERVICE_GMS     = 0xE7,
 142     QMI_SERVICE_GAS     = 0xE8,
 143 } QmiService;
 144
 145 /**
 146  * QmiEndian:
 147  * @QMI_ENDIAN_LITTLE: Little endian.
 148  * @QMI_ENDIAN_BIG: Big endian.
 149  *
 150  * Type of endianness.
 151  *
 152  * Since: 1.0
 153  */
 154 typedef enum { /*< since=1.28 >*/   /* the get_string() helper and QmiEndian type added in 1.28 */
 155     QMI_ENDIAN_LITTLE = 0,
 156     QMI_ENDIAN_BIG    = 1
 157 } QmiEndian;
 158
 159 /**
 160  * QmiDataEndpointType:
 161  * @QMI_DATA_ENDPOINT_TYPE_UNKNOWN: Unknown. Since 1.30.
 162  * @QMI_DATA_ENDPOINT_TYPE_HSIC: High-speed inter-chip interface. Since 1.30.
 163  * @QMI_DATA_ENDPOINT_TYPE_HSUSB: High-speed USB.
 164  * @QMI_DATA_ENDPOINT_TYPE_PCIE: PCIe. Since: 1.28.
 165  * @QMI_DATA_ENDPOINT_TYPE_EMBEDDED: Embedded. Since 1.28.
 166  * @QMI_DATA_ENDPOINT_TYPE_BAM_DMUX: BAM/DMUX. Since 1.30.
 167  * @QMI_DATA_ENDPOINT_TYPE_UNDEFINED: Undefined.
 168  *
 169  * Data Endpoint Type.
 170  *
 171  * Since: 1.18
 172  */
 173 typedef enum { /*< since=1.18 >*/
 174     QMI_DATA_ENDPOINT_TYPE_UNKNOWN   = 0x00,
 175     QMI_DATA_ENDPOINT_TYPE_HSIC      = 0x01,
 176     QMI_DATA_ENDPOINT_TYPE_HSUSB     = 0x02,
 177     QMI_DATA_ENDPOINT_TYPE_PCIE      = 0x03,
 178     QMI_DATA_ENDPOINT_TYPE_EMBEDDED  = 0x04,
 179     QMI_DATA_ENDPOINT_TYPE_BAM_DMUX  = 0x05,
 180     QMI_DATA_ENDPOINT_TYPE_UNDEFINED = 0xFF,
 181 } QmiDataEndpointType;
 182
 183 /**
 184  * QmiSioPort:
 185  * @QMI_SIO_PORT_NONE: Invalid port number.
 186  * @QMI_SIO_PORT_A2_MUX_RMNET0: A2 MUX (BAM-DMUX) port for rmnet0.
 187  * @QMI_SIO_PORT_A2_MUX_RMNET1: A2 MUX (BAM-DMUX) port for rmnet1.
 188  * @QMI_SIO_PORT_A2_MUX_RMNET2: A2 MUX (BAM-DMUX) port for rmnet2.
 189  * @QMI_SIO_PORT_A2_MUX_RMNET3: A2 MUX (BAM-DMUX) port for rmnet3.
 190  * @QMI_SIO_PORT_A2_MUX_RMNET4: A2 MUX (BAM-DMUX) port for rmnet4.
 191  * @QMI_SIO_PORT_A2_MUX_RMNET5: A2 MUX (BAM-DMUX) port for rmnet5.
 192  * @QMI_SIO_PORT_A2_MUX_RMNET6: A2 MUX (BAM-DMUX) port for rmnet6.
 193  * @QMI_SIO_PORT_A2_MUX_RMNET7: A2 MUX (BAM-DMUX) port for rmnet7.
 194  *
 195  * SIO (serial I/O) port numbers. All ports available in the modem have a SIO
 196  * port number. This enum is incomplete, only few port numbers are publicly
 197  * known.
 198  *
 199  * Since: 1.28
 200  */
 201 typedef enum { /*< since=1.28 >*/
 202     QMI_SIO_PORT_NONE          = 0x0000,
 203     QMI_SIO_PORT_A2_MUX_RMNET0 = 0x0e04,
 204     QMI_SIO_PORT_A2_MUX_RMNET1 = 0x0e05,
 205     QMI_SIO_PORT_A2_MUX_RMNET2 = 0x0e06,
 206     QMI_SIO_PORT_A2_MUX_RMNET3 = 0x0e07,
 207     QMI_SIO_PORT_A2_MUX_RMNET4 = 0x0e08,
 208     QMI_SIO_PORT_A2_MUX_RMNET5 = 0x0e09,
 209     QMI_SIO_PORT_A2_MUX_RMNET6 = 0x0e0a,
 210     QMI_SIO_PORT_A2_MUX_RMNET7 = 0x0e0b,
 211 } QmiSioPort;
 212
 213 #endif /* _LIBQMI_GLIB_QMI_ENUMS_H_ */