aboutsummaryrefslogtreecommitdiff
path: root/src/mm-modem.c
blob: b3c1677d5f93a72fc6e7f7a20efb486652211897 (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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
/* -*- 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) 2008 - 2009 Novell, Inc.
 * Copyright (C) 2009 - 2010 Red Hat, Inc.
 */

#include <config.h>
#include <string.h>
#include <dbus/dbus-glib.h>
#include "mm-modem.h"
#include "mm-log.h"
#include "mm-errors.h"
#include "mm-callback-info.h"
#include "mm-marshal.h"

static void impl_modem_enable (MMModem *modem, gboolean enable, DBusGMethodInvocation *context);
static void impl_modem_connect (MMModem *modem, const char *number, DBusGMethodInvocation *context);
static void impl_modem_disconnect (MMModem *modem, DBusGMethodInvocation *context);
static void impl_modem_get_ip4_config (MMModem *modem, DBusGMethodInvocation *context);
static void impl_modem_get_info (MMModem *modem, DBusGMethodInvocation *context);
static void impl_modem_reset (MMModem *modem, DBusGMethodInvocation *context);
static void impl_modem_factory_reset (MMModem *modem, const char *code, DBusGMethodInvocation *context);

#include "mm-modem-glue.h"

static void
async_op_not_supported (MMModem *self,
                        MMModemFn callback,
                        gpointer user_data)
{
    MMCallbackInfo *info;

    info = mm_callback_info_new (self, callback, user_data);
    info->error = g_error_new_literal (MM_MODEM_ERROR, MM_MODEM_ERROR_OPERATION_NOT_SUPPORTED,
                                       "Operation not supported");
    mm_callback_info_schedule (info);
}

static void
async_call_done (MMModem *modem, GError *error, gpointer user_data)
{
    DBusGMethodInvocation *context = (DBusGMethodInvocation *) user_data;

    if (error)
        dbus_g_method_return_error (context, error);
    else
        dbus_g_method_return (context);
}

void
mm_modem_enable (MMModem *self,
                 MMModemFn callback,
                 gpointer user_data)
{
    MMModemState state;

    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (callback != NULL);

    state = mm_modem_get_state (self);
    if (state >= MM_MODEM_STATE_ENABLED) {
        MMCallbackInfo *info;

        info = mm_callback_info_new (self, callback, user_data);

        if (state == MM_MODEM_STATE_ENABLING) {
            info->error = g_error_new_literal (MM_MODEM_ERROR,
                                               MM_MODEM_ERROR_OPERATION_IN_PROGRESS,
                                               "The device is already being enabled.");
        } else {
            /* Already enabled */
        }

        mm_callback_info_schedule (info);
        return;
    }

    if (MM_MODEM_GET_INTERFACE (self)->enable)
        MM_MODEM_GET_INTERFACE (self)->enable (self, callback, user_data);
    else
        async_op_not_supported (self, callback, user_data);
}

static void
finish_disable (MMModem *self,
                MMModemFn callback,
                gpointer user_data)
{
    if (MM_MODEM_GET_INTERFACE (self)->disable)
        MM_MODEM_GET_INTERFACE (self)->disable (self, callback, user_data);
    else
        async_op_not_supported (self, callback, user_data);
}

typedef struct {
    MMModemFn callback;
    gpointer user_data;
} DisableDisconnectInfo;

static void
disable_disconnect_done (MMModem *self,
                         GError *error,
                         gpointer user_data)
{
    DisableDisconnectInfo *cb_data = user_data;
    GError *tmp_error = NULL;

    /* Check for modem removal */
    if (g_error_matches (error, MM_MODEM_ERROR, MM_MODEM_ERROR_REMOVED))
        tmp_error = g_error_copy (error);
    else if (!self) {
        tmp_error = g_error_new_literal (MM_MODEM_ERROR,
                                         MM_MODEM_ERROR_REMOVED,
                                         "The modem was removed.");
    }

    /* And send an immediate error reply if the modem was removed */
    if (tmp_error) {
        cb_data->callback (NULL, tmp_error, cb_data->user_data);
        g_free (cb_data);
        g_error_free (tmp_error);
        return;
    }

    if (error) {
        char *device = mm_modem_get_device (self);

        /* Don't really care what the error was; log it and proceed to disable */
        g_warning ("%s: (%s): error disconnecting the modem while disabling: (%d) %s",
                   __func__,
                   device,
                   error ? error->code : -1,
                   error && error->message ? error->message : "(unknown)");
        g_free (device);
    }
    finish_disable (self, cb_data->callback, cb_data->user_data);
    g_free (cb_data);
}

void
mm_modem_disable (MMModem *self,
                  MMModemFn callback,
                  gpointer user_data)
{
    MMModemState state;

    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (callback != NULL);

    state = mm_modem_get_state (self);
    if (state <= MM_MODEM_STATE_DISABLING) {
        MMCallbackInfo *info;

        info = mm_callback_info_new (self, callback, user_data);

        if (state == MM_MODEM_STATE_DISABLING) {
            info->error = g_error_new_literal (MM_MODEM_ERROR,
                                               MM_MODEM_ERROR_OPERATION_IN_PROGRESS,
                                               "The device is already being disabled.");
        } else {
            /* Already disabled */
        }

        mm_callback_info_schedule (info);
        return;
    }

    /* If the modem is connected, disconnect it */
    if (state >= MM_MODEM_STATE_CONNECTING) {
        DisableDisconnectInfo *cb_data;

        cb_data = g_malloc0 (sizeof (DisableDisconnectInfo));
        cb_data->callback = callback;
        cb_data->user_data = user_data;
        mm_modem_disconnect (self, disable_disconnect_done, cb_data);
    } else
        finish_disable (self, callback, user_data);
}

static void
impl_modem_enable (MMModem *modem,
                   gboolean enable,
                   DBusGMethodInvocation *context)
{
    if (enable)
        mm_modem_enable (modem, async_call_done, context);
    else
        mm_modem_disable (modem, async_call_done, context);
}

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

    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (callback != NULL);
    g_return_if_fail (number != NULL);

    state = mm_modem_get_state (self);
    if (state >= MM_MODEM_STATE_CONNECTING) {
        MMCallbackInfo *info;

        /* Already connecting */
        info = mm_callback_info_new (self, callback, user_data);
        if (state == MM_MODEM_STATE_CONNECTING) {
            info->error = g_error_new_literal (MM_MODEM_ERROR,
                                               MM_MODEM_ERROR_OPERATION_IN_PROGRESS,
                                               "The device is already being connected.");
        } else {
            /* already connected */
        }

        mm_callback_info_schedule (info);
        return;
    }

    if (MM_MODEM_GET_INTERFACE (self)->connect)
        MM_MODEM_GET_INTERFACE (self)->connect (self, number, callback, user_data);
    else
        async_op_not_supported (self, callback, user_data);
}

