src/hardware/arachnid-labs-re-load-pro/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015-2016 Uwe Hermann <uwe@hermann-uwe.de>
   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 2 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <config.h>
  22 #include <string.h>
  23 #include "protocol.h"
  24
  25 #define SERIALCOMM "115200/8n1"
  26
  27 #define CMD_VERSION "version\r\n"
  28 #define CMD_MONITOR "monitor 200\r\n"
  29
  30 static const uint32_t scanopts[] = {
  31         SR_CONF_CONN,
  32         SR_CONF_SERIALCOMM,
  33 };
  34
  35 static const uint32_t drvopts[] = {
  36         SR_CONF_ELECTRONIC_LOAD,
  37 };
  38
  39 static const uint32_t devopts[] = {
  40         SR_CONF_CONTINUOUS,
  41         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  42         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  43 };
  44
  45 static const uint32_t devopts_cg[] = {
  46         SR_CONF_ENABLED | SR_CONF_SET,
  47         SR_CONF_REGULATION | SR_CONF_GET,
  48         SR_CONF_VOLTAGE | SR_CONF_GET,
  49         SR_CONF_CURRENT | SR_CONF_GET,
  50         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  51         SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET,
  52         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET,
  53         SR_CONF_OVER_TEMPERATURE_PROTECTION | SR_CONF_GET,
  54         SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE | SR_CONF_GET,
  55         SR_CONF_UNDER_VOLTAGE_CONDITION | SR_CONF_GET,
  56         SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE | SR_CONF_GET,
  57 };
  58
  59 SR_PRIV struct sr_dev_driver arachnid_labs_re_load_pro_driver_info;
  60
  61 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  62 {
  63         struct sr_dev_inst *sdi;
  64         struct drv_context *drvc;
  65         struct dev_context *devc;
  66         struct sr_config *src;
  67         struct sr_serial_dev_inst *serial;
  68         struct sr_channel_group *cg;
  69         struct sr_channel *ch;
  70         GSList *l, *devices;
  71         int ret, len;
  72         const char *conn, *serialcomm;
  73         char buf[100];
  74         char *bufptr;
  75         double version;
  76
  77         devices = NULL;
  78         drvc = di->context;
  79         drvc->instances = NULL;
  80
  81         conn = serialcomm = NULL;
  82         for (l = options; l; l = l->next) {
  83                 src = l->data;
  84                 switch (src->key) {
  85                 case SR_CONF_CONN:
  86                         conn = g_variant_get_string(src->data, NULL);
  87                         break;
  88                 case SR_CONF_SERIALCOMM:
  89                         serialcomm = g_variant_get_string(src->data, NULL);
  90                         break;
  91                 }
  92         }
  93         if (!conn)
  94                 return NULL;
  95         if (!serialcomm)
  96                 serialcomm = SERIALCOMM;
  97
  98         serial = sr_serial_dev_inst_new(conn, serialcomm);
  99
 100         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 101                 return NULL;
 102
 103         serial_flush(serial);
 104
 105         if (serial_write_blocking(serial, CMD_VERSION,
 106                         strlen(CMD_VERSION), serial_timeout(serial,
 107                         strlen(CMD_VERSION))) < (int)strlen(CMD_VERSION)) {
 108                 sr_dbg("Unable to write while probing for hardware.");
 109                 serial_close(serial);
 110                 return NULL;
 111         }
 112
 113         memset(buf, 0, sizeof(buf));
 114         bufptr = buf;
 115         len = sizeof(buf);
 116         ret = serial_readline(serial, &bufptr, &len, 3000);
 117
 118         if (ret < 0 || len < 9 || strncmp((const char *)&buf, "version ", 8)) {
 119                 sr_dbg("Unable to probe version number.");
 120                 serial_close(serial);
 121                 return NULL;
 122         }
 123
 124         version = g_ascii_strtod(buf + 8, NULL);
 125         if (version < 1.10) {
 126                 sr_info("Firmware >= 1.10 required (got %1.2f).", version);
 127                 serial_close(serial);
 128                 return NULL;
 129         }
 130
 131         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 132         sdi->status = SR_ST_INACTIVE;
 133         sdi->vendor = g_strdup("Arachnid Labs");
 134         sdi->model = g_strdup("Re:load Pro");
 135         sdi->version = g_strdup(buf + 8);
 136         sdi->driver = &arachnid_labs_re_load_pro_driver_info;
 137         sdi->inst_type = SR_INST_SERIAL;
 138         sdi->conn = serial;
 139
 140         cg = g_malloc0(sizeof(struct sr_channel_group));
 141         cg->name = g_strdup("1");
 142         sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
 143
 144         ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
 145         cg->channels = g_slist_append(cg->channels, ch);
 146
 147         ch = sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "I");
 148         cg->channels = g_slist_append(cg->channels, ch);
 149
 150         devc = g_malloc0(sizeof(struct dev_context));
 151         sdi->priv = devc;
 152         drvc->instances = g_slist_append(drvc->instances, sdi);
 153         devices = g_slist_append(devices, sdi);
 154
 155         serial_close(serial);
 156         if (!devices)
 157                 sr_serial_dev_inst_free(serial);
 158
 159         return devices;
 160 }
 161
 162 static int config_list(uint32_t key, GVariant **data,
 163         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 164 {
 165         GVariantBuilder gvb;
 166         int ret;
 167
 168         /* Always available. */
 169         if (key == SR_CONF_SCAN_OPTIONS) {
 170                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 171                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 172                 return SR_OK;
 173         }
 174
 175         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 176                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 177                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 178                 return SR_OK;
 179         }
 180
 181         if (!sdi)
 182                 return SR_ERR_ARG;
 183
 184         ret = SR_OK;
 185
 186         if (!cg) {
 187                 /* No channel group: global options. */
 188                 switch (key) {
 189                 case SR_CONF_DEVICE_OPTIONS:
 190                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 191                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 192                         break;
 193                 default:
 194                         return SR_ERR_NA;
 195                 }
 196         } else {
 197                 switch (key) {
 198                 case SR_CONF_DEVICE_OPTIONS:
 199                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 200                                 devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
 201                         break;
 202                 case SR_CONF_CURRENT_LIMIT:
 203                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 204                         /* Min, max, step. */
 205                         g_variant_builder_add_value(&gvb, g_variant_new_double(0.0));
 206                         g_variant_builder_add_value(&gvb, g_variant_new_double(6.0));
 207                         g_variant_builder_add_value(&gvb, g_variant_new_double(0.001)); /* 1mA steps */
 208                         *data = g_variant_builder_end(&gvb);
 209                         break;
 210                 default:
 211                         return SR_ERR_NA;
 212                 }
 213         }
 214
 215         return ret;
 216 }
 217
 218 static int config_get(uint32_t key, GVariant **data,
 219         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 220 {
 221         struct dev_context *devc;
 222         int ret;
 223         float fvalue;
 224
 225         (void)cg;
 226
 227         devc = sdi->priv;
 228
 229         /*
 230          * These features/keys are not supported by the hardware:
 231          *  - SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE
 232          *  - SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD
 233          *  - SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE
 234          *  - SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD
 235          *  - SR_CONF_ENABLED (state cannot be queried, only set)
 236          */
 237
 238         ret = SR_OK;
 239         switch (key) {
 240         case SR_CONF_LIMIT_SAMPLES:
 241                 *data = g_variant_new_uint64(devc->limit_samples);
 242                 break;
 243         case SR_CONF_LIMIT_MSEC:
 244                 *data = g_variant_new_uint64(devc->limit_msec);
 245                 break;
 246         case SR_CONF_REGULATION:
 247                 *data = g_variant_new_string("CC"); /* Always CC mode. */
 248                 break;
 249         case SR_CONF_VOLTAGE:
 250                 if (reloadpro_get_voltage_current(sdi, &fvalue, NULL) < 0)
 251                         return SR_ERR;
 252                 *data = g_variant_new_double(fvalue);
 253                 break;
 254         case SR_CONF_CURRENT:
 255                 if (reloadpro_get_voltage_current(sdi, NULL, &fvalue) < 0)
 256                         return SR_ERR;
 257                 *data = g_variant_new_double(fvalue);
 258                 break;
 259         case SR_CONF_CURRENT_LIMIT:
 260                 if (reloadpro_get_current_limit(sdi, &fvalue) == SR_OK)
 261                         *data = g_variant_new_double(fvalue);
 262                 break;
 263         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 264                 *data = g_variant_new_boolean(TRUE); /* Always on. */
 265                 break;
 266         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 267                 *data = g_variant_new_boolean(TRUE); /* Always on. */
 268                 break;
 269         case SR_CONF_OVER_TEMPERATURE_PROTECTION:
 270                 *data = g_variant_new_boolean(TRUE); /* Always on. */
 271                 break;
 272         case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
 273                 *data = g_variant_new_boolean(devc->otp_active);
 274                 break;
 275         case SR_CONF_UNDER_VOLTAGE_CONDITION:
 276                 *data = g_variant_new_boolean(TRUE); /* Always on. */
 277                 break;
 278         case SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE:
 279                 *data = g_variant_new_boolean(devc->uvc_active);
 280                 break;
 281         default:
 282                 return SR_ERR_NA;
 283         }
 284
 285         return ret;
 286 }
 287
 288 static int config_set(uint32_t key, GVariant *data,
 289         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 290 {
 291         struct dev_context *devc;
 292         int ret;
 293
 294         (void)cg;
 295
 296         if (sdi->status != SR_ST_ACTIVE)
 297                 return SR_ERR_DEV_CLOSED;
 298
 299         devc = sdi->priv;
 300
 301         ret = SR_OK;
 302         switch (key) {
 303         case SR_CONF_LIMIT_SAMPLES:
 304                 devc->limit_samples = g_variant_get_uint64(data);
 305                 break;
 306         case SR_CONF_LIMIT_MSEC:
 307                 devc->limit_msec = g_variant_get_uint64(data);
 308                 break;
 309         case SR_CONF_ENABLED:
 310                 ret = reloadpro_set_on_off(sdi, g_variant_get_boolean(data));
 311                 break;
 312         case SR_CONF_CURRENT_LIMIT:
 313                 ret = reloadpro_set_current_limit(sdi,
 314                         g_variant_get_double(data));
 315                 break;
 316         default:
 317                 ret = SR_ERR_NA;
 318         }
 319
 320         return ret;
 321 }
 322
 323 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 324 {
 325         int ret;
 326         struct dev_context *devc;
 327         struct sr_serial_dev_inst *serial;
 328
 329         if (sdi->status != SR_ST_ACTIVE)
 330                 return SR_ERR_DEV_CLOSED;
 331
 332         devc = sdi->priv;
 333         serial = sdi->conn;
 334
 335         /* Send the 'monitor <ms>' command (doesn't have a reply). */
 336         if ((ret = serial_write_blocking(serial, CMD_MONITOR,
 337                         strlen(CMD_MONITOR), serial_timeout(serial,
 338                         strlen(CMD_MONITOR)))) < (int)strlen(CMD_MONITOR)) {
 339                 sr_err("Unable to send 'monitor' command: %d.", ret);
 340                 return SR_ERR;
 341         }
 342
 343         /* Poll every 100ms, or whenever some data comes in. */
 344         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 345                           reloadpro_receive_data, (void *)sdi);
 346
 347         std_session_send_df_header(sdi, LOG_PREFIX);
 348
 349         memset(devc->buf, 0, RELOADPRO_BUFSIZE);
 350         devc->buflen = 0;
 351         devc->num_samples = 0;
 352         devc->starttime = g_get_monotonic_time();
 353
 354         return SR_OK;
 355 }
 356
 357 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 358 {
 359         return std_serial_dev_acquisition_stop(sdi,
 360                 std_serial_dev_close, sdi->conn, LOG_PREFIX);
 361 }
 362
 363 SR_PRIV struct sr_dev_driver arachnid_labs_re_load_pro_driver_info = {
 364         .name = "arachnid-labs-re-load-pro",
 365         .longname = "Arachnid Labs Re:load Pro",
 366         .api_version = 1,
 367         .init = std_init,
 368         .cleanup = std_cleanup,
 369         .scan = scan,
 370         .dev_list = std_dev_list,
 371         .config_get = config_get,
 372         .config_set = config_set,
 373         .config_list = config_list,
 374         .dev_open = std_serial_dev_open,
 375         .dev_close = std_serial_dev_close,
 376         .dev_acquisition_start = dev_acquisition_start,
 377         .dev_acquisition_stop = dev_acquisition_stop,
 378         .context = NULL,
 379 };