ns_hal_init.h

00001 /*
00002  * Copyright (c) 2016-2018 ARM Limited. All rights reserved.
00003  * SPDX-License-Identifier: Apache-2.0
00004  * Licensed under the Apache License, Version 2.0 (the License); you may
00005  * not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
00012  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef NS_HAL_INIT_H_
00018 #define NS_HAL_INIT_H_
00019 
00020 #include <stddef.h>
00021 #include "nsdynmemLIB.h"
00022 
00023 #ifdef __cplusplus
00024 extern "C" {
00025 #endif
00026 
00027 /**
00028  * Initialise core Nanostack HAL components.
00029  *
00030  * Calls after the first do nothing. So "major" users should make sure
00031  * they call this first with a "large" heap size, before anyone
00032  * requests a smaller one.
00033  *
00034  * Parameters are as for ns_dyn_mem_init (but note that nsdynmemlib
00035  * currently limits heap size to 16-bit, so be wary of passing large
00036  * sizes.
00037  *
00038  * If heap is NULL, h_size will be allocated from the malloc() heap,
00039  * else the passed-in pointer will be used.
00040  */
00041 void ns_hal_init(void *heap, size_t h_size, void (*passed_fptr)(heap_fail_t), mem_stat_t *info_ptr);
00042 
00043 #ifdef __cplusplus
00044 }
00045 #endif
00046 
00047 #endif /* NS_HAL_INIT_H_ */