aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-05-20 15:10:21 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-05-20 15:10:21 -0400
commit9f3dad4fbb084671bd49887c5cb07194d9141381 (patch)
tree1d4a4bcfc61adecbda2df9c9df606e7acc5b8c34
parent3367ca825a8b53009b94ec06d0dc4b82c7525336 (diff)
downloadlibrambutan-9f3dad4fbb084671bd49887c5cb07194d9141381.tar.gz
librambutan-9f3dad4fbb084671bd49887c5cb07194d9141381.zip
usart.h: Doxygen.
-rw-r--r--libmaple/usart.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/libmaple/usart.h b/libmaple/usart.h
index 60ed0ac..9ba94bd 100644
--- a/libmaple/usart.h
+++ b/libmaple/usart.h
@@ -232,12 +232,12 @@ typedef struct usart_reg_map {
/** USART device type */
typedef struct usart_dev {
- usart_reg_map *regs;
- ring_buffer *rb;
- uint32 max_baud;
- uint8 rx_buf[USART_RX_BUF_SIZE];
- rcc_clk_id clk_id;
- nvic_irq_num irq_num;
+ usart_reg_map *regs; /**< Register map */
+ ring_buffer *rb; /**< RX ring buffer */
+ uint32 max_baud; /**< Maximum baud */
+ uint8 rx_buf[USART_RX_BUF_SIZE]; /**< Actual RX buffer used by rb */
+ rcc_clk_id clk_id; /**< RCC clock information */
+ nvic_irq_num irq_num; /**< USART NVIC interrupt */
} usart_dev;
extern usart_dev *USART1;