FAPI TM, WLS_LIB and ODULOW documentation

[o-du/phy.git] / fapi_5g / source / api / fapi2mac / p5 / nr5g_fapi_proc_ul_iq_samples_resp.c

diff --git a/fapi_5g/source/api/fapi2mac/p5/nr5g_fapi_proc_ul_iq_samples_resp.c b/fapi_5g/source/api/fapi2mac/p5/nr5g_fapi_proc_ul_iq_samples_resp.c
new file mode 100644 (file)
index 0000000..94ebb4a
--- /dev/null
+++ b/fapi_5g/source/api/fapi2mac/p5/nr5g_fapi_proc_ul_iq_samples_resp.c
@@ -0,0 +1,95 @@
+/******************************************************************************
+*
+*   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 consist of implementation of FAPI ULIQ_Samples.response message.
+ *
+ **/
+#include "nr5g_fapi_framework.h"
+#include "gnb_l1_l2_api.h"
+#include "nr5g_fapi_fapi2mac_api.h"
+#include "nr5g_fapi_fapi2mac_p5_proc.h"
+
+#ifdef DEBUG_MODE
+ /** @ingroup group_source_api_p5_fapi2phy_proc
+ *
+ *  @param[in]  p_phy_instance Pointer to PHY instance.
+ *  @param[in]  p_fapi_resp Pointer to IAPI ULIQ_Samples.response message structure.
+ *  @return     Returns ::SUCCESS and ::FAILURE.
+ *
+ *  @description
+ *  This timer mode vendor specific message used for acknowledging the ULIQ_Samples.Request
+ *  message used by TestMAC to validate uplink message indications. 
+ *
+**/
+uint8_t nr5g_fapi_ul_iq_samples_response(
+    p_nr5g_fapi_phy_ctx_t p_phy_ctx,
+    PADD_REMOVE_BBU_CORES p_iapi_resp)
+{
+    uint8_t phy_id;
+    fapi_vendor_ext_ul_iq_samples_res_t *p_fapi_resp;
+    p_fapi_api_queue_elem_t p_list_elem;
+    p_nr5g_fapi_phy_instance_t p_phy_instance = NULL;
+
+    if (NULL == p_phy_ctx) {
+        NR5G_FAPI_LOG(ERROR_LOG, ("[UL_IQ_SAMPLES.response] Invalid handle to "
+                "phy instance"));
+        return FAILURE;
+    }
+
+    if (NULL == p_iapi_resp) {
+        NR5G_FAPI_LOG(ERROR_LOG, ("[UL_IQ_SAMPLES.response] Invalid iapi "
+                "ULIQ_Samples response message"));
+        return FAILURE;
+    }
+
+    phy_id = p_iapi_resp->sSFN_Slot.nCarrierIdx;
+    p_phy_instance = &p_phy_ctx->phy_instance[phy_id];
+    if (p_phy_instance->phy_id != phy_id) {
+        NR5G_FAPI_LOG(ERROR_LOG, (" [UL_IQ_SAMPLES.response] Invalid "
+                "phy instance"));
+        return FAILURE;
+    }
+    // Create FAPI message header
+    if (p_phy_instance->state == FAPI_STATE_IDLE) {
+        nr5g_fapi_message_header_per_phy(phy_id);
+    }
+
+    p_list_elem =
+        nr5g_fapi_fapi2mac_create_api_list_elem(FAPI_VENDOR_EXT_UL_IQ_SAMPLES,
+        1, sizeof(fapi_vendor_ext_ul_iq_samples_res_t));
+    if (!p_list_elem) {
+        NR5G_FAPI_LOG(ERROR_LOG, ("[UL_IQ_SAMPLES.response] Unable to create "
+                "list element. Out of memory!!!"));
+        return FAILURE;
+    }
+
+    p_fapi_resp = (fapi_vendor_ext_ul_iq_samples_res_t *) (p_list_elem + 1);
+    p_fapi_resp->header.msg_id = FAPI_VENDOR_EXT_UL_IQ_SAMPLES;
+    p_fapi_resp->header.length =
+        (uint16_t) sizeof(fapi_vendor_ext_ul_iq_samples_res_t);
+
+    /* Add element to send list */
+    nr5g_fapi_fapi2mac_add_api_to_list(phy_id, p_list_elem);
+
+    NR5G_FAPI_LOG(INFO_LOG, ("[UL_IQ_SAMPLES.response]%d]", phy_id));
+
+    return SUCCESS;
+}
+#endif