X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=dd776c35146ee4e62dc45b71673d7d778ff04b2d;hb=bbe7e48a8856c3cab7e2dcef34da8111e23a3bc3;hp=a301132090965f2a9f89a08318440566118cdfab;hpb=bf90d4c666cac50308577741e64d7cd42dbaad8d;p=libsigrok.git diff --git a/libsigrok.h b/libsigrok.h index a3011320..dd776c35 100644 --- a/libsigrok.h +++ b/libsigrok.h @@ -41,9 +41,9 @@ extern "C" { * * The correct way to get/use the libsigrok API functions is: * - @code{.c} - #include - @endcode + * @code{.c} + * #include + * @endcode */ /* @@ -63,17 +63,17 @@ extern "C" { */ /** Status/error codes returned by libsigrok functions. */ -enum { - SR_OK = 0, /**< No error. */ - SR_ERR = -1, /**< Generic/unspecified error. */ - SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */ - 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. */ +enum sr_error_code { + SR_OK = 0, /**< No error. */ + SR_ERR = -1, /**< Generic/unspecified error. */ + SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */ + 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 must be open. */ + SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */ + SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */ /* * Note: When adding entries here, don't forget to also update the @@ -81,7 +81,7 @@ enum { */ }; -#define SR_MAX_PROBENAME_LEN 32 +#define SR_MAX_CHANNELNAME_LEN 32 /* Handy little macros */ #define SR_HZ(n) (n) @@ -92,7 +92,7 @@ enum { #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n)) /** libsigrok loglevels. */ -enum { +enum sr_loglevel { SR_LOG_NONE = 0, /**< Output no messages at all. */ SR_LOG_ERR = 1, /**< Output error messages. */ SR_LOG_WARN = 2, /**< Output warnings. */ @@ -132,12 +132,12 @@ enum { #endif /** Type definition for callback function for data reception. */ -typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); +typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data); /** Data types used by sr_config_info(). */ -enum { +enum sr_datatype { SR_T_UINT64 = 10000, - SR_T_CHAR, + SR_T_STRING, SR_T_BOOL, SR_T_FLOAT, SR_T_RATIONAL_PERIOD, @@ -149,7 +149,7 @@ enum { }; /** Value for sr_datafeed_packet.type. */ -enum { +enum sr_packettype { /** Payload is sr_datafeed_header. */ SR_DF_HEADER = 10000, /** End of stream (no further data). */ @@ -169,7 +169,7 @@ enum { }; /** Measured quantity, sr_datafeed_analog.mq. */ -enum { +enum sr_mq { SR_MQ_VOLTAGE = 10000, SR_MQ_CURRENT, SR_MQ_RESISTANCE, @@ -198,7 +198,7 @@ enum { }; /** Unit of measured quantity, sr_datafeed_analog.unit. */ -enum { +enum sr_unit { /** Volt */ SR_UNIT_VOLT = 10000, /** Ampere (current). */ @@ -236,7 +236,7 @@ enum { * a unitless quantity, for example. */ SR_UNIT_UNITLESS, - /** Sound pressure level relative so 20 micropascals. */ + /** Sound pressure level, in decibels, relative to 20 micropascals. */ SR_UNIT_DECIBEL_SPL, /** * Normalized (0 to 1) concentration of a substance or compound with 0 @@ -255,7 +255,7 @@ enum { }; /** Values for sr_datafeed_analog.flags. */ -enum { +enum sr_mqflag { /** Voltage measurement is alternating current (AC). */ SR_MQFLAG_AC = 0x01, /** Voltage measurement is direct current (DC). */ @@ -304,6 +304,59 @@ enum { SR_MQFLAG_AVG = 0x40000, }; +enum sr_trigger_matches { + SR_TRIGGER_ZERO = 1, + SR_TRIGGER_ONE, + SR_TRIGGER_RISING, + SR_TRIGGER_FALLING, + SR_TRIGGER_EDGE, + SR_TRIGGER_OVER, + SR_TRIGGER_UNDER, +}; + +/** The representation of a trigger, consisting of one or more stages + * containing one or more matches on a channel. + */ +struct sr_trigger { + /** A name for this trigger. This may be NULL if none is needed. */ + char *name; + /** List of pointers to struct sr_trigger_stage. */ + GSList *stages; +}; + +/** A trigger stage. */ +struct sr_trigger_stage { + /** Starts at 0. */ + int stage; + /** List of pointers to struct sr_trigger_match. */ + GSList *matches; +}; + +/** A channel to match and what to match it on. */ +struct sr_trigger_match { + /** The channel to trigger on. */ + struct sr_channel *channel; + /** The trigger match to use. + * For logic channels, only the following matches may be used: + * SR_TRIGGER_ZERO + * SR_TRIGGER_ONE + * SR_TRIGGER_RISING + * SR_TRIGGER_FALLING + * SR_TRIGGER_EDGE + * + * For analog channels, only these matches may be used: + * SR_TRIGGER_RISING + * SR_TRIGGER_FALLING + * SR_TRIGGER_OVER + * SR_TRIGGER_UNDER + * + */ + int match; + /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER, + * this contains the value to compare against. */ + float value; +}; + /** * @struct sr_context * Opaque structure representing a libsigrok context. @@ -340,8 +393,8 @@ struct sr_datafeed_logic { /** Analog datafeed payload for type SR_DF_ANALOG. */ struct sr_datafeed_analog { - /** The probes for which data is included in this packet. */ - GSList *probes; + /** The channels for which data is included in this packet. */ + GSList *channels; /** Number of samples in data */ int num_samples; /** Measured quantity (voltage, current, temperature, and so on). @@ -352,7 +405,7 @@ struct sr_datafeed_analog { /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */ uint64_t mqflags; /** The analog value(s). The data is interleaved according to - * the probes list. */ + * the channels list. */ float *data; }; @@ -430,24 +483,21 @@ struct sr_input_format { /** Output (file) format struct. */ struct sr_output { - /** - * A pointer to this output format's 'struct sr_output_format'. - * The frontend can use this to call the module's callbacks. - */ + /** A pointer to this output's format. */ struct sr_output_format *format; /** * The device for which this output module is creating output. This - * can be used by the module to find out probe names and numbers. + * can be used by the module to find out channel names and numbers. */ - struct sr_dev_inst *sdi; + const struct sr_dev_inst *sdi; /** * An optional parameter which the frontend can pass in to the * output module. How the string is interpreted is entirely up to * the module. */ - char *param; + GHashTable *params; /** * A generic pointer which can be used by the module to keep internal @@ -479,9 +529,6 @@ struct sr_output_format { */ char *description; - /** Datafeed type, SR_DF_HEADER, etc. */ - int df_type; - /** * This function is called once, at the beginning of an output stream. * @@ -499,72 +546,6 @@ struct sr_output_format { */ int (*init) (struct sr_output *o); - /** - * Whenever a chunk of data comes in, it will be passed to the - * output module via this function. The data_in and - * length_in values refers to this data; the module - * must not alter or g_free() this buffer. - * - * The function must allocate a buffer for storing its output, and - * pass along a pointer to this buffer in the data_out - * parameter, as well as storing the length of the buffer in - * length_out. The calling frontend will g_free() - * this buffer when it's done with it. - * - * IMPORTANT: The memory allocation much happen using a glib memory - * allocation call (not a "normal" malloc) since g_free() will be - * used to free the memory! - * - * If there is no output, this function MUST store NULL in the - * data_out parameter, so the caller knows not to try - * and g_free() it. - * - * 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. - * @param length_in Length of the input. - * @param data_out Pointer to the allocated output buffer. - * @param length_out Length (in bytes) of the output. - * - * @retval SR_OK Success - * @retval other Negative error code. - */ - int (*data) (struct sr_output *o, const uint8_t *data_in, - uint64_t length_in, uint8_t **data_out, - uint64_t *length_out); - - /** - * This function is called when an event occurs in the datafeed - * which the output module may need to be aware of. No data is - * passed in, only the fact that the event occurs. The following - * events can currently be passed in: - * - * - SR_DF_TRIGGER: At this point in the datafeed, the trigger - * matched. The output module may mark this in some way, e.g. by - * plotting a red line on a graph. - * - * - SR_DF_END: This marks the end of the datafeed. No more calls - * into the output module will be done, so this is a good time to - * free up any memory used to keep state, for example. - * - * Any output generated by this function must have a reference to - * it stored in the data_out and length_out - * parameters, or NULL if no output was generated. - * - * 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. - * @param data_out Pointer to the allocated output buffer. - * @param length_out Length (in bytes) of the output. - * - * @retval SR_OK Success - * @retval other Negative error code. - */ - int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, - uint64_t *length_out); - /** * This function is passed a copy of every packed in the data feed. * Any output generated by the output module in response to the @@ -583,7 +564,7 @@ struct sr_output_format { * @retval SR_OK Success * @retval other Negative error code. */ - int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi, + int (*receive) (struct sr_output *o, const struct sr_datafeed_packet *packet, GString **out); /** @@ -597,35 +578,33 @@ struct sr_output_format { int (*cleanup) (struct sr_output *o); }; -/** Constants for probe type. */ -enum { - /** Probe type is logic probe. */ - SR_PROBE_LOGIC = 10000, - /** Probe type is analog probe. */ - SR_PROBE_ANALOG, +/** Constants for channel type. */ +enum sr_channeltype { + /** Channel type is logic channel. */ + SR_CHANNEL_LOGIC = 10000, + /** Channel type is analog channel. */ + SR_CHANNEL_ANALOG, }; -/** Information on single probe. */ -struct sr_probe { - /** Number of probes, starting at 0. @deprecated The index field - * will go: use g_slist_length(sdi->probes) instead. */ +/** Information on single channel. */ +struct sr_channel { + /** The index of this channel, starting at 0. Logic channels will + * be encoded according to this index in SR_DF_LOGIC packets. */ int index; - /** Probe type (SR_PROBE_LOGIC, ...) */ + /** Channel type (SR_CHANNEL_LOGIC, ...) */ int type; - /** Is this probe enabled? */ + /** Is this channel enabled? */ gboolean enabled; - /** Name of probe. */ + /** Name of channel. */ char *name; - /** Trigger string, format like used by sigrok-cli */ - char *trigger; }; -/** Structure for groups of probes that have common properties. */ -struct sr_probe_group { - /** Name of the probe group. */ +/** Structure for groups of channels that have common properties. */ +struct sr_channel_group { + /** Name of the channel group. */ char *name; - /** List of sr_probe structs of the probes belonging to this group. */ - GSList *probes; + /** List of sr_channel structs of the channels belonging to this group. */ + GSList *channels; /** Private data for driver use. */ void *priv; }; @@ -642,7 +621,7 @@ struct sr_config { struct sr_config_info { /** Config key like SR_CONF_CONN, etc. */ int key; - /** Data type like SR_T_CHAR, etc. */ + /** Data type like SR_T_STRING, etc. */ int datatype; /** Id string, e.g. "serialcomm". */ char *id; @@ -653,7 +632,7 @@ struct sr_config_info { }; /** Constants for device classes */ -enum { +enum sr_configkey { /*--- Device classes ------------------------------------------------*/ /** The device can act as logic analyzer. */ @@ -683,6 +662,9 @@ enum { /** The device can demodulate signals. */ SR_CONF_DEMODULATOR, + /** Programmable power supply. */ + SR_CONF_POWER_SUPPLY, + /*--- Driver scan options -------------------------------------------*/ /** @@ -756,8 +738,8 @@ enum { /** Coupling. */ SR_CONF_COUPLING, - /** Trigger types. */ - SR_CONF_TRIGGER_TYPE, + /** Trigger matches. */ + SR_CONF_TRIGGER_MATCH, /** The device supports setting its sample interval, in ms. */ SR_CONF_SAMPLE_INTERVAL, @@ -801,11 +783,38 @@ enum { */ SR_CONF_CENTER_FREQUENCY, - /** The device supports setting the number of logic probes. */ - SR_CONF_NUM_LOGIC_PROBES, + /** The device supports setting the number of logic channels. */ + SR_CONF_NUM_LOGIC_CHANNELS, + + /** The device supports setting the number of analog channels. */ + SR_CONF_NUM_ANALOG_CHANNELS, + + /** Output voltage. */ + SR_CONF_OUTPUT_VOLTAGE, - /** The device supports setting the number of analog probes. */ - SR_CONF_NUM_ANALOG_PROBES, + /** Maximum output voltage. */ + SR_CONF_OUTPUT_VOLTAGE_MAX, + + /** Output current. */ + SR_CONF_OUTPUT_CURRENT, + + /** Maximum output current. */ + SR_CONF_OUTPUT_CURRENT_MAX, + + /** Enabling/disabling output. */ + SR_CONF_OUTPUT_ENABLED, + + /** Channel output configuration. */ + SR_CONF_OUTPUT_CHANNEL, + + /** Over-voltage protection (OVP) */ + SR_CONF_OVER_VOLTAGE_PROTECTION, + + /** Over-current protection (OCP) */ + SR_CONF_OVER_CURRENT_PROTECTION, + + /** Choice of clock edge for external clock ("r" or "f"). */ + SR_CONF_CLOCK_EDGE, /*--- Special stuff -------------------------------------------------*/ @@ -827,7 +836,8 @@ enum { /** Power off the device. */ SR_CONF_POWER_OFF, - /** Data source for acquisition. If not present, acquisition from + /** + * 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. * @@ -836,7 +846,8 @@ enum { * 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. */ + * is always the default. + */ SR_CONF_DATA_SOURCE, /*--- Acquisition modes ---------------------------------------------*/ @@ -869,6 +880,12 @@ enum { /** The device has internal storage, into which data is logged. This * starts or stops the internal logging. */ SR_CONF_DATALOG, + + /** Device mode for multi-function devices. */ + SR_CONF_DEVICE_MODE, + + /** Self test mode. */ + SR_CONF_TEST_MODE, }; /** Device instance data @@ -888,10 +905,10 @@ struct sr_dev_inst { char *model; /** Device version. */ char *version; - /** List of probes. */ - GSList *probes; - /** List of sr_probe_group structs */ - GSList *probe_groups; + /** List of channels. */ + GSList *channels; + /** List of sr_channel_group structs */ + GSList *channel_groups; /** Device instance connection data (used?) */ void *conn; /** Device instance private data (used?) */ @@ -899,7 +916,7 @@ struct sr_dev_inst { }; /** Types of device instance, struct sr_dev_inst.type */ -enum { +enum sr_dev_inst_type { /** Device instance type for USB devices. */ SR_INST_USB = 10000, /** Device instance type for serial port devices. */ @@ -909,7 +926,7 @@ enum { }; /** Device instance status, struct sr_dev_inst.status */ -enum { +enum sr_dev_inst_status { /** The device instance was not found. */ SR_ST_NOT_FOUND = 10000, /** The device instance was found, but is still booting. */ @@ -922,48 +939,73 @@ enum { SR_ST_STOPPING, }; -/** Device driver data */ +/** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */ struct sr_dev_driver { /* Driver-specific */ - /** Driver name */ + /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */ char *name; - /** Long name, e.g. device name. */ + /** Long name. Verbose driver name shown to user. */ char *longname; /** API version (currently 1). */ int api_version; - /** Init driver */ + /** Called when driver is loaded, e.g. program startup. */ int (*init) (struct sr_context *sr_ctx); - /** Free driver */ + /** Called before driver is unloaded. + * Driver must free all resouces held by it. */ int (*cleanup) (void); - /** Scan for devices */ + /** Scan for devices. Driver should do all initialisation required. + * Can be called several times, e.g. with different port options. + * \retval NULL Error or no devices found. + * \retval other GSList of a struct sr_dev_inst for each device. + * Must be freed by caller! + */ GSList *(*scan) (GSList *options); - /** Get device list */ + /** Get list of device instances the driver knows about. + * \returns NULL or GSList of a struct sr_dev_inst for each device. + * Must not be freed by caller! + */ GSList *(*dev_list) (void); + /** Clear list of devices the driver knows about. */ int (*dev_clear) (void); + /** Query value of a configuration key in driver or given device instance. + * @see sr_config_get(). + */ int (*config_get) (int id, GVariant **data, const struct sr_dev_inst *sdi, - const struct sr_probe_group *probe_group); + const struct sr_channel_group *cg); + /** Set value of a configuration key in driver or a given device instance. + * @see sr_config_set(). */ int (*config_set) (int id, GVariant *data, const struct sr_dev_inst *sdi, - const struct sr_probe_group *probe_group); + const struct sr_channel_group *cg); + /** Channel status change. + * @see sr_dev_channel_enable(). */ + int (*config_channel_set) (const struct sr_dev_inst *sdi, + struct sr_channel *ch, unsigned int changes); + /** Apply configuration settings to the device hardware. + * @see sr_config_commit().*/ + int (*config_commit) (const struct sr_dev_inst *sdi); + /** List all possible values for a configuration key in a device instance. + * @see sr_config_list(). + */ int (*config_list) (int info_id, GVariant **data, const struct sr_dev_inst *sdi, - const struct sr_probe_group *probe_group); + const struct sr_channel_group *cg); /* Device-specific */ /** Open device */ int (*dev_open) (struct sr_dev_inst *sdi); /** Close device */ int (*dev_close) (struct sr_dev_inst *sdi); - /** Start data aquisition. */ + /** Begin data acquisition on the specified device. */ int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, void *cb_data); - /** Stop data aquisition. */ + /** End data acquisition on the specified device. */ int (*dev_acquisition_stop) (struct sr_dev_inst *sdi, void *cb_data); /* Dynamic */ - /** Device driver private data */ + /** Device driver private data. Initialized by init(). */ void *priv; };