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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include <string.h>
  22 #include "protocol.h"
  23
  24 #define SERIALCOMM "115200/8n1"
  25
  26 #define CMD_VERSION "version\r\n"
  27 #define CMD_MONITOR "monitor 200\r\n"
  28 #define CMD_MONITOR_STOP "monitor 0\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 | SR_CONF_LIST,
  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         SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  58 };
  59
  60 static const char *regulation[] = {
  61         /* CC mode only. */
  62         "CC",
  63 };
  64
  65 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  66 {
  67         struct sr_dev_inst *sdi;
  68         struct dev_context *devc;
  69         struct sr_config *src;
  70         struct sr_serial_dev_inst *serial;
  71         struct sr_channel_group *cg;
  72         struct sr_channel *ch;
  73         GSList *l;
  74         int ret, len;
  75         const char *conn, *serialcomm;
  76         char buf[100];
  77         char *bufptr;
  78         double version;
  79
  80         conn = serialcomm = NULL;
  81         for (l = options; l; l = l->next) {
  82                 src = l->data;
  83                 switch (src->key) {
  84                 case SR_CONF_CONN:
  85                         conn = g_variant_get_string(src->data, NULL);
  86                         break;
  87                 case SR_CONF_SERIALCOMM:
  88                         serialcomm = g_variant_get_string(src->data, NULL);
  89                         break;
  90                 }
  91         }
  92         if (!conn)
  93                 return NULL;
  94         if (!serialcomm)
  95                 serialcomm = SERIALCOMM;
  96
  97         serial = sr_serial_dev_inst_new(conn, serialcomm);
  98
  99         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 100                 return NULL;
 101
 102         serial_flush(serial);
 103
 104         /*
 105          * First stop potentially running monitoring and wait for 50ms before
 106          * next command can be sent.
 107          */
 108         if (serial_write_blocking(serial, CMD_MONITOR_STOP,
 109                         strlen(CMD_MONITOR_STOP), serial_timeout(serial,
 110                         strlen(CMD_MONITOR_STOP))) < (int)strlen(CMD_MONITOR_STOP)) {
 111                 sr_dbg("Unable to write while probing for hardware.");
 112                 serial_close(serial);
 113                 return NULL;
 114         }
 115         g_usleep(50 * 1000);
 116
 117         if (serial_write_blocking(serial, CMD_VERSION,
 118                         strlen(CMD_VERSION), serial_timeout(serial,
 119                         strlen(CMD_VERSION))) < (int)strlen(CMD_VERSION)) {
 120                 sr_dbg("Unable to write while probing for hardware.");
 121                 serial_close(serial);
 122                 return NULL;
 123         }
 124
 125         memset(buf, 0, sizeof(buf));
 126         bufptr = buf;
 127         len = sizeof(buf);
 128         ret = serial_readline(serial, &bufptr, &len, 3000);
 129
 130         if (ret < 0 || len < 9 || strncmp((const char *)&buf, "version ", 8)) {
 131                 sr_dbg("Unable to probe version number.");
 132                 serial_close(serial);
 133                 return NULL;
 134         }
 135
 136         version = g_ascii_strtod(buf + 8, NULL);
 137         if (version < 1.10) {
 138                 sr_info("Firmware >= 1.10 required (got %1.2f).", version);
 139                 serial_close(serial);
 140                 return NULL;
 141         }
 142
 143         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 144         sdi->status = SR_ST_INACTIVE;
 145         sdi->vendor = g_strdup("Arachnid Labs");
 146         sdi->model = g_strdup("Re:load Pro");
 147         sdi->version = g_strdup(buf + 8);
 148         sdi->inst_type = SR_INST_SERIAL;
 149         sdi->conn = serial;
 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, "V");
 156         cg->channels = g_slist_append(cg->channels, ch);
 157
 158         ch = sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
 159         cg->channels = g_slist_append(cg->channels, ch);
 160
 161         devc = g_malloc0(sizeof(struct dev_context));
 162         sr_sw_limits_init(&devc->limits);
 163         sdi->priv = devc;
 164
 165         serial_close(serial);
 166
 167         return std_scan_complete(di, g_slist_append(NULL, sdi));
 168 }
 169
 170 static int config_list(uint32_t key, GVariant **data,
 171         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 172 {
 173         if (!cg) {
 174                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 175         } else {
 176                 switch (key) {
 177                 case SR_CONF_DEVICE_OPTIONS:
 178                         *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
 179                         break;
 180                 case SR_CONF_REGULATION:
 181                         *data = std_gvar_array_str(ARRAY_AND_SIZE(regulation));
 182                         break;
 183                 case SR_CONF_CURRENT_LIMIT:
 184                         *data = std_gvar_min_max_step(0.0, 6.0, 0.001);
 185                         break;
 186                 case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
 187                         *data = std_gvar_min_max_step(0.0, 60.0, 0.001);
 188                         break;
 189                 default:
 190                         return SR_ERR_NA;
 191                 }
 192         }
 193
 194         return SR_OK;
 195 }
 196
 197 static int config_get(uint32_t key, GVariant **data,
 198         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 199 {
 200         struct dev_context *devc;
 201         float fvalue;
 202
 203         (void)cg;
 204
 205         devc = sdi->priv;
 206
 207         /*
 208          * These features/keys are not supported by the hardware:
 209          *  - SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE
 210          *  - SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD
 211          *  - SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE
 212          *  - SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD
 213          *  - SR_CONF_ENABLED (state cannot be queried, only set)
 214          */
 215
 216         switch (key) {
 217         case SR_CONF_LIMIT_SAMPLES:
 218         case SR_CONF_LIMIT_MSEC:
 219                 return sr_sw_limits_config_get(&devc->limits, key, data);
 220         case SR_CONF_REGULATION:
 221                 *data = g_variant_new_string("CC"); /* Always CC mode. */
 222                 break;
 223         case SR_CONF_VOLTAGE:
 224                 if (reloadpro_get_voltage_current(sdi, &fvalue, NULL) < 0)
 225                         return SR_ERR;
 226                 *data = g_variant_new_double(fvalue);
 227                 break;
 228         case SR_CONF_CURRENT:
 229                 if (reloadpro_get_voltage_current(sdi, NULL, &fvalue) < 0)
 230                         return SR_ERR;
 231                 *data = g_variant_new_double(fvalue);
 232                 break;
 233         case SR_CONF_CURRENT_LIMIT:
 234                 if (reloadpro_get_current_limit(sdi, &fvalue) == SR_OK)
 235                         *data = g_variant_new_double(fvalue);
 236                 break;
 237         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 238                 *data = g_variant_new_boolean(TRUE); /* Always on. */
 239                 break;
 240         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 241                 *data = g_variant_new_boolean(TRUE); /* Always on. */
 242                 break;
 243         case SR_CONF_OVER_TEMPERATURE_PROTECTION:
 244                 *data = g_variant_new_boolean(TRUE); /* Always on. */
 245                 break;
 246         case SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE:
 247                 *data = g_variant_new_boolean(devc->otp_active);
 248                 break;
 249         case SR_CONF_UNDER_VOLTAGE_CONDITION:
 250                 if (reloadpro_get_under_voltage_threshold(sdi, &fvalue) == SR_OK)
 251                         *data = g_variant_new_boolean(fvalue != 0.0);
 252                 break;
 253         case SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE:
 254                 *data = g_variant_new_boolean(devc->uvc_active);
 255                 break;
 256         case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
 257                 if (reloadpro_get_under_voltage_threshold(sdi, &fvalue) == SR_OK)
 258                         *data = g_variant_new_double(fvalue);
 259                 break;
 260         default:
 261                 return SR_ERR_NA;
 262         }
 263
 264         return SR_OK;
 265 }
 266
 267 static int config_set(uint32_t key, GVariant *data,
 268         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 269 {
 270         struct dev_context *devc;
 271
 272         (void)cg;
 273
 274         devc = sdi->priv;
 275
 276         switch (key) {
 277         case SR_CONF_LIMIT_SAMPLES:
 278         case SR_CONF_LIMIT_MSEC:
 279                 return sr_sw_limits_config_set(&devc->limits, key, data);
 280         case SR_CONF_ENABLED:
 281                 return reloadpro_set_on_off(sdi, g_variant_get_boolean(data));
 282         case SR_CONF_CURRENT_LIMIT:
 283                 return reloadpro_set_current_limit(sdi, g_variant_get_double(data));
 284         case SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD:
 285                 return reloadpro_set_under_voltage_threshold(sdi,
 286                         g_variant_get_double(data));
 287         default:
 288                 return SR_ERR_NA;
 289         }
 290
 291         return SR_OK;
 292 }
 293
 294 static int dev_close(struct sr_dev_inst *sdi)
 295 {
 296         if (serial_write_blocking(sdi->conn, CMD_MONITOR_STOP,
 297                         strlen(CMD_MONITOR_STOP), serial_timeout(sdi->conn,
 298                         strlen(CMD_MONITOR_STOP))) < (int)strlen(CMD_MONITOR_STOP)) {
 299                 sr_dbg("Unable to stop monitoring.");
 300         }
 301
 302         return std_serial_dev_close(sdi);
 303 }
 304
 305 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 306 {
 307         int ret;
 308         struct dev_context *devc;
 309         struct sr_serial_dev_inst *serial;
 310
 311         devc = sdi->priv;
 312         devc->acquisition_running = TRUE;
 313
 314         serial = sdi->conn;
 315
 316         /* Send the 'monitor <ms>' command (doesn't have a reply). */
 317         if ((ret = serial_write_blocking(serial, CMD_MONITOR,
 318                         strlen(CMD_MONITOR), serial_timeout(serial,
 319                         strlen(CMD_MONITOR)))) < (int)strlen(CMD_MONITOR)) {
 320                 sr_err("Unable to send 'monitor' command: %d.", ret);
 321                 return SR_ERR;
 322         }
 323
 324         sr_sw_limits_acquisition_start(&devc->limits);
 325         std_session_send_df_header(sdi);
 326
 327         memset(devc->buf, 0, RELOADPRO_BUFSIZE);
 328         devc->buflen = 0;
 329
 330         g_mutex_init(&devc->acquisition_mutex);
 331
 332         serial_source_add(sdi->session, serial, G_IO_IN, 100,
 333                           reloadpro_receive_data, (void *)sdi);
 334
 335         return SR_OK;
 336 }
 337
 338 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 339 {
 340         struct dev_context *devc;
 341         int ret;
 342
 343         devc = sdi->priv;
 344         devc->acquisition_running = FALSE;
 345
 346         ret = std_serial_dev_acquisition_stop(sdi);
 347         g_mutex_clear(&devc->acquisition_mutex);
 348
 349         return ret;
 350
 351 }
 352
 353 static struct sr_dev_driver arachnid_labs_re_load_pro_driver_info = {
 354         .name = "arachnid-labs-re-load-pro",
 355         .longname = "Arachnid Labs Re:load Pro",
 356         .api_version = 1,
 357         .init = std_init,
 358         .cleanup = std_cleanup,
 359         .scan = scan,
 360         .dev_list = std_dev_list,
 361         .dev_clear = std_dev_clear,
 362         .config_get = config_get,
 363         .config_set = config_set,
 364         .config_list = config_list,
 365         .dev_open = std_serial_dev_open,
 366         .dev_close = dev_close,
 367         .dev_acquisition_start = dev_acquisition_start,
 368         .dev_acquisition_stop = dev_acquisition_stop,
 369         .context = NULL,
 370 };
 371 SR_REGISTER_DEV_DRIVER(arachnid_labs_re_load_pro_driver_info);