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