2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
20 #ifndef SIGROK_SIGROK_H
21 #define SIGROK_SIGROK_H
28 #ifdef HAVE_LIBUSB_1_0
37 * Status/error codes returned by libsigrok functions.
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.
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
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.
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 */
59 #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
60 #define SR_MAX_PROBENAME_LEN 32
62 /* Handy little macros */
64 #define SR_KHZ(n) ((n) * 1000)
65 #define SR_MHZ(n) ((n) * 1000000)
66 #define SR_GHZ(n) ((n) * 1000000000)
68 #define SR_HZ_TO_NS(n) (1000000000 / (n))
70 /* libsigrok loglevels. */
78 typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
80 /* Data types used by hardware plugins for set_configuration() */
88 /* (Unused) protocol decoder stack entry */
96 /* sr_datafeed_packet.type values */
106 struct sr_datafeed_packet {
108 /* timeoffset since start, in picoseconds */
110 /* duration of data in this packet, in picoseconds */
115 struct sr_datafeed_header {
117 struct timeval starttime;
119 int num_analog_probes;
120 int num_logic_probes;
123 struct sr_datafeed_logic {
129 struct sr_datafeed_pd {
135 #if defined(HAVE_LA_ALSA)
136 struct sr_analog_probe {
138 uint8_t res; /* Needs to be a power of 2, FIXME */
139 uint16_t val; /* Max hardware ADC width is 16bits */
142 struct sr_analog_sample {
143 uint8_t num_probes; /* Max hardware probes is 256 */
144 struct sr_analog_probe probes[];
149 struct sr_input_format *format;
151 struct sr_device *vdevice;
154 struct sr_input_format {
157 int (*format_match) (const char *filename);
158 int (*init) (struct sr_input *in);
159 int (*loadfile) (struct sr_input *in, const char *filename);
163 struct sr_output_format *format;
164 struct sr_device *device;
169 struct sr_output_format {
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);
185 * TODO: Parameters? If so, configured plugins need another struct.
186 * TODO: Input and output format?
191 struct sr_datastore {
192 /* Size in bytes of the number of units stored in this datastore */
194 unsigned int num_units; /* TODO: uint64_t */
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.
205 /* Which plugin handles this device */
206 struct sr_device_plugin *plugin;
207 /* A plugin may handle multiple devices of the same type */
209 /* List of struct sr_probe* */
211 /* Data acquired by this device, if any */
212 struct sr_datastore *datastore;
217 SR_PROBE_TYPE_ANALOG,
228 /* TODO: Get rid of this global variable. */
229 extern GSList *devices;
231 /* Hardware plugin capabilities */
233 SR_HWCAP_DUMMY, /* Used to terminate lists */
235 /*--- Device classes ------------------------------------------------*/
237 /** The device can act as logic analyzer. */
238 SR_HWCAP_LOGIC_ANALYZER,
240 /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
242 /*--- Device options ------------------------------------------------*/
244 /** The device supports setting/changing its samplerate. */
247 /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
248 /** The device supports setting a probe mask. */
249 SR_HWCAP_PROBECONFIG,
251 /** The device supports setting a pre/post-trigger capture ratio. */
252 SR_HWCAP_CAPTURE_RATIO,
255 /** The device supports setting a pattern (pattern generator mode). */
256 SR_HWCAP_PATTERN_MODE,
258 /** The device supports Run Length Encoding. */
261 /*--- Special stuff -------------------------------------------------*/
263 /* TODO: Better description. */
264 /** The device supports specifying a capturefile to inject. */
265 SR_HWCAP_CAPTUREFILE,
267 /* TODO: Better description. */
268 /** The device supports specifying the capturefile unit size. */
269 SR_HWCAP_CAPTURE_UNITSIZE,
271 /* TODO: Better description. */
272 /** The device supports setting the number of probes. */
273 SR_HWCAP_CAPTURE_NUM_PROBES,
275 /*--- Acquisition modes ---------------------------------------------*/
278 * The device supports setting a sample time limit, i.e. how long the
279 * sample acquisition should run (in ms).
284 * The device supports setting a sample number limit, i.e. how many
285 * samples should be acquired.
287 SR_HWCAP_LIMIT_SAMPLES,
290 * The device supports continuous sampling, i.e. neither a time limit
291 * nor a sample number limit has to be supplied, it will just acquire
292 * samples continuously, until explicitly stopped by a certain command.
296 /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
299 struct sr_hwcap_option {
306 struct sr_device_instance {
315 struct sr_usb_device_instance *usb;
316 struct sr_serial_device_instance *serial;
320 /* sr_device_instance types */
326 #ifdef HAVE_LIBUSB_1_0
327 struct sr_usb_device_instance {
330 struct libusb_device_handle *devhdl;
334 struct sr_serial_device_instance {
339 /* Device instance status */
342 /* Found, but still booting */
344 /* Live, but not in use */
346 /* Actively in use in a session */
351 * TODO: This sucks, you just kinda have to "know" the returned type.
352 * TODO: Need a DI to return the number of trigger stages supported.
355 /* Device info IDs */
357 /* struct sr_device_instance for this specific device */
359 /* The number of probes connected to this device */
361 /* Samplerates supported by this device, (struct sr_samplerates) */
363 /* Types of trigger supported, out of "01crf" (char *) */
365 /* The currently set samplerate in Hz (uint64_t) */
366 SR_DI_CUR_SAMPLERATE,
367 /* Supported pattern generator modes */
372 * A device supports either a range of samplerates with steps of a given
373 * granularity, or is limited to a set of defined samplerates. Use either
374 * step or list, but not both.
376 struct sr_samplerates {
383 struct sr_device_plugin {
384 /* Plugin-specific */
388 int (*init) (const char *deviceinfo);
389 void (*cleanup) (void);
391 /* Device-specific */
392 int (*opendev) (int device_index);
393 int (*closedev) (int device_index);
394 void *(*get_device_info) (int device_index, int device_info_id);
395 int (*get_status) (int device_index);
396 int *(*get_capabilities) (void);
397 int (*set_configuration) (int device_index, int capability, void *value);
398 int (*start_acquisition) (int device_index, gpointer session_device_id);
399 void (*stop_acquisition) (int device_index, gpointer session_device_id);
403 /* List of struct sr_device* */
405 /* List of struct analyzer* */
407 /* list of sr_receive_data_callback */
408 GSList *datafeed_callbacks;
413 #include "sigrok-proto.h"