src/hardware/korad-kaxxxxp/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
   5  * Copyright (C) 2018 Frank Stettner <frank-stettner@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 "protocol.h"
  23
  24 #define REQ_TIMEOUT_MS 500
  25 #define DEVICE_PROCESSING_TIME_MS 80
  26
  27 SR_PRIV int korad_kaxxxxp_send_cmd(struct sr_serial_dev_inst *serial,
  28                                 const char *cmd)
  29 {
  30         int ret;
  31
  32         sr_dbg("Sending '%s'.", cmd);
  33         if ((ret = serial_write_blocking(serial, cmd, strlen(cmd), 0)) < 0) {
  34                 sr_err("Error sending command: %d.", ret);
  35                 return ret;
  36         }
  37
  38         return ret;
  39 }
  40
  41 SR_PRIV int korad_kaxxxxp_read_chars(struct sr_serial_dev_inst *serial,
  42                                 int count, char *buf)
  43 {
  44         int ret, received, turns;
  45
  46         received = 0;
  47         turns = 0;
  48
  49         do {
  50                 if ((ret = serial_read_blocking(serial, buf + received,
  51                                 count - received,
  52                                 serial_timeout(serial, count))) < 0) {
  53                         sr_err("Error %d reading %d bytes from device.",
  54                                ret, count);
  55                         return ret;
  56                 }
  57                 received += ret;
  58                 turns++;
  59         } while ((received < count) && (turns < 100));
  60
  61         buf[count] = 0;
  62
  63         sr_spew("Received: '%s'.", buf);
  64
  65         return ret;
  66 }
  67
  68 static void give_device_time_to_process(struct dev_context *devc)
  69 {
  70         int64_t sleeping_time;
  71
  72         sleeping_time = devc->req_sent_at + (DEVICE_PROCESSING_TIME_MS * 1000);
  73         sleeping_time -= g_get_monotonic_time();
  74
  75         if (sleeping_time > 0) {
  76                 g_usleep(sleeping_time);
  77                 sr_spew("Sleeping for processing %" PRIi64 " usec", sleeping_time);
  78         }
  79 }
  80
  81 SR_PRIV int korad_kaxxxxp_set_value(struct sr_serial_dev_inst *serial,
  82                                 int target, struct dev_context *devc)
  83 {
  84         char msg[21];
  85         const char *cmd;
  86         float value;
  87         int ret;
  88
  89         g_mutex_lock(&devc->rw_mutex);
  90         give_device_time_to_process(devc);
  91
  92         msg[20] = 0;
  93         switch (target) {
  94         case KAXXXXP_CURRENT:
  95         case KAXXXXP_VOLTAGE:
  96         case KAXXXXP_STATUS:
  97                 sr_err("Can't set measurable parameter %d.", target);
  98                 g_mutex_unlock(&devc->rw_mutex);
  99                 return SR_ERR;
 100         case KAXXXXP_CURRENT_MAX:
 101                 cmd = "ISET1:%05.3f";
 102                 value = devc->current_max;
 103                 break;
 104         case KAXXXXP_VOLTAGE_MAX:
 105                 cmd = "VSET1:%05.2f";
 106                 value = devc->voltage_max;
 107                 break;
 108         case KAXXXXP_OUTPUT:
 109                 cmd = "OUT%01.0f";
 110                 value = (devc->output_enabled) ? 1 : 0;
 111                 break;
 112         case KAXXXXP_BEEP:
 113                 cmd = "BEEP%01.0f";
 114                 value = (devc->beep_enabled) ? 1 : 0;
 115                 break;
 116         case KAXXXXP_OCP:
 117                 cmd = "OCP%01.0f";
 118                 value = (devc->ocp_enabled) ? 1 : 0;
 119                 break;
 120         case KAXXXXP_OVP:
 121                 cmd = "OVP%01.0f";
 122                 value = (devc->ovp_enabled) ? 1 : 0;
 123                 break;
 124         case KAXXXXP_SAVE:
 125                 cmd = "SAV%01.0f";
 126                 if (devc->program < 1 || devc->program > 5) {
 127                         sr_err("Only programs 1-5 supported and %d isn't "
 128                                "between them.", devc->program);
 129                         g_mutex_unlock(&devc->rw_mutex);
 130                         return SR_ERR;
 131                 }
 132                 value = devc->program;
 133                 break;
 134         case KAXXXXP_RECALL:
 135                 cmd = "RCL%01.0f";
 136                 if (devc->program < 1 || devc->program > 5) {
 137                         sr_err("Only programs 1-5 supported and %d isn't "
 138                                "between them.", devc->program);
 139                         g_mutex_unlock(&devc->rw_mutex);
 140                         return SR_ERR;
 141                 }
 142                 value = devc->program;
 143                 break;
 144         default:
 145                 sr_err("Don't know how to set %d.", target);
 146                 g_mutex_unlock(&devc->rw_mutex);
 147                 return SR_ERR;
 148         }
 149
 150         if (cmd)
 151                 snprintf(msg, 20, cmd, value);
 152
 153         ret = korad_kaxxxxp_send_cmd(serial, msg);
 154         devc->req_sent_at = g_get_monotonic_time();
 155
 156         g_mutex_unlock(&devc->rw_mutex);
 157
 158         return ret;
 159 }
 160
 161 SR_PRIV int korad_kaxxxxp_get_value(struct sr_serial_dev_inst *serial,
 162                                 int target, struct dev_context *devc)
 163 {
 164         int ret, count;
 165         char reply[6];
 166         float *value;
 167         char status_byte;
 168
 169         g_mutex_lock(&devc->rw_mutex);
 170         give_device_time_to_process(devc);
 171
 172         value = NULL;
 173         count = 5;
 174
 175         switch (target) {
 176         case KAXXXXP_CURRENT:
 177                 /* Read current from device. */
 178                 ret = korad_kaxxxxp_send_cmd(serial, "IOUT1?");
 179                 value = &(devc->current);
 180                 break;
 181         case KAXXXXP_CURRENT_MAX:
 182                 /* Read set current from device. */
 183                 ret = korad_kaxxxxp_send_cmd(serial, "ISET1?");
 184                 value = &(devc->current_max);
 185                 break;
 186         case KAXXXXP_VOLTAGE:
 187                 /* Read voltage from device. */
 188                 ret = korad_kaxxxxp_send_cmd(serial, "VOUT1?");
 189                 value = &(devc->voltage);
 190                 break;
 191         case KAXXXXP_VOLTAGE_MAX:
 192                 /* Read set voltage from device. */
 193                 ret = korad_kaxxxxp_send_cmd(serial, "VSET1?");
 194                 value = &(devc->voltage_max);
 195                 break;
 196         case KAXXXXP_STATUS:
 197         case KAXXXXP_OUTPUT:
 198         case KAXXXXP_OCP:
 199         case KAXXXXP_OVP:
 200                 /* Read status from device. */
 201                 ret = korad_kaxxxxp_send_cmd(serial, "STATUS?");
 202                 count = 1;
 203                 break;
 204         default:
 205                 sr_err("Don't know how to query %d.", target);
 206                 g_mutex_unlock(&devc->rw_mutex);
 207                 return SR_ERR;
 208         }
 209
 210         devc->req_sent_at = g_get_monotonic_time();
 211
 212         if ((ret = korad_kaxxxxp_read_chars(serial, count, reply)) < 0) {
 213                 g_mutex_unlock(&devc->rw_mutex);
 214                 return ret;
 215         }
 216
 217         reply[count] = 0;
 218
 219         if (value) {
 220                 sr_atof_ascii((const char *)&reply, value);
 221                 sr_dbg("value: %f", *value);
 222         } else {
 223                 /* We have status reply. */
 224                 status_byte = reply[0];
 225                 /* Constant current */
 226                 devc->cc_mode[0] = !(status_byte & (1 << 0)); /* Channel one */
 227                 devc->cc_mode[1] = !(status_byte & (1 << 1)); /* Channel two */
 228                 /*
 229                  * Tracking
 230                  * status_byte & ((1 << 2) | (1 << 3))
 231                  * 00 independent 01 series 11 parallel
 232                  */
 233                 devc->beep_enabled = (1 << 4);
 234                 devc->ocp_enabled = (status_byte & (1 << 5));
 235                 devc->output_enabled = (status_byte & (1 << 6));
 236                 /* Velleman LABPS3005 quirk */
 237                 if (devc->output_enabled)
 238                         devc->ovp_enabled = (status_byte & (1 << 7));
 239                 sr_dbg("Status: 0x%02x", status_byte);
 240                 sr_spew("Status: CH1: constant %s CH2: constant %s. "
 241                         "Tracking would be %s. Device is "
 242                         "%s and %s. Buttons are %s. Output is %s "
 243                         "and extra byte is %s.",
 244                         (status_byte & (1 << 0)) ? "voltage" : "current",
 245                         (status_byte & (1 << 1)) ? "voltage" : "current",
 246                         (status_byte & (1 << 2)) ? "parallel" : "series",
 247                         (status_byte & (1 << 3)) ? "tracking" : "independent",
 248                         (status_byte & (1 << 4)) ? "beeping" : "silent",
 249                         (status_byte & (1 << 5)) ? "locked" : "unlocked",
 250                         (status_byte & (1 << 6)) ? "enabled" : "disabled",
 251                         (status_byte & (1 << 7)) ? "true" : "false");
 252         }
 253
 254         /* Read the sixth byte from ISET? BUG workaround. */
 255         if (target == KAXXXXP_CURRENT_MAX)
 256                 serial_read_blocking(serial, &status_byte, 1, 10);
 257
 258         g_mutex_unlock(&devc->rw_mutex);
 259
 260         return ret;
 261 }
 262
 263 SR_PRIV int korad_kaxxxxp_get_all_values(struct sr_serial_dev_inst *serial,
 264                                 struct dev_context *devc)
 265 {
 266         int ret, target;
 267
 268         for (target = KAXXXXP_CURRENT;
 269                         target <= KAXXXXP_STATUS; target++) {
 270                 if ((ret = korad_kaxxxxp_get_value(serial, target, devc)) < 0)
 271                         return ret;
 272         }
 273
 274         return ret;
 275 }
 276
 277 static void next_measurement(struct dev_context *devc)
 278 {
 279         switch (devc->acquisition_target) {
 280         case KAXXXXP_CURRENT:
 281                 devc->acquisition_target = KAXXXXP_VOLTAGE;
 282                 break;
 283         case KAXXXXP_VOLTAGE:
 284                 devc->acquisition_target = KAXXXXP_STATUS;
 285                 break;
 286         case KAXXXXP_STATUS:
 287                 devc->acquisition_target = KAXXXXP_CURRENT;
 288                 break;
 289         default:
 290                 devc->acquisition_target = KAXXXXP_CURRENT;
 291                 sr_err("Invalid target for next acquisition.");
 292         }
 293 }
 294
 295 SR_PRIV int korad_kaxxxxp_receive_data(int fd, int revents, void *cb_data)
 296 {
 297         struct sr_dev_inst *sdi;
 298         struct dev_context *devc;
 299         struct sr_serial_dev_inst *serial;
 300         struct sr_datafeed_packet packet;
 301         struct sr_datafeed_analog analog;
 302         struct sr_analog_encoding encoding;
 303         struct sr_analog_meaning meaning;
 304         struct sr_analog_spec spec;
 305         GSList *l;
 306
 307         (void)fd;
 308
 309         if (!(sdi = cb_data))
 310                 return TRUE;
 311
 312         if (!(devc = sdi->priv))
 313                 return TRUE;
 314
 315         serial = sdi->conn;
 316
 317         if (revents == G_IO_IN) {
 318                 /* Get the value. */
 319                 korad_kaxxxxp_get_value(serial, devc->acquisition_target, devc);
 320
 321                 /* Note: digits/spec_digits will be overridden later. */
 322                 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
 323
 324                 /* Send the value forward. */
 325                 packet.type = SR_DF_ANALOG;
 326                 packet.payload = &analog;
 327                 analog.num_samples = 1;
 328                 l = g_slist_copy(sdi->channels);
 329                 if (devc->acquisition_target == KAXXXXP_CURRENT) {
 330                         l = g_slist_remove_link(l, g_slist_nth(l, 0));
 331                         analog.meaning->channels = l;
 332                         analog.meaning->mq = SR_MQ_CURRENT;
 333                         analog.meaning->unit = SR_UNIT_AMPERE;
 334                         analog.meaning->mqflags = 0;
 335                         analog.encoding->digits = 3;
 336                         analog.spec->spec_digits = 3;
 337                         analog.data = &devc->current;
 338                         sr_session_send(sdi, &packet);
 339                 }
 340                 else if (devc->acquisition_target == KAXXXXP_VOLTAGE) {
 341                         l = g_slist_remove_link(l, g_slist_nth(l, 1));
 342                         analog.meaning->channels = l;
 343                         analog.meaning->mq = SR_MQ_VOLTAGE;
 344                         analog.meaning->unit = SR_UNIT_VOLT;
 345                         analog.meaning->mqflags = SR_MQFLAG_DC;
 346                         analog.encoding->digits = 2;
 347                         analog.spec->spec_digits = 2;
 348                         analog.data = &devc->voltage;
 349                         sr_session_send(sdi, &packet);
 350                         sr_sw_limits_update_samples_read(&devc->limits, 1);
 351                 }
 352                 next_measurement(devc);
 353         }
 354
 355         if (sr_sw_limits_check(&devc->limits))
 356                 sr_dev_acquisition_stop(sdi);
 357
 358         return TRUE;
 359 }