libsigrok-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 /**
  31  * @file
  32  *
  33  * libsigrok private header file, only to be used internally.
  34  */
  35
  36 /*--- Macros ----------------------------------------------------------------*/
  37
  38 #ifndef ARRAY_SIZE
  39 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  40 #endif
  41
  42 #ifndef ARRAY_AND_SIZE
  43 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  44 #endif
  45
  46 /* Versions < 2.30.0 of glib don't have g_match_info_unref(). */
  47 #if !GLIB_CHECK_VERSION(2,30,0)
  48 #define g_match_info_unref g_match_info_free
  49 #endif
  50
  51 /* Size of a datastore chunk in units */
  52 #define DATASTORE_CHUNKSIZE (512 * 1024)
  53
  54 struct sr_context {
  55 #ifdef HAVE_LIBUSB_1_0
  56         libusb_context *libusb_ctx;
  57 #endif
  58 };
  59
  60 #ifdef HAVE_LIBUSB_1_0
  61 struct sr_usb_dev_inst {
  62         uint8_t bus;
  63         uint8_t address;
  64         struct libusb_device_handle *devhdl;
  65 };
  66 #endif
  67
  68 #define SERIAL_PARITY_NONE 0
  69 #define SERIAL_PARITY_EVEN 1
  70 #define SERIAL_PARITY_ODD  2
  71 struct sr_serial_dev_inst {
  72         char *port;
  73         int fd;
  74 };
  75
  76 /* Private driver context. */
  77 struct drv_context {
  78         GSList *instances;
  79 };
  80
  81 /*--- log.c -----------------------------------------------------------------*/
  82
  83 SR_PRIV int sr_log(int loglevel, const char *format, ...);
  84 SR_PRIV int sr_spew(const char *format, ...);
  85 SR_PRIV int sr_dbg(const char *format, ...);
  86 SR_PRIV int sr_info(const char *format, ...);
  87 SR_PRIV int sr_warn(const char *format, ...);
  88 SR_PRIV int sr_err(const char *format, ...);
  89
  90 /*--- device.c --------------------------------------------------------------*/
  91
  92 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
  93                 gboolean enabled, const char *name);
  94
  95 /* Generic device instances */
  96 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
  97                 const char *vendor, const char *model, const char *version);
  98 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
  99 #ifdef HAVE_LIBUSB_1_0
 100
 101 /* USB-specific instances */
 102 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 103                 uint8_t address, struct libusb_device_handle *hdl);
 104 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 105 #endif
 106
 107 /* Serial-specific instances */
 108 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(
 109                                         const char *port, int fd);
 110 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 111
 112
 113 /*--- hwdriver.c ------------------------------------------------------------*/
 114
 115 SR_PRIV void sr_hw_cleanup_all(void);
 116 SR_PRIV int sr_source_remove(int fd);
 117 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 118                           sr_receive_data_callback_t cb, void *cb_data);
 119
 120 /*--- session.c -------------------------------------------------------------*/
 121
 122 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 123                             struct sr_datafeed_packet *packet);
 124
 125 /*--- hardware/common/serial.c ----------------------------------------------*/
 126
 127 SR_PRIV GSList *list_serial_ports(void);
 128 SR_PRIV int serial_open(const char *pathname, int flags);
 129 SR_PRIV int serial_close(int fd);
 130 SR_PRIV int serial_flush(int fd);
 131 SR_PRIV int serial_write(int fd, const void *buf, size_t count);
 132 SR_PRIV int serial_read(int fd, void *buf, size_t count);
 133 SR_PRIV void *serial_backup_params(int fd);
 134 SR_PRIV void serial_restore_params(int fd, void *backup);
 135 SR_PRIV int serial_set_params(int fd, int baudrate, int bits, int parity,
 136                               int stopbits, int flowcontrol);
 137 SR_PRIV int serial_set_paramstr(int fd, const char *paramstr);
 138
 139 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 140
 141 #ifdef HAVE_LIBUSB_1_0
 142 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 143 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 144                                    const char *filename);
 145 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 146                                   const char *filename);
 147 #endif
 148
 149 #endif