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@2222 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
gdisirio 2010-10-02 11:04:23 +00:00
parent 55848af13c
commit 9a42d59144
2 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -54,15 +54,14 @@
/** /**
* @defgroup AVR_CONF Configuration Options * @defgroup AVR_CONF Configuration Options
* @brief AVR Configuration Options. * @details AVR Configuration Options. The AVR port allows some
* @details The AVR port allows some architecture-specific configurations * architecture-specific configurations settings that can be overridden
* settings that can be overridden by redefining them in @p chconf.h. * by redefining them in @p chconf.h. Usually there is no need to change
* Usually there is no need to change the default values. * the default values.
* - @p INT_REQUIRED_STACK, this value represent the amount of stack space * - @p INT_REQUIRED_STACK, this value represent the amount of stack space
* used by the interrupt handlers.<br> * used by the interrupt handlers.<br>
* The default for this value is @p 32, this space is allocated for each * The default for this value is @p 32, this space is allocated for each
* thread so be careful in order to not waste precious RAM space.<br> * thread so be careful in order to not waste precious RAM space.
* The default value is set into <b>./os/ports/GCC/AVR/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.
@ -70,12 +69,18 @@
* @ingroup AVR * @ingroup AVR
*/ */
/** /**
* @defgroup AVR_CORE AVR Core Implementation * @defgroup AVR_STARTUP Startup Support
* @brief AVR specific port code, structures and macros. * @details ChibiOS/RT doed not provide startup files for the AVR, there
* are no special startup requirement so the normal toolchain-provided
* startup files can be used.
*
* @ingroup AVR
*/
/**
* @defgroup AVR_CORE AVR Core Implementation
* @details AVR specific port code, structures and macros.
* *
* @ingroup AVR * @ingroup AVR
* @file AVR/chtypes.h Port types.
* @file AVR/chcore.h Port related structures and macros.
* @file AVR/chcore.c Port related code.
*/ */

7
os/ports/GCC/MSP430/port.dox
View File

@ -48,8 +48,8 @@
* . * .
* @section MSP430_NOTES The MSP430 port notes * @section MSP430_NOTES The MSP430 port notes
* - The MSP430 does not have a dedicated interrupt stack, make sure to reserve * - The MSP430 does not have a dedicated interrupt stack, make sure to reserve
* enough stack space for interrupts in each thread stack. This can be done * enough stack space for interrupts in each thread stack. This can be done
* by modifying the @p INT_REQUIRED_STACK configuration options. * by modifying the @p INT_REQUIRED_STACK configuration options.
* - The state of the hardware multiplier is not saved in the thread context, * - The state of the hardware multiplier is not saved in the thread context,
* make sure to use it in <b>Suspended</b> state (interrupts masked). * make sure to use it in <b>Suspended</b> state (interrupts masked).
* - The port code does not define the switch to a low power mode for the * - The port code does not define the switch to a low power mode for the
@ -69,8 +69,7 @@
* - @p INT_REQUIRED_STACK, this value represent the amount of stack space * - @p INT_REQUIRED_STACK, this value represent the amount of stack space
* used by the interrupt handlers.<br> * used by the interrupt handlers.<br>
* The default for this value is @p 32, this space is allocated for each * The default for this value is @p 32, this space is allocated for each
* thread so be careful in order to not waste precious RAM space.<br> * thread so be careful in order to not waste precious RAM space.
* The default value is set into <b>./os/ports/GCC/MSP430/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.