aboutsummaryrefslogtreecommitdiff
path: root/src/mm-base-sim.h
blob: 8339988c0be48c3b544d09d43790c29a460b2d27 (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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details:
 *
 * Author: Aleksander Morgado <aleksander@lanedo.com>
 *
 * Copyright (C) 2011 Google, Inc.
 */

#ifndef MM_BASE_SIM_H
#define MM_BASE_SIM_H

#include <glib.h>
#include <glib-object.h>

#include <mm-gdbus-sim.h>
#include "mm-base-modem.h"

#define MM_TYPE_BASE_SIM            (mm_base_sim_get_type ())
#define MM_BASE_SIM(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_BASE_SIM, MMBaseSim))
#define MM_BASE_SIM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  MM_TYPE_BASE_SIM, MMBaseSimClass))
#define MM_IS_BASE_SIM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_BASE_SIM))
#define MM_IS_BASE_SIM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  MM_TYPE_BASE_SIM))
#define MM_BASE_SIM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  MM_TYPE_BASE_SIM, MMBaseSimClass))

typedef struct _MMBaseSim MMBaseSim;
typedef struct _MMBaseSimClass MMBaseSimClass;
typedef struct _MMBaseSimPrivate MMBaseSimPrivate;

/* Properties */
#define MM_BASE_SIM_PATH        "sim-path"
#define MM_BASE_SIM_CONNECTION  "sim-connection"
#define MM_BASE_SIM_MODEM       "sim-modem"
#define MM_BASE_SIM_SLOT_NUMBER "sim-slot-number"

/* Signals */
#define MM_BASE_SIM_PIN_LOCK_ENABLED "sim-pin-lock-enabled"

struct _MMBaseSim {
    MmGdbusSimSkeleton parent;
    MMBaseSimPrivate *priv;
};

struct _MMBaseSimClass {
    MmGdbusSimSkeletonClass parent;

    /* Wait SIM ready (async) */
    void     (* wait_sim_ready)        (MMBaseSim            *self,
                                        GAsyncReadyCallback   callback,
                                        gpointer              user_data);
    gboolean (* wait_sim_ready_finish) (MMBaseSim            *self,
                                        GAsyncResult         *res,
                                        GError              **error);

    /* Load SIM identifier (async) */
    void    (* load_sim_identifier)        (MMBaseSim *self,
                                            GAsyncReadyCallback callback,
                                            gpointer user_data);
    gchar * (* load_sim_identifier_finish) (MMBaseSim *self,
                                            GAsyncResult *res,
                                            GError **error);

    /* Load IMSI (async) */
    void    (* load_imsi)        (MMBaseSim *self,
                                  GAsyncReadyCallback callback,
                                  gpointer user_data);
    gchar * (* load_imsi_finish) (MMBaseSim *self,
                                  GAsyncResult *res,
                                  GError **error);

    /* Load EID (async) */
    void    (* load_eid)         (MMBaseSim *self,
                                  GAsyncReadyCallback callback,
                                  gpointer user_data);
    gchar * (* load_eid_finish)  (MMBaseSim *self,
                                  GAsyncResult *res,
                                  GError **error);

    /* Load operator identifier (async) */
    void    (* load_operator_identifier)        (MMBaseSim *self,
                                                 GAsyncReadyCallback callback,
                                                 gpointer user_data);
    gchar * (* load_operator_identifier_finish) (MMBaseSim *self,
                                                 GAsyncResult *res,
                                                 GError **error);

    /* Load operator name (async) */
    void    (* load_operator_name)        (MMBaseSim *self,
                                           GAsyncReadyCallback callback,
                                           gpointer user_data);
    gchar * (* load_operator_name_finish) (MMBaseSim *self,
                                           GAsyncResult *res,
                                           GError **error);

    /* Load emergency numbers (async) */
    void  (* load_emergency_numbers)        (MMBaseSim *self,
                                             GAsyncReadyCallback callback,
                                             gpointer user_data);
    GStrv (* load_emergency_numbers_finish) (MMBaseSim *self,
                                             GAsyncResult *res,
                                             GError **error);

    /* Load preferred networks (async) */
    void  (* load_preferred_networks)          (MMBaseSim *self,
                                                GAsyncReadyCallback callback,
                                                gpointer user_data);
    GList * (* load_preferred_networks_finish) (MMBaseSim *self,
                                                GAsyncResult *res,
                                                GError **error);

    /* Load GID1 (async) */
    void         (* load_gid1)         (MMBaseSim            *self,
                                        GAsyncReadyCallback   callback,
                                        gpointer              user_data);
    GByteArray * (* load_gid1_finish)  (MMBaseSim            *self,
                                        GAsyncResult         *res,
                                        GError              **error);

    /* Load GID2 (async) */
    void         (* load_gid2)         (MMBaseSim            *self,
                                        GAsyncReadyCallback   callback,
                                        gpointer              user_data);
    GByteArray * (* load_gid2_finish)  (MMBaseSim            *self,
                                        GAsyncResult         *res,
                                        GError              **error);

    /* Load sim type (async) */
    void      (* load_sim_type)        (MMBaseSim            *self,
                                        GAsyncReadyCallback   callback,
                                        gpointer              user_data);
    MMSimType (* load_sim_type_finish) (MMBaseSim            *self,
                                        GAsyncResult         *res,
                                        GError              **error);

    /* Load esim status (async) */
    void            (* load_esim_status)        (MMBaseSim            *self,
                                                 GAsyncReadyCallback   callback,
                                                 gpointer              user_data);
    MMSimEsimStatus (* load_esim_status_finish) (MMBaseSim            *self,
                                                 GAsyncResult         *res,
                                                 GError              **error);

    /* Load removabilitu (async) */
    void              (* load_removability)        (MMBaseSim            *self,
                                                    GAsyncReadyCallback   callback,
                                                    gpointer              user_data);
    MMSimRemovability (* load_removability_finish) (MMBaseSim            *self,
                                                    GAsyncResult         *res,
                                                    GError              **error);

    /* Change PIN (async) */
    void     (* change_pin)        (MMBaseSim *self,
                                    const gchar *old_pin,
                                    const gchar *new_pin,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data);
    gboolean (* change_pin_finish) (MMBaseSim *self,
                                    GAsyncResult *res,
                                    GError **error);

    /* Enable PIN (async) */
    void     (* enable_pin)        (MMBaseSim *self,
                                    const gchar *pin,
                                    gboolean enabled,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data);
    gboolean (* enable_pin_finish) (MMBaseSim *self,
                                    GAsyncResult *res,
                                    GError **error);

    /* Send PIN (async) */
    void     (* send_pin)        (MMBaseSim *self,
                                  const gchar *pin,
                                  GAsyncReadyCallback callback,
                                  gpointer user_data);
    gboolean (* send_pin_finish) (MMBaseSim *self,
                                  GAsyncResult *res,
                                  GError **error);

    /* Send PUK (async) */
    void     (* send_puk)        (MMBaseSim *self,
                                  const gchar *puk,
                                  const gchar *new_pin,
                                  GAsyncReadyCallback callback,
                                  gpointer user_data);
    gboolean (* send_puk_finish) (MMBaseSim *self,
                                  GAsyncResult *res,
                                  GError **error);

    /* Signals */
    void     (* pin_lock_enabled) (MMBaseSim *self,
                                   gboolean enabled);

    /* Set preferred networks (async) */
    void  (* set_preferred_networks)           (MMBaseSim *self,
                                                GList *preferred_network_list,
                                                GAsyncReadyCallback callback,
                                                gpointer user_data);
    gboolean (* set_preferred_networks_finish) (MMBaseSim *self,
                                                GAsyncResult *res,
                                                GError **error);
};

GType mm_base_sim_get_type (void);
G_DEFINE_AUTOPTR_CLEANUP_FUNC (MMBaseSim, g_object_unref)

void         mm_base_sim_new                        (MMBaseModem *modem,
                                                     GObject *bind_to,
                                                     GCancellable *cancellable,
                                                     GAsyncReadyCallback callback,
                                                     gpointer user_data);
MMBaseSim   *mm_base_sim_new_finish                 (GAsyncResult  *res,
                                                     GError       **error);

void         mm_base_sim_initialize                 (MMBaseSim *self,
                                                     GCancellable *cancellable,
                                                     GAsyncReadyCallback callback,
                                                     gpointer user_data);
gboolean     mm_base_sim_initialize_finish          (MMBaseSim *self,
                                                     GAsyncResult *result,
                                                     GError **error);

MMBaseSim   *mm_base_sim_new_initialized            (MMBaseModem *modem,
                                                     GObject     *bind_to,
                                                     guint        slot_number,
                                                     gboolean     active,
                                                     const gchar *sim_identifier,
                                                     const gchar *imsi,
                                                     const gchar *eid,
                                                     const gchar *operator_identifier,
                                                     const gchar *operator_name,
                                                     const GStrv  emergency_numbers);

void         mm_base_sim_send_pin                   (MMBaseSim *self,
                                                     const gchar *pin,
                                                     GAsyncReadyCallback callback,
                                                     gpointer user_data);
gboolean     mm_base_sim_send_pin_finish            (MMBaseSim *self,
                                                     GAsyncResult *res,
                                                     GError **error);

void         mm_base_sim_send_puk                   (MMBaseSim *self,
                                                     const gchar *puk,
                                                     const gchar *new_pin,
                                                     GAsyncReadyCallback callback,
                                                     gpointer user_data);
gboolean     mm_base_sim_send_puk_finish            (MMBaseSim *self,
                                                     GAsyncResult *res,
                                                     GError **error);

void         mm_base_sim_export                     (MMBaseSim *self);

const gchar *mm_base_sim_get_path                   (MMBaseSim *sim);

guint        mm_base_sim_get_slot_number            (MMBaseSim *self);

void         mm_base_sim_load_sim_identifier        (MMBaseSim *self,
                                                     GAsyncReadyCallback callback,
                                                     gpointer user_data);
gchar       *mm_base_sim_load_sim_identifier_finish (MMBaseSim *self,
                                                     GAsyncResult *res,
                                                     GError **error);

gboolean     mm_base_sim_is_emergency_number (MMBaseSim   *self,
                                              const gchar *number);

gboolean     mm_base_sim_is_esim_without_profiles (MMBaseSim *self);

#endif /* MM_BASE_SIM_H */