X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=88ba2f58139625680c166a553682df5332014f53;hb=4b4474ed6a4701e28961569eb777052d0b74673d;hp=bf0b8b295812bfdcd06ea4245274bd33853c5e96;hpb=07e1aad5c4d53ee1028613312061f261f1a7800a;p=libsigrok.git diff --git a/libsigrok.h b/libsigrok.h index bf0b8b29..88ba2f58 100644 --- a/libsigrok.h +++ b/libsigrok.h @@ -1,7 +1,7 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * - * Copyright (C) 2010-2012 Bert Vermeulen + * Copyright (C) 2013 Bert Vermeulen * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -36,7 +36,7 @@ extern "C" { * The public libsigrok header file to be used by frontends. * * This is the only file that libsigrok users (frontends) are supposed to - * use and #include. There are other header files which get installed with + * use and \#include. There are other header files which get installed with * libsigrok, but those are not meant to be used directly by frontends. * * The correct way to get/use the libsigrok API functions is: @@ -70,18 +70,26 @@ enum { SR_ERR_ARG = -3, /**< Function argument error. */ SR_ERR_BUG = -4, /**< Errors hinting at internal bugs. */ SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */ + SR_ERR_NA = -6, /**< Not applicable. */ + SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */ + SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */ + SR_ERR_PROBE_GROUP= -9, /**< A probe group must be specified. */ + + /* + * Note: When adding entries here, don't forget to also update the + * sr_strerror() and sr_strerror_name() functions in error.c. + */ }; -#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ #define SR_MAX_PROBENAME_LEN 32 /* Handy little macros */ #define SR_HZ(n) (n) -#define SR_KHZ(n) ((n) * 1000) -#define SR_MHZ(n) ((n) * 1000000) -#define SR_GHZ(n) ((n) * 1000000000) +#define SR_KHZ(n) ((n) * (uint64_t)(1000ULL)) +#define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL)) +#define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL)) -#define SR_HZ_TO_NS(n) (1000000000 / (n)) +#define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n)) /** libsigrok loglevels. */ enum { @@ -134,14 +142,8 @@ enum { SR_T_RATIONAL_PERIOD, SR_T_RATIONAL_VOLT, SR_T_KEYVALUE, -}; - -/** Rational number data type, containing numerator and denominator values. */ -struct sr_rational { - /** Numerator of the rational number. */ - uint64_t p; - /** Denominator of the rational number. */ - uint64_t q; + SR_T_UINT64_RANGE, + SR_T_DOUBLE_RANGE, }; /** Value for sr_datafeed_packet.type. */ @@ -177,6 +179,7 @@ enum { SR_MQ_SOUND_PRESSURE_LEVEL, SR_MQ_CARBON_MONOXIDE, SR_MQ_RELATIVE_HUMIDITY, + SR_MQ_TIME, /**< Time */ }; /** Values for sr_datafeed_analog.unit. */ @@ -215,6 +218,10 @@ enum { * represented as the fraction of number of particles of the substance. */ SR_UNIT_CONCENTRATION, + SR_UNIT_REVOLUTIONS_PER_MINUTE, + SR_UNIT_VOLT_AMPERE, + SR_UNIT_WATT, + SR_UNIT_WATT_HOUR, }; /** Values for sr_datafeed_analog.flags. */ @@ -261,6 +268,8 @@ enum { /** Sound pressure level represented as a percentage of measurements * that were over a preset alarm level. */ SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000, + /** Time is duration (as opposed to epoch, ...). */ + SR_MQFLAG_DURATION = 0x20000, }; struct sr_context; @@ -456,7 +465,7 @@ struct sr_output_format { * data_out parameter, so the caller knows not to try * and g_free() it. * - * Note: This API call is obsolete, use recv() instead. + * Note: This API call is obsolete, use receive() instead. * * @param o Pointer to the respective 'struct sr_output'. * @param data_in Pointer to the input data buffer. @@ -488,7 +497,7 @@ struct sr_output_format { * it stored in the data_out and length_out * parameters, or NULL if no output was generated. * - * Note: This API call is obsolete, use recv() instead. + * Note: This API call is obsolete, use receive() instead. * * @param o Pointer to the respective 'struct sr_output'. * @param event_type Type of event that occured. @@ -498,11 +507,35 @@ struct sr_output_format { * @return SR_OK upon success, a negative error code otherwise. */ int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, - uint64_t *length_out); + uint64_t *length_out); - GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi, - const struct sr_datafeed_packet *packet); + /** + * This function is passed a copy of every packed in the data feed. + * Any output generated by the output module in response to the + * packet should be returned in a newly allocated GString + * out, which will be freed by the caller. + * + * Packets not of interest to the output module can just be ignored, + * and the out parameter set to NULL. + * + * @param o Pointer to the respective 'struct sr_output'. + * @param sdi The device instance that generated the packet. + * @param packet The complete packet. + * @param out A pointer where a GString * should be stored if + * the module generates output, or NULL if not. + * + * @return SR_OK upon success, a negative error code otherwise. + */ + int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *packet, GString **out); + /** + * This function is called after the caller is finished using + * the output module, and can be used to free any internal + * resources the module may keep. + * + * @return SR_OK upon success, a negative error code otherwise. + */ int (*cleanup) (struct sr_output *o); }; @@ -520,9 +553,19 @@ struct sr_probe { char *trigger; }; +/** Structure for groups of probes that have common properties. */ +struct sr_probe_group { + /** Name of the probe group. */ + char *name; + /** List of sr_probe structs of the probes belonging to this group. */ + GSList *probes; + /** Private data for driver use. */ + void *priv; +}; + struct sr_config { int key; - const void *value; + GVariant *data; }; struct sr_config_info { @@ -557,6 +600,9 @@ enum { /** The device can measure humidity. */ SR_CONF_HYGROMETER, + /** The device can measure energy consumption. */ + SR_CONF_ENERGYMETER, + /*--- Driver scan options -------------------------------------------*/ /** @@ -594,7 +640,7 @@ enum { /*--- Device configuration ------------------------------------------*/ - /** The device supports setting/changing its samplerate. */ + /** The device supports setting its samplerate, in Hz. */ SR_CONF_SAMPLERATE = 30000, /** The device supports setting a pre/post-trigger capture ratio. */ @@ -633,6 +679,42 @@ enum { /** Trigger types. */ SR_CONF_TRIGGER_TYPE, + /** The device supports setting its sample interval, in ms. */ + SR_CONF_SAMPLE_INTERVAL, + + /** Number of timebases, as related to SR_CONF_TIMEBASE. */ + SR_CONF_NUM_TIMEBASE, + + /** Number of vertical divisions, as related to SR_CONF_VDIV. */ + SR_CONF_NUM_VDIV, + + /** Sound pressure level frequency weighting. */ + SR_CONF_SPL_WEIGHT_FREQ, + + /** Sound pressure level time weighting. */ + SR_CONF_SPL_WEIGHT_TIME, + + /** Sound pressure level measurement range. */ + SR_CONF_SPL_MEASUREMENT_RANGE, + + /** Max hold mode. */ + SR_CONF_HOLD_MAX, + + /** Min hold mode. */ + SR_CONF_HOLD_MIN, + + /** Logic low-high threshold range. */ + SR_CONF_VOLTAGE_THRESHOLD, + + /** The device supports using a external clock. */ + SR_CONF_EXTERNAL_CLOCK, + + /** + * The device supports swapping channels. Typical this is between + * buffered and unbuffered channels. + */ + SR_CONF_SWAP, + /*--- Special stuff -------------------------------------------------*/ /** Scan options supported by the driver. */ @@ -653,6 +735,21 @@ enum { /** The device supports setting the number of probes. */ SR_CONF_CAPTURE_NUM_PROBES, + /** Power off the device. */ + SR_CONF_POWER_OFF, + + /** Data source for acquisition. If not present, acquisition from + * the device is always "live", i.e. acquisition starts when the + * frontend asks and the results are sent out as soon as possible. + * + * If present, it indicates that either the device has no live + * acquisition capability (for example a pure data logger), or + * there is a choice. sr_config_list() returns those choices. + * + * In any case if a device has live acquisition capabilities, it + * is always the default. */ + SR_CONF_DATA_SOURCE, + /*--- Acquisition modes ---------------------------------------------*/ /** @@ -679,6 +776,10 @@ enum { * samples continuously, until explicitly stopped by a certain command. */ SR_CONF_CONTINUOUS, + + /** The device has internal storage, into which data is logged. This + * starts or stops the internal logging. */ + SR_CONF_DATALOG, }; struct sr_dev_inst { @@ -690,6 +791,9 @@ struct sr_dev_inst { char *model; char *version; GSList *probes; + /* List of sr_probe_group structs */ + GSList *probe_groups; + void *conn; void *priv; }; @@ -699,6 +803,8 @@ enum { SR_INST_USB = 10000, /** Device instance type for serial port devices. */ SR_INST_SERIAL, + /** Device instance type for SCPI devices. */ + SR_INST_SCPI, }; /** Device instance status. */ @@ -715,18 +821,6 @@ enum { SR_ST_STOPPING, }; -/* - * A device supports either a range of samplerates with steps of a given - * granularity, or is limited to a set of defined samplerates. Use either - * step or list, but not both. - */ -struct sr_samplerates { - uint64_t low; - uint64_t high; - uint64_t step; - const uint64_t *list; -}; - struct sr_dev_driver { /* Driver-specific */ char *name; @@ -737,12 +831,15 @@ struct sr_dev_driver { GSList *(*scan) (GSList *options); GSList *(*dev_list) (void); int (*dev_clear) (void); - int (*config_get) (int id, const void **value, - const struct sr_dev_inst *sdi); - int (*config_set) (int id, const void *value, - const struct sr_dev_inst *sdi); - int (*config_list) (int info_id, const void **data, - const struct sr_dev_inst *sdi); + int (*config_get) (int id, GVariant **data, + const struct sr_dev_inst *sdi, + const struct sr_probe_group *probe_group); + int (*config_set) (int id, GVariant *data, + const struct sr_dev_inst *sdi, + const struct sr_probe_group *probe_group); + int (*config_list) (int info_id, GVariant **data, + const struct sr_dev_inst *sdi, + const struct sr_probe_group *probe_group); /* Device-specific */ int (*dev_open) (struct sr_dev_inst *sdi); @@ -756,25 +853,11 @@ struct sr_dev_driver { void *priv; }; -struct sr_session { - /** List of struct sr_dev pointers. */ - GSList *devs; - /** List of sr_receive_data_callback_t items. */ - GSList *datafeed_callbacks; - GTimeVal starttime; - - unsigned int num_sources; - - /* - * Both "sources" and "pollfds" are of the same size and contain pairs - * of descriptor and callback function. We can not embed the GPollFD - * into the source struct since we want to be able to pass the array - * of all poll descriptors to g_poll(). - */ - struct source *sources; - GPollFD *pollfds; - int source_timeout; -}; +/** + * Opaque data structure representing a libsigrok session. None of the fields + * of this structure are meant to be accessed directly. + */ +struct sr_session; #include "proto.h" #include "version.h"