zcy
/
tinySA
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation related fixes. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2480 35acf78f-673a-0410-8e92-d51de3d6d3f4
master
gdisirio 2010-12-15 21:02:07 +00:00
parent 9757807049
commit c6b288f985
13 changed files with 127 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
os/kernel/templates/chcore.h
View File

@ -76,7 +76,7 @@ struct context {
}; };
/** /**
* @brief Platform dependent part of the @p chThdInit() API. * @brief Platform dependent part of the @p chThdCreateI() API.
* @details This code usually setup the context switching frame represented * @details This code usually setup the context switching frame represented
* by an @p intctx structure. * by an @p intctx structure.
*/ */

2
os/ports/GCC/ARM/chcore.h
View File

@ -174,7 +174,7 @@ struct context {
}; };
/** /**
* @brief Platform dependent part of the @p chThdInit() API. * @brief Platform dependent part of the @p chThdCreateI() API.
* @details This code usually setup the context switching frame represented * @details This code usually setup the context switching frame represented
* by an @p intctx structure. * by an @p intctx structure.
*/ */

2
os/ports/GCC/ARMCMx/chcore_v6m.h
View File

@ -72,7 +72,7 @@ struct intctx {
#endif #endif
/** /**
* @brief Platform dependent part of the @p chThdInit() API. * @brief Platform dependent part of the @p chThdCreateI() API.
* @details This code usually setup the context switching frame represented * @details This code usually setup the context switching frame represented
* by an @p intctx structure. * by an @p intctx structure.
*/ */

2
os/ports/GCC/ARMCMx/chcore_v7m.h
View File

@ -60,7 +60,7 @@ struct intctx {
#endif #endif
/** /**
* @brief Platform dependent part of the @p chThdInit() API. * @brief Platform dependent part of the @p chThdCreateI() API.
* @details This code usually setup the context switching frame represented * @details This code usually setup the context switching frame represented
* by an @p intctx structure. * by an @p intctx structure.
*/ */

2
os/ports/GCC/AVR/chcore.h
View File

@ -129,7 +129,7 @@ struct context {
}; };
/** /**
* @brief Platform dependent part of the @p chThdInit() API. * @brief Platform dependent part of the @p chThdCreateI() API.
* @details This code usually setup the context switching frame represented * @details This code usually setup the context switching frame represented
* by an @p intctx structure. * by an @p intctx structure.
*/ */

2
os/ports/GCC/MSP430/chcore.h
View File

@ -104,7 +104,7 @@ struct context {
}; };
/** /**
* @brief Platform dependent part of the @p chThdInit() API. * @brief Platform dependent part of the @p chThdCreateI() API.
* @details This code usually setup the context switching frame represented * @details This code usually setup the context switching frame represented
* by an @p intctx structure. * by an @p intctx structure.
*/ */

2
os/ports/GCC/PPC/chcore.h
View File

@ -167,7 +167,7 @@ struct context {
}; };
/** /**
* @brief Platform dependent part of the @p chThdInit() API. * @brief Platform dependent part of the @p chThdCreateI() API.
* @details This code usually setup the context switching frame represented * @details This code usually setup the context switching frame represented
* by an @p intctx structure. * by an @p intctx structure.
*/ */

2
os/ports/GCC/SIMIA32/chcore.h
View File

