include/bsp/stackalloc.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup bsp_stack
0007  *
0008  * @brief Task stack initialization, allocation and free functions.
0009  */
0010
0011 /*
0012  * Copyright (C) 2009, 2012 embedded brains GmbH & Co. KG
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 #ifndef LIBBSP_SHARED_STACK_ALLOC_H
0037 #define LIBBSP_SHARED_STACK_ALLOC_H
0038
0039 #include <stddef.h>
0040 #include <stdint.h>
0041
0042 #ifdef __cplusplus
0043 extern "C" {
0044 #endif /* __cplusplus */
0045
0046 /**
0047  * @defgroup bsp_stack Task Stack Allocator
0048  *
0049  * @ingroup RTEMSBSPsShared
0050  *
0051  * @brief Task stack initialization, allocation and free functions.
0052  *
0053  * Initialize the task stack allocator with bsp_stack_initialize().  To enable
0054  * the task stack allocator use the following in the system configuration:
0055  *
0056  * @code
0057  * #include <bsp/stackalloc.h>
0058  *
0059  * #define CONFIGURE_INIT
0060  *
0061  * #include <confdefs.h>
0062  * @endcode
0063  *
0064  * @{
0065  */
0066
0067 /**
0068  * @brief Task stack allocator initialization for
0069  * @ref CONFIGURE_TASK_STACK_ALLOCATOR_INIT.
0070  */
0071 void bsp_stack_allocate_init(size_t stack_space_size);
0072
0073 /**
0074  * @brief Task stack allocator for @ref CONFIGURE_TASK_STACK_ALLOCATOR.
0075  *
0076  * In case the designated task stack space from bsp_stack_initialize() is
0077  * completely in use the work space will be used to allocate the stack.
0078  */
0079 void *bsp_stack_allocate(size_t size);
0080
0081 /**
0082  * @brief Task stack free function for @ref CONFIGURE_TASK_STACK_DEALLOCATOR.
0083  */
0084 void bsp_stack_free(void *stack);
0085
0086 /**
0087  * @brief Task stack allocator initialization configuration option.
0088  */
0089 #define CONFIGURE_TASK_STACK_ALLOCATOR_INIT bsp_stack_allocate_init
0090
0091 /**
0092  * @brief Task stack allocator configuration option.
0093  */
0094 #define CONFIGURE_TASK_STACK_ALLOCATOR bsp_stack_allocate
0095
0096 /**
0097  * @brief Task stack deallocator configuration option.
0098  */
0099 #define CONFIGURE_TASK_STACK_DEALLOCATOR bsp_stack_free
0100
0101 /** @} */
0102
0103 #ifdef __cplusplus
0104 }
0105 #endif /* __cplusplus */
0106
0107 #endif /* LIBBSP_SHARED_STACK_ALLOC_H */