fapi_5g/source/api/fapi2phy/p7/nr5g_fapi_proc_tx_data_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 /**
  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 "nr5g_fapi_fapi2mac_api.h"
  27 #include "nr5g_fapi_fapi2phy_api.h"
  28 #include "nr5g_fapi_fapi2phy_p7_proc.h"
  29 #include "nr5g_fapi_fapi2phy_p7_pvt_proc.h"
  30 #include "nr5g_fapi_memory.h"
  31
  32  /** @ingroup group_source_api_p7_fapi2phy_proc
  33  *
  34  *  @param[in]  p_phy_instance Pointer to PHY instance.
  35  *  @param[in]  p_fapi_req Pointer to FAPI TX_Data.request message structure.
  36  *
  37  *  @return     Returns ::SUCCESS and ::FAILURE.
  38  *
  39  *  @description
  40  *  This message contains the MAC PDU data for transmission over the air
  41  *  interface. The PDUs described in this message must follow the same order
  42  *  as DL_TTI.request.
  43  *
  44 **/
  45 uint8_t nr5g_fapi_tx_data_request(
  46     bool is_urllc,
  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
  55     if (NULL == p_phy_instance) {
  56         NR5G_FAPI_LOG(ERROR_LOG, ("[TX_Data.request] Invalid " "phy instance"));
  57         return FAILURE;
  58     }
  59
  60     if (NULL == p_fapi_req) {
  61         NR5G_FAPI_LOG(ERROR_LOG, ("[TX_Data.request] Invalid fapi " "message"));
  62         return FAILURE;
  63     }
  64
  65     p_stats = &p_phy_instance->stats;
  66     p_stats->fapi_stats.fapi_tx_data_req++;
  67     p_list_elem = nr5g_fapi_fapi2phy_create_api_list_elem((uint8_t)
  68         MSG_TYPE_PHY_TX_REQ, 1, (uint32_t) sizeof(TXRequestStruct));
  69     if (!p_list_elem) {
  70         NR5G_FAPI_LOG(ERROR_LOG, ("[TX_Data.request] Unable to create "
  71                 "list element. Out of memory!!!"));
  72         return FAILURE;
  73     }
  74
  75     p_ia_tx_req = (PTXRequestStruct) (p_list_elem + 1);
  76     nr5g_fapi_tx_data_req_to_phy_translation(p_phy_instance, p_fapi_req, p_fapi_vendor_msg, p_ia_tx_req);
  77     nr5g_fapi_fapi2phy_add_to_api_list(is_urllc, p_list_elem);
  78
  79     p_stats->iapi_stats.iapi_tx_req++;
  80     NR5G_FAPI_LOG(DEBUG_LOG, ("[TX_Data.request][%u][%u,%u,%u] is_urllc %u",
  81         p_phy_instance->phy_id,
  82         p_ia_tx_req->sSFN_Slot.nSFN, p_ia_tx_req->sSFN_Slot.nSlot,
  83         p_ia_tx_req->sSFN_Slot.nSym, is_urllc));
  84
  85     return SUCCESS;
  86 }
  87
  88  /** @ingroup group_source_api_p7_fapi2phy_proc
  89  *
  90  *  @param[in]  p_fapi_req Pointer to FAPI TX_Data.request structure.
  91  *  @param[in]  p_ia_tx_req Pointer to IAPI TX_Data.request structure.
  92  *
  93  *  @return     Returns ::SUCCESS and ::FAILURE.
  94  *
  95  *  @description
  96  *  This function converts FAPI TX_Data.request to IAPI TX.request
  97  *  structure.
  98  *
  99 **/
 100 uint8_t nr5g_fapi_tx_data_req_to_phy_translation(
 101     p_nr5g_fapi_phy_instance_t p_phy_instance,
 102     fapi_tx_data_req_t * p_fapi_req,
 103     fapi_vendor_msg_t * p_fapi_vendor_msg,
 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
 129     if (NULL != p_fapi_vendor_msg) {
 130         nr5g_fapi_tx_data_req_to_phy_translation_vendor_ext(p_fapi_vendor_msg,
 131                                                             p_phy_req);
 132     }
 133
 134     p_phy_req->nPDU = p_fapi_req->num_pdus;
 135     p_phy_pdu = (PDLPDUDataStruct) (p_phy_req + 1);
 136
 137     for (idx = 0; idx < p_fapi_req->num_pdus; idx++) {
 138         found = FALSE;
 139         p_fapi_pdu = &p_fapi_req->pdu_desc[idx];
 140         for (count = 0; count < gathered_count; count++) {
 141             if (gather[count][GATHER_PDU_IDX] == p_fapi_pdu->pdu_index) {
 142                 found = TRUE;
 143                 break;
 144             }
 145         }
 146
 147         if (found) {
 148             gather[count][GATHER_CW2] = idx;
 149         } else {
 150             if (gathered_count < FAPI_MAX_NUMBER_DL_PDUS_PER_TTI) {
 151                 gather[gathered_count][GATHER_PDU_IDX] = p_fapi_pdu->pdu_index;
 152                 gather[gathered_count][GATHER_CW1] = idx;
 153                 gathered_count++;
 154             } else {
 155                 NR5G_FAPI_LOG(ERROR_LOG,
 156                     ("exceeded Max DL Pdus supported per tti: %d [%d] ",
 157                         gathered_count, FAPI_MAX_NUMBER_DL_PDUS_PER_TTI));
 158             }
 159         }
 160     }
 161
 162     for (count = 0; count < gathered_count; count++) {
 163         p_phy_pdu->nPduLen1 = 0;
 164         p_phy_pdu->nPduLen2 = 0;
 165         p_phy_pdu->pPayload1 = NULL;
 166         p_phy_pdu->pPayload2 = NULL;
 167         if (gather[count][GATHER_CW1] >= 0) {
 168             p_fapi_pdu = &p_fapi_req->pdu_desc[gather[count][GATHER_CW1]];
 169             p_phy_pdu->nPduIdx = p_fapi_pdu->pdu_index;
 170             tag = (uint8_t *) & p_fapi_pdu->tlvs[0].tl.tag;
 171             if (*tag == FAPI_TX_DATA_PTR_TO_PAYLOAD_64) {
 172                 tag++;
 173                 length =
 174                     (((uint32_t) *
 175                         tag) << 16) | (uint32_t) p_fapi_pdu->tlvs[0].tl.length;
 176                 p_phy_pdu->nPduLen1 = length;
 177                 p_phy_pdu->pPayload1 = p_fapi_pdu->tlvs[0].value;
 178             } else {
 179                 NR5G_FAPI_LOG(ERROR_LOG,
 180                     ("Only 64 bit Ptr to Payload in TX_DATA.req is supported"));
 181             }
 182         }
 183         if (gather[count][GATHER_CW2] >= 0) {
 184             p_fapi_pdu = &p_fapi_req->pdu_desc[gather[count][GATHER_CW2]];
 185             tag = (uint8_t *) & p_fapi_pdu->tlvs[0].tl.tag;
 186             if (*tag == FAPI_TX_DATA_PTR_TO_PAYLOAD_64) {
 187                 tag++;
 188                 length =
 189                     (((uint32_t) *
 190                         tag) << 16) | (uint32_t) p_fapi_pdu->tlvs[0].tl.length;
 191                 p_phy_pdu->nPduLen2 = length;
 192                 p_phy_pdu->pPayload2 = p_fapi_pdu->tlvs[0].value;
 193             } else {
 194                 NR5G_FAPI_LOG(ERROR_LOG,
 195                     ("Only 64 bit Ptr to Payload in TX_DATA.req is supported"));
 196             }
 197         }
 198         p_phy_pdu++;
 199     }
 200     return SUCCESS;
 201 }
 202
 203  /** @ingroup group_source_api_p7_fapi2phy_proc
 204  *
 205  *  @param[in]  p_fapi_vendor_msg Pointer to FAPI TX_Data.request structure.
 206  *  @param[in]  p_ia_tx_req       Pointer to IAPI TX_Data.request structure.
 207  *
 208  *  @return     no return.
 209  *
 210  *  @description
 211  *  This function fills fields for TX.Data structure that come from
 212  *  a vendor extension.
 213  *
 214 **/
 215 void nr5g_fapi_tx_data_req_to_phy_translation_vendor_ext(
 216     fapi_vendor_msg_t * p_fapi_vendor_msg,
 217     PTXRequestStruct p_phy_req)
 218 {
 219     p_phy_req->sSFN_Slot.nSym = p_fapi_vendor_msg->p7_req_vendor.tx_data_req.sym;
 220 }