nwk_nvm.h

00001 /*
00002  * Copyright (c) 2017, 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 NWK_NVM_H_
00019 #define NWK_NVM_H_
00020 #include "net_nvm_api.h"
00021 
00022 
00023 /**
00024  * \brief Function to get setup from NVM
00025  *
00026  * \param parameters Updated wpan parameters
00027  *
00028  * \return Pointer for setup allways never NULL!
00029  */
00030 typedef wpan_nvm_params_t  *wpan_nvm_params_get(struct nwk_wpan_nvm_api *api, uint16_t pan_id);
00031 
00032 /**
00033  * \brief Function to update dynamic values caaled at every second and ifdown process
00034  *
00035  * \param if_down_call true for ifdown call and false
00036  */
00037 typedef void wpan_nvm_params_update(struct nwk_wpan_nvm_api *api, bool if_down_call);
00038 
00039 typedef struct nwk_wpan_nvm_api {
00040     wpan_nvm_params_t params;
00041     struct protocol_interface_info_entry *interface;
00042     wpan_nvm_params_get *nvm_params_get_cb;
00043     wpan_nvm_params_update *nvm_params_update_cb;
00044     wpan_params_updated *NVM_PUSH;
00045     wpan_params_get *NVM_GET;
00046 } nwk_wpan_nvm_api_t;
00047 
00048 #endif /* NWK_NVM_H_ */