xran_up_api.h File Reference

This file provides the definitions for User Plane Messages APIs. More...

#include <rte_common.h>
#include <rte_mbuf.h>
#include "xran_pkt.h"
#include "xran_pkt_up.h"

Include dependency graph for xran_up_api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	xran_up_pkt_gen_params
struct	xran_up_pkt_gen_no_compression_params

Functions
int32_t	xran_extract_iq_samples (struct rte_mbuf *mbuf, void **iq_data_start, uint8_t *CC_ID, uint8_t *Ant_ID, uint8_t *frame_id, uint8_t *subframe_id, uint8_t *slot_id, uint8_t *symb_id, struct ecpri_seq_id *seq_id, uint16_t *num_prbu, uint16_t *start_prbu, uint16_t *sym_inc, uint16_t *rb, uint16_t *sect_id, int8_t expect_comp, uint8_t *compMeth, uint8_t *iqWidth)
	Function extracts IQ samples from received mbuf packet. More...
int	xran_prepare_iq_symbol_portion (struct rte_mbuf *mbuf, const void *iq_data_start, const enum xran_input_byte_order iq_buf_byte_order, const uint32_t iq_data_num_bytes, struct xran_up_pkt_gen_params *params, uint8_t CC_ID, uint8_t Ant_ID, uint8_t seq_id, uint32_t do_copy)
	Function for starting preparion of IQ samples portions to be sent in xRAN packet. More...

Detailed Description

This file provides the definitions for User Plane Messages APIs.

Author

Intel Corporation

Definition in file xran_up_api.h.

Function Documentation

xran_extract_iq_samples()

int32_t xran_extract_iq_samples	(	struct rte_mbuf *	mbuf,
		void **	iq_data_start,
		uint8_t *	CC_ID,
		uint8_t *	Ant_ID,
		uint8_t *	frame_id,
		uint8_t *	subframe_id,
		uint8_t *	slot_id,
		uint8_t *	symb_id,
		struct ecpri_seq_id *	seq_id,
		uint16_t *	num_prbu,
		uint16_t *	start_prbu,
		uint16_t *	sym_inc,
		uint16_t *	rb,
		uint16_t *	sect_id,
		int8_t	expect_comp,
		uint8_t *	compMeth,
		uint8_t *	iqWidth
	)

Function extracts IQ samples from received mbuf packet.

Parameters

mbuf	Packet with received data.
iq_data_start	Address of the first IQ sample in mbuf will be returned here

Returns

int Bytes of IQ samples that have been extracted from mbuf.

Function extracts IQ samples from received mbuf packet.

Parameters

iq_data_start	Address of the first element in IQ data array.
symb_id	Symbol ID to be extracted from ecpri header
seq_id	Sequence ID to be extracted from radio header

Returns

int Size of remaining mbuf filled with IQ samples zero on failure

Definition at line 327 of file xran_up_api.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xran_prepare_iq_symbol_portion()

int xran_prepare_iq_symbol_portion	(	struct rte_mbuf *	mbuf,
		const void *	iq_data_start,
		const enum xran_input_byte_order	iq_buf_byte_order,
		const uint32_t	iq_data_num_bytes,
		struct xran_up_pkt_gen_params *	params,
		uint8_t	CC_ID,
		uint8_t	Ant_ID,
		uint8_t	seq_id,
		uint32_t	do_copy
	)

Function for starting preparion of IQ samples portions to be sent in xRAN packet.

Parameters

mbuf	Initialized rte_mbuf packet.
iq_data_start	Address of the first element in IQ data array.
iq_data_num_bytes	Size of the IQ data array.
iq_data_offset	IQ data bytes already sent.
alignment	Size of IQ data alignment.
pkt_gen_params	Struct with parameters used for building packet

Returns

int Number of bytes that have been appended to the packet within all appended sections.

Definition at line 455 of file xran_up_api.c.

Here is the caller graph for this function: