2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
5 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com> (code from atten-pps3xxx)
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.
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.
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/>.
27 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen);
28 SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char *fmt, va_list args);
29 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char *fmt, ...);
30 SR_PRIV int lps_cmd_reply(char *reply, struct sr_serial_dev_inst *serial, const char *fmt, ...);
31 SR_PRIV int lps_query_status(struct sr_dev_inst *sdi);
33 #define SERIALCOMM "2400/8n1/dtr=1/rts=1/flow=0"
35 static const uint32_t scanopts[] = {
40 static const uint32_t drvopts[] = {
44 static const uint32_t devopts[] = {
46 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
47 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
48 SR_CONF_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
51 /** Hardware capabilities channel 1, 2. */
52 static const uint32_t devopts_cg_ch12[] = {
53 SR_CONF_VOLTAGE | SR_CONF_GET,
54 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
55 SR_CONF_CURRENT | SR_CONF_GET,
56 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
57 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
60 /** Hardware capabilities channel 3 (LPS-304/305 only). */
61 static const uint32_t devopts_cg_ch3[] = {
62 SR_CONF_VOLTAGE | SR_CONF_GET,
63 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
66 static const char *channel_modes[] = {
72 static const struct lps_modelspec models[] = {
73 { LPS_UNKNOWN, "Dummy", 0,
78 { LPS_301, "LPS-301", 1,
81 { { 0, 32, 0.01 }, { 0.005, 2, 0.001 } },
84 { LPS_302, "LPS-302", 1,
87 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
90 { LPS_303, "LPS-303", 1,
93 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
96 { LPS_304, "LPS-304", 3,
99 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
101 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
103 { { 5, 5, 0.0 }, { 0.005, 3, 0.001 } },
106 { LPS_305, "LPS-305", 3,
109 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
111 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
113 { { 3.3, 5, 1.7 }, { 0.005, 3, 0.001 } },
118 /** Send command to device with va_list. */
119 SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char *fmt, va_list args)
122 char auxfmt[LINELEN_MAX];
123 char buf[LINELEN_MAX];
125 snprintf(auxfmt, sizeof(auxfmt), "%s\r\n", fmt);
126 vsnprintf(buf, sizeof(buf), auxfmt, args);
128 sr_spew("lps_send_va: \"%s\"", buf);
130 retc = serial_write_blocking(serial, buf, strlen(buf),
131 serial_timeout(serial, strlen(buf)));
139 /** Send command to device. */
140 SR_PRIV int lps_send_req(struct sr_serial_dev_inst *serial, const char *fmt, ...)
146 retc = lps_send_va(serial, fmt, args);
152 /** Send command and consume simple OK reply. */
153 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char *fmt, ...)
157 char buf[LINELEN_MAX];
163 retc = lps_send_va(serial, fmt, args);
172 buflen = sizeof(buf);
173 retc = lps_read_reply(serial, &bufptr, &buflen);
174 if ((retc == SR_OK) && (buflen == 0))
181 * Send command and read reply string.
182 * @param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated.
184 SR_PRIV int lps_cmd_reply(char *reply, struct sr_serial_dev_inst *serial, const char *fmt, ...)
188 char buf[LINELEN_MAX];
196 retc = lps_send_va(serial, fmt, args);
205 buflen = sizeof(buf);
206 retc = lps_read_reply(serial, &bufptr, &buflen);
207 if ((retc == SR_OK) && (buflen > 0)) {
215 /** Process integer value returned by STATUS command. */
216 SR_PRIV int lps_process_status(struct sr_dev_inst *sdi, int stat)
218 struct dev_context *devc;
223 sr_spew("Status: %d", stat);
224 devc->channel_status[0].cc_mode = (stat & 0x01) != 0;
225 sr_spew("Channel 1 %s mode", devc->channel_status[0].cc_mode?"CC":"CV");
226 if (devc->model->num_channels > 1) {
227 devc->channel_status[1].cc_mode = (stat & 0x02) != 0;
228 sr_spew("Channel 2 %s mode", devc->channel_status[1].cc_mode?"CC":"CV");
230 tracking_mode = (stat & 0x0c) >> 2;
231 switch (tracking_mode) {
232 case 0: devc->tracking_mode = 0;
234 case 2: devc->tracking_mode = 1;
236 case 3: devc->tracking_mode = 2;
239 sr_err("Illegal channel tracking mode %d!", tracking_mode);
240 devc->tracking_mode = 0;
244 sr_spew("Channel tracking: %d", devc->tracking_mode);
246 devc->channel_status[0].output_enabled = devc->channel_status[1].output_enabled = stat&0x040?TRUE:FALSE;
247 sr_spew("Channel 1%s output: %s", devc->model->num_channels > 1?"+2":"", devc->channel_status[0].output_enabled?"ON":"OFF");
248 if (devc->model->num_channels > 2) {
249 devc->channel_status[2].output_enabled = stat&0x010?TRUE:FALSE;
250 devc->channel_status[2].output_voltage_last = stat&0x020?3.3:5;
251 sr_spew("Channel 3 output: %s, U=%02f V, overload=%d",
252 devc->channel_status[2].output_enabled?"ON":"OFF",
253 devc->channel_status[2].output_voltage_last,
256 sr_spew("Fan=%d, beep=%d, CC output compensated=%d", stat&0x0100?1:0, stat&0x0200?1:0, stat&0x0400?1:0);
261 /** Send STATUS commend and process status string. */
262 SR_PRIV int lps_query_status(struct sr_dev_inst *sdi)
264 char buf[LINELEN_MAX];
266 struct dev_context *devc;
270 devc->req_sent_at = g_get_real_time();
272 if ((ret = lps_cmd_reply(buf, sdi->conn, "STATUS")) < 0) {
273 sr_err("%s: Failed to read status: %s.", __func__,
278 if (sr_atoi(buf, &stat) != SR_OK)
281 return lps_process_status(sdi, stat);
284 static gint64 calc_timeout_ms(gint64 start_us)
286 gint64 result = REQ_TIMEOUT_MS - ((g_get_real_time() - start_us) / 1000);
295 * Read message into buf until "OK" received.
297 * @retval SR_OK Msg received; buf and buflen contain result, if any except OK.
298 * @retval SR_ERR Error, including timeout.
300 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen)
303 char buf2[LINELEN_MAX];
306 gint64 timeout_start;
310 /* Read one line. It is either a data message or "OK". */
311 timeout_start = g_get_real_time();
313 /* Up to 5 tries because serial_readline() will consume only one CR or LF per
314 * call, but device sends up to 4 in a row. */
315 for (retries = 0; retries < 5; retries++) {
317 if (serial_readline(serial, buf, buflen, calc_timeout_ms(timeout_start)) != SR_OK)
319 if (!strcmp(*buf, "OK")) { /* We got an OK! */
324 if (*buflen > 0) /* We got a msg! */
328 /* A data msg is in buf (possibly ERROR), need to consume "OK". */
331 for (retries = 0; retries < 5; retries++) {
332 buf2len = sizeof(buf2);
333 if (serial_readline(serial, &buf2ptr, &buf2len, calc_timeout_ms(timeout_start)) != SR_OK)
336 if (!strcmp(buf2ptr, "OK")) { /* We got an OK! */
337 if (!strcmp(*buf, "ERROR")) { /* OK came after msg ERROR! */
338 sr_spew("ERROR found!");
347 return SR_ERR; /* Timeout! */
350 /** Scan for LPS-300 series device. */
351 static GSList *do_scan(lps_modelid modelid, struct sr_dev_driver *drv, GSList *options)
353 struct sr_dev_inst *sdi;
354 struct dev_context *devc;
355 struct sr_serial_dev_inst *serial;
356 struct sr_channel *ch;
357 struct sr_channel_group *cg;
358 const char *conn, *serialcomm;
360 gchar buf[LINELEN_MAX];
367 /* Process and check options. */
369 serialcomm = SERIALCOMM;
370 if (sr_serial_extract_options(options, &conn, &serialcomm) != SR_OK)
373 /* Init serial port. */
374 serial = sr_serial_dev_inst_new(conn, serialcomm);
376 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
379 /* Query and verify model string. */
380 if (lps_cmd_reply(buf, serial, "MODEL") != SR_OK)
383 /* Check model string. */
384 if (strncmp(buf, "LPS-", 4)) {
385 sr_spew("Unknown model code \"%s\"!", buf);
389 /* Bug in device FW 1.17, model number is empty, so this can't work with this FW! */
390 if (modelid == LPS_UNKNOWN) {
392 for (cnt = LPS_301; cnt <= LPS_305; cnt++) {
393 if (!strcmp(buf, models[cnt].modelstr)) {
398 if (modelid == LPS_UNKNOWN) {
399 sr_err("Unable to detect model from model string '%s'!", buf);
406 if ((ret = lps_cmd_reply(buf, serial, "VERSION")) == SR_OK) {
407 if (strncmp(buf, "Ver-", 4)) {
408 sr_spew("Version string %s not recognized.", buf);
415 else /* Bug in device FW 1.17: Querying version string fails while output is active.
416 Therefore just print an error message, but do not exit with error. */
417 sr_err("Failed to query for hardware version: %s.",
420 sdi = g_malloc0(sizeof(struct sr_dev_inst));
421 sdi->status = SR_ST_INACTIVE;
422 sdi->vendor = g_strdup("Motech");
423 sdi->model = g_strdup(models[modelid].modelstr);
424 sdi->version = g_strdup(verstr);
425 sdi->inst_type = SR_INST_SERIAL;
428 devc = g_malloc0(sizeof(struct dev_context));
429 sr_sw_limits_init(&devc->limits);
430 devc->model = &models[modelid];
434 /* Setup channels and channel groups. */
435 for (cnt = 0; cnt < models[modelid].num_channels; cnt++) {
436 snprintf(channel, sizeof(channel), "CH%d", cnt + 1);
437 ch = sr_channel_new(sdi, cnt, SR_CHANNEL_ANALOG, TRUE, channel);
439 devc->channel_status[cnt].info = g_slist_append(NULL, ch);
441 cg = g_malloc(sizeof(struct sr_channel_group));
442 snprintf(channel, sizeof(channel), "CG%d", cnt + 1);
443 cg->name = g_strdup(channel);
445 cg->channels = g_slist_append(NULL, ch);
447 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
451 if (lps_query_status(sdi) != SR_OK)
454 serial_close(serial);
456 return std_scan_complete(drv, g_slist_append(NULL, sdi));
459 sr_info("%s: Error!", __func__);
462 serial_close(serial);
463 sr_serial_dev_inst_free(serial);
465 sr_dev_inst_free(sdi);
470 /** Scan for LPS-301 device. */
471 static GSList *scan_lps301(struct sr_dev_driver *di, GSList *options)
473 return do_scan(LPS_301, di, options);
476 static void clear_helper(struct dev_context *devc)
480 /* Free channel_status.info (list only, data owned by sdi). */
481 for (ch_idx = 0; ch_idx < devc->model->num_channels; ch_idx++)
482 g_slist_free(devc->channel_status[ch_idx].info);
485 static int dev_clear(const struct sr_dev_driver *di)
487 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
490 static int config_get(uint32_t key, GVariant **data,
491 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
493 struct dev_context *devc;
494 struct sr_channel *ch;
504 case SR_CONF_LIMIT_SAMPLES:
505 case SR_CONF_LIMIT_MSEC:
506 return sr_sw_limits_config_get(&devc->limits, key, data);
507 case SR_CONF_CHANNEL_CONFIG:
508 *data = g_variant_new_string(channel_modes[devc->tracking_mode]);
514 /* We only ever have one channel per channel group in this driver. */
515 ch = cg->channels->data;
519 case SR_CONF_VOLTAGE:
520 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_last);
522 case SR_CONF_VOLTAGE_TARGET:
523 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_max);
525 case SR_CONF_CURRENT:
526 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_last);
528 case SR_CONF_CURRENT_LIMIT:
529 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_max);
531 case SR_CONF_ENABLED:
532 *data = g_variant_new_boolean(devc->channel_status[ch_idx].output_enabled);
542 static int config_set(uint32_t key, GVariant *data,
543 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
545 struct dev_context *devc;
546 struct sr_channel *ch;
554 /* Cannot change settings while acquisition active, would cause a mess with commands.
555 * Changing this would be possible, but tricky. */
556 if (devc->acq_running)
561 case SR_CONF_LIMIT_MSEC:
562 case SR_CONF_LIMIT_SAMPLES:
563 return sr_sw_limits_config_set(&devc->limits, key, data);
564 case SR_CONF_CHANNEL_CONFIG:
565 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(channel_modes))) < 0)
567 if (devc->model->modelid <= LPS_303 && idx != 0)
568 break; /* Only first setting possible for smaller models. */
569 if (devc->tracking_mode == idx)
570 break; /* Nothing to do! */
571 devc->tracking_mode = idx;
572 if (devc->model->modelid >= LPS_304) /* No use to set anything in the smaller models. */
573 return lps_cmd_ok(sdi->conn, "TRACK%1d", devc->tracking_mode);
579 /* We only ever have one channel per channel group in this driver. */
580 ch = cg->channels->data;
584 case SR_CONF_VOLTAGE_TARGET:
585 dval = g_variant_get_double(data);
586 if (dval < 0 || dval > devc->model->channels[ch_idx].voltage[1])
589 if (devc->model->modelid < LPS_304)
592 if (fabs(dval - 5.000) <= 0.001)
594 else if ((devc->model->modelid >= LPS_305) && (fabs(dval - 3.300) <= 0.001))
596 else return SR_ERR_ARG;
599 devc->channel_status[ch_idx].output_voltage_max = dval;
601 return lps_cmd_ok(sdi->conn, "VDD%1.0f", trunc(dval));
603 return lps_cmd_ok(sdi->conn, "VSET%d %05.3f", ch_idx+1, dval);
605 case SR_CONF_CURRENT_LIMIT:
606 dval = g_variant_get_double(data);
607 if (dval < 0 || dval > devc->model->channels[ch_idx].current[1])
609 if (ch_idx == 2) /* No current setting for CH3. */
611 devc->channel_status[ch_idx].output_current_max = dval;
612 return lps_cmd_ok(sdi->conn, "ISET%d %05.4f", ch_idx+1, dval);
613 case SR_CONF_ENABLED:
614 bval = g_variant_get_boolean(data);
615 if (bval == devc->channel_status[ch_idx].output_enabled) /* Nothing to do. */
617 devc->channel_status[ch_idx].output_enabled = bval;
618 if (ch_idx != 2) { /* Channels 1,2 can be set only together. */
619 devc->channel_status[ch_idx^1].output_enabled = bval;
620 return lps_cmd_ok(sdi->conn, "OUT%1d", (int)bval);
621 } else { /* Channel 3: No command to disable output, set voltage to 0 instead. */
623 return lps_cmd_ok(sdi->conn, "VDD%1.0f", devc->channel_status[ch_idx].output_voltage_max);
625 return lps_cmd_ok(sdi->conn, "VDD0");
636 static int config_list(uint32_t key, GVariant **data,
637 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
639 struct dev_context *devc;
640 struct sr_channel *ch;
643 devc = (sdi) ? sdi->priv : NULL;
647 case SR_CONF_SCAN_OPTIONS:
648 case SR_CONF_DEVICE_OPTIONS:
649 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
650 case SR_CONF_CHANNEL_CONFIG:
651 if (!devc || !devc->model)
653 if (devc->model->modelid <= LPS_303) {
654 /* The 1-channel models. */
655 *data = g_variant_new_strv(channel_modes, 1);
657 /* The other models support all modes. */
658 *data = g_variant_new_strv(ARRAY_AND_SIZE(channel_modes));
666 /* We only ever have one channel per channel group in this driver. */
667 ch = cg->channels->data;
671 case SR_CONF_DEVICE_OPTIONS:
672 if ((ch_idx == 0) || (ch_idx == 1)) /* CH1, CH2 */
673 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_ch12));
674 else /* Must be CH3 */
675 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_ch3));
677 case SR_CONF_VOLTAGE_TARGET:
678 if (!devc || !devc->model)
680 *data = std_gvar_min_max_step_array(devc->model->channels[ch_idx].voltage);
682 case SR_CONF_CURRENT_LIMIT:
683 if (!devc || !devc->model)
685 *data = std_gvar_min_max_step_array(devc->model->channels[ch_idx].current);
694 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
696 struct dev_context *devc;
697 struct sr_serial_dev_inst *serial;
701 devc->acq_running = TRUE;
704 serial_source_add(sdi->session, serial, G_IO_IN, 50,
705 motech_lps_30x_receive_data, (void *)sdi);
706 std_session_send_df_header(sdi);
708 sr_sw_limits_acquisition_start(&devc->limits);
710 devc->acq_req = AQ_NONE;
711 /* Do not start polling device here, the read function will do it in 50 ms. */
716 static struct sr_dev_driver motech_lps_301_driver_info = {
717 .name = "motech-lps-301",
718 .longname = "Motech LPS-301",
721 .cleanup = std_cleanup,
723 .dev_list = std_dev_list,
724 .dev_clear = dev_clear,
725 .config_get = config_get,
726 .config_set = config_set,
727 .config_list = config_list,
728 .dev_open = std_serial_dev_open,
729 .dev_close = std_serial_dev_close,
730 .dev_acquisition_start = dev_acquisition_start,
731 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
734 SR_REGISTER_DEV_DRIVER(motech_lps_301_driver_info);