X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=6cda5543223d17cfceb225c0dce40ded25899feb;hb=e6b2b4df9dcfaf9eb6fa10f94e0aa5e039230e21;hp=a452c725dce9defb19cd45d2c8e53e0b74db0e1b;hpb=fbf394c61766e51627033b4e95c8f9ae034c7dc1;p=libsigrok.git diff --git a/libsigrok.h b/libsigrok.h index a452c725..6cda5543 100644 --- a/libsigrok.h +++ b/libsigrok.h @@ -1,7 +1,7 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * - * Copyright (C) 2010-2012 Bert Vermeulen + * Copyright (C) 2013 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 @@ -36,7 +36,7 @@ extern "C" { * The public libsigrok header file to be used by frontends. * * This is the only file that libsigrok users (frontends) are supposed to - * use and #include. There are other header files which get installed with + * use and \#include. There are other header files which get installed with * libsigrok, but those are not meant to be used directly by frontends. * * The correct way to get/use the libsigrok API functions is: @@ -70,18 +70,24 @@ enum { SR_ERR_ARG = -3, /**< Function argument error. */ SR_ERR_BUG = -4, /**< Errors hinting at internal bugs. */ SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */ + SR_ERR_NA = -6, /**< Not applicable. */ + SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */ + + /* + * Note: When adding entries here, don't forget to also update the + * sr_strerror() and sr_strerror_name() functions in error.c. + */ }; -#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */ #define SR_MAX_PROBENAME_LEN 32 /* Handy little macros */ #define SR_HZ(n) (n) -#define SR_KHZ(n) ((n) * 1000) -#define SR_MHZ(n) ((n) * 1000000) -#define SR_GHZ(n) ((n) * 1000000000) +#define SR_KHZ(n) ((n) * (uint64_t)(1000ULL)) +#define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL)) +#define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL)) -#define SR_HZ_TO_NS(n) (1000000000 / (n)) +#define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n)) /** libsigrok loglevels. */ enum { @@ -125,7 +131,7 @@ enum { typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); -/** Data types used by hardware drivers for dev_config_set(). */ +/** Data types used by sr_config_info(). */ enum { SR_T_UINT64 = 10000, SR_T_CHAR, @@ -136,14 +142,6 @@ enum { SR_T_KEYVALUE, }; -/** Rational number data type, containing numerator and denominator values. */ -struct sr_rational { - /** Numerator of the rational number. */ - uint64_t p; - /** Denominator of the rational number. */ - uint64_t q; -}; - /** Value for sr_datafeed_packet.type. */ enum { SR_DF_HEADER = 10000, @@ -279,22 +277,15 @@ struct sr_datafeed_meta { GSList *config; }; -struct sr_datafeed_meta_logic { - int num_probes; - uint64_t samplerate; -}; - struct sr_datafeed_logic { uint64_t length; uint16_t unitsize; void *data; }; -struct sr_datafeed_meta_analog { - int num_probes; -}; - struct sr_datafeed_analog { + /** The probes for which data is included in this packet. */ + GSList *probes; int num_samples; /** Measured quantity (voltage, current, temperature, and so on). */ int mq; @@ -302,60 +293,239 @@ struct sr_datafeed_analog { int unit; /** Bitmap with extra information about the MQ. */ uint64_t mqflags; - /** The analog value. */ + /** The analog value(s). The data is interleaved according to + * the probes list. */ float *data; }; +/** Input (file) format struct. */ struct sr_input { + /** + * A pointer to this input format's 'struct sr_input_format'. + * The frontend can use this to call the module's callbacks. + */ struct sr_input_format *format; + GHashTable *param; + struct sr_dev_inst *sdi; + void *internal; }; struct sr_input_format { + /** The unique ID for this input format. Must not be NULL. */ char *id; + + /** + * A short description of the input format, which can (for example) + * be displayed to the user by frontends. Must not be NULL. + */ char *description; + + /** + * Check if this input module can load and parse the specified file. + * + * @param filename The name (and path) of the file to check. + * + * @return TRUE if this module knows the format, FALSE if it doesn't. + */ int (*format_match) (const char *filename); - int (*init) (struct sr_input *in); + + /** + * Initialize the input module. + * + * @param in A pointer to a valid 'struct sr_input' that the caller + * has to allocate and provide to this function. It is also + * the responsibility of the caller to free it later. + * @param filename The name (and path) of the file to use. + * + * @return SR_OK upon success, a negative error code upon failure. + */ + int (*init) (struct sr_input *in, const char *filename); + + /** + * Load a file, parsing the input according to the file's format. + * + * This function will send datafeed packets to the session bus, so + * the calling frontend must have registered its session callbacks + * beforehand. + * + * The packet types sent across the session bus by this function must + * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data + * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet + * if appropriate. + * + * @param in A pointer to a valid 'struct sr_input' that the caller + * has to allocate and provide to this function. It is also + * the responsibility of the caller to free it later. + * @param filename The name (and path) of the file to use. + * + * @return SR_OK upon success, a negative error code upon failure. + */ int (*loadfile) (struct sr_input *in, const char *filename); }; +/** Output (file) format struct. */ struct sr_output { + /** + * A pointer to this output format's 'struct sr_output_format'. + * The frontend can use this to call the module's callbacks. + */ struct sr_output_format *format; + + /** + * The device for which this output module is creating output. This + * can be used by the module to find out probe names and numbers. + */ struct sr_dev_inst *sdi; + + /** + * An optional parameter which the frontend can pass in to the + * output module. How the string is interpreted is entirely up to + * the module. + */ char *param; + + /** + * A generic pointer which can be used by the module to keep internal + * state between calls into its callback functions. + * + * For example, the module might store a pointer to a chunk of output + * there, and only flush it when it reaches a certain size. + */ void *internal; }; struct sr_output_format { + /** + * A unique ID for this output format. Must not be NULL. + * + * It can be used by frontends to select this output format for use. + * + * For example, calling sigrok-cli with -O hex will + * select the hexadecimal text output format. + */ char *id; + + /** + * A short description of the output format. Must not be NULL. + * + * This can be displayed by frontends, e.g. when selecting the output + * format for saving a file. + */ char *description; + int df_type; + + /** + * This function is called once, at the beginning of an output stream. + * + * The device struct will be available in the output struct passed in, + * as well as the param field -- which may be NULL or an empty string, + * if no parameter was passed. + * + * The module can use this to initialize itself, create a struct for + * keeping state and storing it in the internal field. + * + * @param o Pointer to the respective 'struct sr_output'. + * + * @return SR_OK upon success, a negative error code otherwise. + */ int (*init) (struct sr_output *o); + + /** + * Whenever a chunk of data comes in, it will be passed to the + * output module via this function. The data_in and + * length_in values refers to this data; the module + * must not alter or g_free() this buffer. + * + * The function must allocate a buffer for storing its output, and + * pass along a pointer to this buffer in the data_out + * parameter, as well as storing the length of the buffer in + * length_out. The calling frontend will g_free() + * this buffer when it's done with it. + * + * IMPORTANT: The memory allocation much happen using a glib memory + * allocation call (not a "normal" malloc) since g_free() will be + * used to free the memory! + * + * If there is no output, this function MUST store NULL in the + * data_out parameter, so the caller knows not to try + * and g_free() it. + * + * Note: This API call is obsolete, use receive() instead. + * + * @param o Pointer to the respective 'struct sr_output'. + * @param data_in Pointer to the input data buffer. + * @param length_in Length of the input. + * @param data_out Pointer to the allocated output buffer. + * @param length_out Length (in bytes) of the output. + * + * @return SR_OK upon success, a negative error code otherwise. + */ int (*data) (struct sr_output *o, const uint8_t *data_in, uint64_t length_in, uint8_t **data_out, uint64_t *length_out); + + /** + * This function is called when an event occurs in the datafeed + * which the output module may need to be aware of. No data is + * passed in, only the fact that the event occurs. The following + * events can currently be passed in: + * + * - SR_DF_TRIGGER: At this point in the datafeed, the trigger + * matched. The output module may mark this in some way, e.g. by + * plotting a red line on a graph. + * + * - SR_DF_END: This marks the end of the datafeed. No more calls + * into the output module will be done, so this is a good time to + * free up any memory used to keep state, for example. + * + * Any output generated by this function must have a reference to + * it stored in the data_out and length_out + * parameters, or NULL if no output was generated. + * + * Note: This API call is obsolete, use receive() instead. + * + * @param o Pointer to the respective 'struct sr_output'. + * @param event_type Type of event that occured. + * @param data_out Pointer to the allocated output buffer. + * @param length_out Length (in bytes) of the output. + * + * @return SR_OK upon success, a negative error code otherwise. + */ int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, - uint64_t *length_out); - GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi, - const struct sr_datafeed_packet *packet); - int (*cleanup) (struct sr_output *o); -}; + uint64_t *length_out); -/* - * This represents a generic device connected to the system. - * 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_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 pointers. */ - GSList *probes; + /** + * This function is passed a copy of every packed in the data feed. + * Any output generated by the output module in response to the + * packet should be returned in a newly allocated GString + * out, which will be freed by the caller. + * + * Packets not of interest to the output module can just be ignored, + * and the out parameter set to NULL. + * + * @param o Pointer to the respective 'struct sr_output'. + * @param sdi The device instance that generated the packet. + * @param packet The complete packet. + * @param out A pointer where a GString * should be stored if + * the module generates output, or NULL if not. + * + * @return SR_OK upon success, a negative error code otherwise. + */ + int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *packet, GString **out); + + /** + * This function is called after the caller is finished using + * the output module, and can be used to free any internal + * resources the module may keep. + * + * @return SR_OK upon success, a negative error code otherwise. + */ + int (*cleanup) (struct sr_output *o); }; enum { @@ -364,6 +534,7 @@ enum { }; struct sr_probe { + /* The index field will go: use g_slist_length(sdi->probes) instead. */ int index; int type; gboolean enabled; @@ -373,7 +544,7 @@ struct sr_probe { struct sr_config { int key; - const void *value; + GVariant *data; }; struct sr_config_info { @@ -384,19 +555,43 @@ struct sr_config_info { char *description; }; -/** Hardware driver options. */ enum { + /*--- Device classes ------------------------------------------------*/ + + /** The device can act as logic analyzer. */ + SR_CONF_LOGIC_ANALYZER = 10000, + + /** The device can act as an oscilloscope. */ + SR_CONF_OSCILLOSCOPE, + + /** The device can act as a multimeter. */ + SR_CONF_MULTIMETER, + + /** The device is a demo device. */ + SR_CONF_DEMO_DEV, + + /** The device can act as a sound level meter. */ + SR_CONF_SOUNDLEVELMETER, + + /** The device can measure temperature. */ + SR_CONF_THERMOMETER, + + /** The device can measure humidity. */ + SR_CONF_HYGROMETER, + + /*--- Driver scan options -------------------------------------------*/ + /** * Specification on how to connect to a device. * - * In combination with SR_HWOPT_SERIALCOMM, this is a serial port in + * In combination with SR_CONF_SERIALCOMM, this is a serial port in * the form which makes sense to the OS (e.g., /dev/ttyS0). * Otherwise this specifies a USB device, either in the form of * @verbatim .
@endverbatim (decimal, e.g. 1.65) or * @verbatim . @endverbatim * (hexadecimal, e.g. 1d6b.0001). */ - SR_HWOPT_CONN = 10000, + SR_CONF_CONN = 20000, /** * Serial communication specification, in the form: @@ -405,92 +600,89 @@ enum { * * Example: 9600/8n1 * + * The string may also be followed by one or more special settings, + * in the form "/key=value". Supported keys and their values are: + * + * rts 0,1 set the port's RTS pin to low or high + * dtr 0,1 set the port's DTR pin to low or high + * flow 0 no flow control + * 1 hardware-based (RTS/CTS) flow control + * 2 software-based (XON/XOFF) flow control + * * This is always an optional parameter, since a driver typically * knows the speed at which the device wants to communicate. */ - SR_HWOPT_SERIALCOMM, -}; - -/** Hardware device capabilities. */ -enum { - /*--- Device classes ------------------------------------------------*/ - - /** The device can act as logic analyzer. */ - SR_HWCAP_LOGIC_ANALYZER = 10000, - - /** The device can act as an oscilloscope. */ - SR_HWCAP_OSCILLOSCOPE, - - /** The device can act as a multimeter. */ - SR_HWCAP_MULTIMETER, - - /** The device is a demo device. */ - SR_HWCAP_DEMO_DEV, - - /** The device can act as a sound level meter. */ - SR_HWCAP_SOUNDLEVELMETER, - - /** The device can measure temperature. */ - SR_HWCAP_THERMOMETER, - - /** The device can measure humidity. */ - SR_HWCAP_HYGROMETER, + SR_CONF_SERIALCOMM, /*--- Device configuration ------------------------------------------*/ - /** The device supports setting/changing its samplerate. */ - SR_HWCAP_SAMPLERATE = 20000, + /** The device supports setting its samplerate, in Hz. */ + SR_CONF_SAMPLERATE = 30000, /** The device supports setting a pre/post-trigger capture ratio. */ - SR_HWCAP_CAPTURE_RATIO, + SR_CONF_CAPTURE_RATIO, - /* TODO? */ /** The device supports setting a pattern (pattern generator mode). */ - SR_HWCAP_PATTERN_MODE, + SR_CONF_PATTERN_MODE, /** The device supports Run Length Encoding. */ - SR_HWCAP_RLE, + SR_CONF_RLE, /** The device supports setting trigger slope. */ - SR_HWCAP_TRIGGER_SLOPE, + SR_CONF_TRIGGER_SLOPE, /** Trigger source. */ - SR_HWCAP_TRIGGER_SOURCE, + SR_CONF_TRIGGER_SOURCE, /** Horizontal trigger position. */ - SR_HWCAP_HORIZ_TRIGGERPOS, + SR_CONF_HORIZ_TRIGGERPOS, /** Buffer size. */ - SR_HWCAP_BUFFERSIZE, + SR_CONF_BUFFERSIZE, /** Time base. */ - SR_HWCAP_TIMEBASE, + SR_CONF_TIMEBASE, /** Filter. */ - SR_HWCAP_FILTER, + SR_CONF_FILTER, /** Volts/div. */ - SR_HWCAP_VDIV, + SR_CONF_VDIV, /** Coupling. */ - SR_HWCAP_COUPLING, + SR_CONF_COUPLING, + + /** Trigger types. */ + SR_CONF_TRIGGER_TYPE, + + /** The device supports setting its sample interval, in ms. */ + SR_CONF_SAMPLE_INTERVAL, + + /** Number of timebases, as related to SR_CONF_TIMEBASE. */ + SR_CONF_NUM_TIMEBASE, + + /** Number of vertical divisions, as related to SR_CONF_VDIV. */ + SR_CONF_NUM_VDIV, /*--- Special stuff -------------------------------------------------*/ + /** Scan options supported by the driver. */ + SR_CONF_SCAN_OPTIONS = 40000, + + /** Device options for a particular device. */ + SR_CONF_DEVICE_OPTIONS, + /** Session filename. */ - SR_HWCAP_SESSIONFILE = 30000, + SR_CONF_SESSIONFILE, - /* TODO: Better description. */ /** The device supports specifying a capturefile to inject. */ - SR_HWCAP_CAPTUREFILE, + SR_CONF_CAPTUREFILE, - /* TODO: Better description. */ /** The device supports specifying the capturefile unit size. */ - SR_HWCAP_CAPTURE_UNITSIZE, + SR_CONF_CAPTURE_UNITSIZE, - /* TODO: Better description. */ /** The device supports setting the number of probes. */ - SR_HWCAP_CAPTURE_NUM_PROBES, + SR_CONF_CAPTURE_NUM_PROBES, /*--- Acquisition modes ---------------------------------------------*/ @@ -498,26 +690,30 @@ enum { * The device supports setting a sample time limit (how long * the sample acquisition should run, in ms). */ - SR_HWCAP_LIMIT_MSEC = 40000, + SR_CONF_LIMIT_MSEC = 50000, /** * The device supports setting a sample number limit (how many * samples should be acquired). */ - SR_HWCAP_LIMIT_SAMPLES, + SR_CONF_LIMIT_SAMPLES, /** * The device supports setting a frame limit (how many * frames should be acquired). */ - SR_HWCAP_LIMIT_FRAMES, + SR_CONF_LIMIT_FRAMES, /** * The device supports continuous sampling. 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, + SR_CONF_CONTINUOUS, + + /** The device has internal storage, into which data is logged. This + * starts or stops the internal logging. */ + SR_CONF_DATALOG, }; struct sr_dev_inst { @@ -529,6 +725,7 @@ struct sr_dev_inst { char *model; char *version; GSList *probes; + void *conn; void *priv; }; @@ -554,51 +751,6 @@ enum { SR_ST_STOPPING, }; -/* - * TODO: This sucks, you just kinda have to "know" the returned type. - * TODO: Need a DI to return the number of trigger stages supported. - */ - -/** Device info IDs. */ -enum { - /** A list of options supported by the driver. */ - SR_DI_HWOPTS = 10000, - /** A list of capabilities supported by the device. */ - SR_DI_HWCAPS, - /** Samplerates supported by this device (struct sr_samplerates). */ - SR_DI_SAMPLERATES, - /** Types of logic trigger supported, out of "01crf" (char *). */ - SR_DI_TRIGGER_TYPES, - /** The currently set samplerate in Hz (uint64_t). */ - SR_DI_CUR_SAMPLERATE, - /** Supported patterns (in pattern generator mode). */ - SR_DI_PATTERNS, - /** Supported buffer sizes. */ - SR_DI_BUFFERSIZES, - /** Supported time bases. */ - SR_DI_TIMEBASES, - /** Supported trigger sources. */ - SR_DI_TRIGGER_SOURCES, - /** Supported filter targets. */ - SR_DI_FILTERS, - /** Valid volts/div values. */ - SR_DI_VDIVS, - /** Coupling options. */ - SR_DI_COUPLING, -}; - -/* - * A device supports either a range of samplerates with steps of a given - * granularity, or is limited to a set of defined samplerates. Use either - * step or list, but not both. - */ -struct sr_samplerates { - uint64_t low; - uint64_t high; - uint64_t step; - const uint64_t *list; -}; - struct sr_dev_driver { /* Driver-specific */ char *name; @@ -609,14 +761,16 @@ struct sr_dev_driver { GSList *(*scan) (GSList *options); GSList *(*dev_list) (void); int (*dev_clear) (void); + int (*config_get) (int id, GVariant **data, + const struct sr_dev_inst *sdi); + int (*config_set) (int id, GVariant *data, + const struct sr_dev_inst *sdi); + int (*config_list) (int info_id, GVariant **data, + const struct sr_dev_inst *sdi); /* Device-specific */ int (*dev_open) (struct sr_dev_inst *sdi); int (*dev_close) (struct sr_dev_inst *sdi); - int (*info_get) (int info_id, const void **data, - const struct sr_dev_inst *sdi); - int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap, - const void *value); int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, void *cb_data); int (*dev_acquisition_stop) (struct sr_dev_inst *sdi, @@ -629,7 +783,7 @@ struct sr_dev_driver { struct sr_session { /** List of struct sr_dev pointers. */ GSList *devs; - /** List of sr_receive_data_callback_t items. */ + /** List of struct datafeed_callback pointers. */ GSList *datafeed_callbacks; GTimeVal starttime; @@ -644,6 +798,14 @@ struct sr_session { struct source *sources; GPollFD *pollfds; int source_timeout; + + /* + * These are our synchronization primitives for stopping the session in + * an async fashion. We need to make sure the session is stopped from + * within the session thread itself. + */ + GMutex stop_mutex; + gboolean abort_session; }; #include "proto.h"