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 | SR_CONF_SET,
  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(sr_ctx, di, LOG_PREFIX);
 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 GSList *dev_list(const struct sr_dev_driver *di)
 203 {
 204         return ((struct drv_context *)(di->context))->instances;
 205 }
 206
 207 static int dev_clear(const struct sr_dev_driver *di)
 208 {
 209         return std_dev_clear(di, g_free);
 210 }
 211
 212 static int dev_open(struct sr_dev_inst *sdi)
 213 {
 214         struct sr_modbus_dev_inst *modbus = sdi->conn;
 215
 216         if (sr_modbus_open(modbus) < 0)
 217                 return SR_ERR;
 218
 219         sdi->status = SR_ST_ACTIVE;
 220
 221         maynuo_m97_set_bit(modbus, PC1, 1);
 222
 223         return SR_OK;
 224 }
 225
 226 static int dev_close(struct sr_dev_inst *sdi)
 227 {
 228         struct dev_context *devc;
 229         struct sr_modbus_dev_inst *modbus;
 230
 231         if (sdi->status != SR_ST_ACTIVE)
 232                 return SR_ERR_DEV_CLOSED;
 233
 234         modbus = sdi->conn;
 235
 236         if (modbus) {
 237                 devc = sdi->priv;
 238                 if (devc->expecting_registers) {
 239                         /* Wait for the last data that was requested from the device. */
 240                         uint16_t registers[devc->expecting_registers];
 241                         sr_modbus_read_holding_registers(modbus, -1,
 242                                                          devc->expecting_registers,
 243                                                          registers);
 244                 }
 245
 246                 maynuo_m97_set_bit(modbus, PC1, 0);
 247
 248                 if (sr_modbus_close(modbus) < 0)
 249                         return SR_ERR;
 250                 sdi->status = SR_ST_INACTIVE;
 251         }
 252
 253         return SR_OK;
 254 }
 255
 256 static int cleanup(const struct sr_dev_driver *di)
 257 {
 258         return dev_clear(di);
 259 }
 260
 261 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 262                 const struct sr_channel_group *cg)
 263 {
 264         struct dev_context *devc;
 265         struct sr_modbus_dev_inst *modbus;
 266         enum maynuo_m97_mode mode;
 267         int ret, ivalue;
 268         float fvalue;
 269
 270         (void)cg;
 271
 272         modbus = sdi->conn;
 273         devc = sdi->priv;
 274
 275         ret = SR_OK;
 276         switch (key) {
 277         case SR_CONF_LIMIT_SAMPLES:
 278                 *data = g_variant_new_uint64(devc->limit_samples);
 279                 break;
 280         case SR_CONF_LIMIT_MSEC:
 281                 *data = g_variant_new_uint64(devc->limit_msec);
 282                 break;
 283         case SR_CONF_ENABLED:
 284                 if ((ret = maynuo_m97_get_bit(modbus, ISTATE, &ivalue)) == SR_OK)
 285                         *data = g_variant_new_boolean(ivalue);
 286                 break;
 287         case SR_CONF_REGULATION:
 288                 if ((ret = maynuo_m97_get_bit(modbus, UNREG, &ivalue)) != SR_OK)
 289                         break;
 290                 if (ivalue)
 291                         *data = g_variant_new_string("UR");
 292                 else if ((ret = maynuo_m97_get_mode(modbus, &mode)) == SR_OK)
 293                         *data = g_variant_new_string(maynuo_m97_mode_to_str(mode));
 294                 break;
 295         case SR_CONF_VOLTAGE:
 296                 if ((ret = maynuo_m97_get_float(modbus, U, &fvalue)) == SR_OK)
 297                         *data = g_variant_new_double(fvalue);
 298                 break;
 299         case SR_CONF_VOLTAGE_TARGET:
 300                 if ((ret = maynuo_m97_get_float(modbus, UFIX, &fvalue)) == SR_OK)
 301                         *data = g_variant_new_double(fvalue);
 302                 break;
 303         case SR_CONF_CURRENT:
 304                 if ((ret = maynuo_m97_get_float(modbus, I, &fvalue)) == SR_OK)
 305                         *data = g_variant_new_double(fvalue);
 306                 break;
 307         case SR_CONF_CURRENT_LIMIT:
 308                 if ((ret = maynuo_m97_get_float(modbus, IFIX, &fvalue)) == SR_OK)
 309                         *data = g_variant_new_double(fvalue);
 310                 break;
 311         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 312                 *data = g_variant_new_boolean(TRUE);
 313                 break;
 314         case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
 315                 if ((ret = maynuo_m97_get_bit(modbus, UOVER, &ivalue)) == SR_OK)
 316                         *data = g_variant_new_boolean(ivalue);
 317                 break;
 318         case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
 319                 if ((ret = maynuo_m97_get_float(modbus, UMAX, &fvalue)) == SR_OK)
 320                         *data = g_variant_new_double(fvalue);
 321                 break;
 322         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 323                 *data = g_variant_new_boolean(TRUE);
 324                 break;
 325         case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
 326                 if ((ret = maynuo_m97_get_bit(modbus, IOVER, &ivalue)) == SR_OK)
 327                         *data = g_variant_new_boolean(ivalue);
 328                 break;
 329         case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
 330                 if ((ret = maynuo_m97_get_float(modbus, IMAX, &fvalue)) == SR_OK)
 331                         *data = g_variant_new_double(fvalue);
 332                 break;
 333         case SR_CONF_OVER_TEMPERATURE_PROTECTION:
 334                 *data = g_variant_new_boolean(TRUE);
 335                 break;
 336         case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
 337                 if ((ret = maynuo_m97_get_bit(modbus, HEAT, &ivalue)) == SR_OK)
 338                         *data = g_variant_new_boolean(ivalue);
 339                 break;
 340         default:
 341                 return SR_ERR_NA;
 342         }
 343
 344         return ret;
 345 }
 346
 347 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 348                 const struct sr_channel_group *cg)
 349 {
 350         struct dev_context *devc;
 351         struct sr_modbus_dev_inst *modbus;
 352         int ret;
 353
 354         (void)data;
 355         (void)cg;
 356
 357         if (sdi->status != SR_ST_ACTIVE)
 358                 return SR_ERR_DEV_CLOSED;
 359
 360         modbus = sdi->conn;
 361         devc = sdi->priv;
 362
 363         ret = SR_OK;
 364         switch (key) {
 365         case SR_CONF_LIMIT_SAMPLES:
 366                 devc->limit_samples = g_variant_get_uint64(data);
 367                 break;
 368         case SR_CONF_LIMIT_MSEC:
 369                 devc->limit_msec = g_variant_get_uint64(data);
 370                 break;
 371         case SR_CONF_ENABLED:
 372                 ret = maynuo_m97_set_input(modbus, g_variant_get_boolean(data));
 373                 break;
 374         case SR_CONF_VOLTAGE_TARGET:
 375                 ret = maynuo_m97_set_float(modbus, UFIX, g_variant_get_double(data));
 376                 break;
 377         case SR_CONF_CURRENT_LIMIT:
 378                 ret = maynuo_m97_set_float(modbus, IFIX, g_variant_get_double(data));
 379                 break;
 380         case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
 381                 ret = maynuo_m97_set_float(modbus, UMAX, g_variant_get_double(data));
 382                 break;
 383         case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
 384                 ret = maynuo_m97_set_float(modbus, IMAX, g_variant_get_double(data));
 385                 break;
 386         default:
 387                 ret = SR_ERR_NA;
 388         }
 389
 390         return ret;
 391 }
 392
 393 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 394                 const struct sr_channel_group *cg)
 395 {
 396         struct dev_context *devc;
 397         GVariantBuilder gvb;
 398         int ret;
 399
 400         /* Always available, even without sdi. */
 401         if (key == SR_CONF_SCAN_OPTIONS) {
 402                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 403                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 404                 return SR_OK;
 405         } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 406                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 407                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 408                 return SR_OK;
 409         }
 410
 411         if (!sdi)
 412                 return SR_ERR_ARG;
 413         devc = sdi->priv;
 414
 415         ret = SR_OK;
 416         if (!cg) {
 417                 /* No channel group: global options. */
 418                 switch (key) {
 419                 case SR_CONF_DEVICE_OPTIONS:
 420                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 421                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 422                         break;
 423                 default:
 424                         return SR_ERR_NA;
 425                 }
 426         } else {
 427                 switch (key) {
 428                 case SR_CONF_DEVICE_OPTIONS:
 429                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 430                                         devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
 431                         break;
 432                 case SR_CONF_VOLTAGE_TARGET:
 433                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 434                         /* Min, max, write resolution. */
 435                         g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
 436                         g_variant_builder_add_value(&gvb, g_variant_new_double(devc->model->max_voltage));
 437                         g_variant_builder_add_value(&gvb, g_variant_new_double(0.001));
 438                         *data = g_variant_builder_end(&gvb);
 439                         break;
 440                 case SR_CONF_CURRENT_LIMIT:
 441                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 442                         /* Min, max, step. */
 443                         g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
 444                         g_variant_builder_add_value(&gvb, g_variant_new_double(devc->model->max_current));
 445                         g_variant_builder_add_value(&gvb, g_variant_new_double(0.0001));
 446                         *data = g_variant_builder_end(&gvb);
 447                         break;
 448                 default:
 449                         return SR_ERR_NA;
 450                 }
 451         }
 452
 453         return ret;
 454 }
 455
 456 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 457                 void *cb_data)
 458 {
 459         struct dev_context *devc;
 460         struct sr_modbus_dev_inst *modbus;
 461         int ret;
 462
 463         (void)cb_data;
 464
 465         if (sdi->status != SR_ST_ACTIVE)
 466                 return SR_ERR_DEV_CLOSED;
 467
 468         modbus = sdi->conn;
 469         devc = sdi->priv;
 470
 471         if ((ret = sr_modbus_source_add(sdi->session, modbus, G_IO_IN, 10,
 472                         maynuo_m97_receive_data, (void *)sdi)) != SR_OK)
 473                 return ret;
 474
 475         std_session_send_df_header(sdi, LOG_PREFIX);
 476
 477         devc->num_samples = 0;
 478         devc->starttime = g_get_monotonic_time();
 479
 480         return maynuo_m97_capture_start(sdi);
 481 }
 482
 483 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 484 {
 485         struct sr_modbus_dev_inst *modbus;
 486
 487         (void)cb_data;
 488
 489         if (sdi->status != SR_ST_ACTIVE)
 490                 return SR_ERR_DEV_CLOSED;
 491
 492         std_session_send_df_end(sdi, LOG_PREFIX);
 493
 494         modbus = sdi->conn;
 495         sr_modbus_source_remove(sdi->session, modbus);
 496
 497         return SR_OK;
 498 }
 499
 500 SR_PRIV struct sr_dev_driver maynuo_m97_driver_info = {
 501         .name = "maynuo-m97",
 502         .longname = "maynuo M97/M98 series",
 503         .api_version = 1,
 504         .init = init,
 505         .cleanup = cleanup,
 506         .scan = scan,
 507         .dev_list = dev_list,
 508         .dev_clear = dev_clear,
 509         .config_get = config_get,
 510         .config_set = config_set,
 511         .config_list = config_list,
 512         .dev_open = dev_open,
 513         .dev_close = dev_close,
 514         .dev_acquisition_start = dev_acquisition_start,
 515         .dev_acquisition_stop = dev_acquisition_stop,
 516         .context = NULL,
 517 };