O-RAN E Maintenance Release contribution for ODULOW
[o-du/phy.git] / fapi_5g / source / api / fapi2phy / p5 / nr5g_fapi_proc_ul_iq_samples_req.c
1 /******************************************************************************
2 *
3 *   Copyright (c) 2019 Intel.
4 *
5 *   Licensed under the Apache License, Version 2.0 (the "License");
6 *   you may not use this file except in compliance with the License.
7 *   You may obtain a copy of the License at
8 *
9 *       http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *   Unless required by applicable law or agreed to in writing, software
12 *   distributed under the License is distributed on an "AS IS" BASIS,
13 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *   See the License for the specific language governing permissions and
15 *   limitations under the License.
16 *
17 *******************************************************************************/
18
19 /**
20  * @file
21  * This file consist of implementation of FAPI UL_IQ_SAMPLES.request message.
22  *
23  **/
24 #include "nr5g_fapi_framework.h"
25 #include "gnb_l1_l2_api.h"
26 #include "nr5g_fapi_fapi2mac_api.h"
27 #include "nr5g_fapi_fapi2phy_api.h"
28 #include "nr5g_fapi_fapi2phy_p5_proc.h"
29 #include "nr5g_fapi_fapi2phy_p5_pvt_proc.h"
30 #include "nr5g_fapi_memory.h"
31
32  /** @ingroup group_source_api_p5_fapi2phy_proc
33  *
34  *  @param[in]  p_phy_instance Pointer to PHY instance.
35  *  @param[in]  p_fapi_req Pointer to FAPI UL_IQ_SAMPLES.request message structure.
36  *  @return     Returns ::SUCCESS and ::FAILURE.
37  *
38  *  @description
39  *  This is a timer mode specific message used to transmit IQ Sample API to L1.
40  *  In UL direction, L1 opens the IQ samples file and stores it into local
41  *  buffers for processing. 
42  *
43  *
44 **/
45 #ifdef DEBUG_MODE
46 uint8_t nr5g_fapi_ul_iq_samples_request(
47     bool is_urllc,
48     fapi_vendor_ext_iq_samples_req_t * p_fapi_req)
49 {
50     uint16_t num_ant;
51
52     fapi_vendor_ext_iq_samples_info_t *p_file_info;
53     PMAC2PHY_QUEUE_EL p_list_elem;
54
55     if (NULL == p_fapi_req) {
56         NR5G_FAPI_LOG(ERROR_LOG, (" [UL_IQ_SAMPLES.request] Invalid fapi "
57                 "message"));
58         return FAILURE;
59     }
60
61     p_list_elem = nr5g_fapi_fapi2phy_create_api_list_elem((uint8_t)
62         MSG_TYPE_PHY_UL_IQ_SAMPLES, 1,
63         (uint32_t) sizeof(fapi_vendor_ext_iq_samples_info_t));
64     if (!p_list_elem) {
65         NR5G_FAPI_LOG(ERROR_LOG, ("[UL_IQ_SAMPLES.request] Unable to create "
66                 "list element. Out of memory!!!"));
67         return FAILURE;
68     }
69
70     p_file_info = (fapi_vendor_ext_iq_samples_info_t *) (p_list_elem + 1);
71     p_file_info->carrNum = p_fapi_req->iq_samples_info.carrNum;
72     p_file_info->numSubframes = p_fapi_req->iq_samples_info.numSubframes;
73     p_file_info->nIsRadioMode = p_fapi_req->iq_samples_info.nIsRadioMode;
74     p_file_info->timerModeFreqDomain =
75         p_fapi_req->iq_samples_info.timerModeFreqDomain;
76     p_file_info->phaseCompensationEnable =
77         p_fapi_req->iq_samples_info.phaseCompensationEnable;
78     p_file_info->startFrameNum = p_fapi_req->iq_samples_info.startFrameNum;
79     p_file_info->startSlotNum = p_fapi_req->iq_samples_info.startSlotNum;
80     p_file_info->startSymNum = p_fapi_req->iq_samples_info.startSymNum;
81
82     p_file_info->nDLCompressionIdx = p_fapi_req->iq_samples_info.nDLCompressionIdx;
83     p_file_info->nDLCompiqWidth = p_fapi_req->iq_samples_info.nDLCompiqWidth;
84     p_file_info->nDLCompScaleFactor = p_fapi_req->iq_samples_info.nDLCompScaleFactor;
85     p_file_info->nDLCompreMask = p_fapi_req->iq_samples_info.nDLCompreMask;
86     p_file_info->nULDecompressionIdx = p_fapi_req->iq_samples_info.nULDecompressionIdx;
87     p_file_info->nULDecompiqWidth = p_fapi_req->iq_samples_info.nULDecompiqWidth;
88
89     if (FAILURE == NR5G_FAPI_MEMCPY(p_file_info->buffer,
90             sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_BUFFER_SIZE,
91             p_fapi_req->iq_samples_info.buffer, sizeof(CONFIGREQUESTStruct))) {
92         NR5G_FAPI_LOG(ERROR_LOG, ("[UL_IQ_Samples.request] Buffer copy "
93                 "failed!!!"));
94     }
95
96     for (num_ant = 0; num_ant < FAPI_MAX_IQ_SAMPLE_UL_VIRTUAL_PORTS; num_ant++) {
97         if (FAILURE == NR5G_FAPI_STRCPY(p_file_info->filename_in_ul_iq[num_ant],
98                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE,
99                 p_fapi_req->iq_samples_info.filename_in_ul_iq[num_ant],
100                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE)) {
101             NR5G_FAPI_LOG(ERROR_LOG, ("[UL_IQ_Samples.request] file name copy "
102                     "failed!!!"));
103         }
104
105         if (FAILURE ==
106             NR5G_FAPI_STRCPY(p_file_info->filename_in_prach_iq[num_ant],
107                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE,
108                 p_fapi_req->iq_samples_info.filename_in_prach_iq[num_ant],
109                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE)) {
110             NR5G_FAPI_LOG(ERROR_LOG,
111                 ("[UL_IQ_Samples.request] PRACH file name " "copy failed!!!"));
112         }
113
114         if (FAILURE ==
115             NR5G_FAPI_STRCPY(p_file_info->filename_in_ul_iq_compressed[num_ant],
116                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE,
117                 p_fapi_req->iq_samples_info.filename_in_ul_iq_compressed[num_ant],
118                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE)) {
119             NR5G_FAPI_LOG(ERROR_LOG,
120                 ("[UL_IQ_Samples.request] compressed file name copy failed!!!"));
121         }
122     }
123
124     for (num_ant = 0; num_ant < FAPI_MAX_IQ_SAMPLE_UL_ANTENNA; num_ant++) {
125         if (FAILURE ==
126             NR5G_FAPI_STRCPY(p_file_info->filename_in_srs_iq[num_ant],
127                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE,
128                 p_fapi_req->iq_samples_info.filename_in_srs_iq[num_ant],
129                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE)) {
130             NR5G_FAPI_LOG(ERROR_LOG,
131                 ("[UL_IQ_Samples.request] SRS file name " "copy failed!!!"));
132         }
133     }
134
135     nr5g_fapi_fapi2phy_add_to_api_list(is_urllc, p_list_elem);
136     NR5G_FAPI_LOG(INFO_LOG, ("[UL_IQ_SAMPLES.request][%d]",
137             p_fapi_req->iq_samples_info.carrNum));
138
139     return SUCCESS;
140 }
141 #endif