rpl_policy.h

00001 /*
00002  * Copyright (c) 2015-2017, 2019, 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 RPL_POLICY_H_
00019 #define RPL_POLICY_H_
00020 
00021 #include "Core/include/ns_address_internal.h"
00022 #include "rpl_control.h"
00023 
00024 bool rpl_policy_join_instance(rpl_domain_t *domain, uint8_t instance_id, const uint8_t *dodagid);
00025 bool rpl_policy_join_dodag(rpl_domain_t *domain, uint8_t g_mop_prf, uint8_t instance_id, const uint8_t *dodagid);
00026 bool rpl_policy_join_config(rpl_domain_t *domain, const rpl_dodag_conf_t *conf, bool *leaf_only);
00027 
00028 bool rpl_policy_request_dao_acks(const rpl_domain_t *domain, uint8_t mop);
00029 uint16_t rpl_policy_initial_dao_ack_wait(const rpl_domain_t *domain, uint8_t mop);
00030 void rpl_policy_set_initial_dao_ack_wait(uint16_t timeout_in_ms);
00031 
00032 void rpl_policy_set_dao_retry_count(uint8_t count);
00033 int8_t rpl_policy_dao_retry_count();
00034 
00035 int8_t rpl_policy_srh_next_hop_interface(rpl_domain_t *domain, int8_t if_id, const uint8_t *next_hop);
00036 uint16_t rpl_policy_modify_downward_cost_to_root_neighbour(rpl_domain_t *domain, int8_t if_id, const uint8_t *next_hop, uint16_t cost);
00037 
00038 uint16_t rpl_policy_parent_selection_period(rpl_domain_t *domain);
00039 uint16_t rpl_policy_etx_hysteresis(rpl_domain_t *domain);
00040 //Return Fixed point multiple which base 1.0 is 0x0100
00041 uint16_t rpl_policy_dio_validity_period(rpl_domain_t *domain);
00042 //Fixed point must 1.0 is 0x0100
00043 void rpl_policy_set_dio_validity_period(rpl_domain_t *domain, uint16_t fixed_point);
00044 uint16_t rpl_policy_etx_change_parent_selection_delay(rpl_domain_t *domain);
00045 uint16_t rpl_policy_dio_parent_selection_delay(rpl_domain_t *domain);
00046 
00047 uint16_t rpl_policy_repair_initial_dis_delay(rpl_domain_t *domain);
00048 uint16_t rpl_policy_repair_maximum_dis_interval(rpl_domain_t *domain);
00049 uint_fast8_t rpl_policy_repair_dis_count(rpl_domain_t *domain);
00050 uint_fast8_t rpl_policy_repair_poison_count(rpl_domain_t *domain);
00051 
00052 bool rpl_policy_dao_trigger_after_srh_error(rpl_domain_t *domain, uint32_t seconds_since_last_dao_trigger, uint16_t errors_since_last_dao_trigger, uint_fast16_t targets);
00053 
00054 bool rpl_policy_target_descriptor_for_own_address(rpl_domain_t *domain, const uint8_t addr[16], if_address_source_t source, void *data, uint32_t *descriptor_out);
00055 bool rpl_policy_target_descriptor_for_host_address(rpl_domain_t *domain, const uint8_t addr[16], uint32_t *descriptor_out);
00056 
00057 uint16_t rpl_policy_of0_stretch_of_rank(const rpl_domain_t *domain);
00058 uint_fast8_t rpl_policy_of0_rank_factor(const rpl_domain_t *domain);
00059 bool rpl_policy_of0_dodag_preference_supersedes_grounded(const rpl_domain_t *domain);
00060 uint_fast8_t rpl_policy_of0_max_backup_successors(const rpl_domain_t *domain);
00061 
00062 uint_fast8_t rpl_policy_mrhof_parent_set_size(const rpl_domain_t *domain);
00063 uint16_t rpl_policy_mrhof_max_link_metric(const rpl_domain_t *domain);
00064 uint16_t rpl_policy_mrhof_parent_switch_threshold(const rpl_domain_t *domain);
00065 uint16_t rpl_policy_mrhof_max_rank_stretch_for_extra_parents(const rpl_domain_t *domain);
00066 bool rpl_policy_parent_confirmation_requested(void);
00067 void rpl_policy_set_parent_confirmation_request(bool confirmation_requested);
00068 uint8_t rpl_policy_dio_multicast_config_advertisment_min_count(void);
00069 void rpl_policy_set_dio_multicast_config_advertisment_min_count(uint8_t min_count);
00070 
00071 #endif /* RPL_POLICY_H_ */