Refactoring and bug fix

Author: mikaelpatel

README.md

@@ -12,7 +12,7 @@ template class may be used to construct additional libraries.
 This library supports boards based on SAM3X8E, ATmega168, ATmega328P,
 ATmega32U4, ATmega1280, ATmega2560, ATtinyX4 and ATtinyX5.
 
-Version: 1.7
+Version: 1.8
 
 ## Classes
 

examples/Benchmark/Benchmark.ino

@@ -20,8 +20,9 @@ void setup()
 {
   pinMode(LED_PIN, OUTPUT);
   pinMode(BUTTON_PIN, INPUT_PULLUP);
+
   led.output();
-  button.input_pullup();
+  button.input().pullup();
   ss.output();
 }
 

library.properties

@@ -1,5 +1,5 @@
 name=Arduino-GPIO
-version=1.7
+version=1.8
 author=Mikael Patel
 maintainer=Mikael Patel <mikael.patel@gmail.com>
 sentence=General Purpose Input/Output (GPIO) library for Arduino.

mainpage.dox

@@ -14,7 +14,7 @@ additional classes and libraries.
 This library supports boards based on SAM3X8E, ATmega168, ATmega328P,
 ATmega32U4, ATmega1280, ATmega2560, ATtinyX4 and ATtinyX5.
 
-Version: 1.7
+Version: 1.8
 */
 
 /** @page License

src/Hardware/AVR/Board.h

@@ -1,6 +1,6 @@
 /**
  * @file Board.h
- * @version 1.4
+ * @version 1.5
  *
  * @section License
  * Copyright (C) 2017, Mikael Patel
@@ -31,16 +31,16 @@
  * Return port control register address from board pin value.
  * @return io port address
  */
-#define GPIO_REG(pin) (pin >> 4)
+#define GPIO_REG(pin) ((pin) >> 4)
 
-/** Maximum port control register address for atomic instructions. */
-#define GPIO_ATOMIC_MAX GPIO_PIN(0x60,0)
+/** Maximum port control register address for atomic bit instructions. */
+#define GPIO_ATOMIC_MAX GPIO_PIN(0x40,0)
 
 /**
  * Return pin mask from board pin value.
  * @return pin mask
  */
-#define GPIO_MASK(pin) _BV(pin & 0xf)
+#define GPIO_MASK(pin) _BV((pin) & 0xf)
 
 #if defined(__AVR_ATmega168__) || defined(__AVR_ATmega328P__)
 /**

src/Hardware/AVR/GPIO.h

@@ -1,6 +1,6 @@
 /**
  * @file Hardware/AVR/GPIO.h
- * @version 1.4
+ * @version 1.5
  *
  * @section License
  * Copyright (C) 2017, Mikael Patel
@@ -44,7 +44,7 @@
 /**
  * General Purpose Digital I/O pin template class. Highly optimized
  * pin access. The PIN address is bit pointer to the port control
- * register and pin bit position. See Board.h for details.
+ * register and pin bit position. See Hardware/AVR/Board.h for details.
  * @param[in] PIN board pin definition.
  */
 template<BOARD::pin_t PIN>
@@ -53,19 +53,20 @@ class GPIO {
   /**
    * Set pin to input mode.
    */
-  void input()
+  GPIO<PIN>& input()
     __attribute__((always_inline))
   {
     GPIO_ATOMIC(SFR()->ddr &= ~MASK);
+    return (*this);
   }
 
   /**
-   * Set pin to input mode and activate internal pullup resistor.
+   * Used with input() to activate internal pullup resistor on
+   * input pin.
    */
-  void input_pullup()
+  void pullup()
     __attribute__((always_inline))
   {
-    input();
     high();
   }
 
@@ -78,6 +79,17 @@ class GPIO {
     GPIO_ATOMIC(SFR()->ddr |= MASK);
   }
 
+  /**
+   * Open-collector pin. Use input() and output() to source and sink
+   * current.
+   */
+  void open_collector()
+    __attribute__((always_inline))
+  {
+    input();
+    low();
+  }
+
   /**
    * Return current pin state.
    * @return state.

src/Hardware/SAM/Board.h

@@ -1,6 +1,6 @@
 /**
  * @file Hardware/SAM/Board.h
- * @version 1.0
+ * @version 1.1
  *
  * @section License
  * Copyright (C) 2017, Mikael Patel
@@ -31,7 +31,7 @@
  * Return port control register index from board pin value.
  * @return io port address
  */
-#define GPIO_REG(pin) (pin >> 8)
+#define GPIO_REG(pin) ((pin) >> 8)
 
 /**
  * Return pin mask from board pin value.

src/Hardware/SAM/GPIO.h

@@ -1,6 +1,6 @@
 /**
  * @file Hardware/SAM/GPIO.h
- * @version 1.0
+ * @version 1.1
  *
  * @section License
  * Copyright (C) 2017, Mikael Patel
@@ -32,26 +32,27 @@ class GPIO {
 public:
   GPIO()
   {
+    pmc_enable_periph_clk(ID_PIO());
     SFR()->PIO_PER = MASK;
   }
 
   /**
    * Set pin to input mode.
    */
-  void input()
+  GPIO<PIN>& input()
     __attribute__((always_inline))
   {
     SFR()->PIO_ODR = MASK;
-    SFR()->PIO_PUDR = MASK;
+    return (*this);
   }
 
   /**
-   * Set pin to input mode and activate internal pullup resistor.
+   * Used with input() to activate internal pullup resistor on
+   * input pin.
    */
-  void input_pullup()
+  void pullup()
     __attribute__((always_inline))
   {
-    SFR()->PIO_ODR = MASK;
     SFR()->PIO_PUER = MASK;
   }
 
@@ -62,7 +63,16 @@ class GPIO {
     __attribute__((always_inline))
   {
     SFR()->PIO_OER = MASK;
-    SFR()->PIO_PUER = MASK;
+  }
+
+  /**
+   * Open-collector pin.
+   */
+  void open_collector()
+    __attribute__((always_inline))
+  {
+    SFR()->PIO_CODR = MASK;
+    SFR()->PIO_MDER = MASK;
   }
 
   /**
@@ -72,8 +82,6 @@ class GPIO {
   bool read()
     __attribute__((always_inline))
   {
-    if (SFR()->PIO_OSR & MASK)
-      return ((SFR()->PIO_ODSR & MASK) != 0);
     return ((SFR()->PIO_PDSR & MASK) != 0);
   }
 
@@ -184,5 +192,17 @@ class GPIO {
       return (PIOD);
     }
   }
+
+  uint32_t ID_PIO()
+    __attribute__((always_inline))
+  {
+    switch (GPIO_REG(PIN)) {
+    case 0: return (ID_PIOA);
+    case 1: return (ID_PIOB);
+    case 2: return (ID_PIOC);
+    default:
+      return (ID_PIOD);
+    }
+  }
 };
 #endif