@ -84,7 +84,7 @@ struct context {
#define APUSH(p, a) (p) -= sizeof(void *), *(void **)(p) = (void*)(a) #define APUSH(p, a) (p) -= sizeof(void *), *(void **)(p) = (void*)(a)
/** /**
* Platform dependent part of the @p chThdInit() API. * Platform dependent part of the @p chThdCreateI() API.
* This code usually setup the context switching frame represented by a * This code usually setup the context switching frame represented by a
* @p intctx structure. * @p intctx structure.
*/ */

67
os/ports/IAR/ARMCMx/chcore.h
View File

@ -93,7 +93,8 @@
/** /**
* @brief Priority level to priority mask conversion macro. * @brief Priority level to priority mask conversion macro.
*/ */
#define CORTEX_PRIORITY_MASK(n) ((n) << (8 - CORTEX_PRIORITY_BITS)) #define CORTEX_PRIORITY_MASK(n) \
((n) << (8 - CORTEX_PRIORITY_BITS))
/*===========================================================================*/ /*===========================================================================*/
/* Port configurable parameters. */ /* Port configurable parameters. */
@ -163,7 +164,19 @@
* @note ARMv7-M architecture only. * @note ARMv7-M architecture only.
*/ */
#ifndef CORTEX_BASEPRI_KERNEL #ifndef CORTEX_BASEPRI_KERNEL
#define CORTEX_BASEPRI_KERNEL CORTEX_PRIORITY_MASK(CORTEX_PRIORITY_SVCALL+1) #define CORTEX_BASEPRI_KERNEL \
CORTEX_PRIORITY_MASK(CORTEX_PRIORITY_SVCALL+1)
#endif
/**
* @brief Stack alignment enforcement.
* @note The default value is 64 in order to comply with EABI, reducing
* the value to 32 can save some RAM space if you don't care about
* binary compatibility with EABI compiled libraries.
* @note Allowed values are 32 or 64.
*/
#ifndef CORTEX_STACK_ALIGNMENT
#define CORTEX_STACK_ALIGNMENT 64
#endif #endif
/*===========================================================================*/ /*===========================================================================*/
@ -178,18 +191,37 @@
#if defined(__DOXYGEN__) #if defined(__DOXYGEN__)
/** /**
* @brief Macro defining the specific ARM architecture. * @brief Macro defining the specific ARM architecture.
* @note This macro is for documentation only, the real name changes
* depending on the selected architecture, the possible names are:
* - CH_ARCHITECTURE_ARM_v6M.
* - CH_ARCHITECTURE_ARM_v7M.
* .
*/ */
#define CH_ARCHITECTURE_ARM_vxm #define CH_ARCHITECTURE_ARM_vxm
/** /**
* @brief Name of the implemented architecture. * @brief Name of the implemented architecture.
* @note The value is for documentation only, the real value changes
* depending on the selected architecture, the possible values are:
* - "ARMv6-M".
* - "ARMv7-M".
* - "ARMv7-ME".
* .
*/ */
#define CH_ARCHITECTURE_NAME "ARMvx-M" #define CH_ARCHITECTURE_NAME "ARMvx-M"
/** /**
* @brief Name of the architecture variant (optional). * @brief Name of the architecture variant (optional).
* @note The value is for documentation only, the real value changes
* depending on the selected architecture, the possible values are:
* - "Cortex-M0"
* - "Cortex-M1"
* - "Cortex-M3"
* - "Cortex-M4"
* .
*/ */
#define CH_CORE_VARIANT_NAME "Cortex-Mx" #define CH_CORE_VARIANT_NAME "Cortex-Mx"
#elif CORTEX_MODEL == CORTEX_M4 #elif CORTEX_MODEL == CORTEX_M4
#define CH_ARCHITECTURE_ARM_v7M #define CH_ARCHITECTURE_ARM_v7M
#define CH_ARCHITECTURE_NAME "ARMv7-ME" #define CH_ARCHITECTURE_NAME "ARMv7-ME"
@ -213,16 +245,42 @@
/*===========================================================================*/ /*===========================================================================*/
/** /**
* @brief 32 bits stack and memory alignment enforcement. * @brief Stack and memory alignment enforcement.
*/ */
#if (CORTEX_STACK_ALIGNMENT == 64) || defined(__DOXYGEN__)
typedef uint64_t stkalign_t;
#elif CORTEX_STACK_ALIGNMENT == 32
typedef uint32_t stkalign_t; typedef uint32_t stkalign_t;
#else
#error "invalid stack alignment selected"
#endif
/** /**
* @brief Generic ARM register. * @brief Generic ARM register.
*/ */
typedef void *regarm_t; typedef void *regarm_t;
#if !defined(__DOXYGEN__) #if defined(__DOXYGEN__)
/**
* @brief Interrupt saved context.
* @details This structure represents the stack frame saved during a
* preemption-capable interrupt handler.
* @note It is implemented to match the Cortex-Mx exception context.
*/
struct extctx {
/* Dummy definition, just for Doxygen.*/
};
/**
* @brief System saved context.
* @details This structure represents the inner stack frame during a context
* switching.
*/
struct intctx {
/* Dummy definition, just for Doxygen.*/
};
#endif
/** /**
* @brief Platform dependent part of the @p Thread structure. * @brief Platform dependent part of the @p Thread structure.
* @details In this port the structure just holds a pointer to the @p intctx * @details In this port the structure just holds a pointer to the @p intctx
@ -231,7 +289,6 @@ typedef void *regarm_t;
struct context { struct context {
struct intctx *r13; struct intctx *r13;
}; };
#endif
/** /**
* @brief Enforces a correct alignment for a stack area size value. * @brief Enforces a correct alignment for a stack area size value.

48
os/ports/IAR/ARMCMx/chcore_v6m.h
View File

@ -47,11 +47,6 @@ struct cmxctx {
}; };
#if !defined(__DOXYGEN__) #if !defined(__DOXYGEN__)
/**
* @brief Interrupt saved context.
* @details This structure represents the stack frame saved during a
* preemption-capable interrupt handler.
*/
struct extctx { struct extctx {
regarm_t xpsr; regarm_t xpsr;
regarm_t r12; regarm_t r12;
@ -62,14 +57,7 @@ struct extctx {
regarm_t r3; regarm_t r3;
regarm_t pc; regarm_t pc;
}; };
#endif
#if !defined(__DOXYGEN__)
/**
* @brief System saved context.
* @details This structure represents the inner stack frame during a context
* switching.
*/
struct intctx { struct intctx {
regarm_t r8; regarm_t r8;
regarm_t r9; regarm_t r9;
@ -92,9 +80,9 @@ struct intctx {
tp->p_ctx.r13 = (struct intctx *)((uint8_t *)workspace + \ tp->p_ctx.r13 = (struct intctx *)((uint8_t *)workspace + \
wsize - \ wsize - \
sizeof(struct intctx)); \ sizeof(struct intctx)); \
tp->p_ctx.r13->r4 = (void *)pf; \ tp->p_ctx.r13->r4 = pf; \
tp->p_ctx.r13->r5 = arg; \ tp->p_ctx.r13->r5 = arg; \
tp->p_ctx.r13->lr = (void *)_port_thread_start; \ tp->p_ctx.r13->lr = _port_thread_start; \
} }
/** /**
@ -102,11 +90,12 @@ struct intctx {
* @details This size depends on the idle thread implementation, usually * @details This size depends on the idle thread implementation, usually
* the idle thread should take no more space than those reserved * the idle thread should take no more space than those reserved
* by @p INT_REQUIRED_STACK. * by @p INT_REQUIRED_STACK.
* @note In this port it is set to 4 because the idle thread does have * @note In this port it is set to 8 because the idle thread does have
* a stack frame when compiling without optimizations. * a stack frame when compiling without optimizations. You may
* reduce this value to zero when compiling with optimizations.
*/ */
#ifndef IDLE_THREAD_STACK_SIZE #ifndef IDLE_THREAD_STACK_SIZE
#define IDLE_THREAD_STACK_SIZE 4 #define IDLE_THREAD_STACK_SIZE 8
#endif #endif
/** /**
@ -116,11 +105,12 @@ struct intctx {
* This value can be zero on those architecture where there is a * This value can be zero on those architecture where there is a
* separate interrupt stack and the stack space between @p intctx and * separate interrupt stack and the stack space between @p intctx and
* @p extctx is known to be zero. * @p extctx is known to be zero.
* @note This port requires some extra stack space for interrupt handling * @note In this port it is conservatively set to 16 because the function
* representing the frame of the function @p chSchDoRescheduleI(). * @p chSchDoRescheduleI() can have a stack frame, expecially with
* compiler optimizations disabled.
*/ */
#ifndef INT_REQUIRED_STACK #ifndef INT_REQUIRED_STACK
#define INT_REQUIRED_STACK 8 #define INT_REQUIRED_STACK 16
#endif #endif
/** /**
@ -157,16 +147,14 @@ struct intctx {
* @note @p id can be a function name or a vector number depending on the * @note @p id can be a function name or a vector number depending on the
* port implementation. * port implementation.
*/ */
#define PORT_IRQ_HANDLER(id) \ #define PORT_IRQ_HANDLER(id) void id(void)
void id(void)
/** /**
* @brief Fast IRQ handler function declaration. * @brief Fast IRQ handler function declaration.
* @note @p id can be a function name or a vector number depending on the * @note @p id can be a function name or a vector number depending on the
* port implementation. * port implementation.
*/ */
#define PORT_FAST_IRQ_HANDLER(id) \ #define PORT_FAST_IRQ_HANDLER(id) void id(void)
void id(void)
/** /**
* @brief Port-related initialization code. * @brief Port-related initialization code.
@ -183,14 +171,14 @@ struct intctx {
* @details Usually this function just disables interrupts but may perform * @details Usually this function just disables interrupts but may perform
* more actions. * more actions.
*/ */
#define port_lock() asm volatile ("cpsid i") #define port_lock() asm volatile ("cpsid i" : : : "memory")
/** /**
* @brief Kernel-unlock action. * @brief Kernel-unlock action.
* @details Usually this function just disables interrupts but may perform * @details Usually this function just disables interrupts but may perform
* more actions. * more actions.
*/ */
#define port_unlock() asm volatile ("cpsie i") #define port_unlock() asm volatile ("cpsie i" : : : "memory")
/** /**
* @brief Kernel-lock action from an interrupt handler. * @brief Kernel-lock action from an interrupt handler.
@ -213,17 +201,17 @@ struct intctx {
/** /**
* @brief Disables all the interrupt sources. * @brief Disables all the interrupt sources.
*/ */
#define port_disable() asm volatile ("cpsid i") #define port_disable() asm volatile ("cpsid i" : : : "memory")
/** /**
* @brief Disables the interrupt sources below kernel-level priority. * @brief Disables the interrupt sources below kernel-level priority.
*/ */
#define port_suspend() asm volatile ("cpsid i") #define port_suspend() asm volatile ("cpsid i" : : : "memory")
/** /**
* @brief Enables all the interrupt sources. * @brief Enables all the interrupt sources.
*/ */
#define port_enable() asm volatile ("cpsie i") #define port_enable() asm volatile ("cpsie i" : : : "memory")
/** /**
* @brief Enters an architecture-dependent IRQ-waiting mode. * @brief Enters an architecture-dependent IRQ-waiting mode.
@ -234,7 +222,7 @@ struct intctx {
* @note Implemented as an inlined @p WFI instruction. * @note Implemented as an inlined @p WFI instruction.
*/ */
#if CORTEX_ENABLE_WFI_IDLE || defined(__DOXYGEN__) #if CORTEX_ENABLE_WFI_IDLE || defined(__DOXYGEN__)
#define port_wait_for_interrupt() asm volatile ("wfi") #define port_wait_for_interrupt() asm volatile ("wfi" : : : "memory")
#else #else
#define port_wait_for_interrupt() #define port_wait_for_interrupt()
#endif #endif

42
os/ports/IAR/ARMCMx/chcore_v7m.h
View File

@ -18,10 +18,10 @@
*/ */
/** /**
* @file ARMCMx/chcore_v7m.h * @file IAR/ARMCMx/chcore_v7m.h
* @brief ARMv7-M architecture port macros and structures. * @brief ARMv7-M architecture port macros and structures.
* *
* @addtogroup ARMCMx_V7M_CORE * @addtogroup IAR_ARMCMx_V7M_CORE
* @{ * @{
*/ */
@ -33,12 +33,6 @@
/*===========================================================================*/ /*===========================================================================*/
#if !defined(__DOXYGEN__) #if !defined(__DOXYGEN__)
/**
* @brief Interrupt saved context.
* @details This structure represents the stack frame saved during a
* preemption-capable interrupt handler.
* @note It is implemented to match the Cortex-Mx exception context.
*/
struct extctx { struct extctx {
regarm_t r0; regarm_t r0;
regarm_t r1; regarm_t r1;
@ -49,14 +43,7 @@ struct extctx {
regarm_t pc; regarm_t pc;
regarm_t xpsr; regarm_t xpsr;
}; };
#endif
#if !defined(__DOXYGEN__)
/**
* @brief System saved context.
* @details This structure represents the inner stack frame during a context
* switching.
*/
struct intctx { struct intctx {
regarm_t r4; regarm_t r4;
regarm_t r5; regarm_t r5;
@ -81,9 +68,9 @@ struct intctx {
tp->p_ctx.r13 = (struct intctx *)((uint8_t *)workspace + \ tp->p_ctx.r13 = (struct intctx *)((uint8_t *)workspace + \
wsize - \ wsize - \
sizeof(struct intctx)); \ sizeof(struct intctx)); \
tp->p_ctx.r13->r4 = (void *)pf; \ tp->p_ctx.r13->r4 = pf; \
tp->p_ctx.r13->r5 = arg; \ tp->p_ctx.r13->r5 = arg; \
tp->p_ctx.r13->lr = (void *)_port_thread_start; \ tp->p_ctx.r13->lr = _port_thread_start; \
} }
/** /**
@ -91,11 +78,12 @@ struct intctx {
* @details This size depends on the idle thread implementation, usually * @details This size depends on the idle thread implementation, usually
* the idle thread should take no more space than those reserved * the idle thread should take no more space than those reserved
* by @p INT_REQUIRED_STACK. * by @p INT_REQUIRED_STACK.
* @note In this port it is set to 4 because the idle thread does have * @note In this port it is set to 8 because the idle thread does have
* a stack frame when compiling without optimizations. * a stack frame when compiling without optimizations. You may
* reduce this value to zero when compiling with optimizations.
*/ */
#ifndef IDLE_THREAD_STACK_SIZE #ifndef IDLE_THREAD_STACK_SIZE
#define IDLE_THREAD_STACK_SIZE 4 #define IDLE_THREAD_STACK_SIZE 8
#endif #endif
/** /**
@ -105,10 +93,12 @@ struct intctx {
* This value can be zero on those architecture where there is a * This value can be zero on those architecture where there is a
* separate interrupt stack and the stack space between @p intctx and * separate interrupt stack and the stack space between @p intctx and
* @p extctx is known to be zero. * @p extctx is known to be zero.
* @note This port requires no extra stack space for interrupt handling. * @note In this port it is conservatively set to 16 because the function
* @p chSchDoRescheduleI() can have a stack frame, expecially with
* compiler optimizations disabled.
*/ */
#ifndef INT_REQUIRED_STACK #ifndef INT_REQUIRED_STACK
#define INT_REQUIRED_STACK 0 #define INT_REQUIRED_STACK 16
#endif #endif
/** /**
@ -130,16 +120,14 @@ struct intctx {
* @note @p id can be a function name or a vector number depending on the * @note @p id can be a function name or a vector number depending on the
* port implementation. * port implementation.
*/ */
#define PORT_IRQ_HANDLER(id) \ #define PORT_IRQ_HANDLER(id) void id(void)
void id(void)
/** /**
* @brief Fast IRQ handler function declaration. * @brief Fast IRQ handler function declaration.
* @note @p id can be a function name or a vector number depending on the * @note @p id can be a function name or a vector number depending on the
* port implementation. * port implementation.
*/ */
#define PORT_FAST_IRQ_HANDLER(id) \ #define PORT_FAST_IRQ_HANDLER(id) void id(void)
void id(void)
/** /**
* @brief Port-related initialization code. * @brief Port-related initialization code.
@ -222,7 +210,7 @@ struct intctx {
* @note Implemented as an inlined @p WFI instruction. * @note Implemented as an inlined @p WFI instruction.
*/ */
#if CORTEX_ENABLE_WFI_IDLE || defined(__DOXYGEN__) #if CORTEX_ENABLE_WFI_IDLE || defined(__DOXYGEN__)
#define port_wait_for_interrupt() #define port_wait_for_interrupt() asm ("wfi")
#else #else
#define port_wait_for_interrupt() #define port_wait_for_interrupt()
#endif #endif

2
os/ports/RC/STM8/chcore.h
View File

@ -127,7 +127,7 @@ struct stm8_startctx {
}; };
/** /**
* @brief Platform dependent part of the @p chThdInit() API. * @brief Platform dependent part of the @p chThdCreateI() API.
* @details This code usually setup the context switching frame represented * @details This code usually setup the context switching frame represented
* by an @p intctx structure. * by an @p intctx structure.
*/ */

2
os/ports/cosmic/STM8/chcore.h
View File

@ -125,7 +125,7 @@ struct stm8_startctx {
}; };
/** /**
* @brief Platform dependent part of the @p chThdInit() API. * @brief Platform dependent part of the @p chThdCreateI() API.
* @details This code usually setup the context switching frame represented * @details This code usually setup the context switching frame represented
* by an @p intctx structure. * by an @p intctx structure.
*/ */