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         char *serialcomm;
  74         int fd;
  75 };
  76
  77 /* Private driver context. */
  78 struct drv_context {
  79         struct sr_context *sr_ctx;
  80         GSList *instances;
  81 };
  82
  83 /*--- log.c -----------------------------------------------------------------*/
  84
  85 SR_PRIV int sr_log(int loglevel, const char *format, ...);
  86 SR_PRIV int sr_spew(const char *format, ...);
  87 SR_PRIV int sr_dbg(const char *format, ...);
  88 SR_PRIV int sr_info(const char *format, ...);
  89 SR_PRIV int sr_warn(const char *format, ...);
  90 SR_PRIV int sr_err(const char *format, ...);
  91
  92 /*--- device.c --------------------------------------------------------------*/
  93
  94 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
  95                 gboolean enabled, const char *name);
  96
  97 /* Generic device instances */
  98 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
  99                 const char *vendor, const char *model, const char *version);
 100 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 101
 102 #ifdef HAVE_LIBUSB_1_0
 103 /* USB-specific instances */
 104 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 105                 uint8_t address, struct libusb_device_handle *hdl);
 106 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 107 #endif
 108
 109 /* Serial-specific instances */
 110 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 111                 const char *serialcomm);
 112 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 113
 114
 115 /*--- hwdriver.c ------------------------------------------------------------*/
 116
 117 SR_PRIV void sr_hw_cleanup_all(void);
 118 SR_PRIV int sr_source_remove(int fd);
 119 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 120                           sr_receive_data_callback_t cb, void *cb_data);
 121
 122 /*--- session.c -------------------------------------------------------------*/
 123
 124 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 125                             struct sr_datafeed_packet *packet);
 126
 127 /*--- hardware/common/serial.c ----------------------------------------------*/
 128
 129 enum {
 130         SERIAL_RDWR = 1,
 131         SERIAL_RDONLY = 2,
 132         SERIAL_NONBLOCK = 4,
 133 };
 134
 135 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
 136
 137 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 138 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 139 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
 140 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 141                 const void *buf, size_t count);
 142 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 143                 size_t count);
 144 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 145                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
 146 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 147                 const char *paramstr);
 148 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 149                 int *buflen, gint64 timeout_ms);
 150 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 151                                  uint8_t *buf, size_t *buflen,
 152                                  size_t packet_size, packet_valid_t is_valid,
 153                                  uint64_t timeout_ms, int baudrate);
 154
 155 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 156
 157 #ifdef HAVE_LIBUSB_1_0
 158 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 159 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 160                                    const char *filename);
 161 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 162                                   const char *filename);
 163 #endif
 164
 165 /*--- hardware/common/usb.c -------------------------------------------------*/
 166
 167 #ifdef HAVE_LIBUSB_1_0
 168 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
 169 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
 170 #endif
 171
 172 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
 173
 174 SR_PRIV int sr_dmm_parse_fs9922(const uint8_t *buf, float *floatval,
 175                                 struct sr_datafeed_analog *analog);
 176
 177 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
 178
 179 #define FS9721_PACKET_SIZE 14
 180
 181 struct fs9721_info {
 182         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
 183         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
 184         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
 185         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
 186 };
 187
 188 SR_PRIV gboolean sr_fs9721_is_packet_start(uint8_t b);
 189 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 190 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 191                             struct sr_datafeed_analog *analog, void *info);
 192
 193 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
 194
 195 #define METEX14_PACKET_SIZE 14
 196
 197 struct metex14_info {
 198         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
 199         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
 200         gboolean is_hertz, is_ohm, is_celsius, is_nano, is_micro, is_milli;
 201         gboolean is_kilo, is_mega, is_gain, is_decibel, is_hfe, is_unitless;
 202 };
 203
 204 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 205 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 206 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
 207                              struct sr_datafeed_analog *analog, void *info);
 208
 209 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
 210
 211 #define RS9LCD_PACKET_SIZE 9
 212
 213 /* Dummy info struct. The parser does not use it. */
 214 struct rs9lcd_info {};
 215
 216 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 217 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
 218                             struct sr_datafeed_analog *analog, void *info);
 219
 220 #endif