diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-23 16:09:08 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-26 06:56:11 +0200 |
commit | 49720a90d851705d630cc3e688c7ee89665a52fa (patch) | |
tree | 43fd3b2f4d22d29d328ea67f2d91a68261a47dca /bsps/arm | |
parent | bsps/arm: Improve Doxygen groups (diff) | |
download | rtems-49720a90d851705d630cc3e688c7ee89665a52fa.tar.bz2 |
arm/xilinx-zynq: Improve Doxygen file comments
Diffstat (limited to 'bsps/arm')
-rw-r--r-- | bsps/arm/xilinx-zynq/console/console-config.c | 12 | ||||
-rw-r--r-- | bsps/arm/xilinx-zynq/console/debug-console.c | 13 | ||||
-rw-r--r-- | bsps/arm/xilinx-zynq/start/bspreset.c | 12 | ||||
-rw-r--r-- | bsps/arm/xilinx-zynq/start/bspstart.c | 13 | ||||
-rw-r--r-- | bsps/arm/xilinx-zynq/start/bspstarthooks.c | 13 | ||||
-rw-r--r-- | bsps/arm/xilinx-zynq/start/bspstartmmu.c | 13 |
6 files changed, 64 insertions, 12 deletions
diff --git a/bsps/arm/xilinx-zynq/console/console-config.c b/bsps/arm/xilinx-zynq/console/console-config.c index 1f2abf572d..d22ceb557d 100644 --- a/bsps/arm/xilinx-zynq/console/console-config.c +++ b/bsps/arm/xilinx-zynq/console/console-config.c @@ -1,6 +1,14 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* 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 diff --git a/bsps/arm/xilinx-zynq/console/debug-console.c b/bsps/arm/xilinx-zynq/console/debug-console.c index b96a651175..6e89ad0323 100644 --- a/bsps/arm/xilinx-zynq/console/debug-console.c +++ b/bsps/arm/xilinx-zynq/console/debug-console.c @@ -1,6 +1,15 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSBSPsARMZynq * + * @brief This source file contains the definition of ::BSP_output_char and + * ::BSP_poll_char. + */ + +/* * Copyright (C) 2013, 2017 embedded brains GmbH & Co. KG * * Redistribution and use in source and binary forms, with or without diff --git a/bsps/arm/xilinx-zynq/start/bspreset.c b/bsps/arm/xilinx-zynq/start/bspreset.c index 58bb95fa8e..f8cc3b6999 100644 --- a/bsps/arm/xilinx-zynq/start/bspreset.c +++ b/bsps/arm/xilinx-zynq/start/bspreset.c @@ -1,6 +1,14 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSBSPsARMZynq * + * @brief This source file contains the implementation of bsp_reset(). + */ + +/* * Copyright (C) 2013 embedded brains GmbH & Co. KG * * Redistribution and use in source and binary forms, with or without diff --git a/bsps/arm/xilinx-zynq/start/bspstart.c b/bsps/arm/xilinx-zynq/start/bspstart.c index 34fd9ce34e..89926ce1f3 100644 --- a/bsps/arm/xilinx-zynq/start/bspstart.c +++ b/bsps/arm/xilinx-zynq/start/bspstart.c @@ -1,6 +1,15 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSBSPsARMZynq * + * @brief This source file contains the implementation of zynq_clock_cpu_1x() + * and bsp_start(). + */ + +/* * Copyright (C) 2013, 2015 embedded brains GmbH & Co. KG * * Redistribution and use in source and binary forms, with or without diff --git a/bsps/arm/xilinx-zynq/start/bspstarthooks.c b/bsps/arm/xilinx-zynq/start/bspstarthooks.c index a1e635a0de..de6a4ccd54 100644 --- a/bsps/arm/xilinx-zynq/start/bspstarthooks.c +++ b/bsps/arm/xilinx-zynq/start/bspstarthooks.c @@ -1,6 +1,15 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSBSPsARMZynq * + * @brief This source file contains the implementation of bsp_start_hook_0() + * and bsp_start_hook_1(). + */ + +/* * Copyright (C) 2013, 2014 embedded brains GmbH & Co. KG * * Redistribution and use in source and binary forms, with or without diff --git a/bsps/arm/xilinx-zynq/start/bspstartmmu.c b/bsps/arm/xilinx-zynq/start/bspstartmmu.c index 1290bd4c08..04d7586c1b 100644 --- a/bsps/arm/xilinx-zynq/start/bspstartmmu.c +++ b/bsps/arm/xilinx-zynq/start/bspstartmmu.c @@ -1,6 +1,15 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSBSPsARMZynq * + * @brief This source file contains the implementation of + * zynq_setup_mmu_and_cache(). + */ + +/* * Copyright (C) 2013 embedded brains GmbH & Co. KG * * Redistribution and use in source and binary forms, with or without |