]> sigrok.org Git - libsigrok.git/blame_incremental - sigrok.h.in
libsigrok: Fix #includes.
[libsigrok.git] / sigrok.h.in
... / ...
CommitLineData
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#ifdef HAVE_LIBUSB_1_0
29#include <libusb.h>
30#endif
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
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
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".
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 */
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 */
56#define SR_ERR_ARG -3 /* Function argument error */
57#define SR_ERR_SAMPLERATE -4 /* Incorrect samplerate */
58
59#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
60#define SR_MAX_PROBENAME_LEN 32
61
62/* Handy little macros */
63#define SR_HZ(n) (n)
64#define SR_KHZ(n) ((n) * 1000)
65#define SR_MHZ(n) ((n) * 1000000)
66#define SR_GHZ(n) ((n) * 1000000000)
67
68#define SR_HZ_TO_NS(n) (1000000000 / (n))
69
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#define SR_LOG_SPEW 5
77
78typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
79
80/* Data types used by hardware plugins for set_configuration() */
81enum {
82 SR_T_UINT64,
83 SR_T_CHAR,
84 SR_T_BOOL,
85};
86
87#if 0
88/* (Unused) protocol decoder stack entry */
89struct sr_protocol {
90 char *name;
91 int id;
92 int stackindex;
93};
94#endif
95
96/* sr_datafeed_packet.type values */
97enum {
98 SR_DF_HEADER,
99 SR_DF_END,
100 SR_DF_TRIGGER,
101 SR_DF_LOGIC,
102 SR_DF_ANALOG,
103 SR_DF_PD,
104};
105
106struct sr_datafeed_packet {
107 uint16_t type;
108 /* timeoffset since start, in picoseconds */
109 uint64_t timeoffset;
110 /* duration of data in this packet, in picoseconds */
111 uint64_t duration;
112 void *payload;
113};
114
115struct sr_datafeed_header {
116 int feed_version;
117 struct timeval starttime;
118 uint64_t samplerate;
119 int num_analog_probes;
120 int num_logic_probes;
121};
122
123struct sr_datafeed_logic {
124 uint64_t length;
125 uint16_t unitsize;
126 void *data;
127};
128
129struct sr_datafeed_pd {
130 char *protocol;
131 char *annotation;
132 unsigned char *data;
133};
134
135#if defined(HAVE_LA_ALSA)
136struct sr_analog_probe {
137 uint8_t att;
138 uint8_t res; /* Needs to be a power of 2, FIXME */
139 uint16_t val; /* Max hardware ADC width is 16bits */
140};
141
142struct sr_analog_sample {
143 uint8_t num_probes; /* Max hardware probes is 256 */
144 struct sr_analog_probe probes[];
145};
146#endif
147
148struct sr_input {
149 struct sr_input_format *format;
150 char *param;
151 struct sr_device *vdevice;
152};
153
154struct sr_input_format {
155 char *id;
156 char *description;
157 int (*format_match) (const char *filename);
158 int (*init) (struct sr_input *in);
159 int (*loadfile) (struct sr_input *in, const char *filename);
160};
161
162struct sr_output {
163 struct sr_output_format *format;
164 struct sr_device *device;
165 char *param;
166 void *internal;
167};
168
169struct sr_output_format {
170 char *id;
171 char *description;
172 int df_type;
173 int (*init) (struct sr_output *o);
174 int (*data) (struct sr_output *o, const char *data_in,
175 uint64_t length_in, char **data_out, uint64_t *length_out);
176 int (*event) (struct sr_output *o, int event_type, char **data_out,
177 uint64_t *length_out);
178};
179
180#if 0
181struct sr_analyzer {
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};
189#endif
190
191struct sr_datastore {
192 /* Size in bytes of the number of units stored in this datastore */
193 int ds_unitsize;
194 unsigned int num_units; /* TODO: uint64_t */
195 GSList *chunklist;
196};
197
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 */
204struct sr_device {
205 /* Which plugin handles this device */
206 struct sr_device_plugin *plugin;
207 /* A plugin may handle multiple devices of the same type */
208 int plugin_index;
209 /* List of struct sr_probe* */
210 GSList *probes;
211 /* Data acquired by this device, if any */
212 struct sr_datastore *datastore;
213};
214
215enum {
216 SR_PROBE_TYPE_LOGIC,
217 SR_PROBE_TYPE_ANALOG,
218};
219
220struct sr_probe {
221 int index;
222 int type;
223 gboolean enabled;
224 char *name;
225 char *trigger;
226};
227
228/* Hardware plugin capabilities */
229enum {
230 SR_HWCAP_DUMMY, /* Used to terminate lists */
231
232 /*--- Device classes ------------------------------------------------*/
233
234 /** The device can act as logic analyzer. */
235 SR_HWCAP_LOGIC_ANALYZER,
236
237 /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
238
239 /*--- Device options ------------------------------------------------*/
240
241 /** The device supports setting/changing its samplerate. */
242 SR_HWCAP_SAMPLERATE,
243
244 /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
245 /** The device supports setting a probe mask. */
246 SR_HWCAP_PROBECONFIG,
247
248 /** The device supports setting a pre/post-trigger capture ratio. */
249 SR_HWCAP_CAPTURE_RATIO,
250
251 /* TODO? */
252 /** The device supports setting a pattern (pattern generator mode). */
253 SR_HWCAP_PATTERN_MODE,
254
255 /** The device supports Run Length Encoding. */
256 SR_HWCAP_RLE,
257
258 /*--- Special stuff -------------------------------------------------*/
259
260 /* TODO: Better description. */
261 /** The device supports specifying a capturefile to inject. */
262 SR_HWCAP_CAPTUREFILE,
263
264 /* TODO: Better description. */
265 /** The device supports specifying the capturefile unit size. */
266 SR_HWCAP_CAPTURE_UNITSIZE,
267
268 /* TODO: Better description. */
269 /** The device supports setting the number of probes. */
270 SR_HWCAP_CAPTURE_NUM_PROBES,
271
272 /*--- Acquisition modes ---------------------------------------------*/
273
274 /**
275 * The device supports setting a sample time limit, i.e. how long the
276 * sample acquisition should run (in ms).
277 */
278 SR_HWCAP_LIMIT_MSEC,
279
280 /**
281 * The device supports setting a sample number limit, i.e. how many
282 * samples should be acquired.
283 */
284 SR_HWCAP_LIMIT_SAMPLES,
285
286 /**
287 * The device supports continuous sampling, i.e. neither a time limit
288 * nor a sample number limit has to be supplied, it will just acquire
289 * samples continuously, until explicitly stopped by a certain command.
290 */
291 SR_HWCAP_CONTINUOUS,
292
293 /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
294};
295
296struct sr_hwcap_option {
297 int capability;
298 int type;
299 char *description;
300 char *shortname;
301};
302
303struct sr_device_instance {
304 int index;
305 int status;
306 int instance_type;
307 char *vendor;
308 char *model;
309 char *version;
310 void *priv;
311 union {
312 struct sr_usb_device_instance *usb;
313 struct sr_serial_device_instance *serial;
314 };
315};
316
317/* sr_device_instance types */
318enum {
319 SR_USB_INSTANCE,
320 SR_SERIAL_INSTANCE,
321};
322
323#ifdef HAVE_LIBUSB_1_0
324struct sr_usb_device_instance {
325 uint8_t bus;
326 uint8_t address;
327 struct libusb_device_handle *devhdl;
328};
329#endif
330
331struct sr_serial_device_instance {
332 char *port;
333 int fd;
334};
335
336/* Device instance status */
337enum {
338 SR_ST_NOT_FOUND,
339 /* Found, but still booting */
340 SR_ST_INITIALIZING,
341 /* Live, but not in use */
342 SR_ST_INACTIVE,
343 /* Actively in use in a session */
344 SR_ST_ACTIVE,
345};
346
347/*
348 * TODO: This sucks, you just kinda have to "know" the returned type.
349 * TODO: Need a DI to return the number of trigger stages supported.
350 */
351
352/* Device info IDs */
353enum {
354 /* struct sr_device_instance for this specific device */
355 SR_DI_INSTANCE,
356 /* The number of probes connected to this device */
357 SR_DI_NUM_PROBES,
358 /* Samplerates supported by this device, (struct sr_samplerates) */
359 SR_DI_SAMPLERATES,
360 /* Types of trigger supported, out of "01crf" (char *) */
361 SR_DI_TRIGGER_TYPES,
362 /* The currently set samplerate in Hz (uint64_t) */
363 SR_DI_CUR_SAMPLERATE,
364 /* Supported pattern generator modes */
365 SR_DI_PATTERNMODES,
366};
367
368/*
369 * A device supports either a range of samplerates with steps of a given
370 * granularity, or is limited to a set of defined samplerates. Use either
371 * step or list, but not both.
372 */
373struct sr_samplerates {
374 uint64_t low;
375 uint64_t high;
376 uint64_t step;
377 uint64_t *list;
378};
379
380struct sr_device_plugin {
381 /* Plugin-specific */
382 char *name;
383 char *longname;
384 int api_version;
385 int (*init) (const char *deviceinfo);
386 void (*cleanup) (void);
387
388 /* Device-specific */
389 int (*opendev) (int device_index);
390 int (*closedev) (int device_index);
391 void *(*get_device_info) (int device_index, int device_info_id);
392 int (*get_status) (int device_index);
393 int *(*get_capabilities) (void);
394 int (*set_configuration) (int device_index, int capability, void *value);
395 int (*start_acquisition) (int device_index, gpointer session_device_id);
396 void (*stop_acquisition) (int device_index, gpointer session_device_id);
397};
398
399struct sr_session {
400 /* List of struct sr_device* */
401 GSList *devices;
402 /* List of struct analyzer* */
403 GSList *analyzers;
404 /* list of sr_receive_data_callback */
405 GSList *datafeed_callbacks;
406 GTimeVal starttime;
407 gboolean running;
408};
409
410#include "sigrok-proto.h"
411
412#ifdef __cplusplus
413}
414#endif
415
416#endif