summaryrefslogtreecommitdiffstats
path: root/watch-library/watch/watch_uart.h
diff options
context:
space:
mode:
authorJoey Castillo <jose.castillo@gmail.com>2021-09-13 20:46:33 -0400
committerJoey Castillo <jose.castillo@gmail.com>2021-09-13 23:39:24 -0400
commit05c816960b0c3135349f794caf90761b1188d02b (patch)
tree9f2fa5e76615452eaab8d633c5188a713784c3b2 /watch-library/watch/watch_uart.h
parent5a53916f0e51f02aab6d892c87310e5730abce5c (diff)
downloadSensor-Watch-05c816960b0c3135349f794caf90761b1188d02b.tar.gz
Sensor-Watch-05c816960b0c3135349f794caf90761b1188d02b.tar.bz2
Sensor-Watch-05c816960b0c3135349f794caf90761b1188d02b.zip
deprecate debug UART
Diffstat (limited to 'watch-library/watch/watch_uart.h')
-rw-r--r--watch-library/watch/watch_uart.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/watch-library/watch/watch_uart.h b/watch-library/watch/watch_uart.h
index a26d60d2..3c4f7aef 100644
--- a/watch-library/watch/watch_uart.h
+++ b/watch-library/watch/watch_uart.h
@@ -26,21 +26,28 @@
/** @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.
- */
+ * @warning These functions were used early on in development, before the TinyUSB
+ * CDC was implemented. You can now print debug messages to the USB console
+ * using printf, rendering this bit irrelevant. These methods will likely
+ * be refactored out in the future, in favor of a more full-featured UART
+ * on the nine-pin connector.
+ **/
/// @{
/** @brief Initializes the debug UART.
* @param baud The baud rate
*/
+__attribute__((deprecated("Use printf to log debug messages over USB.")))
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.
*/
+__attribute__((deprecated("Use printf to log debug messages over USB.")))
void watch_debug_putc(char c);
/** @brief Outputs a string on the debug UART.
* @param s A null-terminated string.
*/
+__attribute__((deprecated("Use printf to log debug messages over USB.")))
void watch_debug_puts(char *s);
/// @}