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 <glib.h>
  29 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
  30 #ifdef HAVE_LIBUSB_1_0
  31 #include <libusb.h>
  32 #endif
  33 #ifdef HAVE_LIBSERIALPORT
  34 #include <libserialport.h>
  35 #endif
  36
  37 /**
  38  * @file
  39  *
  40  * libsigrok private header file, only to be used internally.
  41  */
  42
  43 /*--- Macros ----------------------------------------------------------------*/
  44
  45 #ifndef ARRAY_SIZE
  46 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  47 #endif
  48
  49 #ifndef ARRAY_AND_SIZE
  50 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  51 #endif
  52
  53 /**
  54  * Read a 8 bits unsigned integer out of memory.
  55  * @param x a pointer to the input memory
  56  * @return the corresponding unsigned integer
  57  */
  58 #define R8(x)     ((unsigned)((const uint8_t*)(x))[0])
  59
  60 /**
  61  * Read a 16 bits big endian unsigned integer out of memory.
  62  * @param x a pointer to the input memory
  63  * @return the corresponding unsigned integer
  64  */
  65 #define RB16(x)  (((unsigned)((const uint8_t*)(x))[0] <<  8) |  \
  66                    (unsigned)((const uint8_t*)(x))[1])
  67
  68 /**
  69  * Read a 16 bits little endian unsigned integer out of memory.
  70  * @param x a pointer to the input memory
  71  * @return the corresponding unsigned integer
  72  */
  73 #define RL16(x)  (((unsigned)((const uint8_t*)(x))[1] <<  8) | \
  74                    (unsigned)((const uint8_t*)(x))[0])
  75
  76 /**
  77  * Read a 16 bits little endian signed integer out of memory.
  78  * @param x a pointer to the input memory
  79  * @return the corresponding signed integer
  80  */
  81 #define RL16S(x)  ((int16_t) \
  82                   (((unsigned)((const uint8_t*)(x))[1] <<  8) | \
  83                     (unsigned)((const uint8_t*)(x))[0]))
  84
  85 /**
  86  * Read a 32 bits big endian unsigned integer out of memory.
  87  * @param x a pointer to the input memory
  88  * @return the corresponding unsigned integer
  89  */
  90 #define RB32(x)  (((unsigned)((const uint8_t*)(x))[0] << 24) | \
  91                   ((unsigned)((const uint8_t*)(x))[1] << 16) |  \
  92                   ((unsigned)((const uint8_t*)(x))[2] <<  8) |  \
  93                    (unsigned)((const uint8_t*)(x))[3])
  94
  95 /**
  96  * Read a 32 bits little endian unsigned integer out of memory.
  97  * @param x a pointer to the input memory
  98  * @return the corresponding unsigned integer
  99  */
 100 #define RL32(x)  (((unsigned)((const uint8_t*)(x))[3] << 24) | \
 101                   ((unsigned)((const uint8_t*)(x))[2] << 16) |  \
 102                   ((unsigned)((const uint8_t*)(x))[1] <<  8) |  \
 103                    (unsigned)((const uint8_t*)(x))[0])
 104
 105 /**
 106  * Read a 32 bits little endian signed integer out of memory.
 107  * @param x a pointer to the input memory
 108  * @return the corresponding signed integer
 109  */
 110 #define RL32S(x)  ((int32_t) \
 111                  (((unsigned)((const uint8_t*)(x))[3] << 24) | \
 112                   ((unsigned)((const uint8_t*)(x))[2] << 16) |  \
 113                   ((unsigned)((const uint8_t*)(x))[1] <<  8) |  \
 114                    (unsigned)((const uint8_t*)(x))[0]))
 115
 116 /**
 117  * Write a 8 bits unsigned integer to memory.
 118  * @param p a pointer to the output memory
 119  * @param x the input unsigned integer
 120  */
 121 #define W8(p, x)    do { ((uint8_t*)(p))[0] = (uint8_t) (x);      } while(0)
 122
 123 /**
 124  * Write a 16 bits unsigned integer to memory stored as big endian.
 125  * @param p a pointer to the output memory
 126  * @param x the input unsigned integer
 127  */
 128 #define WB16(p, x)  do { ((uint8_t*)(p))[1] = (uint8_t) (x);      \
 129                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>8);  } while(0)
 130
 131 /**
 132  * Write a 16 bits unsigned integer to memory stored as little endian.
 133  * @param p a pointer to the output memory
 134  * @param x the input unsigned integer
 135  */
 136 #define WL16(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
 137                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  } while(0)
 138
 139 /**
 140  * Write a 32 bits unsigned integer to memory stored as big endian.
 141  * @param p a pointer to the output memory
 142  * @param x the input unsigned integer
 143  */
 144 #define WB32(p, x)  do { ((uint8_t*)(p))[3] = (uint8_t) (x);      \
 145                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>8);  \
 146                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \
 147                          ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while(0)
 148
 149 /**
 150  * Write a 32 bits unsigned integer to memory stored as little endian.
 151  * @param p a pointer to the output memory
 152  * @param x the input unsigned integer
 153  */
 154 #define WL32(p, x)  do { ((uint8_t*)(p))[0] = (uint8_t) (x);      \
 155                          ((uint8_t*)(p))[1] = (uint8_t)((x)>>8);  \
 156                          ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \
 157                          ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while(0)
 158
 159 /* Portability fixes for FreeBSD. */
 160 #ifdef __FreeBSD__
 161 #define LIBUSB_CLASS_APPLICATION 0xfe
 162 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
 163         libusb_handle_events_timeout(ctx, tv)
 164 #endif
 165
 166 /* Static definitions of structs ending with an all-zero entry are a
 167  * problem when compiling with -Wmissing-field-initializers: GCC
 168  * suppresses the warning only with { 0 }, clang wants { } */
 169 #ifdef __clang__
 170 #define ALL_ZERO { }
 171 #else
 172 #define ALL_ZERO { 0 }
 173 #endif
 174
 175 struct sr_context {
 176 #ifdef HAVE_LIBUSB_1_0
 177         libusb_context *libusb_ctx;
 178         gboolean usb_source_present;
 179 #ifdef _WIN32
 180         GThread *usb_thread;
 181         gboolean usb_thread_running;
 182         GMutex usb_mutex;
 183         HANDLE usb_event;
 184         GPollFD usb_pollfd;
 185         sr_receive_data_callback usb_cb;
 186         void *usb_cb_data;
 187 #endif
 188 #endif
 189 };
 190
 191 /** Input module metadata keys. */
 192 enum sr_input_meta_keys {
 193         /** The input filename, if there is one. */
 194         SR_INPUT_META_FILENAME = 0x01,
 195         /** The input file's size in bytes. */
 196         SR_INPUT_META_FILESIZE = 0x02,
 197         /** The first 128 bytes of the file, provided as a GString. */
 198         SR_INPUT_META_HEADER = 0x04,
 199         /** The file's MIME type. */
 200         SR_INPUT_META_MIMETYPE = 0x08,
 201
 202         /** The module cannot identify a file without this metadata. */
 203         SR_INPUT_META_REQUIRED = 0x80,
 204 };
 205
 206 /** Input (file) module struct. */
 207 struct sr_input {
 208         /**
 209          * A pointer to this input module's 'struct sr_input_module'.
 210          */
 211         const struct sr_input_module *module;
 212         GString *buf;
 213         struct sr_dev_inst *sdi;
 214         gboolean sdi_ready;
 215         void *priv;
 216 };
 217
 218 /** Input (file) module driver. */
 219 struct sr_input_module {
 220         /**
 221          * A unique ID for this input module, suitable for use in command-line
 222          * clients, [a-z0-9-]. Must not be NULL.
 223          */
 224         const char *id;
 225
 226         /**
 227          * A unique name for this input module, suitable for use in GUI
 228          * clients, can contain UTF-8. Must not be NULL.
 229          */
 230         const char *name;
 231
 232         /**
 233          * A short description of the input module. Must not be NULL.
 234          *
 235          * This can be displayed by frontends, e.g. when selecting the input
 236          * module for saving a file.
 237          */
 238         const char *desc;
 239
 240         /**
 241          * Zero-terminated list of metadata items the module needs to be able
 242          * to identify an input stream. Can be all-zero, if the module cannot
 243          * identify streams at all, i.e. has to be forced into use.
 244          *
 245          * Each item is one of:
 246          *   SR_INPUT_META_FILENAME
 247          *   SR_INPUT_META_FILESIZE
 248          *   SR_INPUT_META_HEADER
 249          *   SR_INPUT_META_MIMETYPE
 250          *
 251          * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
 252          * identify a stream without the given metadata.
 253          */
 254         const uint8_t metadata[8];
 255
 256         /**
 257          * Returns a NULL-terminated list of options this module can take.
 258          * Can be NULL, if the module has no options.
 259          */
 260         struct sr_option *(*options) (void);
 261
 262         /**
 263          * Check if this input module can load and parse the specified stream.
 264          *
 265          * @param[in] metadata Metadata the module can use to identify the stream.
 266          *
 267          * @retval SR_OK This module knows the format.
 268          * @retval SR_ERR_NA There wasn't enough data for this module to
 269          *   positively identify the format.
 270          * @retval SR_ERR_DATA This module knows the format, but cannot handle it.
 271          *   This means the stream is either corrupt, or indicates a feature
 272          *   that the module does not support.
 273          * @retval SR_ERR This module does not know the format.
 274          */
 275         int (*format_match) (GHashTable *metadata);
 276
 277         /**
 278          * Initialize the input module.
 279          *
 280          * @retval SR_OK Success
 281          * @retval other Negative error code.
 282          */
 283         int (*init) (struct sr_input *in, GHashTable *options);
 284
 285         /**
 286          * Send data to the specified input instance.
 287          *
 288          * When an input module instance is created with sr_input_new(), this
 289          * function is used to feed data to the instance.
 290          *
 291          * As enough data gets fed into this function to completely populate
 292          * the device instance associated with this input instance, this is
 293          * guaranteed to return the moment it's ready. This gives the caller
 294          * the chance to examine the device instance, attach session callbacks
 295          * and so on.
 296          *
 297          * @retval SR_OK Success
 298          * @retval other Negative error code.
 299          */
 300         int (*receive) (struct sr_input *in, GString *buf);
 301
 302         /**
 303          * Signal the input module no more data will come.
 304          *
 305          * This will cause the module to process any data it may have buffered.
 306          * The SR_DF_END packet will also typically be sent at this time.
 307          */
 308         int (*end) (struct sr_input *in);
 309
 310         /**
 311          * This function is called after the caller is finished using
 312          * the input module, and can be used to free any internal
 313          * resources the module may keep.
 314          *
 315          * This function is optional.
 316          *
 317          * @retval SR_OK Success
 318          * @retval other Negative error code.
 319          */
 320         void (*cleanup) (struct sr_input *in);
 321 };
 322
 323 /** Output module instance. */
 324 struct sr_output {
 325         /** A pointer to this output's module.  */
 326         const struct sr_output_module *module;
 327
 328         /**
 329          * The device for which this output module is creating output. This
 330          * can be used by the module to find out channel names and numbers.
 331          */
 332         const struct sr_dev_inst *sdi;
 333
 334         /**
 335          * A generic pointer which can be used by the module to keep internal
 336          * state between calls into its callback functions.
 337          *
 338          * For example, the module might store a pointer to a chunk of output
 339          * there, and only flush it when it reaches a certain size.
 340          */
 341         void *priv;
 342 };
 343
 344 /** Output module driver. */
 345 struct sr_output_module {
 346         /**
 347          * A unique ID for this output module, suitable for use in command-line
 348          * clients, [a-z0-9-]. Must not be NULL.
 349          */
 350         char *id;
 351
 352         /**
 353          * A unique name for this output module, suitable for use in GUI
 354          * clients, can contain UTF-8. Must not be NULL.
 355          */
 356         const char *name;
 357
 358         /**
 359          * A short description of the output module. Must not be NULL.
 360          *
 361          * This can be displayed by frontends, e.g. when selecting the output
 362          * module for saving a file.
 363          */
 364         char *desc;
 365
 366         /**
 367          * Returns a NULL-terminated list of options this module can take.
 368          * Can be NULL, if the module has no options.
 369          */
 370         const struct sr_option *(*options) (void);
 371
 372         /**
 373          * This function is called once, at the beginning of an output stream.
 374          *
 375          * The device struct will be available in the output struct passed in,
 376          * as well as the param field -- which may be NULL or an empty string,
 377          * if no parameter was passed.
 378          *
 379          * The module can use this to initialize itself, create a struct for
 380          * keeping state and storing it in the <code>internal</code> field.
 381          *
 382          * @param o Pointer to the respective 'struct sr_output'.
 383          *
 384          * @retval SR_OK Success
 385          * @retval other Negative error code.
 386          */
 387         int (*init) (struct sr_output *o, GHashTable *options);
 388
 389         /**
 390          * This function is passed a copy of every packed in the data feed.
 391          * Any output generated by the output module in response to the
 392          * packet should be returned in a newly allocated GString
 393          * <code>out</code>, which will be freed by the caller.
 394          *
 395          * Packets not of interest to the output module can just be ignored,
 396          * and the <code>out</code> parameter set to NULL.
 397          *
 398          * @param o Pointer to the respective 'struct sr_output'.
 399          * @param sdi The device instance that generated the packet.
 400          * @param packet The complete packet.
 401          * @param out A pointer where a GString * should be stored if
 402          * the module generates output, or NULL if not.
 403          *
 404          * @retval SR_OK Success
 405          * @retval other Negative error code.
 406          */
 407         int (*receive) (const struct sr_output *o,
 408                         const struct sr_datafeed_packet *packet, GString **out);
 409
 410         /**
 411          * This function is called after the caller is finished using
 412          * the output module, and can be used to free any internal
 413          * resources the module may keep.
 414          *
 415          * @retval SR_OK Success
 416          * @retval other Negative error code.
 417          */
 418         int (*cleanup) (struct sr_output *o);
 419 };
 420
 421 #ifdef HAVE_LIBUSB_1_0
 422 /** USB device instance */
 423 struct sr_usb_dev_inst {
 424         /** USB bus */
 425         uint8_t bus;
 426         /** Device address on USB bus */
 427         uint8_t address;
 428         /** libusb device handle */
 429         struct libusb_device_handle *devhdl;
 430 };
 431 #endif
 432
 433 #ifdef HAVE_LIBSERIALPORT
 434 #define SERIAL_PARITY_NONE SP_PARITY_NONE
 435 #define SERIAL_PARITY_EVEN SP_PARITY_EVEN
 436 #define SERIAL_PARITY_ODD  SP_PARITY_ODD
 437 struct sr_serial_dev_inst {
 438         /** Port name, e.g. '/dev/tty42'. */
 439         char *port;
 440         /** Comm params for serial_set_paramstr(). */
 441         char *serialcomm;
 442         /** libserialport port handle */
 443         struct sp_port *data;
 444         /** libserialport event set */
 445         struct sp_event_set *event_set;
 446         /** GPollFDs for event polling */
 447         GPollFD *pollfds;
 448 };
 449 #endif
 450
 451 struct sr_usbtmc_dev_inst {
 452         char *device;
 453         int fd;
 454 };
 455
 456 /* Private driver context. */
 457 struct drv_context {
 458         /** sigrok context */
 459         struct sr_context *sr_ctx;
 460         GSList *instances;
 461 };
 462
 463 /*--- log.c -----------------------------------------------------------------*/
 464
 465 SR_PRIV int sr_log(int loglevel, const char *format, ...);
 466 SR_PRIV int sr_spew(const char *format, ...);
 467 SR_PRIV int sr_dbg(const char *format, ...);
 468 SR_PRIV int sr_info(const char *format, ...);
 469 SR_PRIV int sr_warn(const char *format, ...);
 470 SR_PRIV int sr_err(const char *format, ...);
 471
 472 /* Message logging helpers with subsystem-specific prefix string. */
 473 #ifndef NO_LOG_WRAPPERS
 474 #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args)
 475 #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args)
 476 #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args)
 477 #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args)
 478 #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args)
 479 #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args)
 480 #endif
 481
 482 /*--- device.c --------------------------------------------------------------*/
 483
 484 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
 485 enum {
 486         /** The enabled state of the channel has been changed. */
 487         SR_CHANNEL_SET_ENABLED = 1 << 0,
 488 };
 489
 490 SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
 491                 gboolean enabled, const char *name);
 492
 493 /** Device instance data */
 494 struct sr_dev_inst {
 495         /** Device driver. */
 496         struct sr_dev_driver *driver;
 497         /** Device instance status. SR_ST_NOT_FOUND, etc. */
 498         int status;
 499         /** Device instance type. SR_INST_USB, etc. */
 500         int inst_type;
 501         /** Device vendor. */
 502         char *vendor;
 503         /** Device model. */
 504         char *model;
 505         /** Device version. */
 506         char *version;
 507         /** Serial number. */
 508         char *serial_num;
 509         /** Connection string to uniquely identify devices. */
 510         char *connection_id;
 511         /** List of channels. */
 512         GSList *channels;
 513         /** List of sr_channel_group structs */
 514         GSList *channel_groups;
 515         /** Device instance connection data (used?) */
 516         void *conn;
 517         /** Device instance private data (used?) */
 518         void *priv;
 519         /** Session to which this device is currently assigned. */
 520         struct sr_session *session;
 521 };
 522
 523 /* Generic device instances */
 524 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(void);
 525 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
 526
 527 #ifdef HAVE_LIBUSB_1_0
 528 /* USB-specific instances */
 529 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 530                 uint8_t address, struct libusb_device_handle *hdl);
 531 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
 532 #endif
 533
 534 #ifdef HAVE_LIBSERIALPORT
 535 /* Serial-specific instances */
 536 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 537                 const char *serialcomm);
 538 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
 539 #endif
 540
 541 /* USBTMC-specific instances */
 542 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
 543 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
 544
 545 /*--- hwdriver.c ------------------------------------------------------------*/
 546
 547 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
 548 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
 549 SR_PRIV void sr_hw_cleanup_all(void);
 550 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
 551 SR_PRIV void sr_config_free(struct sr_config *src);
 552 SR_PRIV int sr_source_remove(int fd);
 553 SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd);
 554 SR_PRIV int sr_source_remove_channel(GIOChannel *channel);
 555 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 556                 sr_receive_data_callback cb, void *cb_data);
 557 SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout,
 558                 sr_receive_data_callback cb, void *cb_data);
 559 SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout,
 560                 sr_receive_data_callback cb, void *cb_data);
 561
 562 /*--- session.c -------------------------------------------------------------*/
 563
 564 struct sr_session {
 565         /** List of struct sr_dev_inst pointers. */
 566         GSList *devs;
 567         /** List of struct sr_dev_inst pointers owned by this session. */
 568         GSList *owned_devs;
 569         /** List of struct datafeed_callback pointers. */
 570         GSList *datafeed_callbacks;
 571         struct sr_trigger *trigger;
 572         GTimeVal starttime;
 573         gboolean running;
 574
 575         unsigned int num_sources;
 576
 577         /*
 578          * Both "sources" and "pollfds" are of the same size and contain pairs
 579          * of descriptor and callback function. We can not embed the GPollFD
 580          * into the source struct since we want to be able to pass the array
 581          * of all poll descriptors to g_poll().
 582          */
 583         struct source *sources;
 584         GPollFD *pollfds;
 585         int source_timeout;
 586
 587         /*
 588          * These are our synchronization primitives for stopping the session in
 589          * an async fashion. We need to make sure the session is stopped from
 590          * within the session thread itself.
 591          */
 592         /** Mutex protecting access to abort_session. */
 593         GMutex stop_mutex;
 594         /** Abort current session. See sr_session_stop(). */
 595         gboolean abort_session;
 596 };
 597
 598 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
 599                 const struct sr_datafeed_packet *packet);
 600 SR_PRIV int sr_session_stop_sync(struct sr_session *session);
 601 SR_PRIV int sr_sessionfile_check(const char *filename);
 602 SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet,
 603                 struct sr_datafeed_packet **copy);
 604 SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet);
 605
 606 /*--- std.c -----------------------------------------------------------------*/
 607
 608 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
 609 typedef void (*std_dev_clear_callback)(void *priv);
 610
 611 SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
 612                 const char *prefix);
 613 #ifdef HAVE_LIBSERIALPORT
 614 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
 615 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
 616                 void *cb_data, dev_close_callback dev_close_fn,
 617                 struct sr_serial_dev_inst *serial, const char *prefix);
 618 #endif
 619 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
 620                 const char *prefix);
 621 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
 622                 std_dev_clear_callback clear_private);
 623 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
 624
 625 /*--- strutil.c -------------------------------------------------------------*/
 626
 627 SR_PRIV int sr_atol(const char *str, long *ret);
 628 SR_PRIV int sr_atoi(const char *str, int *ret);
 629 SR_PRIV int sr_atod(const char *str, double *ret);
 630 SR_PRIV int sr_atof(const char *str, float *ret);
 631 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
 632
 633 /*--- soft-trigger.c --------------------------------------------------------*/
 634
 635 struct soft_trigger_logic {
 636         const struct sr_dev_inst *sdi;
 637         const struct sr_trigger *trigger;
 638         int count;
 639         int unitsize;
 640         int cur_stage;
 641         uint8_t *prev_sample;
 642 };
 643
 644 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
 645                 const struct sr_dev_inst *sdi, struct sr_trigger *trigger);
 646 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
 647 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
 648                 int len);
 649
 650 /*--- hardware/serial.c -----------------------------------------------------*/
 651
 652 #ifdef HAVE_LIBSERIALPORT
 653 enum {
 654         SERIAL_RDWR = 1,
 655         SERIAL_RDONLY = 2,
 656 };
 657
 658 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
 659
 660 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
 661 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
 662 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
 663 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
 664 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
 665                 const void *buf, size_t count, unsigned int timeout_ms);
 666 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
 667                 const void *buf, size_t count);
 668 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
 669                 size_t count, unsigned int timeout_ms);
 670 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
 671                 size_t count);
 672 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 673                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
 674 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 675                 const char *paramstr);
 676 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 677                 int *buflen, gint64 timeout_ms);
 678 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 679                                  uint8_t *buf, size_t *buflen,
 680                                  size_t packet_size,
 681                                  packet_valid_callback is_valid,
 682                                  uint64_t timeout_ms, int baudrate);
 683 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
 684                                       const char **serial_options);
 685 SR_PRIV int serial_source_add(struct sr_session *session,
 686                 struct sr_serial_dev_inst *serial, int events, int timeout,
 687                 sr_receive_data_callback cb, void *cb_data);
 688 SR_PRIV int serial_source_remove(struct sr_session *session,
 689                 struct sr_serial_dev_inst *serial);
 690 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
 691 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
 692 #endif
 693
 694 /*--- hardware/ezusb.c ------------------------------------------------------*/
 695
 696 #ifdef HAVE_LIBUSB_1_0
 697 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 698 SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
 699                                    const char *filename);
 700 SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
 701                                   const char *filename);
 702 #endif
 703
 704 /*--- hardware/usb.c --------------------------------------------------------*/
 705
 706 #ifdef HAVE_LIBUSB_1_0
 707 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
 708 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
 709 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
 710                 int timeout, sr_receive_data_callback cb, void *cb_data);
 711 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
 712 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
 713 #endif
 714
 715 /*--- hardware/scpi.c -------------------------------------------------------*/
 716
 717 #define SCPI_CMD_IDN "*IDN?"
 718 #define SCPI_CMD_OPC "*OPC?"
 719
 720 enum {
 721         SCPI_CMD_SET_TRIGGER_SOURCE,
 722         SCPI_CMD_SET_TIMEBASE,
 723         SCPI_CMD_SET_VERTICAL_DIV,
 724         SCPI_CMD_SET_TRIGGER_SLOPE,
 725         SCPI_CMD_SET_COUPLING,
 726         SCPI_CMD_SET_HORIZ_TRIGGERPOS,
 727         SCPI_CMD_GET_ANALOG_CHAN_STATE,
 728         SCPI_CMD_GET_DIG_CHAN_STATE,
 729         SCPI_CMD_GET_TIMEBASE,
 730         SCPI_CMD_GET_VERTICAL_DIV,
 731         SCPI_CMD_GET_VERTICAL_OFFSET,
 732         SCPI_CMD_GET_TRIGGER_SOURCE,
 733         SCPI_CMD_GET_HORIZ_TRIGGERPOS,
 734         SCPI_CMD_GET_TRIGGER_SLOPE,
 735         SCPI_CMD_GET_COUPLING,
 736         SCPI_CMD_SET_ANALOG_CHAN_STATE,
 737         SCPI_CMD_SET_DIG_CHAN_STATE,
 738         SCPI_CMD_GET_DIG_POD_STATE,
 739         SCPI_CMD_SET_DIG_POD_STATE,
 740         SCPI_CMD_GET_ANALOG_DATA,
 741         SCPI_CMD_GET_DIG_DATA,
 742         SCPI_CMD_GET_SAMPLE_RATE,
 743         SCPI_CMD_GET_SAMPLE_RATE_LIVE,
 744 };
 745
 746 struct sr_scpi_hw_info {
 747         char *manufacturer;
 748         char *model;
 749         char *serial_number;
 750         char *firmware_version;
 751 };
 752
 753 struct sr_scpi_dev_inst {
 754         const char *name;
 755         const char *prefix;
 756         int priv_size;
 757         GSList *(*scan)(struct drv_context *drvc);
 758         int (*dev_inst_new)(void *priv, struct drv_context *drvc,
 759                 const char *resource, char **params, const char *serialcomm);
 760         int (*open)(void *priv);
 761         int (*source_add)(struct sr_session *session, void *priv, int events,
 762                 int timeout, sr_receive_data_callback cb, void *cb_data);
 763         int (*source_remove)(struct sr_session *session, void *priv);
 764         int (*send)(void *priv, const char *command);
 765         int (*read_begin)(void *priv);
 766         int (*read_data)(void *priv, char *buf, int maxlen);
 767         int (*read_complete)(void *priv);
 768         int (*close)(void *priv);
 769         void (*free)(void *priv);
 770         unsigned int read_timeout_ms;
 771         void *priv;
 772 };
 773
 774 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
 775                 struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
 776 SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
 777                 const char *resource, const char *serialcomm);
 778 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
 779 SR_PRIV int sr_scpi_source_add(struct sr_session *session,
 780                 struct sr_scpi_dev_inst *scpi, int events, int timeout,
 781                 sr_receive_data_callback cb, void *cb_data);
 782 SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
 783                 struct sr_scpi_dev_inst *scpi);
 784 SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
 785                 const char *format, ...);
 786 SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 787                 const char *format, va_list args);
 788 SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
 789 SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
 790 SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
 791 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
 792 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
 793
 794 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 795                         const char *command, char **scpi_response);
 796 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 797                         const char *command, gboolean *scpi_response);
 798 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 799                         const char *command, int *scpi_response);
 800 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 801                         const char *command, float *scpi_response);
 802 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 803                         const char *command, double *scpi_response);
 804 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
 805 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 806                         const char *command, GArray **scpi_response);
 807 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 808                         const char *command, GArray **scpi_response);
 809 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 810                         struct sr_scpi_hw_info **scpi_response);
 811 SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
 812
 813 /*--- hardware/dmm/es519xx.c ------------------------------------------------*/
 814
 815 /**
 816  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
 817  * so always read 2 blocks at a time.
 818  */
 819 #define ES519XX_11B_PACKET_SIZE (11 * 2)
 820 #define ES519XX_14B_PACKET_SIZE 14
 821
 822 struct es519xx_info {
 823         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
 824         gboolean is_milli, is_resistance, is_continuity, is_diode;
 825         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
 826         gboolean is_temperature, is_celsius, is_fahrenheit;
 827         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
 828         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
 829         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
 830         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
 831         uint32_t baudrate;
 832         int packet_size;
 833         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
 834 };
 835
 836 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
 837 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
 838                 struct sr_datafeed_analog *analog, void *info);
 839 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
 840 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
 841                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 842 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
 843 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
 844                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 845 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
 846 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
 847                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 848 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
 849 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
 850                 struct sr_datafeed_analog *analog, void *info);
 851 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
 852 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
 853                 struct sr_datafeed_analog *analog, void *info);
 854 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
 855 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
 856                 float *floatval, struct sr_datafeed_analog *analog, void *info);
 857
 858 /*--- hardware/dmm/fs9922.c -------------------------------------------------*/
 859
 860 #define FS9922_PACKET_SIZE 14
 861
 862 struct fs9922_info {
 863         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
 864         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
 865         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
 866         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
 867         gboolean is_celsius, is_fahrenheit;
 868         int bargraph_sign, bargraph_value;
 869 };
 870
 871 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
 872 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
 873                             struct sr_datafeed_analog *analog, void *info);
 874 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
 875
 876 /*--- hardware/dmm/fs9721.c -------------------------------------------------*/
 877
 878 #define FS9721_PACKET_SIZE 14
 879
 880 struct fs9721_info {
 881         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
 882         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
 883         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
 884         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
 885 };
 886
 887 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
 888 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 889                             struct sr_datafeed_analog *analog, void *info);
 890 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
 891 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
 892 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
 893 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
 894 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
 895
 896 /*--- hardware/dmm/m2110.c --------------------------------------------------*/
 897
 898 #define BBCGM_M2110_PACKET_SIZE 9
 899
 900 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
 901 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
 902                              struct sr_datafeed_analog *analog, void *info);
 903
 904 /*--- hardware/dmm/metex14.c ------------------------------------------------*/
 905
 906 #define METEX14_PACKET_SIZE 14
 907
 908 struct metex14_info {
 909         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
 910         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
 911         gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
 912         gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
 913         gboolean is_unitless, is_logic;
 914 };
 915
 916 #ifdef HAVE_LIBSERIALPORT
 917 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
 918 #endif
 919 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
 920 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
 921                              struct sr_datafeed_analog *analog, void *info);
 922
 923 /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/
 924
 925 #define RS9LCD_PACKET_SIZE 9
 926
 927 /* Dummy info struct. The parser does not use it. */
 928 struct rs9lcd_info { int dummy; };
 929
 930 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
 931 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
 932                             struct sr_datafeed_analog *analog, void *info);
 933
 934 /*--- hardware/dmm/bm25x.c --------------------------------------------------*/
 935
 936 #define BRYMEN_BM25X_PACKET_SIZE 15
 937
 938 /* Dummy info struct. The parser does not use it. */
 939 struct bm25x_info { int dummy; };
 940
 941 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
 942 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
 943                              struct sr_datafeed_analog *analog, void *info);
 944
 945 /*--- hardware/dmm/ut71x.c --------------------------------------------------*/
 946
 947 #define UT71X_PACKET_SIZE 11
 948
 949 struct ut71x_info {
 950         gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
 951         gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
 952         gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
 953         gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
 954 };
 955
 956 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
 957 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
 958                 struct sr_datafeed_analog *analog, void *info);
 959
 960 /*--- hardware/lcr/es51919.c ------------------------------------------------*/
 961
 962 SR_PRIV void es51919_serial_clean(void *priv);
 963 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
 964                                                 const char *vendor,
 965                                                 const char *model);
 966 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
 967                                       const struct sr_dev_inst *sdi,
 968                                       const struct sr_channel_group *cg);
 969 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
 970                                       const struct sr_dev_inst *sdi,
 971                                       const struct sr_channel_group *cg);
 972 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
 973                                        const struct sr_dev_inst *sdi,
 974                                        const struct sr_channel_group *cg);
 975 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
 976                                              void *cb_data);
 977 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
 978                                             void *cb_data);
 979
 980 #endif