added unit tests for calc.h

devel/lib/README.md

@@ -1,6 +1,8 @@
-MightyPorsk's AVR utils library
-===============================
+AVR utils library
+=================
 
-This is my ever-evolving library. When I'm done with a project, I copy the current library to the project, so it doesn't break when I do further improvements.
+This is my ever-evolving library (not only) for AVR programming.
+
+When I'm done with a project, I copy the current library to the project, so it doesn't break when I do further improvements.
 
 Each library file contains a large comment block explaining it's function.

devel/lib/calc.h

@@ -1,46 +1,89 @@
 #pragma once
 
 /**
-  General purpose calculation and bit manipulation utilities.
+  Bit and byte manipulation utilities
 */
 
-// if max, go to zero. Else increment.
-#define inc_wrap(var, min, max)  do { if ((var) >= (max)) { (var)=min; } else { (var)++; } } while(0)
 
-// If zero, go to max. Else decrement,
-#define dec_wrap(var, min, max)  do { if ((var) > min) { (var)--; } else { (var)=(max); } } while(0)
+// --- Increment in range ---
+// when overflown, wraps within range. Lower bound < upper bound.
+// ..., upper bound excluded
+#define inc_wrap(var, min, max)  do { if ((var) >= (max - 1)) { (var) = (min); } else { (var)++; } } while(0)
+// ..., upper bound included
+#define inc_wrapi(var, min, max) inc_wrap((var), (min), (max) + 1)
 
-// === general bit manipulation with register ===
-#define sbi(reg, bit) do { (reg) |= (1 << (uint8_t)(bit)); } while(0)
+
+// --- Decrement in range ---
+// when underflown, wraps within range. Lower bound < upper bound.
+// ..., upper bound excluded
+#define dec_wrap(var, min, max)  do { if ((var) <= (min)) { (var) = (max) - 1; } else { (var)--; } } while(0)
+// ..., upper bound included
+#define dec_wrapi(var, min, max) dec_wrap((var), (min), (max) + 1)
+
+
+// --- Bit manipulation --
+
+// Set bit
+#define sbi(reg, bit) do { (reg) |=  (1 << (uint8_t)(bit)); } while(0)
+
+// Clear bit
 #define cbi(reg, bit) do { (reg) &= ~(1 << (uint8_t)(bit)); } while(0)
 
-#define read_bit(reg, bit) ((((uint8_t)(reg)) >> (uint8_t)(bit)) & 0x1)
-#define get_bit(reg, bit) read_bit(reg, bit)
+// Get n-th bit
+#define read_bit(reg, bit) (((reg) >> (uint8_t)(bit)) & 0x1)
+#define get_bit(reg, bit)  read_bit(reg, bit)
+
+// Test n-th bit (Can't use bit_is_set, as it's redefined in sfr_def.h)
 #define bit_is_high(reg, bit) read_bit(reg, bit)
-#define bit_is_low(reg, bit) !read_bit(reg, bit)
-// Can't use bit_is_set, as it's redefined in sfr_def.h
+#define bit_is_low(reg, bit)  (!read_bit(reg, bit))
 
+// Write value to n-th bit
 #define write_bit(reg, bit, value) do { (reg) = ((reg) & ~(1 << (uint8_t)(bit))) | (((uint8_t)(value) & 0x1) << (uint8_t)(bit)); } while(0)
-#define set_bit(reg, bit, value) write_bit(reg, bit, value)
-#define toggle_bit(reg, bit) do { (reg) ^= (1 << (uint8_t)(bit)); } while(0)
+#define set_bit(reg, bit, value)   write_bit(reg, bit, value)
 
-// general pin manipulation - with pointer to register
-#define sbi_p(reg_p, bit) do { (*(reg_p)) |= (1 << (uint8_t)(bit)); } while(0)
+// Invert n-th bit
+#define toggle_bit(reg, bit)       do { (reg) ^= (1 << (uint8_t)(bit)); } while(0)
+
+
+// --- Bit manipulation with pointer to variable ---
+
+// Set n-th bit in pointee
+#define sbi_p(reg_p, bit) do { (*(reg_p)) |=  (1 << (uint8_t)(bit)); } while(0)
+// Clear n-th bit in pointee
 #define cbi_p(reg_p, bit) do { (*(reg_p)) &= ~(1 << (uint8_t)(bit)); } while(0)
 
+// Get n-th bit in pointee
 #define read_bit_p(reg_p, bit) ((*(reg_p) >> (uint8_t)(bit)) & 0x1)
-#define get_bit_p(reg_p, bit) read_bit_p(reg_p, bit)
+#define get_bit_p(reg_p, bit)  read_bit_p(reg_p, bit)
 
