]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/maynuo-m97/api.c
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / hardware / maynuo-m97 / api.c
index eb92c263980dd3162abd2f97b1f0fd86b044b103..20a922fa215177a139587c94121693ec6bac45a0 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include "protocol.h"
 
-SR_PRIV struct sr_dev_driver maynuo_m97_driver_info;
+static const uint32_t scanopts[] = {
+       SR_CONF_CONN,
+       SR_CONF_SERIALCOMM,
+       SR_CONF_MODBUSADDR,
+};
 
-static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
-{
-       return std_init(sr_ctx, di, LOG_PREFIX);
-}
+static const uint32_t drvopts[] = {
+       SR_CONF_ELECTRONIC_LOAD,
+};
 
-static GSList *scan(struct sr_dev_driver *di, GSList *options)
+static const uint32_t devopts[] = {
+       SR_CONF_CONTINUOUS,
+       SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
+};
+
+static const uint32_t devopts_cg[] = {
+       SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_REGULATION | SR_CONF_GET,
+       SR_CONF_VOLTAGE | SR_CONF_GET,
+       SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_CURRENT | SR_CONF_GET,
+       SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET,
+       SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE | SR_CONF_GET,
+       SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET,
+       SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE | SR_CONF_GET,
+       SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_OVER_TEMPERATURE_PROTECTION | SR_CONF_GET,
+       SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE | SR_CONF_GET,
+};
+
+/*
+ * The IDs in this list are only guessed and needs to be verified
+ * against some real hardware. If at least a few of them matches,
+ * it will probably be safe to enable the others.
+ */
+static const struct maynuo_m97_model supported_models[] = {
+//     {  53, "M9711"     ,   30, 150,    150 },
+//     {  54, "M9712"     ,   30, 150,    300 },
+//     {  55, "M9712C"    ,   60, 150,    300 },
+//     {  56, "M9713"     ,  120, 150,    600 },
+//     {  57, "M9712B"    ,   15, 500,    300 },
+//     {  58, "M9713B"    ,   30, 500,    600 },
+//     {  59, "M9714"     ,  240, 150,   1200 },
+//     {  60, "M9714B"    ,   60, 500,   1200 },
+//     {  61, "M9715"     ,  240, 150,   1800 },
+//     {  62, "M9715B"    ,  120, 500,   1800 },
+//     {  63, "M9716"     ,  240, 150,   2400 },
+//     {  64, "M9716B"    ,  120, 500,   2400 },
+//     {  65, "M9717C"    ,  480, 150,   3600 },
+//     {  66, "M9717"     ,  240, 150,   3600 },
+//     {  67, "M9717B"    ,  120, 500,   3600 },
+//     {  68, "M9718"     ,  240, 150,   6000 },
+//     {  69, "M9718B"    ,  120, 500,   6000 },
+//     {  70, "M9718D"    ,  240, 500,   6000 },
+//     {  71, "M9836"     ,  500, 150,  20000 },
+//     {  72, "M9836B"    ,  240, 500,  20000 },
+//     {  73, "M9838B"    ,  240, 500,  50000 },
+//     {  74, "M9839B"    ,  240, 500, 100000 },
+//     {  75, "M9840B"    ,  500, 500, 200000 },
+//     {  76, "M9840"     , 1500, 150, 200000 },
+//     {  77, "M9712B30"  ,   30, 500,    300 },
+//     {  78, "M9718E"    ,  120, 600,   6000 },
+//     {  79, "M9718F"    ,  480, 150,   6000 },
+//     {  80, "M9716E"    ,  480, 150,   3000 },
+//     {  81, "M9710"     ,   30, 150,    150 },
+//     {  82, "M9834"     ,  500, 150,  10000 },
+//     {  83, "M9835"     ,  500, 150,  15000 },
+//     {  84, "M9835B"    ,  240, 500,  15000 },
+//     {  85, "M9837"     ,  500, 150,  35000 },
+//     {  86, "M9837B"    ,  240, 500,  35000 },
+//     {  87, "M9838"     ,  500, 150,  50000 },
+//     {  88, "M9839"     ,  500, 150, 100000 },
+//     {  89, "M9835C"    , 1000, 150,  15000 }, /* ?? */
+//     {  90, "M9836C"    , 1000, 150,  20000 }, /* ?? */
+//     {  91, "M9718F-300",  480, 300,   6000 }, /* ?? */
+//     {  92, "M9836F"    , 1000, 150,  20000 }, /* ?? */
+//     {  93, "M9836E"    ,  240, 600,  20000 }, /* ?? */
+//     {  94, "M9717D"    ,  240, 500,   3600 }, /* ?? */
+//     {  95, "M9836B-720",  240, 720,  20000 }, /* ?? */
+//     {  96, "M9834H"    ,  500, 150,  10000 }, /* ?? */
+//     {  97, "M9836H"    ,  500, 150,  20000 }, /* ?? */
+//     {  98, "M9718F-500",  480, 500,   6000 }, /* ?? */
+//     {  99, "M9834B"    ,  240, 500,  10000 }, /* ?? */
+//     { 100, "M9811"     ,   30, 150,    200 },
+       { 101, "M9812"     ,   30, 150,    300 },
+//     { 102, "M9812B"    ,   15, 500,    300 },
+};
+
+static struct sr_dev_driver maynuo_m97_driver_info;
+
+static struct sr_dev_inst *probe_device(struct sr_modbus_dev_inst *modbus)
 {
-       struct drv_context *drvc;
-       GSList *devices;
+       const struct maynuo_m97_model *model = NULL;
+       struct dev_context *devc;
+       struct sr_dev_inst *sdi;
+       struct sr_channel_group *cg;
+       struct sr_channel *ch;
+       uint16_t id, version;
+       unsigned int i;
+
+       int ret = maynuo_m97_get_model_version(modbus, &id, &version);
+       if (ret != SR_OK)
+               return NULL;
+       for (i = 0; i < ARRAY_SIZE(supported_models); i++)
+               if (id == supported_models[i].id) {
+                       model = &supported_models[i];
+                       break;
+               }
+       if (model == NULL) {
+               sr_err("Unknown model: %d.", id);
+               return NULL;
+       }
+
+       sdi = g_malloc0(sizeof(struct sr_dev_inst));
+       sdi->status = SR_ST_INACTIVE;
+       sdi->vendor = g_strdup("Maynuo");
+       sdi->model = g_strdup(model->name);
+       sdi->version = g_strdup_printf("v%d.%d", version / 10, version % 10);
+       sdi->conn = modbus;
+       sdi->driver = &maynuo_m97_driver_info;
+       sdi->inst_type = SR_INST_MODBUS;
 
-       (void)options;
+       cg = sr_channel_group_new(sdi, "1", NULL);
 
-       devices = NULL;
-       drvc = di->priv;
-       drvc->instances = NULL;
+       ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V1");
+       cg->channels = g_slist_append(cg->channels, ch);
 
-       /* TODO: scan for devices, either based on a SR_CONF_CONN option
-        * or on a USB scan. */
+       ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "I1");
+       cg->channels = g_slist_append(cg->channels, ch);
 
