move debug uart methods, clarify license info

5 files changed, 175 insertions, 192 deletions

diff --git a/watch-library/hal_gpio.h b/watch-library/hal_gpio.h
deleted file mode 100755
index 821a7a9b..00000000
--- a/watch-library/hal_gpio.h
+++ /dev/null
@@ -1,126 +0,0 @@
-/*

- * Copyright (c) 2014-2016, Alex Taradov <alex@taradov.com>

- * All rights reserved.

- *

- * Redistribution and use in source and binary forms, with or without

- * modification, are permitted provided that the following conditions are met:

- *

- * 1. Redistributions of source code must retain the above copyright notice,

- *    this list of conditions and the following disclaimer.

- * 2. Redistributions in binary form must reproduce the above copyright

- *    notice, this list of conditions and the following disclaimer in the

- *    documentation and/or other materials provided with the distribution.

- * 3. The name of the author may not be used to endorse or promote products

- *    derived from this software without specific prior written permission.

- *

- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE

- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

- * POSSIBILITY OF SUCH DAMAGE.

- */

-

-#ifndef _HAL_GPIO_H_

-#define _HAL_GPIO_H_

-

-/*- Definitions -------------------------------------------------------------*/

-#define HAL_GPIO_PORTA       0

-#define HAL_GPIO_PORTB       1

-#define HAL_GPIO_PORTC       2

-

-#define HAL_GPIO_PMUX_A      0

-#define HAL_GPIO_PMUX_B      1

-#define HAL_GPIO_PMUX_C      2

-#define HAL_GPIO_PMUX_D      3

-#define HAL_GPIO_PMUX_E      4

-#define HAL_GPIO_PMUX_F      5

-#define HAL_GPIO_PMUX_G      6

-#define HAL_GPIO_PMUX_H      7

-#define HAL_GPIO_PMUX_I      8

-

-#define HAL_GPIO_PIN(name, port, pin)						\

-  static inline void HAL_GPIO_##name##_set(void)				\

