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 #ifndef ARRAY_AND_SIZE
67 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
70 /* Data types, used by hardware plugins for set_configuration() */
80 /* (Unused) protocol decoder stack entry */
91 /* datafeed_packet.type values */
101 struct datafeed_packet {
108 struct datafeed_header {
110 struct timeval starttime;
120 struct input_format *format;
125 struct input_format {
128 int (*format_match) (const char *filename);
129 int (*in_loadfile) (const char *filename);
132 struct input_format **input_list(void);
139 struct output_format *format;
140 struct device *device;
145 struct output_format {
148 int (*init) (struct output *o);
149 int (*data) (struct output *o, char *data_in, uint64_t length_in,
150 char **data_out, uint64_t *length_out);
151 int (*event) (struct output *o, int event_type, char **data_out,
152 uint64_t *length_out);
155 struct output_format **output_list(void);
158 int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
159 char *data_in, uint64_t length_in, char **data_out,
160 uint64_t *length_out);
162 char *sigrok_samplerate_string(uint64_t samplerate);
163 char *sigrok_period_string(uint64_t frequency);
165 /*--- analyzer.c ------------------------------------------------------------*/
171 * TODO: Parameters? If so, configured plugins need another struct.
172 * TODO: Input and output format?
176 /*--- backend.c -------------------------------------------------------------*/
178 int sigrok_init(void);
179 void sigrok_cleanup(void);
181 /*--- datastore.c -----------------------------------------------------------*/
183 /* Size of a chunk in units */
184 #define DATASTORE_CHUNKSIZE 512000
187 /* Size in bytes of the number of units stored in this datastore */
189 unsigned int num_units; /* TODO: uint64_t */
193 int datastore_new(int unitsize, struct datastore **ds);
194 int datastore_destroy(struct datastore *ds);
195 void datastore_put(struct datastore *ds, void *data, unsigned int length,
196 int in_unitsize, int *probelist);
198 /*--- debug.c ---------------------------------------------------------------*/
200 void hexdump(unsigned char *address, int length);
202 /*--- device.c --------------------------------------------------------------*/
205 * This represents a generic device connected to the system.
206 * For device-specific information, ask the plugin. The plugin_index refers
207 * to the device index within that plugin; it may be handling more than one
208 * device. All relevant plugin calls take a device_index parameter for this.
211 /* Which plugin handles this device */
212 struct device_plugin *plugin;
213 /* A plugin may handle multiple devices of the same type */
215 /* List of struct probe* */
217 /* Data acquired by this device, if any */
218 struct datastore *datastore;
228 extern GSList *devices;
230 void device_scan(void);
231 void device_close_all(void);
232 GSList *device_list(void);
233 struct device *device_new(struct device_plugin *plugin, int plugin_index, int num_probes);
234 void device_clear(struct device *device);
235 void device_destroy(struct device *dev);
237 void device_probe_clear(struct device *device, int probenum);
238 void device_probe_add(struct device *device, char *name);
239 struct probe *probe_find(struct device *device, int probenum);
240 void device_probe_name(struct device *device, int probenum, char *name);
242 void device_trigger_clear(struct device *device);
243 void device_trigger_set(struct device *device, int probenum, char *trigger);
245 /*--- hwplugin.c ------------------------------------------------------------*/
247 /* Hardware plugin capabilities */
249 HWCAP_DUMMY, /* Used to terminate lists */
250 HWCAP_LOGIC_ANALYZER,
251 HWCAP_SAMPLERATE, /* Change samplerate */
252 HWCAP_PROBECONFIG, /* Configure probe mask */
253 HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
254 HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
255 HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
258 struct hwcap_option {
265 struct sigrok_device_instance {
274 struct usb_device_instance *usb;
275 struct serial_device_instance *serial;
279 /* sigrok_device_instance types */
285 struct usb_device_instance {
288 struct libusb_device_handle *devhdl;
291 struct serial_device_instance {
296 /* Device instance status */
299 /* Found, but still booting */
301 /* Live, but not in use */
303 /* Actively in use in a session */
308 * TODO: This sucks, you just kinda have to "know" the returned type.
309 * TODO: Need a DI to return the number of trigger stages supported.
312 /* Device info IDs */
314 /* struct sigrok_device_instance for this specific device */
316 /* The number of probes connected to this device */
318 /* Samplerates supported by this device, (struct samplerates) */
320 /* Types of trigger supported, out of "01crf" (char *) */
322 /* The currently set samplerate in Hz (uint64_t) */
327 * A device supports either a range of samplerates with steps of a given
328 * granularity, or is limited to a set of defined samplerates. Use either
329 * step or list, but not both.
338 struct device_plugin {
339 /* Plugin-specific */
342 int (*init) (char *deviceinfo);
343 void (*cleanup) (void);
345 /* Device-specific */
346 int (*open) (int device_index);
347 void (*close) (int device_index);
348 void *(*get_device_info) (int device_index, int device_info_id);
349 int (*get_status) (int device_index);
350 int *(*get_capabilities) (void);
351 int (*set_configuration) (int device_index, int capability, void *value);
352 int (*start_acquisition) (int device_index, gpointer session_device_id);
353 void (*stop_acquisition) (int device_index, gpointer session_device_id);
359 /* Not really using this */
360 GSource *timeout_source;
363 typedef int (*receive_data_callback) (int fd, int revents, void *user_data);
365 int load_hwplugins(void);
366 GSList *list_hwplugins(void);
368 /* Generic device instances */
369 struct sigrok_device_instance *sigrok_device_instance_new(int index,
370 int status, const char *vendor, const char *model, const char *version);
371 struct sigrok_device_instance *get_sigrok_device_instance(
372 GSList *device_instances, int device_index);
373 void sigrok_device_instance_free(struct sigrok_device_instance *sdi);
375 /* USB-specific instances */
376 struct usb_device_instance *usb_device_instance_new(uint8_t bus,
377 uint8_t address, struct libusb_device_handle *hdl);
378 void usb_device_instance_free(struct usb_device_instance *usb);
380 /* Serial-specific instances */
381 struct serial_device_instance *serial_device_instance_new(
382 const char *port, int fd);
383 void serial_device_instance_free(struct serial_device_instance *serial);
385 int find_hwcap(int *capabilities, int hwcap);
386 struct hwcap_option *find_hwcap_option(int hwcap);
387 void source_remove(int fd);
388 void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
391 /*--- session.c -------------------------------------------------------------*/
393 typedef void (*source_callback_remove) (int fd);
394 typedef void (*source_callback_add) (int fd, int events, int timeout,
395 receive_data_callback callback, void *user_data);
396 typedef void (*datafeed_callback) (struct device *device,
397 struct datafeed_packet *packet);
400 /* List of struct device* */
402 /* List of struct analyzer* */
404 /* Datafeed callbacks */
405 GSList *datafeed_callbacks;
410 struct session *session_load(const char *filename);
411 struct session *session_new(void);
412 void session_destroy(void);
413 void session_device_clear(void);
414 int session_device_add(struct device *device);
416 /* Protocol analyzers setup */
417 void session_pa_clear(void);
418 void session_pa_add(struct analyzer *pa);
421 void session_datafeed_callback_clear(void);
422 void session_datafeed_callback_add(datafeed_callback callback);
424 /* Session control */
425 int session_start(void);
426 void session_stop(void);
427 void session_bus(struct device *device, struct datafeed_packet *packet);
428 void make_metadata(char *filename);
429 int session_save(char *filename);
431 /*--- hwcommon.c ------------------------------------------------------------*/
433 int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
434 int ezusb_install_firmware(libusb_device_handle *hdl, char *filename);
435 int ezusb_upload_firmware(libusb_device *dev, int configuration,
436 const char *filename);
438 GSList *list_serial_ports(void);
439 int serial_open(const char *pathname, int flags);
440 int serial_close(int fd);
441 int serial_flush(int fd);
442 void *serial_backup_params(int fd);
443 void serial_restore_params(int fd, void *backup);
444 int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
447 /* libsigrok/hardware/common/misc.c */
448 /* TODO: Should not be public. */
449 int opendev2(int device_index, struct sigrok_device_instance **sdi,
450 libusb_device *dev, struct libusb_device_descriptor *des,
451 int *skip, uint16_t vid, uint16_t pid, int interface);
452 int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
453 struct libusb_device_descriptor *des,
454 uint16_t vid, uint16_t pid, int interface);