libsigrok/libsigrok.h

1042 lines
30 KiB
C
Raw Normal View History

/*
2013-04-23 20:24:30 +00:00
* This file is part of the libsigrok project.
*
2013-03-24 10:21:00 +00:00
* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
*
* 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
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
2013-12-10 16:39:31 +00:00
#ifndef LIBSIGROK_LIBSIGROK_H
#define LIBSIGROK_LIBSIGROK_H
#include <stdio.h>
#include <sys/time.h>
#include <stdint.h>
#include <inttypes.h>
#include <glib.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @file
*
* The public libsigrok header file to be used by frontends.
*
* This is the only file that libsigrok users (frontends) are supposed to
2013-04-06 17:18:37 +00:00
* 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:
*
2013-11-22 19:40:52 +00:00
@code{.c}
#include <libsigrok/libsigrok.h>
@endcode
*/
/*
* All possible return codes of libsigrok functions must be listed here.
* Functions should never return hardcoded numbers as status, but rather
* use these enum values. All error codes are negative numbers.
*
* The error codes are globally unique in libsigrok, i.e. if one of the
* libsigrok functions returns a "malloc error" it must be exactly the same
* return value as used by all other functions to indicate "malloc error".
* There must be no functions which indicate two different errors via the
* same return code.
*
* Also, for compatibility reasons, no defined return codes are ever removed
* or reused for different errors later. You can only add new entries and
* return codes, but never remove or redefine existing ones.
*/
/** 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. */
2013-06-13 12:23:06 +00:00
SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */
SR_ERR_PROBE_GROUP= -9, /**< A probe group must be specified. */
2013-04-27 08:49:52 +00:00
/*
* Note: When adding entries here, don't forget to also update the
* sr_strerror() and sr_strerror_name() functions in error.c.
*/
};
2012-02-13 01:16:32 +00:00
#define SR_MAX_PROBENAME_LEN 32
/* Handy little macros */
2011-02-22 17:05:16 +00:00
#define SR_HZ(n) (n)
#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) ((uint64_t)(1000000000ULL) / (n))
2011-01-10 17:14:26 +00:00
/** libsigrok loglevels. */
enum {
SR_LOG_NONE = 0, /**< Output no messages at all. */
SR_LOG_ERR = 1, /**< Output error messages. */
SR_LOG_WARN = 2, /**< Output warnings. */
SR_LOG_INFO = 3, /**< Output informational messages. */
SR_LOG_DBG = 4, /**< Output debug messages. */
SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
};
/*
* Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
*
* Variables and functions marked 'static' are private already and don't
* need SR_PRIV. However, functions which are not static (because they need
* to be used in other libsigrok-internal files) but are also not meant to
* be part of the public libsigrok API, must use SR_PRIV.
*
* This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
*
* This feature is not available on MinGW/Windows, as it is a feature of
* ELF files and MinGW/Windows uses PE files.
*
* Details: http://gcc.gnu.org/wiki/Visibility
*/
/* Marks public libsigrok API symbols. */
#ifndef _WIN32
#define SR_API __attribute__((visibility("default")))
#else
#define SR_API
#endif
/* Marks private, non-public libsigrok symbols (not part of the API). */
#ifndef _WIN32
#define SR_PRIV __attribute__((visibility("hidden")))
#else
#define SR_PRIV
#endif
2013-11-22 19:40:52 +00:00
/** Type definition for callback function for data reception. */
2012-02-29 21:32:34 +00:00
typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
2011-01-10 12:47:24 +00:00
2013-01-22 10:18:18 +00:00
/** Data types used by sr_config_info(). */
enum {
SR_T_UINT64 = 10000,
2011-01-30 16:58:41 +00:00
SR_T_CHAR,
SR_T_BOOL,
SR_T_FLOAT,
SR_T_RATIONAL_PERIOD,
SR_T_RATIONAL_VOLT,
SR_T_KEYVALUE,
SR_T_UINT64_RANGE,
SR_T_DOUBLE_RANGE,
SR_T_INT32,
};
/** Value for sr_datafeed_packet.type. */
enum {
/** Payload is sr_datafeed_header. */
SR_DF_HEADER = 10000,
/** End of stream (no further data). */
SR_DF_END,
/** Payload is struct sr_datafeed_meta */
SR_DF_META,
/** The trigger matched at this point in the data feed. No payload. */
SR_DF_TRIGGER,
/** Payload is struct sr_datafeed_logic. */
SR_DF_LOGIC,
/** Payload is struct sr_datafeed_analog. */
SR_DF_ANALOG,
/** Beginning of frame. No payload. */
SR_DF_FRAME_BEGIN,
/** End of frame. No payload. */
SR_DF_FRAME_END,
};
2013-11-22 19:40:52 +00:00
/** Measured quantity, sr_datafeed_analog.mq. */
enum {
SR_MQ_VOLTAGE = 10000,
SR_MQ_CURRENT,
SR_MQ_RESISTANCE,
SR_MQ_CAPACITANCE,
SR_MQ_TEMPERATURE,
SR_MQ_FREQUENCY,
/** Duty cycle, e.g. on/off ratio. */
SR_MQ_DUTY_CYCLE,
/** Continuity test. */
SR_MQ_CONTINUITY,
SR_MQ_PULSE_WIDTH,
SR_MQ_CONDUCTANCE,
/** Electrical power, usually in W, or dBm. */
SR_MQ_POWER,
/** Gain (a transistor's gain, or hFE, for example). */
SR_MQ_GAIN,
/** Logarithmic representation of sound pressure relative to a
* reference value. */
SR_MQ_SOUND_PRESSURE_LEVEL,
/** Carbon monoxide level */
SR_MQ_CARBON_MONOXIDE,
/** Humidity */
SR_MQ_RELATIVE_HUMIDITY,
/** Time */
SR_MQ_TIME,
};
2013-11-22 19:40:52 +00:00
/** Unit of measured quantity, sr_datafeed_analog.unit. */
enum {
/** Volt */
SR_UNIT_VOLT = 10000,
/** Ampere (current). */
SR_UNIT_AMPERE,
/** Ohm (resistance). */
SR_UNIT_OHM,
/** Farad (capacity). */
SR_UNIT_FARAD,
/** Kelvin (temperature). */
SR_UNIT_KELVIN,
/** Degrees Celsius (temperature). */
SR_UNIT_CELSIUS,
/** Degrees Fahrenheit (temperature). */
SR_UNIT_FAHRENHEIT,
/** Hertz (frequency, 1/s, [Hz]). */
SR_UNIT_HERTZ,
/** Percent value. */
SR_UNIT_PERCENTAGE,
/** Boolean value. */
SR_UNIT_BOOLEAN,
/** Time in seconds. */
SR_UNIT_SECOND,
/** Unit of conductance, the inverse of resistance. */
SR_UNIT_SIEMENS,
/**
* An absolute measurement of power, in decibels, referenced to
* 1 milliwatt (dBu).
*/
SR_UNIT_DECIBEL_MW,
2012-10-16 21:28:04 +00:00
/** Voltage in decibel, referenced to 1 volt (dBV). */
SR_UNIT_DECIBEL_VOLT,
/**
* Measurements that intrinsically do not have units attached, such
2012-10-16 21:28:04 +00:00
* as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
* a unitless quantity, for example.
*/
SR_UNIT_UNITLESS,
/** Sound pressure level relative so 20 micropascals. */
SR_UNIT_DECIBEL_SPL,
/**
* Normalized (0 to 1) concentration of a substance or compound with 0
* representing a concentration of 0%, and 1 being 100%. This is
* represented as the fraction of number of particles of the substance.
*/
SR_UNIT_CONCENTRATION,
/** Revolutions per minute. */
SR_UNIT_REVOLUTIONS_PER_MINUTE,
/** Apparent power [VA]. */
SR_UNIT_VOLT_AMPERE,
/** Real power [W]. */
SR_UNIT_WATT,
/** Consumption [Wh]. */
SR_UNIT_WATT_HOUR,
};
/** Values for sr_datafeed_analog.flags. */
enum {
/** Voltage measurement is alternating current (AC). */
SR_MQFLAG_AC = 0x01,
/** Voltage measurement is direct current (DC). */
SR_MQFLAG_DC = 0x02,
/** This is a true RMS measurement. */
SR_MQFLAG_RMS = 0x04,
/** Value is voltage drop across a diode, or NAN. */
SR_MQFLAG_DIODE = 0x08,
2012-10-21 23:13:36 +00:00
/** Device is in "hold" mode (repeating the last measurement). */
SR_MQFLAG_HOLD = 0x10,
/** Device is in "max" mode, only updating upon a new max value. */
SR_MQFLAG_MAX = 0x20,
/** Device is in "min" mode, only updating upon a new min value. */
SR_MQFLAG_MIN = 0x40,
/** Device is in autoranging mode. */
SR_MQFLAG_AUTORANGE = 0x80,
/** Device is in relative mode. */
SR_MQFLAG_RELATIVE = 0x100,
/** Sound pressure level is A-weighted in the frequency domain,
2012-11-11 01:11:49 +00:00
* according to IEC 61672:2003. */
SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
/** Sound pressure level is C-weighted in the frequency domain,
2012-11-11 01:11:49 +00:00
* according to IEC 61672:2003. */
SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
/** Sound pressure level is Z-weighted (i.e. not at all) in the
2012-11-11 01:11:49 +00:00
* frequency domain, according to IEC 61672:2003. */
SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
/** Sound pressure level is not weighted in the frequency domain,
* albeit without standards-defined low and high frequency limits. */
SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
/** Sound pressure level measurement is S-weighted (1s) in the
* time domain. */
SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
/** Sound pressure level measurement is F-weighted (125ms) in the
* time domain. */
SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
/** Sound pressure level is time-averaged (LAT), also known as
* Equivalent Continuous A-weighted Sound Level (LEQ). */
SR_MQFLAG_SPL_LAT = 0x8000,
/** 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,
2013-12-11 23:18:00 +00:00
/** Device is in "avg" mode, averaging upon each new value. */
SR_MQFLAG_AVG = 0x40000,
};
/**
* @struct sr_context
* Opaque structure representing a libsigrok context.
*
* None of the fields of this structure are meant to be accessed directly.
*
* @see sr_init(), sr_exit().
*/
struct sr_context;
2013-11-22 19:40:52 +00:00
/** Packet in a sigrok data feed. */
2011-01-29 16:03:26 +00:00
struct sr_datafeed_packet {
uint16_t type;
const void *payload;
};
2013-11-22 19:40:52 +00:00
/** Header of a sigrok data feed. */
2011-01-29 16:03:26 +00:00
struct sr_datafeed_header {
int feed_version;
struct timeval starttime;
};
2013-11-22 19:40:52 +00:00
/** Datafeed payload for type SR_DF_META. */
struct sr_datafeed_meta {
GSList *config;
};
2013-11-22 19:40:52 +00:00
/** Logic datafeed payload for type SR_DF_LOGIC. */
struct sr_datafeed_logic {
uint64_t length;
uint16_t unitsize;
2011-06-19 12:28:50 +00:00
void *data;
};
2013-11-22 19:40:52 +00:00
/** Analog datafeed payload for type SR_DF_ANALOG. */
struct sr_datafeed_analog {
2013-01-25 14:16:39 +00:00
/** The probes for which data is included in this packet. */
GSList *probes;
/** Number of samples in data */
int num_samples;
2013-11-22 19:40:52 +00:00
/** Measured quantity (voltage, current, temperature, and so on).
* Use SR_MQ_VOLTAGE, ... */
int mq;
2013-11-22 19:40:52 +00:00
/** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
int unit;
2013-11-22 19:40:52 +00:00
/** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
uint64_t mqflags;
2013-01-25 14:16:39 +00:00
/** The analog value(s). The data is interleaved according to
* the probes list. */
float *data;
};
/** Input (file) format struct. */
struct sr_input {
/**
* A pointer to this input format's 'struct sr_input_format'.
* The frontend can use this to call the module's callbacks.
*/
struct sr_input_format *format;
GHashTable *param;
struct sr_dev_inst *sdi;
void *internal;
};
2013-11-22 19:40:52 +00:00
/** Input (file) format driver. */
struct sr_input_format {
/** The unique ID for this input format. Must not be NULL. */
char *id;
/**
* A short description of the input format, which can (for example)
* be displayed to the user by frontends. Must not be NULL.
*/
char *description;
/**
* Check if this input module can load and parse the specified file.
*
2013-11-22 19:40:52 +00:00
* @param[in] filename The name (and path) of the file to check.
*
2013-11-22 19:40:52 +00:00
* @retval TRUE This module knows the format.
* @retval FALSE This module does not know the format.
*/
int (*format_match) (const char *filename);
/**
* Initialize the input module.
*
* @param in A pointer to a valid 'struct sr_input' that the caller
* has to allocate and provide to this function. It is also
* the responsibility of the caller to free it later.
2013-11-22 19:40:52 +00:00
* @param[in] filename The name (and path) of the file to use.
*
2013-11-22 19:40:52 +00:00
* @retval SR_OK Success
* @retval other Negative error code.
*/
int (*init) (struct sr_input *in, const char *filename);
/**
* Load a file, parsing the input according to the file's format.
*
* This function will send datafeed packets to the session bus, so
* the calling frontend must have registered its session callbacks
* beforehand.
*
* The packet types sent across the session bus by this function must
* include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
* type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
* if appropriate.
*
* @param in A pointer to a valid 'struct sr_input' that the caller
* has to allocate and provide to this function. It is also
* the responsibility of the caller to free it later.
* @param filename The name (and path) of the file to use.
*
2013-11-22 19:40:52 +00:00
* @retval SR_OK Success
* @retval other Negative error code.
*/
int (*loadfile) (struct sr_input *in, const char *filename);
};
/** 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.
*/
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.
*/
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;
/**
* A generic pointer which can be used by the module to keep internal
* state between calls into its callback functions.
*
* For example, the module might store a pointer to a chunk of output
* there, and only flush it when it reaches a certain size.
*/
void *internal;
};
2013-11-22 19:40:52 +00:00
/** Output (file) format driver. */
struct sr_output_format {
/**
* A unique ID for this output format. Must not be NULL.
*
* It can be used by frontends to select this output format for use.
*
* For example, calling sigrok-cli with <code>-O hex</code> will
* select the hexadecimal text output format.
*/
char *id;
/**
* A short description of the output format. Must not be NULL.
*
* This can be displayed by frontends, e.g. when selecting the output
* format for saving a file.
*/
char *description;
/** Datafeed type, SR_DF_HEADER, etc. */
int df_type;
/**
* This function is called once, at the beginning of an output stream.
*
* The device struct will be available in the output struct passed in,
* as well as the param field -- which may be NULL or an empty string,
* if no parameter was passed.
*
* The module can use this to initialize itself, create a struct for
* keeping state and storing it in the <code>internal</code> field.
*
* @param o Pointer to the respective 'struct sr_output'.
*
2013-11-22 19:40:52 +00:00
* @retval SR_OK Success
* @retval other Negative error code.
*/
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 <code>data_in</code> and
* <code>length_in</code> 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 <code>data_out</code>
* parameter, as well as storing the length of the buffer in
* <code>length_out</code>. 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
* <code>data_out</code> 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.
*
2013-11-22 19:40:52 +00:00
* @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 <code>data_out</code> and <code>length_out</code>
* 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.
*
2013-11-22 19:40:52 +00:00
* @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
* packet should be returned in a newly allocated GString
* <code>out</code>, which will be freed by the caller.
*
* Packets not of interest to the output module can just be ignored,
* and the <code>out</code> 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.
*
2013-11-22 19:40:52 +00:00
* @retval SR_OK Success
* @retval other Negative error code.
*/
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.
*
2013-11-22 19:40:52 +00:00
* @retval SR_OK Success
* @retval other Negative error code.
*/
int (*cleanup) (struct sr_output *o);
};
2013-11-22 19:40:52 +00:00
/** Constants for probe type. */
enum {
/** Probe type is logic probe. */
SR_PROBE_LOGIC = 10000,
/** Probe type is analog probe. */
SR_PROBE_ANALOG,
};
2013-11-22 19:40:52 +00:00
/** Information on single probe. */
2011-02-08 16:47:38 +00:00
struct sr_probe {
/** Number of probes, starting at 0. */
int index;
/** Probe type (SR_PROBE_LOGIC, ...) */
int type;
/** Is this probe enabled? */
gboolean enabled;
/** Name of probe. */
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. */
char *name;
/** List of sr_probe structs of the probes belonging to this group. */
GSList *probes;
/** Private data for driver use. */
2013-04-20 22:45:01 +00:00
void *priv;
};
2013-11-22 19:40:52 +00:00
/** Used for setting or getting value of a config item. */
struct sr_config {
/** Config key like SR_CONF_CONN, etc. */
int key;
/** Key-specific data. */
GVariant *data;
};
2013-11-22 19:40:52 +00:00
/** Information about a config key. */
struct sr_config_info {
/** Config key like SR_CONF_CONN, etc. */
int key;
/** Data type like SR_T_CHAR, etc. */
int datatype;
/** Id string, e.g. "serialcomm". */
char *id;
/** Name, e.g. "Serial communication". */
char *name;
/** Verbose description (unused currently). */
char *description;
};
2013-11-22 19:40:52 +00:00
/** Constants for device classes */
enum {
/*--- Device classes ------------------------------------------------*/
/** The device can act as logic analyzer. */
SR_CONF_LOGIC_ANALYZER = 10000,
2011-01-15 04:11:40 +00:00
/** The device can act as an oscilloscope. */
SR_CONF_OSCILLOSCOPE,
2012-07-01 20:37:15 +00:00
/** The device can act as a multimeter. */
SR_CONF_MULTIMETER,
2012-01-21 14:34:11 +00:00
2012-07-01 20:37:15 +00:00
/** The device is a demo device. */
SR_CONF_DEMO_DEV,
2012-01-21 14:34:11 +00:00
/** The device can act as a sound level meter. */
SR_CONF_SOUNDLEVELMETER,
2012-07-01 20:37:15 +00:00
2012-12-04 22:58:03 +00:00
/** The device can measure temperature. */
SR_CONF_THERMOMETER,
2012-12-04 22:58:03 +00:00
/** The device can measure humidity. */
SR_CONF_HYGROMETER,
2012-12-04 22:58:03 +00:00
/** The device can measure energy consumption. */
SR_CONF_ENERGYMETER,
/** The device can demodulate signals. */
SR_CONF_DEMODULATOR,
/** Programmable power supply. */
SR_CONF_POWER_SUPPLY,
/*--- Driver scan options -------------------------------------------*/
/**
* Specification on how to connect to a device.
*
* In combination with SR_CONF_SERIALCOMM, this is a serial port in
* the form which makes sense to the OS (e.g., /dev/ttyS0).
* Otherwise this specifies a USB device, either in the form of
* @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
* @verbatim <vendorid>.<productid> @endverbatim
* (hexadecimal, e.g. 1d6b.0001).
*/
SR_CONF_CONN = 20000,
/**
* Serial communication specification, in the form:
*
* @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
*
* Example: 9600/8n1
*
* The string may also be followed by one or more special settings,
* in the form "/key=value". Supported keys and their values are:
*
* rts 0,1 set the port's RTS pin to low or high
* dtr 0,1 set the port's DTR pin to low or high
* flow 0 no flow control
* 1 hardware-based (RTS/CTS) flow control
* 2 software-based (XON/XOFF) flow control
*
* This is always an optional parameter, since a driver typically
* knows the speed at which the device wants to communicate.
*/
SR_CONF_SERIALCOMM,
2012-07-01 20:37:15 +00:00
/*--- Device configuration ------------------------------------------*/
/** The device supports setting its samplerate, in Hz. */
SR_CONF_SAMPLERATE = 30000,
/** The device supports setting a pre/post-trigger capture ratio. */
SR_CONF_CAPTURE_RATIO,
/** The device supports setting a pattern (pattern generator mode). */
SR_CONF_PATTERN_MODE,
/** The device supports Run Length Encoding. */
SR_CONF_RLE,
/** The device supports setting trigger slope. */
SR_CONF_TRIGGER_SLOPE,
/** Trigger source. */
SR_CONF_TRIGGER_SOURCE,
/** Horizontal trigger position. */
SR_CONF_HORIZ_TRIGGERPOS,
/** Buffer size. */
SR_CONF_BUFFERSIZE,
/** Time base. */
SR_CONF_TIMEBASE,
/** Filter. */
SR_CONF_FILTER,
/** Volts/div. */
SR_CONF_VDIV,
/** Coupling. */
SR_CONF_COUPLING,
/** 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 an external clock. */
SR_CONF_EXTERNAL_CLOCK,
/**
* The device supports swapping channels. Typical this is between
* buffered and unbuffered channels.
*/
SR_CONF_SWAP,
/** Center frequency.
* The input signal is downmixed by this frequency before the ADC
* anti-aliasing filter.
*/
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 analog probes. */
SR_CONF_NUM_ANALOG_PROBES,
/** Output voltage. */
SR_CONF_OUTPUT_VOLTAGE,
/** 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 -------------------------------------------------*/
/** Scan options supported by the driver. */
2013-01-25 14:16:39 +00:00
SR_CONF_SCAN_OPTIONS = 40000,
/** Device options for a particular device. */
SR_CONF_DEVICE_OPTIONS,
/** Session filename. */
2013-01-25 14:16:39 +00:00
SR_CONF_SESSIONFILE,
/** The device supports specifying a capturefile to inject. */
SR_CONF_CAPTUREFILE,
2011-01-15 04:11:40 +00:00
/** The device supports specifying the capturefile unit size. */
SR_CONF_CAPTURE_UNITSIZE,
/** Power off the device. */
SR_CONF_POWER_OFF,
2014-01-09 11:36:05 +00:00
/**
* Data source for acquisition. If not present, acquisition from
2013-06-19 10:18:00 +00:00
* 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
2014-01-09 11:36:05 +00:00
* is always the default.
*/
2013-06-19 10:18:00 +00:00
SR_CONF_DATA_SOURCE,
/*--- Acquisition modes ---------------------------------------------*/
/**
2012-10-21 23:13:36 +00:00
* The device supports setting a sample time limit (how long
* the sample acquisition should run, in ms).
*/
SR_CONF_LIMIT_MSEC = 50000,
/**
2012-10-21 23:13:36 +00:00
* The device supports setting a sample number limit (how many
* samples should be acquired).
*/
SR_CONF_LIMIT_SAMPLES,
2012-04-30 17:55:06 +00:00
/**
2012-10-21 23:13:36 +00:00
* The device supports setting a frame limit (how many
* frames should be acquired).
2012-04-30 17:55:06 +00:00
*/
SR_CONF_LIMIT_FRAMES,
2012-04-30 17:55:06 +00:00
/**
2012-10-21 23:13:36 +00:00
* The device supports continuous sampling. Neither a time limit
* nor a sample number limit has to be supplied, it will just acquire
* samples continuously, until explicitly stopped by a certain command.
*/
SR_CONF_CONTINUOUS,
2013-03-11 15:35:18 +00:00
/** The device has internal storage, into which data is logged. This
* starts or stops the internal logging. */
SR_CONF_DATALOG,
};
/** Device instance data
2013-11-22 19:40:52 +00:00
*/
struct sr_dev_inst {
/** Device driver. */
struct sr_dev_driver *driver;
/** Index of device in driver. */
int index;
/** Device instance status. SR_ST_NOT_FOUND, etc. */
int status;
/** Device instance type. SR_INST_USB, etc. */
int inst_type;
/** Device vendor. */
char *vendor;
/** Device model. */
char *model;
/** Device version. */
char *version;
/** List of probes. */
GSList *probes;
/** List of sr_probe_group structs */
GSList *probe_groups;
/** Device instance connection data (used?) */
void *conn;
/** Device instance private data (used?) */
void *priv;
};
2013-11-22 19:40:52 +00:00
/** Types of device instance, struct sr_dev_inst.type */
enum {
/** Device instance type for USB devices. */
SR_INST_USB = 10000,
/** Device instance type for serial port devices. */
SR_INST_SERIAL,
/** Device instance type for SCPI devices. */
SR_INST_SCPI,
};
2013-11-22 19:40:52 +00:00
/** Device instance status, struct sr_dev_inst.status */
enum {
/** The device instance was not found. */
SR_ST_NOT_FOUND = 10000,
/** The device instance was found, but is still booting. */
2011-01-30 16:58:41 +00:00
SR_ST_INITIALIZING,
/** The device instance is live, but not in use. */
2011-01-30 16:58:41 +00:00
SR_ST_INACTIVE,
/** The device instance is actively in use in a session. */
2011-01-30 16:58:41 +00:00
SR_ST_ACTIVE,
/** The device is winding down its session. */
SR_ST_STOPPING,
};
2014-02-05 13:32:21 +00:00
/** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
2012-02-28 22:52:30 +00:00
struct sr_dev_driver {
/* Driver-specific */
2014-02-05 13:32:21 +00:00
/** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
char *name;
2014-02-05 13:32:21 +00:00
/** Long name. Verbose driver name shown to user. */
char *longname;
/** API version (currently 1). */
int api_version;
2014-02-05 13:32:21 +00:00
/** Called when driver is loaded, e.g. program startup. */
int (*init) (struct sr_context *sr_ctx);
2014-02-05 13:32:21 +00:00
/** Called before driver is unloaded.
* Driver must free all resouces held by it. */
int (*cleanup) (void);
2014-02-05 13:32:21 +00:00
/** 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);
2014-02-05 13:32:21 +00:00
/** 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);
2014-02-05 13:32:21 +00:00
/** Clear list of devices the driver knows about. */
int (*dev_clear) (void);
2014-02-05 13:32:21 +00:00
/** 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);
2014-02-05 13:32:21 +00:00
/** 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);
2014-02-05 13:32:21 +00:00
/** Probe status change.
* @see sr_dev_probe_enable(), sr_dev_trigger_set(). */
int (*config_probe_set) (const struct sr_dev_inst *sdi,
struct sr_probe *probe, unsigned int changes);
2014-02-05 13:32:21 +00:00
/** Apply configuration settings to the device hardware.
* @see sr_config_commit().*/
int (*config_commit) (const struct sr_dev_inst *sdi);
2014-02-05 13:32:21 +00:00
/** 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);
2010-04-15 18:07:16 +00:00
/* Device-specific */
/** Open device */
int (*dev_open) (struct sr_dev_inst *sdi);
/** Close device */
int (*dev_close) (struct sr_dev_inst *sdi);
2014-02-05 13:32:21 +00:00
/** Begin data aquisition on the specified device. */
int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
void *cb_data);
2014-02-05 13:32:21 +00:00
/** End data aquisition on the specified device. */
int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
void *cb_data);
/* Dynamic */
2014-02-05 13:32:21 +00:00
/** Device driver private data. Initialized by init(). */
void *priv;
};
/**
* @struct sr_session
*
* 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"
#ifdef __cplusplus
}
#endif
#endif