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 /* limited by uint64_t */
53 #define MAX_NUM_PROBES 64
54 #define MAX_PROBENAME_LEN 32
57 /* Handy little macros */
58 #define KHZ(n) ((n) * 1000)
59 #define MHZ(n) ((n) * 1000000)
60 #define GHZ(n) ((n) * 1000000000)
63 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
66 /* Data types, used by hardware plugins for set_configuration() */
76 /* (Unused) protocol decoder stack entry */
87 /* datafeed_packet.type values */
100 struct datafeed_packet {
106 struct datafeed_header {
108 struct timeval starttime;
118 struct input_format *format;
123 struct input_format {
126 int (*format_match) (const char *filename);
127 int (*in_loadfile) (const char *filename);
130 struct input_format **input_list(void);
137 struct output_format *format;
138 struct device *device;
143 struct output_format {
146 int (*init) (struct output *o);
147 int (*data) (struct output *o, char *data_in, uint64_t length_in,
148 char **data_out, uint64_t *length_out);
149 int (*event) (struct output *o, int event_type, char **data_out,
150 uint64_t *length_out);
153 struct output_format **output_list(void);
156 int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
157 char *data_in, uint64_t length_in, char **data_out,
158 uint64_t *length_out);
160 char *sigrok_samplerate_string(uint64_t samplerate);
161 char *sigrok_period_string(uint64_t frequency);
163 /*--- analyzer.c ------------------------------------------------------------*/
169 * TODO: Parameters? If so, configured plugins need another struct.
170 * TODO: Input and output format?
174 /*--- backend.c -------------------------------------------------------------*/
176 int sigrok_init(void);
177 void sigrok_cleanup(void);
179 /*--- datastore.c -----------------------------------------------------------*/
181 /* Size of a chunk in units */
182 #define DATASTORE_CHUNKSIZE 512000
185 /* Size in bytes of the number of units stored in this datastore */
187 unsigned int num_units; /* TODO: uint64_t */
191 int datastore_new(int unitsize, struct datastore **ds);
192 int datastore_destroy(struct datastore *ds);
193 void datastore_put(struct datastore *ds, void *data, unsigned int length,
194 int in_unitsize, int *probelist);
196 /*--- debug.c ---------------------------------------------------------------*/
198 void hexdump(unsigned char *address, int length);
200 /*--- device.c --------------------------------------------------------------*/
203 * This represents a generic device connected to the system.
204 * For device-specific information, ask the plugin. The plugin_index refers
205 * to the device index within that plugin; it may be handling more than one
206 * device. All relevant plugin calls take a device_index parameter for this.
209 /* Which plugin handles this device */
210 struct device_plugin *plugin;
211 /* A plugin may handle multiple devices of the same type */
213 /* List of struct probe* */
215 /* Data acquired by this device, if any */
216 struct datastore *datastore;
226 extern GSList *devices;
228 void device_scan(void);
229 void device_close_all(void);
230 GSList *device_list(void);
231 struct device *device_new(struct device_plugin *plugin, int plugin_index, int num_probes);
232 void device_clear(struct device *device);
233 void device_destroy(struct device *dev);
235 void device_probe_clear(struct device *device, int probenum);
236 void device_probe_add(struct device *device, char *name);
237 struct probe *probe_find(struct device *device, int probenum);
238 void device_probe_name(struct device *device, int probenum, char *name);
240 void device_trigger_clear(struct device *device);
241 void device_trigger_set(struct device *device, int probenum, char *trigger);
243 /*--- hwplugin.c ------------------------------------------------------------*/
245 /* Hardware plugin capabilities */
247 HWCAP_DUMMY, /* Used to terminate lists */
248 HWCAP_LOGIC_ANALYZER,
249 HWCAP_SAMPLERATE, /* Change samplerate */
250 HWCAP_PROBECONFIG, /* Configure probe mask */
251 HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
252 HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
253 HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
256 struct hwcap_option {
263 struct sigrok_device_instance {
271 struct usb_device_instance *usb;
272 struct serial_device_instance *serial;
276 /* sigrok_device_instance types */
282 struct usb_device_instance {
285 struct libusb_device_handle *devhdl;
288 struct serial_device_instance {
293 /* Device instance status */
296 /* Found, but still booting */
298 /* Live, but not in use */
300 /* Actively in use in a session */
305 * TODO: This sucks, you just kinda have to "know" the returned type.
306 * TODO: Need a DI to return the number of trigger stages supported.
309 /* Device info IDs */
311 /* struct sigrok_device_instance for this specific device */
313 /* The number of probes connected to this device */
315 /* Samplerates supported by this device, (struct samplerates) */
317 /* Types of trigger supported, out of "01crf" (char *) */
319 /* The currently set samplerate in Hz (uint64_t) */
324 * A device supports either a range of samplerates with steps of a given
325 * granularity, or is limited to a set of defined samplerates. Use either
326 * step or list, but not both.
335 struct device_plugin {
336 /* Plugin-specific */
339 int (*init) (char *deviceinfo);
340 void (*cleanup) (void);
342 /* Device-specific */
343 int (*open) (int device_index);
344 void (*close) (int device_index);
345 void *(*get_device_info) (int device_index, int device_info_id);
346 int (*get_status) (int device_index);
347 int *(*get_capabilities) (void);
348 int (*set_configuration) (int device_index, int capability, void *value);
349 int (*start_acquisition) (int device_index, gpointer session_device_id);
350 void (*stop_acquisition) (int device_index, gpointer session_device_id);
356 /* Not really using this */
357 GSource *timeout_source;
360 typedef int (*receive_data_callback) (int fd, int revents, void *user_data);
362 int load_hwplugins(void);
363 GSList *list_hwplugins(void);
365 /* Generic device instances */
366 struct sigrok_device_instance *sigrok_device_instance_new(int index,
367 int status, const char *vendor, const char *model, const char *version);
368 struct sigrok_device_instance *get_sigrok_device_instance(
369 GSList *device_instances, int device_index);
370 void sigrok_device_instance_free(struct sigrok_device_instance *sdi);
372 /* USB-specific instances */
373 struct usb_device_instance *usb_device_instance_new(uint8_t bus,
374 uint8_t address, struct libusb_device_handle *hdl);
375 void usb_device_instance_free(struct usb_device_instance *usb);
377 /* Serial-specific instances */
378 struct serial_device_instance *serial_device_instance_new(
379 const char *port, int fd);
380 void serial_device_instance_free(struct serial_device_instance *serial);
382 int find_hwcap(int *capabilities, int hwcap);
383 struct hwcap_option *find_hwcap_option(int hwcap);
384 void source_remove(int fd);
385 void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
388 /*--- session.c -------------------------------------------------------------*/
390 typedef void (*source_callback_remove) (int fd);
391 typedef void (*source_callback_add) (int fd, int events, int timeout,
392 receive_data_callback callback, void *user_data);
393 typedef void (*datafeed_callback) (struct device *device,
394 struct datafeed_packet *packet);
397 /* List of struct device* */
399 /* List of struct analyzer* */
401 /* Datafeed callbacks */
402 GSList *datafeed_callbacks;
407 struct session *session_load(const char *filename);
408 struct session *session_new(void);
409 void session_destroy(void);
410 void session_device_clear(void);
411 int session_device_add(struct device *device);
413 /* Protocol analyzers setup */
414 void session_pa_clear(void);
415 void session_pa_add(struct analyzer *pa);
418 void session_datafeed_callback_clear(void);
419 void session_datafeed_callback_add(datafeed_callback callback);
421 /* Session control */
422 int session_start(void);
423 void session_stop(void);
424 void session_bus(struct device *device, struct datafeed_packet *packet);
425 void make_metadata(char *filename);
426 int session_save(char *filename);
428 /*--- hwcommon.c ------------------------------------------------------------*/
430 int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
431 int ezusb_install_firmware(libusb_device_handle *hdl, char *filename);
432 int ezusb_upload_firmware(libusb_device *dev, int configuration,
433 const char *filename);
435 GSList *list_serial_ports(void);
436 int serial_open(const char *pathname, int flags);
437 int serial_close(int fd);
438 int serial_flush(int fd);
439 void *serial_backup_params(int fd);
440 void serial_restore_params(int fd, void *backup);
441 int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
444 /* libsigrok/hardware/common/misc.c */
445 /* TODO: Should not be public. */
446 int opendev2(int device_index, struct sigrok_device_instance **sdi,
447 libusb_device *dev, struct libusb_device_descriptor *des,
448 int *skip, uint16_t vid, uint16_t pid, int interface);
449 int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
450 struct libusb_device_descriptor *des,
451 uint16_t vid, uint16_t pid, int interface);