Refactoring assert and benchmarks

Author: mikaelpatel

examples/Alarm/Alarm.ino

@@ -1,6 +1,7 @@
 #include "GPIO.h"
 #include "OWI.h"
 #include "Driver/DS18B20.h"
+#include "assert.h"
 
 // Configure: Software/Hardware OWI Bus Manager
 #define USE_SOFTWARE_OWI
@@ -29,16 +30,6 @@ Hardware::OWI owi(twi);
 
 DS18B20 sensor(owi);
 
-#define ASSERT(expr)	\
- do {	\
- if (!(expr)) {	\
- Serial.print(__LINE__);	\
- Serial.println(F(":assert:" #expr));	\
- Serial.flush();	\
- exit(0);	\
- }	\
- } while (0)
-
 void setup()
 {
  Serial.begin(57600);

examples/Benchmark/Benchmark.ino

@@ -0,0 +1,73 @@
+#include "GPIO.h"
+#include "OWI.h"
+#include "benchmark.h"
+
+// Configure: Software/Hardware OWI Bus Manager
+#define USE_SOFTWARE_OWI
+#if defined(USE_SOFTWARE_OWI)
+#include "Software/OWI.h"
+Software::OWI<BOARD::D7> owi;
+
+#else
+#include "TWI.h"
+#include "Hardware/OWI.h"
+// Configure: Software/Hardware TWI Bus Manager
+// #define USE_SOFTWARE_TWI
+#if defined(USE_SOFTWARE_TWI)
+#include "Software/TWI.h"
+#if defined(SAM)
+Software::TWI<BOARD::D8,BOARD::D9> twi;
+#else
+Software::TWI<BOARD::D18,BOARD::D19> twi;
+#endif
+#else
+#include "Hardware/TWI.h"
+Hardware::TWI twi;
+#endif
+Hardware::OWI owi(twi);
+#endif
+
+void setup()
+{
+ Serial.begin(57600);
+ while (!Serial);
+ BENCHMARK_BASELINE(1);
+}
+
+void loop()
+{
+ // Measure the standard 1-wire bus manager functions
+ // All measurements are in micro-seconds
+
+ uint8_t rom[owi.ROM_MAX];
+ uint8_t dir = 0;
+
+ // Cyclic Redundancy Check per byte
+ MEASURE(owi.crc_update(0,0));
+
+ // Reset pulse and presence check
+ MEASURE(owi.reset());
+
+ // Write bit and byte
+ MEASURE(owi.write(0,1));
+ MEASURE(owi.write(1,1));
+ MEASURE(owi.write(0x00));
+ MEASURE(owi.write(0xff));
+
+ // Read bit and byte
+ MEASURE(owi.read(1));
+ MEASURE(owi.read());
+
+ // Triplet; read two bits and write one
+ MEASURE(owi.triplet(dir));
+
+ // Standard rom functions
+ MEASURE(owi.read_rom(rom));
+ MEASURE(owi.skip_rom());
+ MEASURE(owi.match_rom(rom));
+ MEASURE(owi.search_rom(0, rom));
+ MEASURE(owi.alarm_search(rom));
+
+ Serial.println();
+ delay(2000);
+}

examples/DS18B20/DS18B20.ino

@@ -1,12 +1,20 @@
 #include "GPIO.h"
 #include "OWI.h"
 #include "Driver/DS18B20.h"
+#include "assert.h"
 
 // Configure: Software/Hardware OWI Bus Manager
 #define USE_SOFTWARE_OWI
 #if defined(USE_SOFTWARE_OWI)
 #include "Software/OWI.h"
+
+#if defined(ARDUINO_attiny)
+#include "Software/Serial.h"
+Software::Serial<BOARD::D0> Serial;
+Software::OWI<BOARD::D1> owi;
+#else
 Software::OWI<BOARD::D7> owi;
+#endif
 
 #else
 // Configure: Software/Hardware TWI Bus Manager
@@ -29,16 +37,6 @@ Hardware::OWI owi(twi);
 
 DS18B20 sensor(owi);
 
-#define ASSERT(expr)	\
- do {	\
- if (!(expr)) {	\
- Serial.print(__LINE__);	\
- Serial.println(F(":assert:" #expr));	\
- Serial.flush();	\
- exit(0);	\
- }	\
- } while (0)
-
 void setup()
 {
  Serial.begin(57600);

examples/DS1990A/DS1990A.ino

@@ -1,5 +1,5 @@
-#include "OWI.h"
 #include "GPIO.h"
+#include "OWI.h"
 #include "Software/OWI.h"
 
 #if defined(ARDUINO_attiny)

examples/Scanner/Scanner.ino

@@ -1,5 +1,5 @@
-#include "OWI.h"
 #include "GPIO.h"
+#include "OWI.h"
 
 // Configure: Software/Hardware OWI Bus Manager
 #define USE_SOFTWARE_OWI

examples/Search/Search.ino

@@ -1,5 +1,5 @@
-#include "OWI.h"
 #include "GPIO.h"
+#include "OWI.h"
 
 // Configure: Software/Hardware OWI Bus Manager
 #define USE_SOFTWARE_OWI

src/Hardware/OWI.h

@@ -69,7 +69,7 @@ class OWI : public ::OWI {
  while (bits--) {
 res >>= 1;
 m_bridge.one_wire_read_bit(value);
-if (value) res |= 0x80;
+res |= (value ? 0x80 : 0x00);
  }
  res >>= adjust;
  }

src/OWI.h

@@ -45,18 +45,19 @@ class OWI {
  /**
  * @override{OWI}
  * Read the given number of bits from the one wire bus. Default
- * number of bits is CHARBITS (8). Calculates partial check-sum.
+ * number of bits is CHARBITS (8).
  * @param[in] bits to be read (default CHARBITS).
  * @return value read.
  */
  virtual uint8_t read(uint8_t bits = CHARBITS) = 0;
 
  /**
  * Read given number of bytes from one wire bus (device) to given
- * buffer.
+ * buffer. Calculates 8-bit Cyclic Redundancy Check sum and return
+ * result of check.
  * @param[in] buf buffer pointer.
  * @param[in] count number of bytes to read.
- * @return true(1) if correctly read otherwise false(0).
+ * @return true(1) if check sum is correct otherwise false(0).
  */
  bool read(void* buf, size_t count)
  {
@@ -80,15 +81,15 @@ class OWI {
  virtual void write(uint8_t value, uint8_t bits = CHARBITS) = 0;
 
  /**
- * Write the given value and given number of bytes from buffer to
+ * Write the given command and given number of bytes from buffer to
  * the one wire bus (device).
- * @param[in] value to write.
+ * @param[in] cmd command to write.
  * @param[in] buf buffer pointer.
  * @param[in] count number of bytes to write.
  */
- void write(uint8_t value, const void* buf, size_t count)
+ void write(uint8_t cmd, const void* buf, size_t count)
  {
- write(value);
+ write(cmd);
  const uint8_t* bp = (const uint8_t*) buf;
  while (count--) write(*bp++);
  }
@@ -121,6 +122,34 @@ class OWI {
  }
  }
 
+ /**
+ * Standard 1-Wire ROM Commands.
+ */
+ enum {
+ SEARCH_ROM = 0xF0,//!< Initiate device search.
+ READ_ROM = 0x33,//!< Read device family code and serial number.
+ MATCH_ROM = 0x55,//!< Select device with 64-bit rom code.
+ SKIP_ROM = 0xCC,//!< Broadcast or single device.
+ ALARM_SEARCH = 0xEC//!< Initiate device alarm search.
+ } __attribute__((packed));
+
+ /**
+ * Optimized Dallas/Maxim iButton 8-bit Cyclic Redundancy Check
+ * calculation. Polynomial: x^8 + x^5 + x^4 + 1 (0x8C).
+ * See http://www.maxim-ic.com/appnotes.cfm/appnote_number/27
+ */
+ static uint8_t crc_update(uint8_t crc, uint8_t data)
+ {
+ crc = crc ^ data;
+ for (uint8_t i = 0; i < 8; i++) {
+ if (crc & 0x01)
+crc = (crc >> 1) ^ 0x8C;
+ else
+crc >>= 1;
+ }
+ return (crc);
+ }
+
  /** Search position and return values. */
  enum {
  FIRST = -1,//!< Start position of search.
@@ -250,34 +279,6 @@ class OWI {
  uint8_t m_rom[ROM_MAX];
  };
 
- /**
- * Standard ROM Commands.
- */
- enum {
- SEARCH_ROM = 0xF0,//!< Initiate device search.
- READ_ROM = 0x33,//!< Read device family code and serial number.
- MATCH_ROM = 0x55,//!< Select device with 64-bit rom code.
- SKIP_ROM = 0xCC,//!< Broadcast or single device.
- ALARM_SEARCH = 0xEC//!< Initiate device alarm search.
- } __attribute__((packed));
-
- /**
- * Optimized Dallas (now Maxim) iButton 8-bit CRC calculation.
- * Polynomial: x^8 + x^5 + x^4 + 1 (0x8C) Initial value: 0x0
- * See http://www.maxim-ic.com/appnotes.cfm/appnote_number/27
- */
- static uint8_t crc_update(uint8_t crc, uint8_t data)
- {
- crc = crc ^ data;
- for (uint8_t i = 0; i < 8; i++) {
- if (crc & 0x01)
-crc = (crc >> 1) ^ 0x8C;
- else
-crc >>= 1;
- }
- return (crc);
- }
-
 protected:
  /** Maximum number of reset retries. */
  static const uint8_t RESET_RETRY_MAX = 4;
@@ -299,8 +300,10 @@ class OWI {
 uint8_t dir = (pos == last) || ((pos < last) && (code[i] & (1 << j)));
 switch (triplet(dir)) {
 case 0b00:
- if (pos == last) last = FIRST;
- else if (pos > last || (code[i] & (1 << j)) == 0) next = pos;
+ if (pos == last)
+ last = FIRST;
+ else if (pos > last || (code[i] & (1 << j)) == 0)
+ next = pos;
  break;
 case 0b11:
  return (ERROR);

src/Software/OWI.h

@@ -65,7 +65,7 @@ class OWI : public ::OWI {
  /**
  * @override{OWI}
  * Read the given number of bits from the one wire bus. Default
- * number of bits is 8. Calculate partial check-sum.
+ * number of bits is 8.
  * @param[in] bits to be read.
  * @return value read.
  */