hardware/brymen-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  *
   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 "libsigrok.h"
  21 #include "libsigrok-internal.h"
  22 #include "protocol.h"
  23
  24 #include <string.h>
  25
  26 /* --- parser.c --- */
  27 SR_PRIV int sr_brymen_parse(const uint8_t *buf, float *floatval,
  28                             struct sr_datafeed_analog *analog, void *info);
  29
  30
  31 static void handle_packet(const uint8_t *buf, struct sr_dev_inst *sdi)
  32 {
  33         float floatval;
  34         struct dev_context *devc;
  35         struct sr_datafeed_packet packet;
  36         struct sr_datafeed_analog analog;
  37
  38         devc = sdi->priv;
  39
  40         analog.num_samples = 1;
  41         analog.mq = -1;
  42
  43         sr_brymen_parse(buf, &floatval, &analog, NULL);
  44         analog.data = &floatval;
  45
  46         analog.probes = sdi->probes;
  47
  48         if (analog.mq != -1) {
  49                 /* Got a measurement. */
  50                 packet.type = SR_DF_ANALOG;
  51                 packet.payload = &analog;
  52                 sr_session_send(devc->cb_data, &packet);
  53                 devc->num_samples++;
  54         }
  55 }
  56
  57 static void handle_new_data(struct sr_dev_inst *sdi)
  58 {
  59         struct dev_context *devc;
  60         int len, status, offset = 0;
  61
  62         devc = sdi->priv;
  63
  64         /* Try to get as much data as the buffer can hold. */
  65         len = DMM_BUFSIZE - devc->buflen;
  66         len = serial_read(devc->serial, devc->buf + devc->buflen, len);
  67         if (len < 1) {
  68                 sr_err("Serial port read error: %d.", len);
  69                 return;
  70         }
  71         devc->buflen += len;
  72         status = PACKET_INVALID_HEADER;
  73
  74         /* Now look for packets in that data. */
  75         while (status != PACKET_NEED_MORE_DATA) {
  76                 /* We don't have a header, look for one */
  77                 if (devc->next_packet_len == 0) {
  78                         len = devc->buflen - offset;
  79                         status = brymen_packet_length(devc->buf + offset, &len);
  80                         if (status == PACKET_HEADER_OK) {
  81                                 /* We know how large the packet will be */
  82                                 devc->next_packet_len = len;
  83                         } else if (status == PACKET_NEED_MORE_DATA) {
  84                                 /* We did not yet receive the complete header */
  85                                 devc->next_packet_len = 0;
  86                                 break;
  87                         } else {
  88                                 /* Invalid header. Move on */
  89                                 devc->next_packet_len = 0;
  90                                 offset++;
  91                                 continue;
  92                         }
  93                 }
  94
  95                 /* We know how the packet size, but did we receive all of it? */
  96                 if (devc->buflen - offset < devc->next_packet_len)
  97                         break;
  98
  99                 /* We should have a full packet here, so we can check it */
 100                 if (brymen_packet_is_valid(devc->buf + offset)) {
 101                         handle_packet(devc->buf + offset, sdi);
 102                         offset += devc->next_packet_len;
 103                 } else {
 104                         offset++;
 105                 }
 106                 /* We are done with this packet. Look for a new one. */
 107                 devc->next_packet_len = 0;
 108         }
 109
 110         /* If we have any data left, move it to the beginning of our buffer. */
 111         memmove(devc->buf, devc->buf + offset, devc->buflen - offset);
 112         devc->buflen -= offset;
 113 }
 114
 115 SR_PRIV int brymen_dmm_receive_data(int fd, int revents, void *cb_data)
 116 {
 117         struct sr_dev_inst *sdi;
 118         struct dev_context *devc;
 119         int ret;
 120         int64_t time;
 121
 122         (void)fd;
 123
 124         if (!(sdi = cb_data))
 125                 return TRUE;
 126
 127         if (!(devc = sdi->priv))
 128                 return TRUE;
 129
 130         if (revents == G_IO_IN) {
 131                 /* Serial data arrived. */
 132                 handle_new_data(sdi);
 133         } else {
 134                 /* Timeout, send another packet request. */
 135                 ret = brymen_packet_request(devc->serial);
 136                 if (ret < 0) {
 137                         sr_err("Failed to request packet: %d.", ret);
 138                         return FALSE;
 139                 }
 140         }
 141
 142         if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
 143                 sr_info("Requested number of samples reached, stopping.");
 144                 sdi->driver->dev_acquisition_stop(sdi, cb_data);
 145                 return TRUE;
 146         }
 147
 148         if (devc->limit_msec) {
 149                 time = (g_get_monotonic_time() - devc->starttime) / 1000;
 150                 if (time > (int64_t)devc->limit_msec) {
 151                         sr_info("Requested time limit reached, stopping.");
 152                         sdi->driver->dev_acquisition_stop(sdi, cb_data);
 153                         return TRUE;
 154                 }
 155         }
 156
 157         return TRUE;
 158 }
 159
 160 /**
 161  * Try to find a valid packet in a serial data stream.
 162  *
 163  * @param serial Previously initialized serial port structure.
 164  * @param buf Buffer containing the bytes to write.
 165  * @param buflen Size of the buffer.
 166  * @param packet_size Callback that assesses the size of the incoming packet/
 167  * @param is_valid Callback that assesses whether the packet is valid or not.
 168  * @param timeout_ms The timeout after which, if no packet is detected, to
 169  *                   abort scanning.
 170  * @param baudrate The baudrate of the serial port. This parameter is not
 171  *                 critical, but it helps fine tune the serial port polling
 172  *                 delay.
 173  *
 174  * @return SR_OK if a valid packet is found within the given timeout,
 175  *         SR_ERR upon failure.
 176  */
 177 SR_PRIV int brymen_stream_detect(struct sr_serial_dev_inst *serial,
 178                                 uint8_t *buf, size_t *buflen,
 179                                 packet_length_t get_packet_size,
 180                                 packet_valid_t is_valid,
 181                                 uint64_t timeout_ms, int baudrate)
 182 {
 183         int64_t start, time, byte_delay_us;
 184         size_t ibuf, i, maxlen;
 185         int status, len, packet_len, stream_len;
 186
 187         maxlen = *buflen;
 188
 189         sr_dbg("Detecting packets on FD %d (timeout = %" PRIu64
 190         "ms, baudrate = %d).", serial->fd, timeout_ms, baudrate);
 191
 192         /* Assume 8n1 transmission. That is 10 bits for every byte. */
 193         byte_delay_us = 10 * (1000000 / baudrate);
 194         start = g_get_monotonic_time();
 195
 196         packet_len = i = ibuf = len = 0;
 197         while (ibuf < maxlen) {
 198                 len = serial_read(serial, &buf[ibuf], maxlen - ibuf);
 199                 if (len > 0) {
 200                         ibuf += len;
 201                         sr_spew("Read %d bytes", len);
 202                 }
 203
 204                 time = g_get_monotonic_time() - start;
 205                 time /= 1000;
 206
 207                 stream_len = ibuf - i;
 208                 if (stream_len > 0 && packet_len == 0) {
 209                         /* How large of a packet are we expecting? */
 210                         packet_len = stream_len;
 211                         status = get_packet_size(&buf[i], &packet_len);
 212                         switch(status) {
 213                         case PACKET_HEADER_OK:
 214                                 /* We know how much data we need to wait for */
 215                                 break;
 216                         case PACKET_NEED_MORE_DATA:
 217                                 /* We did not receive the full header */
 218                                 packet_len = 0;
 219                                 break;
 220                         case PACKET_INVALID_HEADER:
 221                         default:
 222                                 /*
 223                                  * We had enough data, but here was an error in
 224                                  * parsing the header. Restart parsing from the
 225                                  * next byte
 226                                  */
 227                                 packet_len = 0;
 228                                 i++;
 229                                 break;
 230                         }
 231                 }
 232
 233                 if ( (stream_len >= packet_len) && (packet_len != 0) ) {
 234                         /* We have at least a packet's worth of data. */
 235                         if (is_valid(&buf[i])) {
 236                                 sr_spew("Found valid %d-byte packet after "
 237                                 "%" PRIu64 "ms.", packet_len, time);
 238                                 *buflen = ibuf;
 239                                 return SR_OK;
 240                         } else {
 241                                 sr_spew("Got %d bytes, but not a valid "
 242                                 "packet.", packet_len);
 243
 244                         }
 245                         /* Not a valid packet. Continue searching. */
 246                         i++;
 247                         packet_len = 0;
 248                 }
 249                 if (time >= (int64_t)timeout_ms) {
 250                         /* Timeout */
 251                         sr_dbg("Detection timed out after %dms.", time);
 252                         break;
 253                 }
 254                 g_usleep(byte_delay_us);
 255         }
 256
 257         *buflen = ibuf;
 258         sr_err("Didn't find a valid packet (read %d bytes).", ibuf);
 259
 260         return SR_ERR;
 261 }