From 5f9cb6faf40dec46092474446e3590e381c3ca1b Mon Sep 17 00:00:00 2001 From: Nathan Hartman <59230071+hartmannathan@users.noreply.github.com> Date: Mon, 6 Feb 2023 11:40:07 -0500 Subject: [PATCH] drivers/serial: Fix docstrings on UART interrupt handlers --- arch/arm/src/a1x/a1x_serial.c | 6 +++--- arch/arm/src/am335x/am335x_serial.c | 6 +++--- arch/arm/src/c5471/c5471_serial.c | 11 +++++----- arch/arm/src/cxd56xx/cxd56_serial.c | 6 +++--- arch/arm/src/dm320/dm320_serial.c | 11 +++++----- arch/arm/src/eoss3/eoss3_serial.c | 8 ++++--- arch/arm/src/gd32f4/gd32f4xx_serial.c | 8 +++---- arch/arm/src/imx1/imx_serial.c | 11 +++++----- arch/arm/src/imx6/imx_serial.c | 8 ++++--- arch/arm/src/imxrt/imxrt_serial.c | 8 ++++--- arch/arm/src/kinetis/kinetis_lpserial.c | 10 ++++----- arch/arm/src/kinetis/kinetis_serial.c | 8 +++---- arch/arm/src/kl/kl_serial.c | 8 +++---- arch/arm/src/lc823450/lc823450_serial.c | 11 +++++----- arch/arm/src/lpc17xx_40xx/lpc17_40_serial.c | 6 +++--- arch/arm/src/lpc214x/lpc214x_serial.c | 11 +++++----- arch/arm/src/lpc2378/lpc23xx_serial.c | 11 +++++----- arch/arm/src/lpc31xx/lpc31_serial.c | 6 ++++-- arch/arm/src/lpc43xx/lpc43_serial.c | 6 +++--- arch/arm/src/lpc54xx/lpc54_serial.c | 8 +++---- .../src/max326xx/max32660/max32660_serial.c | 8 ++++--- arch/arm/src/nrf52/nrf52_serial.c | 8 +++---- arch/arm/src/nrf53/nrf53_serial.c | 8 +++---- arch/arm/src/nuc1xx/nuc_serial.c | 6 +++--- arch/arm/src/phy62xx/uart.c | 8 +++---- arch/arm/src/rp2040/rp2040_serial.c | 6 +++--- arch/arm/src/rtl8720c/ameba_uart.c | 8 +++---- arch/arm/src/s32k1xx/s32k1xx_serial.c | 8 ++++--- arch/arm/src/s32k3xx/s32k3xx_serial.c | 8 ++++--- arch/arm/src/sam34/sam_serial.c | 6 +++--- arch/arm/src/sama5/sam_dbgu.c | 6 +++--- arch/arm/src/sama5/sam_flexcom_serial.c | 8 ++++--- arch/arm/src/sama5/sam_serial.c | 8 ++++--- arch/arm/src/samd2l2/sam_serial.c | 6 +++--- arch/arm/src/samd5e5/sam_serial.c | 6 +++--- arch/arm/src/samv7/sam_serial.c | 8 ++++--- arch/arm/src/stm32/stm32_hciuart.c | 12 +++++------ arch/arm/src/stm32/stm32_serial.c | 8 +++---- arch/arm/src/stm32f0l0g0/stm32_serial_v1.c | 8 +++---- arch/arm/src/stm32f0l0g0/stm32_serial_v2.c | 6 +++--- arch/arm/src/stm32f7/stm32_serial.c | 6 +++--- arch/arm/src/stm32h7/stm32_serial.c | 6 +++--- arch/arm/src/stm32l4/stm32l4_serial.c | 6 +++--- arch/arm/src/stm32l5/stm32l5_serial.c | 6 +++--- arch/arm/src/stm32u5/stm32_serial.c | 6 +++--- arch/arm/src/stm32wb/stm32wb_serial.c | 6 +++--- arch/arm/src/stm32wl5/stm32wl5_serial.c | 6 +++--- arch/arm/src/str71x/str71x_serial.c | 11 +++++----- arch/arm/src/tiva/common/tiva_hciuart.c | 2 +- arch/arm/src/tiva/common/tiva_serial.c | 11 +++++----- arch/arm/src/tlsr82/tlsr82_serial.c | 8 +++---- arch/arm/src/xmc4/xmc4_serial.c | 8 +++---- arch/arm64/src/qemu/qemu_serial.c | 8 ++++--- arch/avr/src/at32uc3/at32uc3_serial.c | 6 +++--- arch/avr/src/at90usb/at90usb_serial.c | 2 +- arch/avr/src/atmega/atmega_serial.c | 2 +- arch/hc/src/m9s12/m9s12_serial.c | 11 +++++----- arch/mips/src/pic32mx/pic32mx_serial.c | 6 +++--- arch/mips/src/pic32mz/pic32mz_serial.c | 9 ++++---- arch/misoc/src/common/misoc_serial.c | 6 +++--- arch/renesas/src/m16c/m16c_serial.c | 21 +++++++++---------- arch/renesas/src/rx65n/rx65n_serial.c | 11 +++++----- arch/renesas/src/sh1/sh1_serial.c | 11 +++++----- arch/risc-v/src/bl602/bl602_serial.c | 6 +++--- arch/risc-v/src/c906/c906_serial.c | 6 +++--- arch/risc-v/src/esp32c3/esp32c3_serial.c | 2 +- arch/risc-v/src/esp32c3/esp32c3_usbserial.c | 9 ++++---- arch/risc-v/src/fe310/fe310_serial.c | 6 +++--- arch/risc-v/src/k210/k210_serial.c | 6 +++--- arch/risc-v/src/litex/litex_serial.c | 6 +++--- arch/risc-v/src/mpfs/mpfs_serial.c | 6 +++--- arch/risc-v/src/rv32m1/rv32m1_serial.c | 6 +++--- arch/sparc/src/bm3803/bm3803-serial.c | 8 +++---- arch/sparc/src/bm3823/bm3823-serial.c | 8 +++---- arch/sparc/src/s698pm/s698pm-serial.c | 8 +++---- arch/xtensa/src/esp32/esp32_serial.c | 9 ++++---- arch/xtensa/src/esp32s2/esp32s2_serial.c | 2 +- arch/xtensa/src/esp32s3/esp32s3_serial.c | 2 +- arch/xtensa/src/esp32s3/esp32s3_usbserial.c | 9 ++++---- arch/z80/src/ez80/ez80_serial.c | 11 +++++----- arch/z80/src/z180/z180_scc.c | 11 +++++----- drivers/serial/serial_io.c | 2 +- drivers/serial/uart_16550.c | 8 +++---- include/nuttx/serial/serial.h | 2 +- 84 files changed, 319 insertions(+), 307 deletions(-) diff --git a/arch/arm/src/a1x/a1x_serial.c b/arch/arm/src/a1x/a1x_serial.c index 2ac2c00185..083d0912ab 100644 --- a/arch/arm/src/a1x/a1x_serial.c +++ b/arch/arm/src/a1x/a1x_serial.c @@ -1060,9 +1060,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/am335x/am335x_serial.c b/arch/arm/src/am335x/am335x_serial.c index 577bf673c6..fab19cbbc6 100644 --- a/arch/arm/src/am335x/am335x_serial.c +++ b/arch/arm/src/am335x/am335x_serial.c @@ -887,9 +887,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/c5471/c5471_serial.c b/arch/arm/src/c5471/c5471_serial.c index 6800c915cb..394b5bea0e 100644 --- a/arch/arm/src/c5471/c5471_serial.c +++ b/arch/arm/src/c5471/c5471_serial.c @@ -516,12 +516,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the UART interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/cxd56xx/cxd56_serial.c b/arch/arm/src/cxd56xx/cxd56_serial.c index d28b6f0158..3d0a917733 100644 --- a/arch/arm/src/cxd56xx/cxd56_serial.c +++ b/arch/arm/src/cxd56xx/cxd56_serial.c @@ -646,9 +646,9 @@ static bool up_rxflowcontrol(struct uart_dev_s *dev, * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/dm320/dm320_serial.c b/arch/arm/src/dm320/dm320_serial.c index a906b318d2..01d70362a6 100644 --- a/arch/arm/src/dm320/dm320_serial.c +++ b/arch/arm/src/dm320/dm320_serial.c @@ -449,12 +449,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the UART interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/eoss3/eoss3_serial.c b/arch/arm/src/eoss3/eoss3_serial.c index 0db9ee852f..0800c9353a 100644 --- a/arch/arm/src/eoss3/eoss3_serial.c +++ b/arch/arm/src/eoss3/eoss3_serial.c @@ -312,9 +312,11 @@ static void eoss3_detach(struct uart_dev_s *dev) * Name: eoss3_interrupt * * Description: - * This is the common UART interrupt handler. It should call - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/gd32f4/gd32f4xx_serial.c b/arch/arm/src/gd32f4/gd32f4xx_serial.c index a444464f93..44c2b877cd 100644 --- a/arch/arm/src/gd32f4/gd32f4xx_serial.c +++ b/arch/arm/src/gd32f4/gd32f4xx_serial.c @@ -1637,10 +1637,10 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the UART status interrupt handler. It will be invoked when an - * interrupt received on the 'irq'. It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/imx1/imx_serial.c b/arch/arm/src/imx1/imx_serial.c index be538189b9..ea8d1fff0e 100644 --- a/arch/arm/src/imx1/imx_serial.c +++ b/arch/arm/src/imx1/imx_serial.c @@ -802,12 +802,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt (and front-ends) * * Description: - * This is the UART interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/imx6/imx_serial.c b/arch/arm/src/imx6/imx_serial.c index 109a398965..5ddfce8c52 100644 --- a/arch/arm/src/imx6/imx_serial.c +++ b/arch/arm/src/imx6/imx_serial.c @@ -625,9 +625,11 @@ static void imx_detach(struct uart_dev_s *dev) * Name: imx_interrupt (and front-ends) * * Description: - * This is the common UART interrupt handler. It should cal - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/imxrt/imxrt_serial.c b/arch/arm/src/imxrt/imxrt_serial.c index e95ae4f4a2..fcf14e51df 100644 --- a/arch/arm/src/imxrt/imxrt_serial.c +++ b/arch/arm/src/imxrt/imxrt_serial.c @@ -1734,9 +1734,11 @@ static void imxrt_detach(struct uart_dev_s *dev) * Name: imxrt_interrupt (and front-ends) * * Description: - * This is the common UART interrupt handler. It should call - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate imxrt_uart_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_lpserial.c b/arch/arm/src/kinetis/kinetis_lpserial.c index 4aa0d388b0..1ebc196295 100644 --- a/arch/arm/src/kinetis/kinetis_lpserial.c +++ b/arch/arm/src/kinetis/kinetis_lpserial.c @@ -995,11 +995,11 @@ static void kinetis_detach(struct uart_dev_s *dev) * Name: kinetis_interrupts * * Description: - * This is the LPUART status interrupt handler. It will be invoked when - * an interrupt received on the 'irq' It should call uart_transmitchars - * or uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the - * Appropriate uart_dev_s structure in order to call these functions. + * This is the LPUART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_serial.c b/arch/arm/src/kinetis/kinetis_serial.c index 7767147abd..78bcd357a3 100644 --- a/arch/arm/src/kinetis/kinetis_serial.c +++ b/arch/arm/src/kinetis/kinetis_serial.c @@ -1159,10 +1159,10 @@ static int up_interrupt(int irq, void *context, void *arg) * Name: up_interrupts * * Description: - * This is the UART status interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/kl/kl_serial.c b/arch/arm/src/kl/kl_serial.c index 0ad393a9dd..c80f18ec9d 100644 --- a/arch/arm/src/kl/kl_serial.c +++ b/arch/arm/src/kl/kl_serial.c @@ -482,10 +482,10 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupts * * Description: - * This is the UART status interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/lc823450/lc823450_serial.c b/arch/arm/src/lc823450/lc823450_serial.c index 70299fdcf9..a927dd8af9 100644 --- a/arch/arm/src/lc823450/lc823450_serial.c +++ b/arch/arm/src/lc823450/lc823450_serial.c @@ -654,12 +654,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the UART interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/lpc17xx_40xx/lpc17_40_serial.c b/arch/arm/src/lpc17xx_40xx/lpc17_40_serial.c index 5492ada786..334201de05 100644 --- a/arch/arm/src/lpc17xx_40xx/lpc17_40_serial.c +++ b/arch/arm/src/lpc17xx_40xx/lpc17_40_serial.c @@ -1201,9 +1201,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/lpc214x/lpc214x_serial.c b/arch/arm/src/lpc214x/lpc214x_serial.c index 1d2a29e48f..135b486d56 100644 --- a/arch/arm/src/lpc214x/lpc214x_serial.c +++ b/arch/arm/src/lpc214x/lpc214x_serial.c @@ -436,12 +436,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the UART interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/lpc2378/lpc23xx_serial.c b/arch/arm/src/lpc2378/lpc23xx_serial.c index fd92b5ef1d..9ec1c1d8b7 100644 --- a/arch/arm/src/lpc2378/lpc23xx_serial.c +++ b/arch/arm/src/lpc2378/lpc23xx_serial.c @@ -572,12 +572,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the UART interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/lpc31xx/lpc31_serial.c b/arch/arm/src/lpc31xx/lpc31_serial.c index 71b4b07e47..b2fd1eaede 100644 --- a/arch/arm/src/lpc31xx/lpc31_serial.c +++ b/arch/arm/src/lpc31xx/lpc31_serial.c @@ -462,8 +462,10 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the UART irq. It should call uart_transmitchars - * or uart_receivechar to perform the appropriate data transfers. + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_serial.c b/arch/arm/src/lpc43xx/lpc43_serial.c index 13904d2054..4cb9657a1c 100644 --- a/arch/arm/src/lpc43xx/lpc43_serial.c +++ b/arch/arm/src/lpc43xx/lpc43_serial.c @@ -687,9 +687,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_serial.c b/arch/arm/src/lpc54xx/lpc54_serial.c index 8b07997366..8dd0906b6c 100644 --- a/arch/arm/src/lpc54xx/lpc54_serial.c +++ b/arch/arm/src/lpc54xx/lpc54_serial.c @@ -1041,10 +1041,10 @@ static void lpc54_detach(struct uart_dev_s *dev) * Name: lpc54_interrupt * * Description: - * This is the USART status interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * This is the USART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/max326xx/max32660/max32660_serial.c b/arch/arm/src/max326xx/max32660/max32660_serial.c index bf6699a929..9eed0333bd 100644 --- a/arch/arm/src/max326xx/max32660/max32660_serial.c +++ b/arch/arm/src/max326xx/max32660/max32660_serial.c @@ -459,9 +459,11 @@ static void max326_detach(struct uart_dev_s *dev) * Name: max326_interrupt * * Description: - * This is the UART status interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/nrf52/nrf52_serial.c b/arch/arm/src/nrf52/nrf52_serial.c index b667e0fee8..37e904239a 100644 --- a/arch/arm/src/nrf52/nrf52_serial.c +++ b/arch/arm/src/nrf52/nrf52_serial.c @@ -376,10 +376,10 @@ static void nrf52_detach(struct uart_dev_s *dev) * Name: nrf52_interrupt * * Description: - * This is the UART status interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/nrf53/nrf53_serial.c b/arch/arm/src/nrf53/nrf53_serial.c index cfa2c4d8ce..255e5dcfeb 100644 --- a/arch/arm/src/nrf53/nrf53_serial.c +++ b/arch/arm/src/nrf53/nrf53_serial.c @@ -376,10 +376,10 @@ static void nrf53_detach(struct uart_dev_s *dev) * Name: nrf53_interrupt * * Description: - * This is the UART status interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/nuc1xx/nuc_serial.c b/arch/arm/src/nuc1xx/nuc_serial.c index 34016e1342..d4ca40de10 100644 --- a/arch/arm/src/nuc1xx/nuc_serial.c +++ b/arch/arm/src/nuc1xx/nuc_serial.c @@ -593,9 +593,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/phy62xx/uart.c b/arch/arm/src/phy62xx/uart.c index 5884989c21..7526a16eaf 100644 --- a/arch/arm/src/phy62xx/uart.c +++ b/arch/arm/src/phy62xx/uart.c @@ -727,10 +727,10 @@ static void pplus_uart_detach(struct uart_dev_s *dev) * Name: pplus_uart_interrupt * * Description: - * This is the UART status interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/rp2040/rp2040_serial.c b/arch/arm/src/rp2040/rp2040_serial.c index 5c2f25aadf..4c99382c17 100644 --- a/arch/arm/src/rp2040/rp2040_serial.c +++ b/arch/arm/src/rp2040/rp2040_serial.c @@ -556,9 +556,9 @@ static bool up_rxflowcontrol(struct uart_dev_s *dev, * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/rtl8720c/ameba_uart.c b/arch/arm/src/rtl8720c/ameba_uart.c index cc629f8bf7..9a8915a338 100644 --- a/arch/arm/src/rtl8720c/ameba_uart.c +++ b/arch/arm/src/rtl8720c/ameba_uart.c @@ -693,10 +693,10 @@ static void ameba_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the - * appropriate ameba_s structure in order to call these functions. + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/s32k1xx/s32k1xx_serial.c b/arch/arm/src/s32k1xx/s32k1xx_serial.c index e7bc473b22..01f790e0c2 100644 --- a/arch/arm/src/s32k1xx/s32k1xx_serial.c +++ b/arch/arm/src/s32k1xx/s32k1xx_serial.c @@ -1031,9 +1031,11 @@ static void s32k1xx_detach(struct uart_dev_s *dev) * Name: s32k1xx_interrupt (and front-ends) * * Description: - * This is the common UART interrupt handler. It should cal - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * This is the common UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/s32k3xx/s32k3xx_serial.c b/arch/arm/src/s32k3xx/s32k3xx_serial.c index c34be77771..268fc72b30 100644 --- a/arch/arm/src/s32k3xx/s32k3xx_serial.c +++ b/arch/arm/src/s32k3xx/s32k3xx_serial.c @@ -3176,9 +3176,11 @@ static void s32k3xx_detach(struct uart_dev_s *dev) * Name: s32k3xx_interrupt (and front-ends) * * Description: - * This is the common UART interrupt handler. It should cal - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * This is the common UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_serial.c b/arch/arm/src/sam34/sam_serial.c index 9b48baf370..cf9b53aba9 100644 --- a/arch/arm/src/sam34/sam_serial.c +++ b/arch/arm/src/sam34/sam_serial.c @@ -901,9 +901,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_dbgu.c b/arch/arm/src/sama5/sam_dbgu.c index b36e81a045..a64105a8ec 100644 --- a/arch/arm/src/sama5/sam_dbgu.c +++ b/arch/arm/src/sama5/sam_dbgu.c @@ -305,9 +305,9 @@ static void dbgu_detach(struct uart_dev_s *dev) * * Description: * This is the DBGU interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_flexcom_serial.c b/arch/arm/src/sama5/sam_flexcom_serial.c index 9dc920ba18..ef2d6c6c14 100644 --- a/arch/arm/src/sama5/sam_flexcom_serial.c +++ b/arch/arm/src/sama5/sam_flexcom_serial.c @@ -494,9 +494,11 @@ static void flexus_disableallints(struct flexus_dev_s *priv, uint32_t *imr) * Name: flexus_interrupt * * Description: - * This is the common USART interrupt handler. It should call - * uart_transmitchars or uart_receivechar to perform the appropriate - * data transfers. + * This is the common USART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_serial.c b/arch/arm/src/sama5/sam_serial.c index 60387285a3..76a4daf1c1 100644 --- a/arch/arm/src/sama5/sam_serial.c +++ b/arch/arm/src/sama5/sam_serial.c @@ -930,9 +930,11 @@ static void up_disableallints(struct up_dev_s *priv, uint32_t *imr) * Name: up_interrupt * * Description: - * This is the common USART interrupt handler. It should call - * uart_transmitchars or uart_receivechar to perform the appropriate - * data transfers. + * This is the common USART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/samd2l2/sam_serial.c b/arch/arm/src/samd2l2/sam_serial.c index b71e0e5d34..3fd443b191 100644 --- a/arch/arm/src/samd2l2/sam_serial.c +++ b/arch/arm/src/samd2l2/sam_serial.c @@ -559,9 +559,9 @@ static void sam_disableallints(struct sam_dev_s *priv) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/samd5e5/sam_serial.c b/arch/arm/src/samd5e5/sam_serial.c index 0b72e55651..bfd460d92c 100644 --- a/arch/arm/src/samd5e5/sam_serial.c +++ b/arch/arm/src/samd5e5/sam_serial.c @@ -636,9 +636,9 @@ static void sam_disableallints(struct sam_dev_s *priv) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_serial.c b/arch/arm/src/samv7/sam_serial.c index b6cc019642..2f2327fdc7 100644 --- a/arch/arm/src/samv7/sam_serial.c +++ b/arch/arm/src/samv7/sam_serial.c @@ -1380,9 +1380,11 @@ static void sam_detach(struct uart_dev_s *dev) * * Description: * This is the common UART/USART interrupt handler. It will be invoked - * when an interrupt received on the device. It should call - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * when an interrupt is received on the 'irq'. It should call + * uart_xmitchars or uart_recvchars to perform the appropriate data + * transfers. The interrupt handling logic must be able to map the 'arg' + * to the appropriate uart_dev_s structure in order to call these + * functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_hciuart.c b/arch/arm/src/stm32/stm32_hciuart.c index 5b04310997..788a1733b7 100644 --- a/arch/arm/src/stm32/stm32_hciuart.c +++ b/arch/arm/src/stm32/stm32_hciuart.c @@ -1707,12 +1707,12 @@ static int hciuart_configure(const struct hciuart_config_s *config) * Name: hciuart_interrupt * * Description: - * This is the USART interrupt callback. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the - * appropriate btuart_lowerhalf_s structure in order to call these - * functions. + * This is the HCIUART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call + * hciuart_copytotxfifo or hciuart_copytorxbuffer to perform the + * appropriate data transfers. The interrupt handling logic must be able + * to map the 'arg' to the appropriate hciuart_lowerhalf_s structure in + * order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_serial.c b/arch/arm/src/stm32/stm32_serial.c index 0742c92337..1bca0dd73c 100644 --- a/arch/arm/src/stm32/stm32_serial.c +++ b/arch/arm/src/stm32/stm32_serial.c @@ -2078,10 +2078,10 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32f0l0g0/stm32_serial_v1.c b/arch/arm/src/stm32f0l0g0/stm32_serial_v1.c index b6cd9e6d9b..8f623a860c 100644 --- a/arch/arm/src/stm32f0l0g0/stm32_serial_v1.c +++ b/arch/arm/src/stm32f0l0g0/stm32_serial_v1.c @@ -1438,10 +1438,10 @@ static void stm32serial_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the - * appropriate uart_dev_s structure in order to call these functions. + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate stm32_serial_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32f0l0g0/stm32_serial_v2.c b/arch/arm/src/stm32f0l0g0/stm32_serial_v2.c index ee3ba1558b..7c6f9e8e5a 100644 --- a/arch/arm/src/stm32f0l0g0/stm32_serial_v2.c +++ b/arch/arm/src/stm32f0l0g0/stm32_serial_v2.c @@ -1067,9 +1067,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_serial.c b/arch/arm/src/stm32f7/stm32_serial.c index ee2027a8b7..e14288bd44 100644 --- a/arch/arm/src/stm32f7/stm32_serial.c +++ b/arch/arm/src/stm32f7/stm32_serial.c @@ -2248,9 +2248,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32h7/stm32_serial.c b/arch/arm/src/stm32h7/stm32_serial.c index f1035c8f0e..ad0f500c89 100644 --- a/arch/arm/src/stm32h7/stm32_serial.c +++ b/arch/arm/src/stm32h7/stm32_serial.c @@ -2442,9 +2442,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_serial.c b/arch/arm/src/stm32l4/stm32l4_serial.c index ef04854896..792b49800e 100644 --- a/arch/arm/src/stm32l4/stm32l4_serial.c +++ b/arch/arm/src/stm32l4/stm32l4_serial.c @@ -1803,9 +1803,9 @@ static void stm32l4serial_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32l5/stm32l5_serial.c b/arch/arm/src/stm32l5/stm32l5_serial.c index 6b57caaf1b..a54a36b6b9 100644 --- a/arch/arm/src/stm32l5/stm32l5_serial.c +++ b/arch/arm/src/stm32l5/stm32l5_serial.c @@ -1738,9 +1738,9 @@ static void stm32l5serial_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32u5/stm32_serial.c b/arch/arm/src/stm32u5/stm32_serial.c index e0122d46e8..d044c32fab 100644 --- a/arch/arm/src/stm32u5/stm32_serial.c +++ b/arch/arm/src/stm32u5/stm32_serial.c @@ -1738,9 +1738,9 @@ static void stm32serial_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32wb/stm32wb_serial.c b/arch/arm/src/stm32wb/stm32wb_serial.c index dd6a6ef810..f5176e4fd0 100644 --- a/arch/arm/src/stm32wb/stm32wb_serial.c +++ b/arch/arm/src/stm32wb/stm32wb_serial.c @@ -1426,9 +1426,9 @@ static void stm32wb_serial_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/stm32wl5/stm32wl5_serial.c b/arch/arm/src/stm32wl5/stm32wl5_serial.c index 8d087aeaeb..a5ab7b5c3a 100644 --- a/arch/arm/src/stm32wl5/stm32wl5_serial.c +++ b/arch/arm/src/stm32wl5/stm32wl5_serial.c @@ -1491,9 +1491,9 @@ static void stm32wl5serial_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/str71x/str71x_serial.c b/arch/arm/src/str71x/str71x_serial.c index b9d7dcd267..4dc08baa21 100644 --- a/arch/arm/src/str71x/str71x_serial.c +++ b/arch/arm/src/str71x/str71x_serial.c @@ -631,12 +631,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the UART interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/tiva/common/tiva_hciuart.c b/arch/arm/src/tiva/common/tiva_hciuart.c index e32ae9cad4..51c7eb3a7a 100644 --- a/arch/arm/src/tiva/common/tiva_hciuart.c +++ b/arch/arm/src/tiva/common/tiva_hciuart.c @@ -1098,7 +1098,7 @@ static int hciuart_configure(const struct hciuart_config_s *config) * * Description: * This is the UART interrupt callback. It will be invoked when an - * interrupt received on the 'irq' It should call hciuart_copytorxbuffer + * interrupt received on the 'irq'. It should call hciuart_copytorxbuffer * or hciuart_copytotxfifo to perform the appropriate data transfers. The * interrupt handling logic must be able to map the 'irq' number into the * appropriate btuart_lowerhalf_s structure in order to call these diff --git a/arch/arm/src/tiva/common/tiva_serial.c b/arch/arm/src/tiva/common/tiva_serial.c index 220ff827fc..6e4ff4a6ab 100644 --- a/arch/arm/src/tiva/common/tiva_serial.c +++ b/arch/arm/src/tiva/common/tiva_serial.c @@ -1032,12 +1032,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the UART interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/tlsr82/tlsr82_serial.c b/arch/arm/src/tlsr82/tlsr82_serial.c index 2aa0d99347..54fc0ba0a9 100644 --- a/arch/arm/src/tlsr82/tlsr82_serial.c +++ b/arch/arm/src/tlsr82/tlsr82_serial.c @@ -1069,10 +1069,10 @@ static void tlsr82_uart_shutdown(struct uart_dev_s *dev) * Name: tlsr82_uart_interrupt * * Description: - * This is the UART status interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm/src/xmc4/xmc4_serial.c b/arch/arm/src/xmc4/xmc4_serial.c index b5aaf80367..30b6662e97 100644 --- a/arch/arm/src/xmc4/xmc4_serial.c +++ b/arch/arm/src/xmc4/xmc4_serial.c @@ -723,10 +723,10 @@ static void xmc4_detach(struct uart_dev_s *dev) * Name: xmc4_interrupt * * Description: - * This is the UART status interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/arm64/src/qemu/qemu_serial.c b/arch/arm64/src/qemu/qemu_serial.c index 33f628648c..4af6611e24 100644 --- a/arch/arm64/src/qemu/qemu_serial.c +++ b/arch/arm64/src/qemu/qemu_serial.c @@ -536,9 +536,11 @@ static int qemu_pl011_ioctl(struct file *filep, int cmd, unsigned long arg) * Name: qemu_pl011_irq_handler (and front-ends) * * Description: - * This is the common UART interrupt handler. It should cal - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ***************************************************************************/ diff --git a/arch/avr/src/at32uc3/at32uc3_serial.c b/arch/avr/src/at32uc3/at32uc3_serial.c index c6a2141f01..a8ddca1507 100644 --- a/arch/avr/src/at32uc3/at32uc3_serial.c +++ b/arch/avr/src/at32uc3/at32uc3_serial.c @@ -419,9 +419,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the USART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/avr/src/at90usb/at90usb_serial.c b/arch/avr/src/at90usb/at90usb_serial.c index 3518bf35f1..22325768a1 100644 --- a/arch/avr/src/at90usb/at90usb_serial.c +++ b/arch/avr/src/at90usb/at90usb_serial.c @@ -266,7 +266,7 @@ static void usart1_detach(struct uart_dev_s *dev) * * Description: * This is the USART RX interrupt handler. It will be invoked when an - * RX interrupt received. It will call uart_receivechar to perform the RX + * RX interrupt received. It will call uart_recvchars to perform the RX * data transfers. * ****************************************************************************/ diff --git a/arch/avr/src/atmega/atmega_serial.c b/arch/avr/src/atmega/atmega_serial.c index 8525de510d..3df940c582 100644 --- a/arch/avr/src/atmega/atmega_serial.c +++ b/arch/avr/src/atmega/atmega_serial.c @@ -448,7 +448,7 @@ static void usart1_detach(struct uart_dev_s *dev) * * Description: * This is the USART RX interrupt handler. It will be invoked when an - * RX interrupt received. It will call uart_receivechar to perform the RX + * RX interrupt received. It will call uart_recvchars to perform the RX * data transfers. * ****************************************************************************/ diff --git a/arch/hc/src/m9s12/m9s12_serial.c b/arch/hc/src/m9s12/m9s12_serial.c index 0e2c303998..5f9017a50a 100644 --- a/arch/hc/src/m9s12/m9s12_serial.c +++ b/arch/hc/src/m9s12/m9s12_serial.c @@ -446,12 +446,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the SCI interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the SCI interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/mips/src/pic32mx/pic32mx_serial.c b/arch/mips/src/pic32mx/pic32mx_serial.c index 850ac8fe00..efa144696c 100644 --- a/arch/mips/src/pic32mx/pic32mx_serial.c +++ b/arch/mips/src/pic32mx/pic32mx_serial.c @@ -434,9 +434,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/mips/src/pic32mz/pic32mz_serial.c b/arch/mips/src/pic32mz/pic32mz_serial.c index f9b91230cb..655b563941 100644 --- a/arch/mips/src/pic32mz/pic32mz_serial.c +++ b/arch/mips/src/pic32mz/pic32mz_serial.c @@ -685,10 +685,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the common UART interrupt handler. It will be invoked when an - * interrupt received on a specific UART. It should call - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/misoc/src/common/misoc_serial.c b/arch/misoc/src/common/misoc_serial.c index 632e209bc4..ce52d18a77 100644 --- a/arch/misoc/src/common/misoc_serial.c +++ b/arch/misoc/src/common/misoc_serial.c @@ -328,9 +328,9 @@ static void misoc_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/renesas/src/m16c/m16c_serial.c b/arch/renesas/src/m16c/m16c_serial.c index 67bc75925e..151d01a236 100644 --- a/arch/renesas/src/m16c/m16c_serial.c +++ b/arch/renesas/src/m16c/m16c_serial.c @@ -748,11 +748,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_recvinterrupt * * Description: - * This is the UART receive interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_receivechar to - * perform the appropriate data transfer. The interrupt handling logic - * must be able to map the 'irq' number into the appropriate up_dev_s - * structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ @@ -891,12 +891,11 @@ static bool up_rxavailable(struct uart_dev_s *dev) * Name: up_xmtvinterrupt * * Description: - * This is the UART receive interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic - * must be able to map the 'irq' number into the appropriate - * up_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/renesas/src/rx65n/rx65n_serial.c b/arch/renesas/src/rx65n/rx65n_serial.c index 2a53126813..f4d3928d41 100644 --- a/arch/renesas/src/rx65n/rx65n_serial.c +++ b/arch/renesas/src/rx65n/rx65n_serial.c @@ -1259,12 +1259,11 @@ static int up_rcvinterrupt(int irq, void *context, void *arg) * Name: up_xmtinterrupt * * Description: - * This is the SCI interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * up_dev_s structure in order to call these functions. + * This is the SCI interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/renesas/src/sh1/sh1_serial.c b/arch/renesas/src/sh1/sh1_serial.c index cce3ce5173..b958c156a4 100644 --- a/arch/renesas/src/sh1/sh1_serial.c +++ b/arch/renesas/src/sh1/sh1_serial.c @@ -547,12 +547,11 @@ static void up_detach(struct uart_dev_s *dev) * Name: up_interrupt * * Description: - * This is the SCI interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * up_dev_s structure in order to call these functions. + * This is the SCI interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/risc-v/src/bl602/bl602_serial.c b/arch/risc-v/src/bl602/bl602_serial.c index 4787a6852c..8746da60e0 100644 --- a/arch/risc-v/src/bl602/bl602_serial.c +++ b/arch/risc-v/src/bl602/bl602_serial.c @@ -283,9 +283,9 @@ static struct uart_dev_s *const g_uart_devs[] = * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/risc-v/src/c906/c906_serial.c b/arch/risc-v/src/c906/c906_serial.c index e274c85ad0..e7e43837fb 100644 --- a/arch/risc-v/src/c906/c906_serial.c +++ b/arch/risc-v/src/c906/c906_serial.c @@ -352,9 +352,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/risc-v/src/esp32c3/esp32c3_serial.c b/arch/risc-v/src/esp32c3/esp32c3_serial.c index 693cfdb648..2e56e8441a 100644 --- a/arch/risc-v/src/esp32c3/esp32c3_serial.c +++ b/arch/risc-v/src/esp32c3/esp32c3_serial.c @@ -245,7 +245,7 @@ static uart_dev_t g_uart1_dev = * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt is received on the 'irq' It should call uart_xmitchars or + * interrupt is received on the 'irq'. It should call uart_xmitchars or * uart_recvchars to perform the appropriate data transfers. The * interrupt handling logic must be able to map the 'irq' number into the * appropriate uart_dev_s structure in order to call these functions. diff --git a/arch/risc-v/src/esp32c3/esp32c3_usbserial.c b/arch/risc-v/src/esp32c3/esp32c3_usbserial.c index fc63507ef7..8cbb3972df 100644 --- a/arch/risc-v/src/esp32c3/esp32c3_usbserial.c +++ b/arch/risc-v/src/esp32c3/esp32c3_usbserial.c @@ -147,10 +147,11 @@ uart_dev_t g_uart_usbserial = * Name: esp32c3_interrupt * * Description: - * This is the common UART interrupt handler. It will be invoked - * when an interrupt received on the device. It should call - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * This is the common UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/risc-v/src/fe310/fe310_serial.c b/arch/risc-v/src/fe310/fe310_serial.c index c7583185bd..5e04afabef 100644 --- a/arch/risc-v/src/fe310/fe310_serial.c +++ b/arch/risc-v/src/fe310/fe310_serial.c @@ -355,9 +355,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/risc-v/src/k210/k210_serial.c b/arch/risc-v/src/k210/k210_serial.c index b38a81eaf6..16cd880d9a 100644 --- a/arch/risc-v/src/k210/k210_serial.c +++ b/arch/risc-v/src/k210/k210_serial.c @@ -355,9 +355,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/risc-v/src/litex/litex_serial.c b/arch/risc-v/src/litex/litex_serial.c index 5e70282be2..21fc262a26 100644 --- a/arch/risc-v/src/litex/litex_serial.c +++ b/arch/risc-v/src/litex/litex_serial.c @@ -377,9 +377,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/risc-v/src/mpfs/mpfs_serial.c b/arch/risc-v/src/mpfs/mpfs_serial.c index c0dbdc09e8..ec9ab908cf 100644 --- a/arch/risc-v/src/mpfs/mpfs_serial.c +++ b/arch/risc-v/src/mpfs/mpfs_serial.c @@ -728,9 +728,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/risc-v/src/rv32m1/rv32m1_serial.c b/arch/risc-v/src/rv32m1/rv32m1_serial.c index 5f96388a38..cfaf169ffa 100644 --- a/arch/risc-v/src/rv32m1/rv32m1_serial.c +++ b/arch/risc-v/src/rv32m1/rv32m1_serial.c @@ -756,9 +756,9 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/sparc/src/bm3803/bm3803-serial.c b/arch/sparc/src/bm3803/bm3803-serial.c index 9e098c61c9..0183bb648e 100644 --- a/arch/sparc/src/bm3803/bm3803-serial.c +++ b/arch/sparc/src/bm3803/bm3803-serial.c @@ -499,10 +499,10 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the - * approprite uart_dev_s structure in order to call these functions. + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/sparc/src/bm3823/bm3823-serial.c b/arch/sparc/src/bm3823/bm3823-serial.c index 11ba11d385..f871bbe4f3 100644 --- a/arch/sparc/src/bm3823/bm3823-serial.c +++ b/arch/sparc/src/bm3823/bm3823-serial.c @@ -501,10 +501,10 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the - * approprite uart_dev_s structure in order to call these functions. + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/sparc/src/s698pm/s698pm-serial.c b/arch/sparc/src/s698pm/s698pm-serial.c index 6b9dbecd69..0121c4a5f0 100644 --- a/arch/sparc/src/s698pm/s698pm-serial.c +++ b/arch/sparc/src/s698pm/s698pm-serial.c @@ -567,10 +567,10 @@ static void up_detach(struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the - * approprite uart_dev_s structure in order to call these functions. + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/xtensa/src/esp32/esp32_serial.c b/arch/xtensa/src/esp32/esp32_serial.c index a1c303e5cb..e92135a98c 100644 --- a/arch/xtensa/src/esp32/esp32_serial.c +++ b/arch/xtensa/src/esp32/esp32_serial.c @@ -1336,10 +1336,11 @@ static void dma_config(uint8_t dma_chan) * Name: esp32_interrupt * * Description: - * This is the common UART interrupt handler. It will be invoked - * when an interrupt received on the device. It should call - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * This is the common UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/xtensa/src/esp32s2/esp32s2_serial.c b/arch/xtensa/src/esp32s2/esp32s2_serial.c index 63bf504838..b24e877493 100644 --- a/arch/xtensa/src/esp32s2/esp32s2_serial.c +++ b/arch/xtensa/src/esp32s2/esp32s2_serial.c @@ -220,7 +220,7 @@ static uart_dev_t g_uart1_dev = * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt is received on the 'irq' It should call uart_xmitchars or + * interrupt is received on the 'irq'. It should call uart_xmitchars or * uart_recvchars to perform the appropriate data transfers. The * interrupt handling logic must be able to map the 'irq' number into the * appropriate uart_dev_s structure in order to call these functions. diff --git a/arch/xtensa/src/esp32s3/esp32s3_serial.c b/arch/xtensa/src/esp32s3/esp32s3_serial.c index 2070dabe71..9c7eed7df9 100644 --- a/arch/xtensa/src/esp32s3/esp32s3_serial.c +++ b/arch/xtensa/src/esp32s3/esp32s3_serial.c @@ -242,7 +242,7 @@ static uart_dev_t g_uart1_dev = * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt is received on the 'irq' It should call uart_xmitchars or + * interrupt is received on the 'irq'. It should call uart_xmitchars or * uart_recvchars to perform the appropriate data transfers. The * interrupt handling logic must be able to map the 'irq' number into the * appropriate uart_dev_s structure in order to call these functions. diff --git a/arch/xtensa/src/esp32s3/esp32s3_usbserial.c b/arch/xtensa/src/esp32s3/esp32s3_usbserial.c index f117ff1611..ab3685a797 100644 --- a/arch/xtensa/src/esp32s3/esp32s3_usbserial.c +++ b/arch/xtensa/src/esp32s3/esp32s3_usbserial.c @@ -150,10 +150,11 @@ uart_dev_t g_uart_usbserial = * Name: esp32s3_interrupt * * Description: - * This is the common UART interrupt handler. It will be invoked - * when an interrupt received on the device. It should call - * uart_transmitchars or uart_receivechar to perform the appropriate data - * transfers. + * This is the common UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/z80/src/ez80/ez80_serial.c b/arch/z80/src/ez80/ez80_serial.c index 41e159b8a1..050eda7666 100644 --- a/arch/z80/src/ez80/ez80_serial.c +++ b/arch/z80/src/ez80/ez80_serial.c @@ -466,12 +466,11 @@ static void ez80_detach(FAR struct uart_dev_s *dev) * Name: ez80_interrupt * * Description: - * This is the UART interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/arch/z80/src/z180/z180_scc.c b/arch/z80/src/z180/z180_scc.c index 7f0c39f6be..ca2a16ccb0 100644 --- a/arch/z80/src/z180/z180_scc.c +++ b/arch/z80/src/z180/z180_scc.c @@ -424,12 +424,11 @@ static void z180_detach(struct uart_dev_s *dev) * Name: z180_interrupt * * Description: - * This is the UART interrupt handler. It will be invoked - * when an interrupt received on the 'irq' It should call - * uart_transmitchars or uart_receivechar to perform the - * appropriate data transfers. The interrupt handling logic\ - * must be able to map the 'irq' number into the appropriate - * uart_dev_s structure in order to call these functions. + * This is the UART interrupt handler. It will be invoked when an + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/drivers/serial/serial_io.c b/drivers/serial/serial_io.c index 34c658913c..0a6d2affe4 100644 --- a/drivers/serial/serial_io.c +++ b/drivers/serial/serial_io.c @@ -106,7 +106,7 @@ void uart_xmitchars(FAR uart_dev_t *dev) } /**************************************************************************** - * Name: uart_receivechars + * Name: uart_recvchars * * Description: * This function is called from the UART interrupt handler when an diff --git a/drivers/serial/uart_16550.c b/drivers/serial/uart_16550.c index abc0abbf10..6064e74628 100644 --- a/drivers/serial/uart_16550.c +++ b/drivers/serial/uart_16550.c @@ -790,10 +790,10 @@ static void u16550_detach(FAR struct uart_dev_s *dev) * * Description: * This is the UART interrupt handler. It will be invoked when an - * interrupt received on the 'irq' It should call uart_transmitchars or - * uart_receivechar to perform the appropriate data transfers. The - * interrupt handling logic must be able to map the 'irq' number into the - * appropriate u16550_s structure in order to call these functions. + * interrupt is received on the 'irq'. It should call uart_xmitchars or + * uart_recvchars to perform the appropriate data transfers. The + * interrupt handling logic must be able to map the 'arg' to the + * appropriate uart_dev_s structure in order to call these functions. * ****************************************************************************/ diff --git a/include/nuttx/serial/serial.h b/include/nuttx/serial/serial.h index 56cee09de3..0a791986af 100644 --- a/include/nuttx/serial/serial.h +++ b/include/nuttx/serial/serial.h @@ -368,7 +368,7 @@ int uart_register(FAR const char *path, FAR uart_dev_t *dev); void uart_xmitchars(FAR uart_dev_t *dev); /**************************************************************************** - * Name: uart_receivechars + * Name: uart_recvchars * * Description: * This function is called from the UART interrupt handler when an interrupt