X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=3235ddf26ddbdcd620b60debd16e30893b9667fb;hb=999f6730c66fafc76fe32f7090cc740d901a2226;hp=9c69474e3f0f3260811f4a3286eb6cb565b728ae;hpb=ba7dd8bbb8168cba432a844259a3e239aa5f36d7;p=libsigrok.git diff --git a/libsigrok.h b/libsigrok.h index 9c69474e..3235ddf2 100644 --- a/libsigrok.h +++ b/libsigrok.h @@ -81,7 +81,7 @@ enum { */ }; -#define SR_MAX_PROBENAME_LEN 32 +#define SR_MAX_CHANNELNAME_LEN 32 /* Handy little macros */ #define SR_HZ(n) (n) @@ -92,7 +92,7 @@ enum { #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n)) /** libsigrok loglevels. */ -enum { +enum sr_loglevel { SR_LOG_NONE = 0, /**< Output no messages at all. */ SR_LOG_ERR = 1, /**< Output error messages. */ SR_LOG_WARN = 2, /**< Output warnings. */ @@ -135,7 +135,7 @@ enum { typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); /** Data types used by sr_config_info(). */ -enum { +enum sr_datatype { SR_T_UINT64 = 10000, SR_T_CHAR, SR_T_BOOL, @@ -149,7 +149,7 @@ enum { }; /** Value for sr_datafeed_packet.type. */ -enum { +enum sr_packettype { /** Payload is sr_datafeed_header. */ SR_DF_HEADER = 10000, /** End of stream (no further data). */ @@ -169,7 +169,7 @@ enum { }; /** Measured quantity, sr_datafeed_analog.mq. */ -enum { +enum sr_mq { SR_MQ_VOLTAGE = 10000, SR_MQ_CURRENT, SR_MQ_RESISTANCE, @@ -198,7 +198,7 @@ enum { }; /** Unit of measured quantity, sr_datafeed_analog.unit. */ -enum { +enum sr_unit { /** Volt */ SR_UNIT_VOLT = 10000, /** Ampere (current). */ @@ -255,7 +255,7 @@ enum { }; /** Values for sr_datafeed_analog.flags. */ -enum { +enum sr_mqflag { /** Voltage measurement is alternating current (AC). */ SR_MQFLAG_AC = 0x01, /** Voltage measurement is direct current (DC). */ @@ -430,24 +430,21 @@ struct sr_input_format { /** 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. - */ + /** A pointer to this output's format. */ 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 channel names and numbers. */ - struct sr_dev_inst *sdi; + const 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; + GHashTable *params; /** * A generic pointer which can be used by the module to keep internal @@ -479,9 +476,6 @@ struct sr_output_format { */ char *description; - /** Datafeed type, SR_DF_HEADER, etc. */ - int df_type; - /** * This function is called once, at the beginning of an output stream. * @@ -499,72 +493,6 @@ struct sr_output_format { */ 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. - * - * @retval SR_OK Success - * @retval other Negative error code. - */ - 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. - * - * @retval SR_OK Success - * @retval other Negative error code. - */ - int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, - uint64_t *length_out); - /** * This function is passed a copy of every packed in the data feed. * Any output generated by the output module in response to the @@ -583,7 +511,7 @@ struct sr_output_format { * @retval SR_OK Success * @retval other Negative error code. */ - int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi, + int (*receive) (struct sr_output *o, const struct sr_datafeed_packet *packet, GString **out); /** @@ -597,19 +525,19 @@ struct sr_output_format { int (*cleanup) (struct sr_output *o); }; -/** Constants for probe type. */ -enum { - /** Probe type is logic probe. */ - SR_PROBE_LOGIC = 10000, - /** Probe type is analog probe. */ - SR_PROBE_ANALOG, +/** Constants for channel type. */ +enum sr_channeltype { + /** Channel type is logic channel. */ + SR_CHANNEL_LOGIC = 10000, + /** Channel type is analog channel. */ + SR_CHANNEL_ANALOG, }; /** Information on single channel. */ struct sr_channel { /** Number of channels, starting at 0. */ int index; - /** Channel type (SR_PROBE_LOGIC, ...) */ + /** Channel type (SR_CHANNEL_LOGIC, ...) */ int type; /** Is this channel enabled? */ gboolean enabled; @@ -652,7 +580,7 @@ struct sr_config_info { }; /** Constants for device classes */ -enum { +enum sr_configkey { /*--- Device classes ------------------------------------------------*/ /** The device can act as logic analyzer. */ @@ -803,11 +731,11 @@ enum { */ SR_CONF_CENTER_FREQUENCY, - /** The device supports setting the number of logic probes. */ - SR_CONF_NUM_LOGIC_PROBES, + /** The device supports setting the number of logic channels. */ + SR_CONF_NUM_LOGIC_CHANNELS, - /** The device supports setting the number of analog probes. */ - SR_CONF_NUM_ANALOG_PROBES, + /** The device supports setting the number of analog channels. */ + SR_CONF_NUM_ANALOG_CHANNELS, /** Output voltage. */ SR_CONF_OUTPUT_VOLTAGE, @@ -900,6 +828,12 @@ enum { /** The device has internal storage, into which data is logged. This * starts or stops the internal logging. */ SR_CONF_DATALOG, + + /** Device mode for multi-function devices. */ + SR_CONF_DEVICE_MODE, + + /** Self test mode. */ + SR_CONF_TEST_MODE, }; /** Device instance data @@ -992,9 +926,9 @@ struct sr_dev_driver { int (*config_set) (int id, GVariant *data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg); - /** Probe status change. - * @see sr_dev_probe_enable(), sr_dev_trigger_set(). */ - int (*config_probe_set) (const struct sr_dev_inst *sdi, + /** Channel status change. + * @see sr_dev_channel_enable(), sr_dev_trigger_set(). */ + int (*config_channel_set) (const struct sr_dev_inst *sdi, struct sr_channel *ch, unsigned int changes); /** Apply configuration settings to the device hardware. * @see sr_config_commit().*/