git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@665 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
parent
239c51248d
commit
b094fe9dc1
26
docs/ch.txt
26
docs/ch.txt
|
@ -68,8 +68,7 @@
|
||||||
* @a Heap, @a Pool.
|
* @a Heap, @a Pool.
|
||||||
*
|
*
|
||||||
* @section api_suffixes API Names Suffixes
|
* @section api_suffixes API Names Suffixes
|
||||||
* The suffix is not present for normal APIs but can be one of
|
* The suffix can be one of the following:
|
||||||
* the following:
|
|
||||||
* - <b>None</b>, APIs without any suffix can be invoked only from the user
|
* - <b>None</b>, APIs without any suffix can be invoked only from the user
|
||||||
* code in the <b>Normal</b> state unless differently specified. See
|
* code in the <b>Normal</b> state unless differently specified. See
|
||||||
* @ref system_states.
|
* @ref system_states.
|
||||||
|
@ -84,10 +83,12 @@
|
||||||
* - <b>Regular Interrupts</b>. Maskable interrupt sources that cannot
|
* - <b>Regular Interrupts</b>. Maskable interrupt sources that cannot
|
||||||
* preempt the kernel code and are thus able to invoke operating system APIs
|
* preempt the kernel code and are thus able to invoke operating system APIs
|
||||||
* from within their handlers. The interrupt handlers belonging to this class
|
* from within their handlers. The interrupt handlers belonging to this class
|
||||||
* must be written following some rules. See the @ref System APIs group.
|
* must be written following some rules. See the @ref System APIs group and
|
||||||
|
* @ref article_interrupts.
|
||||||
* - <b>Fast Interrupts</b>. Maskable interrupt sources with the ability
|
* - <b>Fast Interrupts</b>. Maskable interrupt sources with the ability
|
||||||
* to preempt the kernel code and thus have a lower latency. Such sources are
|
* to preempt the kernel code and thus have a lower latency and are less
|
||||||
* not supported on all the architectures.<br>
|
* subject to jitter, see @ref article_jitter. Such sources are not
|
||||||
|
* supported on all the architectures.<br>
|
||||||
* Fast interrupts are not allowed to invoke any operating system API from
|
* Fast interrupts are not allowed to invoke any operating system API from
|
||||||
* within their handlers. Fast interrupt sources may however pend a lower
|
* within their handlers. Fast interrupt sources may however pend a lower
|
||||||
* priority regular interrupt where access to the operating system is
|
* priority regular interrupt where access to the operating system is
|
||||||
|
@ -239,9 +240,9 @@
|
||||||
*
|
*
|
||||||
* @section warea Thread Working Area
|
* @section warea Thread Working Area
|
||||||
* Each thread has its own stack, a Thread structure and some preemption
|
* Each thread has its own stack, a Thread structure and some preemption
|
||||||
* areas. All the structures are allocated into a "Thread working area",
|
* areas. All the structures are allocated into a "Thread Working Area",
|
||||||
* a thread private heap, usually allocated in an array declared in your
|
* a thread private heap, usually statically declared in your code.
|
||||||
* code. Threads do not use any memory outside the allocated working area
|
* Threads do not use any memory outside the allocated working area
|
||||||
* except when accessing static shared data.<br><br>
|
* except when accessing static shared data.<br><br>
|
||||||
* @image html workspace.png
|
* @image html workspace.png
|
||||||
* <br>
|
* <br>
|
||||||
|
@ -250,9 +251,9 @@
|
||||||
* registers on the stack of the switched-out thread and popping the registers
|
* registers on the stack of the switched-out thread and popping the registers
|
||||||
* of the switched-in thread from its stack.
|
* of the switched-in thread from its stack.
|
||||||
* The preemption area can be divided in up to three structures:
|
* The preemption area can be divided in up to three structures:
|
||||||
* - External context.
|
* - External Context.
|
||||||
* - Interrupt stack.
|
* - Interrupt Stack.
|
||||||
* - Internal context.
|
* - Internal Context.
|
||||||
*
|
*
|
||||||
* See the @ref Core documentation for details, the area may change on
|
* See the @ref Core documentation for details, the area may change on
|
||||||
* the various ports and some structures may not be present (or be zero-sized).
|
* the various ports and some structures may not be present (or be zero-sized).
|
||||||
|
@ -262,8 +263,7 @@
|
||||||
/**
|
/**
|
||||||
* @page Articles Articles
|
* @page Articles Articles
|
||||||
* @{
|
* @{
|
||||||
* @brief ChibiOS/RT Articles and Code Examples
|
* ChibiOS/RT Articles and Code Examples:
|
||||||
*
|
|
||||||
* - @subpage article_atomic
|
* - @subpage article_atomic
|
||||||
* - @subpage article_saveram
|
* - @subpage article_saveram
|
||||||
* - @subpage article_interrupts
|
* - @subpage article_interrupts
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
* @defgroup AT91SAM7X AT91SAM7X Support
|
* @defgroup AT91SAM7X AT91SAM7X Support
|
||||||
* @{
|
* @{
|
||||||
* @brief AT91SAM7X specific support.
|
* @brief AT91SAM7X specific support.
|
||||||
* The AT91SAM7X support includes:
|
* @details The AT91SAM7X support includes:
|
||||||
* - Buffered, interrupt driven, serial driver.
|
* - Buffered, interrupt driven, serial driver.
|
||||||
* - EMAC driver with MII support.
|
* - EMAC driver with MII support.
|
||||||
* - A demo supporting the kernel test suite.
|
* - A demo supporting the kernel test suite.
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
* @defgroup LPC214x LPC214x Support
|
* @defgroup LPC214x LPC214x Support
|
||||||
* @{
|
* @{
|
||||||
* @brief LPC214x specific support.
|
* @brief LPC214x specific support.
|
||||||
* The LPC214x support includes:
|
* @details The LPC214x support includes:
|
||||||
* - VIC support code.
|
* - VIC support code.
|
||||||
* - Buffered, interrupt driven, serial driver.
|
* - Buffered, interrupt driven, serial driver.
|
||||||
* - SSP driver.
|
* - SSP driver.
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
* @defgroup STM32F103 STM32F103 Support
|
* @defgroup STM32F103 STM32F103 Support
|
||||||
* @{
|
* @{
|
||||||
* @brief STM32F103 specific support.
|
* @brief STM32F103 specific support.
|
||||||
* The STM32F103 support includes:
|
* @details The STM32F103 support includes:
|
||||||
* - Buffered, interrupt driven, serial driver.
|
* - Buffered, interrupt driven, serial driver.
|
||||||
* - A demo supporting the kernel test suite.
|
* - A demo supporting the kernel test suite.
|
||||||
*
|
*
|
||||||
|
|
|
@ -69,8 +69,9 @@
|
||||||
* @defgroup ARMCM3_CONF Configuration Options
|
* @defgroup ARMCM3_CONF Configuration Options
|
||||||
* @{
|
* @{
|
||||||
* @brief ARM Cortex-M3 Configuration Options.
|
* @brief ARM Cortex-M3 Configuration Options.
|
||||||
* The ARMCM3 port allows some architecture-specific configurations settings
|
* @details The ARMCM3 port allows some architecture-specific configurations
|
||||||
* that can be specified externally, as example on the compiler command line:
|
* settings that can be specified externally, as example on the compiler
|
||||||
|
* command line:
|
||||||
* - @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.<br>
|
* structures.<br>
|
||||||
|
|
|
@ -40,8 +40,9 @@
|
||||||
* @defgroup AVR_CONF Configuration Options
|
* @defgroup AVR_CONF Configuration Options
|
||||||
* @{
|
* @{
|
||||||
* @brief AVR Configuration Options.
|
* @brief AVR Configuration Options.
|
||||||
* The AVR port allows some architecture-specific configurations settings
|
* @details The AVR port allows some architecture-specific configurations
|
||||||
* that can be specified externally, as example on the compiler command line:
|
* settingsthat can be specified externally, as example on the compiler
|
||||||
|
* command line:
|
||||||
* - @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
|
||||||
|
|
|
@ -39,8 +39,9 @@
|
||||||
* @defgroup MSP430_CONF Configuration Options
|
* @defgroup MSP430_CONF Configuration Options
|
||||||
* @{
|
* @{
|
||||||
* @brief MSP430 Configuration Options.
|
* @brief MSP430 Configuration Options.
|
||||||
* The MSP430 port allows some architecture-specific configurations settings
|
* @details The MSP430 port allows some architecture-specific configurations
|
||||||
* that can be specified externally, as example on the compiler command line:
|
* settings that can be specified externally, as example on the compiler
|
||||||
|
* command line:
|
||||||
* - @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
|
||||||
|
|
Loading…
Reference in New Issue