1 /******************************************************************************
3 * Copyright (c) 2019 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 *******************************************************************************/
20 * @brief This file provides the definitions for User Plane Messages APIs.
23 * @ingroup group_lte_source_xran
24 * @author Intel Corporation
28 #ifndef _XRAN_UP_API_H_
29 #define _XRAN_UP_API_H_
35 #include <rte_common.h>
39 #include "xran_pkt_up.h"
42 * structure used for storing packet parameters needed for generating
45 struct xran_up_pkt_gen_params
47 struct radio_app_common_hdr app_params;
48 struct data_section_hdr sec_hdr;
49 struct data_section_compression_hdr compr_hdr_param;
50 union compression_params compr_param;
54 * structure used for storing packet parameters needed for generating
55 * a data packet without compression
56 * Next fields are omitted:
57 * udCompHdr (not always present)
58 * reserved (not always present)
59 * udCompParam (not always present)
61 struct xran_up_pkt_gen_no_compression_params
63 struct radio_app_common_hdr app_params;
64 struct data_section_hdr sec_hdr;
69 * @brief Function that is preparing an mbuf with portion of IQ samples related
70 * to the single symbol.
72 * @param mbuf Initialized rte_mbuf packet
73 * @param iq_data_start Address of the first element in IQ data array.
74 * @param iq_data_num_elements Size of the IQ data array.
75 * @param iq_data_offset IQ data array's elements already sent.
76 * @param alignment Align data to this many bytes.
77 * @param params Structure containing Radio App Header and Data Section Header
79 * @return int Bytes of IQ samples that have been appended to the packet.
81 int xran_prepare_iq_symbol_portion(
82 struct rte_mbuf *mbuf,
83 const void *iq_data_start,
84 const uint32_t iq_data_num_bytes,
85 uint32_t *iq_data_offset,
86 const uint8_t alignment,
87 struct xran_up_pkt_gen_params *params,
91 * @brief Function extracts IQ samples from received mbuf packet.
93 * @param mbuf Packet with received data.
94 * @param iq_data_start Address of the first IQ sample in mbuf will be returned
96 * @return int Bytes of IQ samples that have been extracted from mbuf.
98 int xran_extract_iq_samples(struct rte_mbuf *mbuf,
103 uint8_t *subframe_id,
106 struct ecpri_seq_id *seq_id,
108 uint16_t *start_prbu,
113 int xran_prepare_iq_symbol_portion_no_comp(
114 struct rte_mbuf *mbuf,
115 const void *iq_data_start,
116 const enum xran_input_byte_order iq_buf_byte_order,
117 const uint32_t iq_data_num_bytes,
118 struct xran_up_pkt_gen_no_compression_params *params,
128 #endif /* _XRAN_UP_API_H_ */