X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok.h;h=5bab6adf467924495ab1f2982c334e6e731c2522;hb=c09f0b578c0e9c03590cb814f66004bb3f6815ff;hp=e839c4844c9d40a67af9ed4a99cad4219ded9680;hpb=92b3101cfc71581a273e667f185b18be0f0c364f;p=libsigrok.git diff --git a/sigrok.h b/sigrok.h index e839c484..5bab6adf 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) @@ -67,27 +65,41 @@ extern "C" { #define SR_HZ_TO_NS(n) (1000000000 / (n)) +/* 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. */ + +/* + * 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); -/* Data types used by hardware plugins for set_configuration() */ +/* Data types used by hardware drivers for dev_config_set() */ enum { SR_T_UINT64, SR_T_CHAR, - SR_T_NULL, -}; - -enum { - SR_PROTO_RAW, -}; - -#if 0 -/* (Unused) protocol decoder stack entry */ -struct sr_protocol { - char *name; - int id; - int stackindex; + SR_T_BOOL, }; -#endif /* sr_datafeed_packet.type values */ enum { @@ -95,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; }; @@ -110,28 +119,19 @@ 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; char *param; - struct sr_device *vdevice; + struct sr_dev *vdev; }; struct sr_input_format { @@ -144,7 +144,7 @@ struct sr_input_format { struct sr_output { struct sr_output_format *format; - struct sr_device *device; + struct sr_dev *dev; char *param; void *internal; }; @@ -160,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; @@ -180,15 +169,15 @@ struct sr_datastore { /* * This represents a generic device connected to the system. - * For device-specific information, ask the plugin. The plugin_index refers - * to the device index within that plugin; it may be handling more than one - * device. All relevant plugin calls take a device_index parameter for this. + * For device-specific information, ask the driver. The driver_index refers + * to the device index within that driver; it may be handling more than one + * device. All relevant driver calls take a dev_index parameter for this. */ -struct sr_device { - /* Which plugin handles this device */ - struct sr_device_plugin *plugin; - /* A plugin may handle multiple devices of the same type */ - int plugin_index; +struct sr_dev { + /* Which driver handles this device */ + struct sr_dev_driver *driver; + /* A driver may handle multiple devices of the same type */ + int driver_index; /* List of struct sr_probe* */ GSList *probes; /* Data acquired by this device, if any */ @@ -197,7 +186,6 @@ struct sr_device { enum { SR_PROBE_TYPE_LOGIC, - SR_PROBE_TYPE_ANALOG, }; struct sr_probe { @@ -208,70 +196,100 @@ struct sr_probe { char *trigger; }; -/* TODO: Get rid of this global variable. */ -extern GSList *devices; - -/* Hardware plugin capabilities */ +/* Hardware driver 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_DEV, + + /*--- 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 sr_hwcap_option { - int capability; + int hwcap; int type; char *description; char *shortname; }; -struct sr_device_instance { +struct sr_dev_inst { int index; int status; - int instance_type; + int inst_type; char *vendor; char *model; char *version; void *priv; - union { - struct sr_usb_device_instance *usb; - struct sr_serial_device_instance *serial; - }; }; -/* sr_device_instance types */ +/* sr_dev_inst types */ enum { - SR_USB_INSTANCE, - 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; + SR_USB_INST, + SR_SERIAL_INST, }; /* Device instance status */ @@ -292,10 +310,12 @@ enum { /* Device info IDs */ enum { - /* struct sr_device_instance for this specific device */ - SR_DI_INSTANCE, + /* struct sr_dev_inst for this specific device */ + SR_DI_INST, /* 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 *) */ @@ -318,30 +338,28 @@ struct sr_samplerates { uint64_t *list; }; -struct sr_device_plugin { - /* Plugin-specific */ +struct sr_dev_driver { + /* Driver-specific */ char *name; char *longname; int api_version; - int (*init) (const char *deviceinfo); - void (*cleanup) (void); + int (*init) (const char *devinfo); + int (*cleanup) (void); /* Device-specific */ - int (*open) (int device_index); - void (*close) (int device_index); - void *(*get_device_info) (int device_index, int device_info_id); - int (*get_status) (int device_index); - 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 (*dev_open) (int dev_index); + int (*dev_close) (int dev_index); + void *(*dev_info_get) (int dev_index, int dev_info_id); + int (*dev_status_get) (int dev_index); + int *(*hwcap_get_all) (void); + int (*dev_config_set) (int dev_index, int hwcap, void *value); + int (*dev_acquisition_start) (int dev_index, gpointer session_dev_id); + int (*dev_acquisition_stop) (int dev_index, gpointer session_dev_id); }; struct sr_session { - /* List of struct sr_device* */ - GSList *devices; - /* List of struct analyzer* */ - GSList *analyzers; + /* List of struct sr_dev* */ + GSList *devs; /* list of sr_receive_data_callback */ GSList *datafeed_callbacks; GTimeVal starttime;