cleanup com1 driver and doxygen

1 files changed, 16 insertions, 9 deletions

diff --git a/driver/serial.h b/driver/serial.h
index 2f287e6..2e10af8 100644
--- a/driver/serial.h
+++ b/driver/serial.h
@@ -1,11 +1,18 @@
-void serial_init() 
+/**
+ * @file
+ * Serial Port Driver for COM1
+ *
+ * https://wiki.osdev.org/Serial_Ports
+ *
+ * Call serial_init() once before reading and writing with serial_read()
+ * and serial_write(). Note that reading and writing might block.
+ */
 
-char serial_read() {
-int is_transmit_empty() {
-   return x86_inb(PORT + 5) & 0x20;
-}
+/** Initialize COM1 **/
+void serial_init();
+
+/** read one byte from COM1 (blocking) **/
+char serial_read();
  
-void serial_write(char a) {
-   while (is_transmit_empty() == 0);
-   x86_outb(PORT,a);
-}
+/** write one byte from COM1 (blocking) **/
+void serial_write(char a);