blob: 0c16b8d98bb22b381f9c8cfee186de6f82868a38 (
plain) (
tree)
|
|
/**
* @file rtems/score/stack.inl
*
* This file contains the static inline implementation of the inlined
* routines from the Stack Handler.
*/
/*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*
* $Id$
*/
#ifndef _RTEMS_SCORE_STACK_H
# error "Never use <rtems/score/stack.inl> directly; include <rtems/score/stack.h> instead."
#endif
#ifndef _RTEMS_SCORE_STACK_INL
#define _RTEMS_SCORE_STACK_INL
/**
* @addtogroup ScoreStack
* @{
*/
/**
* This routine initializes the_stack record to indicate that
* size bytes of memory starting at starting_address have been
* reserved for a stack.
*/
RTEMS_INLINE_ROUTINE void _Stack_Initialize (
Stack_Control *the_stack,
void *starting_address,
size_t size
)
{
the_stack->area = starting_address;
the_stack->size = size;
}
/**
* This function returns the minimum stack size configured
* for this application.
*
* @return This method returns the minimum stack size;
*/
RTEMS_INLINE_ROUTINE uint32_t _Stack_Minimum (void)
{
return rtems_minimum_stack_size;
}
/**
* This function returns TRUE if size bytes is enough memory for
* a valid stack area on this processor, and FALSE otherwise.
*
* @param[in] size is the stack size to check
*
* @return This method returns TRUE if the stack is large enough.
*/
RTEMS_INLINE_ROUTINE bool _Stack_Is_enough (
size_t size
)
{
return ( size >= _Stack_Minimum() );
}
/**
* This function returns the appropriate stack size given the requested
* size. If the requested size is below the minimum, then the minimum
* configured stack size is returned.
*
* @param[in] size is the stack size to check
*
* @return This method returns the appropriate stack size.
*/
RTEMS_INLINE_ROUTINE size_t _Stack_Ensure_minimum (
size_t size
)
{
if ( size >= _Stack_Minimum() )
return size;
return _Stack_Minimum();
}
/**
* This function increases the stack size to ensure that the thread
* has the desired amount of stack space after the initial stack
* pointer is determined based on alignment restrictions.
*
* @note
*
* The amount of adjustment for alignment is CPU dependent.
*/
RTEMS_INLINE_ROUTINE uint32_t _Stack_Adjust_size (
size_t size
)
{
return size + CPU_STACK_ALIGNMENT;
}
/**@}*/
#endif
/* end of include file */
|
