rtems/src/workspace.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplClassic
0007  *
0008  * @brief This source file contains the implementation of
0009  *   rtems_workspace_get_information(), rtems_workspace_allocate(), and
0010  *   rtems_workspace_free().
0011  */
0012
0013 /*
0014  *  COPYRIGHT (c) 1989-2009.
0015  *  On-Line Applications Research Corporation (OAR).
0016  *
0017  * Redistribution and use in source and binary forms, with or without
0018  * modification, are permitted provided that the following conditions
0019  * are met:
0020  * 1. Redistributions of source code must retain the above copyright
0021  *    notice, this list of conditions and the following disclaimer.
0022  * 2. Redistributions in binary form must reproduce the above copyright
0023  *    notice, this list of conditions and the following disclaimer in the
0024  *    documentation and/or other materials provided with the distribution.
0025  *
0026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0036  * POSSIBILITY OF SUCH DAMAGE.
0037  */
0038
0039 #ifdef HAVE_CONFIG_H
0040 #include "config.h"
0041 #endif
0042
0043 #include <rtems/score/wkspace.h>
0044 #include <rtems/score/protectedheap.h>
0045 #include <rtems/score/interr.h>
0046 #include <rtems/config.h>
0047 #include <rtems/rtems/support.h>
0048
0049 #include <string.h>  /* for memset */
0050
0051 bool rtems_workspace_get_information(
0052   Heap_Information_block  *the_info
0053 )
0054 {
0055   if ( !the_info )
0056     return false;
0057
0058   return _Protected_heap_Get_information( &_Workspace_Area, the_info );
0059 }
0060
0061 bool rtems_workspace_allocate(
0062   size_t      bytes,
0063   void      **pointer
0064 )
0065 {
0066   void *ptr;
0067
0068   /*
0069    * check the arguments
0070    */
0071   if ( !pointer )
0072     return false;
0073
0074   if ( !bytes )
0075     return false;
0076
0077   /*
0078    * Allocate the memory
0079    */
0080   ptr =  _Protected_heap_Allocate( &_Workspace_Area, bytes );
0081   if (!ptr)
0082     return false;
0083
0084   *pointer = ptr;
0085   return true;
0086 }
0087
0088 bool rtems_workspace_free(
0089   void *pointer
0090 )
0091 {
0092    return _Protected_heap_Free( &_Workspace_Area, pointer );
0093 }
0094