O-RAN E Maintenance Release contribution for ODULOW
[o-du/phy.git] / fapi_5g / source / api / fapi2phy / p5 / nr5g_fapi_proc_dl_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  * @file
20  * This file consist of implementation of FAPI DLIQSamples.request message.
21  *
22  **/
23 #include "nr5g_fapi_framework.h"
24 #include "gnb_l1_l2_api.h"
25 #include "nr5g_fapi_fapi2mac_api.h"
26 #include "nr5g_fapi_fapi2phy_api.h"
27 #include "nr5g_fapi_fapi2phy_p5_proc.h"
28 #include "nr5g_fapi_fapi2phy_p5_pvt_proc.h"
29 #include "nr5g_fapi_memory.h"
30
31  /** @ingroup group_source_api_p5_fapi2phy_proc
32  *
33  *  @param[in]  p_fapi_req Pointer to FAPI DLIQSamples.request message structure.
34  *  @return     Returns ::SUCCESS and ::FAILURE.
35  *
36  *  @description
37  *  This is a timer mode specific message used to transmit IQ Sample API to L1.
38  *  In DL direction, L1 copies the IQ samples into a file. 
39  *
40  *
41 **/
42 #ifdef DEBUG_MODE
43 uint8_t nr5g_fapi_dl_iq_samples_request(
44     bool is_urllc,
45     fapi_vendor_ext_iq_samples_req_t * p_fapi_req)
46 {
47     uint16_t num_ant;
48
49     fapi_vendor_ext_iq_samples_info_t *p_file_info;
50     PMAC2PHY_QUEUE_EL p_list_elem;
51
52     if (NULL == p_fapi_req) {
53         NR5G_FAPI_LOG(ERROR_LOG, ("[DL_IQ_Samples.request] Invalid FAPI "
54                 "message"));
55         return FAILURE;
56     }
57
58     p_list_elem = nr5g_fapi_fapi2phy_create_api_list_elem((uint8_t)
59         MSG_TYPE_PHY_DL_IQ_SAMPLES, 1,
60         (uint32_t) sizeof(fapi_vendor_ext_iq_samples_info_t));
61     if (!p_list_elem) {
62         NR5G_FAPI_LOG(ERROR_LOG, ("[DL_IQ_Samples.request] Unable to create "
63                 "list element. Out of memory!!!"));
64         return FAILURE;
65     }
66
67     p_file_info = (fapi_vendor_ext_iq_samples_info_t *) (p_list_elem + 1);
68     p_file_info->carrNum = p_fapi_req->iq_samples_info.carrNum;
69     p_file_info->numSubframes = p_fapi_req->iq_samples_info.numSubframes;
70     p_file_info->nIsRadioMode = p_fapi_req->iq_samples_info.nIsRadioMode;
71     p_file_info->timerModeFreqDomain =
72         p_fapi_req->iq_samples_info.timerModeFreqDomain;
73     p_file_info->phaseCompensationEnable =
74         p_fapi_req->iq_samples_info.phaseCompensationEnable;
75     p_file_info->startFrameNum = p_fapi_req->iq_samples_info.startFrameNum;
76     p_file_info->startSlotNum = p_fapi_req->iq_samples_info.startSlotNum;
77     p_file_info->startSymNum = p_fapi_req->iq_samples_info.startSymNum;
78
79     p_file_info->nDLCompressionIdx = p_fapi_req->iq_samples_info.nDLCompressionIdx;
80     p_file_info->nDLCompiqWidth = p_fapi_req->iq_samples_info.nDLCompiqWidth;
81     p_file_info->nDLCompScaleFactor = p_fapi_req->iq_samples_info.nDLCompScaleFactor;
82     p_file_info->nDLCompreMask = p_fapi_req->iq_samples_info.nDLCompreMask;
83     p_file_info->nULDecompressionIdx = p_fapi_req->iq_samples_info.nULDecompressionIdx;
84     p_file_info->nULDecompiqWidth = p_fapi_req->iq_samples_info.nULDecompiqWidth;
85
86     if (FAILURE == NR5G_FAPI_MEMCPY(p_file_info->buffer,
87             sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_BUFFER_SIZE,
88             p_fapi_req->iq_samples_info.buffer, sizeof(CONFIGREQUESTStruct))) {
89         NR5G_FAPI_LOG(ERROR_LOG, ("[DL_IQ_Samples.request] Buffer copy "
90                 "failed!!!"));
91     }
92
93     if (FAILURE == NR5G_FAPI_STRCPY(p_file_info->filename_out_dl_iq,
94             sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE,
95             p_fapi_req->iq_samples_info.filename_out_dl_iq,
96             sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE)) {
97         NR5G_FAPI_LOG(ERROR_LOG, ("[DL_IQ_Samples.request] file name copy "
98                 "failed!!!"));
99     }
100
101     if (FAILURE == NR5G_FAPI_STRCPY(p_file_info->filename_out_dl_iq_compressed,
102             sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE,
103             p_fapi_req->iq_samples_info.filename_out_dl_iq_compressed,
104             sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE)) {
105         NR5G_FAPI_LOG(ERROR_LOG, ("[DL_IQ_Samples.request] compressed file name copy "
106                 "failed!!!"));
107     }
108
109     for (num_ant = 0; num_ant < FAPI_MAX_IQ_SAMPLE_DL_PORTS; num_ant++) {
110         if (FAILURE ==
111             NR5G_FAPI_STRCPY(p_file_info->filename_out_dl_beam[num_ant],
112                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE,
113                 p_fapi_req->iq_samples_info.filename_out_dl_beam[num_ant],
114                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE)) {
115
116             NR5G_FAPI_LOG(ERROR_LOG, ("[DL_IQ_Samples.request] DL Beam "
117                     "file name copy failed!!!"));
118         }
119     }
120
121     for (num_ant = 0; num_ant < FAPI_MAX_IQ_SAMPLE_UL_VIRTUAL_PORTS; num_ant++) {
122         if (FAILURE ==
123             NR5G_FAPI_STRCPY(p_file_info->filename_out_ul_beam[num_ant],
124                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE,
125                 p_fapi_req->iq_samples_info.filename_out_ul_beam[num_ant],
126                 sizeof(uint8_t) * FAPI_MAX_IQ_SAMPLE_FILE_SIZE)) {
127             NR5G_FAPI_LOG(ERROR_LOG,
128                 ("[DL_IQ_Samples.request] UL Beam "
129                     "file name copy failed!!!"));
130         }
131     }
132
133     nr5g_fapi_fapi2phy_add_to_api_list(is_urllc, p_list_elem);
134
135     NR5G_FAPI_LOG(INFO_LOG, ("[DL_IQ_Samples.request][%d]",
136             p_fapi_req->iq_samples_info.carrNum));
137
138     return SUCCESS;
139 }
140 #endif