src/dmm/fs9721.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
   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 2 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, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  */
  21
  22 /*
  23  * Fortune Semiconductor FS9721_LP3/FS9721B protocol parser.
  24  *
  25  * FS9721_LP3: 4000 counts (3 3/4 digits)
  26  * FS9721B/Q100: 2400 counts (3 2/3 digits)
  27  *
  28  * Same for both chips:
  29  *  - Packages: Bare die (78 pins) or QFP-100
  30  *  - Communication parameters: Unidirectional, 2400/8n1
  31  *  - The protocol seems to be exactly the same.
  32  */
  33
  34 #include <config.h>
  35 #include <string.h>
  36 #include <ctype.h>
  37 #include <math.h>
  38 #include <glib.h>
  39 #include <libsigrok/libsigrok.h>
  40 #include "libsigrok-internal.h"
  41
  42 #define LOG_PREFIX "fs9721"
  43
  44 static int parse_digit(uint8_t b)
  45 {
  46         switch (b) {
  47         case 0x7d:
  48                 return 0;
  49         case 0x05:
  50                 return 1;
  51         case 0x5b:
  52                 return 2;
  53         case 0x1f:
  54                 return 3;
  55         case 0x27:
  56                 return 4;
  57         case 0x3e:
  58                 return 5;
  59         case 0x7e:
  60                 return 6;
  61         case 0x15:
  62                 return 7;
  63         case 0x7f:
  64                 return 8;
  65         case 0x3f:
  66                 return 9;
  67         default:
  68                 sr_dbg("Invalid digit byte: 0x%02x.", b);
  69                 return -1;
  70         }
  71 }
  72
  73 static gboolean sync_nibbles_valid(const uint8_t *buf)
  74 {
  75         int i;
  76
  77         /* Check the synchronization nibbles, and make sure they all match. */
  78         for (i = 0; i < FS9721_PACKET_SIZE; i++) {
  79                 if (((buf[i] >> 4) & 0x0f) != (i + 1)) {
  80                         sr_dbg("Sync nibble in byte %d (0x%02x) is invalid.",
  81                                i, buf[i]);
  82                         return FALSE;
  83                 }
  84         }
  85
  86         return TRUE;
  87 }
  88
  89 static gboolean flags_valid(const struct fs9721_info *info)
  90 {
  91         int count;
  92
  93         /* Does the packet have more than one multiplier? */
  94         count = 0;
  95         count += (info->is_nano) ? 1 : 0;
  96         count += (info->is_micro) ? 1 : 0;
  97         count += (info->is_milli) ? 1 : 0;
  98         count += (info->is_kilo) ? 1 : 0;
  99         count += (info->is_mega) ? 1 : 0;
 100         if (count > 1) {
 101                 sr_dbg("More than one multiplier detected in packet.");
 102                 return FALSE;
 103         }
 104
 105         /* Does the packet "measure" more than one type of value? */
 106         count = 0;
 107         count += (info->is_hz) ? 1 : 0;
 108         count += (info->is_ohm) ? 1 : 0;
 109         count += (info->is_farad) ? 1 : 0;
 110         count += (info->is_ampere) ? 1 : 0;
 111         count += (info->is_volt) ? 1 : 0;
 112         count += (info->is_percent) ? 1 : 0;
 113         if (count > 1) {
 114                 sr_dbg("More than one measurement type detected in packet.");
 115                 return FALSE;
 116         }
 117
 118         /* Both AC and DC set? */
 119         if (info->is_ac && info->is_dc) {
 120                 sr_dbg("Both AC and DC flags detected in packet.");
 121                 return FALSE;
 122         }
 123
 124         /* RS232 flag not set? */
 125         if (!info->is_rs232) {
 126                 sr_dbg("No RS232 flag detected in packet.");
 127                 return FALSE;
 128         }
 129
 130         return TRUE;
 131 }
 132
 133 static int parse_value(const uint8_t *buf, float *result, int *exponent)
 134 {
 135         int i, sign, intval = 0, digits[4];
 136         uint8_t digit_bytes[4];
 137         float floatval;
 138
 139         /* Byte 1: LCD SEG2 */
 140         sign = ((buf[1] & (1 << 3)) != 0) ? -1 : 1;
 141
 142         /*
 143          * Bytes 1-8: Value (4 decimal digits, sign, decimal point)
 144          *
 145          * Over limit: "0L" (LCD), 0x00 0x7d 0x68 0x00 (digit bytes).
 146          */
 147
 148         /* Merge the two nibbles for a digit into one byte. */
 149         for (i = 0; i < 4; i++) {
 150                 digit_bytes[i] = ((buf[1 + (i * 2)] & 0x0f) << 4);
 151                 digit_bytes[i] |= (buf[1 + (i * 2) + 1] & 0x0f);
 152
 153                 /* Bit 7 in the byte is not part of the digit. */
 154                 digit_bytes[i] &= ~(1 << 7);
 155         }
 156
 157         /* Check for "OL". */
 158         if (digit_bytes[0] == 0x00 && digit_bytes[1] == 0x7d &&
 159             digit_bytes[2] == 0x68 && digit_bytes[3] == 0x00) {
 160                 sr_spew("Over limit.");
 161                 *result = INFINITY;
 162                 return SR_OK;
 163         }
 164
 165         /* Parse the digits. */
 166         for (i = 0; i < 4; i++)
 167                 digits[i] = parse_digit(digit_bytes[i]);
 168         sr_spew("Digits: %02x %02x %02x %02x (%d%d%d%d).",
 169                 digit_bytes[0], digit_bytes[1], digit_bytes[2], digit_bytes[3],
 170                 digits[0], digits[1], digits[2], digits[3]);
 171
 172         /* Merge all digits into an integer value. */
 173         for (i = 0; i < 4; i++) {
 174                 intval *= 10;
 175                 intval += digits[i];
 176         }
 177
 178         floatval = (float)intval;
 179
 180         /* Decimal point position. */
 181         if ((buf[3] & (1 << 3)) != 0) {
 182                 *exponent = -3;
 183                 sr_spew("Decimal point after first digit.");
 184         } else if ((buf[5] & (1 << 3)) != 0) {
 185                 *exponent = -2;
 186                 sr_spew("Decimal point after second digit.");
 187         } else if ((buf[7] & (1 << 3)) != 0) {
 188                 *exponent = -1;
 189                 sr_spew("Decimal point after third digit.");
 190         } else {
 191                 *exponent = 0;
 192                 sr_spew("No decimal point in the number.");
 193         }
 194
 195         /* Apply sign. */
 196         floatval *= sign;
 197
 198         sr_spew("The display value is %f.", floatval);
 199
 200         *result = floatval;
 201
 202         return SR_OK;
 203 }
 204
 205 static void parse_flags(const uint8_t *buf, struct fs9721_info *info)
 206 {
 207         /* Byte 0: LCD SEG1 */
 208         info->is_ac         = (buf[0] & (1 << 3)) != 0;
 209         info->is_dc         = (buf[0] & (1 << 2)) != 0;
 210         info->is_auto       = (buf[0] & (1 << 1)) != 0;
 211         info->is_rs232      = (buf[0] & (1 << 0)) != 0;
 212
 213         /* Byte 1: LCD SEG2 */
 214         info->is_sign       = (buf[1] & (1 << 3)) != 0;
 215
 216         /* Byte 9: LCD SEG10 */
 217         info->is_micro      = (buf[9] & (1 << 3)) != 0;
 218         info->is_nano       = (buf[9] & (1 << 2)) != 0;
 219         info->is_kilo       = (buf[9] & (1 << 1)) != 0;
 220         info->is_diode      = (buf[9] & (1 << 0)) != 0;
 221
 222         /* Byte 10: LCD SEG11 */
 223         info->is_milli      = (buf[10] & (1 << 3)) != 0;
 224         info->is_percent    = (buf[10] & (1 << 2)) != 0;
 225         info->is_mega       = (buf[10] & (1 << 1)) != 0;
 226         info->is_beep       = (buf[10] & (1 << 0)) != 0;
 227
 228         /* Byte 11: LCD SEG12 */
 229         info->is_farad      = (buf[11] & (1 << 3)) != 0;
 230         info->is_ohm        = (buf[11] & (1 << 2)) != 0;
 231         info->is_rel        = (buf[11] & (1 << 1)) != 0;
 232         info->is_hold       = (buf[11] & (1 << 0)) != 0;
 233
 234         /* Byte 12: LCD SEG13 */
 235         info->is_ampere     = (buf[12] & (1 << 3)) != 0;
 236         info->is_volt       = (buf[12] & (1 << 2)) != 0;
 237         info->is_hz         = (buf[12] & (1 << 1)) != 0;
 238         info->is_bat        = (buf[12] & (1 << 0)) != 0;
 239
 240         /* Byte 13: LCD SEG14 */
 241         info->is_c2c1_11    = (buf[13] & (1 << 3)) != 0;
 242         info->is_c2c1_10    = (buf[13] & (1 << 2)) != 0;
 243         info->is_c2c1_01    = (buf[13] & (1 << 1)) != 0;
 244         info->is_c2c1_00    = (buf[13] & (1 << 0)) != 0;
 245 }
 246
 247 static void handle_flags(struct sr_datafeed_analog *analog, float *floatval,
 248                          int *exponent, const struct fs9721_info *info)
 249 {
 250         /* Factors */
 251         if (info->is_nano)
 252                 *exponent -= 9;
 253         if (info->is_micro)
 254                 *exponent -= 6;
 255         if (info->is_milli)
 256                 *exponent -= 3;
 257         if (info->is_kilo)
 258                 *exponent += 3;
 259         if (info->is_mega)
 260                 *exponent += 6;
 261         *floatval *= powf(10, *exponent);
 262
 263         /* Measurement modes */
 264         if (info->is_volt) {
 265                 analog->meaning->mq = SR_MQ_VOLTAGE;
 266                 analog->meaning->unit = SR_UNIT_VOLT;
 267         }
 268         if (info->is_ampere) {
 269                 analog->meaning->mq = SR_MQ_CURRENT;
 270                 analog->meaning->unit = SR_UNIT_AMPERE;
 271         }
 272         if (info->is_ohm) {
 273                 analog->meaning->mq = SR_MQ_RESISTANCE;
 274                 analog->meaning->unit = SR_UNIT_OHM;
 275         }
 276         if (info->is_hz) {
 277                 analog->meaning->mq = SR_MQ_FREQUENCY;
 278                 analog->meaning->unit = SR_UNIT_HERTZ;
 279         }
 280         if (info->is_farad) {
 281                 analog->meaning->mq = SR_MQ_CAPACITANCE;
 282                 analog->meaning->unit = SR_UNIT_FARAD;
 283         }
 284         if (info->is_beep) {
 285                 analog->meaning->mq = SR_MQ_CONTINUITY;
 286                 analog->meaning->unit = SR_UNIT_BOOLEAN;
 287                 *floatval = (*floatval == INFINITY) ? 0.0 : 1.0;
 288         }
 289         if (info->is_diode) {
 290                 analog->meaning->mq = SR_MQ_VOLTAGE;
 291                 analog->meaning->unit = SR_UNIT_VOLT;
 292         }
 293         if (info->is_percent) {
 294                 analog->meaning->mq = SR_MQ_DUTY_CYCLE;
 295                 analog->meaning->unit = SR_UNIT_PERCENTAGE;
 296         }
 297
 298         /* Measurement related flags */
 299         if (info->is_ac)
 300                 analog->meaning->mqflags |= SR_MQFLAG_AC;
 301         if (info->is_dc)
 302                 analog->meaning->mqflags |= SR_MQFLAG_DC;
 303         if (info->is_auto)
 304                 analog->meaning->mqflags |= SR_MQFLAG_AUTORANGE;
 305         if (info->is_diode)
 306                 analog->meaning->mqflags |= SR_MQFLAG_DIODE;
 307         if (info->is_hold)
 308                 analog->meaning->mqflags |= SR_MQFLAG_HOLD;
 309         if (info->is_rel)
 310                 analog->meaning->mqflags |= SR_MQFLAG_RELATIVE;
 311
 312         /* Other flags */
 313         if (info->is_rs232)
 314                 sr_spew("RS232 enabled.");
 315         if (info->is_bat)
 316                 sr_spew("Battery is low.");
 317         if (info->is_c2c1_00)
 318                 sr_spew("User-defined LCD symbol 0 is active.");
 319         if (info->is_c2c1_01)
 320                 sr_spew("User-defined LCD symbol 1 is active.");
 321         if (info->is_c2c1_10)
 322                 sr_spew("User-defined LCD symbol 2 is active.");
 323         if (info->is_c2c1_11)
 324                 sr_spew("User-defined LCD symbol 3 is active.");
 325 }
 326
 327 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf)
 328 {
 329         struct fs9721_info info;
 330
 331         parse_flags(buf, &info);
 332
 333         return (sync_nibbles_valid(buf) && flags_valid(&info));
 334 }
 335
 336 /**
 337  * Parse a protocol packet.
 338  *
 339  * @param buf Buffer containing the 14-byte protocol packet. Must not be NULL.
 340  * @param floatval Pointer to a float variable. That variable will contain the
 341  *                 result value upon parsing success. Must not be NULL.
 342  * @param analog Pointer to a struct sr_datafeed_analog. The struct will be
 343  *               filled with data according to the protocol packet.
 344  *               Must not be NULL.
 345  * @param info Pointer to a struct fs9721_info. The struct will be filled
 346  *             with data according to the protocol packet. Must not be NULL.
 347  *
 348  * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the
 349  *         'analog' variable contents are undefined and should not be used.
 350  */
 351 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
 352                             struct sr_datafeed_analog *analog, void *info)
 353 {
 354         int ret, exponent = 0;
 355         struct fs9721_info *info_local;
 356
 357         info_local = (struct fs9721_info *)info;
 358
 359         if ((ret = parse_value(buf, floatval, &exponent)) != SR_OK) {
 360                 sr_dbg("Error parsing value: %d.", ret);
 361                 return ret;
 362         }
 363
 364         parse_flags(buf, info_local);
 365         handle_flags(analog, floatval, &exponent, info_local);
 366
 367         analog->encoding->digits = -exponent;
 368         analog->spec->spec_digits = -exponent;
 369
 370         return SR_OK;
 371 }
 372
 373 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info)
 374 {
 375         struct fs9721_info *info_local;
 376
 377         info_local = (struct fs9721_info *)info;
 378
 379         /* User-defined FS9721_LP3 flag 'c2c1_00' means temperature (C). */
 380         if (info_local->is_c2c1_00) {
 381                 analog->meaning->mq = SR_MQ_TEMPERATURE;
 382                 analog->meaning->unit = SR_UNIT_CELSIUS;
 383         }
 384 }
 385
 386 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info)
 387 {
 388         struct fs9721_info *info_local;
 389
 390         info_local = (struct fs9721_info *)info;
 391
 392         /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (C). */
 393         if (info_local->is_c2c1_01) {
 394                 analog->meaning->mq = SR_MQ_TEMPERATURE;
 395                 analog->meaning->unit = SR_UNIT_CELSIUS;
 396         }
 397 }
 398
 399 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info)
 400 {
 401         struct fs9721_info *info_local;
 402
 403         info_local = (struct fs9721_info *)info;
 404
 405         /* User-defined FS9721_LP3 flag 'c2c1_10' means temperature (C). */
 406         if (info_local->is_c2c1_10) {
 407                 analog->meaning->mq = SR_MQ_TEMPERATURE;
 408                 analog->meaning->unit = SR_UNIT_CELSIUS;
 409         }
 410 }
 411
 412 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info)
 413 {
 414         struct fs9721_info *info_local;
 415
 416         info_local = (struct fs9721_info *)info;
 417
 418         /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (F). */
 419         if (info_local->is_c2c1_01) {
 420                 analog->meaning->mq = SR_MQ_TEMPERATURE;
 421                 analog->meaning->unit = SR_UNIT_FAHRENHEIT;
 422         }
 423
 424         /* User-defined FS9721_LP3 flag 'c2c1_10' means temperature (C). */
 425         if (info_local->is_c2c1_10) {
 426                 analog->meaning->mq = SR_MQ_TEMPERATURE;
 427                 analog->meaning->unit = SR_UNIT_CELSIUS;
 428         }
 429 }
 430
 431 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info)
 432 {
 433         struct fs9721_info *info_local;
 434
 435         info_local = (struct fs9721_info *)info;
 436
 437         /* User-defined FS9721_LP3 flag 'c2c1_00' means MAX. */
 438         if (info_local->is_c2c1_00)
 439                 analog->meaning->mqflags |= SR_MQFLAG_MAX;
 440
 441         /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (C). */
 442         if (info_local->is_c2c1_01) {
 443                 analog->meaning->mq = SR_MQ_TEMPERATURE;
 444                 analog->meaning->unit = SR_UNIT_CELSIUS;
 445         }
 446
 447         /* User-defined FS9721_LP3 flag 'c2c1_11' means MIN. */
 448         if (info_local->is_c2c1_11)
 449                 analog->meaning->mqflags |= SR_MQFLAG_MIN;
 450
 451 }