+// Test n-th bit in pointee (Can't use bit_is_set, as it's redefined in sfr_def.h)
+#define bit_is_high_p(reg_p, bit) read_bit_p(reg_p, bit)
+#define bit_is_low_p(reg_p, bit)  (!read_bit_p(reg_p, bit))
+
+// Write value to a bit in pointee
 #define write_bit_p(reg_p, bit, value) do { *(reg_p) = (*(reg_p) & ~(1 << ((uint8_t)(bit) & 0x1))) | (((uint8_t)(value) & 0x1) << (uint8_t)(bit)); } while(0)
-#define set_bit_p(reg, bit, value) write_bit_p(reg_p, bit, value)
-#define toggle_bit_p(reg_p, bit) do { *(reg_p) ^= (1 << (uint8_t)(bit)); } while(0)
+#define set_bit_p(reg_p, bit, value)     write_bit_p(reg_p, bit, value)
+#define toggle_bit_p(reg_p, bit)       do { *(reg_p) ^= (1 << (uint8_t)(bit)); } while(0)
 
+
+// --- Nibble manipulation ---
+
+// Replace nibble in a byte
 #define write_low_nibble(reg, value)  do { (reg) = ((reg) & 0xF0) | ((uint8_t)(value) & 0xF); } while(0)
 #define write_high_nibble(reg, value) do { (reg) = ((reg) & 0x0F) | (((uint8_t)(value) & 0xF) << 4); } while(0)
 
+#define write_low_nibble_p(reg_p, value)  do { *(reg_p) = (*(reg_p) & 0xF0) | ((uint8_t)(value) & 0xF); } while(0)
+#define write_high_nibble_p(reg_p, value) do { *(reg_p) = (*(reg_p) & 0x0F) | (((uint8_t)(value) & 0xF) << 4); } while(0)
 
-// Check if value is in range A..B or B..A
-#define in_range(x, low, high) (((low) < (high)) && ((x) > (low) && (x) < (high))) || (((low) > (high)) && ((x) < (low) || (x) > (high)))
 
-// Check if value is in range A..B. If B < A, matches all outside B..A
-#define in_range_wrap(x, low, high) (((low) < (high)) && ((x) > (low) && (x) < (high))) || (((low) > (high)) && ((x) > (low) || (x) < (high)))
+// --- Range tests ---
+
+// Test if X is within low..high, regardless of bounds order
+#define in_range(x, low, high)  ((((low)  < (high)) && ((x) >= (low) && (x)  < (high))) || (((low) > (high)) && ((x) >= (high) && (x)  < (low))))
+// ..., include greater bound
+#define in_rangei(x, low, high) ((((low) <= (high)) && ((x) >= (low) && (x) <= (high))) || (((low) > (high)) && ((x) >= (high) && (x) <= (low))))
+
+// Test if X in low..high, wrap around ends if needed.
+#define in_range_wrap(x, low, high)  ((((low)  < (high)) && ((x) >= (low) && (x) < (high)))  || (((low) > (high)) && ((x) >= (low) || (x)  < (high))))
+// ..., include upper bound
+#define in_range_wrapi(x, low, high) ((((low) <= (high)) && ((x) >= (low) && (x) <= (high))) || (((low) > (high)) && ((x) >= (low) || (x) <= (high))))

devel/lib/debounce.h

@@ -49,9 +49,9 @@
 
 /* Internal deboucer entry */
 typedef struct {
-	PORT_P reg;
-	uint8_t bit;
-	uint8_t count;
+	PORT_P reg;    // pointer to IO register
+	uint8_t bit;   // bits 6 and 7 of this hold "state" & "invert" flag
+	uint8_t count; // number of ticks this was in the new state
 } debo_slot_t;
 
 /** Debounce data array */
@@ -101,4 +101,3 @@ void debo_tick()
 
 /** Get a value of debounced pin */
 #define debo_get_pin(i) (get_bit(debo_slots[i].bit, 6) ^ get_bit(debo_slots[i].bit, 7))
-//(get_bit(debo_slots[i].bit, 6) ^ get_bit(debo_slots[i].bit, 7))

devel/lib/loops.h

@@ -0,0 +1,25 @@
+#pragma once
+
+/**
+  Custom loops
+*/
+
+// Repeat code n times (uint8_t counter)
+#define repeat(count) repeat_aux(count, _repeat_##__COUNTER__)
+#define repeat_aux(count, cntvar) for (uint8_t cntvar = 0; cntvar < (count); cntvar++)
+
+// Repeat code n times (uint16_t counter)
+#define repeatx(count) repeatx_aux(count, _repeatx_##__COUNTER__)
+#define repeatx_aux(count, cntvar) for (uint16_t cntvar = 0; cntvar < (count); cntvar++)
+
+// Repeat with custom counter name (uint8_t)
+#define loop(var, count) repeat_aux(count, var)
+// ..., uint16_t
+#define loopx(var, count) repeatx_aux(count, var)
+
+// Do until condition is met
+#define until(what) while(!(what))
+
+// Because why the hell not
+#define whilst(what) while((what))
+