move debug uart methods, clarify license info

1 files changed, 46 insertions, 0 deletions

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