git.gag.com Git - fw/altos/blob - 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 #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_ALTUSMETRUM_MIN     0x000a
  44 #define USB_PRODUCT_ALTUSMETRUM_MAX     0x0013
  45
  46 #define USB_IS_ALTUSMETRUM(v,p) ((v) == USB_VENDOR_ALTUSMETRUM && \
  47                 (USB_PRODUCT_ALTUSMETRUM_MIN <= (p) && \
  48                  (p) <= USB_PRODUCT_ALTUSMETRUM_MAX))
  49
  50 struct altos_device {
  51         //%immutable;
  52         int                             vendor;
  53         int                             product;
  54         int                             serial;
  55         char                            name[256];
  56         char                            path[256];
  57         //%mutable;
  58 };
  59
  60 #define LIBALTOS_SUCCESS        0
  61 #define LIBALTOS_ERROR          -1
  62 #define LIBALTOS_TIMEOUT        -2
  63
  64 /* Returns 0 for success, < 0 on error */
  65 PUBLIC int
  66 altos_init(void);
  67
  68 PUBLIC void
  69 altos_fini(void);
  70
  71 PUBLIC struct altos_list *
  72 altos_list_start(void);
  73
  74 /* Returns 1 for success, zero on end of list */
  75 PUBLIC int
  76 altos_list_next(struct altos_list *list, struct altos_device *device);
  77
  78 PUBLIC void
  79 altos_list_finish(struct altos_list *list);
  80
  81 PUBLIC struct altos_file *
  82 altos_open(struct altos_device *device);
  83
  84 PUBLIC void
  85 altos_close(struct altos_file *file);
  86
  87 PUBLIC void
  88 altos_free(struct altos_file *file);
  89
  90 /* Returns < 0 for error */
  91 PUBLIC int
  92 altos_putchar(struct altos_file *file, char c);
  93
  94 /* Returns < 0 for error */
  95 PUBLIC int
  96 altos_flush(struct altos_file *file);
  97
  98 /* Returns < 0 for error or timeout. timeout of 0 == wait forever */
  99 PUBLIC int
 100 altos_getchar(struct altos_file *file, int timeout);
 101
 102 #endif /* _LIBALTOS_H_ */