src/hardware/serial-dmm/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
   5  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
   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 <stdlib.h>
  23 #include <math.h>
  24 #include <string.h>
  25 #include <glib.h>
  26 #include <libsigrok/libsigrok.h>
  27 #include "libsigrok-internal.h"
  28 #include "protocol.h"
  29
  30 static void log_dmm_packet(const uint8_t *buf)
  31 {
  32         sr_dbg("DMM packet: %02x %02x %02x %02x %02x %02x %02x "
  33                "%02x %02x %02x %02x %02x %02x %02x %02x %02x "
  34                "%02x %02x %02x %02x %02x %02x %02x",
  35                buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
  36                buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13],
  37                buf[14], buf[15], buf[16], buf[17], buf[18], buf[19], buf[20],
  38                buf[21], buf[22]);
  39 }
  40
  41 static void handle_packet(const uint8_t *buf, struct sr_dev_inst *sdi,
  42                           void *info)
  43 {
  44         struct dmm_info *dmm;
  45         float floatval;
  46         struct sr_datafeed_packet packet;
  47         struct sr_datafeed_analog analog;
  48         struct sr_analog_encoding encoding;
  49         struct sr_analog_meaning meaning;
  50         struct sr_analog_spec spec;
  51         struct dev_context *devc;
  52
  53         dmm = (struct dmm_info *)sdi->driver;
  54
  55         log_dmm_packet(buf);
  56         devc = sdi->priv;
  57
  58         /* Note: digits/spec_digits will be overridden by the DMM parsers. */
  59         sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
  60
  61         analog.meaning->channels = sdi->channels;
  62         analog.num_samples = 1;
  63         analog.meaning->mq = 0;
  64
  65         dmm->packet_parse(buf, &floatval, &analog, info);
  66         analog.data = &floatval;
  67
  68         /* If this DMM needs additional handling, call the resp. function. */
  69         if (dmm->dmm_details)
  70                 dmm->dmm_details(&analog, info);
  71
  72         if (analog.meaning->mq != 0) {
  73                 /* Got a measurement. */
  74                 packet.type = SR_DF_ANALOG;
  75                 packet.payload = &analog;
  76                 sr_session_send(sdi, &packet);
  77                 sr_sw_limits_update_samples_read(&devc->limits, 1);
  78         }
  79 }
  80
  81 /** Request packet, if required. */
  82 SR_PRIV int req_packet(struct sr_dev_inst *sdi)
  83 {
  84         struct dmm_info *dmm;
  85         struct dev_context *devc;
  86         struct sr_serial_dev_inst *serial;
  87         int ret;
  88
  89         dmm = (struct dmm_info *)sdi->driver;
  90
  91         if (!dmm->packet_request)
  92                 return SR_OK;
  93
  94         devc = sdi->priv;
  95         serial = sdi->conn;
  96
  97         if (devc->req_next_at && (devc->req_next_at > g_get_monotonic_time())) {
  98                 sr_spew("Not requesting new packet yet, %" PRIi64 " ms left.",
  99                         ((devc->req_next_at - g_get_monotonic_time()) / 1000));
 100                 return SR_OK;
 101         }
 102
 103         ret = dmm->packet_request(serial);
 104         if (ret < 0) {
 105                 sr_err("Failed to request packet: %d.", ret);
 106                 return ret;
 107         }
 108
 109         if (dmm->req_timeout_ms)
 110                 devc->req_next_at = g_get_monotonic_time() + (dmm->req_timeout_ms * 1000);
 111
 112         return SR_OK;
 113 }
 114
 115 static void handle_new_data(struct sr_dev_inst *sdi, void *info)
 116 {
 117         struct dmm_info *dmm;
 118         struct dev_context *devc;
 119         int len, i, offset = 0;
 120         struct sr_serial_dev_inst *serial;
 121
 122         dmm = (struct dmm_info *)sdi->driver;
 123
 124         devc = sdi->priv;
 125         serial = sdi->conn;
 126
 127         /* Try to get as much data as the buffer can hold. */
 128         len = DMM_BUFSIZE - devc->buflen;
 129         len = serial_read_nonblocking(serial, devc->buf + devc->buflen, len);
 130         if (len == 0)
 131                 return; /* No new bytes, nothing to do. */
 132         if (len < 0) {
 133                 sr_err("Serial port read error: %d.", len);
 134                 return;
 135         }
 136         devc->buflen += len;
 137
 138         /* Now look for packets in that data. */
 139         while ((devc->buflen - offset) >= dmm->packet_size) {
 140                 if (dmm->packet_valid(devc->buf + offset)) {
 141                         handle_packet(devc->buf + offset, sdi, info);
 142                         offset += dmm->packet_size;
 143
 144                         /* Request next packet, if required. */
 145                         if (!dmm->packet_request)
 146                                 break;
 147                         if (dmm->req_timeout_ms || dmm->req_delay_ms)
 148                                 devc->req_next_at = g_get_monotonic_time() +
 149                                         dmm->req_delay_ms * 1000;
 150                         req_packet(sdi);
 151                 } else {
 152                         offset++;
 153                 }
 154         }
 155
 156         /* If we have any data left, move it to the beginning of our buffer. */
 157         for (i = 0; i < devc->buflen - offset; i++)
 158                 devc->buf[i] = devc->buf[offset + i];
 159         devc->buflen -= offset;
 160 }
 161
 162 int receive_data(int fd, int revents, void *cb_data)
 163 {
 164         struct sr_dev_inst *sdi;
 165         struct dev_context *devc;
 166         struct dmm_info *dmm;
 167         void *info;
 168
 169         (void)fd;
 170
 171         if (!(sdi = cb_data))
 172                 return TRUE;
 173
 174         if (!(devc = sdi->priv))
 175                 return TRUE;
 176
 177         dmm = (struct dmm_info *)sdi->driver;
 178
 179         if (revents == G_IO_IN) {
 180                 /* Serial data arrived. */
 181                 info = g_malloc(dmm->info_size);
 182                 handle_new_data(sdi, info);
 183                 g_free(info);
 184         } else {
 185                 /* Timeout; send another packet request if DMM needs it. */
 186                 if (dmm->packet_request && (req_packet(sdi) < 0))
 187                         return FALSE;
 188         }
 189
 190         if (sr_sw_limits_check(&devc->limits))
 191                 sdi->driver->dev_acquisition_stop(sdi);
 192
 193         return TRUE;
 194 }