src/hardware/serial-lcr/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 Janne Huttunen <jahuttun@gmail.com>
   5  * Copyright (C) 2019 Gerhard Sittig <gerhard.sittig@gmx.net>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <config.h>
  22 #include <glib.h>
  23 #include <libsigrok/libsigrok.h>
  24 #include "libsigrok-internal.h"
  25 #include <math.h>
  26 #include "protocol.h"
  27 #include <stdint.h>
  28 #include <string.h>
  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_LCRMETER,
  37 };
  38
  39 static const uint32_t devopts[] = {
  40         SR_CONF_CONTINUOUS,
  41         SR_CONF_LIMIT_FRAMES | SR_CONF_SET,
  42         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  43         SR_CONF_OUTPUT_FREQUENCY | SR_CONF_GET | SR_CONF_LIST,
  44         SR_CONF_EQUIV_CIRCUIT_MODEL | SR_CONF_GET | SR_CONF_LIST,
  45 };
  46
  47 static struct sr_dev_inst *scan_packet_check_devinst;
  48
  49 static void scan_packet_check_setup(struct sr_dev_inst *sdi)
  50 {
  51         scan_packet_check_devinst = sdi;
  52 }
  53
  54 static gboolean scan_packet_check_func(const uint8_t *buf)
  55 {
  56         struct sr_dev_inst *sdi;
  57         struct dev_context *devc;
  58         const struct lcr_info *lcr;
  59         struct lcr_parse_info *info;
  60
  61         /* Get a reference to the LCR model that is getting checked. */
  62         sdi = scan_packet_check_devinst;
  63         if (!sdi)
  64                 return FALSE;
  65         devc = sdi->priv;
  66         if (!devc)
  67                 return FALSE;
  68         lcr = devc->lcr_info;
  69         if (!lcr)
  70                 return FALSE;
  71
  72         /* Synchronize to the stream of LCR packets. */
  73         if (!lcr->packet_valid(buf))
  74                 return FALSE;
  75
  76         /* Have LCR packets _processed_, gather current configuration. */
  77         info = &devc->parse_info;
  78         memset(info, 0, sizeof(*info));
  79         if (lcr->packet_parse(buf, NULL, NULL, info) == SR_OK) {
  80                 devc->output_freq = info->output_freq;
  81                 if (info->circuit_model)
  82                         devc->circuit_model = info->circuit_model;
  83         }
  84
  85         return TRUE;
  86 }
  87
  88 static int scan_lcr_port(const struct lcr_info *lcr,
  89         const char *conn, struct sr_serial_dev_inst *serial)
  90 {
  91         size_t len;
  92         uint8_t buf[128];
  93         int ret;
  94         size_t dropped;
  95
  96         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  97                 return SR_ERR_IO;
  98         sr_info("Probing serial port %s.", conn);
  99
 100         /*
 101          * See if we can detect a device of specified type.
 102          *
 103          * No supported device provides a means to "identify" yet. No
 104          * supported device requires "packet request" yet. They all just
 105          * send data periodically. So we check if the packets match the
 106          * probed device's expected format.
 107          */
 108         serial_flush(serial);
 109         if (lcr->packet_request) {
 110                 ret = lcr->packet_request(serial);
 111                 if (ret < 0) {
 112                         sr_err("Failed to request packet: %d.", ret);
 113                         goto scan_port_cleanup;
 114                 }
 115         }
 116         len = sizeof(buf);
 117         ret = serial_stream_detect(serial, buf, &len,
 118                 lcr->packet_size, lcr->packet_valid, 3000);
 119         if (ret != SR_OK)
 120                 goto scan_port_cleanup;
 121
 122         /*
 123          * If the packets were found to match after more than two packets
 124          * got dropped, something is wrong. This is worth warning about,
 125          * but isn't fatal. The dropped bytes might be due to nonstandard
 126          * cables that ship with some devices.
 127          */
 128         dropped = len - lcr->packet_size;
 129         if (dropped > 2 * lcr->packet_size)
 130                 sr_warn("Had to drop unexpected amounts of data.");
 131
 132         /* Create a device instance for the found device. */
 133         sr_info("Found %s %s device on port %s.", lcr->vendor, lcr->model, conn);
 134
 135 scan_port_cleanup:
 136         /* Keep serial port open if probe succeeded. */
 137         if (ret != SR_OK)
 138                 serial_close(serial);
 139
 140         return ret;
 141 }
 142
 143 static struct sr_dev_inst *create_lcr_sdi(struct lcr_info *lcr,
 144         struct sr_serial_dev_inst *serial)
 145 {
 146         struct sr_dev_inst *sdi;
 147         struct dev_context *devc;
 148         size_t ch_idx;
 149         const char **ch_fmts;
 150         const char *fmt;
 151         char ch_name[8];
 152
 153         sdi = g_malloc0(sizeof(*sdi));
 154         sdi->status = SR_ST_INACTIVE;
 155         sdi->vendor = g_strdup(lcr->vendor);
 156         sdi->model = g_strdup(lcr->model);
 157         sdi->inst_type = SR_INST_SERIAL;
 158         sdi->conn = serial;
 159         devc = g_malloc0(sizeof(*devc));
 160         sdi->priv = devc;
 161         devc->lcr_info = lcr;
 162         sr_sw_limits_init(&devc->limits);
 163         ch_fmts = lcr->channel_formats;
 164         for (ch_idx = 0; ch_idx < lcr->channel_count; ch_idx++) {
 165                 fmt = (ch_fmts && ch_fmts[ch_idx]) ? ch_fmts[ch_idx] : "P%zu";
 166                 snprintf(ch_name, sizeof(ch_name), fmt, ch_idx + 1);
 167                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, ch_name);
 168         }
 169
 170         return sdi;
 171 }
 172
 173 static int read_lcr_port(struct sr_dev_inst *sdi,
 174         const struct lcr_info *lcr, struct sr_serial_dev_inst *serial)
 175 {
 176         size_t len;
 177         uint8_t buf[128];
 178         int ret;
 179
 180         serial_flush(serial);
 181         if (lcr->packet_request) {
 182                 ret = lcr->packet_request(serial);
 183                 if (ret < 0) {
 184                         sr_err("Failed to request packet: %d.", ret);
 185                         return ret;
 186                 }
 187         }
 188
 189         /*
 190          * Receive a few more packets (and process them!) to have the
 191          * current output frequency and circuit model parameter values
 192          * detected. The above "stream detect" phase only synchronized
 193          * to the packets by checking their validity, but it cannot
 194          * provide details. This phase here runs a modified "checker"
 195          * routine which also extracts details from LCR packets after
 196          * the device got detected and parameter storage was prepared.
 197          */
 198         sr_info("Retrieving current acquisition parameters.");
 199         len = sizeof(buf);
 200         scan_packet_check_setup(sdi);
 201         ret = serial_stream_detect(serial, buf, &len,
 202                 lcr->packet_size, scan_packet_check_func, 1500);
 203         scan_packet_check_setup(NULL);
 204
 205         return ret;
 206 }
 207
 208 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 209 {
 210         struct lcr_info *lcr;
 211         struct sr_config *src;
 212         GSList *l, *devices;
 213         const char *conn, *serialcomm;
 214         struct sr_serial_dev_inst *serial;
 215         int ret;
 216         struct sr_dev_inst *sdi;
 217
 218         lcr = (struct lcr_info *)di;
 219
 220         /* Get serial port name and communication parameters. */
 221         conn = NULL;
 222         serialcomm = lcr->comm;
 223         for (l = options; l; l = l->next) {
 224                 src = l->data;
 225                 switch (src->key) {
 226                 case SR_CONF_CONN:
 227                         conn = g_variant_get_string(src->data, NULL);
 228                         break;
 229                 case SR_CONF_SERIALCOMM:
 230                         serialcomm = g_variant_get_string(src->data, NULL);
 231                         break;
 232                 }
 233         }
 234         if (!conn)
 235                 return NULL;
 236
 237         devices = NULL;
 238         /* TODO Handle ambiguous conn= specs, see serial-dmm. */
 239
 240         /* Open the serial port, check data packets. */
 241         serial = sr_serial_dev_inst_new(conn, serialcomm);
 242         ret = scan_lcr_port(lcr, conn, serial);
 243         if (ret != SR_OK) {
 244                 /* Probe failed, release 'serial'. */
 245                 sr_serial_dev_inst_free(serial);
 246         } else {
 247                 /* Create and return device instance, keep 'serial' alive. */
 248                 sdi = create_lcr_sdi(lcr, serial);
 249                 devices = g_slist_append(devices, sdi);
 250                 (void)read_lcr_port(sdi, lcr, serial);
 251                 serial_close(serial);
 252         }
 253
 254         return std_scan_complete(di, devices);
 255 }
 256
 257 static int config_get(uint32_t key, GVariant **data,
 258         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 259 {
 260         struct dev_context *devc;
 261         const struct lcr_info *lcr;
 262
 263         if (!sdi)
 264                 return SR_ERR_ARG;
 265         devc = sdi->priv;
 266
 267         switch (key) {
 268         case SR_CONF_LIMIT_FRAMES:
 269         case SR_CONF_LIMIT_MSEC:
 270                 return sr_sw_limits_config_get(&devc->limits, key, data);
 271         case SR_CONF_OUTPUT_FREQUENCY:
 272                 *data = g_variant_new_double(devc->output_freq);
 273                 return SR_OK;
 274         case SR_CONF_EQUIV_CIRCUIT_MODEL:
 275                 if (!devc->circuit_model)
 276                         return SR_ERR_NA;
 277                 *data = g_variant_new_string(devc->circuit_model);
 278                 return SR_OK;
 279         default:
 280                 lcr = devc->lcr_info;
 281                 if (!lcr)
 282                         return SR_ERR_NA;
 283                 if (!lcr->config_get)
 284                         return SR_ERR_NA;
 285                 return lcr->config_get(key, data, sdi, cg);
 286         }
 287         /* UNREACH */
 288 }
 289
 290 static int config_set(uint32_t key, GVariant *data,
 291         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 292 {
 293         struct dev_context *devc;
 294         const struct lcr_info *lcr;
 295
 296         if (!sdi)
 297                 return SR_ERR_ARG;
 298         devc = sdi->priv;
 299
 300         switch (key) {
 301         case SR_CONF_LIMIT_FRAMES:
 302         case SR_CONF_LIMIT_MSEC:
 303                 return sr_sw_limits_config_set(&devc->limits, key, data);
 304         default:
 305                 lcr = devc->lcr_info;
 306                 if (!lcr)
 307                         return SR_ERR_NA;
 308                 if (!lcr->config_set)
 309                         return SR_ERR_NA;
 310                 return lcr->config_set(key, data, sdi, cg);
 311         }
 312         /* UNREACH */
 313 }
 314
 315 static int config_list(uint32_t key, GVariant **data,
 316         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 317 {
 318         struct dev_context *devc;
 319         const struct lcr_info *lcr;
 320
 321         switch (key) {
 322         case SR_CONF_SCAN_OPTIONS:
 323         case SR_CONF_DEVICE_OPTIONS:
 324                 return STD_CONFIG_LIST(key, data, sdi, cg,
 325                         scanopts, drvopts, devopts);
 326         default:
 327                 break;
 328         }
 329
 330         if (!sdi)
 331                 return SR_ERR_ARG;
 332         devc = sdi->priv;
 333         switch (key) {
 334         default:
 335                 lcr = devc->lcr_info;
 336                 if (!lcr || !lcr->config_list)
 337                         return SR_ERR_NA;
 338                 return lcr->config_list(key, data, sdi, cg);
 339         }
 340         /* UNREACH */
 341 }
 342
 343 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 344 {
 345         struct dev_context *devc;
 346         struct sr_serial_dev_inst *serial;
 347
 348         devc = sdi->priv;
 349
 350         /*
 351          * Clear values that were gathered during scan or in a previous
 352          * acquisition, so that this acquisition's data feed immediately
 353          * starts with meta packets before first measurement values, and
 354          * also communicates subsequent parameter changes.
 355          */
 356         devc->output_freq = 0;
 357         devc->circuit_model = NULL;
 358
 359         sr_sw_limits_acquisition_start(&devc->limits);
 360         std_session_send_df_header(sdi);
 361
 362         serial = sdi->conn;
 363         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 364                 lcr_receive_data, (void *)sdi);
 365
 366         return SR_OK;
 367 }
 368
 369 #define LCR_ES51919(id, vendor, model) \
 370         &((struct lcr_info) { \
 371                 { \
 372                         .name = id, \
 373                         .longname = vendor " " model, \
 374                         .api_version = 1, \
 375                         .init = std_init, \
 376                         .cleanup = std_cleanup, \
 377                         .scan = scan, \
 378                         .dev_list = std_dev_list, \
 379                         .dev_clear = std_dev_clear, \
 380                         .config_get = config_get, \
 381                         .config_set = config_set, \
 382                         .config_list = config_list, \
 383                         .dev_open = std_serial_dev_open, \
 384                         .dev_close = std_serial_dev_close, \
 385                         .dev_acquisition_start = dev_acquisition_start, \
 386                         .dev_acquisition_stop = std_serial_dev_acquisition_stop, \
 387                         .context = NULL, \
 388                 }, \
 389                 vendor, model, ES51919_CHANNEL_COUNT, NULL, \
 390                 ES51919_COMM_PARAM, ES51919_PACKET_SIZE, \
 391                 0, NULL, \
 392                 es51919_packet_valid, es51919_packet_parse, \
 393                 NULL, NULL, es51919_config_list, \
 394         }).di
 395
 396 SR_REGISTER_DEV_DRIVER_LIST(lcr_es51919_drivers,
 397         LCR_ES51919("deree-de5000", "DER EE", "DE-5000"),
 398         LCR_ES51919("mastech-ms5308", "MASTECH", "MS5308"),
 399         LCR_ES51919("peaktech-2170", "PeakTech", "2170"),
 400         LCR_ES51919("uni-t-ut612", "UNI-T", "UT612"),
 401 );
 402
 403 #define LCR_VC4080(id, vendor, model) \
 404         &((struct lcr_info) { \
 405                 { \
 406                         .name = id, \
 407                         .longname = vendor " " model, \
 408                         .api_version = 1, \
 409                         .init = std_init, \
 410                         .cleanup = std_cleanup, \
 411                         .scan = scan, \
 412                         .dev_list = std_dev_list, \
 413                         .dev_clear = std_dev_clear, \
 414                         .config_get = config_get, \
 415                         .config_set = config_set, \
 416                         .config_list = config_list, \
 417                         .dev_open = std_serial_dev_open, \
 418                         .dev_close = std_serial_dev_close, \
 419                         .dev_acquisition_start = dev_acquisition_start, \
 420                         .dev_acquisition_stop = std_serial_dev_acquisition_stop, \
 421                         .context = NULL, \
 422                 }, \
 423                 vendor, model, \
 424                 VC4080_CHANNEL_COUNT, vc4080_channel_formats, \
 425                 VC4080_COMM_PARAM, VC4080_PACKET_SIZE, \
 426                 500, vc4080_packet_request, \
 427                 vc4080_packet_valid, vc4080_packet_parse, \
 428                 NULL, NULL, vc4080_config_list, \
 429         }).di
 430
 431 SR_REGISTER_DEV_DRIVER_LIST(lcr_vc4080_drivers,
 432         LCR_VC4080("peaktech-2165", "PeakTech", "2165"),
 433         LCR_VC4080("voltcraft-4080", "Voltcraft", "4080"),
 434 );