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