sr/drivers: add proper probe list to instances of all drivers
[sigrok:sigrok.git] / libsigrok / libsigrok.h
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 #ifndef LIBSIGROK_SIGROK_H
21 #define LIBSIGROK_SIGROK_H
22
23 #include <stdio.h>
24 #include <sys/time.h>
25 #include <stdint.h>
26 #include <inttypes.h>
27 #include <glib.h>
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 /*
34  * Status/error codes returned by libsigrok functions.
35  *
36  * All possible return codes of libsigrok functions must be listed here.
37  * Functions should never return hardcoded numbers as status, but rather
38  * use these #defines instead. All error codes are negative numbers.
39  *
40  * The error codes are globally unique in libsigrok, i.e. if one of the
41  * libsigrok functions returns a "malloc error" it must be exactly the same
42  * return value as used by all other functions to indicate "malloc error".
43  * There must be no functions which indicate two different errors via the
44  * same return code.
45  *
46  * Also, for compatibility reasons, no defined return codes are ever removed
47  * or reused for different #defines later. You can only add new #defines and
48  * return codes, but never remove or redefine existing ones.
49  */
50 #define SR_OK                 0 /* No error */
51 #define SR_ERR               -1 /* Generic/unspecified error */
52 #define SR_ERR_MALLOC        -2 /* Malloc/calloc/realloc error */
53 #define SR_ERR_ARG           -3 /* Function argument error */
54 #define SR_ERR_BUG           -4 /* Errors hinting at internal bugs */
55 #define SR_ERR_SAMPLERATE    -5 /* Incorrect samplerate */
56
57 #define SR_MAX_NUM_PROBES    64 /* Limited by uint64_t. */
58 #define SR_MAX_PROBENAME_LEN 32
59
60 /* Handy little macros */
61 #define SR_HZ(n)  (n)
62 #define SR_KHZ(n) ((n) * 1000)
63 #define SR_MHZ(n) ((n) * 1000000)
64 #define SR_GHZ(n) ((n) * 1000000000)
65
66 #define SR_HZ_TO_NS(n) (1000000000 / (n))
67
68 /* libsigrok loglevels. */
69 #define SR_LOG_NONE           0 /**< Output no messages at all. */
70 #define SR_LOG_ERR            1 /**< Output error messages. */
71 #define SR_LOG_WARN           2 /**< Output warnings. */
72 #define SR_LOG_INFO           3 /**< Output informational messages. */
73 #define SR_LOG_DBG            4 /**< Output debug messages. */
74 #define SR_LOG_SPEW           5 /**< Output very noisy debug messages. */
75
76 /*
77  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
78  *
79  * Variables and functions marked 'static' are private already and don't
80  * need SR_PRIV. However, functions which are not static (because they need
81  * to be used in other libsigrok-internal files) but are also not meant to
82  * be part of the public libsigrok API, must use SR_PRIV.
83  *
84  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
85  *
86  * This feature is not available on MinGW/Windows, as it is a feature of
87  * ELF files and MinGW/Windows uses PE files.
88  *
89  * Details: http://gcc.gnu.org/wiki/Visibility
90  */
91
92 /* Marks public libsigrok API symbols. */
93 #ifndef _WIN32
94 #define SR_API __attribute__((visibility("default")))
95 #else
96 #define SR_API
97 #endif
98
99 /* Marks private, non-public libsigrok symbols (not part of the API). */
100 #ifndef _WIN32
101 #define SR_PRIV __attribute__((visibility("hidden")))
102 #else
103 #define SR_PRIV
104 #endif
105
106 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
107
108 /* Data types used by hardware drivers for dev_config_set() */
109 enum {
110         SR_T_UINT64,
111         SR_T_CHAR,
112         SR_T_BOOL,
113         SR_T_FLOAT,
114         SR_T_RATIONAL_PERIOD,
115         SR_T_RATIONAL_VOLT,
116         SR_T_KEYVALUE,
117 };
118
119 struct sr_rational {
120         /* numerator */
121         uint64_t p;
122         /* denominator */
123         uint64_t q;
124 };
125
126 /* sr_datafeed_packet.type values */
127 enum {
128         SR_DF_HEADER,
129         SR_DF_END,
130         SR_DF_TRIGGER,
131         SR_DF_LOGIC,
132         SR_DF_META_LOGIC,
133         SR_DF_ANALOG,
134         SR_DF_META_ANALOG,
135         SR_DF_FRAME_BEGIN,
136         SR_DF_FRAME_END,
137 };
138
139 /* sr_datafeed_analog.mq values */
140 enum {
141         SR_MQ_VOLTAGE,
142         SR_MQ_CURRENT,
143         SR_MQ_RESISTANCE,
144         SR_MQ_CAPACITANCE,
145         SR_MQ_TEMPERATURE,
146         SR_MQ_FREQUENCY,
147         SR_MQ_DUTY_CYCLE,
148 };
149
150 /* sr_datafeed_analog.unit values */
151 enum {
152         SR_UNIT_VOLT,
153         SR_UNIT_AMPERE,
154         SR_UNIT_OHM,
155         SR_UNIT_FARAD,
156         SR_UNIT_CELSIUS,
157         SR_UNIT_KELVIN,
158         SR_UNIT_HERTZ,
159         SR_UNIT_PERCENTAGE,
160 };
161
162 struct sr_datafeed_packet {
163         uint16_t type;
164         void *payload;
165 };
166
167 struct sr_datafeed_header {
168         int feed_version;
169         struct timeval starttime;
170 };
171
172 struct sr_datafeed_meta_logic {
173         int num_probes;
174         uint64_t samplerate;
175 };
176
177 struct sr_datafeed_logic {
178         uint64_t length;
179         uint16_t unitsize;
180         void *data;
181 };
182
183 struct sr_datafeed_meta_analog {
184         int num_probes;
185 };
186
187 struct sr_datafeed_analog {
188         int num_samples;
189         int mq; /* Measured quantity (e.g. voltage, current, temperature) */
190         int unit; /* Unit in which the MQ is measured. */
191         float *data;
192 };
193
194 struct sr_input {
195         struct sr_input_format *format;
196         GHashTable *param;
197         struct sr_dev_inst *sdi;
198         void *internal;
199 };
200
201 struct sr_input_format {
202         char *id;
203         char *description;
204         int (*format_match) (const char *filename);
205         int (*init) (struct sr_input *in);
206         int (*loadfile) (struct sr_input *in, const char *filename);
207 };
208
209 struct sr_output {
210         struct sr_output_format *format;
211         struct sr_dev_inst *sdi;
212         char *param;
213         void *internal;
214 };
215
216 struct sr_output_format {
217         char *id;
218         char *description;
219         int df_type;
220         int (*init) (struct sr_output *o);
221         int (*data) (struct sr_output *o, const uint8_t *data_in,
222                      uint64_t length_in, uint8_t **data_out,
223                      uint64_t *length_out);
224         int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
225                       uint64_t *length_out);
226 };
227
228 struct sr_datastore {
229         /* Size in bytes of the number of units stored in this datastore */
230         int ds_unitsize;
231         unsigned int num_units; /* TODO: uint64_t */
232         GSList *chunklist;
233 };
234
235 /*
236  * This represents a generic device connected to the system.
237  * For device-specific information, ask the driver. The driver_index refers
238  * to the device index within that driver; it may be handling more than one
239  * device. All relevant driver calls take a dev_index parameter for this.
240  */
241 struct sr_dev {
242         /* Which driver handles this device */
243         struct sr_dev_driver *driver;
244         /* A driver may handle multiple devices of the same type */
245         int driver_index;
246         /* List of struct sr_probe* */
247         GSList *probes;
248         /* Data acquired by this device, if any */
249         struct sr_datastore *datastore;
250 };
251
252 enum {
253         SR_PROBE_LOGIC,
254         SR_PROBE_ANALOG,
255 };
256
257 struct sr_probe {
258         int index;
259         int type;
260         gboolean enabled;
261         char *name;
262         char *trigger;
263 };
264
265 struct sr_hwopt {
266         int hwopt;
267         const void *value;
268 };
269
270 /* Hardware driver options */
271 enum {
272         SR_HWOPT_DUMMY = 0, /* Used to terminate lists. Must be 0! */
273
274         /** Some drivers cannot detect the exact model they're talking to. */
275         SR_HWOPT_MODEL,
276
277         /** Specification on how to connect to a device */
278         SR_HWOPT_CONN,
279
280         /** Serial communication spec: <data bits><parity><stop bit> e.g. 8n1 */
281         SR_HWOPT_SERIALCOMM,
282 };
283
284 /* Hardware device capabilities */
285 enum {
286         SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
287
288         /*--- Device classes ------------------------------------------------*/
289
290         /** The device can act as logic analyzer. */
291         SR_HWCAP_LOGIC_ANALYZER,
292
293         /** The device can act as an oscilloscope. */
294         SR_HWCAP_OSCILLOSCOPE,
295
296         /** The device can act as a multimeter. */
297         SR_HWCAP_MULTIMETER,
298
299         /** The device is a demo device. */
300         SR_HWCAP_DEMO_DEV,
301
302
303         /*--- Device configuration ------------------------------------------*/
304
305         /** The device supports setting/changing its samplerate. */
306         SR_HWCAP_SAMPLERATE,
307
308         /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
309         /** The device supports setting a probe mask. */
310         SR_HWCAP_PROBECONFIG,
311
312         /** The device supports setting a pre/post-trigger capture ratio. */
313         SR_HWCAP_CAPTURE_RATIO,
314
315         /* TODO? */
316         /** The device supports setting a pattern (pattern generator mode). */
317         SR_HWCAP_PATTERN_MODE,
318
319         /** The device supports Run Length Encoding. */
320         SR_HWCAP_RLE,
321
322         /** The device supports setting trigger slope. */
323         SR_HWCAP_TRIGGER_SLOPE,
324
325         /** Trigger source. */
326         SR_HWCAP_TRIGGER_SOURCE,
327
328         /** Horizontal trigger position */
329         SR_HWCAP_HORIZ_TRIGGERPOS,
330
331         /** Buffer size. */
332         SR_HWCAP_BUFFERSIZE,
333
334         /** Time base. */
335         SR_HWCAP_TIMEBASE,
336
337         /** Filter. */
338         SR_HWCAP_FILTER,
339
340         /** Volts/div. */
341         SR_HWCAP_VDIV,
342
343         /** Coupling. */
344         SR_HWCAP_COUPLING,
345
346
347         /*--- Special stuff -------------------------------------------------*/
348
349         /** Session filename */
350         SR_HWCAP_SESSIONFILE,
351
352         /* TODO: Better description. */
353         /** The device supports specifying a capturefile to inject. */
354         SR_HWCAP_CAPTUREFILE,
355
356         /* TODO: Better description. */
357         /** The device supports specifying the capturefile unit size. */
358         SR_HWCAP_CAPTURE_UNITSIZE,
359
360         /* TODO: Better description. */
361         /** The device supports setting the number of probes. */
362         SR_HWCAP_CAPTURE_NUM_PROBES,
363
364
365         /*--- Acquisition modes ---------------------------------------------*/
366
367         /**
368          * The device supports setting a sample time limit, i.e. how long the
369          * sample acquisition should run (in ms).
370          */
371         SR_HWCAP_LIMIT_MSEC,
372
373         /**
374          * The device supports setting a sample number limit, i.e. how many
375          * samples should be acquired.
376          */
377         SR_HWCAP_LIMIT_SAMPLES,
378
379         /**
380          * The device supports setting a frame limit, i.e. how many
381          * frames should be acquired.
382          */
383         SR_HWCAP_LIMIT_FRAMES,
384
385         /**
386          * The device supports continuous sampling, i.e. neither a time limit
387          * nor a sample number limit has to be supplied, it will just acquire
388          * samples continuously, until explicitly stopped by a certain command.
389          */
390         SR_HWCAP_CONTINUOUS,
391
392 };
393
394 struct sr_hwcap_option {
395         int hwcap;
396         int type;
397         char *description;
398         char *shortname;
399 };
400
401 struct sr_dev_inst {
402         struct sr_dev_driver *driver;
403         int index;
404         int status;
405         int inst_type;
406         char *vendor;
407         char *model;
408         char *version;
409         GSList *probes;
410         void *priv;
411 };
412
413 /* sr_dev_inst types */
414 enum {
415         /** Device instance type for USB devices. */
416         SR_INST_USB,
417         /** Device instance type for serial port devices. */
418         SR_INST_SERIAL,
419 };
420
421 /* Device instance status */
422 enum {
423         SR_ST_NOT_FOUND,
424         /* Found, but still booting */
425         SR_ST_INITIALIZING,
426         /* Live, but not in use */
427         SR_ST_INACTIVE,
428         /* Actively in use in a session */
429         SR_ST_ACTIVE,
430 };
431
432 /*
433  * TODO: This sucks, you just kinda have to "know" the returned type.
434  * TODO: Need a DI to return the number of trigger stages supported.
435  */
436
437 /* Device info IDs */
438 enum {
439         /* struct sr_dev_inst for this specific device */
440         /* TODO: obsolete */
441         SR_DI_INST,
442         /* A list of options supported by the driver. */
443         SR_DI_HWOPTS,
444         /* A list of capabilities supported by the device. */
445         SR_DI_HWCAPS,
446         /* The number of probes connected to this device */
447         SR_DI_NUM_PROBES,
448         /* The probe names on this device */
449         SR_DI_PROBE_NAMES,
450         /* Samplerates supported by this device, (struct sr_samplerates) */
451         SR_DI_SAMPLERATES,
452         /* Types of logic trigger supported, out of "01crf" (char *) */
453         SR_DI_TRIGGER_TYPES,
454         /* The currently set samplerate in Hz (uint64_t) */
455         SR_DI_CUR_SAMPLERATE,
456         /* Supported patterns (in pattern generator mode) */
457         SR_DI_PATTERNS,
458         /* Supported buffer sizes */
459         SR_DI_BUFFERSIZES,
460         /* Supported time bases */
461         SR_DI_TIMEBASES,
462         /* Supported trigger sources */
463         SR_DI_TRIGGER_SOURCES,
464         /* Supported filter targets */
465         SR_DI_FILTERS,
466         /* Valid volts/div values */
467         SR_DI_VDIVS,
468         /* Coupling options */
469         SR_DI_COUPLING,
470 };
471
472 /*
473  * A device supports either a range of samplerates with steps of a given
474  * granularity, or is limited to a set of defined samplerates. Use either
475  * step or list, but not both.
476  */
477 struct sr_samplerates {
478         uint64_t low;
479         uint64_t high;
480         uint64_t step;
481         const uint64_t *list;
482 };
483
484 struct sr_dev_driver {
485         /* Driver-specific */
486         char *name;
487         char *longname;
488         int api_version;
489         int (*init) (void);
490         int (*cleanup) (void);
491         GSList *(*scan) (GSList *options);
492
493         /* Device-specific */
494         int (*dev_open) (struct sr_dev_inst *sdi);
495         int (*dev_close) (struct sr_dev_inst *sdi);
496         int (*info_get) (int info_id, const void **data,
497                         const struct sr_dev_inst *sdi);
498         int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap,
499                         const void *value);
500         int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
501                         void *cb_data);
502         int (*dev_acquisition_stop) (const struct sr_dev_inst *sdi,
503                         void *cb_data);
504
505         /* Dynamic */
506         GSList *instances;
507 };
508
509 struct sr_session {
510         /* List of struct sr_dev* */
511         GSList *devs;
512         /* list of sr_receive_data_callback_t */
513         GSList *datafeed_callbacks;
514         GTimeVal starttime;
515         gboolean running;
516
517         unsigned int num_sources;
518
519         /* Both "sources" and "pollfds" are of the same size and contain pairs of
520          * descriptor and callback function. We can not embed the GPollFD into the
521          * source struct since we want to be able to pass the array of all poll
522          * descriptors to g_poll.
523          */
524         struct source *sources;
525         GPollFD *pollfds;
526         int source_timeout;
527 };
528
529 #include "proto.h"
530 #include "version.h"
531
532 #ifdef __cplusplus
533 }
534 #endif
535
536 #endif