Add libaltos which talks to USB connected altos devices
[fw/altos] / ao-tools / 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 struct altos_device {
22         //%immutable;
23         char                            product[256];
24         int                             serial;
25         char                            path[256];
26         //%mutable;
27 };
28
29 int altos_init(void);
30
31 void altos_fini(void);
32
33 struct altos_list *
34 altos_list_start(void);
35
36 int altos_list_next(struct altos_list *list, struct altos_device *device);
37
38 void altos_list_finish(struct altos_list *list);
39
40 struct altos_file *
41 altos_open(struct altos_device *device);
42
43 void altos_close(struct altos_file *file);
44
45 int
46 altos_putchar(struct altos_file *file, char c);
47
48 int
49 altos_flush(struct altos_file *file);
50
51 int
52 altos_getchar(struct altos_file *file, int timeout);
53
54 #endif /* _LIBALTOS_H_ */