]>
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 UH |
70 | /* libsigrok loglevels. */ |
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 | ||
a887e3da | 77 | typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data); |
882e2075 | 78 | |
882e2075 | 79 | /* Data types used by hardware plugins for set_configuration() */ |
a1bb33af | 80 | enum { |
5a2326a7 UH |
81 | SR_T_UINT64, |
82 | SR_T_CHAR, | |
83 | SR_T_NULL, | |
a1bb33af UH |
84 | }; |
85 | ||
86 | enum { | |
5a2326a7 | 87 | SR_PROTO_RAW, |
a1bb33af UH |
88 | }; |
89 | ||
8bb416be | 90 | #if 0 |
a1bb33af | 91 | /* (Unused) protocol decoder stack entry */ |
809c5f20 | 92 | struct sr_protocol { |
a1bb33af UH |
93 | char *name; |
94 | int id; | |
95 | int stackindex; | |
96 | }; | |
8bb416be | 97 | #endif |
a1bb33af | 98 | |
b9c735a2 | 99 | /* sr_datafeed_packet.type values */ |
a1bb33af | 100 | enum { |
5a2326a7 UH |
101 | SR_DF_HEADER, |
102 | SR_DF_END, | |
103 | SR_DF_TRIGGER, | |
104 | SR_DF_LOGIC, | |
105 | SR_DF_ANALOG, | |
106 | SR_DF_PD, | |
a1bb33af UH |
107 | }; |
108 | ||
b9c735a2 | 109 | struct sr_datafeed_packet { |
a1bb33af | 110 | uint16_t type; |
e1aac231 | 111 | uint64_t length; |
4c046c6b | 112 | uint16_t unitsize; |
a1bb33af UH |
113 | void *payload; |
114 | }; | |
115 | ||
b9c735a2 | 116 | struct sr_datafeed_header { |
a1bb33af UH |
117 | int feed_version; |
118 | struct timeval starttime; | |
4c100f32 | 119 | uint64_t samplerate; |
a1bb33af | 120 | int protocol_id; |
921e753f DR |
121 | int num_analog_probes; |
122 | int num_logic_probes; | |
a1bb33af UH |
123 | }; |
124 | ||
92b3101c | 125 | #if defined(HAVE_LA_ALSA) |
809c5f20 | 126 | struct sr_analog_probe { |
48d783e4 | 127 | uint8_t att; |
c3579621 DR |
128 | uint8_t res; /* Needs to be a power of 2, FIXME */ |
129 | uint16_t val; /* Max hardware ADC width is 16bits */ | |
48d783e4 DR |
130 | }; |
131 | ||
809c5f20 | 132 | struct sr_analog_sample { |
c3579621 | 133 | uint8_t num_probes; /* Max hardware probes is 256 */ |
809c5f20 | 134 | struct sr_analog_probe probes[]; |
48d783e4 | 135 | }; |
8bb416be | 136 | #endif |
48d783e4 | 137 | |
f50f3f40 UH |
138 | struct sr_input { |
139 | struct sr_input_format *format; | |
13a12913 | 140 | char *param; |
5c2d46d1 | 141 | struct sr_device *vdevice; |
34e4813f BV |
142 | }; |
143 | ||
f50f3f40 | 144 | struct sr_input_format { |
cdb3573c | 145 | char *id; |
34e4813f | 146 | char *description; |
757b8c62 | 147 | int (*format_match) (const char *filename); |
f50f3f40 UH |
148 | int (*init) (struct sr_input *in); |
149 | int (*loadfile) (struct sr_input *in, const char *filename); | |
34e4813f BV |
150 | }; |
151 | ||
f50f3f40 UH |
152 | struct sr_output { |
153 | struct sr_output_format *format; | |
5c2d46d1 | 154 | struct sr_device *device; |
a1bb33af UH |
155 | char *param; |
156 | void *internal; | |
157 | }; | |
158 | ||
f50f3f40 | 159 | struct sr_output_format { |
cdb3573c | 160 | char *id; |
a1bb33af | 161 | char *description; |
f0411b1d | 162 | int df_type; |
f50f3f40 | 163 | int (*init) (struct sr_output *o); |
54ac5277 UH |
164 | int (*data) (struct sr_output *o, const char *data_in, |
165 | uint64_t length_in, char **data_out, uint64_t *length_out); | |
f50f3f40 | 166 | int (*event) (struct sr_output *o, int event_type, char **data_out, |
a1bb33af UH |
167 | uint64_t *length_out); |
168 | }; | |
169 | ||
8bb416be | 170 | #if 0 |
809c5f20 | 171 | struct sr_analyzer { |
a1bb33af UH |
172 | char *name; |
173 | char *filename; | |
174 | /* | |
175 | * TODO: Parameters? If so, configured plugins need another struct. | |
176 | * TODO: Input and output format? | |
177 | */ | |
178 | }; | |
8bb416be | 179 | #endif |
a1bb33af | 180 | |
c4911129 | 181 | struct sr_datastore { |
a1bb33af UH |
182 | /* Size in bytes of the number of units stored in this datastore */ |
183 | int ds_unitsize; | |
33247d6a | 184 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
185 | GSList *chunklist; |
186 | }; | |
187 | ||
a1bb33af UH |
188 | /* |
189 | * This represents a generic device connected to the system. | |
190 | * For device-specific information, ask the plugin. The plugin_index refers | |
191 | * to the device index within that plugin; it may be handling more than one | |
192 | * device. All relevant plugin calls take a device_index parameter for this. | |
193 | */ | |
5c2d46d1 | 194 | struct sr_device { |
a1bb33af | 195 | /* Which plugin handles this device */ |
5c2d46d1 | 196 | struct sr_device_plugin *plugin; |
a1bb33af UH |
197 | /* A plugin may handle multiple devices of the same type */ |
198 | int plugin_index; | |
1afe8989 | 199 | /* List of struct sr_probe* */ |
a1bb33af UH |
200 | GSList *probes; |
201 | /* Data acquired by this device, if any */ | |
c4911129 | 202 | struct sr_datastore *datastore; |
a1bb33af UH |
203 | }; |
204 | ||
921e753f | 205 | enum { |
5a2326a7 UH |
206 | SR_PROBE_TYPE_LOGIC, |
207 | SR_PROBE_TYPE_ANALOG, | |
921e753f DR |
208 | }; |
209 | ||
1afe8989 | 210 | struct sr_probe { |
a1bb33af | 211 | int index; |
6ea7e235 | 212 | int type; |
a1bb33af UH |
213 | gboolean enabled; |
214 | char *name; | |
215 | char *trigger; | |
216 | }; | |
217 | ||
8bb416be | 218 | /* TODO: Get rid of this global variable. */ |
a1bb33af UH |
219 | extern GSList *devices; |
220 | ||
a1bb33af UH |
221 | /* Hardware plugin capabilities */ |
222 | enum { | |
5a2326a7 | 223 | SR_HWCAP_DUMMY, /* Used to terminate lists */ |
e88dadd7 UH |
224 | |
225 | /*--- Device classes ------------------------------------------------*/ | |
226 | ||
227 | /** The device can act as logic analyzer. */ | |
5a2326a7 | 228 | SR_HWCAP_LOGIC_ANALYZER, |
925dbf9f | 229 | |
e88dadd7 UH |
230 | /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */ |
231 | ||
232 | /*--- Device options ------------------------------------------------*/ | |
233 | ||
234 | /** The device supports setting/changing its samplerate. */ | |
235 | SR_HWCAP_SAMPLERATE, | |
236 | ||
237 | /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */ | |
238 | /** The device supports setting a probe mask. */ | |
239 | SR_HWCAP_PROBECONFIG, | |
240 | ||
241 | /** The device supports setting a pre/post-trigger capture ratio. */ | |
242 | SR_HWCAP_CAPTURE_RATIO, | |
243 | ||
244 | /* TODO? */ | |
245 | /** The device supports setting a pattern (pattern generator mode). */ | |
246 | SR_HWCAP_PATTERN_MODE, | |
247 | ||
248 | /*--- Special stuff -------------------------------------------------*/ | |
249 | ||
250 | /* TODO: Better description. */ | |
251 | /** The device supports specifying a capturefile to inject. */ | |
252 | SR_HWCAP_CAPTUREFILE, | |
925dbf9f | 253 | |
e88dadd7 UH |
254 | /* TODO: Better description. */ |
255 | /** The device supports specifying the capturefile unit size. */ | |
256 | SR_HWCAP_CAPTURE_UNITSIZE, | |
7d658874 | 257 | |
e88dadd7 UH |
258 | /* TODO: Better description. */ |
259 | /** The device supports setting the number of probes. */ | |
260 | SR_HWCAP_CAPTURE_NUM_PROBES, | |
261 | ||
262 | /*--- Acquisition modes ---------------------------------------------*/ | |
263 | ||
264 | /** | |
265 | * The device supports setting a sample time limit, i.e. how long the | |
266 | * sample acquisition should run (in ms). | |
267 | */ | |
268 | SR_HWCAP_LIMIT_MSEC, | |
269 | ||
270 | /** | |
271 | * The device supports setting a sample number limit, i.e. how many | |
272 | * samples should be acquired. | |
273 | */ | |
274 | SR_HWCAP_LIMIT_SAMPLES, | |
275 | ||
276 | /** | |
277 | * The device supports continuous sampling, i.e. neither a time limit | |
278 | * nor a sample number limit has to be supplied, it will just acquire | |
279 | * samples continuously, until explicitly stopped by a certain command. | |
280 | */ | |
5a2326a7 | 281 | SR_HWCAP_CONTINUOUS, |
e88dadd7 UH |
282 | |
283 | /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */ | |
a1bb33af UH |
284 | }; |
285 | ||
a65de030 | 286 | struct sr_hwcap_option { |
a1bb33af UH |
287 | int capability; |
288 | int type; | |
289 | char *description; | |
290 | char *shortname; | |
291 | }; | |
292 | ||
a00ba012 | 293 | struct sr_device_instance { |
a1bb33af UH |
294 | int index; |
295 | int status; | |
296 | int instance_type; | |
297 | char *vendor; | |
298 | char *model; | |
299 | char *version; | |
8d672550 | 300 | void *priv; |
a1bb33af | 301 | union { |
6c290072 UH |
302 | struct sr_usb_device_instance *usb; |
303 | struct sr_serial_device_instance *serial; | |
a1bb33af UH |
304 | }; |
305 | }; | |
306 | ||
a00ba012 | 307 | /* sr_device_instance types */ |
a1bb33af | 308 | enum { |
5a2326a7 UH |
309 | SR_USB_INSTANCE, |
310 | SR_SERIAL_INSTANCE, | |
a1bb33af UH |
311 | }; |
312 | ||
22b02383 | 313 | #ifdef HAVE_LIBUSB_1_0 |
6c290072 | 314 | struct sr_usb_device_instance { |
a1bb33af UH |
315 | uint8_t bus; |
316 | uint8_t address; | |
317 | struct libusb_device_handle *devhdl; | |
318 | }; | |
22b02383 | 319 | #endif |
a1bb33af | 320 | |
6c290072 | 321 | struct sr_serial_device_instance { |
a1bb33af UH |
322 | char *port; |
323 | int fd; | |
324 | }; | |
325 | ||
326 | /* Device instance status */ | |
327 | enum { | |
5a2326a7 | 328 | SR_ST_NOT_FOUND, |
a1bb33af | 329 | /* Found, but still booting */ |
5a2326a7 | 330 | SR_ST_INITIALIZING, |
a1bb33af | 331 | /* Live, but not in use */ |
5a2326a7 | 332 | SR_ST_INACTIVE, |
a1bb33af | 333 | /* Actively in use in a session */ |
5a2326a7 | 334 | SR_ST_ACTIVE, |
a1bb33af UH |
335 | }; |
336 | ||
337 | /* | |
338 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
339 | * TODO: Need a DI to return the number of trigger stages supported. | |
340 | */ | |
341 | ||
342 | /* Device info IDs */ | |
343 | enum { | |
a00ba012 | 344 | /* struct sr_device_instance for this specific device */ |
5a2326a7 | 345 | SR_DI_INSTANCE, |
a1bb33af | 346 | /* The number of probes connected to this device */ |
5a2326a7 | 347 | SR_DI_NUM_PROBES, |
60679b18 | 348 | /* Samplerates supported by this device, (struct sr_samplerates) */ |
5a2326a7 | 349 | SR_DI_SAMPLERATES, |
a1bb33af | 350 | /* Types of trigger supported, out of "01crf" (char *) */ |
5a2326a7 | 351 | SR_DI_TRIGGER_TYPES, |
4c100f32 | 352 | /* The currently set samplerate in Hz (uint64_t) */ |
5a2326a7 | 353 | SR_DI_CUR_SAMPLERATE, |
925dbf9f | 354 | /* Supported pattern generator modes */ |
5a2326a7 | 355 | SR_DI_PATTERNMODES, |
a1bb33af UH |
356 | }; |
357 | ||
1b452b85 UH |
358 | /* |
359 | * A device supports either a range of samplerates with steps of a given | |
360 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
361 | * step or list, but not both. |
362 | */ | |
60679b18 | 363 | struct sr_samplerates { |
a1bb33af UH |
364 | uint64_t low; |
365 | uint64_t high; | |
366 | uint64_t step; | |
367 | uint64_t *list; | |
368 | }; | |
369 | ||
5c2d46d1 | 370 | struct sr_device_plugin { |
1b452b85 | 371 | /* Plugin-specific */ |
a1bb33af | 372 | char *name; |
9f8274a5 | 373 | char *longname; |
a1bb33af | 374 | int api_version; |
54ac5277 | 375 | int (*init) (const char *deviceinfo); |
a1bb33af UH |
376 | void (*cleanup) (void); |
377 | ||
1b452b85 | 378 | /* Device-specific */ |
86f5e3d8 | 379 | int (*opendev) (int device_index); |
697785d1 | 380 | int (*closedev) (int device_index); |
a1bb33af UH |
381 | void *(*get_device_info) (int device_index, int device_info_id); |
382 | int (*get_status) (int device_index); | |
383 | int *(*get_capabilities) (void); | |
384 | int (*set_configuration) (int device_index, int capability, void *value); | |
385 | int (*start_acquisition) (int device_index, gpointer session_device_id); | |
386 | void (*stop_acquisition) (int device_index, gpointer session_device_id); | |
387 | }; | |
388 | ||
2872d21e | 389 | struct sr_session { |
5c2d46d1 | 390 | /* List of struct sr_device* */ |
a1bb33af UH |
391 | GSList *devices; |
392 | /* List of struct analyzer* */ | |
393 | GSList *analyzers; | |
a887e3da | 394 | /* list of sr_receive_data_callback */ |
a1bb33af UH |
395 | GSList *datafeed_callbacks; |
396 | GTimeVal starttime; | |
544a4582 | 397 | gboolean running; |
a1bb33af UH |
398 | }; |
399 | ||
882e2075 | 400 | #include "sigrok-proto.h" |
c2bd92ec | 401 | |
a00b530c UH |
402 | #ifdef __cplusplus |
403 | } | |
404 | #endif | |
405 | ||
a1bb33af | 406 | #endif |