]>
Commit | Line | Data |
---|---|---|
a1bb33af UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010 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 SIGROK_SIGROK_H | |
21 | #define SIGROK_SIGROK_H | |
22 | ||
23 | #include <stdio.h> | |
24 | #include <sys/time.h> | |
25 | #include <stdint.h> | |
26 | #include <inttypes.h> | |
27 | #include <glib.h> | |
22b02383 | 28 | #ifdef HAVE_LIBUSB_1_0 |
a1bb33af | 29 | #include <libusb.h> |
22b02383 | 30 | #endif |
a1bb33af | 31 | |
a00b530c UH |
32 | #ifdef __cplusplus |
33 | extern "C" { | |
34 | #endif | |
35 | ||
e31b636d UH |
36 | /* |
37 | * Status/error codes returned by libsigrok functions. | |
38 | * | |
39 | * All possible return codes of libsigrok functions must be listed here. | |
40 | * Functions should never return hardcoded numbers as status, but rather | |
41 | * use these #defines instead. All error codes are negative numbers. | |
42 | * | |
43 | * The error codes are globally unique in libsigrok, i.e. if one of the | |
2b3414a4 UH |
44 | * libsigrok functions returns a "malloc error" it must be exactly the same |
45 | * return value as used by all other functions to indicate "malloc error". | |
e31b636d UH |
46 | * There must be no functions which indicate two different errors via the |
47 | * same return code. | |
48 | * | |
49 | * Also, for compatibility reasons, no defined return codes are ever removed | |
50 | * or reused for different #defines later. You can only add new #defines and | |
51 | * return codes, but never remove or redefine existing ones. | |
52 | */ | |
e46b8fb1 UH |
53 | #define SR_OK 0 /* No error */ |
54 | #define SR_ERR -1 /* Generic/unspecified error */ | |
55 | #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ | |
f7d2982d UH |
56 | #define SR_ERR_ARG -3 /* Function argument error */ |
57 | #define SR_ERR_SAMPLERATE -4 /* Incorrect samplerate */ | |
a1bb33af | 58 | |
9688b443 UH |
59 | #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ |
60 | #define SR_MAX_PROBENAME_LEN 32 | |
2a3f9541 | 61 | |
a1bb33af | 62 | /* Handy little macros */ |
c9140419 | 63 | #define SR_HZ(n) (n) |
59df0c77 UH |
64 | #define SR_KHZ(n) ((n) * 1000) |
65 | #define SR_MHZ(n) ((n) * 1000000) | |
66 | #define SR_GHZ(n) ((n) * 1000000000) | |
a1bb33af | 67 | |
59df0c77 | 68 | #define SR_HZ_TO_NS(n) (1000000000 / (n)) |
3677f3ec | 69 | |
1352eedd | 70 | /* libsigrok loglevels. */ |
8e49cebd BV |
71 | #define SR_LOG_NONE 0 |
72 | #define SR_LOG_ERR 1 | |
73 | #define SR_LOG_WARN 2 | |
74 | #define SR_LOG_INFO 3 | |
75 | #define SR_LOG_DBG 4 | |
76 | #define SR_LOG_SPEW 5 | |
1352eedd | 77 | |
a887e3da | 78 | typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data); |
882e2075 | 79 | |
882e2075 | 80 | /* Data types used by hardware plugins for set_configuration() */ |
a1bb33af | 81 | enum { |
5a2326a7 UH |
82 | SR_T_UINT64, |
83 | SR_T_CHAR, | |
4d436e71 | 84 | SR_T_BOOL, |
a1bb33af UH |
85 | }; |
86 | ||
8bb416be | 87 | #if 0 |
a1bb33af | 88 | /* (Unused) protocol decoder stack entry */ |
809c5f20 | 89 | struct sr_protocol { |
a1bb33af UH |
90 | char *name; |
91 | int id; | |
92 | int stackindex; | |
93 | }; | |
8bb416be | 94 | #endif |
a1bb33af | 95 | |
b9c735a2 | 96 | /* sr_datafeed_packet.type values */ |
a1bb33af | 97 | enum { |
5a2326a7 UH |
98 | SR_DF_HEADER, |
99 | SR_DF_END, | |
100 | SR_DF_TRIGGER, | |
101 | SR_DF_LOGIC, | |
102 | SR_DF_ANALOG, | |
103 | SR_DF_PD, | |
a1bb33af UH |
104 | }; |
105 | ||
b9c735a2 | 106 | struct sr_datafeed_packet { |
a1bb33af | 107 | uint16_t type; |
38ab3ee7 BV |
108 | /* timeoffset since start, in picoseconds */ |
109 | uint64_t timeoffset; | |
110 | /* duration of data in this packet, in picoseconds */ | |
111 | uint64_t duration; | |
a1bb33af UH |
112 | void *payload; |
113 | }; | |
114 | ||
b9c735a2 | 115 | struct sr_datafeed_header { |
a1bb33af UH |
116 | int feed_version; |
117 | struct timeval starttime; | |
4c100f32 | 118 | uint64_t samplerate; |
921e753f DR |
119 | int num_analog_probes; |
120 | int num_logic_probes; | |
a1bb33af UH |
121 | }; |
122 | ||
38ab3ee7 BV |
123 | struct sr_datafeed_logic { |
124 | uint64_t length; | |
125 | uint16_t unitsize; | |
9c939c51 | 126 | void *data; |
38ab3ee7 BV |
127 | }; |
128 | ||
129 | struct sr_datafeed_pd { | |
130 | char *protocol; | |
131 | char *annotation; | |
132 | unsigned char *data; | |
133 | }; | |
134 | ||
92b3101c | 135 | #if defined(HAVE_LA_ALSA) |
809c5f20 | 136 | struct sr_analog_probe { |
48d783e4 | 137 | uint8_t att; |
c3579621 DR |
138 | uint8_t res; /* Needs to be a power of 2, FIXME */ |
139 | uint16_t val; /* Max hardware ADC width is 16bits */ | |
48d783e4 DR |
140 | }; |
141 | ||
809c5f20 | 142 | struct sr_analog_sample { |
c3579621 | 143 | uint8_t num_probes; /* Max hardware probes is 256 */ |
809c5f20 | 144 | struct sr_analog_probe probes[]; |
48d783e4 | 145 | }; |
8bb416be | 146 | #endif |
48d783e4 | 147 | |
f50f3f40 UH |
148 | struct sr_input { |
149 | struct sr_input_format *format; | |
13a12913 | 150 | char *param; |
5c2d46d1 | 151 | struct sr_device *vdevice; |
34e4813f BV |
152 | }; |
153 | ||
f50f3f40 | 154 | struct sr_input_format { |
cdb3573c | 155 | char *id; |
34e4813f | 156 | char *description; |
757b8c62 | 157 | int (*format_match) (const char *filename); |
f50f3f40 UH |
158 | int (*init) (struct sr_input *in); |
159 | int (*loadfile) (struct sr_input *in, const char *filename); | |
34e4813f BV |
160 | }; |
161 | ||
f50f3f40 UH |
162 | struct sr_output { |
163 | struct sr_output_format *format; | |
5c2d46d1 | 164 | struct sr_device *device; |
a1bb33af UH |
165 | char *param; |
166 | void *internal; | |
167 | }; | |
168 | ||
f50f3f40 | 169 | struct sr_output_format { |
cdb3573c | 170 | char *id; |
a1bb33af | 171 | char *description; |
f0411b1d | 172 | int df_type; |
f50f3f40 | 173 | int (*init) (struct sr_output *o); |
54ac5277 UH |
174 | int (*data) (struct sr_output *o, const char *data_in, |
175 | uint64_t length_in, char **data_out, uint64_t *length_out); | |
f50f3f40 | 176 | int (*event) (struct sr_output *o, int event_type, char **data_out, |
a1bb33af UH |
177 | uint64_t *length_out); |
178 | }; | |
179 | ||
8bb416be | 180 | #if 0 |
809c5f20 | 181 | struct sr_analyzer { |
a1bb33af UH |
182 | char *name; |
183 | char *filename; | |
184 | /* | |
185 | * TODO: Parameters? If so, configured plugins need another struct. | |
186 | * TODO: Input and output format? | |
187 | */ | |
188 | }; | |
8bb416be | 189 | #endif |
a1bb33af | 190 | |
c4911129 | 191 | struct sr_datastore { |
a1bb33af UH |
192 | /* Size in bytes of the number of units stored in this datastore */ |
193 | int ds_unitsize; | |
33247d6a | 194 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
195 | GSList *chunklist; |
196 | }; | |
197 | ||
a1bb33af UH |
198 | /* |
199 | * This represents a generic device connected to the system. | |
200 | * For device-specific information, ask the plugin. The plugin_index refers | |
201 | * to the device index within that plugin; it may be handling more than one | |
202 | * device. All relevant plugin calls take a device_index parameter for this. | |
203 | */ | |
5c2d46d1 | 204 | struct sr_device { |
a1bb33af | 205 | /* Which plugin handles this device */ |
5c2d46d1 | 206 | struct sr_device_plugin *plugin; |
a1bb33af UH |
207 | /* A plugin may handle multiple devices of the same type */ |
208 | int plugin_index; | |
1afe8989 | 209 | /* List of struct sr_probe* */ |
a1bb33af UH |
210 | GSList *probes; |
211 | /* Data acquired by this device, if any */ | |
c4911129 | 212 | struct sr_datastore *datastore; |
a1bb33af UH |
213 | }; |
214 | ||
921e753f | 215 | enum { |
5a2326a7 UH |
216 | SR_PROBE_TYPE_LOGIC, |
217 | SR_PROBE_TYPE_ANALOG, | |
921e753f DR |
218 | }; |
219 | ||
1afe8989 | 220 | struct sr_probe { |
a1bb33af | 221 | int index; |
6ea7e235 | 222 | int type; |
a1bb33af UH |
223 | gboolean enabled; |
224 | char *name; | |
225 | char *trigger; | |
226 | }; | |
227 | ||
8bb416be | 228 | /* TODO: Get rid of this global variable. */ |
a1bb33af UH |
229 | extern GSList *devices; |
230 | ||
a1bb33af UH |
231 | /* Hardware plugin capabilities */ |
232 | enum { | |
5a2326a7 | 233 | SR_HWCAP_DUMMY, /* Used to terminate lists */ |
e88dadd7 UH |
234 | |
235 | /*--- Device classes ------------------------------------------------*/ | |
236 | ||
237 | /** The device can act as logic analyzer. */ | |
5a2326a7 | 238 | SR_HWCAP_LOGIC_ANALYZER, |
925dbf9f | 239 | |
e88dadd7 UH |
240 | /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */ |
241 | ||
242 | /*--- Device options ------------------------------------------------*/ | |
243 | ||
244 | /** The device supports setting/changing its samplerate. */ | |
245 | SR_HWCAP_SAMPLERATE, | |
246 | ||
247 | /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */ | |
248 | /** The device supports setting a probe mask. */ | |
249 | SR_HWCAP_PROBECONFIG, | |
250 | ||
251 | /** The device supports setting a pre/post-trigger capture ratio. */ | |
252 | SR_HWCAP_CAPTURE_RATIO, | |
253 | ||
254 | /* TODO? */ | |
255 | /** The device supports setting a pattern (pattern generator mode). */ | |
256 | SR_HWCAP_PATTERN_MODE, | |
257 | ||
3a4d09c0 GM |
258 | /** The device supports Run Length Encoding. */ |
259 | SR_HWCAP_RLE, | |
260 | ||
e88dadd7 UH |
261 | /*--- Special stuff -------------------------------------------------*/ |
262 | ||
263 | /* TODO: Better description. */ | |
264 | /** The device supports specifying a capturefile to inject. */ | |
265 | SR_HWCAP_CAPTUREFILE, | |
925dbf9f | 266 | |
e88dadd7 UH |
267 | /* TODO: Better description. */ |
268 | /** The device supports specifying the capturefile unit size. */ | |
269 | SR_HWCAP_CAPTURE_UNITSIZE, | |
7d658874 | 270 | |
e88dadd7 UH |
271 | /* TODO: Better description. */ |
272 | /** The device supports setting the number of probes. */ | |
273 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
274 | ||
275 | /*--- Acquisition modes ---------------------------------------------*/ | |
276 | ||
277 | /** | |
278 | * The device supports setting a sample time limit, i.e. how long the | |
279 | * sample acquisition should run (in ms). | |
280 | */ | |
281 | SR_HWCAP_LIMIT_MSEC, | |
282 | ||
283 | /** | |
284 | * The device supports setting a sample number limit, i.e. how many | |
285 | * samples should be acquired. | |
286 | */ | |
287 | SR_HWCAP_LIMIT_SAMPLES, | |
288 | ||
289 | /** | |
290 | * The device supports continuous sampling, i.e. neither a time limit | |
291 | * nor a sample number limit has to be supplied, it will just acquire | |
292 | * samples continuously, until explicitly stopped by a certain command. | |
293 | */ | |
5a2326a7 | 294 | SR_HWCAP_CONTINUOUS, |
e88dadd7 UH |
295 | |
296 | /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */ | |
a1bb33af UH |
297 | }; |
298 | ||
a65de030 | 299 | struct sr_hwcap_option { |
a1bb33af UH |
300 | int capability; |
301 | int type; | |
302 | char *description; | |
303 | char *shortname; | |
304 | }; | |
305 | ||
a00ba012 | 306 | struct sr_device_instance { |
a1bb33af UH |
307 | int index; |
308 | int status; | |
309 | int instance_type; | |
310 | char *vendor; | |
311 | char *model; | |
312 | char *version; | |
8d672550 | 313 | void *priv; |
a1bb33af | 314 | union { |
6c290072 UH |
315 | struct sr_usb_device_instance *usb; |
316 | struct sr_serial_device_instance *serial; | |
a1bb33af UH |
317 | }; |
318 | }; | |
319 | ||
a00ba012 | 320 | /* sr_device_instance types */ |
a1bb33af | 321 | enum { |
5a2326a7 UH |
322 | SR_USB_INSTANCE, |
323 | SR_SERIAL_INSTANCE, | |
a1bb33af UH |
324 | }; |
325 | ||
22b02383 | 326 | #ifdef HAVE_LIBUSB_1_0 |
6c290072 | 327 | struct sr_usb_device_instance { |
a1bb33af UH |
328 | uint8_t bus; |
329 | uint8_t address; | |
330 | struct libusb_device_handle *devhdl; | |
331 | }; | |
22b02383 | 332 | #endif |
a1bb33af | 333 | |
6c290072 | 334 | struct sr_serial_device_instance { |
a1bb33af UH |
335 | char *port; |
336 | int fd; | |
337 | }; | |
338 | ||
339 | /* Device instance status */ | |
340 | enum { | |
5a2326a7 | 341 | SR_ST_NOT_FOUND, |
a1bb33af | 342 | /* Found, but still booting */ |
5a2326a7 | 343 | SR_ST_INITIALIZING, |
a1bb33af | 344 | /* Live, but not in use */ |
5a2326a7 | 345 | SR_ST_INACTIVE, |
a1bb33af | 346 | /* Actively in use in a session */ |
5a2326a7 | 347 | SR_ST_ACTIVE, |
a1bb33af UH |
348 | }; |
349 | ||
350 | /* | |
351 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
352 | * TODO: Need a DI to return the number of trigger stages supported. | |
353 | */ | |
354 | ||
355 | /* Device info IDs */ | |
356 | enum { | |
a00ba012 | 357 | /* struct sr_device_instance for this specific device */ |
5a2326a7 | 358 | SR_DI_INSTANCE, |
a1bb33af | 359 | /* The number of probes connected to this device */ |
5a2326a7 | 360 | SR_DI_NUM_PROBES, |
60679b18 | 361 | /* Samplerates supported by this device, (struct sr_samplerates) */ |
5a2326a7 | 362 | SR_DI_SAMPLERATES, |
a1bb33af | 363 | /* Types of trigger supported, out of "01crf" (char *) */ |
5a2326a7 | 364 | SR_DI_TRIGGER_TYPES, |
4c100f32 | 365 | /* The currently set samplerate in Hz (uint64_t) */ |
5a2326a7 | 366 | SR_DI_CUR_SAMPLERATE, |
925dbf9f | 367 | /* Supported pattern generator modes */ |
5a2326a7 | 368 | SR_DI_PATTERNMODES, |
a1bb33af UH |
369 | }; |
370 | ||
1b452b85 UH |
371 | /* |
372 | * A device supports either a range of samplerates with steps of a given | |
373 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
374 | * step or list, but not both. |
375 | */ | |
60679b18 | 376 | struct sr_samplerates { |
a1bb33af UH |
377 | uint64_t low; |
378 | uint64_t high; | |
379 | uint64_t step; | |
380 | uint64_t *list; | |
381 | }; | |
382 | ||
5c2d46d1 | 383 | struct sr_device_plugin { |
1b452b85 | 384 | /* Plugin-specific */ |
a1bb33af | 385 | char *name; |
9f8274a5 | 386 | char *longname; |
a1bb33af | 387 | int api_version; |
54ac5277 | 388 | int (*init) (const char *deviceinfo); |
a1bb33af UH |
389 | void (*cleanup) (void); |
390 | ||
1b452b85 | 391 | /* Device-specific */ |
86f5e3d8 | 392 | int (*opendev) (int device_index); |
697785d1 | 393 | int (*closedev) (int device_index); |
a1bb33af UH |
394 | void *(*get_device_info) (int device_index, int device_info_id); |
395 | int (*get_status) (int device_index); | |
396 | int *(*get_capabilities) (void); | |
397 | int (*set_configuration) (int device_index, int capability, void *value); | |
398 | int (*start_acquisition) (int device_index, gpointer session_device_id); | |
399 | void (*stop_acquisition) (int device_index, gpointer session_device_id); | |
400 | }; | |
401 | ||
2872d21e | 402 | struct sr_session { |
5c2d46d1 | 403 | /* List of struct sr_device* */ |
a1bb33af UH |
404 | GSList *devices; |
405 | /* List of struct analyzer* */ | |
406 | GSList *analyzers; | |
a887e3da | 407 | /* list of sr_receive_data_callback */ |
a1bb33af UH |
408 | GSList *datafeed_callbacks; |
409 | GTimeVal starttime; | |
544a4582 | 410 | gboolean running; |
a1bb33af UH |
411 | }; |
412 | ||
882e2075 | 413 | #include "sigrok-proto.h" |
c2bd92ec | 414 | |
a00b530c UH |
415 | #ifdef __cplusplus |
416 | } | |
417 | #endif | |
418 | ||
a1bb33af | 419 | #endif |