fapi_5g/source/api/fapi2phy/p5/nr5g_fapi_proc_start_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 START.request message.
  22  *
  23  **/
  24
  25 #include "nr5g_mac_phy_api.h"
  26 #include "nr5g_fapi_framework.h"
  27 #include "nr5g_fapi_fapi2mac_api.h"
  28 #include "nr5g_fapi_fapi2phy_api.h"
  29 #include "nr5g_fapi_fapi2phy_p5_proc.h"
  30 #include "nr5g_fapi_fapi2phy_p5_pvt_proc.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 START.request message structure.
  36  *  @param[in]  p_fapi_vendor_msg Pointer to FAPI vendor message structure.
  37  *  @return     Returns ::SUCCESS and ::FAILURE.
  38  *
  39  *  @description
  40  *  This message instructs a configured PHY to start transmitting as an eNB. If
  41  *  the PHY is in the CONFIGURED state, it will issue SLOT indication.
  42  *  After the PHY has sent its first SLOT.indication message it enters the
  43  *  RUNNING state. If the PHY receives a START.request in either the IDLE or
  44  *  RUNNING state it will return an ERROR.indication including an INVALID_STATE
  45  *  error.
  46  *
  47  *  The *nSFN*, *nSlot*, and *nCarrierIdx* parameters are vendor specific
  48  *  configuration and programmed through Vendor Specific Message structure
  49  *  ::fapi_start_req_vendor_msg_t
  50  *
  51  *  The *phyMode*, *ttiPeriod*, and *numSubframes* parameters of Vendor Specific
  52  *  Message structure ::fapi_start_req_vendor_msg_t are applicable only for
  53  *  TIMER mode (used for debugging only).
  54  *
  55 **/
  56 uint8_t nr5g_fapi_start_request(
  57     bool is_urllc,
  58     p_nr5g_fapi_phy_instance_t p_phy_instance,
  59     fapi_start_req_t * p_fapi_req,
  60     fapi_vendor_msg_t * p_fapi_vendor_msg)
  61 {
  62     PSTARTREQUESTStruct p_start_req;
  63     PMAC2PHY_QUEUE_EL p_list_elem;
  64     nr5g_fapi_stats_t *p_stats;
  65
  66     if (NULL == p_phy_instance) {
  67         NR5G_FAPI_LOG(ERROR_LOG, ("[START.request] Invalid " "phy instance"));
  68         return FAILURE;
  69     }
  70     p_stats = &p_phy_instance->stats;
  71     p_stats->fapi_stats.fapi_start_req++;
  72
  73     if (FAPI_STATE_CONFIGURED != p_phy_instance->state) {
  74         // TODO: Return Error indication to mac
  75         //         // Please refer PHY State transition.
  76         NR5G_FAPI_LOG(ERROR_LOG, ("[START.request] Received in "
  77                 "other than CONFIGURED State"));
  78         return FAILURE;
  79     }
  80
  81     if (NULL == p_fapi_req) {
  82         NR5G_FAPI_LOG(ERROR_LOG, ("[START.request] Invalid fapi " "message"));
  83         return FAILURE;
  84     }
  85
  86     if (NULL == p_fapi_vendor_msg) {
  87         NR5G_FAPI_LOG(ERROR_LOG, ("[START.request] Invalid fapi "
  88                 "vendor message"));
  89         return FAILURE;
  90     }
  91
  92     if (p_fapi_vendor_msg->start_req_vendor.mode > 4) {
  93         NR5G_FAPI_LOG(ERROR_LOG, ("[START.request] PHY Mode %u invalid",
  94                 p_fapi_vendor_msg->start_req_vendor.mode));
  95         return FAILURE;
  96     }
  97
  98     p_list_elem = nr5g_fapi_fapi2phy_create_api_list_elem((uint8_t)
  99         MSG_TYPE_PHY_START_REQ, 1, (uint32_t) sizeof(STARTREQUESTStruct));
 100     if (!p_list_elem) {
 101         NR5G_FAPI_LOG(ERROR_LOG, (" [START.request] Unable to create "
 102                 "list element. Out of memory!!!"));
 103         return FAILURE;
 104     }
 105
 106     p_start_req = (PSTARTREQUESTStruct) (p_list_elem + 1);
 107     p_start_req->sMsgHdr.nMessageType = MSG_TYPE_PHY_START_REQ;
 108     p_start_req->sMsgHdr.nMessageLen = (uint16_t) sizeof(STARTREQUESTStruct);
 109     p_start_req->sSFN_Slot.nSFN = p_fapi_vendor_msg->start_req_vendor.sfn;
 110     p_start_req->sSFN_Slot.nSlot = p_fapi_vendor_msg->start_req_vendor.slot;
 111     p_start_req->sSFN_Slot.nCarrierIdx = p_phy_instance->phy_id;
 112     p_start_req->nMode = p_fapi_vendor_msg->start_req_vendor.mode;
 113 #ifdef DEBUG_MODE
 114     /* Setting period and count only for timer mode */
 115     if (1 == p_fapi_vendor_msg->start_req_vendor.mode) {
 116         p_start_req->nCount = p_fapi_vendor_msg->start_req_vendor.count;
 117         p_start_req->nPeriod = p_fapi_vendor_msg->start_req_vendor.period;
 118     }
 119 #endif
 120
 121     /* Add element to send list */
 122     nr5g_fapi_fapi2phy_add_to_api_list(is_urllc, p_list_elem);
 123
 124     p_stats->iapi_stats.iapi_start_req++;
 125     NR5G_FAPI_LOG(INFO_LOG, ("[START.request][%d]", p_phy_instance->phy_id));
 126
 127     return SUCCESS;
 128 }