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
31 * Status/error codes returned by libsigrok functions.
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.
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
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.
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 */
52 /* Handy little macros */
53 #define KHZ(n) ((n) * 1000)
54 #define MHZ(n) ((n) * 1000000)
55 #define GHZ(n) ((n) * 1000000000)
58 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
61 /* Data types, used by hardware plugins for set_configuration() */
71 /* (Unused) protocol decoder stack entry */
82 /* datafeed_packet.type values */
95 struct datafeed_packet {
101 struct datafeed_header {
103 struct timeval starttime;
113 struct input_format *format;
118 struct input_format {
121 int (*format_match) (const char *filename);
122 int (*in_loadfile) (const char *filename);
125 struct input_format **input_list(void);
132 struct output_format *format;
133 struct device *device;
138 struct output_format {
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);
148 struct output_format **output_list(void);
151 int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
152 char *data_in, uint64_t length_in, char **data_out,
153 uint64_t *length_out);
155 char *sigrok_samplerate_string(uint64_t samplerate);
157 /*--- analyzer.c ------------------------------------------------------------*/
163 * TODO: Parameters? If so, configured plugins need another struct.
164 * TODO: Input and output format?
168 /*--- backend.c -------------------------------------------------------------*/
170 int sigrok_init(void);
171 void sigrok_cleanup(void);
173 /*--- datastore.c -----------------------------------------------------------*/
175 /* Size of a chunk in units */
176 #define DATASTORE_CHUNKSIZE 512000
179 /* Size in bytes of the number of units stored in this datastore */
181 unsigned int num_units; /* TODO: uint64_t */
185 int datastore_new(int unitsize, struct datastore **ds);
186 int datastore_destroy(struct datastore *ds);
187 void datastore_put(struct datastore *ds, void *data, unsigned int length,
188 int in_unitsize, int *probelist);
190 /*--- debug.c ---------------------------------------------------------------*/
192 void hexdump(unsigned char *address, int length);
194 /*--- device.c --------------------------------------------------------------*/
197 * This represents a generic device connected to the system.
198 * For device-specific information, ask the plugin. The plugin_index refers
199 * to the device index within that plugin; it may be handling more than one
200 * device. All relevant plugin calls take a device_index parameter for this.
203 /* Which plugin handles this device */
204 struct device_plugin *plugin;
205 /* A plugin may handle multiple devices of the same type */
207 /* List of struct probe* */
209 /* Data acquired by this device, if any */
210 struct datastore *datastore;
213 #define MAX_PROBENAME_LEN 32
221 extern GSList *devices;
223 void device_scan(void);
224 void device_close_all(void);
225 GSList *device_list(void);
226 struct device *device_new(struct device_plugin *plugin, int plugin_index, int num_probes);
227 void device_clear(struct device *device);
228 void device_destroy(struct device *dev);
230 void device_probe_clear(struct device *device, int probenum);
231 void device_probe_add(struct device *device, char *name);
232 struct probe *probe_find(struct device *device, int probenum);
233 void device_probe_name(struct device *device, int probenum, char *name);
235 void device_trigger_clear(struct device *device);
236 void device_trigger_set(struct device *device, int probenum, char *trigger);
238 /*--- hwplugin.c ------------------------------------------------------------*/
240 /* Hardware plugin capabilities */
242 HWCAP_DUMMY, /* Used to terminate lists */
243 HWCAP_LOGIC_ANALYZER,
244 HWCAP_SAMPLERATE, /* Change samplerate */
245 HWCAP_PROBECONFIG, /* Configure probe mask */
246 HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
247 HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
248 HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
251 struct hwcap_option {
258 struct sigrok_device_instance {
266 struct usb_device_instance *usb;
267 struct serial_device_instance *serial;
271 /* sigrok_device_instance types */
277 struct usb_device_instance {
280 struct libusb_device_handle *devhdl;
283 struct serial_device_instance {
288 /* Device instance status */
291 /* Found, but still booting */
293 /* Live, but not in use */
295 /* Actively in use in a session */
300 * TODO: This sucks, you just kinda have to "know" the returned type.
301 * TODO: Need a DI to return the number of trigger stages supported.
304 /* Device info IDs */
306 /* struct sigrok_device_instance for this specific device */
308 /* The number of probes connected to this device */
310 /* Samplerates supported by this device, (struct samplerates) */
312 /* Types of trigger supported, out of "01crf" (char *) */
314 /* The currently set samplerate in Hz (uint64_t) */
319 * A device supports either a range of samplerates with steps of a given
320 * granularity, or is limited to a set of defined samplerates. Use either
321 * step or list, but not both.
330 struct device_plugin {
331 /* Plugin-specific */
334 int (*init) (char *deviceinfo);
335 void (*cleanup) (void);
337 /* Device-specific */
338 int (*open) (int device_index);
339 void (*close) (int device_index);
340 void *(*get_device_info) (int device_index, int device_info_id);
341 int (*get_status) (int device_index);
342 int *(*get_capabilities) (void);
343 int (*set_configuration) (int device_index, int capability, void *value);
344 int (*start_acquisition) (int device_index, gpointer session_device_id);
345 void (*stop_acquisition) (int device_index, gpointer session_device_id);
351 /* Not really using this */
352 GSource *timeout_source;
355 typedef int (*receive_data_callback) (int fd, int revents, void *user_data);
357 int load_hwplugins(void);
358 GSList *list_hwplugins(void);
360 /* Generic device instances */
361 struct sigrok_device_instance *sigrok_device_instance_new(int index,
362 int status, const char *vendor, const char *model, const char *version);
363 struct sigrok_device_instance *get_sigrok_device_instance(
364 GSList *device_instances, int device_index);
365 void sigrok_device_instance_free(struct sigrok_device_instance *sdi);
367 /* USB-specific instances */
368 struct usb_device_instance *usb_device_instance_new(uint8_t bus,
369 uint8_t address, struct libusb_device_handle *hdl);
370 void usb_device_instance_free(struct usb_device_instance *usb);
372 /* Serial-specific instances */
373 struct serial_device_instance *serial_device_instance_new(
374 const char *port, int fd);
375 void serial_device_instance_free(struct serial_device_instance *serial);
377 int find_hwcap(int *capabilities, int hwcap);
378 struct hwcap_option *find_hwcap_option(int hwcap);
379 void source_remove(int fd);
380 void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
383 /*--- session.c -------------------------------------------------------------*/
385 typedef void (*source_callback_remove) (int fd);
386 typedef void (*source_callback_add) (int fd, int events, int timeout,
387 receive_data_callback callback, void *user_data);
388 typedef void (*datafeed_callback) (struct device *device,
389 struct datafeed_packet *packet);
392 /* List of struct device* */
394 /* List of struct analyzer* */
396 /* Datafeed callbacks */
397 GSList *datafeed_callbacks;
402 struct session *session_load(const char *filename);
403 struct session *session_new(void);
404 void session_destroy(void);
405 void session_device_clear(void);
406 int session_device_add(struct device *device);
408 /* Protocol analyzers setup */
409 void session_pa_clear(void);
410 void session_pa_add(struct analyzer *pa);
413 void session_datafeed_callback_clear(void);
414 void session_datafeed_callback_add(datafeed_callback callback);
416 /* Session control */
417 int session_start(void);
418 void session_stop(void);
419 void session_bus(struct device *device, struct datafeed_packet *packet);
420 void make_metadata(char *filename);
421 int session_save(char *filename);
423 /*--- hwcommon.c ------------------------------------------------------------*/
425 int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
426 int ezusb_install_firmware(libusb_device_handle *hdl, char *filename);
427 int ezusb_upload_firmware(libusb_device *dev, int configuration,
428 const char *filename);
430 GSList *list_serial_ports(void);
431 int serial_open(const char *pathname, int flags);
432 int serial_close(int fd);
433 int serial_flush(int fd);
434 void *serial_backup_params(int fd);
435 void serial_restore_params(int fd, void *backup);
436 int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
439 /* libsigrok/hardware/common/misc.c */
440 /* TODO: Should not be public. */
441 int opendev2(int device_index, struct sigrok_device_instance **sdi,
442 libusb_device *dev, struct libusb_device_descriptor *des,
443 int *skip, uint16_t vid, uint16_t pid, int interface);
444 int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
445 struct libusb_device_descriptor *des,
446 uint16_t vid, uint16_t pid, int interface);