net_fhss.h

00001 /*
00002  * Copyright (c) 2015-2017 ARM Limited. All rights reserved.
00003  *
00004  * SPDX-License-Identifier: LicenseRef-PBL
00005  *
00006  * Licensed under the Permissive Binary License, Version 1.0 (the "License"); you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  * https://www.mbed.com/licenses/PBL-1.0
00010  *
00011  * See the License for the specific language governing permissions and limitations under the License.
00012  *
00013  */
00014 
00015 /**
00016  * \file net_fhss.h
00017  * \brief FHSS API
00018  *
00019  */
00020 
00021 #ifndef NET_FHSS_H_
00022 #define NET_FHSS_H_
00023 #include "ns_types.h"
00024 
00025 #ifdef __cplusplus
00026 extern "C" {
00027 #endif
00028 
00029 /**
00030  * @brief Creates FHSS API instance which will be registered to software MAC.
00031  * @param fhss_configuration Basic FHSS configuration.
00032  * @param fhss_timer FHSS platform timer interface and configuration.
00033  * @param fhss_statistics FHSS statistics storage.
00034  * @return New FHSS instance if successful, NULL otherwise.
00035  */
00036 extern fhss_api_t *ns_fhss_create(const fhss_configuration_t *fhss_configuration, const fhss_timer_t *fhss_timer, fhss_statistics_t *fhss_statistics);
00037 
00038 /**
00039  * @brief Set synchronization time configuration for FHSS network. Should be only called from Border router.
00040  * @param fhss_api FHSS instance.
00041  * @param fhss_synch_configuration FHSS synchronization time configuration.
00042  * @return 0 on success, -1 on fail.
00043  */
00044 extern int ns_fhss_configuration_set(fhss_api_t *fhss_api, const fhss_synch_configuration_t *fhss_synch_configuration);
00045 
00046 /**
00047  * @brief Deletes a FHSS API instance and removes it from software MAC.
00048  * @param fhss_api FHSS instance.
00049  * @return 0 on success, -1 on fail.
00050  */
00051 extern int ns_fhss_delete(fhss_api_t *fhss_api);
00052 
00053 
00054 #ifdef __cplusplus
00055 }
00056 #endif
00057 
00058 #endif /* NET_FHSS_H_ */