1 /*
2  * FreeRTOS Kernel V11.1.0
3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * https://www.FreeRTOS.org
25  * https://github.com/FreeRTOS
26  *
27  */
28 
29 #ifndef __SECURE_HEAP_H__
30 #define __SECURE_HEAP_H__
31 
32 /* Standard includes. */
33 #include <stdlib.h>
34 
35 /**
36  * @brief Allocates memory from heap.
37  *
38  * @param[in] xWantedSize The size of the memory to be allocated.
39  *
40  * @return Pointer to the memory region if the allocation is successful, NULL
41  * otherwise.
42  */
43 void * pvPortMalloc( size_t xWantedSize );
44 
45 /**
46  * @brief Frees the previously allocated memory.
47  *
48  * @param[in] pv Pointer to the memory to be freed.
49  */
50 void vPortFree( void * pv );
51 
52 /**
53  * @brief Get the free heap size.
54  *
55  * @return Free heap size.
56  */
57 size_t xPortGetFreeHeapSize( void );
58 
59 /**
60  * @brief Get the minimum ever free heap size.
61  *
62  * @return Minimum ever free heap size.
63  */
64 size_t xPortGetMinimumEverFreeHeapSize( void );
65 
66 #endif /* __SECURE_HEAP_H__ */
67