-       return devices;
+       devc = g_malloc0(sizeof(struct dev_context));
+       devc->model = model;
+
+       sdi->priv = devc;
+
+       return sdi;
 }
 
-static GSList *dev_list(const struct sr_dev_driver *di)
+static int config_compare(gconstpointer a, gconstpointer b)
 {
-       return ((struct drv_context *)(di->priv))->instances;
+       const struct sr_config *ac = a, *bc = b;
+       return ac->key != bc->key;
 }
 
-static int dev_clear(const struct sr_dev_driver *di)
+static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
-       return std_dev_clear(di, NULL);
+       struct sr_config default_serialcomm = {
+               .key = SR_CONF_SERIALCOMM,
+               .data = g_variant_new_string("9600/8n1"),
+       };
+       struct sr_config default_modbusaddr = {
+               .key = SR_CONF_MODBUSADDR,
+               .data = g_variant_new_uint64(1),
+       };
+       GSList *opts = options, *devices;
+
+       if (!g_slist_find_custom(options, &default_serialcomm, config_compare))
+               opts = g_slist_prepend(opts, &default_serialcomm);
+       if (!g_slist_find_custom(options, &default_modbusaddr, config_compare))
+               opts = g_slist_prepend(opts, &default_modbusaddr);
+
+       devices = sr_modbus_scan(di->context, opts, probe_device);
+
+       while (opts != options)
+               opts = g_slist_delete_link(opts, opts);
+       g_variant_unref(default_serialcomm.data);
+       g_variant_unref(default_modbusaddr.data);
+
+       return devices;
 }
 
 static int dev_open(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
+       struct sr_modbus_dev_inst *modbus = sdi->conn;
 
-       /* TODO: get handle from sdi->conn and open it. */
+       if (sr_modbus_open(modbus) < 0)
+               return SR_ERR;
 
-       sdi->status = SR_ST_ACTIVE;
+       maynuo_m97_set_bit(modbus, PC1, 1);
 
        return SR_OK;
 }
 
 static int dev_close(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
+       struct dev_context *devc;
+       struct sr_modbus_dev_inst *modbus;
 
-       /* TODO: get handle from sdi->conn and close it. */
+       modbus = sdi->conn;
 
-       sdi->status = SR_ST_INACTIVE;
+       if (!modbus)
+               return SR_ERR_BUG;
 
-       return SR_OK;
-}
+       devc = sdi->priv;
 
