]>
Commit | Line | Data |
---|---|---|
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 | SR_MQ_CONTINUITY, | |
149 | SR_MQ_PULSE_WIDTH, | |
150 | SR_MQ_CONDUCTANCE, | |
151 | /** For a measurement of electrical power, usually in W, or dBm */ | |
152 | SR_MQ_POWER, | |
153 | /** Usually for measuring a transistor's gain, or h_FE*/ | |
154 | SR_MQ_GAIN, | |
155 | }; | |
156 | ||
157 | /* sr_datafeed_analog.unit values */ | |
158 | enum { | |
159 | SR_UNIT_VOLT, | |
160 | SR_UNIT_AMPERE, | |
161 | SR_UNIT_OHM, | |
162 | SR_UNIT_FARAD, | |
163 | SR_UNIT_KELVIN, | |
164 | SR_UNIT_CELSIUS, | |
165 | SR_UNIT_FAHRENHEIT, | |
166 | SR_UNIT_HERTZ, | |
167 | SR_UNIT_PERCENTAGE, | |
168 | SR_UNIT_BOOLEAN, | |
169 | SR_UNIT_SECOND, | |
170 | /** Unit of conductance, the inverse of resistance */ | |
171 | SR_UNIT_SIEMENS, | |
172 | /** An absolute measurement of power, in decibels, referenced to | |
173 | * 1 milliwatt */ | |
174 | SR_UNIT_DECIBEL_MW, | |
175 | /** Measurements that intrinsically, do not have units attached, such | |
176 | * as ratios, gains, etc | |
177 | * Specifically, a transistor's gain (hFE) is a unitless quantity*/ | |
178 | SR_UNIT_UNITLESS, | |
179 | }; | |
180 | ||
181 | /** sr_datafeed_analog.flags values */ | |
182 | enum { | |
183 | /** Voltage measurement is alternating current. */ | |
184 | SR_MQFLAG_AC = 0x01, | |
185 | /** Voltage measurement is direct current. */ | |
186 | SR_MQFLAG_DC = 0x02, | |
187 | /** This is a true RMS measurement. */ | |
188 | SR_MQFLAG_RMS = 0x04, | |
189 | /** Value is voltage drop across a diode, or NAN. */ | |
190 | SR_MQFLAG_DIODE = 0x08, | |
191 | /** Device is in "hold" mode, i.e. repeating the last measurement. */ | |
192 | SR_MQFLAG_HOLD = 0x10, | |
193 | /** Device is in "max" mode, only updating when a new max value is found. */ | |
194 | SR_MQFLAG_MAX = 0x20, | |
195 | /** Device is in "min" mode, only updating when a new min value is found. */ | |
196 | SR_MQFLAG_MIN = 0x40, | |
197 | /** Device is in autoranging mode. */ | |
198 | SR_MQFLAG_AUTORANGE = 0x80, | |
199 | /** Device is in relative mode. */ | |
200 | SR_MQFLAG_RELATIVE = 0x100, | |
201 | }; | |
202 | ||
203 | struct sr_datafeed_packet { | |
204 | uint16_t type; | |
205 | void *payload; | |
206 | }; | |
207 | ||
208 | struct sr_datafeed_header { | |
209 | int feed_version; | |
210 | struct timeval starttime; | |
211 | }; | |
212 | ||
213 | struct sr_datafeed_meta_logic { | |
214 | int num_probes; | |
215 | uint64_t samplerate; | |
216 | }; | |
217 | ||
218 | struct sr_datafeed_logic { | |
219 | uint64_t length; | |
220 | uint16_t unitsize; | |
221 | void *data; | |
222 | }; | |
223 | ||
224 | struct sr_datafeed_meta_analog { | |
225 | int num_probes; | |
226 | }; | |
227 | ||
228 | struct sr_datafeed_analog { | |
229 | int num_samples; | |
230 | /** Measured quantity (e.g. voltage, current, temperature) */ | |
231 | int mq; | |
232 | /** Unit in which the MQ is measured. */ | |
233 | int unit; | |
234 | /** Bitmap with extra information about the MQ. */ | |
235 | uint64_t mqflags; | |
236 | float *data; | |
237 | }; | |
238 | ||
239 | struct sr_input { | |
240 | struct sr_input_format *format; | |
241 | GHashTable *param; | |
242 | struct sr_dev_inst *sdi; | |
243 | void *internal; | |
244 | }; | |
245 | ||
246 | struct sr_input_format { | |
247 | char *id; | |
248 | char *description; | |
249 | int (*format_match) (const char *filename); | |
250 | int (*init) (struct sr_input *in); | |
251 | int (*loadfile) (struct sr_input *in, const char *filename); | |
252 | }; | |
253 | ||
254 | struct sr_output { | |
255 | struct sr_output_format *format; | |
256 | struct sr_dev_inst *sdi; | |
257 | char *param; | |
258 | void *internal; | |
259 | }; | |
260 | ||
261 | struct sr_output_format { | |
262 | char *id; | |
263 | char *description; | |
264 | int df_type; | |
265 | int (*init) (struct sr_output *o); | |
266 | int (*data) (struct sr_output *o, const uint8_t *data_in, | |
267 | uint64_t length_in, uint8_t **data_out, | |
268 | uint64_t *length_out); | |
269 | int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, | |
270 | uint64_t *length_out); | |
271 | GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi, | |
272 | struct sr_datafeed_packet *packet); | |
273 | int (*cleanup) (struct sr_output *o); | |
274 | }; | |
275 | ||
276 | struct sr_datastore { | |
277 | /* Size in bytes of the number of units stored in this datastore */ | |
278 | int ds_unitsize; | |
279 | unsigned int num_units; /* TODO: uint64_t */ | |
280 | GSList *chunklist; | |
281 | }; | |
282 | ||
283 | /* | |
284 | * This represents a generic device connected to the system. | |
285 | * For device-specific information, ask the driver. The driver_index refers | |
286 | * to the device index within that driver; it may be handling more than one | |
287 | * device. All relevant driver calls take a dev_index parameter for this. | |
288 | */ | |
289 | struct sr_dev { | |
290 | /* Which driver handles this device */ | |
291 | struct sr_dev_driver *driver; | |
292 | /* A driver may handle multiple devices of the same type */ | |
293 | int driver_index; | |
294 | /* List of struct sr_probe* */ | |
295 | GSList *probes; | |
296 | /* Data acquired by this device, if any */ | |
297 | struct sr_datastore *datastore; | |
298 | }; | |
299 | ||
300 | enum { | |
301 | SR_PROBE_LOGIC, | |
302 | SR_PROBE_ANALOG, | |
303 | }; | |
304 | ||
305 | struct sr_probe { | |
306 | int index; | |
307 | int type; | |
308 | gboolean enabled; | |
309 | char *name; | |
310 | char *trigger; | |
311 | }; | |
312 | ||
313 | struct sr_hwopt { | |
314 | int hwopt; | |
315 | const void *value; | |
316 | }; | |
317 | ||
318 | /* Hardware driver options */ | |
319 | enum { | |
320 | SR_HWOPT_DUMMY = 0, /* Used to terminate lists. Must be 0! */ | |
321 | ||
322 | /** Some drivers cannot detect the exact model they're talking to. */ | |
323 | SR_HWOPT_MODEL, | |
324 | ||
325 | /** Specification on how to connect to a device */ | |
326 | SR_HWOPT_CONN, | |
327 | ||
328 | /** Serial communication spec: <data bits><parity><stop bit> e.g. 8n1 */ | |
329 | SR_HWOPT_SERIALCOMM, | |
330 | }; | |
331 | ||
332 | /* Hardware device capabilities */ | |
333 | enum { | |
334 | SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */ | |
335 | ||
336 | /*--- Device classes ------------------------------------------------*/ | |
337 | ||
338 | /** The device can act as logic analyzer. */ | |
339 | SR_HWCAP_LOGIC_ANALYZER, | |
340 | ||
341 | /** The device can act as an oscilloscope. */ | |
342 | SR_HWCAP_OSCILLOSCOPE, | |
343 | ||
344 | /** The device can act as a multimeter. */ | |
345 | SR_HWCAP_MULTIMETER, | |
346 | ||
347 | /** The device is a demo device. */ | |
348 | SR_HWCAP_DEMO_DEV, | |
349 | ||
350 | ||
351 | /*--- Device configuration ------------------------------------------*/ | |
352 | ||
353 | /** The device supports setting/changing its samplerate. */ | |
354 | SR_HWCAP_SAMPLERATE, | |
355 | ||
356 | /** The device supports setting a pre/post-trigger capture ratio. */ | |
357 | SR_HWCAP_CAPTURE_RATIO, | |
358 | ||
359 | /* TODO? */ | |
360 | /** The device supports setting a pattern (pattern generator mode). */ | |
361 | SR_HWCAP_PATTERN_MODE, | |
362 | ||
363 | /** The device supports Run Length Encoding. */ | |
364 | SR_HWCAP_RLE, | |
365 | ||
366 | /** The device supports setting trigger slope. */ | |
367 | SR_HWCAP_TRIGGER_SLOPE, | |
368 | ||
369 | /** Trigger source. */ | |
370 | SR_HWCAP_TRIGGER_SOURCE, | |
371 | ||
372 | /** Horizontal trigger position */ | |
373 | SR_HWCAP_HORIZ_TRIGGERPOS, | |
374 | ||
375 | /** Buffer size. */ | |
376 | SR_HWCAP_BUFFERSIZE, | |
377 | ||
378 | /** Time base. */ | |
379 | SR_HWCAP_TIMEBASE, | |
380 | ||
381 | /** Filter. */ | |
382 | SR_HWCAP_FILTER, | |
383 | ||
384 | /** Volts/div. */ | |
385 | SR_HWCAP_VDIV, | |
386 | ||
387 | /** Coupling. */ | |
388 | SR_HWCAP_COUPLING, | |
389 | ||
390 | ||
391 | /*--- Special stuff -------------------------------------------------*/ | |
392 | ||
393 | /** Session filename */ | |
394 | SR_HWCAP_SESSIONFILE, | |
395 | ||
396 | /* TODO: Better description. */ | |
397 | /** The device supports specifying a capturefile to inject. */ | |
398 | SR_HWCAP_CAPTUREFILE, | |
399 | ||
400 | /* TODO: Better description. */ | |
401 | /** The device supports specifying the capturefile unit size. */ | |
402 | SR_HWCAP_CAPTURE_UNITSIZE, | |
403 | ||
404 | /* TODO: Better description. */ | |
405 | /** The device supports setting the number of probes. */ | |
406 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
407 | ||
408 | ||
409 | /*--- Acquisition modes ---------------------------------------------*/ | |
410 | ||
411 | /** | |
412 | * The device supports setting a sample time limit, i.e. how long the | |
413 | * sample acquisition should run (in ms). | |
414 | */ | |
415 | SR_HWCAP_LIMIT_MSEC, | |
416 | ||
417 | /** | |
418 | * The device supports setting a sample number limit, i.e. how many | |
419 | * samples should be acquired. | |
420 | */ | |
421 | SR_HWCAP_LIMIT_SAMPLES, | |
422 | ||
423 | /** | |
424 | * The device supports setting a frame limit, i.e. how many | |
425 | * frames should be acquired. | |
426 | */ | |
427 | SR_HWCAP_LIMIT_FRAMES, | |
428 | ||
429 | /** | |
430 | * The device supports continuous sampling, i.e. neither a time limit | |
431 | * nor a sample number limit has to be supplied, it will just acquire | |
432 | * samples continuously, until explicitly stopped by a certain command. | |
433 | */ | |
434 | SR_HWCAP_CONTINUOUS, | |
435 | ||
436 | }; | |
437 | ||
438 | struct sr_hwcap_option { | |
439 | int hwcap; | |
440 | int type; | |
441 | char *description; | |
442 | char *shortname; | |
443 | }; | |
444 | ||
445 | struct sr_dev_inst { | |
446 | struct sr_dev_driver *driver; | |
447 | int index; | |
448 | int status; | |
449 | int inst_type; | |
450 | char *vendor; | |
451 | char *model; | |
452 | char *version; | |
453 | GSList *probes; | |
454 | void *priv; | |
455 | }; | |
456 | ||
457 | /* sr_dev_inst types */ | |
458 | enum { | |
459 | /** Device instance type for USB devices. */ | |
460 | SR_INST_USB, | |
461 | /** Device instance type for serial port devices. */ | |
462 | SR_INST_SERIAL, | |
463 | }; | |
464 | ||
465 | /* Device instance status */ | |
466 | enum { | |
467 | SR_ST_NOT_FOUND, | |
468 | /* Found, but still booting */ | |
469 | SR_ST_INITIALIZING, | |
470 | /* Live, but not in use */ | |
471 | SR_ST_INACTIVE, | |
472 | /* Actively in use in a session */ | |
473 | SR_ST_ACTIVE, | |
474 | }; | |
475 | ||
476 | /* | |
477 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
478 | * TODO: Need a DI to return the number of trigger stages supported. | |
479 | */ | |
480 | ||
481 | /* Device info IDs */ | |
482 | enum { | |
483 | /* A list of options supported by the driver. */ | |
484 | SR_DI_HWOPTS, | |
485 | /* A list of capabilities supported by the device. */ | |
486 | SR_DI_HWCAPS, | |
487 | /* The number of probes connected to this device */ | |
488 | SR_DI_NUM_PROBES, | |
489 | /* The probe names on this device */ | |
490 | SR_DI_PROBE_NAMES, | |
491 | /* Samplerates supported by this device, (struct sr_samplerates) */ | |
492 | SR_DI_SAMPLERATES, | |
493 | /* Types of logic trigger supported, out of "01crf" (char *) */ | |
494 | SR_DI_TRIGGER_TYPES, | |
495 | /* The currently set samplerate in Hz (uint64_t) */ | |
496 | SR_DI_CUR_SAMPLERATE, | |
497 | /* Supported patterns (in pattern generator mode) */ | |
498 | SR_DI_PATTERNS, | |
499 | /* Supported buffer sizes */ | |
500 | SR_DI_BUFFERSIZES, | |
501 | /* Supported time bases */ | |
502 | SR_DI_TIMEBASES, | |
503 | /* Supported trigger sources */ | |
504 | SR_DI_TRIGGER_SOURCES, | |
505 | /* Supported filter targets */ | |
506 | SR_DI_FILTERS, | |
507 | /* Valid volts/div values */ | |
508 | SR_DI_VDIVS, | |
509 | /* Coupling options */ | |
510 | SR_DI_COUPLING, | |
511 | }; | |
512 | ||
513 | /* | |
514 | * A device supports either a range of samplerates with steps of a given | |
515 | * granularity, or is limited to a set of defined samplerates. Use either | |
516 | * step or list, but not both. | |
517 | */ | |
518 | struct sr_samplerates { | |
519 | uint64_t low; | |
520 | uint64_t high; | |
521 | uint64_t step; | |
522 | const uint64_t *list; | |
523 | }; | |
524 | ||
525 | struct sr_dev_driver { | |
526 | /* Driver-specific */ | |
527 | char *name; | |
528 | char *longname; | |
529 | int api_version; | |
530 | int (*init) (void); | |
531 | int (*cleanup) (void); | |
532 | GSList *(*scan) (GSList *options); | |
533 | GSList *(*dev_list) (void); | |
534 | int (*dev_clear) (void); | |
535 | ||
536 | /* Device-specific */ | |
537 | int (*dev_open) (struct sr_dev_inst *sdi); | |
538 | int (*dev_close) (struct sr_dev_inst *sdi); | |
539 | int (*info_get) (int info_id, const void **data, | |
540 | const struct sr_dev_inst *sdi); | |
541 | int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap, | |
542 | const void *value); | |
543 | int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, | |
544 | void *cb_data); | |
545 | int (*dev_acquisition_stop) (const struct sr_dev_inst *sdi, | |
546 | void *cb_data); | |
547 | ||
548 | /* Dynamic */ | |
549 | void *priv; | |
550 | }; | |
551 | ||
552 | /* Private driver context. */ | |
553 | struct drv_context { | |
554 | GSList *instances; | |
555 | }; | |
556 | ||
557 | struct sr_session { | |
558 | /* List of struct sr_dev* */ | |
559 | GSList *devs; | |
560 | /* list of sr_receive_data_callback_t */ | |
561 | GSList *datafeed_callbacks; | |
562 | GTimeVal starttime; | |
563 | ||
564 | unsigned int num_sources; | |
565 | ||
566 | /* Both "sources" and "pollfds" are of the same size and contain pairs of | |
567 | * descriptor and callback function. We can not embed the GPollFD into the | |
568 | * source struct since we want to be able to pass the array of all poll | |
569 | * descriptors to g_poll. | |
570 | */ | |
571 | struct source *sources; | |
572 | GPollFD *pollfds; | |
573 | int source_timeout; | |
574 | }; | |
575 | ||
576 | #include "proto.h" | |
577 | #include "version.h" | |
578 | ||
579 | #ifdef __cplusplus | |
580 | } | |
581 | #endif | |
582 | ||
583 | #endif |