src/libsigrok-internal.h

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