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