From dd319debe873397169d6f477953fece4db79da7d Mon Sep 17 00:00:00 2001
From: Resaec <resaecscript@gmail.com>
Date: Sat, 28 Apr 2018 01:13:16 +0200
Subject: [PATCH] adding comment for uart_wait_idle to warn about a possible
 dead lock

---
 exosphere/src/uart.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/exosphere/src/uart.c b/exosphere/src/uart.c
index 9ca492f5b..ee1379f92 100644
--- a/exosphere/src/uart.c
+++ b/exosphere/src/uart.c
@@ -36,6 +36,7 @@ void uart_init(UartDevice dev, uint32_t baud) {
     uart->UART_ASR = 0;
 }
 
+/* This function blocks until the UART device (dev) is in the desired state (status). Make sure the desired state can be reached! */
 void uart_wait_idle(UartDevice dev, UartVendorStatus status) {
     while (!(get_uart_device(dev)->UART_VENDOR_STATUS & status)) {
         /* Wait */