* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef LIBSIGROK_SIGROK_H
-#define LIBSIGROK_SIGROK_H
+#ifndef LIBSIGROK_LIBSIGROK_H
+#define LIBSIGROK_LIBSIGROK_H
#include <stdio.h>
#include <sys/time.h>
/** 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. */
+ 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
*/
};
-#define SR_MAX_PROBENAME_LEN 32
+#define SR_MAX_CHANNELNAME_LEN 32
/* Handy little macros */
#define SR_HZ(n) (n)
SR_T_KEYVALUE,
SR_T_UINT64_RANGE,
SR_T_DOUBLE_RANGE,
+ SR_T_INT32,
};
/** Value for sr_datafeed_packet.type. */
enum {
- SR_DF_HEADER = 10000, /**< Payload is sr_datafeed_header. */
- SR_DF_END, /**< End of stream (no further data). */
- SR_DF_META, /**< Payload is struct sr_datafeed_meta */
- SR_DF_TRIGGER, /**< The trigger matched at this point in the data feed.
- No payload. */
- SR_DF_LOGIC, /**< Payload is struct sr_datafeed_logic. */
- SR_DF_ANALOG, /**< Payload is struct sr_datafeed_analog. */
- SR_DF_FRAME_BEGIN, /**< Beginning of frame. No payload. */
- SR_DF_FRAME_END, /**< End of frame. No payload. */
+ /** 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,
};
/** Measured quantity, sr_datafeed_analog.mq. */
SR_MQ_CAPACITANCE,
SR_MQ_TEMPERATURE,
SR_MQ_FREQUENCY,
- SR_MQ_DUTY_CYCLE, /**< Duty cycle, e.g. on/off ratio. */
- SR_MQ_CONTINUITY, /**< Continuity test. */
+ /** Duty cycle, e.g. on/off ratio. */
+ SR_MQ_DUTY_CYCLE,
+ /** Continuity test. */
+ SR_MQ_CONTINUITY,
SR_MQ_PULSE_WIDTH,
SR_MQ_CONDUCTANCE,
- SR_MQ_POWER, /**< Electrical power, usually in W, or dBm. */
- SR_MQ_GAIN, /**< Gain (a transistor's gain, or hFE, for example). */
+ /** 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,
- SR_MQ_CARBON_MONOXIDE, /**< Carbon monoxide level */
- SR_MQ_RELATIVE_HUMIDITY,/**< Humidity */
- SR_MQ_TIME, /**< Time */
+ /** Carbon monoxide level */
+ SR_MQ_CARBON_MONOXIDE,
+ /** Humidity */
+ SR_MQ_RELATIVE_HUMIDITY,
+ /** Time */
+ SR_MQ_TIME,
};
/** Unit of measured quantity, sr_datafeed_analog.unit. */
enum {
- SR_UNIT_VOLT = 10000, /**< Volt */
- SR_UNIT_AMPERE, /**< Ampere (current). */
- SR_UNIT_OHM, /**< Ohm (resistance). */
- SR_UNIT_FARAD, /**< Farad (capacity). */
- SR_UNIT_KELVIN, /**< Kelvin (temperature). */
- SR_UNIT_CELSIUS, /**< Degrees Celsius (temperature). */
- SR_UNIT_FAHRENHEIT, /**< Degrees Fahrenheit (temperature). */
- SR_UNIT_HERTZ, /**< Hertz (frequency, 1/s, [Hz]). */
- SR_UNIT_PERCENTAGE, /**< Percent value. */
- SR_UNIT_BOOLEAN, /**< Boolean value. */
- SR_UNIT_SECOND, /**< Time in seconds. */
- SR_UNIT_SIEMENS, /**< Unit of conductance, the inverse of resistance. */
+ /** 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).
* represented as the fraction of number of particles of the substance.
*/
SR_UNIT_CONCENTRATION,
- SR_UNIT_REVOLUTIONS_PER_MINUTE, /**< Revolutions per minute. */
- SR_UNIT_VOLT_AMPERE, /**< Apparent power [VA]. */
- SR_UNIT_WATT, /**< Real power [W]. */
- SR_UNIT_WATT_HOUR, /**< Consumption [Wh]. */
+ /** 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. */
SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
/** Time is duration (as opposed to epoch, ...). */
SR_MQFLAG_DURATION = 0x20000,
+ /** Device is in "avg" mode, averaging upon each new value. */
+ SR_MQFLAG_AVG = 0x40000,
};
-/** sigrok context (opaque). @see sr_init(), sr_exit(). */
+/**
+ * @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;
/** Packet in a sigrok data feed. */
/** Analog datafeed payload for type SR_DF_ANALOG. */
struct sr_datafeed_analog {
- /** The probes for which data is included in this packet. */
- GSList *probes;
- int num_samples; /**< Number of samples in data */
+ /** 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).
* Use SR_MQ_VOLTAGE, ... */
int mq;
/** 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;
};
/**
* 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;
*/
char *description;
- int df_type; /**< Datafeed type, SR_DF_HEADER, etc. */
+ /** Datafeed type, SR_DF_HEADER, etc. */
+ int df_type;
/**
* This function is called once, at the beginning of an output stream.
int (*cleanup) (struct sr_output *o);
};
-/** Constants for probe type. */
+/** Constants for channel type. */
enum {
- SR_PROBE_LOGIC = 10000, /**< Probe type is logic probe. */
- SR_PROBE_ANALOG, /**< Probe type is analog probe. */
+ /** Channel type is logic channel. */
+ SR_CHANNEL_LOGIC = 10000,
+ /** Channel type is analog channel. */
+ SR_CHANNEL_ANALOG,
};
-/** Information on single probe. */
-struct sr_probe {
- int index; /**< Number of probe, starting at 0. @deprecated The
- index field will go: use g_slist_length(sdi->probes) instead. */
- int type; /**< Probe type (SR_PROBE_LOGIC, ...) */
- gboolean enabled; /**< Is this probe enabled? */
- char *name;/**< Name of probe. */
- char *trigger;/**< Trigger string, format like used by sigrok-cli */
+/** Information on single channel. */
+struct sr_channel {
+ /** Number of channels, starting at 0. */
+ int index;
+ /** Channel type (SR_CHANNEL_LOGIC, ...) */
+ int type;
+ /** Is this channel enabled? */
+ gboolean enabled;
+ /** 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;
};
/** Used for setting or getting value of a config item. */
struct sr_config {
- int key; /**< Config key like SR_CONF_CONN, etc. */
- GVariant *data; /**< Key-specific data. */
+ /** Config key like SR_CONF_CONN, etc. */
+ int key;
+ /** Key-specific data. */
+ GVariant *data;
};
/** Information about a config key. */
struct sr_config_info {
- int key; /**< Config key like SR_CONF_CONN, etc. */
- int datatype; /**< Data type like SR_T_CHAR, etc. */
- char *id; /**< Id string, e.g. "serialcomm". */
- char *name; /**< Name, e.g. "Serial communication". */
- char *description; /**< Verbose description (unused currently). */
+ /** 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;
};
/** Constants for device classes */
/** 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 -------------------------------------------*/
/**
/** Logic low-high threshold range. */
SR_CONF_VOLTAGE_THRESHOLD,
- /** The device supports using a external clock. */
+ /** The device supports using an external clock. */
SR_CONF_EXTERNAL_CLOCK,
/**
*/
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 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,
+
+ /** 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. */
/** The device supports specifying the capturefile unit size. */
SR_CONF_CAPTURE_UNITSIZE,
- /** 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
+ /**
+ * 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.
*
* 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 ---------------------------------------------*/
SR_CONF_DATALOG,
};
-/** @private
- * Device instance data
+/** Device instance data
*/
struct sr_dev_inst {
- struct sr_dev_driver *driver; /**< Device driver. */
- int index; /**< Index of device in driver. */
- int status; /**< Device instance status. SR_ST_NOT_FOUND, etc. */
- int inst_type; /**< Device instance type. SR_INST_USB, etc. */
- char *vendor; /**< Device vendor. */
- char *model; /**< Device model. */
- char *version; /**< Device version. */
- GSList *probes; /**< List of probes. */
- GSList *probe_groups; /**< List of sr_probe_group structs */
- void *conn; /**< Device instance connection data (used?) */
- void *priv; /**< Device instance private data (used?) */
+ /** 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 channels. */
+ GSList *channels;
+ /** List of sr_channel_group structs */
+ GSList *channel_groups;
+ /** Device instance connection data (used?) */
+ void *conn;
+ /** Device instance private data (used?) */
+ void *priv;
};
/** Types of device instance, struct sr_dev_inst.type */
SR_ST_STOPPING,
};
-/** Device driver data */
+/** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
struct sr_dev_driver {
/* Driver-specific */
- char *name; /**< Driver name */
- char *longname; /**< Long name, e.g. device name. */
- int api_version; /**< API version (currently 1). */
- int (*init) (struct sr_context *sr_ctx); /**< Init driver */
- int (*cleanup) (void); /**< Free driver */
- GSList *(*scan) (GSList *options); /**< Scan for devices */
- GSList *(*dev_list) (void); /**< Get device list */
+ /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
+ char *name;
+ /** Long name. Verbose driver name shown to user. */
+ char *longname;
+ /** API version (currently 1). */
+ int api_version;
+ /** Called when driver is loaded, e.g. program startup. */
+ int (*init) (struct sr_context *sr_ctx);
+ /** Called before driver is unloaded.
+ * Driver must free all resouces held by it. */
+ int (*cleanup) (void);
+ /** 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 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(), sr_dev_trigger_set(). */
+ 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 */
- int (*dev_open) (struct sr_dev_inst *sdi); /**< Open device */
- int (*dev_close) (struct sr_dev_inst *sdi); /**< Close device */
+ /** Open device */
+ int (*dev_open) (struct sr_dev_inst *sdi);
+ /** Close device */
+ int (*dev_close) (struct sr_dev_inst *sdi);
+ /** Begin data acquisition on the specified device. */
int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
- void *cb_data); /**< Start data aquisition. */
+ void *cb_data);
+ /** End data acquisition on the specified device. */
int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
- void *cb_data); /**< Stop data aquisition. */
+ void *cb_data);
/* Dynamic */
- void *priv; /**< Device driver private data */
+ /** 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.
*/
projects / libsigrok.git / blobdiff