dev/serial: Add Zynq UART kernel I/O support

Replace the BSP_CONSOLE_MINOR BSP option for the Xilinx Zynq BSPs with the new
BSP option ZYNQ_UART_KERNEL_IO_BASE_ADDR.  Move the kernel I/O support to a
shared file.

8 files changed, 64 insertions, 189 deletions

diff --git a/bsps/aarch64/xilinx-zynqmp/console/console.c b/bsps/aarch64/xilinx-zynqmp/console/console.c
index ce031a914e..4023d5c6f3 100644
--- a/bsps/aarch64/xilinx-zynqmp/console/console.c
+++ b/bsps/aarch64/xilinx-zynqmp/console/console.c
@@ -35,7 +35,6 @@
  */
 
 #include <rtems/console.h>
-#include <rtems/bspIo.h>
 #include <rtems/endian.h>
 #include <rtems/sysinit.h>
 #include <rtems/termiostypes.h>
@@ -208,6 +207,7 @@ rtems_status_code console_initialize(
   rtems_termios_initialize();
 
   for (i = 0; i < RTEMS_ARRAY_SIZE(zynqmp_uart_instances); ++i) {
+    zynq_uart_context *ctx = &zynqmp_uart_instances[i];
     char uart[] = "/dev/ttySX";
 
     uart[sizeof(uart) - 2] = (char) ('0' + i);
@@ -215,10 +215,10 @@ rtems_status_code console_initialize(
       &uart[0],
       &zynq_uart_handler,
       NULL,
-      &zynqmp_uart_instances[i].base
+      &ctx->base
     );
 
-    if (i == BSP_CONSOLE_MINOR) {
+    if (ctx->regs == (zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR) {
       link(&uart[0], CONSOLE_DEVICE_NAME);
     }
   }
@@ -237,38 +237,5 @@ rtems_status_code console_initialize(
 
 void zynqmp_debug_console_flush(void)
 {
-  zynq_uart_reset_tx_flush(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
+  zynq_uart_reset_tx_flush((zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR);
 }
-
-static void zynqmp_debug_console_out(char c)
-{
-  zynq_uart_write_char_polled(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs, c);
-}
-
-static void zynqmp_debug_console_init(void)
-{
-  zynq_uart_initialize(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
-  BSP_output_char = zynqmp_debug_console_out;
-}
-
-static void zynqmp_debug_console_early_init(char c)
-{
-  zynq_uart_initialize(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
-  BSP_output_char = zynqmp_debug_console_out;
-  zynqmp_debug_console_out(c);
-}
-
-static int zynqmp_debug_console_in(void)
-{
-  return zynq_uart_read_char_polled(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
-}
-
-BSP_output_char_function_type BSP_output_char = zynqmp_debug_console_early_init;
-
-BSP_polling_getchar_function_type BSP_poll_char = zynqmp_debug_console_in;
-
-RTEMS_SYSINIT_ITEM(
-  zynqmp_debug_console_init,
-  RTEMS_SYSINIT_BSP_START,
-  RTEMS_SYSINIT_ORDER_LAST_BUT_5
-);
diff --git a/bsps/arm/xilinx-zynq/console/console-config.c b/bsps/arm/xilinx-zynq/console/console-config.c
deleted file mode 100644
index 42e64ee4dd..0000000000
--- a/bsps/arm/xilinx-zynq/console/console-config.c
+++ /dev/null
@@ -1,50 +0,0 @@
-/* SPDX-License-Identifier: BSD-2-Clause */
-
-/**
- * @file
- *
- * @ingroup RTEMSBSPsARMZynq
- *
- * @brief This source file contains the definition of ::zynq_uart_instances.
- */
-
-/*
- * Copyright (C) 2013, 2017 embedded brains GmbH & Co. KG
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- */
-
-#include <bsp/irq.h>
-#include <dev/serial/zynq-uart.h>
-#include <dev/serial/zynq-uart-regs.h>
-
-zynq_uart_context zynq_uart_instances[2] = {
-  {
-    .base = RTEMS_TERMIOS_DEVICE_CONTEXT_INITIALIZER( "Zynq UART 0" ),
-    .regs = (volatile zynq_uart *) ZYNQ_UART_0_BASE_ADDR,
-    .irq = ZYNQ_IRQ_UART_0
-  }, {
-    .base = RTEMS_TERMIOS_DEVICE_CONTEXT_INITIALIZER( "Zynq UART 1" ),
-    .regs = (volatile zynq_uart *) ZYNQ_UART_1_BASE_ADDR,
-    .irq = ZYNQ_IRQ_UART_1
-  }
-};
diff --git a/bsps/arm/xilinx-zynq/console/console-init.c b/bsps/arm/xilinx-zynq/console/console-init.c
index 72fa27da11..2018aaa710 100644
--- a/bsps/arm/xilinx-zynq/console/console-init.c
+++ b/bsps/arm/xilinx-zynq/console/console-init.c
@@ -29,7 +29,22 @@
 #include <rtems/termiostypes.h>
 
 #include <bsp.h>
+#include <bsp/bootcard.h>
+#include <bsp/irq.h>
 #include <dev/serial/zynq-uart.h>
+#include <dev/serial/zynq-uart-regs.h>
+
+static zynq_uart_context zynq_uart_instances[2] = {
+  {
+    .base = RTEMS_TERMIOS_DEVICE_CONTEXT_INITIALIZER( "Zynq UART 0" ),
+    .regs = (volatile zynq_uart *) ZYNQ_UART_0_BASE_ADDR,
+    .irq = ZYNQ_IRQ_UART_0
+  }, {
+    .base = RTEMS_TERMIOS_DEVICE_CONTEXT_INITIALIZER( "Zynq UART 1" ),
+    .regs = (volatile zynq_uart *) ZYNQ_UART_1_BASE_ADDR,
+    .irq = ZYNQ_IRQ_UART_1
+  }
+};
 
 rtems_status_code console_initialize(
   rtems_device_major_number major,
@@ -42,6 +57,7 @@ rtems_status_code console_initialize(
   rtems_termios_initialize();
 
   for (i = 0; i < RTEMS_ARRAY_SIZE(zynq_uart_instances); ++i) {
+    zynq_uart_context *ctx = &zynq_uart_instances[i];
     char uart[] = "/dev/ttySX";
 
     uart[sizeof(uart) - 2] = (char) ('0' + i);
@@ -49,10 +65,10 @@ rtems_status_code console_initialize(
       &uart[0],
       &zynq_uart_handler,
       NULL,
-      &zynq_uart_instances[i].base
+      &ctx->base
     );
 
-    if (i == BSP_CONSOLE_MINOR) {
+    if (ctx->regs == (zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR) {
       link(&uart[0], CONSOLE_DEVICE_NAME);
     }
   }
diff --git a/bsps/arm/xilinx-zynq/include/bsp.h b/bsps/arm/xilinx-zynq/include/bsp.h
index 5ffd5f573a..151e603812 100644
--- a/bsps/arm/xilinx-zynq/include/bsp.h
+++ b/bsps/arm/xilinx-zynq/include/bsp.h
@@ -54,7 +54,6 @@
 
 #include <bsp/default-initial-extension.h>
 #include <bsp/start.h>
-#include <dev/serial/zynq-uart.h>
 #include <dev/serial/zynq-uart-zynq.h>
 
 #ifdef __cplusplus
@@ -75,8 +74,6 @@ extern "C" {
 
 #define BSP_ARM_L2C_310_ID 0x410000c8
 
-extern zynq_uart_context zynq_uart_instances[2];
-
 /**
  * @brief Zynq specific set up of the MMU.
  *
diff --git a/bsps/arm/xilinx-zynq/start/bspreset.c b/bsps/arm/xilinx-zynq/start/bspreset.c
index f8cc3b6999..b6cf09ba02 100644
--- a/bsps/arm/xilinx-zynq/start/bspreset.c
+++ b/bsps/arm/xilinx-zynq/start/bspreset.c
@@ -35,14 +35,16 @@
 
 #include <bsp.h>
 #include <bsp/bootcard.h>
-#include <dev/serial/zynq-uart.h>
+#include <dev/serial/zynq-uart-regs.h>
 
 void bsp_reset(void)
 {
+  volatile zynq_uart *regs =
+    (volatile zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR;
   volatile uint32_t *slcr_unlock = (volatile uint32_t *) 0xf8000008;
   volatile uint32_t *pss_rst_ctrl = (volatile uint32_t *) 0xf8000200;
 
-  zynq_uart_reset_tx_flush(&zynq_uart_instances[BSP_CONSOLE_MINOR]);
+  zynq_uart_reset_tx_flush(regs);
 
   while (true) {
     *slcr_unlock = 0xdf0d;
diff --git a/bsps/arm/xilinx-zynqmp-rpu/console/console-config.c b/bsps/arm/xilinx-zynqmp-rpu/console/console-config.c
index 13eaa269c5..db03d1e9f3 100644
--- a/bsps/arm/xilinx-zynqmp-rpu/console/console-config.c
+++ b/bsps/arm/xilinx-zynqmp-rpu/console/console-config.c
@@ -32,7 +32,6 @@
 
 #include <rtems/console.h>
 #include <rtems/bspIo.h>
-#include <rtems/sysinit.h>
 #include <rtems/termiostypes.h>
 
 #include <bsp/irq.h>
@@ -62,6 +61,7 @@ rtems_status_code console_initialize(
   size_t i;
 
   for (i = 0; i < RTEMS_ARRAY_SIZE(zynqmp_uart_instances); ++i) {
+    zynq_uart_context *ctx = &zynqmp_uart_instances[i];
     char uart[] = "/dev/ttySX";
 
     uart[sizeof(uart) - 2] = (char) ('0' + i);
@@ -69,10 +69,10 @@ rtems_status_code console_initialize(
       &uart[0],
       &zynq_uart_handler,
       NULL,
-      &zynqmp_uart_instances[i].base
+      &ctx->base
     );
 
-    if (i == BSP_CONSOLE_MINOR) {
+    if (ctx->regs == (zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR) {
       link(&uart[0], CONSOLE_DEVICE_NAME);
     }
   }
@@ -82,37 +82,5 @@ rtems_status_code console_initialize(
 
 void zynqmp_debug_console_flush(void)
 {
-  zynq_uart_reset_tx_flush(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
+  zynq_uart_reset_tx_flush((zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR);
 }
-
-static void zynqmp_debug_console_out(char c)
-{
-  zynq_uart_write_char_polled(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs, c);
-}
-
-static void zynqmp_debug_console_init(void)
-{
-  zynq_uart_initialize(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
-  BSP_output_char = zynqmp_debug_console_out;
-}
-
-static void zynqmp_debug_console_early_init(char c)
-{
-  zynq_uart_initialize(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
-  zynqmp_debug_console_out(c);
-}
-
-static int zynqmp_debug_console_in(void)
-{
-  return zynq_uart_read_char_polled(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
-}
-
-BSP_output_char_function_type BSP_output_char = zynqmp_debug_console_early_init;
-
-BSP_polling_getchar_function_type BSP_poll_char = zynqmp_debug_console_in;
-
-RTEMS_SYSINIT_ITEM(
-  zynqmp_debug_console_init,
-  RTEMS_SYSINIT_BSP_START,
-  RTEMS_SYSINIT_ORDER_LAST_BUT_5
-);
diff --git a/bsps/arm/xilinx-zynqmp/console/console-config.c b/bsps/arm/xilinx-zynqmp/console/console-config.c
index b9fef02154..550e930415 100644
--- a/bsps/arm/xilinx-zynqmp/console/console-config.c
+++ b/bsps/arm/xilinx-zynqmp/console/console-config.c
@@ -32,7 +32,6 @@
 
 #include <rtems/console.h>
 #include <rtems/bspIo.h>
-#include <rtems/sysinit.h>
 #include <rtems/termiostypes.h>
 
 #include <bsp/irq.h>
@@ -64,6 +63,7 @@ rtems_status_code console_initialize(
   rtems_termios_initialize();
 
   for (i = 0; i < RTEMS_ARRAY_SIZE(zynqmp_uart_instances); ++i) {
+    zynq_uart_context *ctx = &zynqmp_uart_instances[i];
     char uart[] = "/dev/ttySX";
 
     uart[sizeof(uart) - 2] = (char) ('0' + i);
@@ -71,10 +71,10 @@ rtems_status_code console_initialize(
       &uart[0],
       &zynq_uart_handler,
       NULL,
-      &zynqmp_uart_instances[i].base
+      &ctx->base
     );
 
-    if (i == BSP_CONSOLE_MINOR) {
+    if (ctx->regs == (zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR) {
       link(&uart[0], CONSOLE_DEVICE_NAME);
     }
   }
@@ -84,37 +84,5 @@ rtems_status_code console_initialize(
 
 void zynqmp_debug_console_flush(void)
 {
-  zynq_uart_reset_tx_flush(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
+  zynq_uart_reset_tx_flush((zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR);
 }
-
-static void zynqmp_debug_console_out(char c)
-{
-  zynq_uart_write_char_polled(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs, c);
-}
-
-static void zynqmp_debug_console_init(void)
-{
-  zynq_uart_initialize(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
-  BSP_output_char = zynqmp_debug_console_out;
-}
-
-static void zynqmp_debug_console_early_init(char c)
-{
-  zynq_uart_initialize(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
-  zynqmp_debug_console_out(c);
-}
-
-static int zynqmp_debug_console_in(void)
-{
-  return zynq_uart_read_char_polled(zynqmp_uart_instances[BSP_CONSOLE_MINOR].regs);
-}
-
-BSP_output_char_function_type BSP_output_char = zynqmp_debug_console_early_init;
-
-BSP_polling_getchar_function_type BSP_poll_char = zynqmp_debug_console_in;
-
-RTEMS_SYSINIT_ITEM(
-  zynqmp_debug_console_init,
-  RTEMS_SYSINIT_BSP_START,
-  RTEMS_SYSINIT_ORDER_LAST_BUT_5
-);
diff --git a/bsps/arm/xilinx-zynq/console/debug-console.c b/bsps/shared/dev/serial/zynq-uart-kernel-io.c
index 4c636038af..61b1043cd2 100644
--- a/bsps/arm/xilinx-zynq/console/debug-console.c
+++ b/bsps/shared/dev/serial/zynq-uart-kernel-io.c
@@ -3,14 +3,14 @@
 /**
  * @file
  *
- * @ingroup RTEMSBSPsARMZynq
+ * @ingroup zynq_uart
  *
  * @brief This source file contains the definition of ::BSP_output_char and
  *   ::BSP_poll_char.
  */
 
 /*
- * Copyright (C) 2013, 2017 embedded brains GmbH & Co. KG
+ * Copyright (C) 2013, 2024 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -35,47 +35,54 @@
  */
 
 #include <rtems/bspIo.h>
-#include <rtems/sysinit.h>
 
 #include <bsp.h>
-#include <dev/serial/zynq-uart.h>
+#include <dev/serial/zynq-uart-regs.h>
+#include <rtems/sysinit.h>
 
-#include <bspopts.h>
+static void zynq_uart_kernel_output_char(char c)
+{
+  volatile zynq_uart *regs =
+    (volatile zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR;
+
+  zynq_uart_write_char_polled(regs, c);
+}
 
-static void zynq_debug_console_out(char c)
+static int zynq_uart_kernel_poll_char(void)
 {
-  zynq_uart_write_char_polled(zynq_uart_instances[BSP_CONSOLE_MINOR].regs, c);
+  volatile zynq_uart *regs =
+    (volatile zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR;
+
+  return zynq_uart_read_char_polled(regs);
 }
 
-static void zynq_debug_console_early_init(char c);
+static void zynq_uart_kernel_early_init(char c);
 
-static void zynq_debug_console_init(void)
+static void zynq_uart_kernel_init(void)
 {
-  if (BSP_output_char != zynq_debug_console_early_init) {
+  volatile zynq_uart *regs =
+    (volatile zynq_uart *) ZYNQ_UART_KERNEL_IO_BASE_ADDR;
+
+  if (BSP_output_char != zynq_uart_kernel_early_init) {
     return;
   }
 
-  zynq_uart_initialize(zynq_uart_instances[BSP_CONSOLE_MINOR].regs);
-  BSP_output_char = zynq_debug_console_out;
-}
-
-static void zynq_debug_console_early_init(char c)
-{
-  zynq_debug_console_init();
-  zynq_debug_console_out(c);
+  zynq_uart_initialize(regs);
+  BSP_output_char = zynq_uart_kernel_output_char;
 }
 
-static int zynq_debug_console_in(void)
+static void zynq_uart_kernel_early_init(char c)
 {
-  return zynq_uart_read_char_polled(zynq_uart_instances[BSP_CONSOLE_MINOR].regs);
+  zynq_uart_kernel_init();
+  zynq_uart_kernel_output_char(c);
 }
 
-BSP_output_char_function_type BSP_output_char = zynq_debug_console_early_init;
+BSP_output_char_function_type BSP_output_char = zynq_uart_kernel_early_init;
 
-BSP_polling_getchar_function_type BSP_poll_char = zynq_debug_console_in;
+BSP_polling_getchar_function_type BSP_poll_char = zynq_uart_kernel_poll_char;
 
 RTEMS_SYSINIT_ITEM(
-  zynq_debug_console_init,
+  zynq_uart_kernel_init,
   RTEMS_SYSINIT_BSP_START,
   RTEMS_SYSINIT_ORDER_LAST_BUT_5
 );