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