src/hardware/rdtech-um/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2018-2020 Andreas Sandberg <andreas@sandberg.pp.se>
   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 3 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
  22 #include <glib.h>
  23 #include <libsigrok/libsigrok.h>
  24 #include <math.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27
  28 #include "libsigrok-internal.h"
  29 #include "protocol.h"
  30
  31 #define SERIAL_WRITE_TIMEOUT_MS 1
  32
  33 #define UM_POLL_LEN 130
  34 #define UM_POLL_PERIOD_MS 100
  35 #define UM_TIMEOUT_MS 1000
  36
  37 #define UM_CMD_POLL 0xf0
  38
  39 static const struct binary_analog_channel rdtech_default_channels[] = {
  40         { "V", { 2, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
  41         { "I", { 4, BVT_BE_UINT16, 0.001, }, 3, SR_MQ_CURRENT, SR_UNIT_AMPERE },
  42         { "D+", { 96, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
  43         { "D-", { 98, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
  44         { "T", { 10, BVT_BE_UINT16, 1.0, }, 0, SR_MQ_TEMPERATURE, SR_UNIT_CELSIUS },
  45         /* Threshold-based recording (mWh) */
  46         { "E", { 106, BVT_BE_UINT32, 0.001, }, 3, SR_MQ_ENERGY, SR_UNIT_WATT_HOUR },
  47         ALL_ZERO,
  48 };
  49
  50 static const struct binary_analog_channel rdtech_um25c_channels[] = {
  51         { "V", { 2, BVT_BE_UINT16, 0.001, }, 3, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
  52         { "I", { 4, BVT_BE_UINT16, 0.0001, }, 4, SR_MQ_CURRENT, SR_UNIT_AMPERE },
  53         { "D+", { 96, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
  54         { "D-", { 98, BVT_BE_UINT16, 0.01, }, 2, SR_MQ_VOLTAGE, SR_UNIT_VOLT },
  55         { "T", { 10, BVT_BE_UINT16, 1.0, }, 0, SR_MQ_TEMPERATURE, SR_UNIT_CELSIUS },
  56         /* Threshold-based recording (mWh) */
  57         { "E", { 106, BVT_BE_UINT32, 0.001, }, 3, SR_MQ_ENERGY, SR_UNIT_WATT_HOUR },
  58         ALL_ZERO,
  59 };
  60
  61 static gboolean csum_ok_fff1(const uint8_t *buf, size_t len)
  62 {
  63         uint16_t csum_recv;
  64
  65         if (len != UM_POLL_LEN)
  66                 return FALSE;
  67
  68         csum_recv = read_u16be(&buf[len - sizeof(uint16_t)]);
  69         if (csum_recv != 0xfff1)
  70                 return FALSE;
  71
  72         return TRUE;
  73 }
  74
  75 static gboolean csum_ok_um34c(const uint8_t *buf, size_t len)
  76 {
  77         static const int positions[] = {
  78                 1, 3, 7, 9, 15, 17, 19, 23, 31, 39, 41, 45, 49, 53,
  79                 55, 57, 59, 63, 67, 69, 73, 79, 83, 89, 97, 99, 109,
  80                 111, 113, 119, 121, 127,
  81         };
  82
  83         size_t i;
  84         uint8_t csum_calc, csum_recv;
  85
  86         if (len != UM_POLL_LEN)
  87                 return FALSE;
  88
  89         csum_calc = 0;
  90         for (i = 0; i < ARRAY_SIZE(positions); i++)
  91                 csum_calc ^= buf[positions[i]];
  92         csum_recv = read_u8(&buf[len - sizeof(uint8_t)]);
  93         if (csum_recv != csum_calc)
  94                 return FALSE;
  95
  96         return TRUE;
  97 }
  98
  99 static const struct rdtech_um_profile um_profiles[] = {
 100         { "UM24C", RDTECH_UM24C, rdtech_default_channels, csum_ok_fff1, },
 101         { "UM25C", RDTECH_UM25C, rdtech_um25c_channels, csum_ok_fff1, },
 102         { "UM34C", RDTECH_UM34C, rdtech_default_channels, csum_ok_um34c, },
 103 };
 104
 105 static const struct rdtech_um_profile *find_profile(uint16_t id)
 106 {
 107         unsigned int i;
 108
 109         for (i = 0; i < ARRAY_SIZE(um_profiles); i++) {
 110                 if (um_profiles[i].model_id == id)
 111                         return &um_profiles[i];
 112         }
 113         return NULL;
 114 }
 115
 116 SR_PRIV const struct rdtech_um_profile *rdtech_um_probe(struct sr_serial_dev_inst *serial)
 117 {
 118         const struct rdtech_um_profile *p;
 119         uint8_t request;
 120         uint8_t buf[RDTECH_UM_BUFSIZE];
 121         int len;
 122
 123         request = UM_CMD_POLL;
 124         if (serial_write_blocking(serial, &request, sizeof(request),
 125                         SERIAL_WRITE_TIMEOUT_MS) < 0) {
 126                 sr_err("Unable to send probe request.");
 127                 return NULL;
 128         }
 129
 130         len = serial_read_blocking(serial, buf, UM_POLL_LEN, UM_TIMEOUT_MS);
 131         if (len != UM_POLL_LEN) {
 132                 sr_err("Failed to read probe response.");
 133                 return NULL;
 134         }
 135
 136         p = find_profile(RB16(&buf[0]));
 137         if (!p) {
 138                 sr_err("Unrecognized UM device (0x%.4" PRIx16 ")!", RB16(&buf[0]));
 139                 return NULL;
 140         }
 141
 142         if (!p->csum_ok(buf, len)) {
 143                 sr_err("Probe response contains illegal checksum or end marker.\n");
 144                 return NULL;
 145         }
 146
 147         return p;
 148 }
 149
 150 SR_PRIV int rdtech_um_poll(const struct sr_dev_inst *sdi, gboolean force)
 151 {
 152         struct dev_context *devc;
 153         int64_t now, elapsed;
 154         struct sr_serial_dev_inst *serial;
 155         uint8_t request;
 156
 157         /* Check for expired intervals or forced requests. */
 158         devc = sdi->priv;
 159         now = g_get_monotonic_time() / 1000;
 160         elapsed = now - devc->cmd_sent_at;
 161         if (!force && elapsed < UM_POLL_PERIOD_MS)
 162                 return SR_OK;
 163
 164         /* Send another poll request. Update interval only on success. */
 165         serial = sdi->conn;
 166         request = UM_CMD_POLL;
 167         if (serial_write_blocking(serial, &request, sizeof(request),
 168                         SERIAL_WRITE_TIMEOUT_MS) < 0) {
 169                 sr_err("Unable to send poll request.");
 170                 return SR_ERR;
 171         }
 172         devc->cmd_sent_at = now;
 173
 174         return SR_OK;
 175 }
 176
 177 static void handle_poll_data(const struct sr_dev_inst *sdi)
 178 {
 179         struct dev_context *devc;
 180         int i;
 181         GSList *ch;
 182
 183         devc = sdi->priv;
 184         sr_spew("Received poll packet (len: %zu).", devc->buflen);
 185         if (devc->buflen != UM_POLL_LEN) {
 186                 sr_err("Unexpected poll packet length: %zu", devc->buflen);
 187                 return;
 188         }
 189
 190         for (ch = sdi->channels, i = 0; ch; ch = g_slist_next(ch), i++) {
 191                 bv_send_analog_channel(sdi, ch->data,
 192                         &devc->profile->channels[i],
 193                         devc->buf, devc->buflen);
 194         }
 195
 196         sr_sw_limits_update_samples_read(&devc->limits, 1);
 197 }
 198
 199 static void recv_poll_data(struct sr_dev_inst *sdi, struct sr_serial_dev_inst *serial)
 200 {
 201         struct dev_context *devc;
 202         const struct rdtech_um_profile *p;
 203         int len;
 204
 205         /* Serial data arrived. */
 206         devc = sdi->priv;
 207         p = devc->profile;
 208         while (devc->buflen < UM_POLL_LEN) {
 209                 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
 210                 if (len < 1)
 211                         return;
 212
 213                 devc->buflen++;
 214
 215                 /* Check if the poll model ID matches the profile. */
 216                 if (devc->buflen == 2 && RB16(devc->buf) != p->model_id) {
 217                         sr_warn("Illegal model ID in poll response (0x%.4" PRIx16 "),"
 218                                 " skipping 1 byte.",
 219                                 RB16(devc->buf));
 220                         devc->buflen--;
 221                         memmove(devc->buf, devc->buf + 1, devc->buflen);
 222                 }
 223         }
 224
 225         if (devc->buflen == UM_POLL_LEN && p->csum_ok(devc->buf, devc->buflen))
 226                 handle_poll_data(sdi);
 227         else
 228                 sr_warn("Skipping packet with illegal checksum / end marker.");
 229
 230         devc->buflen = 0;
 231 }
 232
 233 SR_PRIV int rdtech_um_receive_data(int fd, int revents, void *cb_data)
 234 {
 235         struct sr_dev_inst *sdi;
 236         struct dev_context *devc;
 237         struct sr_serial_dev_inst *serial;
 238
 239         (void)fd;
 240
 241         if (!(sdi = cb_data))
 242                 return TRUE;
 243
 244         if (!(devc = sdi->priv))
 245                 return TRUE;
 246
 247         serial = sdi->conn;
 248         if (revents == G_IO_IN)
 249                 recv_poll_data(sdi, serial);
 250
 251         if (sr_sw_limits_check(&devc->limits)) {
 252                 sr_dev_acquisition_stop(sdi);
 253                 return TRUE;
 254         }
 255
 256         (void)rdtech_um_poll(sdi, FALSE);
 257
 258         return TRUE;
 259 }