ns_hal_init.h

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