Daiki Kato / mbed-os-lychee

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

features/FEATURE_COMMON_PAL/nanostack-libservice/mbed-client-libservice/nsdynmemLIB.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dkato 0:f782d9c66c49 1 /*
dkato 0:f782d9c66c49 2 * Copyright (c) 2014-2016 ARM Limited. All rights reserved.
dkato 0:f782d9c66c49 3 * SPDX-License-Identifier: Apache-2.0
dkato 0:f782d9c66c49 4 * Licensed under the Apache License, Version 2.0 (the License); you may
dkato 0:f782d9c66c49 5 * not use this file except in compliance with the License.
dkato 0:f782d9c66c49 6 * You may obtain a copy of the License at
dkato 0:f782d9c66c49 7 *
dkato 0:f782d9c66c49 8 * http://www.apache.org/licenses/LICENSE-2.0
dkato 0:f782d9c66c49 9 *
dkato 0:f782d9c66c49 10 * Unless required by applicable law or agreed to in writing, software
dkato 0:f782d9c66c49 11 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
dkato 0:f782d9c66c49 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dkato 0:f782d9c66c49 13 * See the License for the specific language governing permissions and
dkato 0:f782d9c66c49 14 * limitations under the License.
dkato 0:f782d9c66c49 15 */
dkato 0:f782d9c66c49 16
dkato 0:f782d9c66c49 17
dkato 0:f782d9c66c49 18 /**
dkato 0:f782d9c66c49 19 * \file nsdynmemLIB.h
dkato 0:f782d9c66c49 20 * \brief Dynamical Memory API for library model
dkato 0:f782d9c66c49 21 *
dkato 0:f782d9c66c49 22 */
dkato 0:f782d9c66c49 23 #ifndef NSDYNMEMLIB_H_
dkato 0:f782d9c66c49 24 #define NSDYNMEMLIB_H_
dkato 0:f782d9c66c49 25 #ifdef __cplusplus
dkato 0:f782d9c66c49 26 extern "C" {
dkato 0:f782d9c66c49 27 #endif
dkato 0:f782d9c66c49 28
dkato 0:f782d9c66c49 29 #include "ns_types.h"
dkato 0:f782d9c66c49 30
dkato 0:f782d9c66c49 31 /*!
dkato 0:f782d9c66c49 32 * \enum heap_fail_t
dkato 0:f782d9c66c49 33 * \brief Dynamically heap system failure call back event types.
dkato 0:f782d9c66c49 34 */
dkato 0:f782d9c66c49 35 typedef enum {
dkato 0:f782d9c66c49 36 NS_DYN_MEM_NULL_FREE, /**< ns_dyn_mem_free(), NULL pointer free [obsolete - no longer faulted] */
dkato 0:f782d9c66c49 37 NS_DYN_MEM_DOUBLE_FREE, /**< ns_dyn_mem_free(), Possible double pointer free */
dkato 0:f782d9c66c49 38 NS_DYN_MEM_ALLOCATE_SIZE_NOT_VALID, /**< Allocate size is 0 or smaller or size is bigger than max heap size */
dkato 0:f782d9c66c49 39 NS_DYN_MEM_POINTER_NOT_VALID, /**< ns_dyn_mem_free(), try to free pointer which not at heap sector */
dkato 0:f782d9c66c49 40 NS_DYN_MEM_HEAP_SECTOR_CORRUPTED, /**< Heap system detect sector corruption */
dkato 0:f782d9c66c49 41 NS_DYN_MEM_HEAP_SECTOR_UNITIALIZED /**< ns_dyn_mem_free(), ns_dyn_mem_temporary_alloc() or ns_dyn_mem_alloc() called before ns_dyn_mem_init() */
dkato 0:f782d9c66c49 42 } heap_fail_t;
dkato 0:f782d9c66c49 43
dkato 0:f782d9c66c49 44 /**
dkato 0:f782d9c66c49 45 * /struct mem_stat_t
dkato 0:f782d9c66c49 46 * /brief Struct for Memory stats Buffer structure
dkato 0:f782d9c66c49 47 */
dkato 0:f782d9c66c49 48 typedef struct mem_stat_t {
dkato 0:f782d9c66c49 49 /*Heap stats*/
dkato 0:f782d9c66c49 50 int16_t heap_sector_size; /**< Heap total Sector len. */
dkato 0:f782d9c66c49 51 int16_t heap_sector_alloc_cnt; /**< Reserved Heap sector cnt. */
dkato 0:f782d9c66c49 52 int16_t heap_sector_allocated_bytes; /**< Reserved Heap data in bytes. */
dkato 0:f782d9c66c49 53 int16_t heap_sector_allocated_bytes_max; /**< Reserved Heap data in bytes max value. */
dkato 0:f782d9c66c49 54 uint32_t heap_alloc_total_bytes; /**< Total Heap allocated bytes. */
dkato 0:f782d9c66c49 55 uint32_t heap_alloc_fail_cnt; /**< Counter for Heap allocation fail. */
dkato 0:f782d9c66c49 56 } mem_stat_t;
dkato 0:f782d9c66c49 57
dkato 0:f782d9c66c49 58 /**
dkato 0:f782d9c66c49 59 * \brief Init and set Dynamical heap pointer and length.
dkato 0:f782d9c66c49 60 *
dkato 0:f782d9c66c49 61 * \param heap_ptr Pointer to dynamically heap buffer
dkato 0:f782d9c66c49 62 * \param heap_size size of the heap buffer
dkato 0:f782d9c66c49 63 * \return None
dkato 0:f782d9c66c49 64 */
dkato 0:f782d9c66c49 65 extern void ns_dyn_mem_init(uint8_t *heap, uint16_t h_size, void (*passed_fptr)(heap_fail_t), mem_stat_t *info_ptr);
dkato 0:f782d9c66c49 66
dkato 0:f782d9c66c49 67
dkato 0:f782d9c66c49 68 /**
dkato 0:f782d9c66c49 69 * \brief Free allocated memory.
dkato 0:f782d9c66c49 70 *
dkato 0:f782d9c66c49 71 * \param heap_ptr Pointer to allocated memory
dkato 0:f782d9c66c49 72 *
dkato 0:f782d9c66c49 73 * \return 0, Free OK
dkato 0:f782d9c66c49 74 * \return <0, Free Fail
dkato 0:f782d9c66c49 75 */
dkato 0:f782d9c66c49 76 extern void ns_dyn_mem_free(void *heap_ptr);
dkato 0:f782d9c66c49 77 /**
dkato 0:f782d9c66c49 78 * \brief Allocate temporary data.
dkato 0:f782d9c66c49 79 *
dkato 0:f782d9c66c49 80 * Space allocate started from beginning of the heap sector
dkato 0:f782d9c66c49 81 *
dkato 0:f782d9c66c49 82 * \param alloc_size Allocated data size
dkato 0:f782d9c66c49 83 *
dkato 0:f782d9c66c49 84 * \return 0, Allocate Fail
dkato 0:f782d9c66c49 85 * \return >0, Pointer to allocated data sector.
dkato 0:f782d9c66c49 86 */
dkato 0:f782d9c66c49 87 extern void *ns_dyn_mem_temporary_alloc(int16_t alloc_size);
dkato 0:f782d9c66c49 88 /**
dkato 0:f782d9c66c49 89 * \brief Allocate long period data.
dkato 0:f782d9c66c49 90 *
dkato 0:f782d9c66c49 91 * Space allocate started from end of the heap sector
dkato 0:f782d9c66c49 92 *
dkato 0:f782d9c66c49 93 * \param alloc_size Allocated data size
dkato 0:f782d9c66c49 94 *
dkato 0:f782d9c66c49 95 * \return 0, Allocate Fail
dkato 0:f782d9c66c49 96 * \return >0, Pointer to allocated data sector.
dkato 0:f782d9c66c49 97 */
dkato 0:f782d9c66c49 98 extern void *ns_dyn_mem_alloc(int16_t alloc_size);
dkato 0:f782d9c66c49 99
dkato 0:f782d9c66c49 100 /**
dkato 0:f782d9c66c49 101 * \brief Get pointer to the current mem_stat_t set via ns_dyn_mem_init.
dkato 0:f782d9c66c49 102 *
dkato 0:f782d9c66c49 103 * Get pointer to the statistics information, if one is set during the
dkato 0:f782d9c66c49 104 * initialization. This may be useful for statistics collection purposes.
dkato 0:f782d9c66c49 105 *
dkato 0:f782d9c66c49 106 * Note: the caller may not modify the returned structure.
dkato 0:f782d9c66c49 107 *
dkato 0:f782d9c66c49 108 * \return NULL, no mem_stat_t was given on initialization
dkato 0:f782d9c66c49 109 * \return !=0, Pointer to mem_stat_t.
dkato 0:f782d9c66c49 110 */
dkato 0:f782d9c66c49 111 extern const mem_stat_t *ns_dyn_mem_get_mem_stat(void);
dkato 0:f782d9c66c49 112
dkato 0:f782d9c66c49 113 #ifdef __cplusplus
dkato 0:f782d9c66c49 114 }
dkato 0:f782d9c66c49 115 #endif
dkato 0:f782d9c66c49 116 #endif /* NSDYNMEMLIB_H_ */
dkato 0:f782d9c66c49 117