andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation related fixes. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2223 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
gdisirio 2010-10-02 12:22:20 +00:00
parent 9a42d59144
commit 631a5044e1
3 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
os/ports/GCC/PPC/SPC56x/ivor.s
View File

@ -18,7 +18,7 @@
*/ */
/** /**
* @file PPC/ivor.s * @file SPC56x/ivor.s
* @brief PowerPC IVORx handlers. * @brief PowerPC IVORx handlers.
* *
* @addtogroup PPC_CORE * @addtogroup PPC_CORE

2
os/ports/GCC/PPC/SPC56x/vectors.s
View File

@ -18,7 +18,7 @@
*/ */
/** /**
* @file PPC/SPC56x/vectors.s * @file SPC56x/vectors.s
* @brief SPC56x vectors table. * @brief SPC56x vectors table.
* *
* @addtogroup PPC_CORE * @addtogroup PPC_CORE

29
os/ports/GCC/PPC/port.dox
View File

@ -21,8 +21,11 @@
* @defgroup PPC Power Architecture * @defgroup PPC Power Architecture
* @details Power Architecture port for the GCC compiler. * @details Power Architecture port for the GCC compiler.
* *
* @section PPC_STATES Mapping of the System States in the PowerPC port * @section PPC_INTRO Introduction
* The ChibiOS/RT logical @ref system_states are mapped as follow in the * This port supports cores implementing a 32 bits Power Architecture.
*
* @section PPC_STATES Mapping of the System States in the Power Architecture port
* The ChibiOS/RT logical system states are mapped as follow in the
* PowerPC port: * PowerPC port:
* - <b>Init</b>. This state is represented by the startup code and the * - <b>Init</b>. This state is represented by the startup code and the
* initialization code before @p chSysInit() is executed. It has not a * initialization code before @p chSysInit() is executed. It has not a
@ -57,16 +60,15 @@
/** /**
* @defgroup PPC_CONF Configuration Options * @defgroup PPC_CONF Configuration Options
* @brief PowerPC Configuration Options. * @details PowerPC Configuration Options. The PowerPC port allows some
* @details The PowerPC port allows some architecture-specific configurations * architecture-specific configurations settings that can be overridden by
* settings that can be overridden by redefining them in @p chconf.h. * redefining them in @p chconf.h. Usually there is no need to change the
* Usually there is no need to change the default values. * default values.
* - @p INT_REQUIRED_STACK, this value represent the amount of stack space used * - @p INT_REQUIRED_STACK, this value represent the amount of stack space used
* by an interrupt handler between the @p extctx and @p intctx * by an interrupt handler between the @p extctx and @p intctx
* structures. * structures.
* The default for this value is @p 128 bytes, this space is allocated for * The default for this value is @p 128 bytes, this space is allocated for
* each thread so be careful in order to not waste precious RAM space.<br> * each thread so be careful in order to not waste precious RAM space.
* The default value is set into <b>./os/ports/GCC/PPC/chcore.h</b>.
* - @p IDLE_THREAD_STACK_SIZE, stack area size to be assigned to the IDLE * - @p IDLE_THREAD_STACK_SIZE, stack area size to be assigned to the IDLE
* thread. Usually there is no need to change this value unless inserting * thread. Usually there is no need to change this value unless inserting
* code in the IDLE thread hook macro. * code in the IDLE thread hook macro.
@ -87,13 +89,13 @@
/** /**
* @defgroup PPC_STARTUP Startup Support * @defgroup PPC_STARTUP Startup Support
* @brief PPC startup code support. * @brief
* @details ChibiOS/RT provides its own generic startup file for the PowerPC * @details PPC startup code support. ChibiOS/RT provides its own generic
* port. * startup file for the PowerPC port.
* Of course it is not mandatory to use it but care should be taken about the * Of course it is not mandatory to use it but care should be taken about the
* startup phase details. * startup phase details.
* *
* <h2>Startup Process</h2> * @section PPC_STARTUP_1 Startup Process
* The startup process, as implemented, is the following: * The startup process, as implemented, is the following:
* -# The stacks pointer is initialized into the area defined in the linker * -# The stacks pointer is initialized into the area defined in the linker
* script. * script.
@ -112,7 +114,7 @@
* -# Should the @p main() function return a branch is performed to the weak * -# Should the @p main() function return a branch is performed to the weak
* symbol @p main_exit. The default code is an endless empty loop. * symbol @p main_exit. The default code is an endless empty loop.
* . * .
* <h2>Expected linker symbols</h2> * @section PPC_STARTUP_2 Expected linker symbols
* The startup code starts at the symbol @p _boot_address and expects the * The startup code starts at the symbol @p _boot_address and expects the
* following symbols to be defined in the linker script: * following symbols to be defined in the linker script:
* - @p __ram_end__ RAM end location +1. * - @p __ram_end__ RAM end location +1.
@ -126,5 +128,4 @@
* - @p __ivpr_base__ IVPR register initialization address. * - @p __ivpr_base__ IVPR register initialization address.
* . * .
* @ingroup PPC * @ingroup PPC
* @file PPC/crt0.s Startup code.
*/ */