* arch/xtensa/src/esp32/esp32_rtcheap.h
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __ARCH_XTENSA_SRC_ESP32_ESP32_RTCHEAP_H
#define __ARCH_XTENSA_SRC_ESP32_ESP32_RTCHEAP_H
* Public Function Prototypes
****************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
struct mallinfo;
* Name: esp32_rtcheap_initialize
*
* Description:
* Initialize the RTC heap.
*
****************************************************************************/
void esp32_rtcheap_initialize(void);
* Name: esp32_rtcheap_malloc
*
* Description:
* Allocate memory from the RTC heap.
*
* Parameters:
* size - Size (in bytes) of the memory region to be allocated.
*
****************************************************************************/
void *esp32_rtcheap_malloc(size_t size);
* Name: esp32_rtcheap_calloc
*
* Description:
* Calculates the size of the allocation and allocate memory from
* the RTC heap.
*
****************************************************************************/
void *esp32_rtcheap_calloc(size_t n, size_t elem_size);
* Name: esp32_rtcheap_realloc
*
* Description:
* Reallocate memory from the RTC heap.
*
****************************************************************************/
void *esp32_rtcheap_realloc(void *ptr, size_t size);
* Name: esp32_rtcheap_zalloc
*
* Description:
* Allocate and zero memory from the RTC heap.
*
****************************************************************************/
void *esp32_rtcheap_zalloc(size_t size);
* Name: esp32_rtcheap_free
*
* Description:
* Free memory from the RTC heap.
*
****************************************************************************/
void esp32_rtcheap_free(void *mem);
* Name: esp32_rtcheap_memalign
*
* Description:
* memalign requests more than enough space from malloc, finds a region
* within that chunk that meets the alignment request and then frees any
* leading or trailing space.
*
* The alignment argument must be a power of two (not checked). 8-byte
* alignment is guaranteed by normal malloc calls.
*
****************************************************************************/
void *esp32_rtcheap_memalign(size_t alignment, size_t size);
* Name: esp32_rtcheap_heapmember
*
* Description:
* Check if an address lies in the RTC heap.
*
* Parameters:
* mem - The address to check
*
* Return Value:
* True if the address is a member of the RTC heap. False if not.
*
****************************************************************************/
bool esp32_rtcheap_heapmember(void *mem);
* Name: esp32_rtcheap_mallinfo
*
* Description:
* mallinfo returns a copy of updated current heap information for the
* user heap.
*
****************************************************************************/
struct mallinfo esp32_rtcheap_mallinfo(void);
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif