FAPI TM, WLS_LIB and ODULOW documentation
[o-du/phy.git] / fapi_5g / source / api / fapi2phy / nr5g_fapi_fapi2phy_api.h
1 /******************************************************************************
2 *
3 *   Copyright (c) 2019 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 This file defines all the functions used to send APIs
21  * from FAPI to PHY
22  *
23  **/
24
25 #ifndef NR5G_FAPI_FAPI2PHY_API_H
26 #define NR5G_FAPI_FAPI2PHY_API_H
27
28 #include "gnb_l1_l2_api.h"
29
30 typedef struct _nr5g_fapi_fapi2phy_queue {
31     PMAC2PHY_QUEUE_EL p_send_list_head; // list head to, send to PHY
32     PMAC2PHY_QUEUE_EL p_send_list_tail; // list tail to, send to PHY
33     PMAC2PHY_QUEUE_EL p_recv_list_head; // list head received from PHY
34     PMAC2PHY_QUEUE_EL p_recv_list_tail; // list tail received from PHY
35 } nr5g_fapi_fapi2phy_queue_t,
36 *p_nr5g_fapi_fapi2phy_queue_t;
37
38 // Function definitions
39 // -----------------------------------------------------------------------------
40 PMAC2PHY_QUEUE_EL nr5g_fapi_fapi2phy_create_api_list_elem(
41     uint32_t msg_type,
42     uint16_t num_message_in_block,
43     uint32_t align_offset);
44
45 void nr5g_fapi_fapi2phy_add_to_api_list(
46     PMAC2PHY_QUEUE_EL p_list_elem);
47
48 void nr5g_fapi_fapi2phy_send_api_list(
49     );
50
51 void nr5g_fapi_fapi2phy_add_to_free_list(
52     PMAC2PHY_QUEUE_EL p_list_elem);
53
54 void nr5g_fapi_fapi2phy_destroy_api_list_elem(
55     PMAC2PHY_QUEUE_EL p_list_elem);
56 #endif