rtems/score/wkspaceinitone.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreWorkspace
0007  *
0008  * @brief This header file provides the implementation of
0009  *   _Workspace_Initialize_for_one_area().
0010  */
0011
0012 /*
0013  * Copyright (C) 2012, 2020 embedded brains GmbH & Co. KG
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef _RTEMS_SCORE_WKSPACEINITONE_H
0038 #define _RTEMS_SCORE_WKSPACEINITONE_H
0039
0040 #include <rtems/score/wkspace.h>
0041 #include <rtems/score/assert.h>
0042 #include <rtems/score/heapimpl.h>
0043 #include <rtems/score/interr.h>
0044 #include <rtems/score/memory.h>
0045 #include <rtems/config.h>
0046
0047 #ifdef __cplusplus
0048 extern "C" {
0049 #endif
0050
0051 /**
0052  * @ingroup RTEMSScoreWorkspace
0053  *
0054  * @brief Initializes the RTEMS Workspace with support for exactly one memory
0055  *   area.
0056  *
0057  * This implementation should be used by BSPs which provide exactly one memory
0058  * area via _Memory_Get() to implement _Workspace_Handler_initialization().
0059  */
0060 static inline void _Workspace_Initialize_for_one_area( void )
0061 {
0062   uintptr_t                 page_size;
0063   uintptr_t                 wkspace_size;
0064   uintptr_t                 wkspace_size_with_overhead;
0065   const Memory_Information *mem;
0066   Memory_Area              *area;
0067   uintptr_t                 free_size;
0068   uintptr_t                 available_size;
0069
0070   page_size = CPU_HEAP_ALIGNMENT;
0071   wkspace_size = rtems_configuration_get_work_space_size();
0072   wkspace_size_with_overhead = wkspace_size + _Heap_Area_overhead( page_size );
0073
0074   mem = _Memory_Get();
0075   _Assert( _Memory_Get_count( mem ) == 1 );
0076
0077   area = _Memory_Get_area( mem, 0 );
0078   free_size = _Memory_Get_free_size( area );
0079
0080   if (
0081     wkspace_size < wkspace_size_with_overhead &&
0082     free_size >= wkspace_size_with_overhead
0083   ) {
0084     uintptr_t size;
0085
0086     if ( rtems_configuration_get_unified_work_area() ) {
0087       size = free_size;
0088     } else {
0089       size = wkspace_size_with_overhead;
0090     }
0091
0092     available_size = _Heap_Initialize(
0093       &_Workspace_Area,
0094       _Memory_Get_free_begin( area ),
0095       size,
0096       page_size
0097     );
0098
0099     _Memory_Consume( area, size );
0100   } else {
0101     /*
0102      * An unsigned integer overflow happened, or the available free memory is
0103      * not enough.
0104      */
0105     available_size = 0;
0106   }
0107
0108   if ( wkspace_size > available_size ) {
0109     _Internal_error( INTERNAL_ERROR_TOO_LITTLE_WORKSPACE );
0110   }
0111
0112   _Heap_Protection_set_delayed_free_fraction( &_Workspace_Area, 1 );
0113 }
0114
0115 #ifdef __cplusplus
0116 }
0117 #endif
0118
0119 #endif /* _RTEMS_SCORE_WKSPACEINITONE_H */