FAPI TM, WLS_LIB and ODULOW documentation
[o-du/phy.git] / fapi_5g / source / api / fapi2mac / nr5g_fapi_fapi2mac_api.c
diff --git a/fapi_5g/source/api/fapi2mac/nr5g_fapi_fapi2mac_api.c b/fapi_5g/source/api/fapi2mac/nr5g_fapi_fapi2mac_api.c
new file mode 100644 (file)
index 0000000..9ac2892
--- /dev/null
@@ -0,0 +1,162 @@
+/******************************************************************************
+*
+*   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 contains implementation of all the functions used 
+ * to send APIs from FAPI to MAC
+ *
+ **/
+
+#include <stdio.h>
+#include "nr5g_fapi_internal.h"
+#include "gnb_l1_l2_api.h"
+#include "nr5g_fapi_fapi2mac_api.h"
+#include "nr5g_fapi_fapi2mac_wls.h"
+
+static nr5g_fapi_fapi2mac_queue_t fapi2mac_q[FAPI_MAX_PHY_INSTANCES];
+
+//------------------------------------------------------------------------------
+/** @ingroup     group_source_api_fapi2phy
+ *
+ *  @param[in]   p_list_elem Pointer to the ListElement
+ *
+ *  @return      void
+ *
+ *  @description This function adds a ListElement API to a Linked list which will
+ *               be sent to L1 once all APIs for a TTI are added
+ *
+**/
+//------------------------------------------------------------------------------
+inline p_nr5g_fapi_fapi2mac_queue_t nr5g_fapi_fapi2mac_queue(
+    uint8_t phy_id)
+{
+    return &fapi2mac_q[phy_id];
+}
+
+//------------------------------------------------------------------------------
+/** @ingroup     group_lte_source_phy_fapi
+ *
+ *  @param[in]   pListElem Pointer to the ListElement
+ *
+ *  @return      void
+ *
+ *  @description This function adds a ListElement API to a Linked list which will
+ *               be sent to L1 once all APIs for a TTI are added
+ *
+**/
+//------------------------------------------------------------------------------
+void nr5g_fapi_fapi2mac_add_api_to_list(
+    uint8_t phy_id,
+    p_fapi_api_queue_elem_t p_list_elem)
+{
+    p_nr5g_fapi_fapi2mac_queue_t queue = NULL;
+    p_fapi_msg_header_t p_fapi_msg_hdr = NULL;
+
+    if (!p_list_elem) {
+        return;
+    }
+
+    queue = nr5g_fapi_fapi2mac_queue(phy_id);
+    if (queue->p_send_list_head && queue->p_send_list_tail) {
+        p_fapi_msg_hdr = (p_fapi_msg_header_t) (queue->p_send_list_head + 1);
+        p_fapi_msg_hdr->num_msg += 1;
+        queue->p_send_list_tail->p_next = p_list_elem;
+        queue->p_send_list_tail = p_list_elem;
+    } else {
+        queue->p_send_list_head = queue->p_send_list_tail = p_list_elem;
+    }
+}
+
+//------------------------------------------------------------------------------
+/** @ingroup      group_lte_source_phy_fapi
+ *
+ *  @param        A pointer to phy Instance
+ *
+ *  @return       FAPI status
+ *
+ *  @description  This function send API list to L1
+ *
+**/
+//------------------------------------------------------------------------------
+void nr5g_fapi_fapi2mac_send_api_list(
+    )
+{
+    uint8_t phy_id = 0;
+    p_fapi_api_queue_elem_t p_commit_list_head = NULL;
+    p_fapi_api_queue_elem_t p_commit_list_tail = NULL;
+    p_nr5g_fapi_fapi2mac_queue_t queue = NULL;
+
+    for (phy_id = 0; phy_id < FAPI_MAX_PHY_INSTANCES; phy_id++) {
+        queue = nr5g_fapi_fapi2mac_queue(phy_id);
+        if (queue->p_send_list_head && queue->p_send_list_tail) {
+            if (p_commit_list_head && p_commit_list_tail) {
+                p_commit_list_tail->p_next = queue->p_send_list_head;
+                p_commit_list_tail = queue->p_send_list_tail;
+            } else {
+                p_commit_list_head = queue->p_send_list_head;
+                p_commit_list_tail = queue->p_send_list_tail;
+            }
+            queue->p_send_list_head = queue->p_send_list_tail = NULL;
+        }
+    }
+
+    if (p_commit_list_head)
+        nr5g_fapi_fapi2mac_wls_send(p_commit_list_head);
+}
+
+//------------------------------------------------------------------------------
+/** @ingroup     group_lte_source_phy_fapi
+ *
+ *  @param[in]   phyInstance PhyInstance Id
+ *  @param[in]   NumMessageInBlock Number of Messages in Block
+ *  @param[in]   AlignOffset Align Offset
+ *  @param[in]   MsgType Message Type
+ *  @param[in]   FrameNum Frame Number
+ *  @param[in]   subFrameNum subframe Number
+ *
+ *  @return      Pointer to the List Element structure
+ *
+ *  @description This function allocates a buffer from shared memory WLS
+ *               interface and creates a List Element structures. It then fills
+ *               all the fields with data being passed in.
+ *
+**/
+//------------------------------------------------------------------------------
+p_fapi_api_queue_elem_t nr5g_fapi_fapi2mac_create_api_list_elem(
+    uint32_t msg_type,
+    uint16_t num_message_in_block,
+    uint32_t align_offset)
+{
+    p_fapi_api_queue_elem_t p_list_elem = NULL;
+
+    p_list_elem = (p_fapi_api_queue_elem_t)
+        nr5g_fapi_fapi2mac_wls_alloc_buffer();
+    //Fill header for link list of API messages
+    if (p_list_elem) {
+        p_list_elem->msg_type = (uint8_t) msg_type;
+        p_list_elem->num_message_in_block = num_message_in_block;
+        p_list_elem->align_offset = (uint16_t) align_offset;
+        p_list_elem->msg_len = num_message_in_block * align_offset;
+        p_list_elem->p_next = NULL;
+        p_list_elem->p_tx_data_elm_list = NULL;
+        p_list_elem->time_stamp = 0;
+    }
+
+    return p_list_elem;
+}
+