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