aboutsummaryrefslogtreecommitdiff
path: root/src/mm-iface-modem-3gpp-ussd.h
blob: 9e1dc43376675af27be515243fd1713877a7cdaf (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
/* -*- 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:
 *
 * Copyright (C) 2010 Guido Guenther <agx@sigxcpu.org>
 * Copyright (C) 2012 Google, Inc.
 */

#ifndef MM_IFACE_MODEM_3GPP_USSD_H
#define MM_IFACE_MODEM_3GPP_USSD_H

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

#define _LIBMM_INSIDE_MM
#include <libmm-glib.h>

#include "mm-at-serial-port.h"

#define MM_TYPE_IFACE_MODEM_3GPP_USSD               (mm_iface_modem_3gpp_ussd_get_type ())
#define MM_IFACE_MODEM_3GPP_USSD(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_IFACE_MODEM_3GPP_USSD, MMIfaceModem3gppUssd))
#define MM_IS_IFACE_MODEM_3GPP_USSD(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_IFACE_MODEM_3GPP_USSD))
#define MM_IFACE_MODEM_3GPP_USSD_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), MM_TYPE_IFACE_MODEM_3GPP_USSD, MMIfaceModem3gppUssd))

/* CBS data coding scheme - 3GPP TS 23.038 */
#define MM_MODEM_GSM_USSD_SCHEME_7BIT 0b00001111
#define MM_MODEM_GSM_USSD_SCHEME_UCS2 0b01001000

#define MM_IFACE_MODEM_3GPP_USSD_DBUS_SKELETON "iface-modem-3gpp-ussd-dbus-skeleton"

typedef struct _MMIfaceModem3gppUssd MMIfaceModem3gppUssd;

struct _MMIfaceModem3gppUssd {
    GTypeInterface g_iface;

    /* Check for USSD support (async) */
    void (* check_support) (MMIfaceModem3gppUssd *self,
                            GAsyncReadyCallback callback,
                            gpointer user_data);
    gboolean (*check_support_finish) (MMIfaceModem3gppUssd *self,
                                      GAsyncResult *res,
                                      GError **error);

    /* Asynchronous setup of unsolicited result codes */
    void (*setup_unsolicited_result_codes) (MMIfaceModem3gppUssd *self,
                                            GAsyncReadyCallback callback,
                                            gpointer user_data);
    gboolean (*setup_unsolicited_result_codes_finish) (MMIfaceModem3gppUssd *self,
                                                       GAsyncResult *res,
                                                       GError **error);

    /* Asynchronous enabling of unsolicited result codes */
    void (*enable_unsolicited_result_codes) (MMIfaceModem3gppUssd *self,
                                             GAsyncReadyCallback callback,
                                             gpointer user_data);
    gboolean (*enable_unsolicited_result_codes_finish) (MMIfaceModem3gppUssd *self,
                                                        GAsyncResult *res,
                                                        GError **error);

    /* Asynchronous disabling of unsolicited result codes */
    void (*disable_unsolicited_result_codes) (MMIfaceModem3gppUssd *self,
                                              GAsyncReadyCallback callback,
                                              gpointer user_data);
    gboolean (*disable_unsolicited_result_codes_finish) (MMIfaceModem3gppUssd *self,
                                                         GAsyncResult *res,
                                                         GError **error);

    /* Asynchronous cleaning up of unsolicited result codes */
    void (*cleanup_unsolicited_result_codes) (MMIfaceModem3gppUssd *self,
                                              GAsyncReadyCallback callback,
                                              gpointer user_data);
    gboolean (*cleanup_unsolicited_result_codes_finish) (MMIfaceModem3gppUssd *self,
                                                         GAsyncResult *res,
                                                         GError **error);

    /* Encode/Decode */
    gchar * (*encode) (MMIfaceModem3gppUssd *self,
                       const gchar *command,
                       guint *scheme,
                       GError **error);
    gchar * (*decode) (MMIfaceModem3gppUssd *self,
                       const gchar *reply,
                       GError **error);

    /* Send command */
    void (* send) (MMIfaceModem3gppUssd *self,
                   const gchar *command,
                   GAsyncReadyCallback callback,
                   gpointer user_data);
    const gchar * (* send_finish) (MMIfaceModem3gppUssd *self,
                                   GAsyncResult *res,
                                   GError **error);

    /* Cancel */
    void (* cancel) (MMIfaceModem3gppUssd *self,
                     GAsyncReadyCallback callback,
                     gpointer user_data);
    gboolean (* cancel_finish) (MMIfaceModem3gppUssd *self,
                                GAsyncResult *res,
                                GError **error);
};

GType mm_iface_modem_3gpp_ussd_get_type (void);

/* Initialize USSD interface (async) */
void     mm_iface_modem_3gpp_ussd_initialize        (MMIfaceModem3gppUssd *self,
                                                     GAsyncReadyCallback callback,
                                                     gpointer user_data);
gboolean mm_iface_modem_3gpp_ussd_initialize_finish (MMIfaceModem3gppUssd *self,
                                                     GAsyncResult *res,
                                                     GError **error);

/* Enable USSD interface (async) */
void     mm_iface_modem_3gpp_ussd_enable        (MMIfaceModem3gppUssd *self,
                                                 GAsyncReadyCallback callback,
                                                 gpointer user_data);
gboolean mm_iface_modem_3gpp_ussd_enable_finish (MMIfaceModem3gppUssd *self,
                                                 GAsyncResult *res,
                                                 GError **error);

/* Disable USSD interface (async) */
void     mm_iface_modem_3gpp_ussd_disable        (MMIfaceModem3gppUssd *self,
                                                  GAsyncReadyCallback callback,
                                                  gpointer user_data);
gboolean mm_iface_modem_3gpp_ussd_disable_finish (MMIfaceModem3gppUssd *self,
                                                  GAsyncResult *res,
                                                  GError **error);

/* Property updaters */
void mm_iface_modem_3gpp_ussd_update_state                (MMIfaceModem3gppUssd *self,
                                                           MMModem3gppUssdSessionState new_state);
void mm_iface_modem_3gpp_ussd_update_network_notification (MMIfaceModem3gppUssd *self,
                                                           const gchar *network_notification);
void mm_iface_modem_3gpp_ussd_update_network_request      (MMIfaceModem3gppUssd *self,
                                                           const gchar *network_request);

/* Encode/Decode USSD */
gchar *mm_iface_modem_3gpp_ussd_encode (MMIfaceModem3gppUssd *self,
                                        const gchar *command,
                                        guint *scheme,
                                        GError **error);
gchar *mm_iface_modem_3gpp_ussd_decode (MMIfaceModem3gppUssd *self,
                                        const gchar *reply,
                                        GError **error);

/* Shutdown USSD interface */
void mm_iface_modem_3gpp_ussd_shutdown (MMIfaceModem3gppUssd *self);

/* Bind properties for simple GetStatus() */
void mm_iface_modem_3gpp_ussd_bind_simple_status (MMIfaceModem3gppUssd *self,
                                                  MMSimpleStatus *status);

#endif /* MM_IFACE_MODEM_3GPP_USSD_H */