aboutsummaryrefslogtreecommitdiff
path: root/src/mm-serial.h
blob: eeaac9c1b4eda842c12a139eea1c591677fc907f (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
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

#ifndef MM_SERIAL_H
#define MM_SERIAL_H

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

#define MM_TYPE_SERIAL            (mm_serial_get_type ())
#define MM_SERIAL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_SERIAL, MMSerial))
#define MM_SERIAL_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  MM_TYPE_SERIAL, MMSerialClass))
#define MM_IS_SERIAL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_SERIAL))
#define MM_IS_SERIAL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  MM_TYPE_SERIAL))
#define MM_SERIAL_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  MM_TYPE_SERIAL, MMSerialClass))

#define MM_SERIAL_DEVICE     "device"
#define MM_SERIAL_BAUD       "baud"
#define MM_SERIAL_BITS       "bits"
#define MM_SERIAL_PARITY     "parity"
#define MM_SERIAL_STOPBITS   "stopbits"
#define MM_SERIAL_SEND_DELAY "send-delay"
#define MM_SERIAL_CARRIER_DETECT "carrier-detect"

typedef struct _MMSerial MMSerial;
typedef struct _MMSerialClass MMSerialClass;

typedef gboolean (*MMSerialResponseParserFn) (gpointer user_data,
                                              GString *response,
                                              GError **error);

typedef void (*MMSerialResponseFn)     (MMSerial *serial,
                                        GString *response,
                                        GError *error,
                                        gpointer user_data);

typedef void (*MMSerialFlashFn)        (MMSerial *serial,
                                        gpointer user_data);

struct _MMSerial {
    GObject parent;
};

struct _MMSerialClass {
    GObjectClass parent;
};

GType mm_serial_get_type (void);

void     mm_serial_set_response_parser (MMSerial *self,
                                        MMSerialResponseParserFn fn,
                                        gpointer user_data,
                                        GDestroyNotify notify);

gboolean mm_serial_open              (MMSerial *self,
                                      GError  **error);

void     mm_serial_close             (MMSerial *self);
void     mm_serial_queue_command     (MMSerial *self,
                                      const char *command,
                                      guint32 timeout_seconds,
                                      MMSerialResponseFn callback,
                                      gpointer user_data);

guint    mm_serial_flash             (MMSerial *self,
                                      guint32 flash_time,
                                      MMSerialFlashFn callback,
                                      gpointer user_data);

gboolean mm_serial_is_connected      (MMSerial *self);
const char *mm_serial_get_device     (MMSerial *self);

#endif /* MM_SERIAL_H */