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 *******************************************************************************/
21 * @brief This file provides the definitions for User Plane Messages APIs.
24 * @ingroup group_lte_source_xran
25 * @author Intel Corporation
29 #ifndef _XRAN_UP_API_H_
30 #define _XRAN_UP_API_H_
32 #include <rte_common.h>
36 #include "xran_pkt_up.h"
38 #define XRAN_BYTE_ORDER_SWAP
41 * structure used for storing packet parameters needed for generating
44 struct xran_up_pkt_gen_params
46 struct radio_app_common_hdr app_params;
47 struct data_section_hdr sec_hdr;
48 struct data_section_compression_hdr compr_hdr_param;
49 union compression_params compr_param;
53 * structure used for storing packet parameters needed for generating
54 * a data packet without compression
55 * Next fields are omitted:
56 * udCompHdr (not always present)
57 * reserved (not always present)
58 * udCompParam (not always present)
60 struct xran_up_pkt_gen_no_compression_params
62 struct radio_app_common_hdr app_params;
63 struct data_section_hdr sec_hdr;
68 * @brief Function that is preparing an mbuf with portion of IQ samples related
69 * to the single symbol.
71 * @param mbuf Initialized rte_mbuf packet
72 * @param iq_data_start Address of the first element in IQ data array.
73 * @param iq_data_num_elements Size of the IQ data array.
74 * @param iq_data_offset IQ data array's elements already sent.
75 * @param alignment Align data to this many bytes.
76 * @param params Structure containing Radio App Header and Data Section Header
78 * @return int Bytes of IQ samples that have been appended to the packet.
80 int xran_prepare_iq_symbol_portion(
81 struct rte_mbuf *mbuf,
82 const void *iq_data_start,
83 const uint32_t iq_data_num_bytes,
84 uint32_t *iq_data_offset,
85 const uint8_t alignment,
86 struct xran_up_pkt_gen_params *params,
90 * @brief Function extracts IQ samples from received mbuf packet.
92 * @param mbuf Packet with received data.
93 * @param iq_data_start Address of the first IQ sample in mbuf will be returned
95 * @return int Bytes of IQ samples that have been extracted from mbuf.
97 int xran_extract_iq_samples(struct rte_mbuf *mbuf,
102 uint8_t *subframe_id,
105 struct ecpri_seq_id *seq_id);
107 int xran_prepare_iq_symbol_portion_no_comp(
108 struct rte_mbuf *mbuf,
109 const void *iq_data_start,
110 const uint32_t iq_data_num_bytes,
111 struct xran_up_pkt_gen_no_compression_params *params,
116 #endif /* _XRAN_UP_API_H_ */