Build: Set local include directories in Makefile.am

[libsigrok.git] / include / libsigrok / libsigrok.h

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 3c204798ef8d3b056597b60463d573f7c1772225..0e35957f05ee76a95868136e92ed6069c101f2db 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -518,6 +518,12 @@ struct sr_option {
        GSList *values;
 };
 
+/** Output module flags. */
+enum sr_output_flag {
+       /** If set, this output module writes the output itself. */
+       SR_OUTPUT_INTERNAL_IO_HANDLING = 0x01,
+};
+
 struct sr_input;
 struct sr_input_module;
 struct sr_output;
@@ -624,6 +630,9 @@ enum sr_configkey {
        /** The device can act as an LCR meter. */
        SR_CONF_LCRMETER,
 
+       /** The device can act as an electronic load. */
+       SR_CONF_ELECTRONIC_LOAD,
+
        /*--- Driver scan options -------------------------------------------*/
 
        /**
@@ -659,6 +668,14 @@ enum sr_configkey {
         */
        SR_CONF_SERIALCOMM,
 
+       /**
+        * Modbus slave address specification.
+        *
+        * This is always an optional parameter, since a driver typically
+        * knows the default slave address of the device.
+        */
+       SR_CONF_MODBUSADDR,
+
        /*--- Device (or channel group) configuration -----------------------*/
 
        /** The device supports setting its samplerate, in Hz. */
@@ -758,51 +775,51 @@ enum sr_configkey {
        SR_CONF_NUM_ANALOG_CHANNELS,
 
        /**
-        * Output voltage.
+        * Current voltage.
         * @arg type: double
-        * @arg get: get measured output voltage
+        * @arg get: get measured voltage
         */
-       SR_CONF_OUTPUT_VOLTAGE,
+       SR_CONF_VOLTAGE,
 
        /**
-        * Maximum output voltage target.
+        * Maximum target voltage.
         * @arg type: double
-        * @arg get: get output voltage target
-        * @arg set: change output voltage target
+        * @arg get: get target voltage
+        * @arg set: change target voltage
         */
-       SR_CONF_OUTPUT_VOLTAGE_TARGET,
+       SR_CONF_VOLTAGE_TARGET,
 
        /**
-        * Output current.
+        * Current current.
         * @arg type: double
-        * @arg get: get measured output current
+        * @arg get: get measured current
         */
-       SR_CONF_OUTPUT_CURRENT,
+       SR_CONF_CURRENT,
 
        /**
-        * Output current limit.
+        * Current limit.
         * @arg type: double
-        * @arg get: get output current limit
-        * @arg set: change output current limit
+        * @arg get: get current limit
+        * @arg set: change current limit
         */
-       SR_CONF_OUTPUT_CURRENT_LIMIT,
+       SR_CONF_CURRENT_LIMIT,
 
        /**
-        * Enabling/disabling output.
+        * Enabling/disabling channel.
         * @arg type: boolean
         * @arg get: @b true if currently enabled
         * @arg set: enable/disable
         */
-       SR_CONF_OUTPUT_ENABLED,
+       SR_CONF_ENABLED,
 
        /**
-        * Output channel configuration.
+        * Channel configuration.
         * @arg type: string
         * @arg get: get current setting
         * @arg set: change current setting
         * @arg list: array of possible values
         */
-       SR_CONF_OUTPUT_CHANNEL_CONFIG,
+       SR_CONF_CHANNEL_CONFIG,
 
        /**
         * Over-voltage protection (OVP) feature
@@ -839,7 +856,7 @@ enum sr_configkey {
        /**
         * Over-current protection (OCP) active
         * @arg type: boolean
-        * @arg get: @b true if device has activated OCP, i.e. the output current
+        * @arg get: @b true if device has activated OCP, i.e. the current current
         *      exceeds the over-current protection threshold.
         */
        SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
@@ -859,11 +876,11 @@ enum sr_configkey {
        SR_CONF_AMPLITUDE,
 
        /**
-        * Output channel regulation
+        * Channel regulation
         * get: "CV", "CC" or "UR", denoting constant voltage, constant current
         *      or unregulated.
         */
-       SR_CONF_OUTPUT_REGULATION,
+       SR_CONF_REGULATION,
 
        /** Over-temperature protection (OTP) */
        SR_CONF_OVER_TEMPERATURE_PROTECTION,
@@ -883,6 +900,9 @@ enum sr_configkey {
        /* Output frequency target in Hz. */
        SR_CONF_OUTPUT_FREQUENCY_TARGET,
 
+       /** Over-temperature protection (OTP) active. */
+       SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
+
        /*--- Special stuff -------------------------------------------------*/
 
        /** Scan options supported by the driver. */
@@ -975,6 +995,8 @@ enum sr_dev_inst_type {
        SR_INST_SCPI,
        /** Device-instance type for user-created "devices". */
        SR_INST_USER,
+       /** Device instance type for Modbus devices. */
+       SR_INST_MODBUS,
 };
 
 /** Device instance status, struct sr_dev_inst.status */
@@ -1007,13 +1029,13 @@ struct sr_dev_driver {
        int (*cleanup) (const struct sr_dev_driver *driver);
        /** Scan for devices. Driver should do all initialisation required.
         *  Can be called several times, e.g. with different port options.
-        *  \retval NULL Error or no devices found.
-        *  \retval other GSList of a struct sr_dev_inst for each device.
+        *  @retval NULL Error or no devices found.
+        *  @retval other GSList of a struct sr_dev_inst for each device.
         *                Must be freed by caller!
         */
        GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
        /** Get list of device instances the driver knows about.
-        *  \returns NULL or GSList of a struct sr_dev_inst for each device.
+        *  @returns NULL or GSList of a struct sr_dev_inst for each device.
         *           Must not be freed by caller!
         */
        GSList *(*dev_list) (const struct sr_dev_driver *driver);
@@ -1057,8 +1079,8 @@ struct sr_dev_driver {
                        void *cb_data);
 
        /* Dynamic */
-       /** Device driver private data. Initialized by init(). */
-       void *priv;
+       /** Device driver context, considered private. Initialized by init(). */
+       void *context;
 };
 
 /**
@@ -1077,8 +1099,8 @@ struct sr_serial_port {
        char *description;
 };
 
-#include "proto.h"
-#include "version.h"
+#include <libsigrok/proto.h>
+#include <libsigrok/version.h>
 
 #ifdef __cplusplus
 }