score: Doxygen Clean Up Task #15

This commit is contained in:
Alex Ivanov
2013-01-08 09:22:33 -06:00
committed by Jennifer Averett
parent e354eb4f4f
commit 66fffc7473
20 changed files with 761 additions and 725 deletions

View File

@@ -1,21 +1,17 @@
/**
* @file
*
* @ingroup ScoreCPU
* @brief ARM Assembler Support API
*
* @brief ARM assembler support API.
*/
/*
* This include file attempts to address the problems
* caused by incompatible flavors of assemblers and
* toolsets. It primarily addresses variations in the
* use of leading underscores on symbols and the requirement
* that register names be preceded by a %.
* This include file attempts to address the problems
* caused by incompatible flavors of assemblers and
* toolsets. It primarily addresses variations in the
* use of leading underscores on symbols and the requirement
* that register names be preceded by a %.
*
*
* NOTE: The spacing in the use of these macros
* is critical to them working as advertised.
* NOTE: The spacing in the use of these macros
* is critical to them working as advertised.
*/
/*
@@ -53,7 +49,7 @@
*
* @ingroup ScoreCPU
*
* @brief ARM assembler support.
* @brief ARM Assembler Support
*
* @{
*/

View File

@@ -1,9 +1,7 @@
/**
* @file
*
* @ingroup ScoreCPU
*
* @brief ARM assembler support API.
* @brief ARM Assembler Support API
*/
/*

View File

@@ -1,3 +1,9 @@
/**
* @file
*
* @brief ARMV7M Architecture Support
*/
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
@@ -474,8 +480,7 @@ void _ARMV7M_Set_exception_handler(
);
/**
* @brief ARMV7M Set Exception Priority and Handler
*
* @brief ARMV7M set exception priority and handler.
*/
void _ARMV7M_Set_exception_priority_and_handler(
int index,

View File

@@ -1,9 +1,7 @@
/**
* @file
*
* @ingroup ScoreCPU
*
* @brief ARM architecture support API.
* @brief ARM Architecture Support API
*/
/*
@@ -399,8 +397,7 @@ void _CPU_Context_Initialize(
} while (0);
/**
* @brief CPU Initialize
*
* @brief CPU initialization.
*/
void _CPU_Initialize( void );
@@ -411,8 +408,7 @@ void _CPU_ISR_install_vector(
);
/**
* @brief CPU Context Switch
*
* @brief CPU switch context.
*/
void _CPU_Context_switch( Context_Control *run, Context_Control *heir );

View File

@@ -3,7 +3,7 @@
*
* @ingroup ScoreCPU
*
* @brief ARM assembler support API.
* @brief ARM Assembler Support API
*/
/*

View File

@@ -1,9 +1,7 @@
/**
* @file
*
* @ingroup ScoreCPU
*
* @brief ARM architecture types API.
* @brief ARM Architecture Types API
*/
/*

View File

@@ -1,17 +1,20 @@
/**
* @file rtems/asm.h
* @file
*
* This include file attempts to address the problems
* caused by incompatible flavors of assemblers and
* toolsets. It primarily addresses variations in the
* use of leading underscores on symbols and the requirement
* that register names be preceded by a %.
* @brief Address the Problems Caused by Incompatible Flavor of
* Assemblers and Toolsets
*
* This include file attempts to address the problems
* caused by incompatible flavors of assemblers and
* toolsets. It primarily addresses variations in the
* use of leading underscores on symbols and the requirement
* that register names be preceded by a %.
*
* NOTE: The spacing in the use of these macros
* is critical to them working as advertised.
*/
/*
* NOTE: The spacing in the use of these macros
* is critical to them working as advertised.
*
* COPYRIGHT:
*
* This file is based on similar code found in newlib available
@@ -38,24 +41,24 @@
#ifndef __USER_LABEL_PREFIX__
/**
* Recent versions of GNU cpp define variables which indicate the
* need for underscores and percents. If not using GNU cpp or
* the version does not support this, then you will obviously
* have to define these as appropriate.
* Recent versions of GNU cpp define variables which indicate the
* need for underscores and percents. If not using GNU cpp or
* the version does not support this, then you will obviously
* have to define these as appropriate.
*
* This symbol is prefixed to all C program symbols.
* This symbol is prefixed to all C program symbols.
*/
#define __USER_LABEL_PREFIX__ _
#endif
#ifndef __REGISTER_PREFIX__
/**
* Recent versions of GNU cpp define variables which indicate the
* need for underscores and percents. If not using GNU cpp or
* the version does not support this, then you will obviously
* have to define these as appropriate.
* Recent versions of GNU cpp define variables which indicate the
* need for underscores and percents. If not using GNU cpp or
* the version does not support this, then you will obviously
* have to define these as appropriate.
*
* This symbol is prefixed to all register names.
* This symbol is prefixed to all register names.
*/
#define __REGISTER_PREFIX__
#endif
@@ -95,8 +98,9 @@
#define BEGIN_DATA
/** This macro is used to denote the end of a data section. */
#define END_DATA
/** This macro is used to denote the beginning of the
* unitialized data section.
/**
* This macro is used to denote the beginning of the
* unitialized data section.
*/
#define BEGIN_BSS
/** This macro is used to denote the end of the unitialized data section. */
@@ -105,18 +109,18 @@
#define END
/**
* This macro is used to declare a public global symbol.
* This macro is used to declare a public global symbol.
*
* @note This must be tailored for a particular flavor of the C compiler.
* They may need to put underscores in front of the symbols.
* NOTE: This must be tailored for a particular flavor of the C compiler.
* They may need to put underscores in front of the symbols.
*/
#define PUBLIC(sym) .globl SYM (sym)
/**
* This macro is used to prototype a public global symbol.
* This macro is used to prototype a public global symbol.
*
* @note This must be tailored for a particular flavor of the C compiler.
* They may need to put underscores in front of the symbols.
* NOTE: This must be tailored for a particular flavor of the C compiler.
* They may need to put underscores in front of the symbols.
*/
#define EXTERN(sym) .globl SYM (sym)

File diff suppressed because it is too large Load Diff

View File

@@ -1,12 +1,14 @@
/**
* @file rtems/score/cpu_asm.h
* @file
*
* @brief Intel M32R Assembly File
*
* Very loose template for an include file for the cpu_asm.? file
* if it is implemented as a ".S" file (preprocessed by cpp) instead
* of a ".s" file (preprocessed by gm4 or gasp).
*/
/*
* Very loose template for an include file for the cpu_asm.? file
* if it is implemented as a ".S" file (preprocessed by cpp) instead
* of a ".s" file (preprocessed by gm4 or gasp).
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*

View File

@@ -1,9 +1,15 @@
/*
* This file sets up basic CPU dependency settings based on
* compiler settings. For example, it can determine if
* floating point is available. This particular implementation
* is specified to the NO CPU port.
/**
* @file
*
* @brief Set up Basic CPU Dependency Settings Based on Compiler Settings
*
* This file sets up basic CPU dependency settings based on
* compiler settings. For example, it can determine if
* floating point is available. This particular implementation
* is specified to the NO CPU port.
*/
/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*

View File

@@ -1,11 +1,13 @@
/**
* @file rtems/score/types.h
* @file
*
* @brief Intel M32R CPU Type Definitions
*
* This include file contains type definitions pertaining to the Intel
* m32r processor family.
*/
/*
* This include file contains type definitions pertaining to the Intel
* m32r processor family.
*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*

View File

@@ -1,17 +1,20 @@
/**
* @file rtems/asm.h
* @file
*
* @brief Address the Problems Caused by Incompatible Flavor of
* Assemblers and Toolsets
*
* This include file attempts to address the problems
* caused by incompatible flavors of assemblers and
* toolsets. It primarily addresses variations in the
* use of leading underscores on symbols and the requirement
* that register names be preceded by a %.
* This include file attempts to address the problems
* caused by incompatible flavors of assemblers and
* toolsets. It primarily addresses variations in the
* use of leading underscores on symbols and the requirement
* that register names be preceded by a %.
*
* NOTE: The spacing in the use of these macros
* is critical to them working as advertised.
*/
/*
* NOTE: The spacing in the use of these macros
* is critical to them working as advertised.
*
* COPYRIGHT:
*
* This file is based on similar code found in newlib available

View File

@@ -1,7 +1,7 @@
/*
*------------------------------------------------------------------
/**
* @file
*
* m68302.h - Definitions for Motorola MC68302 processor.
* @brief Definitions for Motorola MC68302 Processor
*
* Section references in this file refer to revision 2 of Motorola's
* "MC68302 Integrated Multiprotocol Processor User's Manual".
@@ -9,7 +9,9 @@
*
* Based on Don Meyer's cpu68302.h that was posted in comp.sys.m68k
* on 17 February, 1993.
*
*/
/*
* COPYRIGHT 1995 David W. Glessner.
*
* Redistribution and use in source and binary forms are permitted

View File

@@ -1,3 +1,8 @@
/**
* @file
*
* @brief Definitions for Motorola MC68360 Processor
*/
/*
**************************************************************************
**************************************************************************
@@ -707,7 +712,7 @@ typedef struct m360_ {
unsigned char _pad14[0xF0-0xD0];
unsigned char _pad15[0x100-0xF0];
unsigned char _pad16[0x500-0x100];
/*
* IDMA1 Block
*/
@@ -725,7 +730,7 @@ typedef struct m360_ {
unsigned char csr1;
unsigned char _pad21;
unsigned short _pad22;
/*
* SDMA Block
*/
@@ -733,7 +738,7 @@ typedef struct m360_ {
unsigned char _pad23;
unsigned short sdcr;
unsigned long sdar;
/*
* IDMA2 Block
*/
@@ -750,7 +755,7 @@ typedef struct m360_ {
unsigned char _pad28;
unsigned short _pad29;
unsigned long _pad30;
/*
* CPIC Block
*/
@@ -774,7 +779,7 @@ typedef struct m360_ {
unsigned short pcint;
unsigned short _pad32;
unsigned long _pad33[5];
/*
* TIMER Block
*/
@@ -802,7 +807,7 @@ typedef struct m360_ {
unsigned short ter3;
unsigned short ter4;
unsigned long _pad36[2];
/*
* CP Block
*/

View File

@@ -1,7 +1,7 @@
/*
*-------------------------------------------------------------------
/**
* @file
*
* QSM -- Queued Serial Module
* @brief Motorola M68K Queued Serial Module
*
* The QSM contains two serial interfaces: (a) the queued serial
* peripheral interface (QSPI) and the serial communication interface
@@ -15,7 +15,9 @@
* For more information, refer to Motorola's "Modular Microcontroller
* Family Queued Serial Module Reference Manual" (Motorola document
* QSMRM/AD).
*
*/
/*
* This file was created by John S. Gwynne to support Motorola's 68332 MCU.
*
* Redistribution and use in source and binary forms are permitted

View File

@@ -1,7 +1,7 @@
/*
*-------------------------------------------------------------------
/**
* @file
*
* SIM -- System Integration Module
* @brief Motorola M68K System Integration Module
*
* The system integration module (SIM) is used on many Motorola 16-
* and 32-bit MCUs for the following functions:
@@ -23,7 +23,9 @@
* For more information, refer to Motorola's "Modular Microcontroller
* Family System Integration Module Reference Manual" (Motorola document
* SIMRM/AD).
*
*/
/*
* This file was created by John S. Gwynne to support Motorola's 68332 MCU.
*
* Redistribution and use in source and binary forms are permitted

View File

@@ -1,11 +1,13 @@
/**
* @file rtems/score/cpu.h
* @file
*
* @brief Motorola M68K CPU Dependent Source
*
* This include file contains information pertaining to the Motorola
* m68xxx processor family.
*/
/*
* This include file contains information pertaining to the Motorola
* m68xxx processor family.
*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*

View File

@@ -1,11 +1,13 @@
/**
* @file rtems/score/m68k.h
* @file
*
* @brief Motorola M68K CPU Dependent Source
*
* This include file contains information pertaining to the Motorola
* m68xxx processor family.
*/
/*
* This include file contains information pertaining to the Motorola
* m68xxx processor family.
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*

View File

@@ -1,11 +1,13 @@
/**
* @file rtems/score/types.h
* @file
*
* @brief Motorola M68K CPU Type Definitions
*
* This include file contains type definitions pertaining to the Motorola
* m68xxx processor family.
*/
/*
* This include file contains type definitions pertaining to the Motorola
* m68xxx processor family.
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*

View File

@@ -1,11 +1,10 @@
/**
* @file rtems/score/cpu_asm.h
*/
/*
* Very loose template for an include file for the cpu_asm.? file
* if it is implemented as a ".S" file (preprocessed by cpp) instead
* of a ".s" file (preprocessed by gm4 or gasp).
* @file
*
* @brief V850 Assembly File
* Very loose template for an include file for the cpu_asm.? file
* if it is implemented as a ".S" file (preprocessed by cpp) instead
* of a ".s" file (preprocessed by gm4 or gasp).
*/
/*