X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok.h.in;h=1d1f8caf8add72445a43a9232c9b970915d8738c;hb=5af666a94e67e8a18c0dfa1f4314e1c3e93aa993;hp=a767dc71bceb980746a46ec412309076096a38da;hpb=0f8522bf74af8abfe8601e978b2e0d0e40b1a124;p=libsigrok.git diff --git a/sigrok.h.in b/sigrok.h.in index a767dc71..1d1f8caf 100644 --- a/sigrok.h.in +++ b/sigrok.h.in @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2012 Bert Vermeulen + * Copyright (C) 2010-2012 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 @@ -30,6 +30,38 @@ extern "C" { #endif +/* + * Package version macros (can be used for conditional compilation). + */ + +/** The libsigrok package 'major' version number. */ +#define SR_PACKAGE_VERSION_MAJOR @SR_PACKAGE_VERSION_MAJOR@ + +/** The libsigrok package 'minor' version number. */ +#define SR_PACKAGE_VERSION_MINOR @SR_PACKAGE_VERSION_MINOR@ + +/** The libsigrok package 'micro' version number. */ +#define SR_PACKAGE_VERSION_MICRO @SR_PACKAGE_VERSION_MICRO@ + +/** The libsigrok package version ("major.minor.micro") as string. */ +#define SR_PACKAGE_VERSION_STRING "@SR_PACKAGE_VERSION@" + +/* + * Library/libtool version macros (can be used for conditional compilation). + */ + +/** The libsigrok libtool 'current' version number. */ +#define SR_LIB_VERSION_CURRENT @SR_LIB_VERSION_CURRENT@ + +/** The libsigrok libtool 'revision' version number. */ +#define SR_LIB_VERSION_REVISION @SR_LIB_VERSION_REVISION@ + +/** The libsigrok libtool 'age' version number. */ +#define SR_LIB_VERSION_AGE @SR_LIB_VERSION_AGE@ + +/** The libsigrok libtool version ("current:revision:age") as string. */ +#define SR_LIB_VERSION_STRING "@SR_LIB_VERSION@" + /* * Status/error codes returned by libsigrok functions. * @@ -54,8 +86,8 @@ extern "C" { #define SR_ERR_BUG -4 /* Errors hinting at internal bugs */ #define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */ -#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ -#define SR_MAX_PROBENAME_LEN 32 +#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ +#define SR_MAX_PROBENAME_LEN 32 /* Handy little macros */ #define SR_HZ(n) (n) @@ -66,12 +98,12 @@ extern "C" { #define SR_HZ_TO_NS(n) (1000000000 / (n)) /* libsigrok loglevels. */ -#define SR_LOG_NONE 0 -#define SR_LOG_ERR 1 -#define SR_LOG_WARN 2 -#define SR_LOG_INFO 3 -#define SR_LOG_DBG 4 -#define SR_LOG_SPEW 5 +#define SR_LOG_NONE 0 /**< Output no messages at all. */ +#define SR_LOG_ERR 1 /**< Output error messages. */ +#define SR_LOG_WARN 2 /**< Output warnings. */ +#define SR_LOG_INFO 3 /**< Output informational messages. */ +#define SR_LOG_DBG 4 /**< Output debug messages. */ +#define SR_LOG_SPEW 5 /**< Output very noisy debug messages. */ /* * Use SR_API to mark public API symbols, and SR_PRIV for private symbols. @@ -83,22 +115,43 @@ extern "C" { * * 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 -typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data); +typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); -/* Data types used by hardware plugins for set_configuration() */ +/* Data types used by hardware drivers for dev_config_set() */ enum { SR_T_UINT64, SR_T_CHAR, SR_T_BOOL, + SR_T_FLOAT, + SR_T_RATIONAL_PERIOD, + SR_T_RATIONAL_VOLT, +}; + +struct sr_rational { + /* numerator */ + uint64_t p; + /* denominator */ + uint64_t q; }; /* sr_datafeed_packet.type values */ @@ -107,7 +160,34 @@ enum { SR_DF_END, SR_DF_TRIGGER, SR_DF_LOGIC, - SR_DF_PD, + SR_DF_META_LOGIC, + SR_DF_ANALOG, + SR_DF_META_ANALOG, + SR_DF_FRAME_BEGIN, + SR_DF_FRAME_END, +}; + +/* sr_datafeed_analog.mq values */ +enum { + SR_MQ_VOLTAGE, + SR_MQ_CURRENT, + SR_MQ_RESISTANCE, + SR_MQ_CAPACITANCE, + SR_MQ_TEMPERATURE, + SR_MQ_FREQUENCY, + SR_MQ_DUTY_CYCLE, +}; + +/* sr_datafeed_analog.unit values */ +enum { + SR_UNIT_VOLT, + SR_UNIT_AMPERE, + SR_UNIT_OHM, + SR_UNIT_FARAD, + SR_UNIT_CELSIUS, + SR_UNIT_KELVIN, + SR_UNIT_HERTZ, + SR_UNIT_PERCENTAGE, }; struct sr_datafeed_packet { @@ -118,8 +198,11 @@ struct sr_datafeed_packet { struct sr_datafeed_header { int feed_version; struct timeval starttime; +}; + +struct sr_datafeed_meta_logic { + int num_probes; uint64_t samplerate; - int num_logic_probes; }; struct sr_datafeed_logic { @@ -128,10 +211,21 @@ struct sr_datafeed_logic { void *data; }; +struct sr_datafeed_meta_analog { + int num_probes; +}; + +struct sr_datafeed_analog { + int num_samples; + int mq; /* Measured quantity (e.g. voltage, current, temperature) */ + int unit; /* Unit in which the MQ is measured. */ + float *data; +}; + struct sr_input { struct sr_input_format *format; char *param; - struct sr_device *vdevice; + struct sr_dev *vdev; }; struct sr_input_format { @@ -144,7 +238,7 @@ struct sr_input_format { struct sr_output { struct sr_output_format *format; - struct sr_device *device; + struct sr_dev *dev; char *param; void *internal; }; @@ -154,9 +248,10 @@ struct sr_output_format { char *description; int df_type; int (*init) (struct sr_output *o); - int (*data) (struct sr_output *o, const char *data_in, - uint64_t length_in, char **data_out, uint64_t *length_out); - int (*event) (struct sr_output *o, int event_type, char **data_out, + int (*data) (struct sr_output *o, const uint8_t *data_in, + uint64_t length_in, uint8_t **data_out, + uint64_t *length_out); + int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, uint64_t *length_out); }; @@ -169,15 +264,15 @@ struct sr_datastore { /* * This represents a generic device connected to the system. - * For device-specific information, ask the plugin. The plugin_index refers - * to the device index within that plugin; it may be handling more than one - * device. All relevant plugin calls take a device_index parameter for this. + * For device-specific information, ask the driver. The driver_index refers + * to the device index within that driver; it may be handling more than one + * device. All relevant driver calls take a dev_index parameter for this. */ -struct sr_device { - /* Which plugin handles this device */ - struct sr_device_plugin *plugin; - /* A plugin may handle multiple devices of the same type */ - int plugin_index; +struct sr_dev { + /* Which driver handles this device */ + struct sr_dev_driver *driver; + /* A driver may handle multiple devices of the same type */ + int driver_index; /* List of struct sr_probe* */ GSList *probes; /* Data acquired by this device, if any */ @@ -196,7 +291,7 @@ struct sr_probe { char *trigger; }; -/* Hardware plugin capabilities */ +/* Hardware driver capabilities */ enum { SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */ @@ -205,12 +300,13 @@ enum { /** The device can act as logic analyzer. */ SR_HWCAP_LOGIC_ANALYZER, - /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */ + /** The device can act as an oscilloscope. */ + SR_HWCAP_OSCILLOSCOPE, /*--- Device types --------------------------------------------------*/ /** The device is demo device. */ - SR_HWCAP_DEMO_DEVICE, + SR_HWCAP_DEMO_DEV, /*--- Device options ------------------------------------------------*/ @@ -231,6 +327,30 @@ enum { /** The device supports Run Length Encoding. */ SR_HWCAP_RLE, + /** The device supports setting trigger slope. */ + SR_HWCAP_TRIGGER_SLOPE, + + /** Trigger source. */ + SR_HWCAP_TRIGGER_SOURCE, + + /** Horizontal trigger position */ + SR_HWCAP_HORIZ_TRIGGERPOS, + + /** Buffer size. */ + SR_HWCAP_BUFFERSIZE, + + /** Time base. */ + SR_HWCAP_TIMEBASE, + + /** Filter. */ + SR_HWCAP_FILTER, + + /** Volts/div. */ + SR_HWCAP_VDIV, + + /** Coupling. */ + SR_HWCAP_COUPLING, + /*--- Special stuff -------------------------------------------------*/ /* TODO: Better description. */ @@ -259,6 +379,12 @@ enum { */ SR_HWCAP_LIMIT_SAMPLES, + /** + * The device supports setting a frame limit, i.e. how many + * frames should be acquired. + */ + SR_HWCAP_LIMIT_FRAMES, + /** * The device supports continuous sampling, i.e. neither a time limit * nor a sample number limit has to be supplied, it will just acquire @@ -266,30 +392,31 @@ enum { */ SR_HWCAP_CONTINUOUS, - /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */ }; struct sr_hwcap_option { - int capability; + int hwcap; int type; char *description; char *shortname; }; -struct sr_device_instance { +struct sr_dev_inst { int index; int status; - int instance_type; + int inst_type; char *vendor; char *model; char *version; void *priv; }; -/* sr_device_instance types */ +/* sr_dev_inst types */ enum { - SR_USB_INSTANCE, - SR_SERIAL_INSTANCE, + /** Device instance type for USB devices. */ + SR_INST_USB, + /** Device instance type for serial port devices. */ + SR_INST_SERIAL, }; /* Device instance status */ @@ -310,20 +437,32 @@ enum { /* Device info IDs */ enum { - /* struct sr_device_instance for this specific device */ - SR_DI_INSTANCE, + /* struct sr_dev_inst for this specific device */ + SR_DI_INST, /* The number of probes connected to this device */ SR_DI_NUM_PROBES, /* The probe names on this device */ SR_DI_PROBE_NAMES, /* Samplerates supported by this device, (struct sr_samplerates) */ SR_DI_SAMPLERATES, - /* Types of trigger supported, out of "01crf" (char *) */ + /* Types of logic trigger supported, out of "01crf" (char *) */ SR_DI_TRIGGER_TYPES, /* The currently set samplerate in Hz (uint64_t) */ SR_DI_CUR_SAMPLERATE, - /* Supported pattern generator modes */ - SR_DI_PATTERNMODES, + /* Supported patterns (in pattern generator mode) */ + SR_DI_PATTERNS, + /* Supported buffer sizes */ + SR_DI_BUFFERSIZES, + /* Supported time bases */ + SR_DI_TIMEBASES, + /* Supported trigger sources */ + SR_DI_TRIGGER_SOURCES, + /* Supported filter targets */ + SR_DI_FILTERS, + /* Valid volts/div values */ + SR_DI_VDIVS, + /* Coupling options */ + SR_DI_COUPLING, }; /* @@ -335,32 +474,32 @@ struct sr_samplerates { uint64_t low; uint64_t high; uint64_t step; - uint64_t *list; + const uint64_t *list; }; -struct sr_device_plugin { - /* Plugin-specific */ +struct sr_dev_driver { + /* Driver-specific */ char *name; char *longname; int api_version; - int (*init) (const char *deviceinfo); - void (*cleanup) (void); + int (*init) (const char *devinfo); + int (*cleanup) (void); /* Device-specific */ - int (*opendev) (int device_index); - int (*closedev) (int device_index); - void *(*get_device_info) (int device_index, int device_info_id); - int (*get_status) (int device_index); - int *(*get_capabilities) (void); - int (*set_configuration) (int device_index, int capability, void *value); - int (*start_acquisition) (int device_index, gpointer session_device_id); - void (*stop_acquisition) (int device_index, gpointer session_device_id); + int (*dev_open) (int dev_index); + int (*dev_close) (int dev_index); + const void *(*dev_info_get) (int dev_index, int dev_info_id); + int (*dev_status_get) (int dev_index); + const int *(*hwcap_get_all) (void); + int (*dev_config_set) (int dev_index, int hwcap, const void *value); + int (*dev_acquisition_start) (int dev_index, void *session_dev_id); + int (*dev_acquisition_stop) (int dev_index, void *session_dev_id); }; struct sr_session { - /* List of struct sr_device* */ - GSList *devices; - /* list of sr_receive_data_callback */ + /* List of struct sr_dev* */ + GSList *devs; + /* list of sr_receive_data_callback_t */ GSList *datafeed_callbacks; GTimeVal starttime; gboolean running;