X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=b6d2b64046ebbda6f2a438a91ea5bf5fea2c1854;hb=543d45c581658851b41af42ebdbc476ccf3d88d3;hp=bedfbdb75d5de21cb0da1e189b84a583a1fa83af;hpb=80bf04263528998feb17cedc5b7aa9668dbc8d4d;p=libsigrok.git diff --git a/libsigrok.h b/libsigrok.h index bedfbdb7..b6d2b640 100644 --- a/libsigrok.h +++ b/libsigrok.h @@ -30,12 +30,26 @@ extern "C" { #endif -/* - * Status/error codes returned by libsigrok functions. +/** + * @file + * + * 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 + * libsigrok, but those are not meant to be used directly by frontends. * + * The correct way to get/use the libsigrok API functions is: + * + * @code{.c} + * #include + * @endcode + */ + +/* * All possible return codes of libsigrok functions must be listed here. * Functions should never return hardcoded numbers as status, but rather - * use these #defines instead. All error codes are negative numbers. + * 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 @@ -44,15 +58,19 @@ extern "C" { * same return code. * * Also, for compatibility reasons, no defined return codes are ever removed - * or reused for different #defines later. You can only add new #defines and + * or reused for different errors later. You can only add new entries and * return codes, but never remove or redefine existing ones. */ -#define SR_OK 0 /* No error */ -#define SR_ERR -1 /* Generic/unspecified error */ -#define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ -#define SR_ERR_ARG -3 /* Function argument error */ -#define SR_ERR_BUG -4 /* Errors hinting at internal bugs */ -#define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */ + +/** 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. */ +}; #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ #define SR_MAX_PROBENAME_LEN 32 @@ -65,13 +83,15 @@ extern "C" { #define SR_HZ_TO_NS(n) (1000000000 / (n)) -/* libsigrok loglevels. */ -#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. */ +/** 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. @@ -105,9 +125,9 @@ extern "C" { typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); -/* Data types used by hardware drivers for dev_config_set() */ +/** Data types used by sr_config_info(). */ enum { - SR_T_UINT64, + SR_T_UINT64 = 10000, SR_T_CHAR, SR_T_BOOL, SR_T_FLOAT, @@ -116,52 +136,138 @@ enum { SR_T_KEYVALUE, }; +/** Rational number data type, containing numerator and denominator values. */ struct sr_rational { - /* numerator */ + /** Numerator of the rational number. */ uint64_t p; - /* denominator */ + /** Denominator of the rational number. */ uint64_t q; }; -/* sr_datafeed_packet.type values */ +/** Value for sr_datafeed_packet.type. */ enum { - SR_DF_HEADER, + SR_DF_HEADER = 10000, SR_DF_END, + SR_DF_META, SR_DF_TRIGGER, SR_DF_LOGIC, - SR_DF_META_LOGIC, SR_DF_ANALOG, - SR_DF_META_ANALOG, SR_DF_FRAME_BEGIN, SR_DF_FRAME_END, }; -/* sr_datafeed_analog.mq values */ +/** Values for sr_datafeed_analog.mq. */ enum { - SR_MQ_VOLTAGE, + SR_MQ_VOLTAGE = 10000, SR_MQ_CURRENT, SR_MQ_RESISTANCE, SR_MQ_CAPACITANCE, SR_MQ_TEMPERATURE, SR_MQ_FREQUENCY, SR_MQ_DUTY_CYCLE, + 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, + SR_MQ_CARBON_MONOXIDE, + SR_MQ_RELATIVE_HUMIDITY, }; -/* sr_datafeed_analog.unit values */ +/** Values for sr_datafeed_analog.unit. */ enum { - SR_UNIT_VOLT, + SR_UNIT_VOLT = 10000, SR_UNIT_AMPERE, SR_UNIT_OHM, SR_UNIT_FARAD, - SR_UNIT_CELSIUS, SR_UNIT_KELVIN, + SR_UNIT_CELSIUS, + SR_UNIT_FAHRENHEIT, SR_UNIT_HERTZ, SR_UNIT_PERCENTAGE, + SR_UNIT_BOOLEAN, + 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, + /** Voltage in decibel, referenced to 1 volt (dBV). */ + SR_UNIT_DECIBEL_VOLT, + /** + * Measurements that intrinsically do not have units attached, such + * 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, +}; + +/** 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, + /** 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, + * according to IEC 61672:2003. */ + SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200, + /** Sound pressure level is C-weighted in the frequency domain, + * 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 + * 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, }; +struct sr_context; + struct sr_datafeed_packet { uint16_t type; - void *payload; + const void *payload; }; struct sr_datafeed_header { @@ -169,9 +275,8 @@ struct sr_datafeed_header { struct timeval starttime; }; -struct sr_datafeed_meta_logic { - int num_probes; - uint64_t samplerate; +struct sr_datafeed_meta { + GSList *config; }; struct sr_datafeed_logic { @@ -180,21 +285,25 @@ struct sr_datafeed_logic { void *data; }; -struct sr_datafeed_meta_analog { - int num_probes; -}; - struct sr_datafeed_analog { + /** The probes for which data is included in this packet. */ + GSList *probes; int num_samples; - int mq; /* Measured quantity (e.g. voltage, current, temperature) */ - int unit; /* Unit in which the MQ is measured. */ + /** Measured quantity (voltage, current, temperature, and so on). */ + int mq; + /** Unit in which the MQ is measured. */ + int unit; + /** Bitmap with extra information about the MQ. */ + uint64_t mqflags; + /** The analog value(s). The data is interleaved according to + * the probes list. */ float *data; }; struct sr_input { struct sr_input_format *format; GHashTable *param; - struct sr_dev *vdev; + struct sr_dev_inst *sdi; void *internal; }; @@ -202,13 +311,13 @@ struct sr_input_format { char *id; char *description; int (*format_match) (const char *filename); - int (*init) (struct sr_input *in); + int (*init) (struct sr_input *in, const char *filename); int (*loadfile) (struct sr_input *in, const char *filename); }; struct sr_output { struct sr_output_format *format; - struct sr_dev *dev; + struct sr_dev_inst *sdi; char *param; void *internal; }; @@ -218,42 +327,25 @@ struct sr_output_format { char *description; int df_type; int (*init) (struct sr_output *o); + /* Obsolete, use recv() instead. */ int (*data) (struct sr_output *o, const uint8_t *data_in, uint64_t length_in, uint8_t **data_out, uint64_t *length_out); + /* Obsolete, use recv() instead. */ int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, uint64_t *length_out); -}; - -struct sr_datastore { - /* Size in bytes of the number of units stored in this datastore */ - int ds_unitsize; - unsigned int num_units; /* TODO: uint64_t */ - GSList *chunklist; -}; - -/* - * This represents a generic device connected to the system. - * 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_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 */ - struct sr_datastore *datastore; + GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *packet); + int (*cleanup) (struct sr_output *o); }; enum { - SR_PROBE_TYPE_LOGIC, + SR_PROBE_LOGIC = 10000, + SR_PROBE_ANALOG, }; struct sr_probe { + /* The index field will go: use g_slist_length(sdi->probes) instead. */ int index; int type; gboolean enabled; @@ -261,202 +353,199 @@ struct sr_probe { char *trigger; }; -struct sr_hwopt { - int hwopt; +struct sr_config { + int key; const void *value; }; -/* Hardware driver options */ -enum { - /** Some drivers cannot detect the exact model they're talking to. */ - SR_HWOPT_MODEL, - - /** Specification on how to connect to a device */ - SR_HWOPT_CONN, - - /** Serial communication spec: e.g. 8n1 */ - SR_HWOPT_SERIALCOMM, +struct sr_config_info { + int key; + int datatype; + char *id; + char *name; + char *description; }; -/* Hardware device capabilities */ enum { - SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */ - /*--- Device classes ------------------------------------------------*/ /** The device can act as logic analyzer. */ - SR_HWCAP_LOGIC_ANALYZER, + SR_CONF_LOGIC_ANALYZER = 10000, /** The device can act as an oscilloscope. */ - SR_HWCAP_OSCILLOSCOPE, + SR_CONF_OSCILLOSCOPE, /** The device can act as a multimeter. */ - SR_HWCAP_MULTIMETER, + SR_CONF_MULTIMETER, /** The device is a demo device. */ - SR_HWCAP_DEMO_DEV, + SR_CONF_DEMO_DEV, + + /** The device can act as a sound level meter. */ + SR_CONF_SOUNDLEVELMETER, + + /** The device can measure temperature. */ + SR_CONF_THERMOMETER, + /** The device can measure humidity. */ + SR_CONF_HYGROMETER, + + /*--- 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 .
@endverbatim (decimal, e.g. 1.65) or + * @verbatim . @endverbatim + * (hexadecimal, e.g. 1d6b.0001). + */ + SR_CONF_CONN = 20000, + + /** + * Serial communication specification, in the form: + * + * @verbatim / @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, /*--- Device configuration ------------------------------------------*/ /** The device supports setting/changing its samplerate. */ - SR_HWCAP_SAMPLERATE, - - /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */ - /** The device supports setting a probe mask. */ - SR_HWCAP_PROBECONFIG, + SR_CONF_SAMPLERATE = 30000, /** The device supports setting a pre/post-trigger capture ratio. */ - SR_HWCAP_CAPTURE_RATIO, + SR_CONF_CAPTURE_RATIO, - /* TODO? */ /** The device supports setting a pattern (pattern generator mode). */ - SR_HWCAP_PATTERN_MODE, + SR_CONF_PATTERN_MODE, /** The device supports Run Length Encoding. */ - SR_HWCAP_RLE, + SR_CONF_RLE, /** The device supports setting trigger slope. */ - SR_HWCAP_TRIGGER_SLOPE, + SR_CONF_TRIGGER_SLOPE, /** Trigger source. */ - SR_HWCAP_TRIGGER_SOURCE, + SR_CONF_TRIGGER_SOURCE, - /** Horizontal trigger position */ - SR_HWCAP_HORIZ_TRIGGERPOS, + /** Horizontal trigger position. */ + SR_CONF_HORIZ_TRIGGERPOS, /** Buffer size. */ - SR_HWCAP_BUFFERSIZE, + SR_CONF_BUFFERSIZE, /** Time base. */ - SR_HWCAP_TIMEBASE, + SR_CONF_TIMEBASE, /** Filter. */ - SR_HWCAP_FILTER, + SR_CONF_FILTER, /** Volts/div. */ - SR_HWCAP_VDIV, + SR_CONF_VDIV, /** Coupling. */ - SR_HWCAP_COUPLING, + SR_CONF_COUPLING, + /** Trigger types. */ + SR_CONF_TRIGGER_TYPE, /*--- Special stuff -------------------------------------------------*/ - /** Session filename */ - SR_HWCAP_SESSIONFILE, + /** Scan options supported by the driver. */ + SR_CONF_SCAN_OPTIONS = 40000, + + /** Device options for a particular device. */ + SR_CONF_DEVICE_OPTIONS, + + /** Session filename. */ + SR_CONF_SESSIONFILE, - /* TODO: Better description. */ /** The device supports specifying a capturefile to inject. */ - SR_HWCAP_CAPTUREFILE, + SR_CONF_CAPTUREFILE, - /* TODO: Better description. */ /** The device supports specifying the capturefile unit size. */ - SR_HWCAP_CAPTURE_UNITSIZE, + SR_CONF_CAPTURE_UNITSIZE, - /* TODO: Better description. */ /** The device supports setting the number of probes. */ - SR_HWCAP_CAPTURE_NUM_PROBES, - + SR_CONF_CAPTURE_NUM_PROBES, /*--- Acquisition modes ---------------------------------------------*/ /** - * The device supports setting a sample time limit, i.e. how long the - * sample acquisition should run (in ms). + * The device supports setting a sample time limit (how long + * the sample acquisition should run, in ms). */ - SR_HWCAP_LIMIT_MSEC, + SR_CONF_LIMIT_MSEC = 50000, /** - * The device supports setting a sample number limit, i.e. how many - * samples should be acquired. + * The device supports setting a sample number limit (how many + * samples should be acquired). */ - SR_HWCAP_LIMIT_SAMPLES, + SR_CONF_LIMIT_SAMPLES, /** - * The device supports setting a frame limit, i.e. how many - * frames should be acquired. + * The device supports setting a frame limit (how many + * frames should be acquired). */ - SR_HWCAP_LIMIT_FRAMES, + SR_CONF_LIMIT_FRAMES, /** - * The device supports continuous sampling, i.e. neither a time limit + * 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_HWCAP_CONTINUOUS, - -}; - -struct sr_hwcap_option { - int hwcap; - int type; - char *description; - char *shortname; + SR_CONF_CONTINUOUS, }; struct sr_dev_inst { + struct sr_dev_driver *driver; int index; int status; int inst_type; char *vendor; char *model; char *version; + GSList *probes; void *priv; }; -/* sr_dev_inst types */ +/** Types of device instances (sr_dev_inst). */ enum { /** Device instance type for USB devices. */ - SR_INST_USB, + SR_INST_USB = 10000, /** Device instance type for serial port devices. */ SR_INST_SERIAL, }; -/* Device instance status */ +/** Device instance status. */ enum { - SR_ST_NOT_FOUND, - /* Found, but still booting */ + /** The device instance was not found. */ + SR_ST_NOT_FOUND = 10000, + /** The device instance was found, but is still booting. */ SR_ST_INITIALIZING, - /* Live, but not in use */ + /** The device instance is live, but not in use. */ SR_ST_INACTIVE, - /* Actively in use in a session */ + /** The device instance is actively in use in a session. */ SR_ST_ACTIVE, -}; - -/* - * TODO: This sucks, you just kinda have to "know" the returned type. - * TODO: Need a DI to return the number of trigger stages supported. - */ - -/* Device info IDs */ -enum { - /* 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 logic trigger supported, out of "01crf" (char *) */ - SR_DI_TRIGGER_TYPES, - /* The currently set samplerate in Hz (uint64_t) */ - SR_DI_CUR_SAMPLERATE, - /* 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, + /** The device is winding down its session. */ + SR_ST_STOPPING, }; /* @@ -476,35 +565,44 @@ struct sr_dev_driver { char *name; char *longname; int api_version; - int (*init) (void); + int (*init) (struct sr_context *sr_ctx); int (*cleanup) (void); 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); /* Device-specific */ - 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); + int (*dev_open) (struct sr_dev_inst *sdi); + int (*dev_close) (struct sr_dev_inst *sdi); + int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, + void *cb_data); + int (*dev_acquisition_stop) (struct sr_dev_inst *sdi, + void *cb_data); + + /* Dynamic */ + void *priv; }; struct sr_session { - /* List of struct sr_dev* */ + /** List of struct sr_dev pointers. */ GSList *devs; - /* list of sr_receive_data_callback_t */ + /** List of sr_receive_data_callback_t items. */ GSList *datafeed_callbacks; GTimeVal starttime; - gboolean running; 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. + /* + * 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;