]> sigrok.org Git - libsigrok.git/blobdiff - hardware/radioshack-dmm/radioshack.c
radioshack-dmm: Cosmetics, coding-style, cleanups.
[libsigrok.git] / hardware / radioshack-dmm / radioshack.c
index 2ce7c8f866ad9b3c93c92909f41a7959eedaa9cd..541c936e262f6ac0861d61158a4d8143a84c5520 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include <glib.h>
-#include "libsigrok.h"
-#include "libsigrok-internal.h"
-#include "radioshack-dmm.h"
 #include <stdlib.h>
 #include <math.h>
 #include <string.h>
 #include <errno.h>
+#include <glib.h>
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
+#include "radioshack-dmm.h"
 
+enum {
+       READ_ALL,
+       READ_TEMP,
+};
 
-static gboolean rs_22_812_is_checksum_valid(const rs_22_812_packet *data)
+static gboolean checksum_valid(const struct rs_22_812_packet *rs_packet)
 {
-       uint8_t *raw = (void *) data;
+       uint8_t *raw;
        uint8_t sum = 0;
-       size_t i;
-       for(i = 0; i < RS_22_812_PACKET_SIZE - 1; i++)
+       int i;
+
+       raw = (void *)rs_packet;
+
+       for (i = 0; i < RS_22_812_PACKET_SIZE - 1; i++)
                sum += raw[i];
-       /* This is just a funky constant added to the checksum */
+
+       /* This is just a funky constant added to the checksum. */
        sum += 57;
-       sum -= data->checksum;
-       return(sum == 0);
+       sum -= rs_packet->checksum;
+       return (sum == 0);
 }
 
-static gboolean rs_22_812_is_mode_valid(rs_22_812_mode mode)
+static gboolean selection_good(const struct rs_22_812_packet *rs_packet)
 {
-       return(mode < RS_22_812_MODE_INVALID);
-}
+       int count;
 
-static gboolean rs_22_812_is_selection_good(const rs_22_812_packet *data)
-{
-       int n_postfix = 0;
-       int n_type = 0;
        /* Does the packet have more than one multiplier ? */
-       if(data->indicatrix1 & RS_22_812_IND1_KILO)
-               n_postfix++;
-       if(data->indicatrix1 & RS_22_812_IND1_MEGA)
-               n_postfix++;
-       if(data->indicatrix1 & RS_22_812_IND1_MILI)
-               n_postfix++;
-       if(data->indicatrix2 & RS_22_812_IND2_MICRO)
-               n_postfix++;
-       if(data->indicatrix2 & RS_22_812_IND2_NANO)
-               n_postfix++;
-       if(n_postfix > 1)
+       count = 0;
+       count += (rs_packet->indicatrix1 & RS_22_812_IND1_KILO)  ? 1 : 0;
+       count += (rs_packet->indicatrix1 & RS_22_812_IND1_MEGA)  ? 1 : 0;
+       count += (rs_packet->indicatrix1 & RS_22_812_IND1_MILI)  ? 1 : 0;
+       count += (rs_packet->indicatrix2 & RS_22_812_IND2_MICRO) ? 1 : 0;
+       count += (rs_packet->indicatrix2 & RS_22_812_IND2_NANO)  ? 1 : 0;
+       if (count > 1) {
+               sr_err("More than one multiplier detected in packet.");
                return FALSE;
+       }
 
-       /* Does the packet "measure" more than one type of value ?*/
-       if(data->indicatrix1 & RS_22_812_IND1_HZ)
-               n_type++;
-       if(data->indicatrix1 & RS_22_812_IND1_OHM)
-               n_type++;
-       if(data->indicatrix1 & RS_22_812_IND1_FARAD)
-               n_type++;
-       if(data->indicatrix1 & RS_22_812_IND1_AMP)
-               n_type++;
-       if(data->indicatrix1 & RS_22_812_IND1_VOLT)
-               n_type++;
-       if(data->indicatrix2 & RS_22_812_IND2_DBM)
-               n_type++;
-       if(data->indicatrix2 & RS_22_812_IND2_SEC)
-               n_type++;
-       if(data->indicatrix2 & RS_22_812_IND2_DUTY)
-               n_type++;
-       if(data->indicatrix2 & RS_22_812_IND2_HFE)
-               n_type++;
-       if(n_type > 1)
+       /* Does the packet "measure" more than one type of value? */
+       count = 0;
+       count += (rs_packet->indicatrix1 & RS_22_812_IND1_HZ)    ? 1 : 0;
+       count += (rs_packet->indicatrix1 & RS_22_812_IND1_OHM)   ? 1 : 0;
+       count += (rs_packet->indicatrix1 & RS_22_812_IND1_FARAD) ? 1 : 0;
+       count += (rs_packet->indicatrix1 & RS_22_812_IND1_AMP)   ? 1 : 0;
+       count += (rs_packet->indicatrix1 & RS_22_812_IND1_VOLT)  ? 1 : 0;
+       count += (rs_packet->indicatrix2 & RS_22_812_IND2_DBM)   ? 1 : 0;
+       count += (rs_packet->indicatrix2 & RS_22_812_IND2_SEC)   ? 1 : 0;
+       count += (rs_packet->indicatrix2 & RS_22_812_IND2_DUTY)  ? 1 : 0;
+       count += (rs_packet->indicatrix2 & RS_22_812_IND2_HFE)   ? 1 : 0;
+       if (count > 1) {
+               sr_err("More than one measurement type detected in packet.");
                return FALSE;
+       }
 
-       /* OK, no duplicates */
        return TRUE;
 }
 
