Documentation improvements, fixed a small error in the STM32 serial driver.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2234 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 32 insertions, 0 deletions

diff --git a/os/hal/platforms/STM32/uart_lld.c b/os/hal/platforms/STM32/uart_lld.c
index 99373a401..0d9c533f1 100644
--- a/os/hal/platforms/STM32/uart_lld.c
+++ b/os/hal/platforms/STM32/uart_lld.c
@@ -225,6 +225,8 @@ static void serve_usart_irq(UARTDriver *uartp) {
 #if STM32_UART_USE_USART1 || defined(__DOXYGEN__)

 /**

  * @brief   USART1 RX DMA interrupt handler (channel 5).

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(DMA1_Ch5_IRQHandler) {

   UARTDriver *uartp;

@@ -256,6 +258,8 @@ CH_IRQ_HANDLER(DMA1_Ch5_IRQHandler) {
 

 /**

  * @brief   USART1 TX DMA interrupt handler (channel 4).

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(DMA1_Ch4_IRQHandler) {

 

@@ -273,6 +277,8 @@ CH_IRQ_HANDLER(DMA1_Ch4_IRQHandler) {
 

 /**

  * @brief   USART1 IRQ handler.

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(USART1_IRQHandler) {

 

@@ -287,6 +293,8 @@ CH_IRQ_HANDLER(USART1_IRQHandler) {
 #if STM32_UART_USE_USART2 || defined(__DOXYGEN__)

 /**

  * @brief   USART2 RX DMA interrupt handler (channel 6).

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(DMA1_Ch6_IRQHandler) {

   UARTDriver *uartp;

@@ -318,6 +326,8 @@ CH_IRQ_HANDLER(DMA1_Ch6_IRQHandler) {
 

 /**

  * @brief   USART2 TX DMA interrupt handler (channel 7).

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(DMA1_Ch7_IRQHandler) {

 

@@ -335,6 +345,8 @@ CH_IRQ_HANDLER(DMA1_Ch7_IRQHandler) {
 

 /**

  * @brief   USART2 IRQ handler.

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(USART2_IRQHandler) {

 

@@ -349,6 +361,8 @@ CH_IRQ_HANDLER(USART2_IRQHandler) {
 #if STM32_UART_USE_USART3 || defined(__DOXYGEN__)

 /**

  * @brief   USART3 RX DMA interrupt handler (channel 3).

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(DMA1_Ch3_IRQHandler) {

   UARTDriver *uartp;

@@ -380,6 +394,8 @@ CH_IRQ_HANDLER(DMA1_Ch3_IRQHandler) {
 

 /**

  * @brief   USART3 TX DMA interrupt handler (channel 2).

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(DMA1_Ch2_IRQHandler) {

 

@@ -397,6 +413,8 @@ CH_IRQ_HANDLER(DMA1_Ch2_IRQHandler) {
 

 /**

  * @brief   USART3 IRQ handler.

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(USART3_IRQHandler) {

 

@@ -414,6 +432,8 @@ CH_IRQ_HANDLER(USART3_IRQHandler) {
 

 /**

  * @brief   Low level UART driver initialization.

+ *

+ * @notapi

  */

 void uart_lld_init(void) {

 

@@ -455,6 +475,8 @@ void uart_lld_init(void) {
  * @brief   Configures and activates the UART peripheral.

  *

  * @param[in] uartp     pointer to the @p UARTDriver object

+ *

+ * @notapi

  */

 void uart_lld_start(UARTDriver *uartp) {

 

@@ -519,6 +541,8 @@ void uart_lld_start(UARTDriver *uartp) {
  * @brief   Deactivates the UART peripheral.

  *

  * @param[in] uartp     pointer to the @p UARTDriver object

+ *

+ * @notapi

  */

 void uart_lld_stop(UARTDriver *uartp) {

 

@@ -568,6 +592,8 @@ void uart_lld_stop(UARTDriver *uartp) {
  * @param[in] uartp     pointer to the @p UARTDriver object

  * @param[in] n         number of data frames to send

  * @param[in] txbuf     the pointer to the transmit buffer

+ *

+ * @notapi

  */

 void uart_lld_start_send(UARTDriver *uartp, size_t n, const void *txbuf) {

 

@@ -586,6 +612,8 @@ void uart_lld_start_send(UARTDriver *uartp, size_t n, const void *txbuf) {
  *

  * @return              The number of data frames not transmitted by the

  *                      stopped transmit operation.

+ *

+ * @notapi

  */

 size_t uart_lld_stop_send(UARTDriver *uartp) {

 

@@ -602,6 +630,8 @@ size_t uart_lld_stop_send(UARTDriver *uartp) {
  * @param[in] uartp     pointer to the @p UARTDriver object

  * @param[in] n         number of data frames to send

  * @param[in] rxbuf     the pointer to the receive buffer

+ *

+ * @notapi

  */

 void uart_lld_start_receive(UARTDriver *uartp, size_t n, void *rxbuf) {

 

@@ -624,6 +654,8 @@ void uart_lld_start_receive(UARTDriver *uartp, size_t n, void *rxbuf) {
  *

  * @return              The number of data frames not received by the

  *                      stopped receive operation.

+ *

+ * @notapi

  */

 size_t uart_lld_stop_receive(UARTDriver *uartp) {

   size_t n;