michaelh/zephyr
1
0
Fork 0
Code Releases Activity

thread_stack: move up K_THREAD_STACK_RESERVED defn

Browse source 
Some forthcoming macros will need this. This may now
be individually defined by arch code instead of hanging
off of ARCH_THREAD_STACK_DEFINE.

Some additional details added to the documentation string.

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
This commit is contained in:
Andrew Boie 2020-04-23 13:35:37 -07:00 • committed by Anas Nashif
commit 27c8aadf94
1 changed files with 22 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

35
include/sys/thread_stack.h
View file

@ -60,6 +60,28 @@ static inline char *z_stack_ptr_align(char *ptr)
}
#define Z_STACK_PTR_ALIGN(ptr) ((uintptr_t)z_stack_ptr_align((char *)(ptr)))
/**
* @def K_THREAD_STACK_RESERVED
* @brief Indicate how much additional memory is reserved for stack objects
*
* Any given stack declaration may have additional memory in it for guard
* areas, supervisor mode stacks, or platform-specific data. This macro
* indicates how much space is reserved for this.
*
* This value only indicates memory that is permanently reserved in the stack
* object. Memory that is "borrowed" from the thread's stack buffer is never
* accounted for here.
*
* Reserved memory is at the beginning of the stack object. The reserved area
* must be appropriately sized such that the stack buffer immediately following
* it is correctly aligned.
*/
#ifdef ARCH_THREAD_STACK_RESERVED
#define K_THREAD_STACK_RESERVED ((size_t)(ARCH_THREAD_STACK_RESERVED))
#else
#define K_THREAD_STACK_RESERVED ((size_t)0U)
#endif
/**
* @brief Properly align the lowest address of a stack object
*
@ -112,7 +134,6 @@ static inline char *z_stack_ptr_align(char *ptr)
#define K_THREAD_STACK_LEN(size) ARCH_THREAD_STACK_LEN(size)
#define K_THREAD_STACK_MEMBER(sym, size) ARCH_THREAD_STACK_MEMBER(sym, size)
#define K_THREAD_STACK_SIZEOF(sym) ARCH_THREAD_STACK_SIZEOF(sym)
#define K_THREAD_STACK_RESERVED ((size_t)ARCH_THREAD_STACK_RESERVED)
static inline char *Z_THREAD_STACK_BUFFER(k_thread_stack_t *sym)
{
return ARCH_THREAD_STACK_BUFFER(sym);
@ -211,18 +232,6 @@ static inline char *Z_THREAD_STACK_BUFFER(k_thread_stack_t *sym)
*/
#define K_THREAD_STACK_SIZEOF(sym) sizeof(sym)
/**
* @brief Indicate how much additional memory is reserved for stack objects
*
* Any given stack declaration may have additional memory in it for guard
* areas or supervisor mode stacks. This macro indicates how much space
* is reserved for this. The memory reserved may not be contiguous within
* the stack object, and does not account for additional space used due to
* enforce alignment.
*/
#define K_THREAD_STACK_RESERVED ((size_t)0U)
/**
* @brief Get a pointer to the physical stack buffer
*