Update to odulow per maintenance bronze
[o-du/phy.git] / fapi_5g / source / api / fapi2phy / p7 / nr5g_fapi_proc_tx_data_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 TX_Data.request message.
22  *
23  **/
24
25 #include "nr5g_fapi_framework.h"
26 #include "gnb_l1_l2_api.h"
27 #include "nr5g_fapi_fapi2mac_api.h"
28 #include "nr5g_fapi_fapi2phy_api.h"
29 #include "nr5g_fapi_fapi2phy_p7_proc.h"
30 #include "nr5g_fapi_fapi2phy_p7_pvt_proc.h"
31 #include "nr5g_fapi_memory.h"
32
33  /** @ingroup group_source_api_p7_fapi2phy_proc
34  *
35  *  @param[in]  p_phy_instance Pointer to PHY instance.
36  *  @param[in]  p_fapi_req Pointer to FAPI TX_Data.request message structure.
37  *  
38  *  @return     Returns ::SUCCESS and ::FAILURE.
39  *
40  *  @description
41  *  This message contains the MAC PDU data for transmission over the air 
42  *  interface. The PDUs described in this message must follow the same order 
43  *  as DL_TTI.request. 
44  *
45 **/
46 uint8_t nr5g_fapi_tx_data_request(
47     p_nr5g_fapi_phy_instance_t p_phy_instance,
48     fapi_tx_data_req_t * p_fapi_req,
49     fapi_vendor_msg_t * p_fapi_vendor_msg)
50 {
51     PTXRequestStruct p_ia_tx_req;
52     PMAC2PHY_QUEUE_EL p_list_elem;
53     nr5g_fapi_stats_t *p_stats;
54     UNUSED(p_fapi_vendor_msg);
55
56     if (NULL == p_phy_instance) {
57         NR5G_FAPI_LOG(ERROR_LOG, ("[TX_Data.request] Invalid " "phy instance"));
58         return FAILURE;
59     }
60
61     if (NULL == p_fapi_req) {
62         NR5G_FAPI_LOG(ERROR_LOG, ("[TX_Data.request] Invalid fapi " "message"));
63         return FAILURE;
64     }
65
66     p_stats = &p_phy_instance->stats;
67     p_stats->fapi_stats.fapi_tx_data_req++;
68     p_list_elem = nr5g_fapi_fapi2phy_create_api_list_elem((uint8_t)
69         MSG_TYPE_PHY_TX_REQ, 1, (uint32_t) sizeof(TXRequestStruct));
70     if (!p_list_elem) {
71         NR5G_FAPI_LOG(ERROR_LOG, ("[TX_Data.request] Unable to create "
72                 "list element. Out of memory!!!"));
73         return FAILURE;
74     }
75
76     p_ia_tx_req = (PTXRequestStruct) (p_list_elem + 1);
77     nr5g_fapi_tx_data_req_to_phy_translation(p_phy_instance, p_fapi_req,
78         p_ia_tx_req);
79     nr5g_fapi_fapi2phy_add_to_api_list(p_list_elem);
80
81     p_stats->iapi_stats.iapi_tx_req++;
82     NR5G_FAPI_LOG(DEBUG_LOG, ("[TX_Data.request][%d][%d,%d]",
83             p_phy_instance->phy_id, p_ia_tx_req->sSFN_Slot.nSFN,
84             p_ia_tx_req->sSFN_Slot.nSlot));
85
86     return SUCCESS;
87 }
88
89  /** @ingroup group_source_api_p7_fapi2phy_proc
90  *
91  *  @param[in]  p_fapi_req Pointer to FAPI TX_Data.request structure.
92  *  @param[in]  p_ia_tx_req Pointer to IAPI TX_Data.request structure.
93  *  
94  *  @return     Returns ::SUCCESS and ::FAILURE.
95  *
96  *  @description
97  *  This function converts FAPI TX_Data.request to IAPI TX.request
98  *  structure.
99  *
100 **/
101 uint8_t nr5g_fapi_tx_data_req_to_phy_translation(
102     p_nr5g_fapi_phy_instance_t p_phy_instance,
103     fapi_tx_data_req_t * p_fapi_req,
104     PTXRequestStruct p_phy_req)
105 {
106 #define GATHER_SIZE 3
107 #define GATHER_PDU_IDX 0
108 #define GATHER_CW1 1
109 #define GATHER_CW2 2
110     int gather[FAPI_MAX_NUMBER_DL_PDUS_PER_TTI][GATHER_SIZE];
111     int gathered_count = 0;
112     uint8_t *tag;
113     uint32_t length;
114     uint16_t idx, count, found;
115     fapi_tx_pdu_desc_t *p_fapi_pdu = NULL;
116     PDLPDUDataStruct p_phy_pdu = NULL;
117
118     NR5G_FAPI_MEMSET(gather,
119         (sizeof(int) * FAPI_MAX_NUMBER_DL_PDUS_PER_TTI * 3), -1,
120         (sizeof(int) * FAPI_MAX_NUMBER_DL_PDUS_PER_TTI * 3));
121     NR5G_FAPI_MEMSET(p_phy_req, sizeof(TXRequestStruct), 0,
122         sizeof(TXRequestStruct));
123     p_phy_req->sMsgHdr.nMessageType = MSG_TYPE_PHY_TX_REQ;
124     p_phy_req->sMsgHdr.nMessageLen = (uint16_t) sizeof(TXRequestStruct);
125     p_phy_req->sSFN_Slot.nCarrierIdx = p_phy_instance->phy_id;
126     p_phy_req->sSFN_Slot.nSFN = p_fapi_req->sfn;
127     p_phy_req->sSFN_Slot.nSlot = p_fapi_req->slot;
128     p_phy_req->nPDU = p_fapi_req->num_pdus;
129     p_phy_pdu = (PDLPDUDataStruct) (p_phy_req + 1);
130
131     for (idx = 0; idx < p_fapi_req->num_pdus; idx++) {
132         found = FALSE;
133         p_fapi_pdu = &p_fapi_req->pdu_desc[idx];
134         for (count = 0; count < gathered_count; count++) {
135             if (gather[count][GATHER_PDU_IDX] == p_fapi_pdu->pdu_index) {
136                 found = TRUE;
137                 break;
138             }
139         }
140
141         if (found) {
142             gather[count][GATHER_CW2] = idx;
143         } else {
144             if (gathered_count < FAPI_MAX_NUMBER_DL_PDUS_PER_TTI) {
145                 gather[gathered_count][GATHER_PDU_IDX] = p_fapi_pdu->pdu_index;
146                 gather[gathered_count][GATHER_CW1] = idx;
147                 gathered_count++;
148             } else {
149                 NR5G_FAPI_LOG(ERROR_LOG,
150                     ("exceeded Max DL Pdus supported per tti: %d [%d] ",
151                         gathered_count, FAPI_MAX_NUMBER_DL_PDUS_PER_TTI));
152             }
153         }
154     }
155
156     for (count = 0; count < gathered_count; count++) {
157         p_phy_pdu->nPduLen1 = 0;
158         p_phy_pdu->nPduLen2 = 0;
159         p_phy_pdu->pPayload1 = NULL;
160         p_phy_pdu->pPayload2 = NULL;
161         if (gather[count][GATHER_CW1] >= 0) {
162             p_fapi_pdu = &p_fapi_req->pdu_desc[gather[count][GATHER_CW1]];
163             p_phy_pdu->nPduIdx = p_fapi_pdu->pdu_index;
164             tag = (uint8_t *) & p_fapi_pdu->tlvs[0].tl.tag;
165             if (*tag == FAPI_TX_DATA_PTR_TO_PAYLOAD_64) {
166                 tag++;
167                 length =
168                     (((uint32_t) *
169                         tag) << 16) | (uint32_t) p_fapi_pdu->tlvs[0].tl.length;
170                 p_phy_pdu->nPduLen1 = length;
171                 p_phy_pdu->pPayload1 = p_fapi_pdu->tlvs[0].value;
172             } else {
173                 NR5G_FAPI_LOG(ERROR_LOG,
174                     ("Only 64 bit Ptr to Payload in TX_DATA.req is supported"));
175             }
176         }
177         if (gather[count][GATHER_CW2] >= 0) {
178             p_fapi_pdu = &p_fapi_req->pdu_desc[gather[count][GATHER_CW2]];
179             tag = (uint8_t *) & p_fapi_pdu->tlvs[0].tl.tag;
180             if (*tag == FAPI_TX_DATA_PTR_TO_PAYLOAD_64) {
181                 tag++;
182                 length =
183                     (((uint32_t) *
184                         tag) << 16) | (uint32_t) p_fapi_pdu->tlvs[0].tl.length;
185                 p_phy_pdu->nPduLen2 = length;
186                 p_phy_pdu->pPayload2 = p_fapi_pdu->tlvs[0].value;
187             } else {
188                 NR5G_FAPI_LOG(ERROR_LOG,
189                     ("Only 64 bit Ptr to Payload in TX_DATA.req is supported"));
190             }
191         }
192         p_phy_pdu++;
193     }
194     return SUCCESS;
195 }