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 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
  21 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
  22
  23 #include "config.h"
  24
  25 #include <glib.h>
  26 #ifdef HAVE_LIBHIDAPI
  27 #include <hidapi.h>
  28 #endif
  29 #ifdef HAVE_LIBSERIALPORT
  30 #include <libserialport.h>
  31 #endif
  32 #ifdef HAVE_LIBUSB_1_0
  33 #include <libusb.h>
  34 #endif
  35 #include <stdarg.h>
  36 #include <stdint.h>
  37 #include <stdio.h>
  38 #include <stdlib.h>
  39
  40 struct zip;
  41 struct zip_stat;
  42
  43 /**
  44  * @file
  45  *
  46  * libsigrok private header file, only to be used internally.
  47  */
  48
  49 /*--- Macros ----------------------------------------------------------------*/
  50
  51 #ifndef ARRAY_SIZE
  52 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  53 #endif
  54
  55 #ifndef ARRAY_AND_SIZE
  56 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  57 #endif
  58
  59 #ifndef G_SOURCE_FUNC
  60 #define G_SOURCE_FUNC(f) ((GSourceFunc) (void (*)(void)) (f)) /* Since 2.58. */
  61 #endif
  62
  63 #define SR_RECEIVE_DATA_CALLBACK(f) \
  64         ((sr_receive_data_callback) (void (*)(void)) (f))
  65
  66 /**
  67  * Read a 8 bits unsigned integer out of memory.
  68  * @param x a pointer to the input memory
  69  * @return the corresponding unsigned integer
  70  */
  71 #define R8(x)     ((unsigned)((const uint8_t*)(x))[0])
  72
  73 /**
  74  * Read a 16 bits big endian unsigned integer out of memory.
  75  * @param x a pointer to the input memory
  76  * @return the corresponding unsigned integer
  77  */
  78 #define RB16(x)  (((unsigned)((const uint8_t*)(x))[0] <<  8) | \
  79                    (unsigned)((const uint8_t*)(x))[1])
  80
  81 /**
  82  * Read a 16 bits little endian unsigned integer out of memory.
  83  * @param x a pointer to the input memory
  84  * @return the corresponding unsigned integer
  85  */
  86 #define RL16(x)  (((unsigned)((const uint8_t*)(x))[1] <<  8) | \
  87                    (unsigned)((const uint8_t*)(x))[0])
  88
  89 /**
  90  * Read a 16 bits big endian signed integer out of memory.
  91  * @param x a pointer to the input memory
  92  * @return the corresponding signed integer
  93  */
  94 #define RB16S(x)  ((int16_t) \
  95                   (((unsigned)((const uint8_t*)(x))[0] <<  8) | \
  96                     (unsigned)((const uint8_t*)(x))[1]))
  97
  98 /**
  99  * Read a 16 bits little endian signed integer out of memory.
 100  * @param x a pointer to the input memory
 101  * @return the corresponding signed integer
 102  */
 103 #define RL16S(x)  ((int16_t) \
 104                   (((unsigned)((const uint8_t*)(x))[1] <<  8) | \
 105                     (unsigned)((const uint8_t*)(x))[0]))
 106
 107 /**
 108  * Read a 32 bits big endian unsigned integer out of memory.
 109  * @param x a pointer to the input memory
 110  * @return the corresponding unsigned integer
 111  */
 112 #define RB32(x)  (((unsigned)((const uint8_t*)(x))[0] << 24) | \
 113                   ((unsigned)((const uint8_t*)(x))[1] << 16) | \
 114                   ((unsigned)((const uint8_t*)(x))[2] <<  8) | \
 115                    (unsigned)((const uint8_t*)(x))[3])
 116
 117 /**
 118  * Read a 32 bits little endian unsigned integer out of memory.
 119  * @param x a pointer to the input memory
 120  * @return the corresponding unsigned integer
 121  */
 122 #define RL32(x)  (((unsigned)((const uint8_t*)(x))[3] << 24) | \
 123                   ((unsigned)((const uint8_t*)(x))[2] << 16) | \
 124                   ((unsigned)((const uint8_t*)(x))[1] <<  8) | \
 125                    (unsigned)((const uint8_t*)(x))[0])
 126
 127 /**
 128  * Read a 32 bits big endian signed integer out of memory.
 129  * @param x a pointer to the input memory
 130  * @return the corresponding signed integer
 131  */
 132 #define RB32S(x)  ((int32_t) \
 133                  (((unsigned)((const uint8_t*)(x))[0] << 24) | \
 134                   ((unsigned)((const uint8_t*)(x))[1] << 16) | \
 135                   ((unsigned)((const uint8_t*)(x))[2] <<  8) | \
 136                    (unsigned)((const uint8_t*)(x))[3]))
 137
 138 /**
 139  * Read a 32 bits little endian signed integer out of memory.
 140  * @param x a pointer to the input memory
 141  * @return the corresponding signed integer
 142  */
 143 #define RL32S(x)  ((int32_t) \
 144                  (((unsigned)((const uint8_t*)(x))[3] << 24) | \
 145                   ((unsigned)((const uint8_t*)(x))[2] << 16) | \
 146                   ((unsigned)((const uint8_t*)(x))[1] <<  8) | \
 147                    (unsigned)((const uint8_t*)(x))[0]))
 148
 149 /**
 150  * Read a 64 bits big endian unsigned integer out of memory.
 151  * @param x a pointer to the input memory
 152  * @return the corresponding unsigned integer
 153  */
 154 #define RB64(x)  (((uint64_t)((const uint8_t*)(x))[0] << 56) | \
 155                   ((uint64_t)((const uint8_t*)(x))[1] << 48) | \
 156                   ((uint64_t)((const uint8_t*)(x))[2] << 40) | \
 157                   ((uint64_t)((const uint8_t*)(x))[3] << 32) | \
 158                   ((uint64_t)((const uint8_t*)(x))[4] << 24) | \
 159                   ((uint64_t)((const uint8_t*)(x))[5] << 16) | \
 160                   ((uint64_t)((const uint8_t*)(x))[6] <<  8) | \
 161                    (uint64_t)((const uint8_t*)(x))[7])
 162
 163 /**
 164  * Read a 64 bits little endian unsigned integer out of memory.
 165  * @param x a pointer to the input memory
 166  * @return the corresponding unsigned integer
 167  */
 168 #define RL64(x)  (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
 169                   ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
 170                   ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
 171                   ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
 172                   ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
 173                   ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
 174                   ((uint64_t)((const uint8_t*)(x))[1] <<  8) | \
 175                    (uint64_t)((const uint8_t*)(x))[0])
 176
 177 /**
 178  * Read a 64 bits little endian signed integer out of memory.
 179  * @param x a pointer to the input memory
 180  * @return the corresponding unsigned integer
 181  */
 182 #define RL64S(x)  ((int64_t) \
 183                  (((uint64_t)((const uint8_t*)(x))[7] << 56) | \
 184                   ((uint64_t)((const uint8_t*)(x))[6] << 48) | \
 185                   ((uint64_t)((const uint8_t*)(x))[5] << 40) | \
 186                   ((uint64_t)((const uint8_t*)(x))[4] << 32) | \
 187                   ((uint64_t)((const uint8_t*)(x))[3] << 24) | \
 188                   ((uint64_t)((const uint8_t*)(x))[2] << 16) | \
 189                   ((uint64_t)((const uint8_t*)(x))[1] <<  8) | \
 190                    (uint64_t)((const uint8_t*)(x))[0]))
 191
 192 /**
 193  * Read a 32 bits big endian float out of memory.
 194  * @param x a pointer to the input memory
 195  * @return the corresponding float
 196  */
 197 #define RBFL(x)  ((union { uint32_t u; float f; }) { .u = RB32(x) }.f)
 198
 199 /**
 200  * Read a 32 bits little endian float out of memory.
 201  * @param x a pointer to the input memory
 202  * @return the corresponding float
 203  */
 204 #define RLFL(x)  ((union { uint32_t u; float f; }) { .u = RL32(x) }.f)
 205
 206 /**
 207  * Write a 8 bits unsigned integer to memory.
 208  * @param p a pointer to the output memory
 209  * @param x the input unsigned integer
 210  */
 211 #define W8(p, x)    do { ((uint8_t*)(p))[0] = (uint8_t) (x);      } while (0)
 212
 213 /**
 214  * Write a 16 bits unsigned integer to memory stored as big endian.
 215  * @param p a pointer to the output memory
 216  * @param x the input unsigned integer
 217  */
 218 #define WB16(p, x)  do { ((uint8_t*)(p))[1] = (uint8_t) (x);      \
 219                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>8);  } while (0)
 220
 221 /**
 222  * Write a 16 bits unsigned integer to memory stored as little endian.
 223  * @param p a pointer to the output memory
 224  * @param x the input unsigned integer
 225  */
 226 #define WL16(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
 227                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  } while (0)
 228
 229 /**
 230  * Write a 32 bits unsigned integer to memory stored as big endian.
 231  * @param p a pointer to the output memory
 232  * @param x the input unsigned integer
 233  */
 234 #define WB32(p, x)  do { ((uint8_t*)(p))[3] = (uint8_t) (x);      \
 235                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>8);  \
 236                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
 237                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0)
 238
 239 /**
 240  * Write a 32 bits unsigned integer to memory stored as little endian.
 241  * @param p a pointer to the output memory
 242  * @param x the input unsigned integer
 243  */
 244 #define WL32(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
 245                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  \
 246                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
 247                          ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0)
 248
 249 /**
 250  * Write a 32 bits float to memory stored as big endian.
 251  * @param p a pointer to the output memory
 252  * @param x the input float
 253  */
 254 #define WBFL(p, x)  WB32(p, (union { uint32_t u; float f; }) { .f = x }.u)
 255
 256 /**
 257  * Write a 32 bits float to memory stored as little endian.
 258  * @param p a pointer to the output memory
 259  * @param x the input float
 260  */
 261 #define WLFL(p, x)  WL32(p, (union { uint32_t u; float f; }) { .f = x }.u)
 262
 263 /* Portability fixes for FreeBSD. */
 264 #ifdef __FreeBSD__
 265 #define LIBUSB_CLASS_APPLICATION 0xfe
 266 #define libusb_has_capability(x) 0
 267 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
 268         libusb_handle_events_timeout(ctx, tv)
 269 #endif
 270
 271 /* Static definitions of structs ending with an all-zero entry are a
 272  * problem when compiling with -Wmissing-field-initializers: GCC
 273  * suppresses the warning only with { 0 }, clang wants { } */
 274 #ifdef __clang__
 275 #define ALL_ZERO { }
 276 #else
 277 #define ALL_ZERO { 0 }
 278 #endif
 279
 280 #ifdef __APPLE__
 281 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
 282 #else
 283 #define SR_DRIVER_LIST_SECTION "__sr_driver_list"
 284 #endif
 285
 286 /**
 287  * Register a list of hardware drivers.
 288  *
 289  * This macro can be used to register multiple hardware drivers to the library.
 290  * This is useful when a driver supports multiple similar but slightly
 291  * different devices that require different sr_dev_driver struct definitions.
 292  *
 293  * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
 294  *
 295  * Example:
 296  * @code{c}
 297  * #define MY_DRIVER(_name) \
 298  *     &(struct sr_dev_driver){ \
 299  *         .name = _name, \
 300  *         ...
 301  *     };
 302  *
 303  * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
 304  *     MY_DRIVER("driver 1"),
 305  *     MY_DRIVER("driver 2"),
 306  *     ...
 307  * );
 308  * @endcode
 309  *
 310  * @param name Name to use for the driver list identifier.
 311  * @param ... Comma separated list of pointers to sr_dev_driver structs.
 312  */
 313 #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
 314         static const struct sr_dev_driver *name[] \
 315                 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
 316                         aligned(sizeof(struct sr_dev_driver *)))) \
 317                 = { \
 318                         __VA_ARGS__ \
 319                 };
 320
 321 /**
 322  * Register a hardware driver.
 323  *
 324  * This macro is used to register a hardware driver with the library. It has
 325  * to be used in order to make the driver accessible to applications using the
 326  * library.
 327  *
 328  * The macro invocation should be placed directly under the struct
 329  * sr_dev_driver definition.
 330  *
 331  * Example:
 332  * @code{c}
 333  * static struct sr_dev_driver driver_info = {
 334  *     .name = "driver",
 335  *     ....
 336  * };
 337  * SR_REGISTER_DEV_DRIVER(driver_info);
 338  * @endcode
 339  *
 340  * @param name Identifier name of sr_dev_driver struct to register.
 341  */
 342 #define SR_REGISTER_DEV_DRIVER(name) \
 343         SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
 344
 345 SR_API void sr_drivers_init(struct sr_context *context);
 346
 347 struct sr_context {
 348         struct sr_dev_driver **driver_list;
 349 #ifdef HAVE_LIBUSB_1_0
 350         libusb_context *libusb_ctx;
 351 #endif
 352         sr_resource_open_callback resource_open_cb;
 353         sr_resource_close_callback resource_close_cb;
 354         sr_resource_read_callback resource_read_cb;
 355         void *resource_cb_data;
 356 };
 357
 358 /** Input module metadata keys. */
 359 enum sr_input_meta_keys {
 360         /** The input filename, if there is one. */
 361         SR_INPUT_META_FILENAME = 0x01,
 362         /** The input file's size in bytes. */
 363         SR_INPUT_META_FILESIZE = 0x02,
 364         /** The first 128 bytes of the file, provided as a GString. */
 365         SR_INPUT_META_HEADER = 0x04,
 366
 367         /** The module cannot identify a file without this metadata. */
 368         SR_INPUT_META_REQUIRED = 0x80,
 369 };
 370
 371 /** Input (file) module struct. */
 372 struct sr_input {
 373         /**
 374          * A pointer to this input module's 'struct sr_input_module'.
 375          */
 376         const struct sr_input_module *module;
 377         GString *buf;
 378         struct sr_dev_inst *sdi;
 379         gboolean sdi_ready;
 380         void *priv;
 381 };
 382
 383 /** Input (file) module driver. */
 384 struct sr_input_module {
 385         /**
 386          * A unique ID for this input module, suitable for use in command-line
 387          * clients, [a-z0-9-]. Must not be NULL.
 388          */
 389         const char *id;
 390
 391         /**
 392          * A unique name for this input module, suitable for use in GUI
 393          * clients, can contain UTF-8. Must not be NULL.
 394          */
 395         const char *name;
 396
 397         /**
 398          * A short description of the input module. Must not be NULL.
 399          *
 400          * This can be displayed by frontends, e.g. when selecting the input
 401          * module for saving a file.
 402          */
 403         const char *desc;
 404
 405         /**
 406          * A NULL terminated array of strings containing a list of file name
 407          * extensions typical for the input file format, or NULL if there is
 408          * no typical extension for this file format.
 409          */
 410         const char *const *exts;
 411
 412         /**
 413          * Zero-terminated list of metadata items the module needs to be able
 414          * to identify an input stream. Can be all-zero, if the module cannot
 415          * identify streams at all, i.e. has to be forced into use.
 416          *
 417          * Each item is one of:
 418          *   SR_INPUT_META_FILENAME
 419          *   SR_INPUT_META_FILESIZE
 420          *   SR_INPUT_META_HEADER
 421          *
 422          * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
 423          * identify a stream without the given metadata.
 424          */
 425         const uint8_t metadata[8];
 426
 427         /**
 428          * Returns a NULL-terminated list of options this module can take.
 429          * Can be NULL, if the module has no options.
 430          */
 431         const struct sr_option *(*options) (void);
 432
 433         /**
 434          * Check if this input module can load and parse the specified stream.
 435          *
 436          * @param[in] metadata Metadata the module can use to identify the stream.
 437          * @param[out] confidence "Strength" of the detection.
 438          *   Specialized handlers can take precedence over generic/basic support.
 439          *
 440          * @retval SR_OK This module knows the format.
 441          * @retval SR_ERR_NA There wasn't enough data for this module to
 442          *   positively identify the format.
 443          * @retval SR_ERR_DATA This module knows the format, but cannot handle
 444          *   it. This means the stream is either corrupt, or indicates a
 445          *   feature that the module does not support.
 446          * @retval SR_ERR This module does not know the format.
 447          *
 448          * Lower numeric values of 'confidence' mean that the input module
 449          * stronger believes in its capability to handle this specific format.
 450          * This way, multiple input modules can claim support for a format,
 451          * and the application can pick the best match, or try fallbacks
 452          * in case of errors. This approach also copes with formats that
 453          * are unreliable to detect in the absence of magic signatures.
 454          */
 455         int (*format_match) (GHashTable *metadata, unsigned int *confidence);
 456
 457         /**
 458          * Initialize the input module.
 459          *
 460          * @retval SR_OK Success
 461          * @retval other Negative error code.
 462          */
 463         int (*init) (struct sr_input *in, GHashTable *options);
 464
 465         /**
 466          * Send data to the specified input instance.
 467          *
 468          * When an input module instance is created with sr_input_new(), this
 469          * function is used to feed data to the instance.
 470          *
 471          * As enough data gets fed into this function to completely populate
 472          * the device instance associated with this input instance, this is
 473          * guaranteed to return the moment it's ready. This gives the caller
 474          * the chance to examine the device instance, attach session callbacks
 475          * and so on.
 476          *
 477          * @retval SR_OK Success
 478          * @retval other Negative error code.
 479          */
 480         int (*receive) (struct sr_input *in, GString *buf);
 481
 482         /**
 483          * Signal the input module no more data will come.
 484          *
 485          * This will cause the module to process any data it may have buffered.
 486          * The SR_DF_END packet will also typically be sent at this time.
 487          */
 488         int (*end) (struct sr_input *in);
 489
 490         /**
 491          * Reset the input module's input handling structures.
 492          *
 493          * Causes the input module to reset its internal state so that we can
 494          * re-send the input data from the beginning without having to
 495          * re-create the entire input module.
 496          *
 497          * @retval SR_OK Success.
 498          * @retval other Negative error code.
 499          */
 500         int (*reset) (struct sr_input *in);
 501
 502         /**
 503          * This function is called after the caller is finished using
 504          * the input module, and can be used to free any internal
 505          * resources the module may keep.
 506          *
 507          * This function is optional.
 508          *
 509          * @retval SR_OK Success
 510          * @retval other Negative error code.
 511          */
 512         void (*cleanup) (struct sr_input *in);
 513 };
 514
 515 /** Output module instance. */
 516 struct sr_output {
 517         /** A pointer to this output's module. */
 518         const struct sr_output_module *module;
 519
 520         /**
 521          * The device for which this output module is creating output. This
 522          * can be used by the module to find out channel names and numbers.
 523          */
 524         const struct sr_dev_inst *sdi;
 525
 526         /**
 527          * The name of the file that the data should be written to.
 528          */
 529         const char *filename;
 530
 531         /**
 532          * A generic pointer which can be used by the module to keep internal
 533          * state between calls into its callback functions.
 534          *
 535          * For example, the module might store a pointer to a chunk of output
 536          * there, and only flush it when it reaches a certain size.
 537          */
 538         void *priv;
 539 };
 540
 541 /** Output module driver. */
 542 struct sr_output_module {
 543         /**
 544          * A unique ID for this output module, suitable for use in command-line
 545          * clients, [a-z0-9-]. Must not be NULL.
 546          */
 547         const char *id;
 548
 549         /**
 550          * A unique name for this output module, suitable for use in GUI
 551          * clients, can contain UTF-8. Must not be NULL.
 552          */
 553         const char *name;
 554
 555         /**
 556          * A short description of the output module. Must not be NULL.
 557          *
 558          * This can be displayed by frontends, e.g. when selecting the output
 559          * module for saving a file.
 560          */
 561         const char *desc;
 562
 563         /**
 564          * A NULL terminated array of strings containing a list of file name
 565          * extensions typical for the input file format, or NULL if there is
 566          * no typical extension for this file format.
 567          */
 568         const char *const *exts;
 569
 570         /**
 571          * Bitfield containing flags that describe certain properties
 572          * this output module may or may not have.
 573          * @see sr_output_flags
 574          */
 575         const uint64_t flags;
 576
 577         /**
 578          * Returns a NULL-terminated list of options this module can take.
 579          * Can be NULL, if the module has no options.
 580          */
 581         const struct sr_option *(*options) (void);
 582
 583         /**
 584          * This function is called once, at the beginning of an output stream.
 585          *
 586          * The device struct will be available in the output struct passed in,
 587          * as well as the param field -- which may be NULL or an empty string,
 588          * if no parameter was passed.
 589          *
 590          * The module can use this to initialize itself, create a struct for
 591          * keeping state and storing it in the <code>internal</code> field.
 592          *
 593          * @param o Pointer to the respective 'struct sr_output'.
 594          *
 595          * @retval SR_OK Success
 596          * @retval other Negative error code.
 597          */
 598         int (*init) (struct sr_output *o, GHashTable *options);
 599
 600         /**
 601          * This function is passed a copy of every packet in the data feed.
 602          * Any output generated by the output module in response to the
 603          * packet should be returned in a newly allocated GString
 604          * <code>out</code>, which will be freed by the caller.
 605          *
 606          * Packets not of interest to the output module can just be ignored,
 607          * and the <code>out</code> parameter set to NULL.
 608          *
 609          * @param o Pointer to the respective 'struct sr_output'.
 610          * @param sdi The device instance that generated the packet.
 611          * @param packet The complete packet.
 612          * @param out A pointer where a GString * should be stored if
 613          * the module generates output, or NULL if not.
 614          *
 615          * @retval SR_OK Success
 616          * @retval other Negative error code.
 617          */
 618         int (*receive) (const struct sr_output *o,
 619                         const struct sr_datafeed_packet *packet, GString **out);
 620
 621         /**
 622          * This function is called after the caller is finished using
 623          * the output module, and can be used to free any internal
 624          * resources the module may keep.
 625          *
 626          * @retval SR_OK Success
 627          * @retval other Negative error code.
 628          */
 629         int (*cleanup) (struct sr_output *o);
 630 };
 631
 632 /** Transform module instance. */
 633 struct sr_transform {
 634         /** A pointer to this transform's module. */
 635         const struct sr_transform_module *module;
 636
 637         /**
 638          * The device for which this transform module is used. This
 639          * can be used by the module to find out channel names and numbers.
 640          */
 641         const struct sr_dev_inst *sdi;
 642
 643         /**
 644          * A generic pointer which can be used by the module to keep internal
 645          * state between calls into its callback functions.
 646          */
 647         void *priv;
 648 };
 649
 650 struct sr_transform_module {
 651         /**
 652          * A unique ID for this transform module, suitable for use in
 653          * command-line clients, [a-z0-9-]. Must not be NULL.
 654          */
 655         const char *id;
 656
 657         /**
 658          * A unique name for this transform module, suitable for use in GUI
 659          * clients, can contain UTF-8. Must not be NULL.
 660          */
 661         const char *name;
 662
 663         /**
 664          * A short description of the transform module. Must not be NULL.
 665          *
 666          * This can be displayed by frontends, e.g. when selecting
 667          * which transform module(s) to add.
 668          */
 669         const char *desc;
 670
 671         /**
 672          * Returns a NULL-terminated list of options this transform module
 673          * can take. Can be NULL, if the transform module has no options.
 674          */
 675         const struct sr_option *(*options) (void);
 676
 677         /**
 678          * This function is called once, at the beginning of a stream.
 679          *
 680          * @param t Pointer to the respective 'struct sr_transform'.
 681          * @param options Hash table of options for this transform module.
 682          *                Can be NULL if no options are to be used.
 683          *
 684          * @retval SR_OK Success
 685          * @retval other Negative error code.
 686          */
 687         int (*init) (struct sr_transform *t, GHashTable *options);
 688
 689         /**
 690          * This function is passed a pointer to every packet in the data feed.
 691          *
 692          * It can either return (in packet_out) a pointer to another packet
 693          * (possibly the exact same packet it got as input), or NULL.
 694          *
 695          * @param t Pointer to the respective 'struct sr_transform'.
 696          * @param packet_in Pointer to a datafeed packet.
 697          * @param packet_out Pointer to the resulting datafeed packet after
 698          *                   this function was run. If NULL, the transform
 699          *                   module intentionally didn't output a new packet.
 700          *
 701          * @retval SR_OK Success
 702          * @retval other Negative error code.
 703          */
 704         int (*receive) (const struct sr_transform *t,
 705                         struct sr_datafeed_packet *packet_in,
 706                         struct sr_datafeed_packet **packet_out);
 707
 708         /**
 709          * This function is called after the caller is finished using
 710          * the transform module, and can be used to free any internal
 711          * resources the module may keep.
 712          *
 713          * @retval SR_OK Success
 714          * @retval other Negative error code.
 715          */
 716         int (*cleanup) (struct sr_transform *t);
 717 };
 718
 719 #ifdef HAVE_LIBUSB_1_0
 720 /** USB device instance */
 721 struct sr_usb_dev_inst {
 722         /** USB bus */
 723         uint8_t bus;
 724         /** Device address on USB bus */
 725         uint8_t address;
 726         /** libusb device handle */
 727         struct libusb_device_handle *devhdl;
 728 };
 729 #endif
 730
 731 struct sr_serial_dev_inst;
 732 #ifdef HAVE_SERIAL_COMM
 733 struct ser_lib_functions;
 734 struct ser_hid_chip_functions;
 735 struct sr_bt_desc;
 736 typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial,
 737         void *cb_data, const void *buf, size_t count);
 738 struct sr_serial_dev_inst {
 739         /** Port name, e.g. '/dev/tty42'. */
 740         char *port;
 741         /** Comm params for serial_set_paramstr(). */
 742         char *serialcomm;
 743         struct ser_lib_functions *lib_funcs;
 744         struct {
 745                 int bit_rate;
 746                 int data_bits;
 747                 int parity_bits;
 748                 int stop_bits;
 749         } comm_params;
 750         GString *rcv_buffer;
 751         serial_rx_chunk_callback rx_chunk_cb_func;
 752         void *rx_chunk_cb_data;
 753 #ifdef HAVE_LIBSERIALPORT
 754         /** libserialport port handle */
 755         struct sp_port *sp_data;
 756 #endif
 757 #ifdef HAVE_LIBHIDAPI
 758         enum ser_hid_chip_t {
 759                 SER_HID_CHIP_UNKNOWN,           /**!< place holder */
 760                 SER_HID_CHIP_BTC_BU86X,         /**!< Brymen BU86x */
 761                 SER_HID_CHIP_SIL_CP2110,        /**!< SiLabs CP2110 */
 762                 SER_HID_CHIP_VICTOR_DMM,        /**!< Victor 70/86 DMM cable */
 763                 SER_HID_CHIP_WCH_CH9325,        /**!< WCH CH9325 */
 764                 SER_HID_CHIP_LAST,              /**!< sentinel */
 765         } hid_chip;
 766         struct ser_hid_chip_functions *hid_chip_funcs;
 767         char *usb_path;
 768         char *usb_serno;
 769         const char *hid_path;
 770         hid_device *hid_dev;
 771         GSList *hid_source_args;
 772 #endif
 773 #ifdef HAVE_BLUETOOTH
 774         enum ser_bt_conn_t {
 775                 SER_BT_CONN_UNKNOWN,    /**!< place holder */
 776                 SER_BT_CONN_RFCOMM,     /**!< BT classic, RFCOMM channel */
 777                 SER_BT_CONN_BLE122,     /**!< BLE, BLE122 module, indications */
 778                 SER_BT_CONN_NRF51,      /**!< BLE, Nordic nRF51, notifications */
 779                 SER_BT_CONN_CC254x,     /**!< BLE, TI CC254x, notifications */
 780                 SER_BT_CONN_MAX,        /**!< sentinel */
 781         } bt_conn_type;
 782         char *bt_addr_local;
 783         char *bt_addr_remote;
 784         size_t bt_rfcomm_channel;
 785         uint16_t bt_notify_handle_read;
 786         uint16_t bt_notify_handle_write;
 787         uint16_t bt_notify_handle_cccd;
 788         uint16_t bt_notify_value_cccd;
 789         struct sr_bt_desc *bt_desc;
 790         GSList *bt_source_args;
 791 #endif
 792 };
 793 #endif
 794
 795 struct sr_usbtmc_dev_inst {
 796         char *device;
 797         int fd;
 798 };
 799
 800 /* Private driver context. */
 801 struct drv_context {
 802         /** sigrok context */
 803         struct sr_context *sr_ctx;
 804         GSList *instances;
 805 };
 806
 807 /*--- log.c -----------------------------------------------------------------*/
 808
 809 #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
 810 /*
 811  * On MinGW, we need to specify the gnu_printf format flavor or GCC
 812  * will assume non-standard Microsoft printf syntax.
 813  */
 814 SR_PRIV int sr_log(int loglevel, const char *format, ...)
 815                 __attribute__((__format__ (__gnu_printf__, 2, 3)));
 816 #else
 817 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
 818 #endif
 819
 820 /* Message logging helpers with subsystem-specific prefix string. */
 821 #define sr_spew(...)    sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
 822 #define sr_dbg(...)     sr_log(SR_LOG_DBG,  LOG_PREFIX ": " __VA_ARGS__)
 823 #define sr_info(...)    sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
 824 #define sr_warn(...)    sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
 825 #define sr_err(...)     sr_log(SR_LOG_ERR,  LOG_PREFIX ": " __VA_ARGS__)
 826
 827 /*--- device.c --------------------------------------------------------------*/
 828
 829 /** Scan options supported by a driver. */
 830 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
 831
 832 /** Device options for a particular device. */
 833 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
 834
 835 /** Mask for separating config keys from capabilities. */
 836 #define SR_CONF_MASK 0x1fffffff
 837
 838 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
 839 enum {
 840         /** The enabled state of the channel has been changed. */
 841         SR_CHANNEL_SET_ENABLED = 1 << 0,
 842 };
 843
 844 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
 845                 int index, int type, gboolean enabled, const char *name);
 846 SR_PRIV void sr_channel_free(struct sr_channel *ch);
 847 SR_PRIV void sr_channel_free_cb(void *p);
 848 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
 849                 struct sr_channel *cur_channel);
 850 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
 851 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
 852
 853 /** Device instance data */
 854 struct sr_dev_inst {
 855         /** Device driver. */
 856         struct sr_dev_driver *driver;
 857         /** Device instance status. SR_ST_NOT_FOUND, etc. */
 858         int status;
 859         /** Device instance type. SR_INST_USB, etc. */
 860         int inst_type;
 861         /** Device vendor. */
 862         char *vendor;
 863         /** Device model. */
 864         char *model;
 865         /** Device version. */
 866         char *version;
 867         /** Serial number. */
 868         char *serial_num;
 869         /** Connection string to uniquely identify devices. */
 870         char *connection_id;
 871         /** List of channels. */
 872         GSList *channels;
 873         /** List of sr_channel_group structs */
 874         GSList *channel_groups;
 875         /** Device instance connection data (used?) */
 876         void *conn;
 877         /** Device instance private data (used?) */
 878         void *priv;
 879         /** Session to which this device is currently assigned. */
 880         struct sr_session *session;
 881 };
 882
 883 /* Generic device instances */
 884 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 885
 886 #ifdef HAVE_LIBUSB_1_0
 887 /* USB-specific instances */
 888 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 889                 uint8_t address, struct libusb_device_handle *hdl);
 890 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 891 #endif
 892
 893 #ifdef HAVE_SERIAL_COMM
 894 #ifndef HAVE_LIBSERIALPORT
 895 /*
 896  * Some identifiers which initially got provided by libserialport are
 897  * used internally within the libsigrok serial layer's implementation,
 898  * while libserialport no longer is the exclusive provider of serial
 899  * communication support. Declare the identifiers here so they remain
 900  * available across all build configurations.
 901  */
 902 enum libsp_parity {
 903         SP_PARITY_NONE = 0,
 904         SP_PARITY_ODD = 1,
 905         SP_PARITY_EVEN = 2,
 906         SP_PARITY_MARK = 3,
 907         SP_PARITY_SPACE = 4,
 908 };
 909
 910 enum libsp_flowcontrol {
 911         SP_FLOWCONTROL_NONE = 0,
 912         SP_FLOWCONTROL_XONXOFF = 1,
 913         SP_FLOWCONTROL_RTSCTS = 2,
 914         SP_FLOWCONTROL_DTRDSR = 3,
 915 };
 916 #endif
 917
 918 /* Serial-specific instances */
 919 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 920                 const char *serialcomm);
 921 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 922 #endif
 923
 924 /* USBTMC-specific instances */
 925 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
 926 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
 927
 928 /*--- hwdriver.c ------------------------------------------------------------*/
 929
 930 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
 931 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
 932 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
 933 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
 934 SR_PRIV void sr_config_free(struct sr_config *src);
 935 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
 936 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
 937
 938 /*--- session.c -------------------------------------------------------------*/
 939
 940 struct sr_session {
 941         /** Context this session exists in. */
 942         struct sr_context *ctx;
 943         /** List of struct sr_dev_inst pointers. */
 944         GSList *devs;
 945         /** List of struct sr_dev_inst pointers owned by this session. */
 946         GSList *owned_devs;
 947         /** List of struct datafeed_callback pointers. */
 948         GSList *datafeed_callbacks;
 949         GSList *transforms;
 950         struct sr_trigger *trigger;
 951
 952         /** Callback to invoke on session stop. */
 953         sr_session_stopped_callback stopped_callback;
 954         /** User data to be passed to the session stop callback. */
 955         void *stopped_cb_data;
 956
 957         /** Mutex protecting the main context pointer. */
 958         GMutex main_mutex;
 959         /** Context of the session main loop. */
 960         GMainContext *main_context;
 961
 962         /** Registered event sources for this session. */
 963         GHashTable *event_sources;
 964         /** Session main loop. */
 965         GMainLoop *main_loop;
 966         /** ID of idle source for dispatching the session stop notification. */
 967         unsigned int stop_check_id;
 968         /** Whether the session has been started. */
 969         gboolean running;
 970 };
 971
 972 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
 973                 void *key, GSource *source);
 974 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
 975                 void *key);
 976 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
 977                 void *key, GSource *source);
 978 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
 979                 void *key, gintptr fd, int events, int timeout,
 980                 sr_receive_data_callback cb, void *cb_data);
 981
 982 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
 983                 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
 984 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
 985                 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
 986                 void *cb_data);
 987 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
 988                 GIOChannel *channel, int events, int timeout,
 989                 sr_receive_data_callback cb, void *cb_data);
 990 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
 991 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
 992                 GPollFD *pollfd);
 993 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
 994                 GIOChannel *channel);
 995
 996 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
 997                 uint32_t key, GVariant *var);
 998 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 999                 const struct sr_datafeed_packet *packet);
