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          *
 430          * @retval SR_OK This module knows the format.
 431          * @retval SR_ERR_NA There wasn't enough data for this module to
 432          *   positively identify the format.
 433          * @retval SR_ERR_DATA This module knows the format, but cannot handle
 434          *   it. This means the stream is either corrupt, or indicates a
 435          *   feature that the module does not support.
 436          * @retval SR_ERR This module does not know the format.
 437          */
 438         int (*format_match) (GHashTable *metadata);
 439
 440         /**
 441          * Initialize the input module.
 442          *
 443          * @retval SR_OK Success
 444          * @retval other Negative error code.
 445          */
 446         int (*init) (struct sr_input *in, GHashTable *options);
 447
 448         /**
 449          * Send data to the specified input instance.
 450          *
 451          * When an input module instance is created with sr_input_new(), this
 452          * function is used to feed data to the instance.
 453          *
 454          * As enough data gets fed into this function to completely populate
 455          * the device instance associated with this input instance, this is
 456          * guaranteed to return the moment it's ready. This gives the caller
 457          * the chance to examine the device instance, attach session callbacks
 458          * and so on.
 459          *
 460          * @retval SR_OK Success
 461          * @retval other Negative error code.
 462          */
 463         int (*receive) (struct sr_input *in, GString *buf);
 464
 465         /**
 466          * Signal the input module no more data will come.
 467          *
 468          * This will cause the module to process any data it may have buffered.
 469          * The SR_DF_END packet will also typically be sent at this time.
 470          */
 471         int (*end) (struct sr_input *in);
 472
 473         /**
 474          * Reset the input module's input handling structures.
 475          *
 476          * Causes the input module to reset its internal state so that we can
 477          * re-send the input data from the beginning without having to
 478          * re-create the entire input module.
 479          *
 480          * @retval SR_OK Success.
 481          * @retval other Negative error code.
 482          */
 483         int (*reset) (struct sr_input *in);
 484
 485         /**
 486          * This function is called after the caller is finished using
 487          * the input module, and can be used to free any internal
 488          * resources the module may keep.
 489          *
 490          * This function is optional.
 491          *
 492          * @retval SR_OK Success
 493          * @retval other Negative error code.
 494          */
 495         void (*cleanup) (struct sr_input *in);
 496 };
 497
 498 /** Output module instance. */
 499 struct sr_output {
 500         /** A pointer to this output's module. */
 501         const struct sr_output_module *module;
 502
 503         /**
 504          * The device for which this output module is creating output. This
 505          * can be used by the module to find out channel names and numbers.
 506          */
 507         const struct sr_dev_inst *sdi;
 508
 509         /**
 510          * The name of the file that the data should be written to.
 511          */
 512         const char *filename;
 513
 514         /**
 515          * A generic pointer which can be used by the module to keep internal
 516          * state between calls into its callback functions.
 517          *
 518          * For example, the module might store a pointer to a chunk of output
 519          * there, and only flush it when it reaches a certain size.
 520          */
 521         void *priv;
 522 };
 523
 524 /** Output module driver. */
 525 struct sr_output_module {
 526         /**
 527          * A unique ID for this output module, suitable for use in command-line
 528          * clients, [a-z0-9-]. Must not be NULL.
 529          */
 530         const char *id;
 531
 532         /**
 533          * A unique name for this output module, suitable for use in GUI
 534          * clients, can contain UTF-8. Must not be NULL.
 535          */
 536         const char *name;
 537
 538         /**
 539          * A short description of the output module. Must not be NULL.
 540          *
 541          * This can be displayed by frontends, e.g. when selecting the output
 542          * module for saving a file.
 543          */
 544         const char *desc;
 545
 546         /**
 547          * A NULL terminated array of strings containing a list of file name
 548          * extensions typical for the input file format, or NULL if there is
 549          * no typical extension for this file format.
 550          */
 551         const char *const *exts;
 552
 553         /**
 554          * Bitfield containing flags that describe certain properties
 555          * this output module may or may not have.
 556          * @see sr_output_flags
 557          */
 558         const uint64_t flags;
 559
 560         /**
 561          * Returns a NULL-terminated list of options this module can take.
 562          * Can be NULL, if the module has no options.
 563          */
 564         const struct sr_option *(*options) (void);
 565
 566         /**
 567          * This function is called once, at the beginning of an output stream.
 568          *
 569          * The device struct will be available in the output struct passed in,
 570          * as well as the param field -- which may be NULL or an empty string,
 571          * if no parameter was passed.
 572          *
 573          * The module can use this to initialize itself, create a struct for
 574          * keeping state and storing it in the <code>internal</code> field.
 575          *
 576          * @param o Pointer to the respective 'struct sr_output'.
 577          *
 578          * @retval SR_OK Success
 579          * @retval other Negative error code.
 580          */
 581         int (*init) (struct sr_output *o, GHashTable *options);
 582
 583         /**
 584          * This function is passed a copy of every packet in the data feed.
 585          * Any output generated by the output module in response to the
 586          * packet should be returned in a newly allocated GString
 587          * <code>out</code>, which will be freed by the caller.
 588          *
 589          * Packets not of interest to the output module can just be ignored,
 590          * and the <code>out</code> parameter set to NULL.
 591          *
 592          * @param o Pointer to the respective 'struct sr_output'.
 593          * @param sdi The device instance that generated the packet.
 594          * @param packet The complete packet.
 595          * @param out A pointer where a GString * should be stored if
 596          * the module generates output, or NULL if not.
 597          *
 598          * @retval SR_OK Success
 599          * @retval other Negative error code.
 600          */
 601         int (*receive) (const struct sr_output *o,
 602                         const struct sr_datafeed_packet *packet, GString **out);
 603
 604         /**
 605          * This function is called after the caller is finished using
 606          * the output module, and can be used to free any internal
 607          * resources the module may keep.
 608          *
 609          * @retval SR_OK Success
 610          * @retval other Negative error code.
 611          */
 612         int (*cleanup) (struct sr_output *o);
 613 };
 614
 615 /** Transform module instance. */
 616 struct sr_transform {
 617         /** A pointer to this transform's module. */
 618         const struct sr_transform_module *module;
 619
 620         /**
 621          * The device for which this transform module is used. This
 622          * can be used by the module to find out channel names and numbers.
 623          */
 624         const struct sr_dev_inst *sdi;
 625
 626         /**
 627          * A generic pointer which can be used by the module to keep internal
 628          * state between calls into its callback functions.
 629          */
 630         void *priv;
 631 };
 632
 633 struct sr_transform_module {
 634         /**
 635          * A unique ID for this transform module, suitable for use in
 636          * command-line clients, [a-z0-9-]. Must not be NULL.
 637          */
 638         const char *id;
 639
 640         /**
 641          * A unique name for this transform module, suitable for use in GUI
 642          * clients, can contain UTF-8. Must not be NULL.
 643          */
 644         const char *name;
 645
 646         /**
 647          * A short description of the transform module. Must not be NULL.
 648          *
 649          * This can be displayed by frontends, e.g. when selecting
 650          * which transform module(s) to add.
 651          */
 652         const char *desc;
 653
 654         /**
 655          * Returns a NULL-terminated list of options this transform module
 656          * can take. Can be NULL, if the transform module has no options.
 657          */
 658         const struct sr_option *(*options) (void);
 659
 660         /**
 661          * This function is called once, at the beginning of a stream.
 662          *
 663          * @param t Pointer to the respective 'struct sr_transform'.
 664          * @param options Hash table of options for this transform module.
 665          *                Can be NULL if no options are to be used.
 666          *
 667          * @retval SR_OK Success
 668          * @retval other Negative error code.
 669          */
 670         int (*init) (struct sr_transform *t, GHashTable *options);
 671
 672         /**
 673          * This function is passed a pointer to every packet in the data feed.
 674          *
 675          * It can either return (in packet_out) a pointer to another packet
 676          * (possibly the exact same packet it got as input), or NULL.
 677          *
 678          * @param t Pointer to the respective 'struct sr_transform'.
 679          * @param packet_in Pointer to a datafeed packet.
 680          * @param packet_out Pointer to the resulting datafeed packet after
 681          *                   this function was run. If NULL, the transform
 682          *                   module intentionally didn't output a new packet.
 683          *
 684          * @retval SR_OK Success
 685          * @retval other Negative error code.
 686          */
 687         int (*receive) (const struct sr_transform *t,
 688                         struct sr_datafeed_packet *packet_in,
 689                         struct sr_datafeed_packet **packet_out);
 690
 691         /**
 692          * This function is called after the caller is finished using
 693          * the transform module, and can be used to free any internal
 694          * resources the module may keep.
 695          *
 696          * @retval SR_OK Success
 697          * @retval other Negative error code.
 698          */
 699         int (*cleanup) (struct sr_transform *t);
 700 };
 701
 702 #ifdef HAVE_LIBUSB_1_0
 703 /** USB device instance */
 704 struct sr_usb_dev_inst {
 705         /** USB bus */
 706         uint8_t bus;
 707         /** Device address on USB bus */
 708         uint8_t address;
 709         /** libusb device handle */
 710         struct libusb_device_handle *devhdl;
 711 };
 712 #endif
 713
 714 #ifdef HAVE_LIBSERIALPORT
 715 struct sr_serial_dev_inst {
 716         /** Port name, e.g. '/dev/tty42'. */
 717         char *port;
 718         /** Comm params for serial_set_paramstr(). */
 719         char *serialcomm;
 720         /** libserialport port handle */
 721         struct sp_port *data;
 722 };
 723 #endif
 724
 725 struct sr_usbtmc_dev_inst {
 726         char *device;
 727         int fd;
 728 };
 729
 730 /* Private driver context. */
 731 struct drv_context {
 732         /** sigrok context */
 733         struct sr_context *sr_ctx;
 734         GSList *instances;
 735 };
 736
 737 /*--- log.c -----------------------------------------------------------------*/
 738
 739 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
 740 /*
 741  * On MinGW, we need to specify the gnu_printf format flavor or GCC
 742  * will assume non-standard Microsoft printf syntax.
 743  */
 744 SR_PRIV int sr_log(int loglevel, const char *format, ...)
 745                 __attribute__((__format__ (__gnu_printf__, 2, 3)));
 746 #else
 747 SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
 748 #endif
 749
 750 /* Message logging helpers with subsystem-specific prefix string. */
 751 #define sr_spew(...)    sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
 752 #define sr_dbg(...)     sr_log(SR_LOG_DBG,  LOG_PREFIX ": " __VA_ARGS__)
 753 #define sr_info(...)    sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
 754 #define sr_warn(...)    sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
 755 #define sr_err(...)     sr_log(SR_LOG_ERR,  LOG_PREFIX ": " __VA_ARGS__)
 756
 757 /*--- device.c --------------------------------------------------------------*/
 758
 759 /** Scan options supported by a driver. */
 760 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
 761
 762 /** Device options for a particular device. */
 763 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
 764
 765 /** Mask for separating config keys from capabilities. */
 766 #define SR_CONF_MASK 0x1fffffff
 767
 768 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
 769 enum {
 770         /** The enabled state of the channel has been changed. */
 771         SR_CHANNEL_SET_ENABLED = 1 << 0,
 772 };
 773
 774 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
 775                 int index, int type, gboolean enabled, const char *name);
 776 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
 777                 struct sr_channel *cur_channel);
 778
 779 /** Device instance data */
 780 struct sr_dev_inst {
 781         /** Device driver. */
 782         struct sr_dev_driver *driver;
 783         /** Device instance status. SR_ST_NOT_FOUND, etc. */
 784         int status;
 785         /** Device instance type. SR_INST_USB, etc. */
 786         int inst_type;
 787         /** Device vendor. */
 788         char *vendor;
 789         /** Device model. */
 790         char *model;
 791         /** Device version. */
 792         char *version;
 793         /** Serial number. */
 794         char *serial_num;
 795         /** Connection string to uniquely identify devices. */
 796         char *connection_id;
 797         /** List of channels. */
 798         GSList *channels;
 799         /** List of sr_channel_group structs */
 800         GSList *channel_groups;
 801         /** Device instance connection data (used?) */
 802         void *conn;
 803         /** Device instance private data (used?) */
 804         void *priv;
 805         /** Session to which this device is currently assigned. */
 806         struct sr_session *session;
 807 };
 808
 809 /* Generic device instances */
 810 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 811
 812 #ifdef HAVE_LIBUSB_1_0
 813 /* USB-specific instances */
 814 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 815                 uint8_t address, struct libusb_device_handle *hdl);
 816 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 817 #endif
 818
 819 #ifdef HAVE_LIBSERIALPORT
 820 /* Serial-specific instances */
 821 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 822                 const char *serialcomm);
 823 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 824 #endif
 825
 826 /* USBTMC-specific instances */
 827 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
 828 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
 829
 830 /*--- hwdriver.c ------------------------------------------------------------*/
 831
 832 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
 833 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
 834 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
 835 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
 836 SR_PRIV void sr_config_free(struct sr_config *src);
 837 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
 838 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
 839
 840 /*--- session.c -------------------------------------------------------------*/
 841
 842 struct sr_session {
 843         /** Context this session exists in. */
 844         struct sr_context *ctx;
 845         /** List of struct sr_dev_inst pointers. */
 846         GSList *devs;
 847         /** List of struct sr_dev_inst pointers owned by this session. */
 848         GSList *owned_devs;
 849         /** List of struct datafeed_callback pointers. */
 850         GSList *datafeed_callbacks;
 851         GSList *transforms;
 852         struct sr_trigger *trigger;
 853
 854         /** Callback to invoke on session stop. */
 855         sr_session_stopped_callback stopped_callback;
 856         /** User data to be passed to the session stop callback. */
 857         void *stopped_cb_data;
 858
 859         /** Mutex protecting the main context pointer. */
 860         GMutex main_mutex;
 861         /** Context of the session main loop. */
 862         GMainContext *main_context;
 863
 864         /** Registered event sources for this session. */
 865         GHashTable *event_sources;
 866         /** Session main loop. */
 867         GMainLoop *main_loop;
 868         /** ID of idle source for dispatching the session stop notification. */
 869         unsigned int stop_check_id;
 870         /** Whether the session has been started. */
 871         gboolean running;
 872 };
 873
 874 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
 875                 void *key, GSource *source);
 876 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
 877                 void *key);
 878 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
 879                 void *key, GSource *source);
 880 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
 881                 void *key, gintptr fd, int events, int timeout,
 882                 sr_receive_data_callback cb, void *cb_data);
 883
 884 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
 885                 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
 886 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
 887                 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
 888                 void *cb_data);
 889 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
 890                 GIOChannel *channel, int events, int timeout,
 891                 sr_receive_data_callback cb, void *cb_data);
 892 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
 893 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
 894                 GPollFD *pollfd);
 895 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
 896                 GIOChannel *channel);
 897
 898 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 899                 const struct sr_datafeed_packet *packet);
 900 SR_PRIV int sr_sessionfile_check(const char *filename);
 901 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
 902                 struct sr_session **session);
 903 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
 904                 struct sr_datafeed_packet **copy);
 905 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
 906
 907 /*--- session_file.c --------------------------------------------------------*/
 908
 909 #if !HAVE_ZIP_DISCARD
 910 /* Replace zip_discard() if not available. */
 911 #define zip_discard(zip) sr_zip_discard(zip)
 912 SR_PRIV void sr_zip_discard(struct zip *archive);
 913 #endif
 914
 915 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
 916                         const struct zip_stat *entry);
 917
 918 /*--- analog.c --------------------------------------------------------------*/
 919
 920 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
 921                            struct sr_analog_encoding *encoding,
 922                            struct sr_analog_meaning *meaning,
 923                            struct sr_analog_spec *spec,
 924                            int digits);
 925
 926 /*--- std.c -----------------------------------------------------------------*/
 927
 928 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
 929 typedef void (*std_dev_clear_callback)(void *priv);
 930
 931 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
 932 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
 933 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
 934 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
 935 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
 936 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
 937 #ifdef HAVE_LIBSERIALPORT
 938 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
 939 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
 940 #endif
 941 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
 942 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
 943 SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi);
 944 SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi);
 945 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
 946                 std_dev_clear_callback clear_private);
 947 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
 948 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
 949 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
 950 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
 951
 952 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
 953         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
 954         const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
 955         size_t drvsize, const uint32_t devopts[], size_t devsize);
 956
 957 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
 958         std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
 959                 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
 960
 961 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
 962 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
 963 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
 964 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
 965 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
 966 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
 967 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
 968
 969 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
 970 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
 971
 972 SR_PRIV GVariant *std_gvar_array_i32(const int32_t *a, unsigned int n);
 973 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t *a, unsigned int n);
 974 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t *a, unsigned int n);
 975
 976 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
 977
 978 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
 979 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
 980 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
 981
 982 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
 983 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
 984
 985 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
 986 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
 987 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
 988
 989 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
 990
 991 /*--- resource.c ------------------------------------------------------------*/
 992
 993 SR_PRIV int64_t sr_file_get_size(FILE *file);
 994
 995 SR_PRIV int sr_resource_open(struct sr_context *ctx,
 996                 struct sr_resource *res, int type, const char *name)
 997                 G_GNUC_WARN_UNUSED_RESULT;
 998 SR_PRIV int sr_resource_close(struct sr_context *ctx,
 999                 struct sr_resource *res);
