mirror of
https://github.com/espressif/openthread.git
synced 2026-07-04 03:10:23 +00:00
Nick Banks
92 lines
3.0 KiB
C
92 lines
3.0 KiB
C
/*
|
|
* Copyright (c) 2016, The OpenThread Authors.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the copyright holder nor the
|
|
* names of its contributors may be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @brief
|
|
* This file includes the platform abstraction for dynamic memory allocation.
|
|
*/
|
|
|
|
#ifndef MEMORY_H_
|
|
#define MEMORY_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @defgroup memory Memory
|
|
* @ingroup platform
|
|
*
|
|
* @brief
|
|
* This module includes the platform abstraction for dynamic memory allocation.
|
|
*
|
|
* @{
|
|
*
|
|
*/
|
|
|
|
// Currently, OpenThread only requires dynamic memory allocation when supporting multiple
|
|
// simultaneous instances, for MbedTls.
|
|
#ifdef OPENTHREAD_MULTIPLE_INSTANCE
|
|
|
|
/**
|
|
* Dynamically allocates new memory. On platforms that support it, should just redirect to calloc. For
|
|
* those that don't support calloc, should support the same functionality:
|
|
*
|
|
* "The calloc() function contiguously allocates enough space for count objects that are size bytes of
|
|
* memory each and returns a pointer to the allocated memory. The allocated memory is filled with bytes
|
|
* of value zero."
|
|
*
|
|
* @param[in] aNum The number of blocks to allocate
|
|
* @param[in] aSize The size of each block to allocate
|
|
*
|
|
* @retval void* The pointer to the front of the memory allocated
|
|
* @retval NULL Failed to allocate the memory requested.
|
|
*/
|
|
void *otPlatCAlloc(size_t aNum, size_t aSize);
|
|
|
|
/**
|
|
* Frees memory that was dynamically allocated.
|
|
*
|
|
* @param[in] aPtr A pointer the memory blocks to free. The pointer may be NULL.
|
|
*/
|
|
void otPlatFree(void *aPtr);
|
|
|
|
#endif
|
|
|
|
/**
|
|
* @}
|
|
*
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|
|
#endif // DEBUG_H_
|