First round of documentation cleanup for oran_e_maintenance_release_v1.0
[o-du/phy.git] / fhi_lib / lib / src / xran_app_frag.h
1 /******************************************************************************
2 *
3 *   Copyright (c) 2020 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 /**
21  * @brief Header file for functions to perform application level fragmentation
22  *
23  * @file xran_app_frag.h
24  * @ingroup group_source_xran
25  * @author Intel Corporation
26  **/
27
28 #ifndef _XRAN_APP_FRAG_
29 #define _XRAN_APP_FRAG_
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #include <stdint.h>
36 #include <stdio.h>
37
38 #include <rte_config.h>
39 #include <rte_malloc.h>
40 #include <rte_memory.h>
41 #include <rte_mempool.h>
42 #include <rte_byteorder.h>
43
44 #include "xran_fh_o_du.h"
45 #include "xran_cp_api.h"
46
47 int32_t
48 xran_app_fragment_packet(struct rte_mbuf *pkt_in, /* eth hdr is prepended */
49                                     struct rte_mbuf **pkts_out,
50                                     uint16_t nb_pkts_out,
51                                     uint16_t mtu_size,
52                                     struct rte_mempool *pool_direct,
53                                     struct rte_mempool *pool_indirect,
54                          int16_t nRBStart,  /**< start RB of RB allocation */
55                          int16_t nRBSize,  /**< number of RBs used */
56                          uint8_t *seqid,
57                          uint8_t iqWidth,
58                          uint8_t isUdCompHdr);
59
60 #ifdef __cplusplus
61 }
62 #endif
63
64 #endif /* _XRAN_APP_FRAG_ */
65