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