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