libsigrok-internal.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 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 #include <serialport.h>
  30
  31 /**
  32  * @file
  33  *
  34  * libsigrok private header file, only to be used internally.
  35  */
  36
  37 /*--- Macros ----------------------------------------------------------------*/
  38
  39 #ifndef ARRAY_SIZE
  40 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  41 #endif
  42
  43 #ifndef ARRAY_AND_SIZE
  44 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  45 #endif
  46
  47 /* Portability fixes for FreeBSD. */
  48 #ifdef __FreeBSD__
  49 #define LIBUSB_CLASS_APPLICATION 0xfe
  50 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
  51         libusb_handle_events_timeout(ctx, tv)
  52 #endif
  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 SP_PARITY_NONE
  69 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
  70 #define SERIAL_PARITY_ODD  SP_PARITY_ODD
  71 struct sr_serial_dev_inst {
  72         char *port;
  73         char *serialcomm;
  74         int fd;
  75         struct sp_port *data;
  76 };
  77
  78 /* Private driver context. */
  79 struct drv_context {
  80         struct sr_context *sr_ctx;
  81         GSList *instances;
  82 };
  83
  84 /*--- log.c -----------------------------------------------------------------*/
  85
  86 SR_PRIV int sr_log(int loglevel, const char *format, ...);
  87 SR_PRIV int sr_spew(const char *format, ...);
  88 SR_PRIV int sr_dbg(const char *format, ...);
  89 SR_PRIV int sr_info(const char *format, ...);
  90 SR_PRIV int sr_warn(const char *format, ...);
  91 SR_PRIV int sr_err(const char *format, ...);
  92
  93 /*--- device.c --------------------------------------------------------------*/
  94
  95 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
  96                 gboolean enabled, const char *name);
  97
  98 /* Generic device instances */
  99 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 100                 const char *vendor, const char *model, const char *version);
 101 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 102
 103 #ifdef HAVE_LIBUSB_1_0
 104 /* USB-specific instances */
 105 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 106                 uint8_t address, struct libusb_device_handle *hdl);
 107 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
 108 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 109 #endif
 110
 111 /* Serial-specific instances */
 112 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 113                 const char *serialcomm);
 114 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 115
 116
 117 /*--- hwdriver.c ------------------------------------------------------------*/
 118
 119 SR_PRIV void sr_hw_cleanup_all(void);
 120 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
 121 SR_PRIV void sr_config_free(struct sr_config *src);
 122 SR_PRIV int sr_source_remove(int fd);
 123 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 124                 sr_receive_data_callback_t cb, void *cb_data);
 125
 126 /*--- session.c -------------------------------------------------------------*/
 127
 128 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 129                 const struct sr_datafeed_packet *packet);
 130 SR_PRIV int sr_session_stop_sync(void);
 131 SR_PRIV int sr_sessionfile_check(const char *filename);
 132
 133 /*--- std.c -----------------------------------------------------------------*/
 134
 135 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
 136 typedef void (*std_dev_clear_t)(void *priv);
 137
 138 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 139                 const char *prefix);
 140 SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 141                 void *cb_data, dev_close_t dev_close_fn,
 142                 struct sr_serial_dev_inst *serial, const char *prefix);
 143 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 144                 const char *prefix);
 145 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 146                 std_dev_clear_t clear_private);
 147
 148 /*--- hardware/common/serial.c ----------------------------------------------*/
 149
 150 enum {
 151         SERIAL_RDWR = 1,
 152         SERIAL_RDONLY = 2,
 153         SERIAL_NONBLOCK = 4,
 154 };
 155
 156 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
 157
 158 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 159 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 160 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
 161 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 162                 const void *buf, size_t count);
 163 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 164                 size_t count);
 165 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 166                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
 167 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 168                 const char *paramstr);
 169 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 170                 int *buflen, gint64 timeout_ms);
 171 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 172                                  uint8_t *buf, size_t *buflen,
 173                                  size_t packet_size, packet_valid_t is_valid,
 174                                  uint64_t timeout_ms, int baudrate);
 175
 176 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 177
 178 #ifdef HAVE_LIBUSB_1_0
 179 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 180 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 181                                    const char *filename);
 182 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 183                                   const char *filename);
 184 #endif
 185
 186 /*--- hardware/common/usb.c -------------------------------------------------*/
 187
 188 #ifdef HAVE_LIBUSB_1_0
 189 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
 190 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
 191 #endif
 192
 193 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
 194
 195 #define ES51922_PACKET_SIZE 14
 196
 197 struct es51922_info {
 198         gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
 199         gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
 200         gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
 201         gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
 202         gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
 203         gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
 204 };
 205
 206 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
 207 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
 208                              struct sr_datafeed_analog *analog, void *info);
 209
 210 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
 211
 212 /**
 213  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
 214  * so always read 2 blocks at a time.
 215  */
 216 #define ES519XX_11B_PACKET_SIZE (11 * 2)
 217 #define ES519XX_14B_PACKET_SIZE 14
 218
 219 struct es519xx_info {
 220         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
 221         gboolean is_milli, is_resistance, is_continuity, is_diode;
 222         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
 223         gboolean is_temperature, is_celsius, is_fahrenheit;
 224         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
 225         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
 226         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
 227         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
 228         uint32_t baudrate;
 229         int packet_size;
 230         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
 231 };
 232
 233 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
 234 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
 235                 struct sr_datafeed_analog *analog, void *info);
 236 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
 237 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
 238                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 239 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
 240 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
 241                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 242 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
 243 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
 244                 struct sr_datafeed_analog *analog, void *info);
 245 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
 246 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
 247                 struct sr_datafeed_analog *analog, void *info);
 248 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
 249 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
 250                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 251
 252 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
 253
 254 #define FS9922_PACKET_SIZE 14
 255
 256 struct fs9922_info {
 257         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
 258         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
 259         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
 260         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
 261         gboolean is_celsius, is_fahrenheit;
 262         int bargraph_sign, bargraph_value;
 263 };
 264
 265 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
 266 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
 267                             struct sr_datafeed_analog *analog, void *info);
 268 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
 269
 270 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
 271
 272 #define FS9721_PACKET_SIZE 14
 273
 274 struct fs9721_info {
 275         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
 276         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
 277         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
 278         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
 279 };
 280
 281 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 282 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 283                             struct sr_datafeed_analog *analog, void *info);
 284 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
 285 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
 286 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
 287 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
 288
 289 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
 290
 291 #define METEX14_PACKET_SIZE 14
 292
 293 struct metex14_info {
 294         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
 295         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
 296         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
 297         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
 298         gboolean is_unitless;
 299 };
 300
 301 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 302 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 303 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
 304                              struct sr_datafeed_analog *analog, void *info);
 305
 306 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
 307
 308 #define RS9LCD_PACKET_SIZE 9
 309
 310 /* Dummy info struct. The parser does not use it. */
 311 struct rs9lcd_info { int dummy; };
 312
 313 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 314 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
 315                             struct sr_datafeed_analog *analog, void *info);
 316
 317 #endif