FAPI TM, WLS_LIB and ODULOW documentation

[o-du/phy.git] / fapi_5g / source / framework / wls / fapi2phy / nr5g_fapi_fapi2phy_wls.h

diff --git a/fapi_5g/source/framework/wls/fapi2phy/nr5g_fapi_fapi2phy_wls.h b/fapi_5g/source/framework/wls/fapi2phy/nr5g_fapi_fapi2phy_wls.h
new file mode 100644 (file)
index 0000000..36cf06a
--- /dev/null
+++ b/fapi_5g/source/framework/wls/fapi2phy/nr5g_fapi_fapi2phy_wls.h
@@ -0,0 +1,42 @@
+/******************************************************************************
+*
+*   Copyright (c) 2019 Intel.
+*
+*   Licensed under the Apache License, Version 2.0 (the "License");
+*   you may not use this file except in compliance with the License.
+*   You may obtain a copy of the License at
+*
+*       http://www.apache.org/licenses/LICENSE-2.0
+*
+*   Unless required by applicable law or agreed to in writing, software
+*   distributed under the License is distributed on an "AS IS" BASIS,
+*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*   See the License for the specific language governing permissions and
+*   limitations under the License.
+*
+*******************************************************************************/
+/**
+ *
+ * @file This file has definitions of Shared Memory interface functions between
+ * FAPI and PHY.
+ *
+ **/
+
+#ifndef _NR5G_FAPI2PHY_WLS_H_
+#define _NR5G_FAPI2PHY_WLS_H_
+
+#include "gnb_l1_l2_api.h"
+
+uint8_t nr5g_fapi_fapi2phy_is_valid_wls_ptr(
+    void *data);
+uint8_t nr5g_fapi_fapi2phy_wls_send(
+    void *data);
+PMAC2PHY_QUEUE_EL nr5g_fapi_fapi2phy_wls_recv(
+    );
+
+inline uint8_t nr5g_fapi_fapi2phy_wls_ready(
+    );
+inline uint8_t nr5g_fapi_fapi2phy_wls_wait(
+    );
+
+#endif /*_NR5G_FAPI2PHY_WLS_H_*/