X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok.h;h=d7d8c2fab317e283ed9337d395383942236672a2;hb=f50f3f40d9238b0c50be67e52bc132aadfcf2050;hp=be82f4b5fb92849a3d6d0efd10ec7c727c47b847;hpb=f0411b1d170aa60c3aa79b12e88f53b225ea350d;p=libsigrok.git diff --git a/sigrok.h b/sigrok.h index be82f4b5..d7d8c2fa 100644 --- a/sigrok.h +++ b/sigrok.h @@ -27,6 +27,10 @@ #include #include +#ifdef __cplusplus +extern "C" { +#endif + /* * Status/error codes returned by libsigrok functions. * @@ -44,21 +48,22 @@ * or reused for different #defines later. You can only add new #defines and * return codes, but never remove or redefine existing ones. */ -#define SIGROK_OK 0 /* No error */ -#define SIGROK_ERR -1 /* Generic/unspecified error */ -#define SIGROK_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ -#define SIGROK_ERR_SAMPLERATE -3 /* Incorrect samplerate */ +#define SR_OK 0 /* No error */ +#define SR_ERR -1 /* Generic/unspecified error */ +#define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ +#define SR_ERR_SAMPLERATE -3 /* Incorrect samplerate */ /* limited by uint64_t */ #define MAX_NUM_PROBES 64 #define MAX_PROBENAME_LEN 32 - /* Handy little macros */ #define KHZ(n) ((n) * 1000) #define MHZ(n) ((n) * 1000000) #define GHZ(n) ((n) * 1000000000) +#define HZ_TO_NS(n) (1000000000 / (n)) + #ifndef ARRAY_SIZE #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) #endif @@ -67,10 +72,13 @@ #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) #endif -/* Data types, used by hardware plugins for set_configuration() */ +typedef int (*receive_data_callback) (int fd, int revents, void *user_data); + +/* Data types used by hardware plugins for set_configuration() */ enum { T_UINT64, T_CHAR, + T_NULL, }; enum { @@ -84,16 +92,13 @@ struct protocol { int stackindex; }; -/* - * Datafeed - */ - /* datafeed_packet.type values */ enum { DF_HEADER, DF_END, DF_TRIGGER, DF_LOGIC, + DF_ANALOG, DF_PD, }; @@ -109,61 +114,53 @@ struct datafeed_header { struct timeval starttime; uint64_t samplerate; int protocol_id; - int num_probes; + int num_analog_probes; + int num_logic_probes; }; -/* - * Input - */ -struct input { - struct input_format *format; - void *param; - void *internal; +struct analog_probe { + uint8_t att; + uint8_t res; /* Needs to be a power of 2, FIXME */ + uint16_t val; /* Max hardware ADC width is 16bits */ +}; + +struct analog_sample { + uint8_t num_probes; /* Max hardware probes is 256 */ + struct analog_probe probes[]; }; -struct input_format { +struct sr_input { + struct sr_input_format *format; + char *param; + struct device *vdevice; +}; + +struct sr_input_format { char *extension; char *description; int (*format_match) (const char *filename); - int (*in_loadfile) (const char *filename); + int (*init) (struct sr_input *in); + int (*loadfile) (struct sr_input *in, const char *filename); }; -struct input_format **input_list(void); - - -/* - * Output - */ -struct output { - struct output_format *format; +struct sr_output { + struct sr_output_format *format; struct device *device; char *param; void *internal; }; -struct output_format { +struct sr_output_format { char *extension; char *description; int df_type; - int (*init) (struct output *o); - int (*data) (struct output *o, char *data_in, uint64_t length_in, + int (*init) (struct sr_output *o); + int (*data) (struct sr_output *o, char *data_in, uint64_t length_in, char **data_out, uint64_t *length_out); - int (*event) (struct output *o, int event_type, char **data_out, + int (*event) (struct sr_output *o, int event_type, char **data_out, uint64_t *length_out); }; -struct output_format **output_list(void); - - -int filter_probes(int in_unitsize, int out_unitsize, int *probelist, - char *data_in, uint64_t length_in, char **data_out, - uint64_t *length_out); - -char *sigrok_samplerate_string(uint64_t samplerate); -char *sigrok_period_string(uint64_t frequency); - -/*--- analyzer.c ------------------------------------------------------------*/ - struct analyzer { char *name; char *filename; @@ -173,13 +170,6 @@ struct analyzer { */ }; -/*--- backend.c -------------------------------------------------------------*/ - -int sigrok_init(void); -void sigrok_cleanup(void); - -/*--- datastore.c -----------------------------------------------------------*/ - /* Size of a chunk in units */ #define DATASTORE_CHUNKSIZE 512000 @@ -190,17 +180,6 @@ struct datastore { GSList *chunklist; }; -int datastore_new(int unitsize, struct datastore **ds); -int datastore_destroy(struct datastore *ds); -void datastore_put(struct datastore *ds, void *data, unsigned int length, - int in_unitsize, int *probelist); - -/*--- debug.c ---------------------------------------------------------------*/ - -void hexdump(unsigned char *address, int length); - -/*--- device.c --------------------------------------------------------------*/ - /* * This represents a generic device connected to the system. * For device-specific information, ask the plugin. The plugin_index refers @@ -218,8 +197,14 @@ struct device { struct datastore *datastore; }; +enum { + PROBE_TYPE_LOGIC, + PROBE_TYPE_ANALOG, +}; + struct probe { int index; + int type; gboolean enabled; char *name; char *trigger; @@ -227,32 +212,22 @@ struct probe { extern GSList *devices; -void device_scan(void); -void device_close_all(void); -GSList *device_list(void); -struct device *device_new(struct device_plugin *plugin, int plugin_index, int num_probes); -void device_clear(struct device *device); -void device_destroy(struct device *dev); - -void device_probe_clear(struct device *device, int probenum); -void device_probe_add(struct device *device, char *name); -struct probe *probe_find(struct device *device, int probenum); -void device_probe_name(struct device *device, int probenum, char *name); - -void device_trigger_clear(struct device *device); -void device_trigger_set(struct device *device, int probenum, char *trigger); - -/*--- hwplugin.c ------------------------------------------------------------*/ - /* Hardware plugin capabilities */ enum { - HWCAP_DUMMY, /* Used to terminate lists */ + HWCAP_DUMMY, /* Used to terminate lists */ + /* device classes */ HWCAP_LOGIC_ANALYZER, - HWCAP_SAMPLERATE, /* Change samplerate */ - HWCAP_PROBECONFIG, /* Configure probe mask */ - HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */ - HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */ - HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */ + + /* device options */ + HWCAP_SAMPLERATE, /* Change samplerate */ + HWCAP_PROBECONFIG, /* Configure probe mask */ + HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */ + HWCAP_PATTERN_MODE, /* Pattern generator mode */ + + /* acquisition modes */ + HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */ + HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */ + HWCAP_CONTINUOUS, }; struct hwcap_option { @@ -321,6 +296,8 @@ enum { DI_TRIGGER_TYPES, /* The currently set samplerate in Hz (uint64_t) */ DI_CUR_SAMPLERATE, + /* Supported pattern generator modes */ + DI_PATTERNMODES, }; /* @@ -360,97 +337,21 @@ struct gsource_fd { GSource *timeout_source; }; -typedef int (*receive_data_callback) (int fd, int revents, void *user_data); - -int load_hwplugins(void); -GSList *list_hwplugins(void); - -/* Generic device instances */ -struct sigrok_device_instance *sigrok_device_instance_new(int index, - int status, const char *vendor, const char *model, const char *version); -struct sigrok_device_instance *get_sigrok_device_instance( - GSList *device_instances, int device_index); -void sigrok_device_instance_free(struct sigrok_device_instance *sdi); - -/* USB-specific instances */ -struct usb_device_instance *usb_device_instance_new(uint8_t bus, - uint8_t address, struct libusb_device_handle *hdl); -void usb_device_instance_free(struct usb_device_instance *usb); - -/* Serial-specific instances */ -struct serial_device_instance *serial_device_instance_new( - const char *port, int fd); -void serial_device_instance_free(struct serial_device_instance *serial); - -int find_hwcap(int *capabilities, int hwcap); -struct hwcap_option *find_hwcap_option(int hwcap); -void source_remove(int fd); -void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb, - void *user_data); - -/*--- session.c -------------------------------------------------------------*/ - -typedef void (*source_callback_remove) (int fd); -typedef void (*source_callback_add) (int fd, int events, int timeout, - receive_data_callback callback, void *user_data); -typedef void (*datafeed_callback) (struct device *device, - struct datafeed_packet *packet); - struct session { /* List of struct device* */ GSList *devices; /* List of struct analyzer* */ GSList *analyzers; - /* Datafeed callbacks */ + /* list of receive_data_callback */ GSList *datafeed_callbacks; GTimeVal starttime; + gboolean running; }; -/* Session setup */ -struct session *session_load(const char *filename); -struct session *session_new(void); -void session_destroy(void); -void session_device_clear(void); -int session_device_add(struct device *device); - -/* Protocol analyzers setup */ -void session_pa_clear(void); -void session_pa_add(struct analyzer *pa); - -/* Datafeed setup */ -void session_datafeed_callback_clear(void); -void session_datafeed_callback_add(datafeed_callback callback); - -/* Session control */ -int session_start(void); -void session_stop(void); -void session_bus(struct device *device, struct datafeed_packet *packet); -void make_metadata(char *filename); -int session_save(char *filename); - -/*--- hwcommon.c ------------------------------------------------------------*/ - -int ezusb_reset(struct libusb_device_handle *hdl, int set_clear); -int ezusb_install_firmware(libusb_device_handle *hdl, char *filename); -int ezusb_upload_firmware(libusb_device *dev, int configuration, - const char *filename); - -GSList *list_serial_ports(void); -int serial_open(const char *pathname, int flags); -int serial_close(int fd); -int serial_flush(int fd); -void *serial_backup_params(int fd); -void serial_restore_params(int fd, void *backup); -int serial_set_params(int fd, int speed, int bits, int parity, int stopbits, - int flowcontrol); - -/* libsigrok/hardware/common/misc.c */ -/* TODO: Should not be public. */ -int opendev2(int device_index, struct sigrok_device_instance **sdi, - libusb_device *dev, struct libusb_device_descriptor *des, - int *skip, uint16_t vid, uint16_t pid, int interface); -int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev, - struct libusb_device_descriptor *des, - uint16_t vid, uint16_t pid, int interface); +#include "sigrok-proto.h" + +#ifdef __cplusplus +} +#endif #endif