static void
impl_modem_connect (MMModem *modem,
                    const char *number,
                    DBusGMethodInvocation *context)
{
    mm_modem_connect (modem, number, async_call_done, context);
}

static void
get_ip4_invoke (MMCallbackInfo *info)
{
    MMModemIp4Fn callback = (MMModemIp4Fn) info->callback;

    callback (info->modem,
              GPOINTER_TO_UINT (mm_callback_info_get_data (info, "ip4-address")),
              (GArray *) mm_callback_info_get_data (info, "ip4-dns"),
              info->error, info->user_data);
}

void
mm_modem_get_ip4_config (MMModem *self,
                         MMModemIp4Fn callback,
                         gpointer user_data)
{
    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (callback != NULL);

    if (MM_MODEM_GET_INTERFACE (self)->get_ip4_config)
        MM_MODEM_GET_INTERFACE (self)->get_ip4_config (self, callback, user_data);
    else {
        MMCallbackInfo *info;

        info = mm_callback_info_new_full (self,
                                          get_ip4_invoke,
                                          G_CALLBACK (callback),
                                          user_data);

        info->error = g_error_new_literal (MM_MODEM_ERROR, MM_MODEM_ERROR_OPERATION_NOT_SUPPORTED,
                                           "Operation not supported");
        mm_callback_info_schedule (info);
    }
}

