]> sigrok.org Git - libsigrok.git/blobdiff - hardware/common/dmm/fs9721.c
build: Portability fixes.
[libsigrok.git] / hardware / common / dmm / fs9721.c
index 79df12d991f69ff6e7c45089023244dfba842915..f3101f8b34b88ce5bffc9078341bdd3e7c4c9d35 100644 (file)
@@ -1,7 +1,8 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* Message logging helpers with driver-specific prefix string. */
-#define DRIVER_LOG_DOMAIN "fs9721: "
-#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
-#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+#define LOG_PREFIX "fs9721"
 
 static int parse_digit(uint8_t b)
 {
@@ -70,21 +64,71 @@ static int parse_digit(uint8_t b)
        case 0x3f:
                return 9;
        default:
-               sr_err("Invalid digit byte: 0x%02x.", b);
+               sr_dbg("Invalid digit byte: 0x%02x.", b);
                return -1;
        }
 }
 
-/**
- * Parse the numerical value from a protocol packet.
- *
- * @param buf Buffer containing the 14-byte protocol packet.
- * @param result Pointer to a float variable. That variable will contain the
- *               result value upon parsing success.
- *
- * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the result
- *         variable contents are undefined and should not be used.
- */
+static gboolean sync_nibbles_valid(const uint8_t *buf)
+{
+       int i;
+
+       /* Check the synchronization nibbles, and make sure they all match. */
+       for (i = 0; i < FS9721_PACKET_SIZE; i++) {
+               if (((buf[i] >> 4) & 0x0f) != (i + 1)) {
+                       sr_dbg("Sync nibble in byte %d (0x%02x) is invalid.",
+                              i, buf[i]);
+                       return FALSE;
+               }
+       }
+
+       return TRUE;
+}
+
+static gboolean flags_valid(const struct fs9721_info *info)
+{
+       int count;
+
+       /* Does the packet have more than one multiplier? */
+       count = 0;
+       count += (info->is_nano) ? 1 : 0;
+       count += (info->is_micro) ? 1 : 0;
+       count += (info->is_milli) ? 1 : 0;
+       count += (info->is_kilo) ? 1 : 0;
+       count += (info->is_mega) ? 1 : 0;
+       if (count > 1) {
+               sr_dbg("More than one multiplier detected in packet.");
+               return FALSE;
+       }
+
+       /* Does the packet "measure" more than one type of value? */
+       count = 0;
+       count += (info->is_hz) ? 1 : 0;
+       count += (info->is_ohm) ? 1 : 0;
+       count += (info->is_farad) ? 1 : 0;
+       count += (info->is_ampere) ? 1 : 0;
+       count += (info->is_volt) ? 1 : 0;
+       count += (info->is_percent) ? 1 : 0;
+       if (count > 1) {
+               sr_dbg("More than one measurement type detected in packet.");
+               return FALSE;
+       }
+
+       /* Both AC and DC set? */
+       if (info->is_ac && info->is_dc) {
+               sr_dbg("Both AC and DC flags detected in packet.");
+               return FALSE;
+       }
+
+       /* RS232 flag not set? */
+       if (!info->is_rs232) {
+               sr_dbg("No RS232 flag detected in packet.");
+               return FALSE;
+       }
+
+       return TRUE;
+}
+
 static int parse_value(const uint8_t *buf, float *result)
 {
        int i, sign, intval = 0, digits[4];
@@ -130,7 +174,6 @@ static int parse_value(const uint8_t *buf, float *result)
                intval += digits[i];
        }
 
-       /* Store the value in a float variable. */
        floatval = (float)intval;
 
        /* Decimal point position. */
@@ -157,166 +200,246 @@ static int parse_value(const uint8_t *buf, float *result)
        return SR_OK;
 }
 
