aboutsummaryrefslogtreecommitdiff
path: root/docs/references/usart.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/references/usart.md')
-rw-r--r--docs/references/usart.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/references/usart.md b/docs/references/usart.md
new file mode 100644
index 0000000..22e54ab
--- /dev/null
+++ b/docs/references/usart.md
@@ -0,0 +1,23 @@
+Universal synchronous/asynchronous receive/transmitter
+======================================================
+This part acts as UART intended as text base interface with computer. It is
+using hardware termed as USART by Atmel. This hardware also supports synchronous
+communication and can behave as SPI master, but this is not supported by this
+library (I don't require this feature, but implementation is welcomed).
+
+This part implements, if enabled, whole stack for binding input and output to
+stdin and stdout. This is handy during development. You can use `printf` and
+`scanf` directly.
+
+This part can be enabled by `CONFIG_USART` configuration option. This enables
+more detailed configuration in sub-menu.
+
+## Usage
+
+
+## References
+### usart_init_async
+```C
+void usart_init_async(void)
+```
+