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 implementation of User Plane Messages APIs.
23 * @ingroup group_lte_source_xran
24 * @author Intel Corporation
29 #include <rte_memcpy.h>
32 #include "xran_fh_o_du.h"
33 #include "xran_transport.h"
34 #include "xran_up_api.h"
35 #include "xran_printf.h"
36 #include "xran_mlog_lnx.h"
37 #include "xran_common.h"
39 extern uint32_t xran_lib_ota_tti;
42 * @brief Builds eCPRI header in xRAN packet
44 * @param mbuf Initialized rte_mbuf packet
45 * @param iq_data_num_bytes Number of bytes in IQ data buffer
46 * @param iq_data_offset Number of elements already sent
47 * @return int int 0 on success, non zero on failure
49 static int build_ecpri_hdr(struct rte_mbuf *mbuf,
50 const uint32_t iq_data_num_bytes,
51 const uint32_t iq_data_offset,
54 struct xran_ecpri_hdr *ecpri_hdr = (struct xran_ecpri_hdr *)
55 rte_pktmbuf_append(mbuf, sizeof(struct xran_ecpri_hdr));
57 uint16_t iq_samples_bytes_in_mbuf = rte_pktmbuf_tailroom(mbuf) -
58 sizeof(struct radio_app_common_hdr) - sizeof(struct data_section_hdr);
60 iq_samples_bytes_in_mbuf -= (iq_samples_bytes_in_mbuf % alignment);
62 if (NULL == ecpri_hdr)
65 ecpri_hdr->cmnhdr.ecpri_ver = XRAN_ECPRI_VER;
66 ecpri_hdr->cmnhdr.ecpri_resv = 0;
67 ecpri_hdr->cmnhdr.ecpri_concat = 0;
68 ecpri_hdr->cmnhdr.ecpri_mesg_type = ECPRI_IQ_DATA;
70 if (iq_data_offset + iq_samples_bytes_in_mbuf > iq_data_num_bytes) {
71 ecpri_hdr->cmnhdr.ecpri_payl_size =
72 rte_cpu_to_be_16(sizeof(struct radio_app_common_hdr) +
73 sizeof(struct data_section_hdr) +
74 (iq_data_num_bytes - iq_data_offset) +
75 xran_get_ecpri_hdr_size());
76 ecpri_hdr->ecpri_seq_id.e_bit = 1; /* last segment */
78 ecpri_hdr->cmnhdr.ecpri_payl_size =
79 rte_cpu_to_be_16(sizeof(struct radio_app_common_hdr) +
80 sizeof(struct data_section_hdr) +
81 iq_samples_bytes_in_mbuf +
82 xran_get_ecpri_hdr_size());
83 ecpri_hdr->ecpri_seq_id.e_bit = 0;
86 // ecpri_hdr->ecpri_xtc_id = 0; /* currently not used */
87 ecpri_hdr->ecpri_seq_id.seq_id = 0;
88 ecpri_hdr->ecpri_seq_id.sub_seq_id = iq_data_offset /
89 iq_samples_bytes_in_mbuf;
95 * @brief Builds eCPRI header in xRAN packet
97 * @param mbuf Initialized rte_mbuf packet
98 * @param ecpri_mesg_type eCPRI message type
99 * @param payl_size the size in bytes of the payload part of eCPRI message
100 * @param CC_ID Component Carrier ID for ecpriRtcid/ecpriPcid
101 * @param Ant_ID Antenna ID for ecpriRtcid/ecpriPcid
102 * @param seq_id Message identifier for eCPRI message
103 * @param comp_meth Compression method
104 * @return int int 0 on success, non zero on failure
106 static int xran_build_ecpri_hdr_ex(struct rte_mbuf *mbuf,
107 uint8_t ecpri_mesg_type,
114 char *pChar = rte_pktmbuf_mtod(mbuf, char*);
115 struct xran_ecpri_hdr *ecpri_hdr = (struct xran_ecpri_hdr *)(pChar + sizeof(struct rte_ether_hdr));
116 uint16_t ecpri_payl_size = payl_size
117 + sizeof(struct data_section_hdr)
118 + sizeof(struct radio_app_common_hdr)
119 + xran_get_ecpri_hdr_size();
121 if (comp_meth != XRAN_COMPMETHOD_NONE)
122 ecpri_payl_size += sizeof(struct data_section_compression_hdr);
124 if (NULL == ecpri_hdr)
127 ecpri_hdr->cmnhdr.ecpri_ver = XRAN_ECPRI_VER;
128 ecpri_hdr->cmnhdr.ecpri_resv = 0; // should be zero
129 ecpri_hdr->cmnhdr.ecpri_concat = 0;
130 ecpri_hdr->cmnhdr.ecpri_mesg_type = ecpri_mesg_type;
131 ecpri_hdr->cmnhdr.ecpri_payl_size = rte_cpu_to_be_16(ecpri_payl_size);
133 /* one to one lls-CU to RU only and band sector is the same */
134 ecpri_hdr->ecpri_xtc_id = xran_compose_cid(0, 0, CC_ID, Ant_ID);
136 ecpri_hdr->ecpri_seq_id.seq_id = seq_id;
138 /* no transport layer fragmentation supported */
139 ecpri_hdr->ecpri_seq_id.sub_seq_id = 0;
140 ecpri_hdr->ecpri_seq_id.e_bit = 1;
147 * @brief Builds application layer of xRAN packet
149 * @param mbuf Initialized rte_mbuf packet
150 * @param app_hdr_input Radio App common header structure to be set in mbuf
152 * @return int 0 on success, non zero on failure
154 static int build_application_layer(
155 struct rte_mbuf *mbuf,
156 const struct radio_app_common_hdr *app_hdr_input)
158 char *pChar = rte_pktmbuf_mtod(mbuf, char*);
159 struct radio_app_common_hdr *app_hdr = (struct radio_app_common_hdr *)(pChar + sizeof(struct rte_ether_hdr)
160 + sizeof (struct xran_ecpri_hdr));
165 rte_memcpy(app_hdr, app_hdr_input, sizeof(struct radio_app_common_hdr));
171 * @brief Builds section header in xRAN packet
173 * @param mbuf Initialized rte_mbuf packet
174 * @param sec_hdr Section header structure to be set in mbuf packet
175 * @return int 0 on success, non zero on failure
177 static int build_section_hdr(
178 struct rte_mbuf *mbuf,
179 const struct data_section_hdr *sec_hdr)
181 char *pChar = rte_pktmbuf_mtod(mbuf, char*);
182 struct data_section_hdr *section_hdr = (struct data_section_hdr *)
183 (pChar + sizeof(struct rte_ether_hdr) + sizeof (struct xran_ecpri_hdr) + sizeof(struct radio_app_common_hdr));
185 if (NULL == section_hdr)
188 rte_memcpy(section_hdr, sec_hdr, sizeof(struct data_section_hdr));
193 * @brief Function for appending IQ samples data to the mbuf.
195 * @param mbuf Initialized rte_mbuf packet.
196 * @param iq_data_start Address of the first element in IQ data array.
197 * @param iq_data_num_bytes Size of the IQ data array.
198 * @param iq_data_offset IQ data btyes already sent.
199 * @return uint16_t Bytes that have been appended to the packet.
201 static uint16_t append_iq_samples_ex(
202 struct rte_mbuf *mbuf,
203 const void *iq_data_start,
204 const uint32_t iq_data_num_bytes,
205 enum xran_input_byte_order iq_buf_byte_order,
208 char *pChar = rte_pktmbuf_mtod(mbuf, char*);
209 void *iq_sam_buf = (pChar + sizeof(struct rte_ether_hdr) + sizeof (struct xran_ecpri_hdr)
210 + sizeof(struct radio_app_common_hdr)
211 + sizeof(struct data_section_hdr));
213 if (iq_sam_buf == NULL){
214 print_err("iq_sam_buf == NULL\n");
217 if(iq_buf_byte_order == XRAN_CPU_LE_BYTE_ORDER){
219 uint16_t *psrc = (uint16_t *)iq_data_start;
220 uint16_t *pdst = (uint16_t *)iq_sam_buf;
221 /* CPU byte order (le) of IQ to network byte order (be) */
222 for (idx = 0; idx < iq_data_num_bytes/sizeof(int16_t); idx++){
223 pdst[idx] = (psrc[idx]>>8) | (psrc[idx]<<8); //rte_cpu_to_be_16(psrc[idx]);
227 else if(iq_buf_byte_order == XRAN_NE_BE_BYTE_ORDER){
229 rte_memcpy(iq_sam_buf, (uint8_t *)iq_data_start, iq_data_num_bytes);
233 return iq_data_num_bytes;
237 * @brief Function for appending IQ samples data to the mbuf.
239 * @param mbuf Initialized rte_mbuf packet.
240 * @param iq_data_start Address of the first element in IQ data array.
241 * @param iq_data_num_bytes Size of the IQ data array.
242 * @param iq_data_offset IQ data btyes already sent.
243 * @return uint16_t Bytes that have been appended to the packet.
245 static uint16_t append_iq_samples(
246 struct rte_mbuf *mbuf,
247 const void *iq_data_start,
248 const uint32_t iq_data_num_bytes,
249 const uint32_t iq_data_offset,
250 const uint8_t alignment)
252 uint16_t iq_bytes_to_send = 0;
253 uint16_t free_space_in_pkt = rte_pktmbuf_tailroom(mbuf);
255 if (free_space_in_pkt > iq_data_num_bytes - iq_data_offset)
256 iq_bytes_to_send = iq_data_num_bytes - iq_data_offset;
258 iq_bytes_to_send = free_space_in_pkt;
260 /* don't cut off an iq in half */
261 iq_bytes_to_send -= iq_bytes_to_send % alignment;
263 void *iq_sam_buf = (void *)rte_pktmbuf_append(mbuf, iq_bytes_to_send);
265 rte_memcpy(iq_sam_buf, (uint8_t *)iq_data_start + iq_data_offset,
268 return iq_bytes_to_send;
272 * @brief Builds compression header in xRAN packet
274 * @param mbuf Initialized rte_mbuf packet
275 * @param compression_hdr Section compression header structure
276 * to be set in mbuf packet
277 * @return int 0 on success, non zero on failure
279 static int build_compression_hdr(
280 struct rte_mbuf *mbuf,
281 const struct data_section_compression_hdr *compr_hdr)
283 char *pChar = rte_pktmbuf_mtod(mbuf, char*);
284 struct data_section_compression_hdr *compression_hdr = (struct data_section_compression_hdr *)
285 (pChar + sizeof(struct rte_ether_hdr) + sizeof (struct xran_ecpri_hdr) + sizeof(struct radio_app_common_hdr)
286 + sizeof(struct data_section_hdr));
288 if (NULL == compression_hdr)
291 rte_memcpy(compression_hdr, compr_hdr, sizeof(*compression_hdr));
297 * @brief Appends compression parameter in xRAN packet
299 * @param mbuf Initialized rte_mbuf packet
300 * @param ud_comp_paramr Compression param to be set in mbuf packet
301 * @return int 0 on success, non zero on failure
303 static int append_comp_param(struct rte_mbuf *mbuf, union compression_params *ud_comp_param)
305 union compression_params *compr_param =
306 (union compression_params *)rte_pktmbuf_append(mbuf, sizeof(union compression_params));
308 if (NULL == compr_param)
311 rte_memcpy(compr_param, ud_comp_param, sizeof(union compression_params));
317 * @brief Function for extracting all IQ samples from xRAN packet
318 * holding a single data section
319 * @param iq_data_start Address of the first element in IQ data array.
320 * @param symb_id Symbol ID to be extracted from ecpri header
321 * @param seq_id Sequence ID to be extracted from radio header
322 * @return int Size of remaining mbuf filled with IQ samples
325 int32_t xran_extract_iq_samples(struct rte_mbuf *mbuf,
326 void **iq_data_start,
330 uint8_t *subframe_id,
333 struct ecpri_seq_id *seq_id,
335 uint16_t *start_prbu,
344 uint32_t mlogVar[10];
345 uint32_t mlogVarCnt = 0;
347 struct xran_eaxc_info result;
351 if (NULL == iq_data_start)
354 /* Process eCPRI header. */
355 const struct xran_ecpri_hdr *ecpri_hdr = rte_pktmbuf_mtod(mbuf, void *);
356 if (ecpri_hdr == NULL)
360 *seq_id = ecpri_hdr->ecpri_seq_id;
362 xran_decompose_cid((uint16_t)ecpri_hdr->ecpri_xtc_id, &result);
364 *CC_ID = result.ccId;
365 *Ant_ID = result.ruPortId;
367 /* Process radio header. */
368 struct radio_app_common_hdr *radio_hdr =
369 (void *)rte_pktmbuf_adj(mbuf, sizeof(*ecpri_hdr));
370 if (radio_hdr == NULL)
371 return 0; /* packet too short */
373 radio_hdr->sf_slot_sym.value = rte_be_to_cpu_16(radio_hdr->sf_slot_sym.value);
376 *frame_id = radio_hdr->frame_id;
379 *subframe_id = radio_hdr->sf_slot_sym.subframe_id;
382 *slot_id = xran_slotid_convert(radio_hdr->sf_slot_sym.slot_id, 1);
385 *symb_id = radio_hdr->sf_slot_sym.symb_id;
387 /* Process data section hdr */
388 struct data_section_hdr *data_hdr =
389 (void *)rte_pktmbuf_adj(mbuf, sizeof(*radio_hdr));
390 if (data_hdr == NULL)
391 return 0; /* packet too short */
394 data_hdr->fields.all_bits = rte_be_to_cpu_32(data_hdr->fields.all_bits);
396 *num_prbu = data_hdr->fields.num_prbu;
397 *start_prbu = data_hdr->fields.start_prbu;
398 *sym_inc = data_hdr->fields.sym_inc;
399 *rb = data_hdr->fields.rb;
400 *sect_id = data_hdr->fields.sect_id;
403 const struct data_section_compression_hdr *data_compr_hdr =
404 (void *) rte_pktmbuf_adj(mbuf, sizeof(*data_hdr));
406 if (data_compr_hdr == NULL)
409 *compMeth = data_compr_hdr->ud_comp_hdr.ud_comp_meth;
410 *iqWidth = data_compr_hdr->ud_comp_hdr.ud_iq_width;
412 const uint8_t *compr_param =
413 (void *)rte_pktmbuf_adj(mbuf, sizeof(*data_compr_hdr));
415 *iq_data_start = (void *)compr_param; /*rte_pktmbuf_adj(mbuf, sizeof(*compr_param))*/;
417 *iq_data_start = rte_pktmbuf_adj(mbuf, sizeof(*data_hdr));
420 if (*iq_data_start == NULL)
424 mlogVar[mlogVarCnt++] = 0xBBBBBBBB;
425 mlogVar[mlogVarCnt++] = xran_lib_ota_tti;
426 mlogVar[mlogVarCnt++] = radio_hdr->frame_id;
427 mlogVar[mlogVarCnt++] = radio_hdr->sf_slot_sym.subframe_id;
428 mlogVar[mlogVarCnt++] = radio_hdr->sf_slot_sym.slot_id;
429 mlogVar[mlogVarCnt++] = radio_hdr->sf_slot_sym.symb_id;
430 mlogVar[mlogVarCnt++] = data_hdr->fields.sect_id;
431 mlogVar[mlogVarCnt++] = data_hdr->fields.start_prbu;
432 mlogVar[mlogVarCnt++] = data_hdr->fields.num_prbu;
433 mlogVar[mlogVarCnt++] = rte_pktmbuf_pkt_len(mbuf);
434 MLogAddVariables(mlogVarCnt, mlogVar, MLogTick());
437 return rte_pktmbuf_pkt_len(mbuf);
441 * @brief Function for starting preparion of IQ samples portions
442 * to be sent in xRAN packet
444 * @param mbuf Initialized rte_mbuf packet.
445 * @param iq_data_start Address of the first element in IQ data array.
446 * @param iq_data_num_bytes Size of the IQ data array.
447 * @param iq_data_offset IQ data bytes already sent.
448 * @param alignment Size of IQ data alignment.
449 * @param pkt_gen_params Struct with parameters used for building packet
450 * @return int Number of bytes that have been appended
451 to the packet within all appended sections.
453 int32_t xran_prepare_iq_symbol_portion(
454 struct rte_mbuf *mbuf,
455 const void *iq_data_start,
456 const enum xran_input_byte_order iq_buf_byte_order,
457 const uint32_t iq_data_num_bytes,
458 struct xran_up_pkt_gen_params *params,
464 if(xran_build_ecpri_hdr_ex(mbuf,
470 params->compr_hdr_param.ud_comp_hdr.ud_comp_meth)){
471 print_err("xran_build_ecpri_hdr_ex return 0\n");
475 if (build_application_layer(mbuf, &(params->app_params)) != 0){
476 print_err("build_application_layer return != 0\n");
480 if (build_section_hdr(mbuf, &(params->sec_hdr)) != 0){
481 print_err("build_section_hdr return != 0\n");
486 if(params->compr_hdr_param.ud_comp_hdr.ud_comp_meth != XRAN_COMPMETHOD_NONE) {
487 if (build_compression_hdr(mbuf, &(params->compr_hdr_param)) !=0)
490 /* payload expected to start with udCompParam */
492 /*if(append_comp_param(mbuf, &(params->compr_param)) !=0)
497 return append_iq_samples_ex(mbuf, iq_data_start, iq_data_num_bytes, iq_buf_byte_order, do_copy);