mac_pd_sap.h

00001 /*
00002  * Copyright (c) 2014-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 /*
00019  * \file mac_pd_sap.h
00020  * \brief Add short description about this file!!!
00021  *
00022  */
00023 
00024 #ifndef MAC_PD_SAP_H_
00025 #define MAC_PD_SAP_H_
00026 
00027 struct protocol_interface_rf_mac_setup;
00028 struct arm_phy_sap_msg_s;
00029 
00030 #define ENHANCED_ACK_NEIGHBOUR_POLL_MAX_TIME_US 3500
00031 
00032 /**
00033  * Send a buffer to the MAC.
00034  * Used by the protocol core.
00035  *
00036  * \param buf pointer to buffer
00037  *
00038  */
00039 int8_t mac_pd_sap_req(struct protocol_interface_rf_mac_setup *rf_mac_setup);
00040 
00041 int8_t mac_plme_cca_req(struct protocol_interface_rf_mac_setup *rf_mac_setup);
00042 
00043 void mac_pd_abort_active_tx(struct protocol_interface_rf_mac_setup *rf_mac_setup);
00044 
00045 void mac_pd_sap_set_phy_tx_time(struct protocol_interface_rf_mac_setup *rf_mac_setup, uint32_t tx_time, bool cca_enabled);
00046 
00047 void mac_pd_sap_rf_low_level_function_set(void *mac_ptr, void *driver);
00048 
00049 int8_t mac_pd_sap_data_cb(void *identifier, struct arm_phy_sap_msg_s *message);
00050 
00051 void mac_csma_param_init(struct protocol_interface_rf_mac_setup *rf_mac_setup);
00052 
00053 uint32_t mac_csma_backoff_get(struct protocol_interface_rf_mac_setup *rf_mac_setup);
00054 
00055 void mac_csma_backoff_start(struct protocol_interface_rf_mac_setup *rf_mac_setup);
00056 /**
00057  * Run Mac data interface state Machine.
00058  *
00059  */
00060 void mac_pd_sap_state_machine(struct protocol_interface_rf_mac_setup *rf_mac_setup);
00061 
00062 #endif /* MAC_PD_SAP_H_ */