static void
value_array_add_uint (GValueArray *array, guint32 i)
{
    GValue value = { 0, };

    g_value_init (&value, G_TYPE_UINT);
    g_value_set_uint (&value, i);
    g_value_array_append (array, &value);
    g_value_unset (&value);
}

static void
get_ip4_done (MMModem *modem,
              guint32 address,
              GArray *dns,
              GError *error,
              gpointer user_data)
{
    DBusGMethodInvocation *context = (DBusGMethodInvocation *) user_data;

    if (error)
        dbus_g_method_return_error (context, error);
    else {
        GValueArray *array;
        guint32 dns1 = 0;
        guint32 dns2 = 0;
        guint32 dns3 = 0;

        array = g_value_array_new (4);

        if (dns) {
            if (dns->len > 0)

                dns1 = g_array_index (dns, guint32, 0);
            if (dns->len > 1)
                dns2 = g_array_index (dns, guint32, 1);
            if (dns->len > 2)
                dns3 = g_array_index (dns, guint32, 2);
        }

        value_array_add_uint (array, address);
        value_array_add_uint (array, dns1);
        value_array_add_uint (array, dns2);
        value_array_add_uint (array, dns3);

        dbus_g_method_return (context, array);
    }
}

static void
impl_modem_get_ip4_config (MMModem *modem,
                           DBusGMethodInvocation *context)
{
    mm_modem_get_ip4_config (modem, get_ip4_done, context);
}

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

    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (callback != NULL);

    state = mm_modem_get_state (self);
    if (state <= MM_MODEM_STATE_DISCONNECTING) {
        MMCallbackInfo *info;

        /* Already connecting */
        info = mm_callback_info_new (self, callback, user_data);
        if (state == MM_MODEM_STATE_DISCONNECTING) {
            info->error = g_error_new_literal (MM_MODEM_ERROR,
                                               MM_MODEM_ERROR_OPERATION_IN_PROGRESS,
                                               "The device is already being disconnected.");
        } else {
            /* already disconnected */
        }

        mm_callback_info_schedule (info);
        return;
    }

    if (MM_MODEM_GET_INTERFACE (self)->disconnect)
        MM_MODEM_GET_INTERFACE (self)->disconnect (self, callback, user_data);
    else
        async_op_not_supported (self, callback, user_data);
}

static void
impl_modem_disconnect (MMModem *modem,
                       DBusGMethodInvocation *context)
{
    mm_modem_disconnect (modem, async_call_done, context);
}

static void
info_call_done (MMModem *self,
                const char *manufacturer,
                const char *model,
                const char *version,
                GError *error,
                gpointer user_data)
{
    DBusGMethodInvocation *context = (DBusGMethodInvocation *) user_data;

    if (error)
        dbus_g_method_return_error (context, error);
    else {
        GValueArray *array;
        GValue value = { 0, };

        array = g_value_array_new (3);

        /* Manufacturer */
        g_value_init (&value, G_TYPE_STRING);
        g_value_set_string (&value, manufacturer);
        g_value_array_append (array, &value);
        g_value_unset (&value);

        /* Model */
        g_value_init (&value, G_TYPE_STRING);
        g_value_set_string (&value, model);
        g_value_array_append (array, &value);
        g_value_unset (&value);

        /* Version */
        g_value_init (&value, G_TYPE_STRING);
        g_value_set_string (&value, version);
        g_value_array_append (array, &value);
        g_value_unset (&value);

        dbus_g_method_return (context, array);
    }
}

static void
info_invoke (MMCallbackInfo *info)
{
    MMModemInfoFn callback = (MMModemInfoFn) info->callback;

    callback (info->modem, NULL, NULL, NULL, info->error, info->user_data);
}

