f710919c510ade1ba1fb96c026c45b9f6cee15fb
[fw/altos] / altosui / libaltos / libaltos.h
1 /*
2  * Copyright © 2010 Keith Packard <keithp@keithp.com>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; version 2 of the License.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License along
14  * with this program; if not, write to the Free Software Foundation, Inc.,
15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
16  */
17
18 #ifndef _LIBALTOS_H_
19 #define _LIBALTOS_H_
20
21 #include <stdlib.h>
22
23 #if defined(_WIN32) || defined(__WIN32__) || defined(__CYGWIN__)
24 # ifndef BUILD_STATIC
25 #  ifdef BUILD_DLL
26 #   define PUBLIC __declspec(dllexport)
27 #  else
28 #   define PUBLIC __declspec(dllimport)
29 #  endif
30 # endif /* BUILD_STATIC */
31 #endif
32
33 #ifndef PUBLIC
34 # define PUBLIC
35 #endif
36
37 #define USB_VENDOR_FSF                  0xfffe
38 #define USB_VENDOR_ALTUSMETRUM          USB_VENDOR_FSF
39 #define USB_PRODUCT_ALTUSMETRUM         0x000a
40 #define USB_PRODUCT_TELEMETRUM          0x000b
41 #define USB_PRODUCT_TELEDONGLE          0x000c
42 #define USB_PRODUCT_TELETERRA           0x000d
43 #define USB_PRODUCT_TELEBT              0x000e
44 #define USB_PRODUCT_ALTUSMETRUM_MIN     0x000a
45 #define USB_PRODUCT_ALTUSMETRUM_MAX     0x0013
46
47 #define USB_IS_ALTUSMETRUM(v,p) ((v) == USB_VENDOR_ALTUSMETRUM && \
48                 (USB_PRODUCT_ALTUSMETRUM_MIN <= (p) && \
49                  (p) <= USB_PRODUCT_ALTUSMETRUM_MAX))
50
51 struct altos_device {
52         //%immutable;
53         int                             vendor;
54         int                             product;
55         int                             serial;
56         char                            name[256];
57         char                            path[256];
58         //%mutable;
59 };
60
61 #define BLUETOOTH_PRODUCT_TELEBT        "TeleBT"
62
63 struct altos_bt_device {
64         //%immutable;
65         char                            name[256];
66         char                            addr[20];
67         //%mutable;
68 };
69
70 #define LIBALTOS_SUCCESS        0
71 #define LIBALTOS_ERROR          -1
72 #define LIBALTOS_TIMEOUT        -2
73
74 /* Returns 0 for success, < 0 on error */
75 PUBLIC int
76 altos_init(void);
77
78 PUBLIC void
79 altos_fini(void);
80
81 PUBLIC struct altos_list *
82 altos_list_start(void);
83
84 /* Returns 1 for success, zero on end of list */
85 PUBLIC int
86 altos_list_next(struct altos_list *list, struct altos_device *device);
87
88 PUBLIC void
89 altos_list_finish(struct altos_list *list);
90
91 PUBLIC struct altos_file *
92 altos_open(struct altos_device *device);
93
94 PUBLIC void
95 altos_close(struct altos_file *file);
96
97 PUBLIC void
98 altos_free(struct altos_file *file);
99
100 /* Returns < 0 for error */
101 PUBLIC int
102 altos_putchar(struct altos_file *file, char c);
103
104 /* Returns < 0 for error */
105 PUBLIC int
106 altos_flush(struct altos_file *file);
107
108 /* Returns < 0 for error or timeout. timeout of 0 == wait forever */
109 PUBLIC int
110 altos_getchar(struct altos_file *file, int timeout);
111
112 PUBLIC struct altos_bt_list *
113 altos_bt_list_start(int inquiry_time);
114
115 PUBLIC int
116 altos_bt_list_next(struct altos_bt_list *list, struct altos_bt_device *device);
117
118 PUBLIC void
119 altos_bt_list_finish(struct altos_bt_list *list);
120
121 PUBLIC void
122 altos_bt_fill_in(char *name, char *addr, struct altos_bt_device *device);
123
124 PUBLIC struct altos_file *
125 altos_bt_open(struct altos_bt_device *device);
126
127 #endif /* _LIBALTOS_H_ */