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