src/hardware/maynuo-m97/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Aurelien Jacobs <aurel@gnuage.org>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include "protocol.h"
  22
  23 static const uint32_t scanopts[] = {
  24         SR_CONF_CONN,
  25         SR_CONF_SERIALCOMM,
  26         SR_CONF_MODBUSADDR
  27 };
  28
  29 static const uint32_t drvopts[] = {
  30         SR_CONF_ELECTRONIC_LOAD,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         SR_CONF_CONTINUOUS,
  35         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  36         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  37 };
  38
  39 static const uint32_t devopts_cg[] = {
  40         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  41         SR_CONF_REGULATION | SR_CONF_GET,
  42         SR_CONF_VOLTAGE | SR_CONF_GET,
  43         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  44         SR_CONF_CURRENT | SR_CONF_GET,
  45         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  46         SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET,
  47         SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE | SR_CONF_GET,
  48         SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD | SR_CONF_GET | SR_CONF_SET,
  49         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET,
  50         SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE | SR_CONF_GET,
  51         SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD | SR_CONF_GET | SR_CONF_SET,
  52         SR_CONF_OVER_TEMPERATURE_PROTECTION | SR_CONF_GET,
  53         SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE | SR_CONF_GET,
  54 };
  55
  56 /* The IDs in this list are only guessed and needs to be verified
  57    against some real hardware. If at least a few of them matches,
  58    it will probably be safe to enable the others. */
  59 static const struct maynuo_m97_model supported_models[] = {
  60 //      {  53, "M9711"     ,   30, 150,    150 },
  61 //      {  54, "M9712"     ,   30, 150,    300 },
  62 //      {  55, "M9712C"    ,   60, 150,    300 },
  63 //      {  56, "M9713"     ,  120, 150,    600 },
  64 //      {  57, "M9712B"    ,   15, 500,    300 },
  65 //      {  58, "M9713B"    ,   30, 500,    600 },
  66 //      {  59, "M9714"     ,  240, 150,   1200 },
  67 //      {  60, "M9714B"    ,   60, 500,   1200 },
  68 //      {  61, "M9715"     ,  240, 150,   1800 },
  69 //      {  62, "M9715B"    ,  120, 500,   1800 },
  70 //      {  63, "M9716"     ,  240, 150,   2400 },
  71 //      {  64, "M9716B"    ,  120, 500,   2400 },
  72 //      {  65, "M9717C"    ,  480, 150,   3600 },
  73 //      {  66, "M9717"     ,  240, 150,   3600 },
  74 //      {  67, "M9717B"    ,  120, 500,   3600 },
  75 //      {  68, "M9718"     ,  240, 150,   6000 },
  76 //      {  69, "M9718B"    ,  120, 500,   6000 },
  77 //      {  70, "M9718D"    ,  240, 500,   6000 },
  78 //      {  71, "M9836"     ,  500, 150,  20000 },
  79 //      {  72, "M9836B"    ,  240, 500,  20000 },
  80 //      {  73, "M9838B"    ,  240, 500,  50000 },
  81 //      {  74, "M9839B"    ,  240, 500, 100000 },
  82 //      {  75, "M9840B"    ,  500, 500, 200000 },
  83 //      {  76, "M9840"     , 1500, 150, 200000 },
  84 //      {  77, "M9712B30"  ,   30, 500,    300 },
  85 //      {  78, "M9718E"    ,  120, 600,   6000 },
  86 //      {  79, "M9718F"    ,  480, 150,   6000 },
  87 //      {  80, "M9716E"    ,  480, 150,   3000 },
  88 //      {  81, "M9710"     ,   30, 150,    150 },
  89 //      {  82, "M9834"     ,  500, 150,  10000 },
  90 //      {  83, "M9835"     ,  500, 150,  15000 },
  91 //      {  84, "M9835B"    ,  240, 500,  15000 },
  92 //      {  85, "M9837"     ,  500, 150,  35000 },
  93 //      {  86, "M9837B"    ,  240, 500,  35000 },
  94 //      {  87, "M9838"     ,  500, 150,  50000 },
  95 //      {  88, "M9839"     ,  500, 150, 100000 },
  96 //      {  89, "M9835C"    , 1000, 150,  15000 }, /* ?? */
  97 //      {  90, "M9836C"    , 1000, 150,  20000 }, /* ?? */
  98 //      {  91, "M9718F-300",  480, 300,   6000 }, /* ?? */
  99 //      {  92, "M9836F"    , 1000, 150,  20000 }, /* ?? */
 100 //      {  93, "M9836E"    ,  240, 600,  20000 }, /* ?? */
 101 //      {  94, "M9717D"    ,  240, 500,   3600 }, /* ?? */
 102 //      {  95, "M9836B-720",  240, 720,  20000 }, /* ?? */
 103 //      {  96, "M9834H"    ,  500, 150,  10000 }, /* ?? */
 104 //      {  97, "M9836H"    ,  500, 150,  20000 }, /* ?? */
 105 //      {  98, "M9718F-500",  480, 500,   6000 }, /* ?? */
 106 //      {  99, "M9834B"    ,  240, 500,  10000 }, /* ?? */
 107 //      { 100, "M9811"     ,   30, 150,    200 },
 108         { 101, "M9812"     ,   30, 150,    300 },
 109 //      { 102, "M9812B"    ,   15, 500,    300 },
 110 };
 111
 112 SR_PRIV struct sr_dev_driver maynuo_m97_driver_info;
 113
 114 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 115 {
 116         return std_init(di, sr_ctx);
 117 }
 118
 119 static struct sr_dev_inst *probe_device(struct sr_modbus_dev_inst *modbus)
 120 {
 121         const struct maynuo_m97_model *model = NULL;
 122         struct dev_context *devc;
 123         struct sr_dev_inst *sdi;
 124         struct sr_channel_group *cg;
 125         struct sr_channel *ch;
 126         uint16_t id, version;
 127         unsigned int i;
 128
 129         int ret = maynuo_m97_get_model_version(modbus, &id, &version);
 130         if (ret != SR_OK)
 131                 return NULL;
 132         for (i = 0; i < ARRAY_SIZE(supported_models); i++)
 133                 if (id == supported_models[i].id) {
 134                         model = &supported_models[i];
 135                         break;
 136                 }
 137         if (model == NULL) {
 138                 sr_err("Unknown model: %d.", id);
 139                 return NULL;
 140         }
 141
 142         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 143         sdi->status = SR_ST_ACTIVE;
 144         sdi->vendor = g_strdup("Maynuo");
 145         sdi->model = g_strdup(model->name);
 146         sdi->version = g_strdup_printf("v%d.%d", version/10, version%10);
 147         sdi->conn = modbus;
 148         sdi->driver = &maynuo_m97_driver_info;
 149         sdi->inst_type = SR_INST_MODBUS;
 150
 151         cg = g_malloc0(sizeof(struct sr_channel_group));
 152         cg->name = g_strdup("1");
 153         sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
 154
 155         ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V1");
 156         cg->channels = g_slist_append(cg->channels, ch);
 157
 158         ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "I1");
 159         cg->channels = g_slist_append(cg->channels, ch);
 160
 161         devc = g_malloc0(sizeof(struct dev_context));
 162         devc->model = model;
 163
 164         sdi->priv = devc;
 165
 166         return sdi;
 167 }
 168
 169 static int config_compare(gconstpointer a, gconstpointer b)
 170 {
 171         const struct sr_config *ac = a, *bc = b;
 172         return ac->key != bc->key;
 173 }
 174
 175 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 176 {
 177         struct sr_config default_serialcomm = {
 178             .key = SR_CONF_SERIALCOMM,
 179             .data = g_variant_new_string("9600/8n1"),
 180         };
 181         struct sr_config default_modbusaddr = {
 182             .key = SR_CONF_MODBUSADDR,
 183             .data = g_variant_new_uint64(1),
 184         };
 185         GSList *opts = options, *devices;
 186
 187         if (!g_slist_find_custom(options, &default_serialcomm, config_compare))
 188                 opts = g_slist_prepend(opts, &default_serialcomm);
 189         if (!g_slist_find_custom(options, &default_modbusaddr, config_compare))
 190                 opts = g_slist_prepend(opts, &default_modbusaddr);
 191
 192         devices = sr_modbus_scan(di->context, opts, probe_device);
 193
 194         while (opts != options)
 195                 opts = g_slist_delete_link(opts, opts);
 196         g_variant_unref(default_serialcomm.data);
 197         g_variant_unref(default_modbusaddr.data);
 198
 199         return devices;
 200 }
 201
 202 static int dev_open(struct sr_dev_inst *sdi)
 203 {
 204         struct sr_modbus_dev_inst *modbus = sdi->conn;
 205
 206         if (sr_modbus_open(modbus) < 0)
 207                 return SR_ERR;
 208
 209         sdi->status = SR_ST_ACTIVE;
 210
 211         maynuo_m97_set_bit(modbus, PC1, 1);
 212
 213         return SR_OK;
 214 }
 215
 216 static int dev_close(struct sr_dev_inst *sdi)
 217 {
 218         struct dev_context *devc;
 219         struct sr_modbus_dev_inst *modbus;
 220
 221         if (sdi->status != SR_ST_ACTIVE)
 222                 return SR_ERR_DEV_CLOSED;
 223
 224         modbus = sdi->conn;
 225
 226         if (modbus) {
 227                 devc = sdi->priv;
 228                 if (devc->expecting_registers) {
 229                         /* Wait for the last data that was requested from the device. */
 230                         uint16_t registers[devc->expecting_registers];
 231                         sr_modbus_read_holding_registers(modbus, -1,
 232                                                          devc->expecting_registers,
 233                                                          registers);
 234                 }
 235
 236                 maynuo_m97_set_bit(modbus, PC1, 0);
 237
 238                 if (sr_modbus_close(modbus) < 0)
 239                         return SR_ERR;
 240                 sdi->status = SR_ST_INACTIVE;
 241         }
 242
 243         return SR_OK;
 244 }
 245
 246 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 247                 const struct sr_channel_group *cg)
 248 {
 249         struct dev_context *devc;
 250         struct sr_modbus_dev_inst *modbus;
 251         enum maynuo_m97_mode mode;
 252         int ret, ivalue;
 253         float fvalue;
 254
 255         (void)cg;
 256
 257         modbus = sdi->conn;
 258         devc = sdi->priv;
 259
 260         ret = SR_OK;
 261         switch (key) {
 262         case SR_CONF_LIMIT_SAMPLES:
 263         case SR_CONF_LIMIT_MSEC:
 264                 ret = sr_sw_limits_config_get(&devc->limits, key, data);
 265                 break;
 266         case SR_CONF_ENABLED:
 267                 if ((ret = maynuo_m97_get_bit(modbus, ISTATE, &ivalue)) == SR_OK)
 268                         *data = g_variant_new_boolean(ivalue);
 269                 break;
 270         case SR_CONF_REGULATION:
 271                 if ((ret = maynuo_m97_get_bit(modbus, UNREG, &ivalue)) != SR_OK)
 272                         break;
 273                 if (ivalue)
 274                         *data = g_variant_new_string("UR");
 275                 else if ((ret = maynuo_m97_get_mode(modbus, &mode)) == SR_OK)
 276                         *data = g_variant_new_string(maynuo_m97_mode_to_str(mode));
 277                 break;
 278         case SR_CONF_VOLTAGE:
 279                 if ((ret = maynuo_m97_get_float(modbus, U, &fvalue)) == SR_OK)
 280                         *data = g_variant_new_double(fvalue);
 281                 break;
 282         case SR_CONF_VOLTAGE_TARGET:
 283                 if ((ret = maynuo_m97_get_float(modbus, UFIX, &fvalue)) == SR_OK)
 284                         *data = g_variant_new_double(fvalue);
 285                 break;
 286         case SR_CONF_CURRENT:
 287                 if ((ret = maynuo_m97_get_float(modbus, I, &fvalue)) == SR_OK)
 288                         *data = g_variant_new_double(fvalue);
 289                 break;
 290         case SR_CONF_CURRENT_LIMIT:
 291                 if ((ret = maynuo_m97_get_float(modbus, IFIX, &fvalue)) == SR_OK)
 292                         *data = g_variant_new_double(fvalue);
 293                 break;
 294         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 295                 *data = g_variant_new_boolean(TRUE);
 296                 break;
 297         case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
 298                 if ((ret = maynuo_m97_get_bit(modbus, UOVER, &ivalue)) == SR_OK)
 299                         *data = g_variant_new_boolean(ivalue);
 300                 break;
 301         case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
 302                 if ((ret = maynuo_m97_get_float(modbus, UMAX, &fvalue)) == SR_OK)
 303                         *data = g_variant_new_double(fvalue);
 304                 break;
 305         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 306                 *data = g_variant_new_boolean(TRUE);
 307                 break;
 308         case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
 309                 if ((ret = maynuo_m97_get_bit(modbus, IOVER, &ivalue)) == SR_OK)
 310                         *data = g_variant_new_boolean(ivalue);
 311                 break;
 312         case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
 313                 if ((ret = maynuo_m97_get_float(modbus, IMAX, &fvalue)) == SR_OK)
 314                         *data = g_variant_new_double(fvalue);
 315                 break;
 316         case SR_CONF_OVER_TEMPERATURE_PROTECTION:
 317                 *data = g_variant_new_boolean(TRUE);
 318                 break;
 319         case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
 320                 if ((ret = maynuo_m97_get_bit(modbus, HEAT, &ivalue)) == SR_OK)
 321                         *data = g_variant_new_boolean(ivalue);
 322                 break;
 323         default:
 324                 return SR_ERR_NA;
 325         }
 326
 327         return ret;
 328 }
 329
 330 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 331                 const struct sr_channel_group *cg)
 332 {
 333         struct dev_context *devc;
 334         struct sr_modbus_dev_inst *modbus;
 335         int ret;
 336
 337         (void)cg;
 338
 339         if (sdi->status != SR_ST_ACTIVE)
 340                 return SR_ERR_DEV_CLOSED;
 341
 342         modbus = sdi->conn;
 343         devc = sdi->priv;
 344
 345         ret = SR_OK;
 346         switch (key) {
 347         case SR_CONF_LIMIT_SAMPLES:
 348         case SR_CONF_LIMIT_MSEC:
 349                 ret = sr_sw_limits_config_set(&devc->limits, key, data);
 350                 break;
 351         case SR_CONF_ENABLED:
 352                 ret = maynuo_m97_set_input(modbus, g_variant_get_boolean(data));
 353                 break;
 354         case SR_CONF_VOLTAGE_TARGET:
 355                 ret = maynuo_m97_set_float(modbus, UFIX, g_variant_get_double(data));
 356                 break;
 357         case SR_CONF_CURRENT_LIMIT:
 358                 ret = maynuo_m97_set_float(modbus, IFIX, g_variant_get_double(data));
 359                 break;
 360         case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
 361                 ret = maynuo_m97_set_float(modbus, UMAX, g_variant_get_double(data));
 362                 break;
 363         case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
 364                 ret = maynuo_m97_set_float(modbus, IMAX, g_variant_get_double(data));
 365                 break;
 366         default:
 367                 ret = SR_ERR_NA;
 368         }
 369
 370         return ret;
 371 }
 372
 373 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 374                 const struct sr_channel_group *cg)
 375 {
 376         struct dev_context *devc;
 377         GVariantBuilder gvb;
 378         int ret;
 379
 380         /* Always available, even without sdi. */
 381         if (key == SR_CONF_SCAN_OPTIONS) {
 382                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 383                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 384                 return SR_OK;
 385         } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 386                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 387                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 388                 return SR_OK;
 389         }
 390
 391         if (!sdi)
 392                 return SR_ERR_ARG;
 393         devc = sdi->priv;
 394
 395         ret = SR_OK;
 396         if (!cg) {
 397                 /* No channel group: global options. */
 398                 switch (key) {
 399                 case SR_CONF_DEVICE_OPTIONS:
 400                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 401                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 402                         break;
 403                 default:
 404                         return SR_ERR_NA;
 405                 }
 406         } else {
 407                 switch (key) {
 408                 case SR_CONF_DEVICE_OPTIONS:
 409                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 410                                         devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
 411                         break;
 412                 case SR_CONF_VOLTAGE_TARGET:
 413                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 414                         /* Min, max, write resolution. */
 415                         g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
 416                         g_variant_builder_add_value(&gvb, g_variant_new_double(devc->model->max_voltage));
 417                         g_variant_builder_add_value(&gvb, g_variant_new_double(0.001));
 418                         *data = g_variant_builder_end(&gvb);
 419                         break;
 420                 case SR_CONF_CURRENT_LIMIT:
 421                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 422                         /* Min, max, step. */
 423                         g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
 424                         g_variant_builder_add_value(&gvb, g_variant_new_double(devc->model->max_current));
 425                         g_variant_builder_add_value(&gvb, g_variant_new_double(0.0001));
 426                         *data = g_variant_builder_end(&gvb);
 427                         break;
 428                 default:
 429                         return SR_ERR_NA;
 430                 }
 431         }
 432
 433         return ret;
 434 }
 435
 436 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 437 {
 438         struct dev_context *devc;
 439         struct sr_modbus_dev_inst *modbus;
 440         int ret;
 441
 442         if (sdi->status != SR_ST_ACTIVE)
 443                 return SR_ERR_DEV_CLOSED;
 444
 445         modbus = sdi->conn;
 446         devc = sdi->priv;
 447
 448         if ((ret = sr_modbus_source_add(sdi->session, modbus, G_IO_IN, 10,
 449                         maynuo_m97_receive_data, (void *)sdi)) != SR_OK)
 450                 return ret;
 451
 452         sr_sw_limits_acquisition_start(&devc->limits);
 453         std_session_send_df_header(sdi, LOG_PREFIX);
 454
 455         return maynuo_m97_capture_start(sdi);
 456 }
 457
 458 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 459 {
 460         struct sr_modbus_dev_inst *modbus;
 461
 462         if (sdi->status != SR_ST_ACTIVE)
 463                 return SR_ERR_DEV_CLOSED;
 464
 465         std_session_send_df_end(sdi, LOG_PREFIX);
 466
 467         modbus = sdi->conn;
 468         sr_modbus_source_remove(sdi->session, modbus);
 469
 470         return SR_OK;
 471 }
 472
 473 SR_PRIV struct sr_dev_driver maynuo_m97_driver_info = {
 474         .name = "maynuo-m97",
 475         .longname = "maynuo M97/M98 series",
 476         .api_version = 1,
 477         .init = init,
 478         .cleanup = std_cleanup,
 479         .scan = scan,
 480         .dev_list = std_dev_list,
 481         .config_get = config_get,
 482         .config_set = config_set,
 483         .config_list = config_list,
 484         .dev_open = dev_open,
 485         .dev_close = dev_close,
 486         .dev_acquisition_start = dev_acquisition_start,
 487         .dev_acquisition_stop = dev_acquisition_stop,
 488         .context = NULL,
 489 };