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 <libserialport.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         int nonblocking;
  79         struct sp_port *data;
  80 };
  81 #endif
  82
  83 struct sr_usbtmc_dev_inst {
  84         char *device;
  85         int fd;
  86 };
  87
  88 /* Private driver context. */
  89 struct drv_context {
  90         struct sr_context *sr_ctx;
  91         GSList *instances;
  92 };
  93
  94 /*--- log.c -----------------------------------------------------------------*/
  95
  96 SR_PRIV int sr_log(int loglevel, const char *format, ...);
  97 SR_PRIV int sr_spew(const char *format, ...);
  98 SR_PRIV int sr_dbg(const char *format, ...);
  99 SR_PRIV int sr_info(const char *format, ...);
 100 SR_PRIV int sr_warn(const char *format, ...);
 101 SR_PRIV int sr_err(const char *format, ...);
 102
 103 /*--- device.c --------------------------------------------------------------*/
 104
 105 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
 106                 gboolean enabled, const char *name);
 107
 108 /* Generic device instances */
 109 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 110                 const char *vendor, const char *model, const char *version);
 111 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 112
 113 #ifdef HAVE_LIBUSB_1_0
 114 /* USB-specific instances */
 115 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 116                 uint8_t address, struct libusb_device_handle *hdl);
 117 SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
 118 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 119 #endif
 120
 121 #ifdef HAVE_LIBSERIALPORT
 122 /* Serial-specific instances */
 123 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 124                 const char *serialcomm);
 125 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 126 #endif
 127
 128 /* USBTMC-specific instances */
 129 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
 130 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
 131
 132 /*--- hwdriver.c ------------------------------------------------------------*/
 133
 134 SR_PRIV void sr_hw_cleanup_all(void);
 135 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
 136 SR_PRIV void sr_config_free(struct sr_config *src);
 137 SR_PRIV int sr_source_remove(int fd);
 138 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 139                 sr_receive_data_callback_t cb, void *cb_data);
 140
 141 /*--- session.c -------------------------------------------------------------*/
 142
 143 struct sr_session {
 144         /** List of struct sr_dev pointers. */
 145         GSList *devs;
 146         /** List of struct datafeed_callback pointers. */
 147         GSList *datafeed_callbacks;
 148         GTimeVal starttime;
 149         gboolean running;
 150
 151         unsigned int num_sources;
 152
 153         /*
 154          * Both "sources" and "pollfds" are of the same size and contain pairs
 155          * of descriptor and callback function. We can not embed the GPollFD
 156          * into the source struct since we want to be able to pass the array
 157          * of all poll descriptors to g_poll().
 158          */
 159         struct source *sources;
 160         GPollFD *pollfds;
 161         int source_timeout;
 162
 163         /*
 164          * These are our synchronization primitives for stopping the session in
 165          * an async fashion. We need to make sure the session is stopped from
 166          * within the session thread itself.
 167          */
 168         GMutex stop_mutex;
 169         gboolean abort_session;
 170 };
 171
 172 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 173                 const struct sr_datafeed_packet *packet);
 174 SR_PRIV int sr_session_stop_sync(void);
 175 SR_PRIV int sr_sessionfile_check(const char *filename);
 176
 177 /*--- std.c -----------------------------------------------------------------*/
 178
 179 typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
 180 typedef void (*std_dev_clear_t)(void *priv);
 181
 182 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 183                 const char *prefix);
 184 #ifdef HAVE_LIBSERIALPORT
 185 SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
 186                 void *cb_data, dev_close_t dev_close_fn,
 187                 struct sr_serial_dev_inst *serial, const char *prefix);
 188 #endif
 189 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 190                 const char *prefix);
 191 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 192                 std_dev_clear_t clear_private);
 193
 194 /*--- strutil.c -------------------------------------------------------------*/
 195
 196 SR_PRIV int sr_atol(const char *str, long *ret);
 197 SR_PRIV int sr_atoi(const char *str, int *ret);
 198 SR_PRIV int sr_atod(const char *str, double *ret);
 199 SR_PRIV int sr_atof(const char *str, float *ret);
 200
 201 /*--- hardware/common/serial.c ----------------------------------------------*/
 202
 203 #ifdef HAVE_LIBSERIALPORT
 204 enum {
 205         SERIAL_RDWR = 1,
 206         SERIAL_RDONLY = 2,
 207         SERIAL_NONBLOCK = 4,
 208 };
 209
 210 typedef gboolean (*packet_valid_t)(const uint8_t *buf);
 211
 212 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 213 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 214 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
 215 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 216                 const void *buf, size_t count);
 217 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 218                 size_t count);
 219 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 220                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
 221 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 222                 const char *paramstr);
 223 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 224                 int *buflen, gint64 timeout_ms);
 225 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 226                                  uint8_t *buf, size_t *buflen,
 227                                  size_t packet_size, packet_valid_t is_valid,
 228                                  uint64_t timeout_ms, int baudrate);
 229 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
 230                                       const char **serial_options);
 231 #endif
 232
 233 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 234
 235 #ifdef HAVE_LIBUSB_1_0
 236 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 237 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 238                                    const char *filename);
 239 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 240                                   const char *filename);
 241 #endif
 242
 243 /*--- hardware/common/usb.c -------------------------------------------------*/
 244
 245 #ifdef HAVE_LIBUSB_1_0
 246 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
 247 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
 248 #endif
 249
 250 /*--- hardware/common/scpi.c ------------------------------------------------*/
 251
 252 #ifdef HAVE_LIBSERIALPORT
 253
 254 #define SCPI_CMD_IDN "*IDN?"
 255 #define SCPI_CMD_OPC "*OPC?"
 256
 257 enum {
 258         SCPI_CMD_SET_TRIGGER_SOURCE,
 259         SCPI_CMD_SET_TIMEBASE,
 260         SCPI_CMD_SET_VERTICAL_DIV,
 261         SCPI_CMD_SET_TRIGGER_SLOPE,
 262         SCPI_CMD_SET_COUPLING,
 263         SCPI_CMD_SET_HORIZ_TRIGGERPOS,
 264         SCPI_CMD_GET_ANALOG_CHAN_STATE,
 265         SCPI_CMD_GET_DIG_CHAN_STATE,
 266         SCPI_CMD_GET_TIMEBASE,
 267         SCPI_CMD_GET_VERTICAL_DIV,
 268         SCPI_CMD_GET_VERTICAL_OFFSET,
 269         SCPI_CMD_GET_TRIGGER_SOURCE,
 270         SCPI_CMD_GET_HORIZ_TRIGGERPOS,
 271         SCPI_CMD_GET_TRIGGER_SLOPE,
 272         SCPI_CMD_GET_COUPLING,
 273         SCPI_CMD_SET_ANALOG_CHAN_STATE,
 274         SCPI_CMD_SET_DIG_CHAN_STATE,
 275         SCPI_CMD_GET_DIG_POD_STATE,
 276         SCPI_CMD_SET_DIG_POD_STATE,
 277         SCPI_CMD_GET_ANALOG_DATA,
 278         SCPI_CMD_GET_DIG_DATA,
 279 };
 280
 281 struct sr_scpi_hw_info {
 282         char *manufacturer;
 283         char *model;
 284         char *serial_number;
 285         char *firmware_version;
 286 };
 287
 288 struct sr_scpi_dev_inst {
 289         int (*open)(void *priv);
 290         int (*source_add)(void *priv, int events,
 291                 int timeout, sr_receive_data_callback_t cb, void *cb_data);
 292         int (*source_remove)(void *priv);
 293         int (*send)(void *priv, const char *command);
 294         int (*receive)(void *priv, char **scpi_response);
 295         int (*close)(void *priv);
 296         void (*free)(void *priv);
 297         void *priv;
 298 };
 299
 300 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
 301 SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
 302                 int timeout, sr_receive_data_callback_t cb, void *cb_data);
 303 SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi);
 304 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
 305                         const char *command);
 306 SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
 307                         char **scpi_response);
 308 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
 309 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
 310
 311 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 312                         const char *command, char **scpi_response);
 313 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 314                         const char *command, gboolean *scpi_response);
 315 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 316                         const char *command, int *scpi_response);
 317 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 318                         const char *command, float *scpi_response);
 319 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 320                         const char *command, double *scpi_response);
 321 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
 322 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 323                         const char *command, GArray **scpi_response);
 324 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 325                         const char *command, GArray **scpi_response);
 326 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 327                         struct sr_scpi_hw_info **scpi_response);
 328 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
 329
 330 #endif
 331
 332 /*--- hardware/common/scpi_serial.c -----------------------------------------*/
 333
 334 SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
 335                         const char *serialcomm);
 336
 337 /*--- hardware/common/dmm/es51922.c -----------------------------------------*/
 338
 339 #define ES51922_PACKET_SIZE 14
 340
 341 struct es51922_info {
 342         gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
 343         gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
 344         gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
 345         gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
 346         gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
 347         gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
 348 };
 349
 350 SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
 351 SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
 352                              struct sr_datafeed_analog *analog, void *info);
 353
 354 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
 355
 356 /**
 357  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
 358  * so always read 2 blocks at a time.
 359  */
 360 #define ES519XX_11B_PACKET_SIZE (11 * 2)
 361 #define ES519XX_14B_PACKET_SIZE 14
 362
 363 struct es519xx_info {
 364         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
 365         gboolean is_milli, is_resistance, is_continuity, is_diode;
 366         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
 367         gboolean is_temperature, is_celsius, is_fahrenheit;
 368         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
 369         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
 370         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
 371         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
 372         uint32_t baudrate;
 373         int packet_size;
 374         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
 375 };
 376
 377 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
 378 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
 379                 struct sr_datafeed_analog *analog, void *info);
 380 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
 381 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
 382                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 383 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
 384 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
 385                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 386 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
 387 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
 388                 struct sr_datafeed_analog *analog, void *info);
 389 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
 390 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
 391                 struct sr_datafeed_analog *analog, void *info);
 392 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
 393 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
 394                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 395
 396 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
 397
 398 #define FS9922_PACKET_SIZE 14
 399
 400 struct fs9922_info {
 401         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
 402         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
 403         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
 404         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
 405         gboolean is_celsius, is_fahrenheit;
 406         int bargraph_sign, bargraph_value;
 407 };
 408
 409 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
 410 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
 411                             struct sr_datafeed_analog *analog, void *info);
 412 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
 413
 414 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
 415
 416 #define FS9721_PACKET_SIZE 14
 417
 418 struct fs9721_info {
 419         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
 420         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
 421         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
 422         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
 423 };
 424
 425 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 426 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 427                             struct sr_datafeed_analog *analog, void *info);
 428 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
 429 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
 430 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
 431 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
 432
 433 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
 434
 435 #define METEX14_PACKET_SIZE 14
 436
 437 struct metex14_info {
 438         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
 439         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
 440         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
 441         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
 442         gboolean is_unitless;
 443 };
 444
 445 #ifdef HAVE_LIBSERIALPORT
 446 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 447 #endif
 448 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 449 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
 450                              struct sr_datafeed_analog *analog, void *info);
 451
 452 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
 453
 454 #define RS9LCD_PACKET_SIZE 9
 455
 456 /* Dummy info struct. The parser does not use it. */
 457 struct rs9lcd_info { int dummy; };
 458
 459 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 460 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
 461                             struct sr_datafeed_analog *analog, void *info);
 462
 463 #endif