-/* Since the RS 22-812 does not identify itslef in any way shape, or form,
+/*
+ * Since the 22-812 does not identify itself in any way, shape, or form,
  * we really don't know for sure who is sending the data. We must use every
  * possible check to filter out bad packets, especially since detection of the
- * 22-812 depends on how well we can filter the packets */
-SR_PRIV gboolean rs_22_812_is_packet_valid(const rs_22_812_packet *packet)
+ * 22-812 depends on how well we can filter the packets.
+ */
+SR_PRIV gboolean rs_22_812_packet_valid(const struct rs_22_812_packet *rs_packet)
 {
-       /* Unfortunately, the packet doesn't have a signature, so we must
-        * compute its checksum first */
-       if(!rs_22_812_is_checksum_valid(packet))
+       if (!checksum_valid(rs_packet))
                return FALSE;
 
-       if(!rs_22_812_is_mode_valid(packet->mode))
+       if (!(rs_packet->mode < RS_22_812_MODE_INVALID))
                return FALSE;
 
-       if(!rs_22_812_is_selection_good(packet)) {
+       if (!selection_good(rs_packet))
                return FALSE;
-       }
-       /* Made it here, huh? Then this looks to be a valid packet */
+
        return TRUE;
 }
 
-static uint8_t rs_22_812_to_digit(uint8_t raw_digit)
+static uint8_t decode_digit(uint8_t raw_digit)
 {
-       /* Take out the decimal point, so we can use a simple switch() */
+       /* Take out the decimal point, so we can use a simple switch(). */
        raw_digit &= ~RS_22_812_DP_MASK;
-       switch(raw_digit)
-       {
+
+       switch (raw_digit) {
        case 0x00:
        case RS_22_812_LCD_0:
                return 0;
@@ -139,104 +132,94 @@ static uint8_t rs_22_812_to_digit(uint8_t raw_digit)
        case RS_22_812_LCD_9:
                return 9;
        default:
+               sr_err("Invalid digit byte: 0x%02x.", raw_digit);
                return 0xff;
        }
 }
 
-typedef enum {
-       READ_ALL,
-       READ_TEMP,
-} value_type;
-
-static double lcdraw_to_double(rs_22_812_packet *rs_packet, value_type type)
+static double lcdraw_to_double(const struct rs_22_812_packet *rs_packet,
+                              int type)
 {
-       /* *********************************************************************
-        * Get a raw floating point value from the data
-        **********************************************************************/
-       double rawval;
-       double multiplier = 1;
-       uint8_t digit;
+       double rawval, multiplier = 1;
+       uint8_t digit, raw_digit;
        gboolean dp_reached = FALSE;
        int i, end;
-       switch(type) {
-       case READ_TEMP:
-               /* Do not parse the last digit */
-               end = 1;
-               break;
-       case READ_ALL:
-       default:
-               /* Parse all digits */
-               end = 0;
-       }
-       /* We have 4 digits, and we start from the most significant */
-       for(i = 3; i >= end; i--)
-       {
-               uint8_t raw_digit = *(&(rs_packet->digit4) + i);
-               digit = rs_22_812_to_digit(raw_digit);
-               if(digit == 0xff) {
+
+       /* end = 1: Don't parse last digit. end = 0: Parse all digits. */
+       end = (type == READ_TEMP) ? 1 : 0;
+
+       /* We have 4 digits, and we start from the most significant. */
+       for (i = 3; i >= end; i--) {
+               raw_digit = *(&(rs_packet->digit4) + i);
+               digit = decode_digit(raw_digit);
+               if (digit == 0xff) {
                        rawval = NAN;
                        break;
                }
-               /* Digit 1 does not have a decimal point. Instead, the decimal
-                * point is used to indicate MAX, so we must avoid testing it */
-               if( (i < 3) && (raw_digit & RS_22_812_DP_MASK) )
+               /*
+                * Digit 1 does not have a decimal point. Instead, the decimal
+                * point is used to indicate MAX, so we must avoid testing it.
+                */
+               if ((i < 3) && (raw_digit & RS_22_812_DP_MASK))
                        dp_reached = TRUE;
-               if(dp_reached) multiplier /= 10;
+               if (dp_reached)
+                       multiplier /= 10;
                rawval = rawval * 10 + digit;
        }
        rawval *= multiplier;
-       if(rs_packet->info & RS_22_812_INFO_NEG)
+       if (rs_packet->info & RS_22_812_INFO_NEG)
                rawval *= -1;
 
-       /* See if we need to multiply our raw value by anything */
-       if(rs_packet->indicatrix1 & RS_22_812_IND2_NANO) {
+       /* See if we need to multiply our raw value by anything. */
+       if (rs_packet->indicatrix1 & RS_22_812_IND2_NANO) {
                rawval *= 1E-9;
-       } else if(rs_packet->indicatrix2 & RS_22_812_IND2_MICRO) {
+       } else if (rs_packet->indicatrix2 & RS_22_812_IND2_MICRO) {
                rawval *= 1E-6;
-       } else if(rs_packet->indicatrix1 & RS_22_812_IND1_MILI) {
+       } else if (rs_packet->indicatrix1 & RS_22_812_IND1_MILI) {
                rawval *= 1E-3;
-       } else if(rs_packet->indicatrix1 & RS_22_812_IND1_KILO) {
+       } else if (rs_packet->indicatrix1 & RS_22_812_IND1_KILO) {
                rawval *= 1E3;
-       } else if(rs_packet->indicatrix1 & RS_22_812_IND1_MEGA) {
+       } else if (rs_packet->indicatrix1 & RS_22_812_IND1_MEGA) {
                rawval *= 1E6;
        }
 
        return rawval;
 }
 
-static gboolean rs_22_812_is_celsius(rs_22_812_packet *rs_packet)
+static gboolean is_celsius(struct rs_22_812_packet *rs_packet)
 {
-       return((rs_packet->digit4 & ~RS_22_812_DP_MASK) == RS_22_812_LCD_C);
+       return ((rs_packet->digit4 & ~RS_22_812_DP_MASK) == RS_22_812_LCD_C);
 }
 
-static gboolean rs_22_812_is_shortcirc(rs_22_812_packet *rs_packet)
+static gboolean is_shortcirc(struct rs_22_812_packet *rs_packet)
 {
-       return((rs_packet->digit2 & ~RS_22_812_DP_MASK) == RS_22_812_LCD_h);
+       return ((rs_packet->digit2 & ~RS_22_812_DP_MASK) == RS_22_812_LCD_h);
 }
 
-static gboolean rs_22_812_is_logic_high(rs_22_812_packet *rs_packet)
+static gboolean is_logic_high(struct rs_22_812_packet *rs_packet)
 {
-       sr_spew("digit 2: %x", rs_packet->digit2 & ~RS_22_812_DP_MASK);
-       return((rs_packet->digit2 & ~RS_22_812_DP_MASK) == RS_22_812_LCD_H);
+       sr_spew("Digit 2: 0x%02x.", rs_packet->digit2 & ~RS_22_812_DP_MASK);
+       return ((rs_packet->digit2 & ~RS_22_812_DP_MASK) == RS_22_812_LCD_H);
 }
 
-static void rs_22_812_handle_packet(rs_22_812_packet *rs_packet,
-                                   rs_dev_ctx *devc)
+static void handle_packet(struct rs_22_812_packet *rs_packet,
+                         struct dev_context *devc)
 {
-       double rawval = lcdraw_to_double(rs_packet, READ_ALL);
-       /* *********************************************************************
-        * Now see what the value means, and pass that on
-        **********************************************************************/
+       double rawval;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_analog *analog;
 
+       rawval = lcdraw_to_double(rs_packet, READ_ALL);
+
+       /* TODO: Check malloc return value. */
        analog = g_try_malloc0(sizeof(struct sr_datafeed_analog));
        analog->num_samples = 1;
+       /* TODO: Check malloc return value. */
        analog->data = g_try_malloc(sizeof(float));
        *analog->data = (float)rawval;
        analog->mq = -1;
 
-       switch(rs_packet->mode) {
+       switch (rs_packet->mode) {
        case RS_22_812_MODE_DC_V:
                analog->mq = SR_MQ_VOLTAGE;
                analog->unit = SR_UNIT_VOLT;
@@ -272,7 +255,7 @@ static void rs_22_812_handle_packet(rs_22_812_packet *rs_packet,
        case RS_22_812_MODE_CONT:
                analog->mq = SR_MQ_CONTINUITY;
                analog->unit = SR_UNIT_BOOLEAN;
-               *analog->data = rs_22_812_is_shortcirc(rs_packet);
+               *analog->data = is_shortcirc(rs_packet);
                break;
        case RS_22_812_MODE_DIODE:
                analog->mq = SR_MQ_VOLTAGE;
@@ -286,16 +269,18 @@ static void rs_22_812_handle_packet(rs_22_812_packet *rs_packet,
                analog->unit = SR_UNIT_HERTZ;
                break;
        case RS_22_812_MODE_LOGIC:
-               /* No matter whether or not we have an actual voltage reading,
-                * we are measuring voltage, so we set our MQ as VOLTAGE */
+               /*
+                * No matter whether or not we have an actual voltage reading,
+                * we are measuring voltage, so we set our MQ as VOLTAGE.
+                */
                analog->mq = SR_MQ_VOLTAGE;
-               if(!isnan(rawval)) {
-                       /* We have an actual voltage */
+               if (!isnan(rawval)) {
+                       /* We have an actual voltage. */
                        analog->unit = SR_UNIT_VOLT;
                } else {
-                       /* We have either HI or LOW */
+                       /* We have either HI or LOW. */
                        analog->unit = SR_UNIT_BOOLEAN;
-                       *analog->data = rs_22_812_is_logic_high(rs_packet);
+                       *analog->data = is_logic_high(rs_packet);
                }
                break;
        case RS_22_812_MODE_HFE:
@@ -315,10 +300,10 @@ static void rs_22_812_handle_packet(rs_22_812_packet *rs_packet,
                analog->unit = SR_UNIT_SECOND;
        case RS_22_812_MODE_TEMP:
                analog->mq = SR_MQ_TEMPERATURE;
-               /* We need to reparse */
+               /* We need to reparse. */
                *analog->data = lcdraw_to_double(rs_packet, READ_TEMP);
-               analog->unit = rs_22_812_is_celsius(rs_packet)?
-                               SR_UNIT_CELSIUS:SR_UNIT_FAHRENHEIT;
+               analog->unit = is_celsius(rs_packet) ?
+                              SR_UNIT_CELSIUS : SR_UNIT_FAHRENHEIT;
                break;
        case RS_22_812_MODE_DBM:
                analog->mq = SR_MQ_POWER;
@@ -326,26 +311,22 @@ static void rs_22_812_handle_packet(rs_22_812_packet *rs_packet,
                analog->mqflags |= SR_MQFLAG_AC;
                break;
        default:
-               sr_warn("radioshack-dmm: unkown mode: %d", rs_packet->mode);
+               sr_err("Unknown mode: %d.", rs_packet->mode);
                break;
        }
 
-       if(rs_packet->info & RS_22_812_INFO_HOLD) {
+       if (rs_packet->info & RS_22_812_INFO_HOLD)
                analog->mqflags |= SR_MQFLAG_HOLD;
-       }
-       if(rs_packet->digit4 & RS_22_812_DIG4_MAX) {
+       if (rs_packet->digit4 & RS_22_812_DIG4_MAX)
                analog->mqflags |= SR_MQFLAG_MAX;
-       }
-       if(rs_packet->indicatrix2 & RS_22_812_IND2_MIN) {
+       if (rs_packet->indicatrix2 & RS_22_812_IND2_MIN)
                analog->mqflags |= SR_MQFLAG_MIN;
-       }
-       if(rs_packet->info & RS_22_812_INFO_AUTO) {
+       if (rs_packet->info & RS_22_812_INFO_AUTO)
                analog->mqflags |= SR_MQFLAG_AUTORANGE;
-       }
 
        if (analog->mq != -1) {
                /* Got a measurement. */
-               sr_spew("radioshack-dmm: val %f", rawval);
+               sr_spew("Value: %f.", rawval);
                packet.type = SR_DF_ANALOG;
                packet.payload = analog;
                sr_session_send(devc->cb_data, &packet);
@@ -355,42 +336,41 @@ static void rs_22_812_handle_packet(rs_22_812_packet *rs_packet,
        g_free(analog);
 }
 
-static void handle_new_data(rs_dev_ctx *devc, int fd)
+static void handle_new_data(struct dev_context *devc, int fd)
 {
        int len;
-       size_t i;
-       size_t offset = 0;
-       /* Try to get as much data as the buffer can hold */
+       size_t i, offset = 0;
+       struct rs_22_812_packet *rs_packet;
+
+       /* Try to get as much data as the buffer can hold. */
        len = RS_DMM_BUFSIZE - devc->buflen;
        len = serial_read(fd, devc->buf + devc->buflen, len);
        if (len < 1) {
-               sr_err("radioshack-dmm: serial port read error!");
+               sr_err("Serial port read error.");
                return;
        }
        devc->buflen += len;
 
-       /* Now look for packets in that data */
-       while((devc->buflen - offset) >= RS_22_812_PACKET_SIZE)
-       {
-               rs_22_812_packet * packet = (void *)(devc->buf + offset);
-               if( rs_22_812_is_packet_valid(packet) )
-               {
-                       rs_22_812_handle_packet(packet, devc);
+       /* Now look for packets in that data. */
+       while ((devc->buflen - offset) >= RS_22_812_PACKET_SIZE) {
+               rs_packet = (void *)(devc->buf + offset);
+               if (rs_22_812_packet_valid(rs_packet)) {
+                       handle_packet(rs_packet, devc);
                        offset += RS_22_812_PACKET_SIZE;
                } else {
                        offset++;
                }
        }
 
-       /* If we have any data left, move it to the beginning of our buffer */
-       for(i = 0; i < devc->buflen - offset; i++)
+       /* If we have any data left, move it to the beginning of our buffer. */
+       for (i = 0; i < devc->buflen - offset; i++)
                devc->buf[i] = devc->buf[offset + i];
        devc->buflen -= offset;
 }
 
-SR_PRIV int radioshack_receive_data(int fd, int revents, void *cb_data)
+SR_PRIV int radioshack_dmm_receive_data(int fd, int revents, void *cb_data)
 {
-       const struct sr_dev_inst *sdi;
+       struct sr_dev_inst *sdi;
        struct dev_context *devc;
 
        if (!(sdi = cb_data))
@@ -399,8 +379,7 @@ SR_PRIV int radioshack_receive_data(int fd, int revents, void *cb_data)
        if (!(devc = sdi->priv))
                return TRUE;
 
-       if (revents == G_IO_IN)
-       {
+       if (revents == G_IO_IN) {
                /* Serial data arrived. */
                handle_new_data(devc, fd);
        }
@@ -412,4 +391,3 @@ SR_PRIV int radioshack_receive_data(int fd, int revents, void *cb_data)
 
        return TRUE;
 }
-