1000 SR_PRIV int sr_sessionfile_check(const char *filename);
1001 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
1002                 struct sr_session **session);
1003
1004 /*--- session_file.c --------------------------------------------------------*/
1005
1006 #if !HAVE_ZIP_DISCARD
1007 /* Replace zip_discard() if not available. */
1008 #define zip_discard(zip) sr_zip_discard(zip)
1009 SR_PRIV void sr_zip_discard(struct zip *archive);
1010 #endif
1011
1012 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1013                         const struct zip_stat *entry);
1014
1015 /*--- analog.c --------------------------------------------------------------*/
1016
1017 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
1018                            struct sr_analog_encoding *encoding,
1019                            struct sr_analog_meaning *meaning,
1020                            struct sr_analog_spec *spec,
1021                            int digits);
1022
1023 /*--- std.c -----------------------------------------------------------------*/
1024
1025 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1026 typedef void (*std_dev_clear_callback)(void *priv);
1027
1028 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
1029 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
1030 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1031 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1032 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1033 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1034 #ifdef HAVE_SERIAL_COMM
1035 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1036 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
1037 #endif
1038 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1039 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
1040 SR_PRIV int std_session_send_df_trigger(const struct sr_dev_inst *sdi);
1041 SR_PRIV int std_session_send_df_frame_begin(const struct sr_dev_inst *sdi);
1042 SR_PRIV int std_session_send_df_frame_end(const struct sr_dev_inst *sdi);
1043 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
1044                 std_dev_clear_callback clear_private);
1045 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
1046 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
1047 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1048 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1049
1050 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1051         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1052         const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1053         size_t drvsize, const uint32_t devopts[], size_t devsize);
1054
1055 extern SR_PRIV const uint32_t NO_OPTS[1];
1056
1057 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1058         std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1059                 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1060
1061 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1062 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1063 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1064 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1065 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1066 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1067 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1068
1069 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1070 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1071
1072 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1073 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1074 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1075 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1076
1077 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1078
1079 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1080 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1081 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1082
1083 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1084 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1085
1086 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1087 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1088 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1089
1090 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1091
1092 SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial,
1093         int baudrate, int bits, int parity, int stopbits,
1094         int flowcontrol, int rts, int dtr);
1095
1096 /*--- resource.c ------------------------------------------------------------*/
1097
1098 SR_PRIV int64_t sr_file_get_size(FILE *file);
1099
1100 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1101                 struct sr_resource *res, int type, const char *name)
1102                 G_GNUC_WARN_UNUSED_RESULT;
1103 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1104                 struct sr_resource *res);
1105 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1106                 const struct sr_resource *res, void *buf, size_t count)
1107                 G_GNUC_WARN_UNUSED_RESULT;
1108 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1109                 const char *name, size_t *size, size_t max_size)
1110                 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1111
1112 /*--- strutil.c -------------------------------------------------------------*/
1113
1114 SR_PRIV int sr_atol(const char *str, long *ret);
1115 SR_PRIV int sr_atoi(const char *str, int *ret);
1116 SR_PRIV int sr_atod(const char *str, double *ret);
1117 SR_PRIV int sr_atof(const char *str, float *ret);
1118 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1119 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1120
1121 SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
1122 SR_PRIV void sr_hexdump_free(GString *s);
1123
1124 /*--- soft-trigger.c --------------------------------------------------------*/
1125
1126 struct soft_trigger_logic {
1127         const struct sr_dev_inst *sdi;
1128         const struct sr_trigger *trigger;
1129         int count;
1130         int unitsize;
1131         int cur_stage;
1132         uint8_t *prev_sample;
1133         uint8_t *pre_trigger_buffer;
1134         uint8_t *pre_trigger_head;
1135         int pre_trigger_size;
1136         int pre_trigger_fill;
1137 };
1138
1139 SR_PRIV int logic_channel_unitsize(GSList *channels);
1140 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1141                 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1142                 int pre_trigger_samples);
1143 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1144 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1145                 int len, int *pre_trigger_samples);
1146
1147 /*--- serial.c --------------------------------------------------------------*/
1148
1149 #ifdef HAVE_SERIAL_COMM
1150 enum {
1151         SERIAL_RDWR = 1,
1152         SERIAL_RDONLY = 2,
1153 };
1154
1155 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1156
1157 typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
1158                 const char *desc);
1159 typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
1160
1161 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1162 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1163 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1164 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1165 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
1166 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1167                 const void *buf, size_t count, unsigned int timeout_ms);
1168 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1169                 const void *buf, size_t count);
1170 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1171                 size_t count, unsigned int timeout_ms);
1172 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1173                 size_t count);
1174 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
1175                 serial_rx_chunk_callback cb, void *cb_data);
1176 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1177                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1178 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1179                 const char *paramstr);
1180 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1181                 int *buflen, gint64 timeout_ms);
1182 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1183                                  uint8_t *buf, size_t *buflen,
1184                                  size_t packet_size,
1185                                  packet_valid_callback is_valid,
1186                                  uint64_t timeout_ms);
1187 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1188                                       const char **serial_options);
1189 SR_PRIV int serial_source_add(struct sr_session *session,
1190                 struct sr_serial_dev_inst *serial, int events, int timeout,
1191                 sr_receive_data_callback cb, void *cb_data);
1192 SR_PRIV int serial_source_remove(struct sr_session *session,
1193                 struct sr_serial_dev_inst *serial);
1194 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1195 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1196
1197 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
1198 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
1199 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
1200                 const uint8_t *data, size_t len);
1201 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
1202                 uint8_t *data, size_t len);
1203
1204 struct ser_lib_functions {
1205         int (*open)(struct sr_serial_dev_inst *serial, int flags);
1206         int (*close)(struct sr_serial_dev_inst *serial);
1207         int (*flush)(struct sr_serial_dev_inst *serial);
1208         int (*drain)(struct sr_serial_dev_inst *serial);
1209         int (*write)(struct sr_serial_dev_inst *serial,
1210                         const void *buf, size_t count,
1211                         int nonblocking, unsigned int timeout_ms);
1212         int (*read)(struct sr_serial_dev_inst *serial,
1213                         void *buf, size_t count,
1214                         int nonblocking, unsigned int timeout_ms);
1215         int (*set_params)(struct sr_serial_dev_inst *serial,
1216                         int baudrate, int bits, int parity, int stopbits,
1217                         int flowcontrol, int rts, int dtr);
1218         int (*setup_source_add)(struct sr_session *session,
1219                         struct sr_serial_dev_inst *serial,
1220                         int events, int timeout,
1221                         sr_receive_data_callback cb, void *cb_data);
1222         int (*setup_source_remove)(struct sr_session *session,
1223                         struct sr_serial_dev_inst *serial);
1224         GSList *(*list)(GSList *list, sr_ser_list_append_t append);
1225         GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
1226                         uint16_t vendor_id, uint16_t product_id);
1227         int (*get_frame_format)(struct sr_serial_dev_inst *serial,
1228                         int *baud, int *bits);
1229         size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
1230 };
1231 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
1232 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
1233 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
1234 SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
1235 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
1236
1237 #ifdef HAVE_LIBHIDAPI
1238 struct vid_pid_item {
1239         uint16_t vid, pid;
1240 };
1241
1242 struct ser_hid_chip_functions {
1243         const char *chipname;
1244         const char *chipdesc;
1245         const struct vid_pid_item *vid_pid_items;
1246         const int max_bytes_per_request;
1247         int (*set_params)(struct sr_serial_dev_inst *serial,
1248                         int baudrate, int bits, int parity, int stopbits,
1249                         int flowcontrol, int rts, int dtr);
1250         int (*read_bytes)(struct sr_serial_dev_inst *serial,
1251                         uint8_t *data, int space, unsigned int timeout);
1252         int (*write_bytes)(struct sr_serial_dev_inst *serial,
1253                         const uint8_t *data, int space);
1254         int (*flush)(struct sr_serial_dev_inst *serial);
1255         int (*drain)(struct sr_serial_dev_inst *serial);
1256 };
1257 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
1258 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
1259 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
1260 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor;
1261 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
1262 #endif
1263 #endif
1264
1265 /*--- bt/ API ---------------------------------------------------------------*/
1266
1267 #ifdef HAVE_BLUETOOTH
1268 SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
1269
1270 struct sr_bt_desc;
1271 typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
1272 typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
1273
1274 SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
1275 SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
1276
1277 SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
1278         sr_bt_scan_cb cb, void *cb_data);
1279 SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
1280         sr_bt_data_cb cb, void *cb_data);
1281 SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
1282 SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
1283 SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
1284 SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
1285         uint16_t read_handle, uint16_t write_handle,
1286         uint16_t cccd_handle, uint16_t cccd_value);
1287
1288 SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
1289 SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
1290
1291 SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
1292 SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
1293 SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
1294
1295 SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
1296         void *data, size_t len);
1297 SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
1298         const void *data, size_t len);
1299
1300 SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
1301 SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
1302 #endif
1303
1304 /*--- ezusb.c ---------------------------------------------------------------*/
1305
1306 #ifdef HAVE_LIBUSB_1_0
1307 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
1308 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
1309                                    const char *name);
1310 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
1311                                   int configuration, const char *name);
1312 #endif
1313
1314 /*--- usb.c -----------------------------------------------------------------*/
1315
1316 #ifdef HAVE_LIBUSB_1_0
1317 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
1318 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
1319 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
1320 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
1321                 int timeout, sr_receive_data_callback cb, void *cb_data);
1322 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
1323 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
1324 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
1325                 const char *manufacturer, const char *product);
1326 #endif
1327
1328
1329 /*--- modbus/modbus.c -------------------------------------------------------*/
1330
1331 struct sr_modbus_dev_inst {
1332         const char *name;
1333         const char *prefix;
1334         int priv_size;
1335         GSList *(*scan)(int modbusaddr);
1336         int (*dev_inst_new)(void *priv, const char *resource,
1337                 char **params, const char *serialcomm, int modbusaddr);
1338         int (*open)(void *priv);
1339         int (*source_add)(struct sr_session *session, void *priv, int events,
1340                 int timeout, sr_receive_data_callback cb, void *cb_data);
1341         int (*source_remove)(struct sr_session *session, void *priv);
1342         int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
1343         int (*read_begin)(void *priv, uint8_t *function_code);
1344         int (*read_data)(void *priv, uint8_t *buf, int maxlen);
1345         int (*read_end)(void *priv);
1346         int (*close)(void *priv);
1347         void (*free)(void *priv);
1348         unsigned int read_timeout_ms;
1349         void *priv;
1350 };
1351
1352 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
1353                 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
1354 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
1355                 const char *serialcomm, int modbusaddr);
1356 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
1357 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
1358                 struct sr_modbus_dev_inst *modbus, int events, int timeout,
1359                 sr_receive_data_callback cb, void *cb_data);
1360 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
1361                 struct sr_modbus_dev_inst *modbus);
1362 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1363                               uint8_t *request, int request_size);
1364 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1365                             uint8_t *reply, int reply_size);
1366 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1367                                     uint8_t *request, int request_size,
1368                                     uint8_t *reply, int reply_size);
1369 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1370                                  int address, int nb_coils, uint8_t *coils);
1371 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1372                                              int address, int nb_registers,
1373                                              uint16_t *registers);
1374 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1375                                  int address, int value);
1376 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1377                                                int address, int nb_registers,
1378                                                uint16_t *registers);
1379 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1380 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1381
1382 /*--- dmm/es519xx.c ---------------------------------------------------------*/
1383
1384 /**
1385  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1386  * so always read 2 blocks at a time.
1387  */
1388 #define ES519XX_11B_PACKET_SIZE (11 * 2)
1389 #define ES519XX_14B_PACKET_SIZE 14
1390
1391 struct es519xx_info {
1392         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1393         gboolean is_milli, is_resistance, is_continuity, is_diode;
1394         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1395         gboolean is_temperature, is_celsius, is_fahrenheit;
1396         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1397         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1398         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1399         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1400         uint32_t baudrate;
1401         int packet_size;
1402         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1403         int digits;
1404 };
1405
1406 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1407 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1408                 struct sr_datafeed_analog *analog, void *info);
1409 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1410 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1411                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1412 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1413 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1414                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1415 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1416 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1417                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1418 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1419 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1420                 struct sr_datafeed_analog *analog, void *info);
1421 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1422 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1423                 struct sr_datafeed_analog *analog, void *info);
1424 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1425 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1426                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1427
1428 /*--- dmm/fs9922.c ----------------------------------------------------------*/
1429
1430 #define FS9922_PACKET_SIZE 14
1431
1432 struct fs9922_info {
1433         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1434         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1435         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1436         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1437         gboolean is_celsius, is_fahrenheit;
1438         int bargraph_sign, bargraph_value;
1439 };
1440
1441 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1442 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1443                             struct sr_datafeed_analog *analog, void *info);
1444 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
1445
1446 /*--- dmm/fs9721.c ----------------------------------------------------------*/
1447
1448 #define FS9721_PACKET_SIZE 14
1449
1450 struct fs9721_info {
1451         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1452         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1453         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1454         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1455 };
1456
1457 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1458 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1459                             struct sr_datafeed_analog *analog, void *info);
1460 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1461 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1462 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1463 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1464 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1465
1466 /*--- dmm/ms2115b.c ---------------------------------------------------------*/
1467
1468 #define MS2115B_PACKET_SIZE 9
1469
1470 enum ms2115b_display {
1471         MS2115B_DISPLAY_MAIN,
1472         MS2115B_DISPLAY_SUB,
1473         MS2115B_DISPLAY_COUNT,
1474 };
1475
1476 struct ms2115b_info {
1477         /* Selected channel. */
1478         size_t ch_idx;
1479         gboolean is_ac, is_dc, is_auto;
1480         gboolean is_diode, is_beep, is_farad;
1481         gboolean is_ohm, is_ampere, is_volt, is_hz;
1482         gboolean is_duty_cycle, is_percent;
1483 };
1484
1485 extern SR_PRIV const char *ms2115b_channel_formats[];
1486 SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
1487 SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
1488         struct sr_datafeed_analog *analog, void *info);
1489
1490 /*--- dmm/ms8250d.c ---------------------------------------------------------*/
1491
1492 #define MS8250D_PACKET_SIZE 18
1493
1494 struct ms8250d_info {
1495         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1496         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1497         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1498         gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
1499 };
1500
1501 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
1502 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
1503                              struct sr_datafeed_analog *analog, void *info);
1504
1505 /*--- dmm/dtm0660.c ---------------------------------------------------------*/
1506
1507 #define DTM0660_PACKET_SIZE 15
1508
1509 struct dtm0660_info {
1510         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1511         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1512         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1513         gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1514         gboolean is_minmax, is_max, is_sign;
1515 };
1516
1517 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1518 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
1519                         struct sr_datafeed_analog *analog, void *info);
1520
1521 /*--- dmm/m2110.c -----------------------------------------------------------*/
1522
1523 #define BBCGM_M2110_PACKET_SIZE 9
1524
1525 /* Dummy info struct. The parser does not use it. */
1526 struct m2110_info { int dummy; };
1527
1528 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1529 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1530                              struct sr_datafeed_analog *analog, void *info);
1531
1532 /*--- dmm/metex14.c ---------------------------------------------------------*/
1533
1534 #define METEX14_PACKET_SIZE 14
1535
1536 struct metex14_info {
1537         size_t ch_idx;
1538         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1539         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1540         gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
1541         gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1542         gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
1543         gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
1544 };
1545
1546 #ifdef HAVE_SERIAL_COMM
1547 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1548 #endif
1549 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1550 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1551                              struct sr_datafeed_analog *analog, void *info);
1552 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
1553 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
1554                              struct sr_datafeed_analog *analog, void *info);
1555
1556 /*--- dmm/rs9lcd.c ----------------------------------------------------------*/
1557
1558 #define RS9LCD_PACKET_SIZE 9
1559
1560 /* Dummy info struct. The parser does not use it. */
1561 struct rs9lcd_info { int dummy; };
1562
1563 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1564 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1565                             struct sr_datafeed_analog *analog, void *info);
1566
1567 /*--- dmm/bm25x.c -----------------------------------------------------------*/
1568
1569 #define BRYMEN_BM25X_PACKET_SIZE 15
1570
1571 /* Dummy info struct. The parser does not use it. */
1572 struct bm25x_info { int dummy; };
1573
1574 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1575 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1576                              struct sr_datafeed_analog *analog, void *info);
1577
1578 /*--- dmm/bm86x.c -----------------------------------------------------------*/
1579
1580 #define BRYMEN_BM86X_PACKET_SIZE 24
1581 #define BRYMEN_BM86X_DISPLAY_COUNT 2
1582
1583 struct brymen_bm86x_info { size_t ch_idx; };
1584
1585 #ifdef HAVE_SERIAL_COMM
1586 SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial);
1587 #endif
1588 SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf);
1589 SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval,
1590                 struct sr_datafeed_analog *analog, void *info);
1591
1592 /*--- dmm/ut71x.c -----------------------------------------------------------*/
1593
1594 #define UT71X_PACKET_SIZE 11
1595
1596 struct ut71x_info {
1597         gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1598         gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1599         gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1600         gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1601 };
1602
1603 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1604 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1605                 struct sr_datafeed_analog *analog, void *info);
1606
1607 /*--- dmm/vc870.c -----------------------------------------------------------*/
1608
1609 #define VC870_PACKET_SIZE 23
1610
1611 struct vc870_info {
1612         gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1613         gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1614         gboolean is_current, is_micro, is_milli, is_power;
1615         gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
1616         gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1617         gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1618         gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1619         gboolean is_lo, is_hi, is_open2;
1620
1621         gboolean is_frequency, is_dual_display, is_auto;
1622 };
1623
1624 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1625 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1626                 struct sr_datafeed_analog *analog, void *info);
1627
1628 /*--- dmm/vc96.c ------------------------------------------------------------*/
1629
1630 #define VC96_PACKET_SIZE 13
1631
1632 struct vc96_info {
1633         size_t ch_idx;
1634         gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
1635         gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
1636         gboolean is_unitless;
1637 };
1638
1639 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
1640 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
1641                 struct sr_datafeed_analog *analog, void *info);
1642
1643 /*--- lcr/es51919.c ---------------------------------------------------------*/
1644
1645 /* Acquisition details which apply to all supported serial-lcr devices. */
1646 struct lcr_parse_info {
1647         size_t ch_idx;
1648         uint64_t output_freq;
1649         const char *circuit_model;
1650 };
1651
1652 #define ES51919_PACKET_SIZE     17
1653 #define ES51919_CHANNEL_COUNT   2
1654 #define ES51919_COMM_PARAM      "9600/8n1/rts=1/dtr=1"
1655
1656 SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
1657         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1658 SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
1659         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1660 SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
1661         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1662 SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
1663 SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
1664         struct sr_datafeed_analog *analog, void *info);
1665
1666 /*--- lcr/vc4080.c ----------------------------------------------------------*/
1667
1668 /* Note: Also uses 'struct lcr_parse_info' from es51919 above. */
1669
1670 #define VC4080_PACKET_SIZE      39
1671 #define VC4080_COMM_PARAM       "1200/8n1"
1672 #define VC4080_WITH_DQ_CHANS    0 /* Enable separate D/Q channels? */
1673
1674 enum vc4080_display {
1675         VC4080_DISPLAY_PRIMARY,
1676         VC4080_DISPLAY_SECONDARY,
1677 #if VC4080_WITH_DQ_CHANS
1678         VC4080_DISPLAY_D_VALUE,
1679         VC4080_DISPLAY_Q_VALUE,
1680 #endif
1681         VC4080_CHANNEL_COUNT,
1682 };
1683
1684 extern SR_PRIV const char *vc4080_channel_formats[VC4080_CHANNEL_COUNT];
1685
1686 SR_PRIV int vc4080_config_list(uint32_t key, GVariant **data,
1687         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
1688 SR_PRIV int vc4080_packet_request(struct sr_serial_dev_inst *serial);
1689 SR_PRIV gboolean vc4080_packet_valid(const uint8_t *pkt);
1690 SR_PRIV int vc4080_packet_parse(const uint8_t *pkt, float *floatval,
1691         struct sr_datafeed_analog *analog, void *info);
1692
1693 /*--- dmm/ut372.c -----------------------------------------------------------*/
1694
1695 #define UT372_PACKET_SIZE 27
1696
1697 struct ut372_info {
1698         int dummy;
1699 };
1700
1701 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1702 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1703                 struct sr_datafeed_analog *analog, void *info);
1704
1705 /*--- dmm/asycii.c ----------------------------------------------------------*/
1706
1707 #define ASYCII_PACKET_SIZE 16
1708
1709 struct asycii_info {
1710         gboolean is_ac, is_dc, is_ac_and_dc;
1711         gboolean is_resistance, is_capacitance, is_diode, is_gain;
1712         gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
1713         gboolean is_pulse_width, is_period_pos, is_period_neg;
1714         gboolean is_pulse_count, is_count_pos, is_count_neg;
1715         gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
1716         gboolean is_hertz, is_percent, is_seconds, is_decibel;
1717         gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1718         gboolean is_unitless;
1719         gboolean is_peak_min, is_peak_max;
1720         gboolean is_invalid;
1721 };
1722
1723 #ifdef HAVE_SERIAL_COMM
1724 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
1725 #endif
1726 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
1727 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
1728                             struct sr_datafeed_analog *analog, void *info);
1729
1730 /*--- dmm/eev121gw.c --------------------------------------------------------*/
1731
1732 #define EEV121GW_PACKET_SIZE 19
1733
1734 enum eev121gw_display {
1735         EEV121GW_DISPLAY_MAIN,
1736         EEV121GW_DISPLAY_SUB,
1737         EEV121GW_DISPLAY_BAR,
1738         EEV121GW_DISPLAY_COUNT,
1739 };
1740
1741 struct eev121gw_info {
1742         /* Selected channel. */
1743         size_t ch_idx;
1744         /*
1745          * Measured value, number and sign/overflow flags, scale factor
1746          * and significant digits.
1747          */
1748         uint32_t uint_value;
1749         gboolean is_ofl, is_neg;
1750         int factor, digits;
1751         /* Currently active mode (meter's function). */
1752         gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
1753         gboolean is_resistance, is_capacitance, is_diode, is_temperature;
1754         gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
1755         /* Quantities associated with mode/function. */
1756         gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
1757         gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
1758         gboolean is_hertz, is_seconds, is_percent, is_loop_current;
1759         gboolean is_unitless, is_logic;
1760         /* Other indicators. */
1761         gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
1762         gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
1763         gboolean is_auto_poweroff, is_low_batt;
1764 };
1765
1766 extern SR_PRIV const char *eev121gw_channel_formats[];
1767 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
1768 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
1769                 struct sr_datafeed_analog *analog, void *info);
1770
1771 /*--- scale/kern.c ----------------------------------------------------------*/
1772
1773 struct kern_info {
1774         gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1775         gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1776         gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1777         int buflen;
1778 };
1779
1780 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1781 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1782                 struct sr_datafeed_analog *analog, void *info);
1783
1784 /*--- sw_limits.c -----------------------------------------------------------*/
1785
1786 struct sr_sw_limits {
1787         uint64_t limit_samples;
1788         uint64_t limit_frames;
1789         uint64_t limit_msec;
1790         uint64_t samples_read;
1791         uint64_t frames_read;
1792         uint64_t start_time;
1793 };
1794
1795 SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key,
1796         GVariant **data);
1797 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
1798         GVariant *data);
1799 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
1800 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
1801 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
1802         uint64_t samples_read);
1803 SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
1804         uint64_t frames_read);
1805 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
1806
1807 #endif