static void
info_call_not_supported (MMModem *self,
                         MMModemInfoFn callback,
                         gpointer user_data)
{
    MMCallbackInfo *info;

    info = mm_callback_info_new_full (MM_MODEM (self), info_invoke, G_CALLBACK (callback), user_data);
    info->error = g_error_new_literal (MM_MODEM_ERROR, MM_MODEM_ERROR_OPERATION_NOT_SUPPORTED,
                                       "Operation not supported");

    mm_callback_info_schedule (info);
}

void
mm_modem_get_info (MMModem *self,
                   MMModemInfoFn callback,
                   gpointer user_data)
{
    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (callback != NULL);

    if (MM_MODEM_GET_INTERFACE (self)->get_info)
        MM_MODEM_GET_INTERFACE (self)->get_info (self, callback, user_data);
    else
        info_call_not_supported (self, callback, user_data);
}

static void
impl_modem_get_info (MMModem *modem,
                     DBusGMethodInvocation *context)
{
    mm_modem_get_info (modem, info_call_done, context);
}

/*****************************************************************************/

static void
reset_auth_cb (MMAuthRequest *req,
               GObject *owner,
               DBusGMethodInvocation *context,
               gpointer user_data)
{
    MMModem *self = MM_MODEM (owner);
    GError *error = NULL;

    /* Return any authorization error, otherwise try to reset the modem */
    if (!mm_modem_auth_finish (self, req, &error)) {
        dbus_g_method_return_error (context, error);
        g_error_free (error);
    } else
        mm_modem_reset (self, async_call_done, context);
}

static void
impl_modem_reset (MMModem *modem, DBusGMethodInvocation *context)
{
    GError *error = NULL;

    /* Make sure the caller is authorized to reset the device */
    if (!mm_modem_auth_request (MM_MODEM (modem),
                                MM_AUTHORIZATION_DEVICE_CONTROL,
                                context,
                                reset_auth_cb,
                                NULL, NULL,
                                &error)) {
        dbus_g_method_return_error (context, error);
        g_error_free (error);
    }
}

void
mm_modem_reset (MMModem *self,
                MMModemFn callback,
                gpointer user_data)
{
    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (callback != NULL);

    if (MM_MODEM_GET_INTERFACE (self)->reset)
        MM_MODEM_GET_INTERFACE (self)->reset (self, callback, user_data);
    else
        async_op_not_supported (self, callback, user_data);
}

/*****************************************************************************/

static void
factory_reset_auth_cb (MMAuthRequest *req,
                       GObject *owner,
                       DBusGMethodInvocation *context,
                       gpointer user_data)
{
    MMModem *self = MM_MODEM (owner);
    const char *code = user_data;
    GError *error = NULL;

    /* Return any authorization error, otherwise try to reset the modem */
    if (!mm_modem_auth_finish (self, req, &error)) {
        dbus_g_method_return_error (context, error);
        g_error_free (error);
    } else
        mm_modem_factory_reset (self, code, async_call_done, context);
}

static void
impl_modem_factory_reset (MMModem *modem,
                          const char *code,
                          DBusGMethodInvocation *context)
{
    GError *error = NULL;

    /* Make sure the caller is authorized to reset the device */
    if (!mm_modem_auth_request (MM_MODEM (modem),
                                MM_AUTHORIZATION_DEVICE_CONTROL,
                                context,
                                factory_reset_auth_cb,
                                g_strdup (code),
                                g_free,
                                &error)) {
        dbus_g_method_return_error (context, error);
        g_error_free (error);
    }
}

void
mm_modem_factory_reset (MMModem *self,
                        const char *code,
                        MMModemFn callback,
                        gpointer user_data)
{
    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (callback != NULL);
    g_return_if_fail (code != NULL);

    if (MM_MODEM_GET_INTERFACE (self)->factory_reset)
        MM_MODEM_GET_INTERFACE (self)->factory_reset (self, code, callback, user_data);
    else
        async_op_not_supported (self, callback, user_data);
}

/*****************************************************************************/

