sigrok-internal.h

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef LIBSIGROK_SIGROK_INTERNAL_H
  21 #define LIBSIGROK_SIGROK_INTERNAL_H
  22
  23 #include <stdarg.h>
  24 #include <glib.h>
  25 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
  26 #ifdef HAVE_LIBUSB_1_0
  27 #include <libusb.h>
  28 #endif
  29
  30 /*--- Macros ----------------------------------------------------------------*/
  31
  32 #ifndef ARRAY_SIZE
  33 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  34 #endif
  35
  36 #ifndef ARRAY_AND_SIZE
  37 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  38 #endif
  39
  40 /* Size of a datastore chunk in units */
  41 #define DATASTORE_CHUNKSIZE (512 * 1024)
  42
  43 #ifdef HAVE_LIBUSB_1_0
  44 struct sr_usb_dev_inst {
  45         uint8_t bus;
  46         uint8_t address;
  47         struct libusb_device_handle *devhdl;
  48 };
  49 #endif
  50
  51 struct sr_serial_dev_inst {
  52         char *port;
  53         int fd;
  54 };
  55
  56 #define GTV_TO_MSEC(gtv)       (gtv.tv_sec * 1000 + gtv.tv_usec / 1000)
  57
  58 #ifdef HAVE_LIBUSB_1_0
  59 /* USB-specific instances */
  60 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
  61                 uint8_t address, struct libusb_device_handle *hdl);
  62 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
  63 #endif
  64
  65 /* Serial-specific instances */
  66 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(
  67                                         const char *port, int fd);
  68 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
  69
  70 /*--- log.c -----------------------------------------------------------------*/
  71
  72 SR_PRIV int sr_log(int loglevel, const char *format, ...);
  73 SR_PRIV int sr_spew(const char *format, ...);
  74 SR_PRIV int sr_dbg(const char *format, ...);
  75 SR_PRIV int sr_info(const char *format, ...);
  76 SR_PRIV int sr_warn(const char *format, ...);
  77 SR_PRIV int sr_err(const char *format, ...);
  78
  79 /*--- hwdriver.c ------------------------------------------------------------*/
  80
  81 SR_PRIV void sr_hw_cleanup_all(void);
  82
  83 /*--- session.c -------------------------------------------------------------*/
  84
  85 SR_PRIV int sr_session_send(struct sr_dev *dev,
  86                             struct sr_datafeed_packet *packet);
  87
  88 /* Generic device instances */
  89 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
  90                 const char *vendor, const char *model, const char *version);
  91 SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index);
  92 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
  93
  94 SR_PRIV void sr_source_remove(int fd);
  95 SR_PRIV void sr_source_add(int fd, int events, int timeout,
  96                            sr_receive_data_callback_t cb, void *cb_data);
  97
  98 /*--- hardware/common/serial.c ----------------------------------------------*/
  99
 100 SR_PRIV GSList *list_serial_ports(void);
 101 SR_PRIV int serial_open(const char *pathname, int flags);
 102 SR_PRIV int serial_close(int fd);
 103 SR_PRIV int serial_flush(int fd);
 104 SR_PRIV int serial_write(int fd, const void *buf, size_t count);
 105 SR_PRIV int serial_read(int fd, void *buf, size_t count);
 106 SR_PRIV void *serial_backup_params(int fd);
 107 SR_PRIV void serial_restore_params(int fd, void *backup);
 108 SR_PRIV int serial_set_params(int fd, int speed, int bits, int parity,
 109                               int stopbits, int flowcontrol);
 110
 111 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 112
 113 #ifdef HAVE_LIBUSB_1_0
 114 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 115 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 116                                    const char *filename);
 117 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 118                                   const char *filename);
 119 #endif
 120
 121 /*--- hardware/common/misc.c ------------------------------------------------*/
 122
 123 #ifdef HAVE_LIBUSB_1_0
 124 SR_PRIV int opendev2(int dev_index, struct sr_dev_inst **sdi,
 125                      libusb_device *dev, struct libusb_device_descriptor *des,
 126                      int *skip, uint16_t vid, uint16_t pid, int interface);
 127 SR_PRIV int opendev3(struct sr_dev_inst **sdi, libusb_device *dev,
 128                      struct libusb_device_descriptor *des,
 129                      uint16_t vid, uint16_t pid, int interface);
 130 #endif
 131
 132 #endif