]>
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 | ||
882e2075 | 30 | |
e31b636d UH |
31 | /* |
32 | * Status/error codes returned by libsigrok functions. | |
33 | * | |
34 | * All possible return codes of libsigrok functions must be listed here. | |
35 | * Functions should never return hardcoded numbers as status, but rather | |
36 | * use these #defines instead. All error codes are negative numbers. | |
37 | * | |
38 | * The error codes are globally unique in libsigrok, i.e. if one of the | |
2b3414a4 UH |
39 | * libsigrok functions returns a "malloc error" it must be exactly the same |
40 | * return value as used by all other functions to indicate "malloc error". | |
e31b636d UH |
41 | * There must be no functions which indicate two different errors via the |
42 | * same return code. | |
43 | * | |
44 | * Also, for compatibility reasons, no defined return codes are ever removed | |
45 | * or reused for different #defines later. You can only add new #defines and | |
46 | * return codes, but never remove or redefine existing ones. | |
47 | */ | |
882e2075 BV |
48 | #define SIGROK_OK 0 /* No error */ |
49 | #define SIGROK_ERR -1 /* Generic/unspecified error */ | |
50 | #define SIGROK_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ | |
51 | #define SIGROK_ERR_SAMPLERATE -3 /* Incorrect samplerate */ | |
a1bb33af | 52 | |
2a3f9541 BV |
53 | /* limited by uint64_t */ |
54 | #define MAX_NUM_PROBES 64 | |
55 | #define MAX_PROBENAME_LEN 32 | |
56 | ||
57 | ||
a1bb33af | 58 | /* Handy little macros */ |
d86dc674 UH |
59 | #define KHZ(n) ((n) * 1000) |
60 | #define MHZ(n) ((n) * 1000000) | |
61 | #define GHZ(n) ((n) * 1000000000) | |
a1bb33af | 62 | |
fdd20b52 UH |
63 | #ifndef ARRAY_SIZE |
64 | #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) | |
65 | #endif | |
66 | ||
dfa4b731 DR |
67 | #ifndef ARRAY_AND_SIZE |
68 | #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) | |
69 | #endif | |
70 | ||
882e2075 BV |
71 | |
72 | typedef int (*receive_data_callback) (int fd, int revents, void *user_data); | |
73 | ||
74 | ||
75 | /* Data types used by hardware plugins for set_configuration() */ | |
a1bb33af UH |
76 | enum { |
77 | T_UINT64, | |
78 | T_CHAR, | |
79 | }; | |
80 | ||
81 | enum { | |
82 | PROTO_RAW, | |
83 | }; | |
84 | ||
85 | /* (Unused) protocol decoder stack entry */ | |
86 | struct protocol { | |
87 | char *name; | |
88 | int id; | |
89 | int stackindex; | |
90 | }; | |
91 | ||
882e2075 | 92 | |
a1bb33af UH |
93 | |
94 | /* datafeed_packet.type values */ | |
95 | enum { | |
96 | DF_HEADER, | |
97 | DF_END, | |
98 | DF_TRIGGER, | |
4c046c6b | 99 | DF_LOGIC, |
1437e893 | 100 | DF_ANALOG, |
4c046c6b | 101 | DF_PD, |
a1bb33af UH |
102 | }; |
103 | ||
104 | struct datafeed_packet { | |
105 | uint16_t type; | |
e1aac231 | 106 | uint64_t length; |
4c046c6b | 107 | uint16_t unitsize; |
a1bb33af UH |
108 | void *payload; |
109 | }; | |
110 | ||
111 | struct datafeed_header { | |
112 | int feed_version; | |
113 | struct timeval starttime; | |
4c100f32 | 114 | uint64_t samplerate; |
a1bb33af UH |
115 | int protocol_id; |
116 | int num_probes; | |
117 | }; | |
118 | ||
882e2075 BV |
119 | |
120 | ||
34e4813f BV |
121 | struct input { |
122 | struct input_format *format; | |
123 | void *param; | |
124 | void *internal; | |
125 | }; | |
126 | ||
127 | struct input_format { | |
128 | char *extension; | |
129 | char *description; | |
757b8c62 UH |
130 | int (*format_match) (const char *filename); |
131 | int (*in_loadfile) (const char *filename); | |
34e4813f BV |
132 | }; |
133 | ||
34e4813f BV |
134 | |
135 | ||
a1bb33af UH |
136 | struct output { |
137 | struct output_format *format; | |
138 | struct device *device; | |
139 | char *param; | |
140 | void *internal; | |
141 | }; | |
142 | ||
143 | struct output_format { | |
144 | char *extension; | |
145 | char *description; | |
f0411b1d | 146 | int df_type; |
5a8fda15 | 147 | int (*init) (struct output *o); |
a1bb33af UH |
148 | int (*data) (struct output *o, char *data_in, uint64_t length_in, |
149 | char **data_out, uint64_t *length_out); | |
150 | int (*event) (struct output *o, int event_type, char **data_out, | |
151 | uint64_t *length_out); | |
152 | }; | |
153 | ||
a1bb33af UH |
154 | |
155 | struct analyzer { | |
156 | char *name; | |
157 | char *filename; | |
158 | /* | |
159 | * TODO: Parameters? If so, configured plugins need another struct. | |
160 | * TODO: Input and output format? | |
161 | */ | |
162 | }; | |
163 | ||
a1bb33af UH |
164 | |
165 | /* Size of a chunk in units */ | |
166 | #define DATASTORE_CHUNKSIZE 512000 | |
167 | ||
168 | struct datastore { | |
169 | /* Size in bytes of the number of units stored in this datastore */ | |
170 | int ds_unitsize; | |
33247d6a | 171 | unsigned int num_units; /* TODO: uint64_t */ |
a1bb33af UH |
172 | GSList *chunklist; |
173 | }; | |
174 | ||
a1bb33af UH |
175 | |
176 | /* | |
177 | * This represents a generic device connected to the system. | |
178 | * For device-specific information, ask the plugin. The plugin_index refers | |
179 | * to the device index within that plugin; it may be handling more than one | |
180 | * device. All relevant plugin calls take a device_index parameter for this. | |
181 | */ | |
182 | struct device { | |
183 | /* Which plugin handles this device */ | |
184 | struct device_plugin *plugin; | |
185 | /* A plugin may handle multiple devices of the same type */ | |
186 | int plugin_index; | |
187 | /* List of struct probe* */ | |
188 | GSList *probes; | |
189 | /* Data acquired by this device, if any */ | |
190 | struct datastore *datastore; | |
191 | }; | |
192 | ||
193 | struct probe { | |
194 | int index; | |
195 | gboolean enabled; | |
196 | char *name; | |
197 | char *trigger; | |
198 | }; | |
199 | ||
200 | extern GSList *devices; | |
201 | ||
a1bb33af UH |
202 | |
203 | /* Hardware plugin capabilities */ | |
204 | enum { | |
1b452b85 | 205 | HWCAP_DUMMY, /* Used to terminate lists */ |
a1bb33af | 206 | HWCAP_LOGIC_ANALYZER, |
1b452b85 UH |
207 | HWCAP_SAMPLERATE, /* Change samplerate */ |
208 | HWCAP_PROBECONFIG, /* Configure probe mask */ | |
a803c0db | 209 | HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */ |
1b452b85 UH |
210 | HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */ |
211 | HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */ | |
a1bb33af UH |
212 | }; |
213 | ||
214 | struct hwcap_option { | |
215 | int capability; | |
216 | int type; | |
217 | char *description; | |
218 | char *shortname; | |
219 | }; | |
220 | ||
882e2075 | 221 | |
a1bb33af UH |
222 | struct sigrok_device_instance { |
223 | int index; | |
224 | int status; | |
225 | int instance_type; | |
226 | char *vendor; | |
227 | char *model; | |
228 | char *version; | |
8d672550 | 229 | void *priv; |
a1bb33af UH |
230 | union { |
231 | struct usb_device_instance *usb; | |
232 | struct serial_device_instance *serial; | |
233 | }; | |
234 | }; | |
235 | ||
236 | /* sigrok_device_instance types */ | |
237 | enum { | |
238 | USB_INSTANCE, | |
239 | SERIAL_INSTANCE, | |
240 | }; | |
241 | ||
242 | struct usb_device_instance { | |
243 | uint8_t bus; | |
244 | uint8_t address; | |
245 | struct libusb_device_handle *devhdl; | |
246 | }; | |
247 | ||
248 | struct serial_device_instance { | |
249 | char *port; | |
250 | int fd; | |
251 | }; | |
252 | ||
253 | /* Device instance status */ | |
254 | enum { | |
255 | ST_NOT_FOUND, | |
256 | /* Found, but still booting */ | |
257 | ST_INITIALIZING, | |
258 | /* Live, but not in use */ | |
259 | ST_INACTIVE, | |
260 | /* Actively in use in a session */ | |
261 | ST_ACTIVE, | |
262 | }; | |
263 | ||
264 | /* | |
265 | * TODO: This sucks, you just kinda have to "know" the returned type. | |
266 | * TODO: Need a DI to return the number of trigger stages supported. | |
267 | */ | |
268 | ||
269 | /* Device info IDs */ | |
270 | enum { | |
271 | /* struct sigrok_device_instance for this specific device */ | |
272 | DI_INSTANCE, | |
273 | /* The number of probes connected to this device */ | |
274 | DI_NUM_PROBES, | |
4c100f32 | 275 | /* Samplerates supported by this device, (struct samplerates) */ |
a1bb33af UH |
276 | DI_SAMPLERATES, |
277 | /* Types of trigger supported, out of "01crf" (char *) */ | |
278 | DI_TRIGGER_TYPES, | |
4c100f32 UH |
279 | /* The currently set samplerate in Hz (uint64_t) */ |
280 | DI_CUR_SAMPLERATE, | |
a1bb33af UH |
281 | }; |
282 | ||
1b452b85 UH |
283 | /* |
284 | * A device supports either a range of samplerates with steps of a given | |
285 | * granularity, or is limited to a set of defined samplerates. Use either | |
a1bb33af UH |
286 | * step or list, but not both. |
287 | */ | |
288 | struct samplerates { | |
289 | uint64_t low; | |
290 | uint64_t high; | |
291 | uint64_t step; | |
292 | uint64_t *list; | |
293 | }; | |
294 | ||
295 | struct device_plugin { | |
1b452b85 | 296 | /* Plugin-specific */ |
a1bb33af UH |
297 | char *name; |
298 | int api_version; | |
299 | int (*init) (char *deviceinfo); | |
300 | void (*cleanup) (void); | |
301 | ||
1b452b85 | 302 | /* Device-specific */ |
a1bb33af UH |
303 | int (*open) (int device_index); |
304 | void (*close) (int device_index); | |
305 | void *(*get_device_info) (int device_index, int device_info_id); | |
306 | int (*get_status) (int device_index); | |
307 | int *(*get_capabilities) (void); | |
308 | int (*set_configuration) (int device_index, int capability, void *value); | |
309 | int (*start_acquisition) (int device_index, gpointer session_device_id); | |
310 | void (*stop_acquisition) (int device_index, gpointer session_device_id); | |
311 | }; | |
312 | ||
313 | struct gsource_fd { | |
314 | GSource source; | |
315 | GPollFD gpfd; | |
316 | /* Not really using this */ | |
317 | GSource *timeout_source; | |
318 | }; | |
319 | ||
a1bb33af UH |
320 | struct session { |
321 | /* List of struct device* */ | |
322 | GSList *devices; | |
323 | /* List of struct analyzer* */ | |
324 | GSList *analyzers; | |
1b452b85 | 325 | /* Datafeed callbacks */ |
a1bb33af UH |
326 | GSList *datafeed_callbacks; |
327 | GTimeVal starttime; | |
328 | }; | |
329 | ||
882e2075 | 330 | #include "sigrok-proto.h" |
a1bb33af | 331 | #endif |