void
mm_modem_get_supported_charsets (MMModem *self,
                                 MMModemUIntFn callback,
                                 gpointer user_data)
{
    MMCallbackInfo *info;

    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (callback != NULL);

    if (MM_MODEM_GET_INTERFACE (self)->get_supported_charsets)
        MM_MODEM_GET_INTERFACE (self)->get_supported_charsets (self, callback, user_data);
    else {
        info = mm_callback_info_uint_new (MM_MODEM (self), callback, user_data);
        info->error = g_error_new_literal (MM_MODEM_ERROR, MM_MODEM_ERROR_OPERATION_NOT_SUPPORTED,
                                           "Operation not supported");
        mm_callback_info_schedule (info);
    }
}

void
mm_modem_set_charset (MMModem *self,
                      MMModemCharset charset,
                      MMModemFn callback,
                      gpointer user_data)
{
    MMCallbackInfo *info;

    g_return_if_fail (charset != MM_MODEM_CHARSET_UNKNOWN);
    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (callback != NULL);

    if (MM_MODEM_GET_INTERFACE (self)->set_charset)
        MM_MODEM_GET_INTERFACE (self)->set_charset (self, charset, callback, user_data);
    else {
        info = mm_callback_info_new (MM_MODEM (self), callback, user_data);
        info->error = g_error_new_literal (MM_MODEM_ERROR, MM_MODEM_ERROR_OPERATION_NOT_SUPPORTED,
                                           "Operation not supported");
        mm_callback_info_schedule (info);
    }
}

/*****************************************************************************/

gboolean
mm_modem_owns_port (MMModem *self,
                    const char *subsys,
                    const char *name)
{
    g_return_val_if_fail (self != NULL, FALSE);
    g_return_val_if_fail (MM_IS_MODEM (self), FALSE);
    g_return_val_if_fail (subsys, FALSE);
    g_return_val_if_fail (name, FALSE);

    g_assert (MM_MODEM_GET_INTERFACE (self)->owns_port);
    return MM_MODEM_GET_INTERFACE (self)->owns_port (self, subsys, name);
}

gboolean
mm_modem_grab_port (MMModem *self,
                    const char *subsys,
                    const char *name,
                    MMPortType suggested_type,
                    gpointer user_data,
                    GError **error)
{
    g_return_val_if_fail (self != NULL, FALSE);
    g_return_val_if_fail (MM_IS_MODEM (self), FALSE);
    g_return_val_if_fail (subsys, FALSE);
    g_return_val_if_fail (name, FALSE);

    g_assert (MM_MODEM_GET_INTERFACE (self)->grab_port);
    return MM_MODEM_GET_INTERFACE (self)->grab_port (self, subsys, name, suggested_type, user_data, error);
}

void
mm_modem_release_port (MMModem *self,
                       const char *subsys,
                       const char *name)
{
    g_return_if_fail (self != NULL);
    g_return_if_fail (MM_IS_MODEM (self));
    g_return_if_fail (subsys);
    g_return_if_fail (name);

    g_assert (MM_MODEM_GET_INTERFACE (self)->release_port);
    MM_MODEM_GET_INTERFACE (self)->release_port (self, subsys, name);
}

gboolean
mm_modem_get_valid (MMModem *self)
{
    gboolean valid = FALSE;

    g_return_val_if_fail (self != NULL, FALSE);
    g_return_val_if_fail (MM_IS_MODEM (self), FALSE);

    g_object_get (G_OBJECT (self), MM_MODEM_VALID, &valid, NULL);
    return valid;
}

char *
mm_modem_get_device (MMModem *self)
{
    char *device;

    g_return_val_if_fail (self != NULL, NULL);
    g_return_val_if_fail (MM_IS_MODEM (self), NULL);

    g_object_get (G_OBJECT (self), MM_MODEM_MASTER_DEVICE, &device, NULL);
    return device;
}

MMModemState
mm_modem_get_state (MMModem *self)
{
    MMModemState state = MM_MODEM_STATE_UNKNOWN;

    g_object_get (G_OBJECT (self), MM_MODEM_STATE, &state, NULL);
    return state;
}

