aboutsummaryrefslogtreecommitdiff
path: root/src/mm-modem.h
blob: c664a3231838b98df66428645db96f880d73b0a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

#ifndef MM_MODEM_H
#define MM_MODEM_H

#include <glib-object.h>

#define MM_TYPE_MODEM      (mm_modem_get_type ())
#define MM_MODEM(obj)      (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_MODEM, MMModem))
#define MM_IS_MODEM(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_MODEM))
#define MM_MODEM_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), MM_TYPE_MODEM, MMModem))

#define MM_MODEM_DATA_DEVICE "data-device"
#define MM_MODEM_DRIVER      "driver"
#define MM_MODEM_TYPE        "type"

#define MM_MODEM_TYPE_GSM  1
#define MM_MODEM_TYPE_CDMA 2

typedef enum {
    MM_MODEM_PROP_FIRST = 0x1000,

    MM_MODEM_PROP_DATA_DEVICE = MM_MODEM_PROP_FIRST,
    MM_MODEM_PROP_DRIVER,
    MM_MODEM_PROP_TYPE
} MMModemProp;

typedef enum {
    MM_MODEM_NETWORK_MODE_ANY       = 0,
    MM_MODEM_NETWORK_MODE_GPRS      = 1,
    MM_MODEM_NETWORK_MODE_EDGE      = 2,
    MM_MODEM_NETWORK_MODE_3G        = 3,
    MM_MODEM_NETWORK_MODE_HSDPA     = 4,
    MM_MODEM_NETWORK_MODE_PREFER_2G = 5,
    MM_MODEM_NETWORK_MODE_PREFER_3G = 6
} MMModemNetworkMode;

typedef enum {
    MM_MODEM_BAND_ANY   = 0,
    MM_MODEM_BAND_EGSM  = 1,  /*  900 MHz */
    MM_MODEM_BAND_DCS   = 2,  /* 1800 MHz */
    MM_MODEM_BAND_PCS   = 3,  /* 1900 MHz */
    MM_MODEM_BAND_G850  = 4,  /*  850 MHz */
    MM_MODEM_BAND_U2100 = 5,  /* WCDMA 2100 MHz               (Class I) */
    MM_MODEM_BAND_U1700 = 6,  /* WCDMA 3GPP UMTS1800 MHz      (Class III) */
    MM_MODEM_BAND_17IV  = 7,  /* WCDMA 3GPP AWS 1700/2100 MHz (Class IV) */
    MM_MODEM_BAND_U800  = 8,  /* WCDMA 3GPP UMTS800 MHz       (Class VI) */
    MM_MODEM_BAND_U850  = 9,  /* WCDMA 3GPP UMTS850 MHz       (Class V) */
    MM_MODEM_BAND_U900  = 10, /* WCDMA 3GPP UMTS900 MHz       (Class VIII) */
    MM_MODEM_BAND_U17IX = 11  /* WCDMA 3GPP UMTS MHz          (Class IX) */
} MMModemBand;

typedef struct _MMModem MMModem;

typedef void (*MMModemFn) (MMModem *modem,
                           GError *error,
                           gpointer user_data);

typedef void (*MMModemUIntFn) (MMModem *modem,
                               guint32 result,
                               GError *error,
                               gpointer user_data);

typedef void (*MMModemScanFn) (MMModem *modem,
                               GPtrArray *results,
                               GError *error,
                               gpointer user_data);

struct _MMModem {
    GTypeInterface g_iface;

    /* Methods */
    void (*enable) (MMModem *self,
                    gboolean enable,
                    MMModemFn callback,
                    gpointer user_data);

    void (*set_pin) (MMModem *self,
                     const char *pin,
                     MMModemFn callback,
                     gpointer user_data);

    /* 'register' is a reserved word */
    void (*do_register) (MMModem *self,
                         const char *network_id,
                         MMModemFn callback,
                         gpointer user_data);

    void (*connect) (MMModem *self,
                     const char *number,
                     const char *apn,
                     MMModemFn callback,
                     gpointer user_data);

    void (*disconnect) (MMModem *self,
                        MMModemFn callback,
                        gpointer user_data);

    void (*scan) (MMModem *self,
                  MMModemScanFn callback,
                  gpointer user_data);

    void (*get_signal_quality) (MMModem *self,
                                MMModemUIntFn callback,
                                gpointer user_data);

    void (*set_band) (MMModem *self,
                      MMModemBand band,
                      MMModemFn callback,
                      gpointer user_data);

    void (*get_band) (MMModem *self,
                      MMModemUIntFn callback,
                      gpointer user_data);

    void (*set_network_mode) (MMModem *self,
                              MMModemNetworkMode mode,
                              MMModemFn callback,
                              gpointer user_data);

    void (*get_network_mode) (MMModem *self,
                              MMModemUIntFn callback,
                              gpointer user_data);

    /* Signals */
    void (*signal_quality) (MMModem *self,
                            guint32 quality);

    void (*network_mode) (MMModem *self,
                          MMModemNetworkMode mode);
};

GType mm_modem_get_type (void);

void mm_modem_enable (MMModem *self,
                      gboolean enable,
                      MMModemFn callback,
                      gpointer user_data);

void mm_modem_set_pin (MMModem *self,
                       const char *pin,
                       MMModemFn callback,
                       gpointer user_data);

void mm_modem_register (MMModem *self,
                        const char *network_id,
                        MMModemFn callback,
                        gpointer user_data);

void mm_modem_connect (MMModem *self,
                       const char *number,
                       const char *apn,
                       MMModemFn callback,
                       gpointer user_data);

void mm_modem_disconnect (MMModem *self,
                          MMModemFn callback,
                          gpointer user_data);

void mm_modem_scan (MMModem *self,
                    MMModemScanFn callback,
                    gpointer user_data);

void mm_modem_get_signal_quality (MMModem *self,
                                  MMModemUIntFn callback,
                                  gpointer user_data);

void mm_modem_set_band (MMModem *self,
                        MMModemBand band,
                        MMModemFn callback,
                        gpointer user_data);

void mm_modem_get_band (MMModem *self,
                        MMModemUIntFn callback,
                        gpointer user_data);

void mm_modem_set_network_mode (MMModem *self,
                                MMModemNetworkMode mode,
                                MMModemFn callback,
                                gpointer user_data);

void mm_modem_get_network_mode (MMModem *self,
                                MMModemUIntFn callback,
                                gpointer user_data);

/* Protected */

void mm_modem_install_dbus_info (GType type);

void mm_modem_signal_quality (MMModem *self,
                              guint32 quality);

void mm_modem_network_mode (MMModem *self,
                            MMModemNetworkMode mode);

#endif  /* MM_MODEM_H */