src/libsigrok-internal.h

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