static const char *
state_to_string (MMModemState state)
{
    switch (state) {
    case MM_MODEM_STATE_UNKNOWN:
        return "unknown";
    case MM_MODEM_STATE_DISABLED:
        return "disabled";
    case MM_MODEM_STATE_DISABLING:
        return "disabling";
    case MM_MODEM_STATE_ENABLING:
        return "enabling";
    case MM_MODEM_STATE_ENABLED:
        return "enabled";
    case MM_MODEM_STATE_SEARCHING:
        return "searching";
    case MM_MODEM_STATE_REGISTERED:
        return "registered";
    case MM_MODEM_STATE_DISCONNECTING:
        return "disconnecting";
    case MM_MODEM_STATE_CONNECTING:
        return "connecting";
    case MM_MODEM_STATE_CONNECTED:
        return "connected";
    default:
        g_assert_not_reached ();
        break;
    }

    g_assert_not_reached ();
    return "(invalid)";
}

void
mm_modem_set_state (MMModem *self,
                    MMModemState new_state,
                    MMModemStateReason reason)
{
    MMModemState old_state = MM_MODEM_STATE_UNKNOWN;
    const char *dbus_path;

    g_object_get (G_OBJECT (self), MM_MODEM_STATE, &old_state, NULL);

    if (new_state != old_state) {
        g_object_set (G_OBJECT (self), MM_MODEM_STATE, new_state, NULL);
        g_signal_emit_by_name (G_OBJECT (self), "state-changed", old_state, new_state, reason);

        dbus_path = (const char *) g_object_get_data (G_OBJECT (self), DBUS_PATH_TAG);
        if (dbus_path) {
            mm_info ("Modem %s: state changed (%s -> %s)",
                     dbus_path,
                     state_to_string (old_state),
                     state_to_string (new_state));
        }
    }
}

/*****************************************************************************/

gboolean
mm_modem_auth_request (MMModem *self,
                       const char *authorization,
                       DBusGMethodInvocation *context,
                       MMAuthRequestCb callback,
                       gpointer callback_data,
                       GDestroyNotify notify,
                       GError **error)
{
    g_return_val_if_fail (self != NULL, FALSE);
    g_return_val_if_fail (MM_IS_MODEM (self), FALSE);
    g_return_val_if_fail (authorization != NULL, FALSE);
    g_return_val_if_fail (context != NULL, FALSE);
    g_return_val_if_fail (callback != NULL, FALSE);

    g_return_val_if_fail (MM_MODEM_GET_INTERFACE (self)->auth_request, FALSE);
    return MM_MODEM_GET_INTERFACE (self)->auth_request (self,
                                                        authorization,
                                                        context,
                                                        callback,
                                                        callback_data,
                                                        notify,
                                                        error);
}

gboolean
mm_modem_auth_finish (MMModem *self,
                      MMAuthRequest *req,
                      GError **error)
{
    gboolean success;

    g_return_val_if_fail (self != NULL, FALSE);
    g_return_val_if_fail (MM_IS_MODEM (self), FALSE);
    g_return_val_if_fail (req != NULL, FALSE);

    g_return_val_if_fail (MM_MODEM_GET_INTERFACE (self)->auth_finish, FALSE);
    success = MM_MODEM_GET_INTERFACE (self)->auth_finish (self, req, error);

    /* If the request failed, the implementor *should* return an error */
    if (!success && error)
        g_warn_if_fail (*error != NULL);

    return success;
}

/*****************************************************************************/

