* INTC Contribution to the O-RAN F Release for O-DU Low
[o-du/phy.git] / fapi_5g / source / api / fapi2mac / p5 / nr5g_fapi_proc_start_resp.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 STOP.indication message.
22  *
23  **/
24
25 #include "nr5g_fapi_framework.h"
26 #include "nr5g_fapi_fapi2mac_api.h"
27 #include "nr5g_fapi_fapi2mac_p5_proc.h"
28
29 /** @ingroup group_source_api_p5_fapi2mac_proc
30  *
31  *  @param[in]  p_phy_ctx Pointer to PHY context.
32  *  @param[in]  p_fapi_resp Pointer to IAPI START.response message structure.
33  *  @return     Returns ::SUCCESS and ::FAILURE.
34  *
35  *  @description
36  *  This message allows PHY to indicate that it has successfully started PHY
37  *  
38  *
39 **/
40 uint8_t nr5g_fapi_start_resp(
41     p_nr5g_fapi_phy_ctx_t p_phy_ctx,
42     PSTARTRESPONSEStruct p_iapi_resp)
43 {
44     uint8_t phy_id;
45 #ifdef DEBUG_MODE
46     fapi_vendor_ext_start_response_t *p_fapi_resp;
47 #endif
48     fapi_error_ind_t *p_fapi_error_ind;
49     p_fapi_api_queue_elem_t p_list_elem;
50     p_nr5g_fapi_phy_instance_t p_phy_instance = NULL;
51     nr5g_fapi_stats_t *p_stats;
52
53     if (NULL == p_phy_ctx) {
54         NR5G_FAPI_LOG(ERROR_LOG, ("[START.response] Invalid " "phy context"));
55         return FAILURE;
56     }
57
58     if (NULL == p_iapi_resp) {
59         NR5G_FAPI_LOG(ERROR_LOG, ("[START.response] Invalid "
60                 "start response message"));
61         return FAILURE;
62     }
63
64     phy_id = p_iapi_resp->sSFN_Slot.nCarrierIdx;
65     p_phy_instance = &p_phy_ctx->phy_instance[phy_id];
66     if (p_phy_instance->phy_id != phy_id) {
67         NR5G_FAPI_LOG(ERROR_LOG, ("[START.response] Invalid  " "phy instance"));
68         return FAILURE;
69     }
70
71     p_stats = &p_phy_instance->stats;
72     p_stats->iapi_stats.iapi_start_res++;
73     if (0 == p_iapi_resp->nStatus) {
74         if (FAPI_STATE_CONFIGURED == p_phy_instance->state) {
75             p_phy_instance->state = FAPI_STATE_RUNNING;
76         }
77 #ifdef DEBUG_MODE
78         p_list_elem =
79             nr5g_fapi_fapi2mac_create_api_list_elem
80             (FAPI_VENDOR_EXT_START_RESPONSE, 1,
81             sizeof(fapi_vendor_ext_start_response_t));
82         if (!p_list_elem) {
83             NR5G_FAPI_LOG(ERROR_LOG, ("[START.Response] Unable to create "
84                     "list element. Out of memory!!!"));
85             return FAILURE;
86         }
87
88         p_fapi_resp = (fapi_vendor_ext_start_response_t *) (p_list_elem + 1);
89         p_fapi_resp->header.msg_id = FAPI_VENDOR_EXT_START_RESPONSE;
90         p_fapi_resp->header.length =
91             (uint16_t) sizeof(fapi_vendor_ext_start_response_t);
92
93         /* Add element to send list */
94         nr5g_fapi_fapi2mac_add_api_to_list(phy_id, p_list_elem, false);
95         p_stats->fapi_stats.fapi_vext_start_res++;
96         NR5G_FAPI_LOG(INFO_LOG, ("[START.response][%d]", phy_id));
97 #endif
98     } else if (1 == p_iapi_resp->nStatus) {
99         p_list_elem =
100             nr5g_fapi_fapi2mac_create_api_list_elem(FAPI_ERROR_INDICATION, 1,
101             sizeof(fapi_error_ind_t));
102         if (!p_list_elem) {
103             NR5G_FAPI_LOG(ERROR_LOG, ("[START.response] Unable to create "
104                     "list element. Out of memory!!!"));
105             return FAILURE;
106         }
107
108         /* PHY STOP Failed. Sending Error Indication to MAC */
109         p_fapi_error_ind = (fapi_error_ind_t *) (p_list_elem + 1);
110         p_fapi_error_ind->header.msg_id = FAPI_ERROR_INDICATION;
111         p_fapi_error_ind->header.length = (uint16_t) sizeof(fapi_error_ind_t);
112         p_fapi_error_ind->sfn = p_iapi_resp->sSFN_Slot.nSFN;
113         p_fapi_error_ind->slot = p_iapi_resp->sSFN_Slot.nSlot;
114         p_fapi_error_ind->message_id = FAPI_START_REQUEST;
115         p_fapi_error_ind->error_code = p_iapi_resp->nStatus;
116
117         /* Add element to send list */
118         nr5g_fapi_fapi2mac_add_api_to_list(phy_id, p_list_elem, false);
119         p_stats->fapi_stats.fapi_error_ind++;
120         NR5G_FAPI_LOG(INFO_LOG, ("[ERROR.Indication][%d]", phy_id));
121     } else {
122         NR5G_FAPI_LOG(ERROR_LOG, ("[START.response] Invalid status "
123                 "from PHY"));
124         return FAILURE;
125     }
126
127     return SUCCESS;
128 }