From f8f6311b99971e0a73efbe32cfe995b37427f694 Mon Sep 17 00:00:00 2001 From: Yash Date: Fri, 23 Jan 2026 10:54:43 +0000 Subject: [PATCH] bsps/powerpc: Add Doxygen and formatting to Motorola BSPs Add Doxygen-style file headers and fix specific typos in comments to improve documentation and compliance with coding standards. --- bsps/powerpc/motorola_powerpc/bootloader/pci.h | 8 ++++++++ bsps/powerpc/motorola_powerpc/console/keyboard.h | 5 ++++- .../powerpc/motorola_powerpc/include/bsp/VMEConfig.h | 8 ++++++++ bsps/powerpc/motorola_powerpc/include/bsp/irq.h | 5 ++++- bsps/powerpc/motorola_powerpc/include/tm27.h | 6 ++++-- bsps/powerpc/motorola_powerpc/start/bspreset.c | 8 ++++++++ bsps/powerpc/motorola_powerpc/start/bspstart.c | 5 ++++- bsps/powerpc/motorola_powerpc/start/motorola.c | 7 +++++-- bsps/powerpc/motorola_powerpc/start/residual.c | 3 +++ bsps/powerpc/mvme3100/start/bspstart.c | 12 +++++++++--- bsps/powerpc/mvme3100/start/misc.c | 8 ++++++++ 11 files changed, 65 insertions(+), 10 deletions(-) diff --git a/bsps/powerpc/motorola_powerpc/bootloader/pci.h b/bsps/powerpc/motorola_powerpc/bootloader/pci.h index 4281a13090..dad9267af6 100644 --- a/bsps/powerpc/motorola_powerpc/bootloader/pci.h +++ b/bsps/powerpc/motorola_powerpc/bootloader/pci.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup RTEMSBSPsPowerPCMotorola + * + * @brief Motorola PowerPC PCI Support + */ + /* * PCI defines and function prototypes * Copyright 1994, Drew Eckhardt diff --git a/bsps/powerpc/motorola_powerpc/console/keyboard.h b/bsps/powerpc/motorola_powerpc/console/keyboard.h index a44beb2963..d4d0ed686e 100644 --- a/bsps/powerpc/motorola_powerpc/console/keyboard.h +++ b/bsps/powerpc/motorola_powerpc/console/keyboard.h @@ -2,7 +2,10 @@ /** * @file - * @brief Keyboard Definitions + * + * @ingroup RTEMSBSPsPowerPCMotorola + * + * @brief Motorola PowerPC Keyboard Support */ /* diff --git a/bsps/powerpc/motorola_powerpc/include/bsp/VMEConfig.h b/bsps/powerpc/motorola_powerpc/include/bsp/VMEConfig.h index 9e57730d60..a1150cd083 100644 --- a/bsps/powerpc/motorola_powerpc/include/bsp/VMEConfig.h +++ b/bsps/powerpc/motorola_powerpc/include/bsp/VMEConfig.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup RTEMSBSPsPowerPCMotorola + * + * @brief Motorola PowerPC VME Configuration + */ + #ifndef RTEMS_BSP_VME_CONFIG_H #define RTEMS_BSP_VME_CONFIG_H diff --git a/bsps/powerpc/motorola_powerpc/include/bsp/irq.h b/bsps/powerpc/motorola_powerpc/include/bsp/irq.h index 9ab289c3a8..1cad6f56cc 100644 --- a/bsps/powerpc/motorola_powerpc/include/bsp/irq.h +++ b/bsps/powerpc/motorola_powerpc/include/bsp/irq.h @@ -2,6 +2,9 @@ /** * @file + * + * @ingroup RTEMSBSPsPowerPCMotorola + * * @brief Interrupt Handler Support * * This include file describe the data structure and the functions implemented @@ -213,7 +216,7 @@ int BSP_irq_enable_at_i8259s (const rtems_irq_number irqLine); /* * function to acknowledge a particular irq at 8259 level. After calling * this function, if a device asserts an enabled interrupt line it will - * be propagated further to the processor. Mainly usefull for people + * be propagated further to the processor. Mainly useful for people * writing raw handlers as this is automagically done for RTEMS managed * handlers. */ diff --git a/bsps/powerpc/motorola_powerpc/include/tm27.h b/bsps/powerpc/motorola_powerpc/include/tm27.h index 08f81ba452..eb126dac6f 100644 --- a/bsps/powerpc/motorola_powerpc/include/tm27.h +++ b/bsps/powerpc/motorola_powerpc/include/tm27.h @@ -1,8 +1,10 @@ /* SPDX-License-Identifier: GPL-2.0+-with-RTEMS-exception */ -/* +/** * @file - * @ingroup powerpc_motorola_powerpc + * + * @ingroup RTEMSBSPsPowerPCMotorola + * * @brief Implementations for interrupt mechanisms for Time Test 27 */ diff --git a/bsps/powerpc/motorola_powerpc/start/bspreset.c b/bsps/powerpc/motorola_powerpc/start/bspreset.c index 88e9792b76..031d70bea8 100644 --- a/bsps/powerpc/motorola_powerpc/start/bspreset.c +++ b/bsps/powerpc/motorola_powerpc/start/bspreset.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup RTEMSBSPsPowerPCMotorola + * + * @brief Motorola PowerPC Reset Support + */ + #include #include #include diff --git a/bsps/powerpc/motorola_powerpc/start/bspstart.c b/bsps/powerpc/motorola_powerpc/start/bspstart.c index e725a51c4e..57e5d2b382 100644 --- a/bsps/powerpc/motorola_powerpc/start/bspstart.c +++ b/bsps/powerpc/motorola_powerpc/start/bspstart.c @@ -2,6 +2,9 @@ /** * @file + * + * @ingroup RTEMSBSPsPowerPCMotorola + * * @brief Motorola PowerPC BSP Start * * This routine does the bulk of the system initialization. @@ -252,7 +255,7 @@ static void bsp_early( void ) printk("-----------------------------------------\n"); #ifdef SHOW_MORE_INIT_SETTINGS printk("Residuals are located at %x\n", (unsigned) &residualCopy); - printk("Additionnal boot options are %s\n", loaderParam); + printk("Additional boot options are %s\n", loaderParam); printk("-----------------------------------------\n"); #endif diff --git a/bsps/powerpc/motorola_powerpc/start/motorola.c b/bsps/powerpc/motorola_powerpc/start/motorola.c index 74dfaa0774..177aaa64de 100644 --- a/bsps/powerpc/motorola_powerpc/start/motorola.c +++ b/bsps/powerpc/motorola_powerpc/start/motorola.c @@ -2,6 +2,9 @@ /** * @file + * + * @ingroup RTEMSBSPsPowerPCMotorola + * * @brief Motorola (MVME) Board Identification * * This include file describe the data structure and the functions implemented @@ -42,7 +45,7 @@ /* ** Board-specific table that maps interrupt names to onboard PCI -** peripherals as well as local PCI busses. This table is used at +** peripherals as well as local PCI buses. This table is used at ** bspstart() to configure the interrupt name & pin for all devices that ** do not have it already specified. If the device is already ** configured, we leave it alone but sanity check & print a warning if @@ -65,7 +68,7 @@ ** controller interrupt pin- so it is quite reasonable for a device on ** bus 1 signalling interrupt pin 1 to show up at the interrupt ** controller as pin 4- this is why the int pin field varies for -** bridged pci busses. +** bridged pci buses. ** ** ** opts = bitmap of options that control the configuration of this diff --git a/bsps/powerpc/motorola_powerpc/start/residual.c b/bsps/powerpc/motorola_powerpc/start/residual.c index 5f4acfcb56..9452265a4b 100644 --- a/bsps/powerpc/motorola_powerpc/start/residual.c +++ b/bsps/powerpc/motorola_powerpc/start/residual.c @@ -2,6 +2,9 @@ /** * @file + * + * @ingroup RTEMSBSPsPowerPCMotorola + * * @brief Function used to parse residual data * * This code is heavily inspired by the public specification of STREAM V2 diff --git a/bsps/powerpc/mvme3100/start/bspstart.c b/bsps/powerpc/mvme3100/start/bspstart.c index d40ca7f3ba..e57a85c5d7 100644 --- a/bsps/powerpc/mvme3100/start/bspstart.c +++ b/bsps/powerpc/mvme3100/start/bspstart.c @@ -1,7 +1,13 @@ /* SPDX-License-Identifier: GPL-2.0+-with-RTEMS-exception */ -/* - * This routine does the bulk of the system initialization. +/** + * @file + * + * @ingroup RTEMSBSPsPowerPCMVME3100 + * + * @brief MVME3100 BSP Start + * + * This routine does the bulk of the system initialization. */ /* @@ -362,7 +368,7 @@ VpdBufRec vpdData [] = { bsp_clicks_per_usec = BSP_bus_frequency/(BSP_time_base_divisor * 1000); /* - * Initalize RTEMS IRQ system + * Initialize RTEMS IRQ system */ BSP_rtems_irq_mng_init(0); diff --git a/bsps/powerpc/mvme3100/start/misc.c b/bsps/powerpc/mvme3100/start/misc.c index dbcf25df2f..639ad13b7c 100644 --- a/bsps/powerpc/mvme3100/start/misc.c +++ b/bsps/powerpc/mvme3100/start/misc.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup RTEMSBSPsPowerPCMVME3100 + * + * @brief MVME3100 Miscellaneous Support + */ + /* Miscellaneous small BSP routines; reboot, board CSR, ... */ /*