-/**
- * Parse various flags in a protocol packet.
- *
- * @param buf Buffer containing the 14-byte protocol packet.
- * @param floatval Pointer to a float variable which should contain the value
- *                 parsed using parse_value(). That variable will be modified
- *                 in-place depending on the flags in the protocol packet.
- * @param analog Pointer to a struct sr_datafeed_analog. The struct will be
- *               filled with the relevant data according to the flags in the
- *               protocol packet.
- *
- * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the 'floatval'
- *         and 'analog' variable contents are undefined and should not be used.
- */
-static int parse_flags(const uint8_t *buf, float *floatval,
-                      struct sr_datafeed_analog *analog)
+static void parse_flags(const uint8_t *buf, struct fs9721_info *info)
 {
-       gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
-       gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
-       gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
-       gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00;
-
        /* Byte 0: LCD SEG1 */
-       is_ac         = (buf[0] & (1 << 3)) != 0;
-       is_dc         = (buf[0] & (1 << 2)) != 0;
-       is_auto       = (buf[0] & (1 << 1)) != 0;
-       is_rs232      = (buf[0] & (1 << 0)) != 0;
+       info->is_ac         = (buf[0] & (1 << 3)) != 0;
+       info->is_dc         = (buf[0] & (1 << 2)) != 0;
+       info->is_auto       = (buf[0] & (1 << 1)) != 0;
+       info->is_rs232      = (buf[0] & (1 << 0)) != 0;
+
+       /* Byte 1: LCD SEG2 */
+       info->is_sign       = (buf[1] & (1 << 3)) != 0;
 
        /* Byte 9: LCD SEG10 */
-       is_micro      = (buf[9] & (1 << 3)) != 0;
-       is_nano       = (buf[9] & (1 << 2)) != 0;
-       is_kilo       = (buf[9] & (1 << 1)) != 0;
-       is_diode      = (buf[9] & (1 << 0)) != 0;
+       info->is_micro      = (buf[9] & (1 << 3)) != 0;
+       info->is_nano       = (buf[9] & (1 << 2)) != 0;
+       info->is_kilo       = (buf[9] & (1 << 1)) != 0;
+       info->is_diode      = (buf[9] & (1 << 0)) != 0;
 
        /* Byte 10: LCD SEG11 */
-       is_milli      = (buf[10] & (1 << 3)) != 0;
-       is_percent    = (buf[10] & (1 << 2)) != 0;
-       is_mega       = (buf[10] & (1 << 1)) != 0;
-       is_beep       = (buf[10] & (1 << 0)) != 0;
+       info->is_milli      = (buf[10] & (1 << 3)) != 0;
+       info->is_percent    = (buf[10] & (1 << 2)) != 0;
+       info->is_mega       = (buf[10] & (1 << 1)) != 0;
+       info->is_beep       = (buf[10] & (1 << 0)) != 0;
 
        /* Byte 11: LCD SEG12 */
-       is_farad      = (buf[11] & (1 << 3)) != 0;
-       is_ohm        = (buf[11] & (1 << 2)) != 0;
-       is_rel        = (buf[11] & (1 << 1)) != 0;
-       is_hold       = (buf[11] & (1 << 0)) != 0;
+       info->is_farad      = (buf[11] & (1 << 3)) != 0;
+       info->is_ohm        = (buf[11] & (1 << 2)) != 0;
+       info->is_rel        = (buf[11] & (1 << 1)) != 0;
+       info->is_hold       = (buf[11] & (1 << 0)) != 0;
 
        /* Byte 12: LCD SEG13 */
-       is_ampere     = (buf[12] & (1 << 3)) != 0;
-       is_volt       = (buf[12] & (1 << 2)) != 0;
-       is_hz         = (buf[12] & (1 << 1)) != 0;
-       is_bat        = (buf[12] & (1 << 0)) != 0;
+       info->is_ampere     = (buf[12] & (1 << 3)) != 0;
+       info->is_volt       = (buf[12] & (1 << 2)) != 0;
+       info->is_hz         = (buf[12] & (1 << 1)) != 0;
+       info->is_bat        = (buf[12] & (1 << 0)) != 0;
 
        /* Byte 13: LCD SEG14 */
-       is_c2c1_11    = (buf[13] & (1 << 3)) != 0;
-       is_c2c1_10    = (buf[13] & (1 << 2)) != 0;
-       is_c2c1_01    = (buf[13] & (1 << 1)) != 0;
-       is_c2c1_00    = (buf[13] & (1 << 0)) != 0;
+       info->is_c2c1_11    = (buf[13] & (1 << 3)) != 0;
+       info->is_c2c1_10    = (buf[13] & (1 << 2)) != 0;
+       info->is_c2c1_01    = (buf[13] & (1 << 1)) != 0;
+       info->is_c2c1_00    = (buf[13] & (1 << 0)) != 0;
+}
 