-static int cleanup(const struct sr_dev_driver *di)
-{
-       dev_clear(di);
+       if (devc->expecting_registers) {
+               /* Wait for the last data that was requested from the device. */
+               uint16_t registers[devc->expecting_registers];
+               sr_modbus_read_holding_registers(modbus, -1,
+                       devc->expecting_registers, registers);
+       }
 
-       /* TODO: free other driver resources, if any. */
+       maynuo_m97_set_bit(modbus, PC1, 0);
 
-       return SR_OK;
+       return sr_modbus_close(modbus);
 }
 
-static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_get(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       int ret;
+       struct dev_context *devc;
+       struct sr_modbus_dev_inst *modbus;
+       enum maynuo_m97_mode mode;
+       int ret, ivalue;
+       float fvalue;
 
-       (void)sdi;
-       (void)data;
        (void)cg;
 
+       modbus = sdi->conn;
+       devc = sdi->priv;
+
        ret = SR_OK;
        switch (key) {
-       /* TODO */
+       case SR_CONF_LIMIT_SAMPLES:
+       case SR_CONF_LIMIT_MSEC:
+               ret = sr_sw_limits_config_get(&devc->limits, key, data);
+               break;
+       case SR_CONF_ENABLED:
+               if ((ret = maynuo_m97_get_bit(modbus, ISTATE, &ivalue)) == SR_OK)
+                       *data = g_variant_new_boolean(ivalue);
+               break;
+       case SR_CONF_REGULATION:
+               if ((ret = maynuo_m97_get_bit(modbus, UNREG, &ivalue)) != SR_OK)
+                       break;
+               if (ivalue)
+                       *data = g_variant_new_string("UR");
+               else if ((ret = maynuo_m97_get_mode(modbus, &mode)) == SR_OK)
+                       *data = g_variant_new_string(maynuo_m97_mode_to_str(mode));
+               break;
+       case SR_CONF_VOLTAGE:
+               if ((ret = maynuo_m97_get_float(modbus, U, &fvalue)) == SR_OK)
+                       *data = g_variant_new_double(fvalue);
+               break;
+       case SR_CONF_VOLTAGE_TARGET:
+               if ((ret = maynuo_m97_get_float(modbus, UFIX, &fvalue)) == SR_OK)
+                       *data = g_variant_new_double(fvalue);
+               break;
+       case SR_CONF_CURRENT:
+               if ((ret = maynuo_m97_get_float(modbus, I, &fvalue)) == SR_OK)
+                       *data = g_variant_new_double(fvalue);
+               break;
+       case SR_CONF_CURRENT_LIMIT:
+               if ((ret = maynuo_m97_get_float(modbus, IFIX, &fvalue)) == SR_OK)
+                       *data = g_variant_new_double(fvalue);
+               break;
+       case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
+               *data = g_variant_new_boolean(TRUE);
+               break;
+       case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
+               if ((ret = maynuo_m97_get_bit(modbus, UOVER, &ivalue)) == SR_OK)
+                       *data = g_variant_new_boolean(ivalue);
+               break;
+       case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
+               if ((ret = maynuo_m97_get_float(modbus, UMAX, &fvalue)) == SR_OK)
+                       *data = g_variant_new_double(fvalue);
+               break;
+       case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
+               *data = g_variant_new_boolean(TRUE);
+               break;
+       case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
+               if ((ret = maynuo_m97_get_bit(modbus, IOVER, &ivalue)) == SR_OK)
+                       *data = g_variant_new_boolean(ivalue);
+               break;
+       case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
+               if ((ret = maynuo_m97_get_float(modbus, IMAX, &fvalue)) == SR_OK)
+                       *data = g_variant_new_double(fvalue);
+               break;
+       case SR_CONF_OVER_TEMPERATURE_PROTECTION:
+               *data = g_variant_new_boolean(TRUE);
+               break;
+       case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
+               if ((ret = maynuo_m97_get_bit(modbus, HEAT, &ivalue)) == SR_OK)
+                       *data = g_variant_new_boolean(ivalue);
+               break;
        default:
                return SR_ERR_NA;
        }
@@ -103,82 +314,110 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        return ret;
 }
 
