diff --git a/drivers/avr/usart1.c b/drivers/avr/usart1.c index 005ba72..4e4349a 100644 --- a/drivers/avr/usart1.c +++ b/drivers/avr/usart1.c @@ -38,7 +38,7 @@ usart1_init (const usart1_cfg_t *cfg) } -/* Return non-zero if there is a character ready to be read. */ +/** Return non-zero if there is a character ready to be read. */ bool usart1_read_ready_p (void) { @@ -46,7 +46,7 @@ usart1_read_ready_p (void) } -/* Return non-zero if a character can be written without blocking. */ +/** Return non-zero if a character can be written without blocking. */ bool usart1_write_ready_p (void) { @@ -54,7 +54,7 @@ usart1_write_ready_p (void) } -/* Return non-zero if transmitter finished. */ +/** Return non-zero if transmitter finished. */ bool usart1_write_finished_p (void) { @@ -62,22 +62,19 @@ usart1_write_finished_p (void) } -/* Write character to USART1. */ -int8_t +/** Write character to USART1. This blocks until the character can be + written into transmit register. */ +void usart1_putc (char ch) { - if (ch == '\n') - usart1_putc ('\r'); - while (!usart1_write_ready_p ()) continue; UDR1 = ch; - return 1; } -/* Read character from USART1. This blocks until a character is read. */ +/** Read character from USART1. This blocks until a character is read. */ int8_t usart1_getc (void) { @@ -89,7 +86,7 @@ usart1_getc (void) } -/* Write string to USART1. This blocks until the string is written. */ +/** Write string to USART1. This blocks until the string is written. */ void usart1_puts (const char *str) { diff --git a/drivers/avr/usart1.h b/drivers/avr/usart1.h index 6eb14ff..d0bf26d 100644 --- a/drivers/avr/usart1.h +++ b/drivers/avr/usart1.h @@ -21,39 +21,39 @@ typedef struct usart1_cfg_struct #define USART1_BAUD_DIVISOR(BAUD_RATE) ((F_CPU / 16) / (BAUD_RATE)) -/* Return non-zero if there is a character ready to be read. */ +/** Return non-zero if there is a character ready to be read. */ bool usart1_read_ready_p (void); -/* Read character from USART1. This blocks if nothing is available to - read. */ +/** Read character from USART1. This blocks if nothing is available to + read. */ int8_t usart1_getc (void); -/* Return non-zero if a character can be written without blocking. */ +/** Return non-zero if a character can be written without blocking. */ bool usart1_write_ready_p (void); -/* Return non-zero if transmitter finished. */ +/** Return non-zero if transmitter finished. */ bool usart1_write_finished_p (void); -/* Write character to USART1. This returns zero if the character - could not be written. */ -int8_t +/** Write character to USART1. This blocks until the character can be + written into transmit register. */ +void usart1_putc (char ch); -/* Write string to USART1. */ +/** Write string to USART1. */ void usart1_puts (const char *str); -/* Initialise usart1 and set baud rate. */ +/** Initialise usart1 and set baud rate. */ uint8_t usart1_init (const usart1_cfg_t *cfg);