X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok.h;h=7b3d4a4967d9c38c92e552099c4752a5ea64c8ed;hb=819184ee68f1fda1ebc5b0a5f6aed403ecc27403;hp=414890df13d12d58043fe425d51184e25f848497;hpb=c49111295f0b2e50044923897d99ca84f65b75db;p=libsigrok.git diff --git a/sigrok.h b/sigrok.h index 414890df..7b3d4a49 100644 --- a/sigrok.h +++ b/sigrok.h @@ -55,26 +55,18 @@ extern "C" { #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 +#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ +#define SR_MAX_PROBENAME_LEN 32 /* Handy little macros */ -#define KHZ(n) ((n) * 1000) -#define MHZ(n) ((n) * 1000000) -#define GHZ(n) ((n) * 1000000000) +#define SR_HZ(n) (n) +#define SR_KHZ(n) ((n) * 1000) +#define SR_MHZ(n) ((n) * 1000000) +#define SR_GHZ(n) ((n) * 1000000000) -#define HZ_TO_NS(n) (1000000000 / (n)) +#define SR_HZ_TO_NS(n) (1000000000 / (n)) -#ifndef ARRAY_SIZE -#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) -#endif - -#ifndef ARRAY_AND_SIZE -#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) -#endif - -typedef int (*receive_data_callback) (int fd, int revents, void *user_data); +typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data); /* Data types used by hardware plugins for set_configuration() */ enum { @@ -87,12 +79,14 @@ enum { SR_PROTO_RAW, }; +#if 0 /* (Unused) protocol decoder stack entry */ -struct protocol { +struct sr_protocol { char *name; int id; int stackindex; }; +#endif /* sr_datafeed_packet.type values */ enum { @@ -120,16 +114,18 @@ struct sr_datafeed_header { int num_logic_probes; }; -struct analog_probe { +#if 0 +struct sr_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 { +struct sr_analog_sample { uint8_t num_probes; /* Max hardware probes is 256 */ - struct analog_probe probes[]; + struct sr_analog_probe probes[]; }; +#endif struct sr_input { struct sr_input_format *format; @@ -157,13 +153,14 @@ struct sr_output_format { char *description; int df_type; 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 (*data) (struct sr_output *o, const char *data_in, + uint64_t length_in, char **data_out, uint64_t *length_out); int (*event) (struct sr_output *o, int event_type, char **data_out, uint64_t *length_out); }; -struct analyzer { +#if 0 +struct sr_analyzer { char *name; char *filename; /* @@ -171,9 +168,7 @@ struct analyzer { * TODO: Input and output format? */ }; - -/* Size of a chunk in units */ -#define DATASTORE_CHUNKSIZE 512000 +#endif struct sr_datastore { /* Size in bytes of the number of units stored in this datastore */ @@ -212,6 +207,7 @@ struct sr_probe { char *trigger; }; +/* TODO: Get rid of this global variable. */ extern GSList *devices; /* Hardware plugin capabilities */ @@ -237,7 +233,7 @@ enum { SR_HWCAP_CONTINUOUS, }; -struct hwcap_option { +struct sr_hwcap_option { int capability; int type; char *description; @@ -326,7 +322,7 @@ struct sr_device_plugin { char *name; char *longname; int api_version; - int (*init) (char *deviceinfo); + int (*init) (const char *deviceinfo); void (*cleanup) (void); /* Device-specific */ @@ -345,7 +341,7 @@ struct sr_session { GSList *devices; /* List of struct analyzer* */ GSList *analyzers; - /* list of receive_data_callback */ + /* list of sr_receive_data_callback */ GSList *datafeed_callbacks; GTimeVal starttime; gboolean running;