-  {										\

-    PORT->Group[HAL_GPIO_PORT##port].OUTSET.reg = (1 << pin);			\

-    (void)HAL_GPIO_##name##_set;						\

-  }										\

-										\

-  static inline void HAL_GPIO_##name##_clr(void)				\

-  {										\

-    PORT->Group[HAL_GPIO_PORT##port].OUTCLR.reg = (1 << pin);			\

-    (void)HAL_GPIO_##name##_clr;						\

-  }										\

-										\

-  static inline void HAL_GPIO_##name##_toggle(void)				\

-  {										\

-    PORT->Group[HAL_GPIO_PORT##port].OUTTGL.reg = (1 << pin);			\

-    (void)HAL_GPIO_##name##_toggle;						\

-  }										\

-										\

-  static inline void HAL_GPIO_##name##_write(int value)				\

-  {										\

-    if (value)									\

-      PORT->Group[HAL_GPIO_PORT##port].OUTSET.reg = (1 << pin);			\

-    else									\

-      PORT->Group[HAL_GPIO_PORT##port].OUTCLR.reg = (1 << pin);			\

-    (void)HAL_GPIO_##name##_write;						\

-  }										\

-										\

-  static inline void HAL_GPIO_##name##_in(void)					\

-  {										\

-    PORT->Group[HAL_GPIO_PORT##port].DIRCLR.reg = (1 << pin);			\

-    PORT->Group[HAL_GPIO_PORT##port].PINCFG[pin].reg |= PORT_PINCFG_INEN;	\

-    PORT->Group[HAL_GPIO_PORT##port].PINCFG[pin].reg &= ~PORT_PINCFG_PULLEN;	\

-    (void)HAL_GPIO_##name##_in;							\

-  }										\

-										\

-  static inline void HAL_GPIO_##name##_out(void)				\

-  {										\

-    PORT->Group[HAL_GPIO_PORT##port].DIRSET.reg = (1 << pin);			\

-    PORT->Group[HAL_GPIO_PORT##port].PINCFG[pin].reg |= PORT_PINCFG_INEN;	\

-    (void)HAL_GPIO_##name##_out;						\

-  }										\

-										\

-  static inline void HAL_GPIO_##name##_pullup(void)				\

-  {										\

-    PORT->Group[HAL_GPIO_PORT##port].OUTSET.reg = (1 << pin);			\

-    PORT->Group[HAL_GPIO_PORT##port].PINCFG[pin].reg |= PORT_PINCFG_PULLEN;	\

-    (void)HAL_GPIO_##name##_pullup;						\

-  }										\

-										\

-  static inline int HAL_GPIO_##name##_read(void)				\

-  {										\

-    return (PORT->Group[HAL_GPIO_PORT##port].IN.reg & (1 << pin)) != 0;		\

-    (void)HAL_GPIO_##name##_read;						\

-  }										\

-										\

-  static inline int HAL_GPIO_##name##_state(void)				\

-  {										\

-    return (PORT->Group[HAL_GPIO_PORT##port].DIR.reg & (1 << pin)) != 0;	\

-    (void)HAL_GPIO_##name##_state;						\

-  }										\

-										\

-  static inline void HAL_GPIO_##name##_pmuxen(int mux)				\

-  {										\

-    PORT->Group[HAL_GPIO_PORT##port].PINCFG[pin].reg |= PORT_PINCFG_PMUXEN;	\

-    if (pin & 1)								\

-      PORT->Group[HAL_GPIO_PORT##port].PMUX[pin>>1].bit.PMUXO = mux;		\

-    else									\

-      PORT->Group[HAL_GPIO_PORT##port].PMUX[pin>>1].bit.PMUXE = mux;		\

-    (void)HAL_GPIO_##name##_pmuxen;						\

-  }										\

-										\

-  static inline void HAL_GPIO_##name##_pmuxdis(void)				\

-  {										\

-    PORT->Group[HAL_GPIO_PORT##port].PINCFG[pin].reg &= ~PORT_PINCFG_PMUXEN;	\

-    (void)HAL_GPIO_##name##_pmuxdis;						\

-  }										\

-

-#endif // _HAL_GPIO_H_

-

diff --git a/watch-library/main.c b/watch-library/main.c
index b9a5320b..c23ceac6 100755
--- a/watch-library/main.c
+++ b/watch-library/main.c
@@ -1,30 +1,25 @@
 /*
- * Copyright (c) 2021, Joey Castillo
- * UART methods are Copyright (c) 2014-2017, Alex Taradov <alex@taradov.com>
- * All rights reserved.
+ * MIT License
  *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
+ * Copyright (c) 2021 Joey Castillo
  *
- * 1. Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- * 3. The name of the author may not be used to endorse or promote products
- *    derived from this software without specific prior written permission.
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
 //-----------------------------------------------------------------------------
@@ -35,53 +30,10 @@
 #include <stdio.h>
 #include "saml22.h"
 #include "hal_init.h"
-#include "peripheral_clk_config.h"
-#include "hal_gpio.h"
 #include "atmel_start_pins.h"
 #include "watch.h"
 
-//-----------------------------------------------------------------------------
-HAL_GPIO_PIN(UART_TX,   B, 0)
-
-//-----------------------------------------------------------------------------
-static void uart_init(uint32_t baud) {
-    uint64_t br = (uint64_t)65536 * (CONF_CPU_FREQUENCY - 16 * baud) / CONF_CPU_FREQUENCY;
-
-    HAL_GPIO_UART_TX_out();
-    HAL_GPIO_UART_TX_pmuxen(HAL_GPIO_PMUX_C);
-
-    MCLK->APBCMASK.reg |= MCLK_APBCMASK_SERCOM3;
-
-    GCLK->PCHCTRL[SERCOM3_GCLK_ID_CORE].reg = GCLK_PCHCTRL_GEN(0) | GCLK_PCHCTRL_CHEN;
-    while (0 == (GCLK->PCHCTRL[SERCOM3_GCLK_ID_CORE].reg & GCLK_PCHCTRL_CHEN));
-
-    SERCOM3->USART.CTRLA.reg =
-        SERCOM_USART_CTRLA_DORD | SERCOM_USART_CTRLA_MODE(1/*USART_INT_CLK*/) |
-        SERCOM_USART_CTRLA_RXPO(0/*PAD0*/) | SERCOM_USART_CTRLA_TXPO(1/*PAD2*/);
-
-    SERCOM3->USART.CTRLB.reg = SERCOM_USART_CTRLB_RXEN | SERCOM_USART_CTRLB_TXEN |
-        SERCOM_USART_CTRLB_CHSIZE(0/*8 bits*/);
-
-    SERCOM3->USART.BAUD.reg = (uint16_t)br;
-
-    SERCOM3->USART.CTRLA.reg |= SERCOM_USART_CTRLA_ENABLE;
-}
-
-//-----------------------------------------------------------------------------
-void uart_putc(char c) {
-    while (!(SERCOM3->USART.INTFLAG.reg & SERCOM_USART_INTFLAG_DRE));
-    SERCOM3->USART.DATA.reg = c;
-}
-
-//-----------------------------------------------------------------------------
-void uart_puts(char *s) {
-    while (*s) uart_putc(*s++);
-}
-
 int main(void) {
-    // Temporary, for debugging.
-    // uart_init(115200);
-
     // ASF code. Initialize the MCU with configuration options from Atmel Studio.
     init_mcu();
 
diff --git a/watch-library/watch/notes.h b/watch-library/watch/notes.h
index 95f2abbf..bc4a3fa2 100644
--- a/watch-library/watch/notes.h
+++ b/watch-library/watch/notes.h
@@ -1,3 +1,26 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020 Joey Castillo
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
 ////< @file notes.h
 
 /// @brief 108 notes for use with watch_buzzer_play_note
diff --git a/watch-library/watch/watch.c b/watch-library/watch/watch.c
index 811ebab6..659be1c5 100644
--- a/watch-library/watch/watch.c
+++ b/watch-library/watch/watch.c
@@ -1,4 +1,29 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2021 Joey Castillo
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
 #include "watch.h"
+#include "peripheral_clk_config.h"
 #include <stdlib.h>
 
 //////////////////////////////////////////////////////////////////////////////////////////
@@ -503,6 +528,69 @@ uint32_t watch_i2c_read32(int16_t addr, uint8_t reg) {
 }
 
 //////////////////////////////////////////////////////////////////////////////////////////
+// Debug UART
+
+/*
+ * UART methods are Copyright (c) 2014-2017, Alex Taradov <alex@taradov.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+void watch_enable_debug_uart(uint32_t baud) {
+    uint64_t br = (uint64_t)65536 * (CONF_CPU_FREQUENCY - 16 * baud) / CONF_CPU_FREQUENCY;
+
+    gpio_set_pin_direction(D1, GPIO_DIRECTION_IN);
+    gpio_set_pin_function(D1, PINMUX_PB00C_SERCOM3_PAD2);
+
+    MCLK->APBCMASK.reg |= MCLK_APBCMASK_SERCOM3;
+
+    GCLK->PCHCTRL[SERCOM3_GCLK_ID_CORE].reg = GCLK_PCHCTRL_GEN(0) | GCLK_PCHCTRL_CHEN;
+    while (0 == (GCLK->PCHCTRL[SERCOM3_GCLK_ID_CORE].reg & GCLK_PCHCTRL_CHEN));
+
+    SERCOM3->USART.CTRLA.reg =
+        SERCOM_USART_CTRLA_DORD | SERCOM_USART_CTRLA_MODE(1/*USART_INT_CLK*/) |
+        SERCOM_USART_CTRLA_RXPO(0/*PAD0*/) | SERCOM_USART_CTRLA_TXPO(1/*PAD2*/);
+
+    SERCOM3->USART.CTRLB.reg = SERCOM_USART_CTRLB_RXEN | SERCOM_USART_CTRLB_TXEN |
+        SERCOM_USART_CTRLB_CHSIZE(0/*8 bits*/);
+
+    SERCOM3->USART.BAUD.reg = (uint16_t)br;
+
+    SERCOM3->USART.CTRLA.reg |= SERCOM_USART_CTRLA_ENABLE;
+}
+
+void watch_debug_putc(char c) {
+    while (!(SERCOM3->USART.INTFLAG.reg & SERCOM_USART_INTFLAG_DRE));
+    SERCOM3->USART.DATA.reg = c;
+}
+
+void watch_debug_puts(char *s) {
+    while (*s) watch_debug_putc(*s++);
+}
+
+//////////////////////////////////////////////////////////////////////////////////////////
 // Deep Sleep
 
 static void extwake_callback(uint8_t reason) {
diff --git a/watch-library/watch/watch.h b/watch-library/watch/watch.h
index f5afacd5..2b8cd4e0 100644
--- a/watch-library/watch/watch.h
+++ b/watch-library/watch/watch.h
@@ -1,3 +1,26 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020 Joey Castillo
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
 /// @file watch.h
 
 #ifndef WATCH_H_
@@ -25,6 +48,7 @@
             - @ref gpio - This section covers functions related to general-purpose input and output signals.
             - @ref i2c - This section covers functions related to the SAM L22's built-I2C driver, including configuring
                          the I2C bus, putting values directly on the bus and reading data from registers on I2C devices.
+            - @ref debug - This section covers functions related to the debug UART, available on pin D1 of the 9-pin connector.
             - @ref deepsleep - This section covers functions related to preparing for and entering BACKUP mode, the
                                deepest sleep mode available on the SAM L22.
  */
@@ -470,6 +494,28 @@ uint32_t watch_i2c_read24(int16_t addr, uint8_t reg);
 uint32_t watch_i2c_read32(int16_t addr, uint8_t reg);
 /// @}
 
+/** @addtogroup debug Debug UART
+  * @brief This section covers functions related to the debug UART, available on
+  *        pin D1 of the 9-pin connector.
+  * @todo Refactor this as a USB CDC so that folks can debug over USB.
+  */
+/// @{
+/** @brief Initializes the debug UART.
+  * @param baud The baud rate
+  */
+void watch_enable_debug_uart(uint32_t baud);
+
+/** @brief Outputs a single character on the debug UART.
+  * @param c The character you wish to output.
+  */
+void watch_debug_putc(char c);
+
+/** @brief Outputs a string on the debug UART.
+  * @param s A null-terminated string.
+  */
+void watch_debug_puts(char *s);
+/// @}
+
 
 /** @addtogroup deepsleep Deep Sleep Control
   * @brief This section covers functions related to preparing for and entering BACKUP mode, the