src/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 /** @file
  21   * @internal
  22   */
  23
  24 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
  25 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
  26
  27 #include <stdarg.h>
  28 #include <glib.h>
  29 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
  30 #ifdef HAVE_LIBUSB_1_0
  31 #include <libusb.h>
  32 #endif
  33 #ifdef HAVE_LIBSERIALPORT
  34 #include <libserialport.h>
  35 #endif
  36
  37 /**
  38  * @file
  39  *
  40  * libsigrok private header file, only to be used internally.
  41  */
  42
  43 /*--- Macros ----------------------------------------------------------------*/
  44
  45 #ifndef ARRAY_SIZE
  46 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  47 #endif
  48
  49 #ifndef ARRAY_AND_SIZE
  50 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  51 #endif
  52
  53 /**
  54  * Read a 8 bits integer out of memory.
  55  * @param x a pointer to the input memory
  56  * @return the corresponding integer
  57  */
  58 #define R8(x)     ((unsigned)((const uint8_t*)(x))[0])
  59
  60 /**
  61  * Read a 16 bits big endian integer out of memory.
  62  * @param x a pointer to the input memory
  63  * @return the corresponding integer
  64  */
  65 #define RB16(x)  (((unsigned)((const uint8_t*)(x))[0] <<  8) |  \
  66                    (unsigned)((const uint8_t*)(x))[1])
  67
  68 /**
  69  * Read a 16 bits little endian integer out of memory.
  70  * @param x a pointer to the input memory
  71  * @return the corresponding integer
  72  */
  73 #define RL16(x)  (((unsigned)((const uint8_t*)(x))[1] <<  8) | \
  74                    (unsigned)((const uint8_t*)(x))[0])
  75
  76 /**
  77  * Read a 32 bits big endian integer out of memory.
  78  * @param x a pointer to the input memory
  79  * @return the corresponding integer
  80  */
  81 #define RB32(x)  (((unsigned)((const uint8_t*)(x))[0] << 24) | \
  82                   ((unsigned)((const uint8_t*)(x))[1] << 16) |  \
  83                   ((unsigned)((const uint8_t*)(x))[2] <<  8) |  \
  84                    (unsigned)((const uint8_t*)(x))[3])
  85
  86 /**
  87  * Read a 32 bits little endian integer out of memory.
  88  * @param x a pointer to the input memory
  89  * @return the corresponding integer
  90  */
  91 #define RL32(x)  (((unsigned)((const uint8_t*)(x))[3] << 24) | \
  92                   ((unsigned)((const uint8_t*)(x))[2] << 16) |  \
  93                   ((unsigned)((const uint8_t*)(x))[1] <<  8) |  \
  94                    (unsigned)((const uint8_t*)(x))[0])
  95
  96 /**
  97  * Write a 8 bits integer to memory.
  98  * @param p a pointer to the output memory
  99  * @param x the input integer
 100  */
 101 #define W8(p, x)    do { ((uint8_t*)(p))[0] = (uint8_t) (x);      } while(0)
 102
 103 /**
 104  * Write a 16 bits integer to memory stored as big endian.
 105  * @param p a pointer to the output memory
 106  * @param x the input integer
 107  */
 108 #define WB16(p, x)  do { ((uint8_t*)(p))[1] = (uint8_t) (x);      \
 109                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>8);  } while(0)
 110
 111 /**
 112  * Write a 16 bits integer to memory stored as little endian.
 113  * @param p a pointer to the output memory
 114  * @param x the input integer
 115  */
 116 #define WL16(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
 117                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  } while(0)
 118
 119 /**
 120  * Write a 32 bits integer to memory stored as big endian.
 121  * @param p a pointer to the output memory
 122  * @param x the input integer
 123  */
 124 #define WB32(p, x)  do { ((uint8_t*)(p))[3] = (uint8_t) (x);      \
 125                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>8);  \
 126                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
 127                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while(0)
 128
 129 /**
 130  * Write a 32 bits integer to memory stored as little endian.
 131  * @param p a pointer to the output memory
 132  * @param x the input integer
 133  */
 134 #define WL32(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
 135                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  \
 136                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
 137                          ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while(0)
 138
 139 /* Portability fixes for FreeBSD. */
 140 #ifdef __FreeBSD__
 141 #define LIBUSB_CLASS_APPLICATION 0xfe
 142 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
 143         libusb_handle_events_timeout(ctx, tv)
 144 #endif
 145
 146 /* Static definitions of structs ending with an all-zero entry are a
 147  * problem when compiling with -Wmissing-field-initializers: GCC
 148  * suppresses the warning only with { 0 }, clang wants { } */
 149 #ifdef __clang__
 150 #define ALL_ZERO { }
 151 #else
 152 #define ALL_ZERO { 0 }
 153 #endif
 154
 155 struct sr_context {
 156 #ifdef HAVE_LIBUSB_1_0
 157         libusb_context *libusb_ctx;
 158         gboolean usb_source_present;
 159 #ifdef _WIN32
 160         GThread *usb_thread;
 161         gboolean usb_thread_running;
 162         GMutex usb_mutex;
 163         HANDLE usb_event;
 164         GPollFD usb_pollfd;
 165         sr_receive_data_callback usb_cb;
 166         void *usb_cb_data;
 167 #endif
 168 #endif
 169 };
 170
 171 /** Input (file) module struct. */
 172 struct sr_input {
 173         /**
 174          * A pointer to this input module's 'struct sr_input_module'.
 175          * The frontend can use this to call the module's callbacks.
 176          */
 177         struct sr_input_module *module;
 178
 179         GHashTable *param;
 180
 181         struct sr_dev_inst *sdi;
 182
 183         void *internal;
 184 };
 185
 186 /** Input (file) module driver. */
 187 struct sr_input_module {
 188         /** The unique ID for this input module. Must not be NULL. */
 189         char *id;
 190
 191         /**
 192          * A short description of the input module, which can (for example)
 193          * be displayed to the user by frontends. Must not be NULL.
 194          */
 195         char *description;
 196
 197         /**
 198          * Check if this input module can load and parse the specified file.
 199          *
 200          * @param[in] filename The name (and path) of the file to check.
 201          *
 202          * @retval TRUE This module knows the format.
 203          * @retval FALSE This module does not know the format.
 204          */
 205         int (*format_match) (const char *filename);
 206
 207         /**
 208          * Initialize the input module.
 209          *
 210          * @param in A pointer to a valid 'struct sr_input' that the caller
 211          *           has to allocate and provide to this function. It is also
 212          *           the responsibility of the caller to free it later.
 213          * @param[in] filename The name (and path) of the file to use.
 214          *
 215          * @retval SR_OK Success
 216          * @retval other Negative error code.
 217          */
 218         int (*init) (struct sr_input *in, const char *filename);
 219
 220         /**
 221          * Load a file, parsing the input according to the file's format.
 222          *
 223          * This function will send datafeed packets to the session bus, so
 224          * the calling frontend must have registered its session callbacks
 225          * beforehand.
 226          *
 227          * The packet types sent across the session bus by this function must
 228          * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
 229          * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
 230          * if appropriate.
 231          *
 232          * @param in A pointer to a valid 'struct sr_input' that the caller
 233          *           has to allocate and provide to this function. It is also
 234          *           the responsibility of the caller to free it later.
 235          * @param filename The name (and path) of the file to use.
 236          *
 237          * @retval SR_OK Success
 238          * @retval other Negative error code.
 239          */
 240         int (*loadfile) (struct sr_input *in, const char *filename);
 241 };
 242
 243 /** Output module instance. */
 244 struct sr_output {
 245         /** A pointer to this output's module.  */
 246         const struct sr_output_module *module;
 247
 248         /**
 249          * The device for which this output module is creating output. This
 250          * can be used by the module to find out channel names and numbers.
 251          */
 252         const struct sr_dev_inst *sdi;
 253
 254         /**
 255          * A generic pointer which can be used by the module to keep internal
 256          * state between calls into its callback functions.
 257          *
 258          * For example, the module might store a pointer to a chunk of output
 259          * there, and only flush it when it reaches a certain size.
 260          */
 261         void *priv;
 262 };
 263
 264 /** Output module driver. */
 265 struct sr_output_module {
 266         /**
 267          * A unique ID for this output module, suitable for use in command-line
 268          * clients, [a-z0-9-]. Must not be NULL.
 269          */
 270         char *id;
 271
 272         /**
 273          * A unique name for this output module, suitable for use in GUI
 274          * clients, can contain UTF-8. Must not be NULL.
 275          */
 276         const char *name;
 277
 278         /**
 279          * A short description of the output module. Must not be NULL.
 280          *
 281          * This can be displayed by frontends, e.g. when selecting the output
 282          * module for saving a file.
 283          */
 284         char *desc;
 285
 286         /**
 287          * Returns a NULL-terminated list of options this module can take.
 288          * Can be NULL, if the module has no options.
 289          */
 290         const struct sr_option *(*options) (void);
 291
 292         /**
 293          * This function is called once, at the beginning of an output stream.
 294          *
 295          * The device struct will be available in the output struct passed in,
 296          * as well as the param field -- which may be NULL or an empty string,
 297          * if no parameter was passed.
 298          *
 299          * The module can use this to initialize itself, create a struct for
 300          * keeping state and storing it in the <code>internal</code> field.
 301          *
 302          * @param o Pointer to the respective 'struct sr_output'.
 303          *
 304          * @retval SR_OK Success
 305          * @retval other Negative error code.
 306          */
 307         int (*init) (struct sr_output *o, GHashTable *options);
 308
 309         /**
 310          * This function is passed a copy of every packed in the data feed.
 311          * Any output generated by the output module in response to the
 312          * packet should be returned in a newly allocated GString
 313          * <code>out</code>, which will be freed by the caller.
 314          *
 315          * Packets not of interest to the output module can just be ignored,
 316          * and the <code>out</code> parameter set to NULL.
 317          *
 318          * @param o Pointer to the respective 'struct sr_output'.
 319          * @param sdi The device instance that generated the packet.
 320          * @param packet The complete packet.
 321          * @param out A pointer where a GString * should be stored if
 322          * the module generates output, or NULL if not.
 323          *
 324          * @retval SR_OK Success
 325          * @retval other Negative error code.
 326          */
 327         int (*receive) (const struct sr_output *o,
 328                         const struct sr_datafeed_packet *packet, GString **out);
 329
 330         /**
 331          * This function is called after the caller is finished using
 332          * the output module, and can be used to free any internal
 333          * resources the module may keep.
 334          *
 335          * @retval SR_OK Success
 336          * @retval other Negative error code.
 337          */
 338         int (*cleanup) (struct sr_output *o);
 339 };
 340
 341 #ifdef HAVE_LIBUSB_1_0
 342 /** USB device instance */
 343 struct sr_usb_dev_inst {
 344         /** USB bus */
 345         uint8_t bus;
 346         /** Device address on USB bus */
 347         uint8_t address;
 348         /** libusb device handle */
 349         struct libusb_device_handle *devhdl;
 350 };
 351 #endif
 352
 353 #ifdef HAVE_LIBSERIALPORT
 354 #define SERIAL_PARITY_NONE SP_PARITY_NONE
 355 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
 356 #define SERIAL_PARITY_ODD  SP_PARITY_ODD
 357 struct sr_serial_dev_inst {
 358         /** Port name, e.g. '/dev/tty42'. */
 359         char *port;
 360         /** Comm params for serial_set_paramstr(). */
 361         char *serialcomm;
 362         /** Port is non-blocking. */
 363         int nonblocking;
 364         /** libserialport port handle */
 365         struct sp_port *data;
 366         /** libserialport event set */
 367         struct sp_event_set *event_set;
 368         /** GPollFDs for event polling */
 369         GPollFD *pollfds;
 370 };
 371 #endif
 372
 373 struct sr_usbtmc_dev_inst {
 374         char *device;
 375         int fd;
 376 };
 377
 378 /* Private driver context. */
 379 struct drv_context {
 380         /** sigrok context */
 381         struct sr_context *sr_ctx;
 382         GSList *instances;
 383 };
 384
 385 /*--- log.c -----------------------------------------------------------------*/
 386
 387 SR_PRIV int sr_log(int loglevel, const char *format, ...);
 388 SR_PRIV int sr_spew(const char *format, ...);
 389 SR_PRIV int sr_dbg(const char *format, ...);
 390 SR_PRIV int sr_info(const char *format, ...);
 391 SR_PRIV int sr_warn(const char *format, ...);
 392 SR_PRIV int sr_err(const char *format, ...);
 393
 394 /* Message logging helpers with subsystem-specific prefix string. */
 395 #ifndef NO_LOG_WRAPPERS
 396 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
 397 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
 398 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
 399 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
 400 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
 401 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
 402 #endif
 403
 404 /*--- device.c --------------------------------------------------------------*/
 405
 406 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
 407 enum {
 408         /** The enabled state of the channel has been changed. */
 409         SR_CHANNEL_SET_ENABLED = 1 << 0,
 410 };
 411
 412 SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
 413                 gboolean enabled, const char *name);
 414
 415 /* Generic device instances */
 416 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 417                 const char *vendor, const char *model, const char *version);
 418 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 419
 420 #ifdef HAVE_LIBUSB_1_0
 421 /* USB-specific instances */
 422 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 423                 uint8_t address, struct libusb_device_handle *hdl);
 424 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 425 #endif
 426
 427 #ifdef HAVE_LIBSERIALPORT
 428 /* Serial-specific instances */
 429 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 430                 const char *serialcomm);
 431 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 432 #endif
 433
 434 /* USBTMC-specific instances */
 435 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
 436 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
 437
 438 /*--- hwdriver.c ------------------------------------------------------------*/
 439
 440 SR_PRIV void sr_hw_cleanup_all(void);
 441 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
 442 SR_PRIV void sr_config_free(struct sr_config *src);
 443 SR_PRIV int sr_source_remove(int fd);
 444 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
 445 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
 446 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 447                 sr_receive_data_callback cb, void *cb_data);
 448 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
 449                 sr_receive_data_callback cb, void *cb_data);
 450 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
 451                 sr_receive_data_callback cb, void *cb_data);
 452
 453 /*--- session.c -------------------------------------------------------------*/
 454
 455 struct sr_session {
 456         /** List of struct sr_dev pointers. */
 457         GSList *devs;
 458         /** List of struct datafeed_callback pointers. */
 459         GSList *datafeed_callbacks;
 460         struct sr_trigger *trigger;
 461         GTimeVal starttime;
 462         gboolean running;
 463
 464         unsigned int num_sources;
 465
 466         /*
 467          * Both "sources" and "pollfds" are of the same size and contain pairs
 468          * of descriptor and callback function. We can not embed the GPollFD
 469          * into the source struct since we want to be able to pass the array
 470          * of all poll descriptors to g_poll().
 471          */
 472         struct source *sources;
 473         GPollFD *pollfds;
 474         int source_timeout;
 475
 476         /*
 477          * These are our synchronization primitives for stopping the session in
 478          * an async fashion. We need to make sure the session is stopped from
 479          * within the session thread itself.
 480          */
 481         /** Mutex protecting access to abort_session. */
 482         GMutex stop_mutex;
 483         /** Abort current session. See sr_session_stop(). */
 484         gboolean abort_session;
 485 };
 486
 487 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 488                 const struct sr_datafeed_packet *packet);
 489 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
 490 SR_PRIV int sr_sessionfile_check(const char *filename);
 491
 492 /*--- std.c -----------------------------------------------------------------*/
 493
 494 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
 495 typedef void (*std_dev_clear_callback)(void *priv);
 496
 497 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 498                 const char *prefix);
 499 #ifdef HAVE_LIBSERIALPORT
 500 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
 501 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 502                 void *cb_data, dev_close_callback dev_close_fn,
 503                 struct sr_serial_dev_inst *serial, const char *prefix);
 504 #endif
 505 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 506                 const char *prefix);
 507 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 508                 std_dev_clear_callback clear_private);
 509 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
 510
 511 /*--- strutil.c -------------------------------------------------------------*/
 512
 513 SR_PRIV int sr_atol(const char *str, long *ret);
 514 SR_PRIV int sr_atoi(const char *str, int *ret);
 515 SR_PRIV int sr_atod(const char *str, double *ret);
 516 SR_PRIV int sr_atof(const char *str, float *ret);
 517 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
 518
 519 /*--- soft-trigger.c --------------------------------------------------------*/
 520
 521 struct soft_trigger_logic {
 522         const struct sr_dev_inst *sdi;
 523         const struct sr_trigger *trigger;
 524         int count;
 525         int unitsize;
 526         int cur_stage;
 527         uint8_t *prev_sample;
 528 };
 529
 530 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
 531                 const struct sr_dev_inst *sdi, struct sr_trigger *trigger);
 532 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
 533 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
 534                 int len);
 535
 536 /*--- hardware/common/serial.c ----------------------------------------------*/
 537
 538 #ifdef HAVE_LIBSERIALPORT
 539 enum {
 540         SERIAL_RDWR = 1,
 541         SERIAL_RDONLY = 2,
 542         SERIAL_NONBLOCK = 4,
 543 };
 544
 545 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
 546
 547 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 548 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 549 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
 550 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 551                 const void *buf, size_t count);
 552 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
 553                 const void *buf, size_t count);
 554 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
 555                 const void *buf, size_t count);
 556 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 557                 size_t count);
 558 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
 559                 size_t count);
 560 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
 561                 size_t count);
 562 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 563                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
 564 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 565                 const char *paramstr);
 566 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 567                 int *buflen, gint64 timeout_ms);
 568 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 569                                  uint8_t *buf, size_t *buflen,
 570                                  size_t packet_size,
 571                                  packet_valid_callback is_valid,
 572                                  uint64_t timeout_ms, int baudrate);
 573 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
 574                                       const char **serial_options);
 575 SR_PRIV int serial_source_add(struct sr_session *session,
 576                 struct sr_serial_dev_inst *serial, int events, int timeout,
 577                 sr_receive_data_callback cb, void *cb_data);
 578 SR_PRIV int serial_source_remove(struct sr_session *session,
 579                 struct sr_serial_dev_inst *serial);
 580 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
 581 #endif
 582
 583 /*--- hardware/common/ezusb.c -----------------------------------------------*/
 584
 585 #ifdef HAVE_LIBUSB_1_0
 586 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 587 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 588                                    const char *filename);
 589 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 590                                   const char *filename);
 591 #endif
 592
 593 /*--- hardware/common/usb.c -------------------------------------------------*/
 594
 595 #ifdef HAVE_LIBUSB_1_0
 596 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
 597 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
 598 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
 599                 int timeout, sr_receive_data_callback cb, void *cb_data);
 600 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
 601 #endif
 602
 603 /*--- hardware/common/scpi.c ------------------------------------------------*/
 604
 605 #define SCPI_CMD_IDN "*IDN?"
 606 #define SCPI_CMD_OPC "*OPC?"
 607
 608 enum {
 609         SCPI_CMD_SET_TRIGGER_SOURCE,
 610         SCPI_CMD_SET_TIMEBASE,
 611         SCPI_CMD_SET_VERTICAL_DIV,
 612         SCPI_CMD_SET_TRIGGER_SLOPE,
 613         SCPI_CMD_SET_COUPLING,
 614         SCPI_CMD_SET_HORIZ_TRIGGERPOS,
 615         SCPI_CMD_GET_ANALOG_CHAN_STATE,
 616         SCPI_CMD_GET_DIG_CHAN_STATE,
 617         SCPI_CMD_GET_TIMEBASE,
 618         SCPI_CMD_GET_VERTICAL_DIV,
 619         SCPI_CMD_GET_VERTICAL_OFFSET,
 620         SCPI_CMD_GET_TRIGGER_SOURCE,
 621         SCPI_CMD_GET_HORIZ_TRIGGERPOS,
 622         SCPI_CMD_GET_TRIGGER_SLOPE,
 623         SCPI_CMD_GET_COUPLING,
 624         SCPI_CMD_SET_ANALOG_CHAN_STATE,
 625         SCPI_CMD_SET_DIG_CHAN_STATE,
 626         SCPI_CMD_GET_DIG_POD_STATE,
 627         SCPI_CMD_SET_DIG_POD_STATE,
 628         SCPI_CMD_GET_ANALOG_DATA,
 629         SCPI_CMD_GET_DIG_DATA,
 630         SCPI_CMD_GET_SAMPLE_RATE,
 631         SCPI_CMD_GET_SAMPLE_RATE_LIVE,
 632 };
 633
 634 struct sr_scpi_hw_info {
 635         char *manufacturer;
 636         char *model;
 637         char *serial_number;
 638         char *firmware_version;
 639 };
 640
 641 struct sr_scpi_dev_inst {
 642         const char *name;
 643         const char *prefix;
 644         int priv_size;
 645         GSList *(*scan)(struct drv_context *drvc);
 646         int (*dev_inst_new)(void *priv, struct drv_context *drvc,
 647                 const char *resource, char **params, const char *serialcomm);
 648         int (*open)(void *priv);
 649         int (*source_add)(struct sr_session *session, void *priv, int events,
 650                 int timeout, sr_receive_data_callback cb, void *cb_data);
 651         int (*source_remove)(struct sr_session *session, void *priv);
 652         int (*send)(void *priv, const char *command);
 653         int (*read_begin)(void *priv);
 654         int (*read_data)(void *priv, char *buf, int maxlen);
 655         int (*read_complete)(void *priv);
 656         int (*close)(void *priv);
 657         void (*free)(void *priv);
 658         void *priv;
 659 };
 660
 661 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
 662                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
 663 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
 664                 const char *resource, const char *serialcomm);
 665 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
 666 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
 667                 struct sr_scpi_dev_inst *scpi, int events, int timeout,
 668                 sr_receive_data_callback cb, void *cb_data);
 669 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
 670                 struct sr_scpi_dev_inst *scpi);
 671 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
 672                 const char *format, ...);
 673 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 674                 const char *format, va_list args);
 675 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
 676 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
 677 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
 678 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
 679 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
 680
 681 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 682                         const char *command, char **scpi_response);
 683 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 684                         const char *command, gboolean *scpi_response);
 685 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 686                         const char *command, int *scpi_response);
 687 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 688                         const char *command, float *scpi_response);
 689 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 690                         const char *command, double *scpi_response);
 691 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
 692 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 693                         const char *command, GArray **scpi_response);
 694 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 695                         const char *command, GArray **scpi_response);
 696 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 697                         struct sr_scpi_hw_info **scpi_response);
 698 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
 699
 700 /*--- hardware/common/dmm/es519xx.c -----------------------------------------*/
 701
 702 /**
 703  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
 704  * so always read 2 blocks at a time.
 705  */
 706 #define ES519XX_11B_PACKET_SIZE (11 * 2)
 707 #define ES519XX_14B_PACKET_SIZE 14
 708
 709 struct es519xx_info {
 710         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
 711         gboolean is_milli, is_resistance, is_continuity, is_diode;
 712         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
 713         gboolean is_temperature, is_celsius, is_fahrenheit;
 714         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
 715         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
 716         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
 717         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
 718         uint32_t baudrate;
 719         int packet_size;
 720         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
 721 };
 722
 723 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
 724 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
 725                 struct sr_datafeed_analog *analog, void *info);
 726 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
 727 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
 728                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 729 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
 730 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
 731                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 732 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
 733 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
 734                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 735 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
 736 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
 737                 struct sr_datafeed_analog *analog, void *info);
 738 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
 739 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
 740                 struct sr_datafeed_analog *analog, void *info);
 741 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
 742 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
 743                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 744
 745 /*--- hardware/common/dmm/fs9922.c ------------------------------------------*/
 746
 747 #define FS9922_PACKET_SIZE 14
 748
 749 struct fs9922_info {
 750         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
 751         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
 752         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
 753         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
 754         gboolean is_celsius, is_fahrenheit;
 755         int bargraph_sign, bargraph_value;
 756 };
 757
 758 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
 759 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
 760                             struct sr_datafeed_analog *analog, void *info);
 761 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
 762
 763 /*--- hardware/common/dmm/fs9721.c ------------------------------------------*/
 764
 765 #define FS9721_PACKET_SIZE 14
 766
 767 struct fs9721_info {
 768         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
 769         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
 770         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
 771         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
 772 };
 773
 774 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 775 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 776                             struct sr_datafeed_analog *analog, void *info);
 777 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
 778 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
 779 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
 780 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
 781 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
 782
 783 /*--- hardware/common/dmm/m2110.c -----------------------------------------*/
 784
 785 #define BBCGM_M2110_PACKET_SIZE 9
 786
 787 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
 788 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
 789                              struct sr_datafeed_analog *analog, void *info);
 790
 791 /*--- hardware/common/dmm/metex14.c -----------------------------------------*/
 792
 793 #define METEX14_PACKET_SIZE 14
 794
 795 struct metex14_info {
 796         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
 797         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
 798         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
 799         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
 800         gboolean is_unitless, is_logic;
 801 };
 802
 803 #ifdef HAVE_LIBSERIALPORT
 804 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 805 #endif
 806 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 807 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
 808                              struct sr_datafeed_analog *analog, void *info);
 809
 810 /*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/
 811
 812 #define RS9LCD_PACKET_SIZE 9
 813
 814 /* Dummy info struct. The parser does not use it. */
 815 struct rs9lcd_info { int dummy; };
 816
 817 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 818 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
 819                             struct sr_datafeed_analog *analog, void *info);
 820
 821 /*--- hardware/common/dmm/bm25x.c -----------------------------------------*/
 822
 823 #define BRYMEN_BM25X_PACKET_SIZE 15
 824
 825 /* Dummy info struct. The parser does not use it. */
 826 struct bm25x_info { int dummy; };
 827
 828 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
 829 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
 830                              struct sr_datafeed_analog *analog, void *info);
 831
 832 #endif