src/hardware/tondaj-sl-814/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 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 <config.h>
  22 #include <string.h>
  23 #include <glib.h>
  24 #include <libsigrok/libsigrok.h>
  25 #include "libsigrok-internal.h"
  26 #include "protocol.h"
  27
  28 /* States */
  29 enum {
  30         SEND_INIT,
  31         GET_INIT_REPLY,
  32         SEND_PACKET_REQUEST,
  33         GET_PACKET,
  34 };
  35
  36 static void parse_packet(const uint8_t *buf, float *floatval,
  37                          struct sr_datafeed_analog *analog)
  38 {
  39         gboolean is_a, is_fast;
  40         uint16_t intval;
  41         uint8_t level = 0, level_bits;
  42
  43         /* Byte 0 [7:7]: 0 = A, 1 = C */
  44         is_a = ((buf[0] & (1 << 7)) == 0);
  45
  46         /* Byte 0 [6:6]: Unknown/unused? */
  47
  48         /* Byte 0 [5:4]: Level (00 = 40, 01 = 60, 10 = 80, 11 = 100) */
  49         level_bits = (buf[0] >> 4) & 0x03;
  50         if (level_bits == 0)
  51                 level = 40;
  52         else if (level_bits == 1)
  53                 level = 60;
  54         else if (level_bits == 2)
  55                 level = 80;
  56         else if (level_bits == 3)
  57                 level = 100;
  58
  59         /* Byte 0 [3:3]: 0 = fast, 1 = slow */
  60         is_fast = ((buf[0] & (1 << 3)) == 0);
  61
  62         /* Byte 0 [2:0]: value[10..8] */
  63         /* Byte 1 [7:0]: value[7..0] */
  64         intval = (buf[0] & 0x7) << 8;
  65         intval |= buf[1];
  66
  67         *floatval = (float)intval;
  68
  69         /* The value on the display always has one digit after the comma. */
  70         *floatval /= 10;
  71
  72         analog->meaning->mq = SR_MQ_SOUND_PRESSURE_LEVEL;
  73         analog->meaning->unit = SR_UNIT_DECIBEL_SPL;
  74
  75         if (is_a)
  76                 analog->meaning->mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_A;
  77         else
  78                 analog->meaning->mqflags |= SR_MQFLAG_SPL_FREQ_WEIGHT_C;
  79
  80         if (is_fast)
  81                 analog->meaning->mqflags |= SR_MQFLAG_SPL_TIME_WEIGHT_F;
  82         else
  83                 analog->meaning->mqflags |= SR_MQFLAG_SPL_TIME_WEIGHT_S;
  84
  85         /* TODO: How to handle level? */
  86         (void)level;
  87 }
  88
  89 static void decode_packet(struct sr_dev_inst *sdi)
  90 {
  91         struct sr_datafeed_packet packet;
  92         struct sr_datafeed_analog analog;
  93         struct sr_analog_encoding encoding;
  94         struct sr_analog_meaning meaning;
  95         struct sr_analog_spec spec;
  96         struct dev_context *devc;
  97         float floatval;
  98
  99         devc = sdi->priv;
 100
 101         sr_analog_init(&analog, &encoding, &meaning, &spec, 1);
 102
 103         parse_packet(devc->buf, &floatval, &analog);
 104
 105         /* Send a sample packet with one analog value. */
 106         analog.meaning->channels = sdi->channels;
 107         analog.num_samples = 1;
 108         analog.data = &floatval;
 109         packet.type = SR_DF_ANALOG;
 110         packet.payload = &analog;
 111         sr_session_send(sdi, &packet);
 112
 113         sr_sw_limits_update_samples_read(&devc->limits, 1);
 114 }
 115
 116 SR_PRIV int tondaj_sl_814_receive_data(int fd, int revents, void *cb_data)
 117 {
 118         struct sr_dev_inst *sdi;
 119         struct dev_context *devc;
 120         struct sr_serial_dev_inst *serial;
 121         uint8_t buf[3];
 122         int ret;
 123
 124         (void)fd;
 125         (void)revents;
 126
 127         sdi = cb_data;
 128         serial = sdi->conn;
 129         devc = sdi->priv;
 130
 131         /* TODO: Parts of this code need to be improved later. */
 132
 133         /* State machine. */
 134         if (devc->state == SEND_INIT) {
 135                 /* On the first run, send the "init" command. */
 136                 buf[0] = 0x10;
 137                 buf[1] = 0x04;
 138                 buf[2] = 0x0d;
 139                 sr_spew("Sending init command: %02x %02x %02x.",
 140                         buf[0], buf[1], buf[2]);
 141                 if ((ret = serial_write_blocking(serial, buf, 3,
 142                                 serial_timeout(serial, 3))) < 0) {
 143                         sr_err("Error sending init command: %d.", ret);
 144                         return FALSE;
 145                 }
 146                 devc->state = GET_INIT_REPLY;
 147         } else if (devc->state == GET_INIT_REPLY) {
 148                 /* If we just sent the "init" command, get its reply. */
 149                 if ((ret = serial_read_blocking(serial, buf, 2, 0)) < 0) {
 150                         sr_err("Error reading init reply: %d.", ret);
 151                         return FALSE;
 152                 }
 153                 sr_spew("Received init reply: %02x %02x.", buf[0], buf[1]);
 154                 /* Expected reply: 0x05 0x0d */
 155                 if (buf[0] != 0x05 || buf[1] != 0x0d) {
 156                         sr_err("Received incorrect init reply, retrying.");
 157                         devc->state = SEND_INIT;
 158                         return TRUE;
 159                 }
 160                 devc->state = SEND_PACKET_REQUEST;
 161         } else if (devc->state == SEND_PACKET_REQUEST) {
 162                 /* Request a packet (send 0x30 ZZ 0x0d). */
 163                 buf[0] = 0x30;
 164                 buf[1] = 0x00; /* ZZ */
 165                 buf[2] = 0x0d;
 166                 sr_spew("Sending data request command: %02x %02x %02x.",
 167                         buf[0], buf[1], buf[2]);
 168                 if ((ret = serial_write_blocking(serial, buf, 3,
 169                                 serial_timeout(serial, 3))) < 0) {
 170                         sr_err("Error sending request command: %d.", ret);
 171                         return FALSE;
 172                 }
 173                 devc->buflen = 0;
 174                 devc->state = GET_PACKET;
 175         } else if (devc->state == GET_PACKET) {
 176                 /* Read a packet from the device. */
 177                 ret = serial_read_nonblocking(serial, devc->buf + devc->buflen,
 178                                   4 - devc->buflen);
 179                 if (ret < 0) {
 180                         sr_err("Error reading packet: %d.", ret);
 181                         return TRUE;
 182                 }
 183
 184                 devc->buflen += ret;
 185
 186                 /* Didn't receive all 4 bytes, yet. */
 187                 if (devc->buflen != 4)
 188                         return TRUE;
 189
 190                 sr_spew("Received packet: %02x %02x %02x %02x.", devc->buf[0],
 191                         devc->buf[1], devc->buf[2], devc->buf[3]);
 192
 193                 /* Expected reply: AA BB ZZ+1 0x0d */
 194                 if (devc->buf[2] != 0x01 || devc->buf[3] != 0x0d) {
 195                         sr_err("Received incorrect request reply, retrying.");
 196                         devc->state = SEND_PACKET_REQUEST;
 197                         return TRUE;
 198                 }
 199
 200                 decode_packet(sdi);
 201
 202                 devc->state = SEND_PACKET_REQUEST;
 203         } else {
 204                 sr_err("Invalid state: %d.", devc->state);
 205                 return FALSE;
 206         }
 207
 208         if (sr_sw_limits_check(&devc->limits))
 209                 sdi->driver->dev_acquisition_stop(sdi);
 210
 211         return TRUE;
 212 }