]>
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> | |
28 | #include <libusb.h> | |
29 | ||
a00b530c UH |
30 | #ifdef __cplusplus |
31 | extern "C" { | |
32 | #endif | |
33 | ||
e31b636d UH |
34 | /* |
35 | * Status/error codes returned by libsigrok functions. | |
36 | * | |
37 | * All possible return codes of libsigrok functions must be listed here. | |
38 | * Functions should never return hardcoded numbers as status, but rather | |
39 | * use these #defines instead. All error codes are negative numbers. | |
40 | * | |
41 | * The error codes are globally unique in libsigrok, i.e. if one of the | |
2b3414a4 UH |
42 | * libsigrok functions returns a "malloc error" it must be exactly the same |
43 | * return value as used by all other functions to indicate "malloc error". | |
e31b636d UH |
44 | * There must be no functions which indicate two different errors via the |
45 | * same return code. | |
46 | * | |
47 | * Also, for compatibility reasons, no defined return codes are ever removed | |
48 | * or reused for different #defines later. You can only add new #defines and | |
49 | * return codes, but never remove or redefine existing ones. | |
50 | */ | |
e46b8fb1 UH |
51 | #define SR_OK 0 /* No error */ |
52 | #define SR_ERR -1 /* Generic/unspecified error */ | |
53 | #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ | |
54 | #define SR_ERR_SAMPLERATE -3 /* Incorrect samplerate */ | |
a1bb33af | 55 | |
2a3f9541 BV |
56 | /* limited by uint64_t */ |
57 | #define MAX_NUM_PROBES 64 | |
58 | #define MAX_PROBENAME_LEN 32 | |
59 | ||
a1bb33af | 60 | /* Handy little macros */ |
d86dc674 UH |
61 | #define KHZ(n) ((n) * 1000) |
62 | #define MHZ(n) ((n) * 1000000) | |
63 | #define GHZ(n) ((n) * 1000000000) | |
a1bb33af | 64 | |
3677f3ec DR |
65 | #define HZ_TO_NS(n) (1000000000 / (n)) |
66 | ||
fdd20b52 UH |
67 | #ifndef ARRAY_SIZE |
68 | #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) | |
69 | #endif | |
70 | ||
dfa4b731 DR |
71 | #ifndef ARRAY_AND_SIZE |
72 | #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) | |
73 | #endif | |
74 | ||
882e2075 BV |
75 | typedef int (*receive_data_callback) (int fd, int revents, void *user_data); |
76 | ||
882e2075 | 77 | /* Data types used by hardware plugins for set_configuration() */ |
a1bb33af | 78 | enum { |
5a2326a7 UH |
79 | SR_T_UINT64, |
80 | SR_T_CHAR, | |
81 | SR_T_NULL, | |
a1bb33af UH |
82 | }; |
83 | ||
84 | enum { | |
5a2326a7 | 85 | SR_PROTO_RAW, |
a1bb33af UH |
86 | }; |
87 | ||
88 | /* (Unused) protocol decoder stack entry */ | |
89 | struct protocol { | |
90 | char *name; | |
91 | int id; | |
92 | int stackindex; | |
93 | }; | |
94 | ||
b9c735a2 | 95 | /* sr_datafeed_packet.type values */ |
a1bb33af | 96 | enum { |
5a2326a7 UH |
97 | SR_DF_HEADER, |
98 | SR_DF_END, | |
99 | SR_DF_TRIGGER, | |
100 | SR_DF_LOGIC, | |
101 | SR_DF_ANALOG, | |
102 | SR_DF_PD, | |
a1bb33af UH |
103 | }; |
104 | ||
b9c735a2 | 105 | struct sr_datafeed_packet { |
a1bb33af | 106 | uint16_t type; |
e1aac231 | 107 | uint64_t length; |
4c046c6b | 108 | uint16_t unitsize; |
a1bb33af UH |
109 | void *payload; |
110 | }; | |
111 | ||
b9c735a2 | 112 | struct sr_datafeed_header { |
a1bb33af UH |
113 | int feed_version; |
114 | struct timeval starttime; | |
4c100f32 | 115 | uint64_t samplerate; |
a1bb33af | 116 | int protocol_id; |
921e753f DR |
117 | int num_analog_probes; |
118 | int num_logic_probes; | |
a1bb33af UH |
119 | }; |
120 | ||
48d783e4 DR |
121 | struct analog_probe { |
122 | uint8_t att; | |
c3579621 DR |
123 | uint8_t res; /* Needs to be a power of 2, FIXME */ |
124 | uint16_t val; /* Max hardware ADC width is 16bits */ | |
48d783e4 DR |
125 | }; |
126 | ||
127 | struct analog_sample { | |
c3579621 | 128 | uint8_t num_probes; /* Max hardware probes is 256 */ |
48d783e4 DR |
129 | struct analog_probe probes[]; |
130 | }; | |
131 | ||
f50f3f40 UH |
132 | struct sr_input { |
133 | struct sr_input_format *format; | |
13a12913 | 134 | char *param; |
5c2d46d1 | 135 | struct sr_device *vdevice; |
34e4813f BV |
136 | }; |
137 | ||
f50f3f40 | 138 | struct sr_input_format { |
34e4813f BV |
139 | char *extension; |
140 | char *description; | |
757b8c62 | 141 | int (*format_match) (const char *filename); |
f50f3f40 UH |
142 | int (*init) (struct sr_input *in); |
143 | int (*loadfile) (struct sr_input *in, const char *filename); | |
34e4813f BV |
144 | }; |
145 | ||
f50f3f40 UH |
146 | struct sr_output { |
147 | struct sr_output_format *format; | |
5c2d46d1 | 148 | struct sr_device *device; |
a1bb33af UH |
149 | char *param; |
150 | void *internal; | |
151 | }; | |
152 | ||
f50f3f40 | 153 | struct sr_output_format { |
a1bb33af UH |
154 | char *extension; |
155 | char *description; | |
f0411b1d | 156 | int df_type; |
f50f3f40 UH |
157 | int (*init) (struct sr_output *o); |
158 | int (*data) (struct sr_output *o, char *data_in, uint64_t length_in, | |
a1bb33af | 159 | char **data_out, uint64_t *length_out); |
f50f3f40 | 160 | int (*event) (struct sr_output *o, int event_type, char **data_out, |
a1bb33af UH |
161 | uint64_t *length_out); |
162 | }; | |
163 | ||
a1bb33af UH |
164 | struct analyzer { |
165 | char *name; | |
166 | char *filename; | |
167 | /* | |
168 | * TODO: Parameters? If so, configured plugins need another struct. | |
169 | * TODO: Input and output format? | |
170 | */ | |
171 | }; | |
172 | ||
a1bb33af UH |
173 | /* Size of a chunk in units */ |
174 | #define DATASTORE_CHUNKSIZE 512000 | |
175 | ||
176 | struct datastore { | |
177 | /* Size in bytes of the number of units stored in this datastore */ | |
178 | int ds_unitsize; | |
33247d6a | 179 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
180 | GSList *chunklist; |
181 | }; | |
182 | ||
a1bb33af UH |
183 | /* |
184 | * This represents a generic device connected to the system. | |
185 | * For device-specific information, ask the plugin. The plugin_index refers | |
186 | * to the device index within that plugin; it may be handling more than one | |
187 | * device. All relevant plugin calls take a device_index parameter for this. | |
188 | */ | |
5c2d46d1 | 189 | struct sr_device { |
a1bb33af | 190 | /* Which plugin handles this device */ |
5c2d46d1 | 191 | struct sr_device_plugin *plugin; |
a1bb33af UH |
192 | /* A plugin may handle multiple devices of the same type */ |
193 | int plugin_index; | |
194 | /* List of struct probe* */ | |
195 | GSList *probes; | |
196 | /* Data acquired by this device, if any */ | |
197 | struct datastore *datastore; | |
198 | }; | |
199 | ||
921e753f | 200 | enum { |
5a2326a7 UH |
201 | SR_PROBE_TYPE_LOGIC, |
202 | SR_PROBE_TYPE_ANALOG, | |
921e753f DR |
203 | }; |
204 | ||
a1bb33af UH |
205 | struct probe { |
206 | int index; | |
6ea7e235 | 207 | int type; |
a1bb33af UH |
208 | gboolean enabled; |
209 | char *name; | |
210 | char *trigger; | |
211 | }; | |
212 | ||
213 | extern GSList *devices; | |
214 | ||
a1bb33af UH |
215 | /* Hardware plugin capabilities */ |
216 | enum { | |
5a2326a7 | 217 | SR_HWCAP_DUMMY, /* Used to terminate lists */ |
925dbf9f | 218 | /* device classes */ |
5a2326a7 | 219 | SR_HWCAP_LOGIC_ANALYZER, |
925dbf9f BV |
220 | |
221 | /* device options */ | |
5a2326a7 UH |
222 | SR_HWCAP_SAMPLERATE, /* Change samplerate */ |
223 | SR_HWCAP_PROBECONFIG, /* Configure probe mask */ | |
224 | SR_HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */ | |
225 | SR_HWCAP_PATTERN_MODE, /* Pattern generator mode */ | |
925dbf9f BV |
226 | |
227 | /* acquisition modes */ | |
5a2326a7 UH |
228 | SR_HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */ |
229 | SR_HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */ | |
230 | SR_HWCAP_CONTINUOUS, | |
a1bb33af UH |
231 | }; |
232 | ||
233 | struct hwcap_option { | |
234 | int capability; | |
235 | int type; | |
236 | char *description; | |
237 | char *shortname; | |
238 | }; | |
239 | ||
a00ba012 | 240 | struct sr_device_instance { |
a1bb33af UH |
241 | int index; |
242 | int status; | |
243 | int instance_type; | |
244 | char *vendor; | |
245 | char *model; | |
246 | char *version; | |
8d672550 | 247 | void *priv; |
a1bb33af | 248 | union { |
6c290072 UH |
249 | struct sr_usb_device_instance *usb; |
250 | struct sr_serial_device_instance *serial; | |
a1bb33af UH |
251 | }; |
252 | }; | |
253 | ||
a00ba012 | 254 | /* sr_device_instance types */ |
a1bb33af | 255 | enum { |
5a2326a7 UH |
256 | SR_USB_INSTANCE, |
257 | SR_SERIAL_INSTANCE, | |
a1bb33af UH |
258 | }; |
259 | ||
6c290072 | 260 | struct sr_usb_device_instance { |
a1bb33af UH |
261 | uint8_t bus; |
262 | uint8_t address; | |
263 | struct libusb_device_handle *devhdl; | |
264 | }; | |
265 | ||
6c290072 | 266 | struct sr_serial_device_instance { |
a1bb33af UH |
267 | char *port; |
268 | int fd; | |
269 | }; | |
270 | ||
271 | /* Device instance status */ | |
272 | enum { | |
5a2326a7 | 273 | SR_ST_NOT_FOUND, |
a1bb33af | 274 | /* Found, but still booting */ |
5a2326a7 | 275 | SR_ST_INITIALIZING, |
a1bb33af | 276 | /* Live, but not in use */ |
5a2326a7 | 277 | SR_ST_INACTIVE, |
a1bb33af | 278 | /* Actively in use in a session */ |
5a2326a7 | 279 | SR_ST_ACTIVE, |
a1bb33af UH |
280 | }; |
281 | ||
282 | /* | |
283 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
284 | * TODO: Need a DI to return the number of trigger stages supported. | |
285 | */ | |
286 | ||
287 | /* Device info IDs */ | |
288 | enum { | |
a00ba012 | 289 | /* struct sr_device_instance for this specific device */ |
5a2326a7 | 290 | SR_DI_INSTANCE, |
a1bb33af | 291 | /* The number of probes connected to this device */ |
5a2326a7 | 292 | SR_DI_NUM_PROBES, |
4c100f32 | 293 | /* Samplerates supported by this device, (struct samplerates) */ |
5a2326a7 | 294 | SR_DI_SAMPLERATES, |
a1bb33af | 295 | /* Types of trigger supported, out of "01crf" (char *) */ |
5a2326a7 | 296 | SR_DI_TRIGGER_TYPES, |
4c100f32 | 297 | /* The currently set samplerate in Hz (uint64_t) */ |
5a2326a7 | 298 | SR_DI_CUR_SAMPLERATE, |
925dbf9f | 299 | /* Supported pattern generator modes */ |
5a2326a7 | 300 | SR_DI_PATTERNMODES, |
a1bb33af UH |
301 | }; |
302 | ||
1b452b85 UH |
303 | /* |
304 | * A device supports either a range of samplerates with steps of a given | |
305 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
306 | * step or list, but not both. |
307 | */ | |
308 | struct samplerates { | |
309 | uint64_t low; | |
310 | uint64_t high; | |
311 | uint64_t step; | |
312 | uint64_t *list; | |
313 | }; | |
314 | ||
5c2d46d1 | 315 | struct sr_device_plugin { |
1b452b85 | 316 | /* Plugin-specific */ |
a1bb33af | 317 | char *name; |
9f8274a5 | 318 | char *longname; |
a1bb33af UH |
319 | int api_version; |
320 | int (*init) (char *deviceinfo); | |
321 | void (*cleanup) (void); | |
322 | ||
1b452b85 | 323 | /* Device-specific */ |
a1bb33af UH |
324 | int (*open) (int device_index); |
325 | void (*close) (int device_index); | |
326 | void *(*get_device_info) (int device_index, int device_info_id); | |
327 | int (*get_status) (int device_index); | |
328 | int *(*get_capabilities) (void); | |
329 | int (*set_configuration) (int device_index, int capability, void *value); | |
330 | int (*start_acquisition) (int device_index, gpointer session_device_id); | |
331 | void (*stop_acquisition) (int device_index, gpointer session_device_id); | |
332 | }; | |
333 | ||
a1bb33af | 334 | struct session { |
5c2d46d1 | 335 | /* List of struct sr_device* */ |
a1bb33af UH |
336 | GSList *devices; |
337 | /* List of struct analyzer* */ | |
338 | GSList *analyzers; | |
544a4582 | 339 | /* list of receive_data_callback */ |
a1bb33af UH |
340 | GSList *datafeed_callbacks; |
341 | GTimeVal starttime; | |
544a4582 | 342 | gboolean running; |
a1bb33af UH |
343 | }; |
344 | ||
882e2075 | 345 | #include "sigrok-proto.h" |
c2bd92ec | 346 | |
a00b530c UH |
347 | #ifdef __cplusplus |
348 | } | |
349 | #endif | |
350 | ||
a1bb33af | 351 | #endif |