static void
mm_modem_init (gpointer g_iface)
{
    GType iface_type = G_TYPE_FROM_INTERFACE (g_iface);
    static gboolean initialized = FALSE;

    if (initialized)
        return;

    /* Properties */
    g_object_interface_install_property
        (g_iface,
         g_param_spec_string (MM_MODEM_DATA_DEVICE,
                              "Device",
                              "Data device",
                              NULL,
                              G_PARAM_READWRITE));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_string (MM_MODEM_MASTER_DEVICE,
                              "MasterDevice",
                              "Master modem parent device of all the modem's ports",
                              NULL,
                              G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_string (MM_MODEM_DRIVER,
                              "Driver",
                              "Driver",
                              NULL,
                              G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_string (MM_MODEM_PLUGIN,
                              "Plugin",
                              "Plugin name",
                              NULL,
                              G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_uint (MM_MODEM_TYPE,
                            "Type",
                            "Type",
                            0, G_MAXUINT32, 0,
                            G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_uint (MM_MODEM_IP_METHOD,
                            "IP method",
                            "IP configuration method",
                            MM_MODEM_IP_METHOD_PPP,
                            MM_MODEM_IP_METHOD_DHCP,
                            MM_MODEM_IP_METHOD_PPP,
                            G_PARAM_READWRITE));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_boolean (MM_MODEM_VALID,
                               "Valid",
                               "Modem is valid",
                               FALSE,
                               G_PARAM_READABLE));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_uint (MM_MODEM_STATE,
                            "State",
                            "State",
                            MM_MODEM_STATE_UNKNOWN,
                            MM_MODEM_STATE_LAST,
                            MM_MODEM_STATE_UNKNOWN,
                            G_PARAM_READWRITE));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_boolean (MM_MODEM_ENABLED,
                               "Enabled",
                               "Modem is enabled",
                               FALSE,
                               G_PARAM_READABLE));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_string (MM_MODEM_EQUIPMENT_IDENTIFIER,
                               "EquipmentIdentifier",
                               "The equipment identifier of the device",
                               NULL,
                               G_PARAM_READABLE));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_string (MM_MODEM_DEVICE_IDENTIFIER,
                               "DeviceIdentifier",
                               "A best-effort identifer of the device",
                               NULL,
                               G_PARAM_READABLE));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_string (MM_MODEM_UNLOCK_REQUIRED,
                               "UnlockRequired",
                               "Whether or not the modem requires an unlock "
                               "code to become usable, and if so, which unlock code is required",
                               NULL,
                               G_PARAM_READABLE));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_uint (MM_MODEM_UNLOCK_RETRIES,
                               "UnlockRetries",
                               "The remaining number of unlock attempts",
                               0, G_MAXUINT32, 0,
                               G_PARAM_READABLE));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_uint (MM_MODEM_HW_VID,
                            "Hardware vendor ID",
                            "Hardware vendor ID",
                            0, G_MAXUINT, 0,
                            G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));

    g_object_interface_install_property
        (g_iface,
         g_param_spec_uint (MM_MODEM_HW_PID,
                            "Hardware product ID",
                            "Hardware product ID",
                            0, G_MAXUINT, 0,
                            G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));

    /* Signals */
    g_signal_new ("state-changed",
                  iface_type,
                  G_SIGNAL_RUN_FIRST,
                  G_STRUCT_OFFSET (MMModem, state_changed),
                  NULL, NULL,
                  mm_marshal_VOID__UINT_UINT_UINT,
                  G_TYPE_NONE, 3,
                  G_TYPE_UINT, G_TYPE_UINT, G_TYPE_UINT);

    initialized = TRUE;
}

GType
mm_modem_get_type (void)
{
    static GType modem_type = 0;

    if (!G_UNLIKELY (modem_type)) {
        const GTypeInfo modem_info = {
            sizeof (MMModem), /* class_size */
            mm_modem_init,   /* base_init */
            NULL,       /* base_finalize */
            NULL,
            NULL,       /* class_finalize */
            NULL,       /* class_data */
            0,
            0,              /* n_preallocs */
            NULL
        };

        modem_type = g_type_register_static (G_TYPE_INTERFACE,
                                             "MMModem",
                                             &modem_info, 0);

        g_type_interface_add_prerequisite (modem_type, G_TYPE_OBJECT);

        dbus_g_object_type_install_info (modem_type, &dbus_glib_mm_modem_object_info);
    }

    return modem_type;
}