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