fapi_5g/source/api/fapi2phy/p5/nr5g_fapi_proc_shutdown_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 SHUTDOWN.request message structure.
  36  *  @return     Returns ::SUCCESS and ::FAILURE.
  37  *
  38  *  @description
  39  *  This vendor specific message  instructs a configured PHY to Shutdown its processing
  40  *  by cleaning up the resources alloted when PHY is up and running.
  41  *
  42 **/
  43 uint8_t nr5g_fapi_shutdown_request(
  44     bool is_urllc,
  45     p_nr5g_fapi_phy_instance_t p_phy_instance,
  46     fapi_vendor_ext_shutdown_req_t * p_fapi_req)
  47 {
  48     PSHUTDOWNREQUESTStruct p_shutdown_req;
  49     PMAC2PHY_QUEUE_EL p_list_elem;
  50     nr5g_fapi_stats_t *p_stats;
  51
  52     if (NULL == p_phy_instance) {
  53         NR5G_FAPI_LOG(ERROR_LOG, ("[SHUTDOWN.request] Invalid "
  54                 "phy instance"));
  55         return FAILURE;
  56     }
  57     p_stats = &p_phy_instance->stats;
  58     p_stats->fapi_stats.fapi_vext_shutdown_req++;
  59
  60     if (NULL == p_fapi_req) {
  61         NR5G_FAPI_LOG(ERROR_LOG, ("[SHUTDOWN.request] Invalid handle to fapi "
  62                 "message"));
  63         return FAILURE;
  64     }
  65
  66     p_list_elem = nr5g_fapi_fapi2phy_create_api_list_elem((uint8_t)
  67         MSG_TYPE_PHY_SHUTDOWN_REQ, 1, (uint32_t) sizeof(SHUTDOWNREQUESTStruct));
  68     if (!p_list_elem) {
  69         NR5G_FAPI_LOG(ERROR_LOG, ("[SHUTDOWN.request] Unable to create "
  70                 "list element. Out of memory!!!"));
  71         return FAILURE;
  72     }
  73     p_shutdown_req = (PSHUTDOWNREQUESTStruct) (p_list_elem + 1);
  74     p_shutdown_req->sMsgHdr.nMessageType = MSG_TYPE_PHY_SHUTDOWN_REQ;
  75     p_shutdown_req->sMsgHdr.nMessageLen =
  76         (uint16_t) sizeof(SHUTDOWNREQUESTStruct);
  77     p_shutdown_req->sSFN_Slot.nSFN = p_fapi_req->sfn;
  78     p_shutdown_req->sSFN_Slot.nSlot = p_fapi_req->slot;
  79     p_shutdown_req->sSFN_Slot.nCarrierIdx = p_phy_instance->phy_id;
  80     p_phy_instance->shutdown_test_type = p_shutdown_req->nTestType =
  81         p_fapi_req->test_type;
  82
  83     /* Add element to send list */
  84     nr5g_fapi_fapi2phy_add_to_api_list(is_urllc, p_list_elem);
  85
  86     p_stats->iapi_stats.iapi_shutdown_req++;
  87     NR5G_FAPI_LOG(INFO_LOG, ("[SHUTDOWN.request][%d]", p_phy_instance->phy_id));
  88
  89     return SUCCESS;
  90 }