mac_filter.h

00001 /*
00002  * Copyright (c) 2014-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 /*
00019  * \file mac_filter.h
00020  * \brief Private functions for filter API.
00021  *
00022  */
00023 
00024 #ifndef MAC_FILTER_H_
00025 #define MAC_FILTER_H_
00026 
00027 struct mac_pre_parsed_frame_s;
00028 
00029 /**
00030  * Modify the link quality values.
00031  * This function modifies the link qualities based on the filter settings. This is used from the MAC layer
00032  *
00033  * if lqi result is less than 0 this packet is dropped and function returns 1
00034  * if dbm result is less than -90dbm this packet is dropped and function returns 1
00035  * if packet can be prosessed function returns 0 with modified link quality values.
00036  *
00037  * \param interface_id Network Interface.
00038  * \param mac_frame pointer to pre parsed mac frame
00039  *
00040  * return modified link quality.
00041  * return >0 Packet is ignored.
00042  * return 0 Packet is not dropped.
00043  */
00044 int_fast8_t mac_filter_modify_link_quality(int8_t interface_id, struct mac_pre_parsed_frame_s *mac_frame);
00045 
00046 #endif /* MAC_FILTER_H_ */