X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok.h;h=e12c5bc5acc6b4479f88cdb07e42f26c17b05b63;hb=c73d2ea421c2b425c3f0ae33bce2bfd0c448ca5f;hp=414890df13d12d58043fe425d51184e25f848497;hpb=c49111295f0b2e50044923897d99ca84f65b75db;p=libsigrok.git diff --git a/sigrok.h b/sigrok.h index 414890df..e12c5bc5 100644 --- a/sigrok.h +++ b/sigrok.h @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2010 Bert Vermeulen + * Copyright (C) 2010-2012 Bert Vermeulen * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -17,17 +17,14 @@ * along with this program. If not, see . */ -#ifndef SIGROK_SIGROK_H -#define SIGROK_SIGROK_H +#ifndef LIBSIGROK_SIGROK_H +#define LIBSIGROK_SIGROK_H #include #include #include #include #include -#ifdef HAVE_LIBUSB_1_0 -#include -#endif #ifdef __cplusplus extern "C" { @@ -53,45 +50,55 @@ extern "C" { #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 */ +#define SR_ERR_ARG -3 /* Function argument error */ +#define SR_ERR_BUG -4 /* Errors hinting at internal bugs */ +#define SR_ERR_SAMPLERATE -5 /* 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 +/* libsigrok loglevels. */ +#define SR_LOG_NONE 0 /**< Output no messages at all. */ +#define SR_LOG_ERR 1 /**< Output error messages. */ +#define SR_LOG_WARN 2 /**< Output warnings. */ +#define SR_LOG_INFO 3 /**< Output informational messages. */ +#define SR_LOG_DBG 4 /**< Output debug messages. */ +#define SR_LOG_SPEW 5 /**< Output very noisy debug messages. */ -#ifndef ARRAY_AND_SIZE -#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) -#endif +/* + * Use SR_API to mark public API symbols, and SR_PRIV for private symbols. + * + * Variables and functions marked 'static' are private already and don't + * need SR_PRIV. However, functions which are not static (because they need + * to be used in other libsigrok-internal files) but are also not meant to + * be part of the public libsigrok API, must use SR_PRIV. + * + * This uses the 'visibility' feature of gcc (requires gcc >= 4.0). + * + * Details: http://gcc.gnu.org/wiki/Visibility + */ + +/* Marks public libsigrok API symbols. */ +#define SR_API __attribute__((visibility("default"))) -typedef int (*receive_data_callback) (int fd, int revents, void *user_data); +/* Marks private, non-public libsigrok symbols (not part of the API). */ +#define SR_PRIV __attribute__((visibility("hidden"))) + +typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data); /* Data types used by hardware plugins for set_configuration() */ enum { SR_T_UINT64, SR_T_CHAR, - SR_T_NULL, -}; - -enum { - SR_PROTO_RAW, -}; - -/* (Unused) protocol decoder stack entry */ -struct protocol { - char *name; - int id; - int stackindex; + SR_T_BOOL, }; /* sr_datafeed_packet.type values */ @@ -100,14 +107,11 @@ enum { SR_DF_END, SR_DF_TRIGGER, SR_DF_LOGIC, - SR_DF_ANALOG, SR_DF_PD, }; struct sr_datafeed_packet { uint16_t type; - uint64_t length; - uint16_t unitsize; void *payload; }; @@ -115,20 +119,13 @@ struct sr_datafeed_header { int feed_version; struct timeval starttime; uint64_t samplerate; - int protocol_id; - int num_analog_probes; int num_logic_probes; }; -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 sr_datafeed_logic { + uint64_t length; + uint16_t unitsize; + void *data; }; struct sr_input { @@ -138,7 +135,7 @@ struct sr_input { }; struct sr_input_format { - char *extension; + char *id; char *description; int (*format_match) (const char *filename); int (*init) (struct sr_input *in); @@ -153,28 +150,16 @@ struct sr_output { }; struct sr_output_format { - char *extension; + char *id; 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 { - char *name; - char *filename; - /* - * TODO: Parameters? If so, configured plugins need another struct. - * TODO: Input and output format? - */ -}; - -/* Size of a chunk in units */ -#define DATASTORE_CHUNKSIZE 512000 - struct sr_datastore { /* Size in bytes of the number of units stored in this datastore */ int ds_unitsize; @@ -201,7 +186,6 @@ struct sr_device { enum { SR_PROBE_TYPE_LOGIC, - SR_PROBE_TYPE_ANALOG, }; struct sr_probe { @@ -212,32 +196,80 @@ struct sr_probe { char *trigger; }; -extern GSList *devices; - /* Hardware plugin capabilities */ enum { - SR_HWCAP_DUMMY, /* Used to terminate lists */ - /* device classes */ + SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */ + + /*--- Device classes ------------------------------------------------*/ + + /** The device can act as logic analyzer. */ SR_HWCAP_LOGIC_ANALYZER, - /* device options */ - SR_HWCAP_SAMPLERATE, /* Change samplerate */ - SR_HWCAP_PROBECONFIG, /* Configure probe mask */ - SR_HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */ - SR_HWCAP_PATTERN_MODE, /* Pattern generator mode */ + /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */ + + /*--- Device types --------------------------------------------------*/ + + /** The device is demo device. */ + SR_HWCAP_DEMO_DEVICE, + + /*--- Device options ------------------------------------------------*/ + + /** The device supports setting/changing its samplerate. */ + SR_HWCAP_SAMPLERATE, + + /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */ + /** The device supports setting a probe mask. */ + SR_HWCAP_PROBECONFIG, + + /** The device supports setting a pre/post-trigger capture ratio. */ + SR_HWCAP_CAPTURE_RATIO, + + /* TODO? */ + /** The device supports setting a pattern (pattern generator mode). */ + SR_HWCAP_PATTERN_MODE, + + /** The device supports Run Length Encoding. */ + SR_HWCAP_RLE, + + /*--- Special stuff -------------------------------------------------*/ + + /* TODO: Better description. */ + /** The device supports specifying a capturefile to inject. */ + SR_HWCAP_CAPTUREFILE, - /* special stuff */ - SR_HWCAP_CAPTUREFILE, /* capturefile to inject */ - SR_HWCAP_CAPTURE_UNITSIZE, /* unitsize of capturefile data */ - SR_HWCAP_CAPTURE_NUM_PROBES,/* set number of probes */ + /* TODO: Better description. */ + /** The device supports specifying the capturefile unit size. */ + SR_HWCAP_CAPTURE_UNITSIZE, - /* acquisition modes */ - SR_HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */ - SR_HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */ + /* TODO: Better description. */ + /** The device supports setting the number of probes. */ + SR_HWCAP_CAPTURE_NUM_PROBES, + + /*--- Acquisition modes ---------------------------------------------*/ + + /** + * The device supports setting a sample time limit, i.e. how long the + * sample acquisition should run (in ms). + */ + SR_HWCAP_LIMIT_MSEC, + + /** + * The device supports setting a sample number limit, i.e. how many + * samples should be acquired. + */ + SR_HWCAP_LIMIT_SAMPLES, + + /** + * The device supports continuous sampling, i.e. neither a time limit + * nor a sample number limit has to be supplied, it will just acquire + * samples continuously, until explicitly stopped by a certain command. + */ SR_HWCAP_CONTINUOUS, + + /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */ }; -struct hwcap_option { +struct sr_hwcap_option { int capability; int type; char *description; @@ -252,10 +284,6 @@ struct sr_device_instance { char *model; char *version; void *priv; - union { - struct sr_usb_device_instance *usb; - struct sr_serial_device_instance *serial; - }; }; /* sr_device_instance types */ @@ -264,19 +292,6 @@ enum { SR_SERIAL_INSTANCE, }; -#ifdef HAVE_LIBUSB_1_0 -struct sr_usb_device_instance { - uint8_t bus; - uint8_t address; - struct libusb_device_handle *devhdl; -}; -#endif - -struct sr_serial_device_instance { - char *port; - int fd; -}; - /* Device instance status */ enum { SR_ST_NOT_FOUND, @@ -299,6 +314,8 @@ enum { SR_DI_INSTANCE, /* The number of probes connected to this device */ SR_DI_NUM_PROBES, + /* The probe names on this device */ + SR_DI_PROBE_NAMES, /* Samplerates supported by this device, (struct sr_samplerates) */ SR_DI_SAMPLERATES, /* Types of trigger supported, out of "01crf" (char *) */ @@ -326,12 +343,12 @@ 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 */ - int (*open) (int device_index); - void (*close) (int device_index); + int (*opendev) (int device_index); + int (*closedev) (int device_index); void *(*get_device_info) (int device_index, int device_info_id); int (*get_status) (int device_index); int *(*get_capabilities) (void); @@ -343,9 +360,7 @@ struct sr_device_plugin { struct sr_session { /* List of struct sr_device* */ 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;