1 /******************************************************************************
3 * Copyright (c) 2021 Intel.
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 *******************************************************************************/
21 * This file consist of implementation of FAPI STOP.indication message.
25 #include "nr5g_fapi_framework.h"
26 #include "nr5g_fapi_fapi2mac_api.h"
27 #include "nr5g_fapi_fapi2phy_api.h"
28 #include "nr5g_fapi_fapi2mac_p5_proc.h"
29 #include "nr5g_fapi_fapi2phy_p5_proc.h"
30 #include "nr5g_fapi_fapi2phy_p5_pvt_proc.h"
32 /** @ingroup group_source_api_p5_fapi2mac_proc
34 * @param[in] p_phy_ctx Pointer to PHY context.
35 * @param[in] p_fapi_resp Pointer to IAPI STOP.indication message structure.
36 * @return Returns ::SUCCESS and ::FAILURE.
39 * This message allows PHY to indicate that it has successfully stopped
40 * and returned to the CONFIGURED state.
43 uint8_t nr5g_fapi_stop_indication(
44 p_nr5g_fapi_phy_ctx_t p_phy_ctx,
45 PSTOPRESPONSEStruct p_iapi_resp)
49 fapi_error_ind_t *p_fapi_error_ind;
50 p_fapi_api_queue_elem_t p_list_elem;
51 p_nr5g_fapi_phy_instance_t p_phy_instance = NULL;
52 nr5g_fapi_stats_t *p_stats;
54 if (NULL == p_phy_ctx) {
55 NR5G_FAPI_LOG(ERROR_LOG, ("[STOP.indication] Invalid " "phy context"));
59 if (NULL == p_iapi_resp) {
60 NR5G_FAPI_LOG(ERROR_LOG, ("[STOP.indication] Invalid "
61 "stop response message"));
65 phy_id = p_iapi_resp->sSFN_Slot.nCarrierIdx;
66 p_phy_instance = &p_phy_ctx->phy_instance[phy_id];
67 if (p_phy_instance->phy_id != phy_id) {
68 NR5G_FAPI_LOG(ERROR_LOG, ("[STOP.indication] Invalid " "phy instance"));
72 p_stats = &p_phy_instance->stats;
73 p_stats->iapi_stats.iapi_stop_ind++;
74 if (SUCCESS == p_iapi_resp->nStatus) {
75 if (FAPI_STATE_RUNNING == p_phy_instance->state) {
76 p_phy_instance->state = FAPI_STATE_CONFIGURED;
80 nr5g_fapi_fapi2mac_create_api_list_elem(FAPI_STOP_INDICATION, 1,
81 sizeof(fapi_stop_ind_t));
83 NR5G_FAPI_LOG(ERROR_LOG, ("[STOP.indication] Unable to create "
84 "list element. Out of memory!!!"));
87 fapi_stop_ind_t *p_fapi_resp;
88 p_fapi_resp = (fapi_stop_ind_t *) (p_list_elem + 1);
89 p_fapi_resp->header.msg_id = FAPI_STOP_INDICATION;
90 p_fapi_resp->header.length = (uint16_t) sizeof(fapi_stop_ind_t);
91 /* Add element to send list */
92 nr5g_fapi_fapi2mac_add_api_to_list(phy_id, p_list_elem, false);
93 p_stats->fapi_stats.fapi_stop_ind++;
94 NR5G_FAPI_LOG(INFO_LOG, ("[STOP.indication][%d]", phy_id));
96 fapi_vendor_ext_shutdown_req_t fapi_req;
97 fapi_req.header.msg_id = FAPI_VENDOR_EXT_SHUTDOWN_REQUEST;
98 fapi_req.header.length = sizeof(fapi_vendor_ext_shutdown_req_t);
101 fapi_req.test_type = 0;
102 nr5g_fapi_shutdown_request(0, p_phy_instance, &fapi_req);
103 nr5g_fapi_fapi2phy_send_api_list(0);
105 } else if (FAILURE == p_iapi_resp->nStatus) {
107 nr5g_fapi_fapi2mac_create_api_list_elem(FAPI_ERROR_INDICATION, 1,
108 sizeof(fapi_error_ind_t));
110 NR5G_FAPI_LOG(ERROR_LOG, ("[STOP.indication] Unable to create "
111 "list element. Out of memory!!!"));
115 /* PHY STOP Failed. Sending Error Indication to MAC */
116 p_fapi_error_ind = (fapi_error_ind_t *) (p_list_elem + 1);
117 p_fapi_error_ind->header.msg_id = FAPI_ERROR_INDICATION;
118 p_fapi_error_ind->header.length = (uint16_t) sizeof(fapi_error_ind_t);
119 p_fapi_error_ind->sfn = p_iapi_resp->sSFN_Slot.nSFN;
120 p_fapi_error_ind->slot = p_iapi_resp->sSFN_Slot.nSlot;
121 p_fapi_error_ind->message_id = FAPI_STOP_REQUEST;
122 p_fapi_error_ind->error_code = p_iapi_resp->nStatus;
123 /* Add element to send list */
124 nr5g_fapi_fapi2mac_add_api_to_list(phy_id, p_list_elem, false);
125 p_stats->fapi_stats.fapi_error_ind++;
126 NR5G_FAPI_LOG(INFO_LOG, ("[STOP.indication][ERROR.indication][%d]",
129 NR5G_FAPI_LOG(ERROR_LOG, ("[STOP.indication] Invalid status "