hardware/mic-985xx/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
   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 2 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include "protocol.h"
  22
  23 static int mic_send(struct sr_serial_dev_inst *serial, const char *cmd)
  24 {
  25         int ret;
  26
  27         if ((ret = serial_write(serial, cmd, strlen(cmd))) < 0) {
  28                 sr_err("Error sending '%s' command: %d.", cmd, ret);
  29                 return SR_ERR;
  30         }
  31
  32         return SR_OK;
  33 }
  34
  35 SR_PRIV int mic_cmd_get_device_info(struct sr_serial_dev_inst *serial)
  36 {
  37         return mic_send(serial, "I\r");
  38 }
  39
  40 static int mic_cmd_set_realtime_mode(struct sr_serial_dev_inst *serial)
  41 {
  42         return mic_send(serial, "S 1 M 2 32 3\r");
  43 }
  44
  45 SR_PRIV gboolean packet_valid_temp(const uint8_t *buf)
  46 {
  47         if (buf[0] != 'v' || buf[1] != ' ' || buf[5] != '\r')
  48                 return FALSE;
  49
  50         if (!isdigit(buf[2]) || !isdigit(buf[3]) || !isdigit(buf[4]))
  51                 return FALSE;
  52
  53         return TRUE;
  54 }
  55
  56 SR_PRIV gboolean packet_valid_temp_hum(const uint8_t *buf)
  57 {
  58         if (buf[0] != 'v' || buf[1] != ' ' || buf[5] != ' ' || buf[9] != '\r')
  59                 return FALSE;
  60
  61         if (!isdigit(buf[2]) || !isdigit(buf[3]) || !isdigit(buf[4]))
  62                 return FALSE;
  63
  64         if (!isdigit(buf[6]) || !isdigit(buf[7]) || !isdigit(buf[8]))
  65                 return FALSE;
  66
  67         return TRUE;
  68 }
  69
  70 static int packet_parse(const char *buf, int idx, float *temp, float *humidity)
  71 {
  72         char tmp[4];
  73
  74         /* Packet format MIC98581: "v ttt\r". */
  75         /* Packet format MIC98583: "v ttt hhh\r". */
  76
  77         /* TODO: Sanity check on buf. For now we assume well-formed ASCII. */
  78
  79         tmp[3] = '\0';
  80
  81         strncpy((char *)&tmp, &buf[2], 3);
  82         *temp = g_ascii_strtoull((const char *)&tmp, NULL, 10) / 10;
  83
  84         if (mic_devs[idx].has_humidity) {
  85                 strncpy((char *)&tmp, &buf[6], 3);
  86                 *humidity = g_ascii_strtoull((const char *)&tmp, NULL, 10) / 10;
  87         }
  88
  89         return SR_OK;
  90 }
  91
  92 static int handle_packet(const uint8_t *buf, struct sr_dev_inst *sdi, int idx)
  93 {
  94         float temperature, humidity;
  95         struct sr_datafeed_packet packet;
  96         struct sr_datafeed_analog analog;
  97         struct dev_context *devc;
  98         GSList *l;
  99         int ret;
 100
 101         (void)idx;
 102
 103         devc = sdi->priv;
 104
 105         ret = packet_parse((const char *)buf, idx, &temperature, &humidity);
 106         if (ret < 0) {
 107                 sr_err("Failed to parse packet.");
 108                 return SR_ERR;
 109         }
 110
 111         /* Common values for both probes. */
 112         packet.type = SR_DF_ANALOG;
 113         packet.payload = &analog;
 114         analog.num_samples = 1;
 115
 116         /* Temperature. */
 117         l = g_slist_copy(sdi->probes);
 118         l = g_slist_remove_link(l, g_slist_nth(l, 1));
 119         analog.probes = l;
 120         analog.mq = SR_MQ_TEMPERATURE;
 121         analog.unit = SR_UNIT_CELSIUS; /* TODO: Use C/F correctly. */
 122         analog.data = &temperature;
 123         sr_session_send(devc->cb_data, &packet);
 124         g_slist_free(l);
 125
 126         /* Humidity. */
 127         if (mic_devs[idx].has_humidity) {
 128                 l = g_slist_copy(sdi->probes);
 129                 l = g_slist_remove_link(l, g_slist_nth(l, 0));
 130                 analog.probes = l;
 131                 analog.mq = SR_MQ_RELATIVE_HUMIDITY;
 132                 analog.unit = SR_UNIT_PERCENTAGE;
 133                 analog.data = &humidity;
 134                 sr_session_send(devc->cb_data, &packet);
 135                 g_slist_free(l);
 136         }
 137
 138         devc->num_samples++;
 139
 140         return SR_OK;
 141 }
 142
 143 static void handle_new_data(struct sr_dev_inst *sdi, int idx)
 144 {
 145         struct dev_context *devc;
 146         int len, i, offset = 0;
 147
 148         devc = sdi->priv;
 149
 150         /* Try to get as much data as the buffer can hold. */
 151         len = SERIAL_BUFSIZE - devc->buflen;
 152         len = serial_read(devc->serial, devc->buf + devc->buflen, len);
 153         if (len < 1) {
 154                 sr_err("Serial port read error: %d.", len);
 155                 return;
 156         }
 157
 158         devc->buflen += len;
 159
 160         /* Now look for packets in that data. */
 161         while ((devc->buflen - offset) >= mic_devs[idx].packet_size) {
 162                 if (mic_devs[idx].packet_valid(devc->buf + offset)) {
 163                         handle_packet(devc->buf + offset, sdi, idx);
 164                         offset += mic_devs[idx].packet_size;
 165                 } else {
 166                         offset++;
 167                 }
 168         }
 169
 170         /* If we have any data left, move it to the beginning of our buffer. */
 171         for (i = 0; i < devc->buflen - offset; i++)
 172                 devc->buf[i] = devc->buf[offset + i];
 173         devc->buflen -= offset;
 174 }
 175
 176 static int receive_data(int fd, int revents, int idx, void *cb_data)
 177 {
 178         struct sr_dev_inst *sdi;
 179         struct dev_context *devc;
 180         int64_t t;
 181         static gboolean first_time = TRUE;
 182
 183         (void)fd;
 184
 185         if (!(sdi = cb_data))
 186                 return TRUE;
 187
 188         if (!(devc = sdi->priv))
 189                 return TRUE;
 190
 191         if (revents == G_IO_IN) {
 192                 /* New data arrived. */
 193                 handle_new_data(sdi, idx);
 194         } else {
 195                 /* Timeout. */
 196                 if (first_time) {
 197                         mic_cmd_set_realtime_mode(devc->serial);
 198                         first_time = FALSE;
 199                 }
 200         }
 201
 202         if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
 203                 sr_info("Requested number of samples reached.");
 204                 sdi->driver->dev_acquisition_stop(sdi, cb_data);
 205                 return TRUE;
 206         }
 207
 208         if (devc->limit_msec) {
 209                 t = (g_get_monotonic_time() - devc->starttime) / 1000;
 210                 if (t > (int64_t)devc->limit_msec) {
 211                         sr_info("Requested time limit reached.");
 212                         sdi->driver->dev_acquisition_stop(sdi, cb_data);
 213                         return TRUE;
 214                 }
 215         }
 216
 217         return TRUE;
 218 }
 219
 220 #define RECEIVE_DATA(ID_UPPER) \
 221 SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
 222         return receive_data(fd, revents, ID_UPPER, cb_data); }
 223
 224 /* Driver-specific receive_data() wrappers */
 225 RECEIVE_DATA(MIC_98581)
 226 RECEIVE_DATA(MIC_98583)