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.
This commit is contained in:
Yash
2026-01-23 10:54:43 +00:00
committed by YASH BHIWANIA
parent 28588dcc59
commit f8f6311b99
11 changed files with 65 additions and 10 deletions

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSBSPsPowerPCMotorola
*
* @brief Motorola PowerPC PCI Support
*/
/*
* PCI defines and function prototypes
* Copyright 1994, Drew Eckhardt

View File

@@ -2,7 +2,10 @@
/**
* @file
* @brief Keyboard Definitions
*
* @ingroup RTEMSBSPsPowerPCMotorola
*
* @brief Motorola PowerPC Keyboard Support
*/
/*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSBSPsPowerPCMotorola
*
* @brief Motorola PowerPC VME Configuration
*/
#ifndef RTEMS_BSP_VME_CONFIG_H
#define RTEMS_BSP_VME_CONFIG_H

View File

@@ -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.
*/

View File

@@ -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
*/

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSBSPsPowerPCMotorola
*
* @brief Motorola PowerPC Reset Support
*/
#include <bsp.h>
#include <rtems/bspIo.h>
#include <libcpu/stackTrace.h>

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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);

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup RTEMSBSPsPowerPCMVME3100
*
* @brief MVME3100 Miscellaneous Support
*/
/* Miscellaneous small BSP routines; reboot, board CSR, ... */
/*