2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #ifndef LIBSIGROK_SIGROK_H
21 #define LIBSIGROK_SIGROK_H
34 * All possible return codes of libsigrok functions must be listed here.
35 * Functions should never return hardcoded numbers as status, but rather
36 * use these enum values. All error codes are negative numbers.
38 * The error codes are globally unique in libsigrok, i.e. if one of the
39 * libsigrok functions returns a "malloc error" it must be exactly the same
40 * return value as used by all other functions to indicate "malloc error".
41 * There must be no functions which indicate two different errors via the
44 * Also, for compatibility reasons, no defined return codes are ever removed
45 * or reused for different errors later. You can only add new entries and
46 * return codes, but never remove or redefine existing ones.
49 /** Status/error codes returned by libsigrok functions. */
51 SR_OK = 0, /**< No error. */
52 SR_ERR = -1, /**< Generic/unspecified error. */
53 SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */
54 SR_ERR_ARG = -3, /**< Function argument error. */
55 SR_ERR_BUG = -4, /**< Errors hinting at internal bugs. */
56 SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
59 #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
60 #define SR_MAX_PROBENAME_LEN 32
62 /* Handy little macros */
64 #define SR_KHZ(n) ((n) * 1000)
65 #define SR_MHZ(n) ((n) * 1000000)
66 #define SR_GHZ(n) ((n) * 1000000000)
68 #define SR_HZ_TO_NS(n) (1000000000 / (n))
70 /** libsigrok loglevels. */
72 SR_LOG_NONE = 0, /**< Output no messages at all. */
73 SR_LOG_ERR = 1, /**< Output error messages. */
74 SR_LOG_WARN = 2, /**< Output warnings. */
75 SR_LOG_INFO = 3, /**< Output informational messages. */
76 SR_LOG_DBG = 4, /**< Output debug messages. */
77 SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
81 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
83 * Variables and functions marked 'static' are private already and don't
84 * need SR_PRIV. However, functions which are not static (because they need
85 * to be used in other libsigrok-internal files) but are also not meant to
86 * be part of the public libsigrok API, must use SR_PRIV.
88 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
90 * This feature is not available on MinGW/Windows, as it is a feature of
91 * ELF files and MinGW/Windows uses PE files.
93 * Details: http://gcc.gnu.org/wiki/Visibility
96 /* Marks public libsigrok API symbols. */
98 #define SR_API __attribute__((visibility("default")))
103 /* Marks private, non-public libsigrok symbols (not part of the API). */
105 #define SR_PRIV __attribute__((visibility("hidden")))
110 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
112 /** Data types used by hardware drivers for dev_config_set(). */
118 SR_T_RATIONAL_PERIOD,
123 /** Rational number data type, containing numerator and denominator values. */
125 /** Numerator of the rational number. */
127 /** Denominator of the rational number. */
131 /** Value for sr_datafeed_packet.type. */
144 /** Values for sr_datafeed_analog.mq. */
156 /** Electrical power, usually in W, or dBm. */
158 /** Gain (e.g. a transistor's gain, or hFE). */
162 /** Values for sr_datafeed_analog.unit. */
175 /** Unit of conductance, the inverse of resistance. */
178 * An absolute measurement of power, in decibels, referenced to
182 /** Voltage in decibel, referenced to 1 volt (dBV). */
183 SR_UNIT_DECIBEL_VOLT,
185 * Measurements that intrinsically do not have units attached, such
186 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
187 * a unitless quantity, for example.
192 /** Values for sr_datafeed_analog.flags. */
194 /** Voltage measurement is alternating current (AC). */
196 /** Voltage measurement is direct current (DC). */
198 /** This is a true RMS measurement. */
199 SR_MQFLAG_RMS = 0x04,
200 /** Value is voltage drop across a diode, or NAN. */
201 SR_MQFLAG_DIODE = 0x08,
202 /** Device is in "hold" mode, i.e. repeating the last measurement. */
203 SR_MQFLAG_HOLD = 0x10,
204 /** Device is in "max" mode, only updating upon a new max value. */
205 SR_MQFLAG_MAX = 0x20,
206 /** Device is in "min" mode, only updating upon a new min value. */
207 SR_MQFLAG_MIN = 0x40,
208 /** Device is in autoranging mode. */
209 SR_MQFLAG_AUTORANGE = 0x80,
210 /** Device is in relative mode. */
211 SR_MQFLAG_RELATIVE = 0x100,
216 struct sr_datafeed_packet {
221 struct sr_datafeed_header {
223 struct timeval starttime;
226 struct sr_datafeed_meta_logic {
231 struct sr_datafeed_logic {
237 struct sr_datafeed_meta_analog {
241 struct sr_datafeed_analog {
243 /** Measured quantity (e.g. voltage, current, temperature). */
245 /** Unit in which the MQ is measured. */
247 /** Bitmap with extra information about the MQ. */
249 /** The analog value. */
254 struct sr_input_format *format;
256 struct sr_dev_inst *sdi;
260 struct sr_input_format {
263 int (*format_match) (const char *filename);
264 int (*init) (struct sr_input *in);
265 int (*loadfile) (struct sr_input *in, const char *filename);
269 struct sr_output_format *format;
270 struct sr_dev_inst *sdi;
275 struct sr_output_format {
279 int (*init) (struct sr_output *o);
280 int (*data) (struct sr_output *o, const uint8_t *data_in,
281 uint64_t length_in, uint8_t **data_out,
282 uint64_t *length_out);
283 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
284 uint64_t *length_out);
285 GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
286 struct sr_datafeed_packet *packet);
287 int (*cleanup) (struct sr_output *o);
290 struct sr_datastore {
291 /** Size in bytes of the number of units stored in this datastore. */
293 unsigned int num_units; /* TODO: uint64_t */
298 * This represents a generic device connected to the system.
299 * For device-specific information, ask the driver. The driver_index refers
300 * to the device index within that driver; it may be handling more than one
301 * device. All relevant driver calls take a dev_index parameter for this.
304 /** Which driver handles this device. */
305 struct sr_dev_driver *driver;
306 /** A driver may handle multiple devices of the same type. */
308 /** List of struct sr_probe pointers. */
310 /** Data acquired by this device, if any. */
311 struct sr_datastore *datastore;
332 /** Hardware driver options. */
334 /** Used to terminate lists. Must be 0! */
338 * Some drivers cannot detect the exact model they're talking to
339 * (may be phased out).
344 * Specification on how to connect to a device. In combination
345 * with SR_HWOPT_SERIALCOMM, this is a serial port in the form
346 * which makes sense to the operating system (e.g., /dev/ttyS0).
347 * Otherwise this specifies a USB device, either in the form of
348 * [bus].[address] (decimal, e.g. 1.65) or [vendorid].[productid]
349 * (hexadecimal, e.g. 1d6b.0001).
354 * Serial communication specification, in the form:
355 * [baudrate]/[databits][parity][stopbits], e.g. 9600/8n1
357 * This is always an optional parameter, since a driver typically
358 * knows the speed at which the device wants to communicate.
363 /** Hardware device capabilities. */
365 /** Used to terminate lists. Must be 0! */
368 /*--- Device classes ------------------------------------------------*/
370 /** The device can act as logic analyzer. */
371 SR_HWCAP_LOGIC_ANALYZER,
373 /** The device can act as an oscilloscope. */
374 SR_HWCAP_OSCILLOSCOPE,
376 /** The device can act as a multimeter. */
379 /** The device is a demo device. */
383 /*--- Device configuration ------------------------------------------*/
385 /** The device supports setting/changing its samplerate. */
388 /** The device supports setting a pre/post-trigger capture ratio. */
389 SR_HWCAP_CAPTURE_RATIO,
392 /** The device supports setting a pattern (pattern generator mode). */
393 SR_HWCAP_PATTERN_MODE,
395 /** The device supports Run Length Encoding. */
398 /** The device supports setting trigger slope. */
399 SR_HWCAP_TRIGGER_SLOPE,
401 /** Trigger source. */
402 SR_HWCAP_TRIGGER_SOURCE,
404 /** Horizontal trigger position. */
405 SR_HWCAP_HORIZ_TRIGGERPOS,
423 /*--- Special stuff -------------------------------------------------*/
425 /** Session filename. */
426 SR_HWCAP_SESSIONFILE,
428 /* TODO: Better description. */
429 /** The device supports specifying a capturefile to inject. */
430 SR_HWCAP_CAPTUREFILE,
432 /* TODO: Better description. */
433 /** The device supports specifying the capturefile unit size. */
434 SR_HWCAP_CAPTURE_UNITSIZE,
436 /* TODO: Better description. */
437 /** The device supports setting the number of probes. */
438 SR_HWCAP_CAPTURE_NUM_PROBES,
441 /*--- Acquisition modes ---------------------------------------------*/
444 * The device supports setting a sample time limit, i.e. how long the
445 * sample acquisition should run (in ms).
450 * The device supports setting a sample number limit, i.e. how many
451 * samples should be acquired.
453 SR_HWCAP_LIMIT_SAMPLES,
456 * The device supports setting a frame limit, i.e. how many
457 * frames should be acquired.
459 SR_HWCAP_LIMIT_FRAMES,
462 * The device supports continuous sampling, i.e. neither a time limit
463 * nor a sample number limit has to be supplied, it will just acquire
464 * samples continuously, until explicitly stopped by a certain command.
470 struct sr_hwcap_option {
478 struct sr_dev_driver *driver;
489 /** Types of device instances (sr_dev_inst). */
491 /** Device instance type for USB devices. */
493 /** Device instance type for serial port devices. */
497 /** Device instance status. */
499 /** The device instance was not found. */
501 /** The device instance was found, but is still booting. */
503 /** The device instance is live, but not in use. */
505 /** The device instance is actively in use in a session. */
510 * TODO: This sucks, you just kinda have to "know" the returned type.
511 * TODO: Need a DI to return the number of trigger stages supported.
514 /** Device info IDs. */
516 /** A list of options supported by the driver. */
518 /** A list of capabilities supported by the device. */
520 /** The number of probes connected to this device. */
522 /** The probe names on this device. */
524 /** Samplerates supported by this device (struct sr_samplerates). */
526 /** Types of logic trigger supported, out of "01crf" (char *). */
528 /** The currently set samplerate in Hz (uint64_t). */
529 SR_DI_CUR_SAMPLERATE,
530 /** Supported patterns (in pattern generator mode). */
532 /** Supported buffer sizes. */
534 /** Supported time bases. */
536 /** Supported trigger sources. */
537 SR_DI_TRIGGER_SOURCES,
538 /** Supported filter targets. */
540 /** Valid volts/div values. */
542 /** Coupling options. */
547 * A device supports either a range of samplerates with steps of a given
548 * granularity, or is limited to a set of defined samplerates. Use either
549 * step or list, but not both.
551 struct sr_samplerates {
555 const uint64_t *list;
558 struct sr_dev_driver {
559 /* Driver-specific */
564 int (*cleanup) (void);
565 GSList *(*scan) (GSList *options);
566 GSList *(*dev_list) (void);
567 int (*dev_clear) (void);
569 /* Device-specific */
570 int (*dev_open) (struct sr_dev_inst *sdi);
571 int (*dev_close) (struct sr_dev_inst *sdi);
572 int (*info_get) (int info_id, const void **data,
573 const struct sr_dev_inst *sdi);
574 int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap,
576 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
578 int (*dev_acquisition_stop) (const struct sr_dev_inst *sdi,
586 /** List of struct sr_dev pointers. */
588 /** List of sr_receive_data_callback_t items. */
589 GSList *datafeed_callbacks;
592 unsigned int num_sources;
595 * Both "sources" and "pollfds" are of the same size and contain pairs
596 * of descriptor and callback function. We can not embed the GPollFD
597 * into the source struct since we want to be able to pass the array
598 * of all poll descriptors to g_poll().
600 struct source *sources;