-static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_set(uint32_t key, GVariant *data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       int ret;
+       struct dev_context *devc;
+       struct sr_modbus_dev_inst *modbus;
 
-       (void)data;
        (void)cg;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
+       modbus = sdi->conn;
+       devc = sdi->priv;
 
-       ret = SR_OK;
        switch (key) {
-       /* TODO */
+       case SR_CONF_LIMIT_SAMPLES:
+       case SR_CONF_LIMIT_MSEC:
+               return sr_sw_limits_config_set(&devc->limits, key, data);
+       case SR_CONF_ENABLED:
+               return maynuo_m97_set_input(modbus, g_variant_get_boolean(data));
+       case SR_CONF_VOLTAGE_TARGET:
+               return maynuo_m97_set_float(modbus, UFIX, g_variant_get_double(data));
+       case SR_CONF_CURRENT_LIMIT:
+               return maynuo_m97_set_float(modbus, IFIX, g_variant_get_double(data));
+       case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
+               return maynuo_m97_set_float(modbus, UMAX, g_variant_get_double(data));
+       case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
+               return maynuo_m97_set_float(modbus, IMAX, g_variant_get_double(data));
        default:
-               ret = SR_ERR_NA;
+               return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
-static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_list(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       int ret;
-
-       (void)sdi;
-       (void)data;
-       (void)cg;
-
-       ret = SR_OK;
-       switch (key) {
-       /* TODO */
-       default:
-               return SR_ERR_NA;
+       struct dev_context *devc;
+
+       devc = (sdi) ? sdi->priv : NULL;
+
+       if (!cg) {
+               return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
+       } else {
+               switch (key) {
+               case SR_CONF_DEVICE_OPTIONS:
+                       *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
+                       break;
+               case SR_CONF_VOLTAGE_TARGET:
+                       if (!devc || !devc->model)
+                               return SR_ERR_ARG;
+                       *data = std_gvar_min_max_step(0.0, devc->model->max_voltage, 0.001);
+                       break;
+               case SR_CONF_CURRENT_LIMIT:
+                       if (!devc || !devc->model)
+                               return SR_ERR_ARG;
+                       *data = std_gvar_min_max_step(0.0, devc->model->max_current, 0.0001);
+                       break;
+               default:
+                       return SR_ERR_NA;
+               }
        }
 
-       return ret;
+       return SR_OK;
 }
 
-static int dev_acquisition_start(const struct sr_dev_inst *sdi,
-               void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
-       (void)sdi;
-       (void)cb_data;
+       struct dev_context *devc;
+       struct sr_modbus_dev_inst *modbus;
+       int ret;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
+       modbus = sdi->conn;
+       devc = sdi->priv;
 
-       /* TODO: configure hardware, reset acquisition state, set up
-        * callbacks and send header packet. */
+       if ((ret = sr_modbus_source_add(sdi->session, modbus, G_IO_IN, 10,
+                       maynuo_m97_receive_data, (void *)sdi)) != SR_OK)
+               return ret;
 
-       return SR_OK;
+       sr_sw_limits_acquisition_start(&devc->limits);
+       std_session_send_df_header(sdi);
+
+       return maynuo_m97_capture_start(sdi);
 }
 
-static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 {
-       (void)cb_data;
+       struct sr_modbus_dev_inst *modbus;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
+       std_session_send_df_end(sdi);
 
-       /* TODO: stop acquisition. */
+       modbus = sdi->conn;
+       sr_modbus_source_remove(sdi->session, modbus);
 
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver maynuo_m97_driver_info = {
+static struct sr_dev_driver maynuo_m97_driver_info = {
        .name = "maynuo-m97",
-       .longname = "maynuo-m97",
+       .longname = "maynuo M97/M98 series",
        .api_version = 1,
-       .init = init,
-       .cleanup = cleanup,
+       .init = std_init,
+       .cleanup = std_cleanup,
        .scan = scan,
-       .dev_list = dev_list,
-       .dev_clear = dev_clear,
+       .dev_list = std_dev_list,
+       .dev_clear = std_dev_clear,
        .config_get = config_get,
        .config_set = config_set,
        .config_list = config_list,
@@ -186,5 +425,6 @@ SR_PRIV struct sr_dev_driver maynuo_m97_driver_info = {
        .dev_close = dev_close,
        .dev_acquisition_start = dev_acquisition_start,
        .dev_acquisition_stop = dev_acquisition_stop,
-       .priv = NULL,
+       .context = NULL,
 };
+SR_REGISTER_DEV_DRIVER(maynuo_m97_driver_info);