X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok.h;h=c6809468f0a88acb9b6bba2f308cea1484532fdd;hb=44dae539254e324e0330e194f9c775be3d761503;hp=898785612e60dd3a696fbd195c66d564a478cda1;hpb=06dd80d424a511736e0c61492bd618a5c3e65cff;p=libsigrok.git diff --git a/sigrok.h b/sigrok.h index 89878561..c6809468 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" { @@ -54,10 +51,11 @@ extern "C" { #define SR_ERR -1 /* Generic/unspecified error */ #define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ #define SR_ERR_ARG -3 /* Function argument error */ -#define SR_ERR_SAMPLERATE -4 /* Incorrect samplerate */ +#define SR_ERR_BUG -4 /* Errors hinting at internal bugs */ +#define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */ -#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ -#define SR_MAX_PROBENAME_LEN 32 +#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ +#define SR_MAX_PROBENAME_LEN 32 /* Handy little macros */ #define SR_HZ(n) (n) @@ -68,12 +66,31 @@ extern "C" { #define SR_HZ_TO_NS(n) (1000000000 / (n)) /* libsigrok loglevels. */ -#define SR_LOG_NONE 0 -#define SR_LOG_ERR 1 -#define SR_LOG_WARN 2 -#define SR_LOG_INFO 3 -#define SR_LOG_DBG 4 -#define SR_LOG_SPEW 5 +#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. */ + +/* + * 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"))) + +/* 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); @@ -81,36 +98,20 @@ typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data); enum { SR_T_UINT64, SR_T_CHAR, - SR_T_NULL, + SR_T_BOOL, }; -enum { - SR_PROTO_RAW, -}; - -#if 0 -/* (Unused) protocol decoder stack entry */ -struct sr_protocol { - char *name; - int id; - int stackindex; -}; -#endif - /* sr_datafeed_packet.type values */ enum { SR_DF_HEADER, 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; }; @@ -118,23 +119,14 @@ struct sr_datafeed_header { int feed_version; struct timeval starttime; uint64_t samplerate; - int protocol_id; - int num_analog_probes; int num_logic_probes; }; -#if defined(HAVE_LA_ALSA) -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 sr_analog_sample { - uint8_t num_probes; /* Max hardware probes is 256 */ - struct sr_analog_probe probes[]; +struct sr_datafeed_logic { + uint64_t length; + uint16_t unitsize; + void *data; }; -#endif struct sr_input { struct sr_input_format *format; @@ -168,17 +160,6 @@ struct sr_output_format { uint64_t *length_out); }; -#if 0 -struct sr_analyzer { - char *name; - char *filename; - /* - * TODO: Parameters? If so, configured plugins need another struct. - * TODO: Input and output format? - */ -}; -#endif - struct sr_datastore { /* Size in bytes of the number of units stored in this datastore */ int ds_unitsize; @@ -205,7 +186,6 @@ struct sr_device { enum { SR_PROBE_TYPE_LOGIC, - SR_PROBE_TYPE_ANALOG, }; struct sr_probe { @@ -216,12 +196,9 @@ struct sr_probe { char *trigger; }; -/* TODO: Get rid of this global variable. */ -extern GSList *devices; - /* Hardware plugin capabilities */ enum { - SR_HWCAP_DUMMY, /* Used to terminate lists */ + SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */ /*--- Device classes ------------------------------------------------*/ @@ -230,6 +207,11 @@ enum { /* 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. */ @@ -246,6 +228,9 @@ enum { /** 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. */ @@ -299,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 */ @@ -311,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, @@ -346,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 *) */ @@ -374,7 +344,7 @@ struct sr_device_plugin { char *longname; int api_version; int (*init) (const char *deviceinfo); - void (*cleanup) (void); + int (*cleanup) (void); /* Device-specific */ int (*opendev) (int device_index); @@ -384,14 +354,12 @@ struct sr_device_plugin { int *(*get_capabilities) (void); int (*set_configuration) (int device_index, int capability, void *value); int (*start_acquisition) (int device_index, gpointer session_device_id); - void (*stop_acquisition) (int device_index, gpointer session_device_id); + int (*stop_acquisition) (int device_index, gpointer session_device_id); }; struct sr_session { /* List of struct sr_device* */ GSList *devices; - /* List of struct analyzer* */ - GSList *analyzers; /* list of sr_receive_data_callback */ GSList *datafeed_callbacks; GTimeVal starttime;