rtems/score/wkspacedata.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreWorkspace
0007  *
0008  * @brief This header file provides data structures used by the implementation
0009  *   and the @ref RTEMSImplApplConfig to define ::_Workspace_Size,
0010  *   ::_Workspace_Is_unified, and ::_Workspace_Malloc_initializer.
0011  */
0012
0013 /*
0014  * Copyright (C) 2020 embedded brains GmbH & Co. KG
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifndef _RTEMS_SCORE_WKSPACEDATA_H
0039 #define _RTEMS_SCORE_WKSPACEDATA_H
0040
0041 #include <rtems/score/basedefs.h>
0042
0043 #ifdef __cplusplus
0044 extern "C" {
0045 #endif
0046
0047 struct Heap_Control;
0048
0049 /**
0050  * @defgroup RTEMSScoreWorkspace Workspace Handler
0051  *
0052  * @ingroup RTEMSScore
0053  *
0054  * @brief This group contains the Workspace Handler implementation.
0055  *
0056  * This handler encapsulates functionality related to the management of the
0057  * RTEMS Workspace.  It provides mechanisms which can be used to define,
0058  * initialize and manipulate the RTEMS Workspace.
0059  *
0060  * @{
0061  */
0062
0063 /**
0064  * @brief The workspace size in bytes.
0065  *
0066  * This constant is defined by the application configuration via
0067  * <rtems/confdefs.h>.
0068  */
0069 extern const uintptr_t _Workspace_Size;
0070
0071 /**
0072  * @brief Indicates if the workspace and C program heap are unified.
0073  *
0074  * This constant is defined by the application configuration via
0075  * <rtems/confdefs.h>.
0076  */
0077 extern const bool _Workspace_Is_unified;
0078
0079 /**
0080  * @brief Initializes the C Program Heap separated from the RTEMS Workspace.
0081  *
0082  * @return Returns the heap control used for the C Program Heap.
0083  */
0084 struct Heap_Control *_Workspace_Malloc_initialize_separate( void );
0085
0086 /**
0087  * @brief Initializes the C Program Heap so that it is unified with the RTEMS
0088  * Workspace.
0089  *
0090  * @return Returns the heap control used for the C Program Heap.
0091  */
0092 struct Heap_Control *_Workspace_Malloc_initialize_unified( void );
0093
0094 /**
0095  * @brief This constant provides the C Program Heap initialization handler.
0096  *
0097  * This constant is defined by the application configuration option
0098  * #CONFIGURE_UNIFIED_WORK_AREAS via <rtems/confdefs.h> or a default
0099  * configuration.
0100  */
0101 extern struct Heap_Control *( * const _Workspace_Malloc_initializer )( void );
0102
0103 /** @} */
0104
0105 #ifdef __cplusplus
0106 }
0107 #endif
0108
0109 #endif /* _RTEMS_SCORE_WKSPACEDATA_H */