1000 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1001                 const struct sr_resource *res, void *buf, size_t count)
1002                 G_GNUC_WARN_UNUSED_RESULT;
1003 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1004                 const char *name, size_t *size, size_t max_size)
1005                 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1006
1007 /*--- strutil.c -------------------------------------------------------------*/
1008
1009 SR_PRIV int sr_atol(const char *str, long *ret);
1010 SR_PRIV int sr_atoi(const char *str, int *ret);
1011 SR_PRIV int sr_atod(const char *str, double *ret);
1012 SR_PRIV int sr_atof(const char *str, float *ret);
1013 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
1014 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
1015
1016 /*--- soft-trigger.c --------------------------------------------------------*/
1017
1018 struct soft_trigger_logic {
1019         const struct sr_dev_inst *sdi;
1020         const struct sr_trigger *trigger;
1021         int count;
1022         int unitsize;
1023         int cur_stage;
1024         uint8_t *prev_sample;
1025         uint8_t *pre_trigger_buffer;
1026         uint8_t *pre_trigger_head;
1027         int pre_trigger_size;
1028         int pre_trigger_fill;
1029 };
1030
1031 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
1032                 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
1033                 int pre_trigger_samples);
1034 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
1035 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
1036                 int len, int *pre_trigger_samples);
1037
1038 /*--- hardware/serial.c -----------------------------------------------------*/
1039
1040 #ifdef HAVE_LIBSERIALPORT
1041 enum {
1042         SERIAL_RDWR = 1,
1043         SERIAL_RDONLY = 2,
1044 };
1045
1046 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
1047
1048 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
1049 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
1050 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
1051 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
1052 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
1053                 const void *buf, size_t count, unsigned int timeout_ms);
1054 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
1055                 const void *buf, size_t count);
1056 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
1057                 size_t count, unsigned int timeout_ms);
1058 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
1059                 size_t count);
1060 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
1061                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
1062 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
1063                 const char *paramstr);
1064 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
1065                 int *buflen, gint64 timeout_ms);
1066 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
1067                                  uint8_t *buf, size_t *buflen,
1068                                  size_t packet_size,
1069                                  packet_valid_callback is_valid,
1070                                  uint64_t timeout_ms, int baudrate);
1071 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
1072                                       const char **serial_options);
1073 SR_PRIV int serial_source_add(struct sr_session *session,
1074                 struct sr_serial_dev_inst *serial, int events, int timeout,
1075                 sr_receive_data_callback cb, void *cb_data);
1076 SR_PRIV int serial_source_remove(struct sr_session *session,
1077                 struct sr_serial_dev_inst *serial);
1078 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
1079 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
1080 #endif
1081
1082 /*--- hardware/ezusb.c ------------------------------------------------------*/
1083
1084 #ifdef HAVE_LIBUSB_1_0
1085 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
1086 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
1087                                    const char *name);
1088 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
1089                                   int configuration, const char *name);
1090 #endif
1091
1092 /*--- hardware/usb.c --------------------------------------------------------*/
1093
1094 #ifdef HAVE_LIBUSB_1_0
1095 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
1096 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
1097 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
1098 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
1099                 int timeout, sr_receive_data_callback cb, void *cb_data);
1100 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
1101 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
1102 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
1103                 const char *manufacturer, const char *product);
1104 #endif
1105
1106
1107 /*--- modbus/modbus.c -------------------------------------------------------*/
1108
1109 struct sr_modbus_dev_inst {
1110         const char *name;
1111         const char *prefix;
1112         int priv_size;
1113         GSList *(*scan)(int modbusaddr);
1114         int (*dev_inst_new)(void *priv, const char *resource,
1115                 char **params, const char *serialcomm, int modbusaddr);
1116         int (*open)(void *priv);
1117         int (*source_add)(struct sr_session *session, void *priv, int events,
1118                 int timeout, sr_receive_data_callback cb, void *cb_data);
1119         int (*source_remove)(struct sr_session *session, void *priv);
1120         int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
1121         int (*read_begin)(void *priv, uint8_t *function_code);
1122         int (*read_data)(void *priv, uint8_t *buf, int maxlen);
1123         int (*read_end)(void *priv);
1124         int (*close)(void *priv);
1125         void (*free)(void *priv);
1126         unsigned int read_timeout_ms;
1127         void *priv;
1128 };
1129
1130 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
1131                 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
1132 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
1133                 const char *serialcomm, int modbusaddr);
1134 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
1135 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
1136                 struct sr_modbus_dev_inst *modbus, int events, int timeout,
1137                 sr_receive_data_callback cb, void *cb_data);
1138 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
1139                 struct sr_modbus_dev_inst *modbus);
1140 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
1141                               uint8_t *request, int request_size);
1142 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
1143                             uint8_t *reply, int reply_size);
1144 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
1145                                     uint8_t *request, int request_size,
1146                                     uint8_t *reply, int reply_size);
1147 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
1148                                  int address, int nb_coils, uint8_t *coils);
1149 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
1150                                              int address, int nb_registers,
1151                                              uint16_t *registers);
1152 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
1153                                  int address, int value);
1154 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
1155                                                int address, int nb_registers,
1156                                                uint16_t *registers);
1157 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
1158 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
1159
1160 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
1161
1162 /**
1163  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
1164  * so always read 2 blocks at a time.
1165  */
1166 #define ES519XX_11B_PACKET_SIZE (11 * 2)
1167 #define ES519XX_14B_PACKET_SIZE 14
1168
1169 struct es519xx_info {
1170         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
1171         gboolean is_milli, is_resistance, is_continuity, is_diode;
1172         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
1173         gboolean is_temperature, is_celsius, is_fahrenheit;
1174         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
1175         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
1176         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
1177         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
1178         uint32_t baudrate;
1179         int packet_size;
1180         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
1181         int digits;
1182 };
1183
1184 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
1185 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
1186                 struct sr_datafeed_analog *analog, void *info);
1187 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
1188 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
1189                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1190 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
1191 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
1192                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1193 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
1194 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
1195                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1196 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
1197 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
1198                 struct sr_datafeed_analog *analog, void *info);
1199 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
1200 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
1201                 struct sr_datafeed_analog *analog, void *info);
1202 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
1203 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
1204                 float *floatval, struct sr_datafeed_analog *analog, void *info);
1205
1206 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
1207
1208 #define FS9922_PACKET_SIZE 14
1209
1210 struct fs9922_info {
1211         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
1212         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
1213         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
1214         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
1215         gboolean is_celsius, is_fahrenheit;
1216         int bargraph_sign, bargraph_value;
1217 };
1218
1219 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
1220 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
1221                             struct sr_datafeed_analog *analog, void *info);
1222 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
1223
1224 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
1225
1226 #define FS9721_PACKET_SIZE 14
1227
1228 struct fs9721_info {
1229         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1230         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1231         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1232         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
1233 };
1234
1235 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
1236 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
1237                             struct sr_datafeed_analog *analog, void *info);
1238 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
1239 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
1240 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
1241 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
1242 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
1243
1244 /*--- hardware/dmm/dtm0660.c ------------------------------------------------*/
1245
1246 #define DTM0660_PACKET_SIZE 15
1247
1248 struct dtm0660_info {
1249         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
1250         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
1251         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
1252         gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
1253         gboolean is_minmax, is_max, is_sign;
1254 };
1255
1256 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
1257 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
1258                         struct sr_datafeed_analog *analog, void *info);
1259
1260 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
1261
1262 #define BBCGM_M2110_PACKET_SIZE 9
1263
1264 /* Dummy info struct. The parser does not use it. */
1265 struct m2110_info { int dummy; };
1266
1267 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
1268 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
1269                              struct sr_datafeed_analog *analog, void *info);
1270
1271 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
1272
1273 #define METEX14_PACKET_SIZE 14
1274
1275 struct metex14_info {
1276         size_t ch_idx;
1277         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
1278         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
1279         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
1280         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
1281         gboolean is_unitless, is_logic;
1282 };
1283
1284 #ifdef HAVE_LIBSERIALPORT
1285 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
1286 #endif
1287 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
1288 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1289                              struct sr_datafeed_analog *analog, void *info);
1290 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
1291 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
1292                              struct sr_datafeed_analog *analog, void *info);
1293
1294 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
1295
1296 #define RS9LCD_PACKET_SIZE 9
1297
1298 /* Dummy info struct. The parser does not use it. */
1299 struct rs9lcd_info { int dummy; };
1300
1301 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
1302 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
1303                             struct sr_datafeed_analog *analog, void *info);
1304
1305 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
1306
1307 #define BRYMEN_BM25X_PACKET_SIZE 15
1308
1309 /* Dummy info struct. The parser does not use it. */
1310 struct bm25x_info { int dummy; };
1311
1312 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
1313 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
1314                              struct sr_datafeed_analog *analog, void *info);
1315
1316 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
1317
1318 #define UT71X_PACKET_SIZE 11
1319
1320 struct ut71x_info {
1321         gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
1322         gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
1323         gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
1324         gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
1325 };
1326
1327 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
1328 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
1329                 struct sr_datafeed_analog *analog, void *info);
1330
1331 /*--- hardware/dmm/vc870.c --------------------------------------------------*/
1332
1333 #define VC870_PACKET_SIZE 23
1334
1335 struct vc870_info {
1336         gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
1337         gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
1338         gboolean is_current, is_micro, is_milli, is_power;
1339         gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
1340         gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
1341         gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
1342         gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
1343         gboolean is_lo, is_hi, is_open2;
1344
1345         gboolean is_frequency, is_dual_display, is_auto;
1346 };
1347
1348 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
1349 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
1350                 struct sr_datafeed_analog *analog, void *info);
1351
1352 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
1353
1354 SR_PRIV void es51919_serial_clean(void *priv);
1355 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
1356                                                 const char *vendor,
1357                                                 const char *model);
1358 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
1359                                       const struct sr_dev_inst *sdi,
1360                                       const struct sr_channel_group *cg);
1361 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
1362                                       const struct sr_dev_inst *sdi,
1363                                       const struct sr_channel_group *cg);
1364 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
1365                                        const struct sr_dev_inst *sdi,
1366                                        const struct sr_channel_group *cg);
1367 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi);
1368 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi);
1369
1370 /*--- hardware/dmm/ut372.c --------------------------------------------------*/
1371
1372 #define UT372_PACKET_SIZE 27
1373
1374 struct ut372_info {
1375         int dummy;
1376 };
1377
1378 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
1379 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
1380                 struct sr_datafeed_analog *analog, void *info);
1381
1382 /*--- hardware/dmm/asycii.c -------------------------------------------------*/
1383
1384 #define ASYCII_PACKET_SIZE 16
1385
1386 struct asycii_info {
1387         gboolean is_ac, is_dc, is_ac_and_dc;
1388         gboolean is_resistance, is_capacitance, is_diode, is_gain;
1389         gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
1390         gboolean is_pulse_width, is_period_pos, is_period_neg;
1391         gboolean is_pulse_count, is_count_pos, is_count_neg;
1392         gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
1393         gboolean is_hertz, is_percent, is_seconds, is_decibel;
1394         gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
1395         gboolean is_unitless;
1396         gboolean is_peak_min, is_peak_max;
1397         gboolean is_invalid;
1398 };
1399
1400 #ifdef HAVE_LIBSERIALPORT
1401 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
1402 #endif
1403 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
1404 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
1405                             struct sr_datafeed_analog *analog, void *info);
1406
1407 /*--- hardware/scale/kern.c -------------------------------------------------*/
1408
1409 struct kern_info {
1410         gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
1411         gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
1412         gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
1413         int buflen;
1414 };
1415
1416 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
1417 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
1418                 struct sr_datafeed_analog *analog, void *info);
1419
1420 /*--- sw_limits.c -----------------------------------------------------------*/
1421
1422 struct sr_sw_limits {
1423         uint64_t limit_samples;
1424         uint64_t limit_msec;
1425         uint64_t samples_read;
1426         uint64_t start_time;
1427 };
1428
1429 SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key,
1430         GVariant **data);
1431 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
1432         GVariant *data);
1433 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
1434 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
1435 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
1436         uint64_t samples_read);
1437 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
1438
1439 #endif