+static void handle_flags(struct sr_datafeed_analog *analog, float *floatval,
+                        const struct fs9721_info *info)
+{
        /* Factors */
-       if (is_nano)
+       if (info->is_nano)
                *floatval /= 1000000000;
-       if (is_micro)
+       if (info->is_micro)
                *floatval /= 1000000;
-       if (is_milli)
+       if (info->is_milli)
                *floatval /= 1000;
-       if (is_kilo)
+       if (info->is_kilo)
                *floatval *= 1000;
-       if (is_mega)
+       if (info->is_mega)
                *floatval *= 1000000;
 
        /* Measurement modes */
-       if (is_volt) {
+       if (info->is_volt) {
                analog->mq = SR_MQ_VOLTAGE;
                analog->unit = SR_UNIT_VOLT;
        }
-       if (is_ampere) {
+       if (info->is_ampere) {
                analog->mq = SR_MQ_CURRENT;
                analog->unit = SR_UNIT_AMPERE;
        }
-       if (is_ohm) {
+       if (info->is_ohm) {
                analog->mq = SR_MQ_RESISTANCE;
                analog->unit = SR_UNIT_OHM;
        }
-       if (is_hz) {
+       if (info->is_hz) {
                analog->mq = SR_MQ_FREQUENCY;
                analog->unit = SR_UNIT_HERTZ;
        }
-       if (is_farad) {
+       if (info->is_farad) {
                analog->mq = SR_MQ_CAPACITANCE;
                analog->unit = SR_UNIT_FARAD;
        }
-       if (is_beep) {
+       if (info->is_beep) {
                analog->mq = SR_MQ_CONTINUITY;
                analog->unit = SR_UNIT_BOOLEAN;
-               *floatval = (*floatval < 0.0) ? 0.0 : 1.0;
+               *floatval = (*floatval == INFINITY) ? 0.0 : 1.0;
        }
-       if (is_diode) {
+       if (info->is_diode) {
                analog->mq = SR_MQ_VOLTAGE;
                analog->unit = SR_UNIT_VOLT;
        }
-       if (is_percent) {
+       if (info->is_percent) {
                analog->mq = SR_MQ_DUTY_CYCLE;
                analog->unit = SR_UNIT_PERCENTAGE;
        }
 
        /* Measurement related flags */
-       if (is_ac)
+       if (info->is_ac)
                analog->mqflags |= SR_MQFLAG_AC;
-       if (is_dc)
+       if (info->is_dc)
                analog->mqflags |= SR_MQFLAG_DC;
-       if (is_auto)
+       if (info->is_auto)
                analog->mqflags |= SR_MQFLAG_AUTORANGE;
-       if (is_hold)
+       if (info->is_diode)
+               analog->mqflags |= SR_MQFLAG_DIODE;
+       if (info->is_hold)
                analog->mqflags |= SR_MQFLAG_HOLD;
-       if (is_rel)
+       if (info->is_rel)
                analog->mqflags |= SR_MQFLAG_RELATIVE;
 
        /* Other flags */
-       if (is_rs232)
+       if (info->is_rs232)
                sr_spew("RS232 enabled.");
-       if (is_bat)
+       if (info->is_bat)
                sr_spew("Battery is low.");
-       if (is_c2c1_00)
+       if (info->is_c2c1_00)
                sr_spew("User-defined LCD symbol 0 is active.");
-       if (is_c2c1_01)
+       if (info->is_c2c1_01)
                sr_spew("User-defined LCD symbol 1 is active.");
-       if (is_c2c1_10)
+       if (info->is_c2c1_10)
                sr_spew("User-defined LCD symbol 2 is active.");
-       if (is_c2c1_11)
+       if (info->is_c2c1_11)
                sr_spew("User-defined LCD symbol 3 is active.");
+}
 
-       return SR_OK;
+SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf)
+{
+       struct fs9721_info info;
+
+       parse_flags(buf, &info);
+
+       return (sync_nibbles_valid(buf) && flags_valid(&info));
 }
 
 /**
  * Parse a protocol packet.
  *
- * @param buf Buffer containing the 14-byte protocol packet.
- * @param floatval Pointer to a float variable. That variable will be modified
- *                 in-place depending on the protocol packet.
+ * @param buf Buffer containing the 14-byte protocol packet. Must not be NULL.
+ * @param floatval Pointer to a float variable. That variable will contain the
+ *                 result value upon parsing success. Mut not be NULL.
  * @param analog Pointer to a struct sr_datafeed_analog. The struct will be
  *               filled with data according to the protocol packet.
+ *               Must not be NULL.
+ * @param info Pointer to a struct fs9721_info. The struct will be filled
+ *             with data according to the protocol packet. Must not be NULL.
  *
  * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the
  *         'analog' variable contents are undefined and should not be used.
  */
-SR_PRIV int sr_dmm_parse_fs9721(const uint8_t *buf, float *floatval,
-                               struct sr_datafeed_analog *analog)
+SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
+                           struct sr_datafeed_analog *analog, void *info)
 {
        int ret;
+       struct fs9721_info *info_local;
+
+       info_local = (struct fs9721_info *)info;
 
        if ((ret = parse_value(buf, floatval)) != SR_OK) {
-               sr_err("Error parsing value: %d.", ret);
+               sr_dbg("Error parsing value: %d.", ret);
                return ret;
        }
 
-       if ((ret = parse_flags(buf, floatval, analog)) != SR_OK) {
-               sr_err("Error parsing flags: %d.", ret);
-               return ret;
-       }
+       parse_flags(buf, info_local);
+       handle_flags(analog, floatval, info_local);
 
        return SR_OK;
 }
+
+SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info)
+{
+       struct fs9721_info *info_local;
+
+       info_local = (struct fs9721_info *)info;
+
+       /* User-defined FS9721_LP3 flag 'c2c1_00' means temperature (C). */
+       if (info_local->is_c2c1_00) {
+               analog->mq = SR_MQ_TEMPERATURE;
+               analog->unit = SR_UNIT_CELSIUS;
+       }
+}
+
+SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info)
+{
+       struct fs9721_info *info_local;
+
+       info_local = (struct fs9721_info *)info;
+
+       /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (C). */
+       if (info_local->is_c2c1_01) {
+               analog->mq = SR_MQ_TEMPERATURE;
+               analog->unit = SR_UNIT_CELSIUS;
+       }
+}
+
+SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info)
+{
+       struct fs9721_info *info_local;
+
+       info_local = (struct fs9721_info *)info;
+
+       /* User-defined FS9721_LP3 flag 'c2c1_10' means temperature (C). */
+       if (info_local->is_c2c1_10) {
+               analog->mq = SR_MQ_TEMPERATURE;
+               analog->unit = SR_UNIT_CELSIUS;
+       }
+}
+
+SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info)
+{
+       struct fs9721_info *info_local;
+
+       info_local = (struct fs9721_info *)info;
+
+       /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (F). */
+       if (info_local->is_c2c1_01) {
+               analog->mq = SR_MQ_TEMPERATURE;
+               analog->unit = SR_UNIT_FAHRENHEIT;
+       }
+
+       /* User-defined FS9721_LP3 flag 'c2c1_10' means temperature (C). */
+       if (info_local->is_c2c1_10) {
+               analog->mq = SR_MQ_TEMPERATURE;
+               analog->unit = SR_UNIT_CELSIUS;
+       }
+}
+
+SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info)
+{
+       struct fs9721_info *info_local;
+
+       info_local = (struct fs9721_info *)info;
+
+       /* User-defined FS9721_LP3 flag 'c2c1_00' means MAX. */
+       if (info_local->is_c2c1_00)
+               analog->mqflags |= SR_MQFLAG_MAX;
+
+       /* User-defined FS9721_LP3 flag 'c2c1_01' means temperature (C). */
+       if (info_local->is_c2c1_01) {
+               analog->mq = SR_MQ_TEMPERATURE;
+               analog->unit = SR_UNIT_CELSIUS;
+       }
+
+       /* User-defined FS9721_LP3 flag 'c2c1_11' means MIN. */
+       if (info_local->is_c2c1_11)
+               analog->mqflags |= SR_MQFLAG_MIN;
+
+}