X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fclass_c__plane.html;fp=docs%2FAPI%2Fclass_c__plane.html;h=1145fc81fc7a005aea11ed54bb0ba6b91a222012;hb=870e1b86b0c74169b215c166dee787c7c1a20d06;hp=0000000000000000000000000000000000000000;hpb=298022ce50fa8133cc880507170c4b7120d227b5;p=o-du%2Fphy.git diff --git a/docs/API/class_c__plane.html b/docs/API/class_c__plane.html new file mode 100644 index 0000000..1145fc8 --- /dev/null +++ b/docs/API/class_c__plane.html @@ -0,0 +1,2013 @@ + + + + + + + +o-du/phy: C_plane Class Reference + + + + + + + + + +
+
+ + + + + + +
+
o-du/phy +
+
Intel O-RAN/X-RAN Generated Doxygen Documentation
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Static Public Member Functions | +Static Public Attributes | +Protected Member Functions | +Protected Attributes
+
+
C_plane Class Reference
+
+
+
+Inheritance diagram for C_plane:
+
+
Inheritance graph
+ + + +
+
+Collaboration diagram for C_plane:
+
+
Collaboration graph
+ + + + + + + + + + + + + + + + +
+ + + + + + + + +

+Static Public Member Functions

static void SetUpTestCase ()
 
static void TearDownTestCase ()
 
static unsigned get_number_of_cases (const std::string &type)
 
+ + + + + +

+Static Public Attributes

static json conf
 
static std::string test_type
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

void SetUp () override
 
void TearDown () override
 
int prepare_sections (bool extflag)
 
int prepare_extensions (int sect_num)
 
void verify_sections (void)
 
void set_division_factor (const double factor)
 Set division factor. More...
 
void set_results_units (const std::string &units)
 Set reults units. More...
 
void set_parallelization_factor (const int factor)
 Set size of processed data. More...
 
template<typename F , typename ... Args>
void performance (const std::string &isa, const std::string &module_name, F function, Args ... args)
 Run performance test case for a given function. More...
 
void print_test_description (const std::string &isa, const std::string &module_name)
 Print unique test description to the results xml file. More...
 
const std::string get_case_name ()
 Get name of the test case from JSON file. More...
 
void init_test (const std::string &type)
 Defines section in the conf.json that is used to load parameters from. More...
 
template<typename T >
get_input_parameter (const std::string &parameter_name)
 Load selected data from a JSON object. get_input_parameter loads data from parameters section of the test case in JSON file and get_reference_parameter does the same thing for references section. More...
 
template<typename T >
get_reference_parameter (const std::string &parameter_name)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

int m_maxSections = 8
 
int m_numSections
 
struct rte_mbuf * m_pTestBuffer
 
struct xran_cp_gen_params m_params
 
struct xran_recv_packet_info m_pktInfo
 
struct xran_cp_gen_params m_result
 
uint8_t m_dir
 
std::string m_dirStr
 
uint8_t m_sectionType
 
uint8_t m_ccId
 
uint8_t m_antId
 
uint8_t m_seqId
 
uint8_t m_frameId
 
uint8_t m_subframeId
 
uint8_t m_slotId
 
uint8_t m_symStart
 
uint8_t m_symNum
 
uint16_t * m_prbStart = NULL
 
uint16_t * m_prbNum = NULL
 
uint8_t m_iqWidth
 
uint8_t m_compMethod
 
uint16_t m_beamId
 
uint16_t m_reMask = 0xfff
 
uint16_t m_sectionId
 
uint8_t m_filterIndex
 
uint16_t m_timeOffset
 
uint8_t m_fftSize
 
uint8_t m_scs
 
uint16_t m_cpLength
 
int m_freqOffset
 
uint16_t m_ext1_dst_len = 0
 
int8_t * m_p_ext1_dst = NULL
 
int16_t * m_p_bfw_iq_src = NULL
 
struct xran_sectionext1_info m_ext1
 
struct xran_sectionext2_info m_ext2
 
struct xran_sectionext4_info m_ext4
 
struct xran_sectionext5_info m_ext5
 
int16_t m_bfwIQ [XRAN_MAX_BFW_N *2]
 
double division_factor = 1.0
 
std::string result_units = "None"
 
int parallelization_factor = 1
 
+

Detailed Description

+
+

Definition at line 62 of file c_plane_tests.cc.

+

Member Function Documentation

+ +

◆ get_case_name()

+ +
+
+ + + + + +
+ + + + + + + +
const std::string get_case_name ()
+
+inlineprotectedinherited
+
+ +

Get name of the test case from JSON file.

+
Returns
Test'ss case name or a default name if name field is missing.
+ +

Definition at line 338 of file common.hpp.

+ +
+
+ +

◆ get_input_parameter()

+ +
+
+ + + + + +
+ + + + + + + + +
T get_input_parameter (const std::string & parameter_name)
+
+inlineprotectedinherited
+
+ +

Load selected data from a JSON object. get_input_parameter loads data from parameters section of the test case in JSON file and get_reference_parameter does the same thing for references section.

+

Get parameter function uses template type to figure out how to load parameters. If type is NOT a pointer it'll load value directly from the JSON. Otherwise path to the test vector is expected and function will allocate memory, load data from the binary file to this memory location and return pointer to it. For example in here we request to load pointer to float so llrs filed is expected to be a path to the binary file.

+ +

Definition at line 290 of file common.hpp.

+
+Here is the call graph for this function:
+
+
+ + + + + + + + + + + +
+ +
+
+ +

◆ get_number_of_cases()

+ +
+
+ + + + + +
+ + + + + + + + +
static unsigned get_number_of_cases (const std::string & type)
+
+inlinestaticinherited
+
+ +

Definition at line 190 of file common.hpp.

+
+Here is the call graph for this function:
+
+
+ + + + + +
+
+Here is the caller graph for this function:
+
+
+ + + +
+ +
+
+ +

◆ get_reference_parameter()

+ +
+
+ + + + + +
+ + + + + + + + +
T get_reference_parameter (const std::string & parameter_name)
+
+inlineprotectedinherited
+
+ +

Definition at line 312 of file common.hpp.

+
+Here is the call graph for this function:
+
+
+ + + + + + + + + + + +
+ +
+
+ +

◆ init_test()

+ +
+
+ + + + + +
+ + + + + + + + +
void init_test (const std::string & type)
+
+inlineprotectedinherited
+
+ +

Defines section in the conf.json that is used to load parameters from.

+
Parameters
+ + +
[in]typeName of the section in the JSON file.
+
+
+ +

Definition at line 358 of file common.hpp.

+
+Here is the call graph for this function:
+
+
+ + + + +
+
+Here is the caller graph for this function:
+
+
+ + + + + + + + +
+ +
+
+ +

◆ performance()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void performance (const std::string & isa,
const std::string & module_name,
function,
Args ... args 
)
+
+inlineprotectedinherited
+
+ +

Run performance test case for a given function.

+
Parameters
+ + + + + +
[in]isaUsed Instruction Set.
[in]module_namename of the tested kernel.
[in]functionfunction to be tested.
[in]argsfunction's arguments.
+
+
+ +

Definition at line 253 of file common.hpp.

+
+Here is the call graph for this function:
+
+
+ + + + + +
+
+Here is the caller graph for this function:
+
+
+ + + +
+ +
+
+ +

◆ prepare_extensions()

+ +
+
+ + + + + +
+ + + + + + + + +
int prepare_extensions (int sect_num)
+
+protected
+
+ +

Definition at line 230 of file c_plane_tests.cc.

+
+Here is the caller graph for this function:
+
+
+ + + + + +
+ +
+
+ +

◆ prepare_sections()

+ +
+
+ + + + + +
+ + + + + + + + +
int prepare_sections (bool extflag)
+
+protected
+
+ +

Definition at line 320 of file c_plane_tests.cc.

+
+Here is the call graph for this function:
+
+
+ + + +
+
+Here is the caller graph for this function:
+
+
+ + + + +
+ +
+
+ +

◆ print_test_description()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void print_test_description (const std::string & isa,
const std::string & module_name 
)
+
+inlineprotectedinherited
+
+ +

Print unique test description to the results xml file.

+
Parameters
+ + + + +
[in]isaUsed Instruction Set.
[in]module_namename of the tested kernel.
[in]functionfunction to be tested.
+
+
+ +

Definition at line 271 of file common.hpp.

+ +
+
+ +

◆ set_division_factor()

+ +
+
+ + + + + +
+ + + + + + + + +
void set_division_factor (const double factor)
+
+inlineprotectedinherited
+
+ +

Set division factor.

+
Parameters
+ + +
[in]factorDivision factor that divides mean and standard deviation.
+
+
+ +

Definition at line 222 of file common.hpp.

+ +
+
+ +

◆ set_parallelization_factor()

+ +
+
+ + + + + +
+ + + + + + + + +
void set_parallelization_factor (const int factor)
+
+inlineprotectedinherited
+
+ +

Set size of processed data.

+
Parameters
+ + +
[in]sizeSize of processed data used to calculate module throughput.
+
+
+ +

Definition at line 240 of file common.hpp.

+ +
+
+ +

◆ set_results_units()

+ +
+
+ + + + + +
+ + + + + + + + +
void set_results_units (const std::string & units)
+
+inlineprotectedinherited
+
+ +

Set reults units.

+
Parameters
+ + +
[in]unitsUnits that are displayed in the report.
+
+
+ +

Definition at line 231 of file common.hpp.

+ +
+
+ +

◆ SetUp()

+ +
+
+ + + + + +
+ + + + + + + +
void SetUp ()
+
+inlineoverrideprotected
+
+ +

Definition at line 112 of file c_plane_tests.cc.

+
+Here is the call graph for this function:
+
+
+ + + + + + +
+ +
+
+ +

◆ SetUpTestCase()

+ +
+
+ + + + + +
+ + + + + + + +
static void SetUpTestCase ()
+
+inlinestaticinherited
+
+ +

Definition at line 162 of file common.hpp.

+
+Here is the call graph for this function:
+
+
+ + + + + + +
+ +
+
+ +

◆ TearDown()

+ +
+
+ + + + + +
+ + + + + + + +
void TearDown ()
+
+inlineoverrideprotected
+
+ +

Definition at line 195 of file c_plane_tests.cc.

+
+Here is the call graph for this function:
+
+
+ + + + + +
+ +
+
+ +

◆ TearDownTestCase()

+ +
+
+ + + + + +
+ + + + + + + +
static void TearDownTestCase ()
+
+inlinestaticinherited
+
+ +

Definition at line 185 of file common.hpp.

+ +
+
+ +

◆ verify_sections()

+ +
+
+ + + + + +
+ + + + + + + + +
void verify_sections (void )
+
+protected
+
+ +

Definition at line 394 of file c_plane_tests.cc.

+
+Here is the caller graph for this function:
+
+
+ + + + +
+ +
+
+

Field Documentation

+ +

◆ conf

+ +
+
+ + + + + +
+ + + + +
json conf
+
+staticinherited
+
+ +

Definition at line 159 of file common.hpp.

+ +
+
+ +

◆ division_factor

+ +
+
+ + + + + +
+ + + + +
double division_factor = 1.0
+
+protectedinherited
+
+ +

Definition at line 214 of file common.hpp.

+ +
+
+ +

◆ m_antId

+ +
+
+ + + + + +
+ + + + +
uint8_t m_antId
+
+protected
+
+ +

Definition at line 83 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_beamId

+ +
+
+ + + + + +
+ + + + +
uint16_t m_beamId
+
+protected
+
+ +

Definition at line 90 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_bfwIQ

+ +
+
+ + + + + +
+ + + + +
int16_t m_bfwIQ[XRAN_MAX_BFW_N *2]
+
+protected
+
+ +

Definition at line 109 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_ccId

+ +
+
+ + + + + +
+ + + + +
uint8_t m_ccId
+
+protected
+
+ +

Definition at line 83 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_compMethod

+ +
+
+ + + + + +
+ + + + +
uint8_t m_compMethod
+
+protected
+
+ +

Definition at line 89 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_cpLength

+ +
+
+ + + + + +
+ + + + +
uint16_t m_cpLength
+
+protected
+
+ +

Definition at line 97 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_dir

+ +
+
+ + + + + +
+ + + + +
uint8_t m_dir
+
+protected
+
+ +

Definition at line 79 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_dirStr

+ +
+
+ + + + + +
+ + + + +
std::string m_dirStr
+
+protected
+
+ +

Definition at line 80 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_ext1

+ +
+
+ + + + + +
+ + + + +
struct xran_sectionext1_info m_ext1
+
+protected
+
+ +

Definition at line 104 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_ext1_dst_len

+ +
+
+ + + + + +
+ + + + +
uint16_t m_ext1_dst_len = 0
+
+protected
+
+ +

Definition at line 100 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_ext2

+ +
+
+ + + + + +
+ + + + +
struct xran_sectionext2_info m_ext2
+
+protected
+
+ +

Definition at line 105 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_ext4

+ +
+
+ + + + + +
+ + + + +
struct xran_sectionext4_info m_ext4
+
+protected
+
+ +

Definition at line 106 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_ext5

+ +
+
+ + + + + +
+ + + + +
struct xran_sectionext5_info m_ext5
+
+protected
+
+ +

Definition at line 107 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_fftSize

+ +
+
+ + + + + +
+ + + + +
uint8_t m_fftSize
+
+protected
+
+ +

Definition at line 95 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_filterIndex

+ +
+
+ + + + + +
+ + + + +
uint8_t m_filterIndex
+
+protected
+
+ +

Definition at line 93 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_frameId

+ +
+
+ + + + + +
+ + + + +
uint8_t m_frameId
+
+protected
+
+ +

Definition at line 85 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_freqOffset

+ +
+
+ + + + + +
+ + + + +
int m_freqOffset
+
+protected
+
+ +

Definition at line 98 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_iqWidth

+ +
+
+ + + + + +
+ + + + +
uint8_t m_iqWidth
+
+protected
+
+ +

Definition at line 89 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_maxSections

+ +
+
+ + + + + +
+ + + + +
int m_maxSections = 8
+
+protected
+
+ +

Definition at line 70 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_numSections

+ +
+
+ + + + + +
+ + + + +
int m_numSections
+
+protected
+
+ +

Definition at line 71 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_p_bfw_iq_src

+ +
+
+ + + + + +
+ + + + +
int16_t* m_p_bfw_iq_src = NULL
+
+protected
+
+ +

Definition at line 102 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_p_ext1_dst

+ +
+
+ + + + + +
+ + + + +
int8_t* m_p_ext1_dst = NULL
+
+protected
+
+ +

Definition at line 101 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_params

+ +
+
+ + + + + +
+ + + + +
struct xran_cp_gen_params m_params
+
+protected
+
+ +

Definition at line 75 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_pktInfo

+ +
+
+ + + + + +
+ + + + +
struct xran_recv_packet_info m_pktInfo
+
+protected
+
+ +

Definition at line 76 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_prbNum

+ +
+
+ + + + + +
+ + + + +
uint16_t * m_prbNum = NULL
+
+protected
+
+ +

Definition at line 87 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_prbStart

+ +
+
+ + + + + +
+ + + + +
uint16_t* m_prbStart = NULL
+
+protected
+
+ +

Definition at line 87 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_pTestBuffer

+ +
+
+ + + + + +
+ + + + +
struct rte_mbuf* m_pTestBuffer
+
+protected
+
+ +

Definition at line 73 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_reMask

+ +
+
+ + + + + +
+ + + + +
uint16_t m_reMask = 0xfff
+
+protected
+
+ +

Definition at line 91 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_result

+ +
+
+ + + + + +
+ + + + +
struct xran_cp_gen_params m_result
+
+protected
+
+ +

Definition at line 77 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_scs

+ +
+
+ + + + + +
+ + + + +
uint8_t m_scs
+
+protected
+
+ +

Definition at line 96 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_sectionId

+ +
+
+ + + + + +
+ + + + +
uint16_t m_sectionId
+
+protected
+
+ +

Definition at line 92 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_sectionType

+ +
+
+ + + + + +
+ + + + +
uint8_t m_sectionType
+
+protected
+
+ +

Definition at line 81 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_seqId

+ +
+
+ + + + + +
+ + + + +
uint8_t m_seqId
+
+protected
+
+ +

Definition at line 84 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_slotId

+ +
+
+ + + + + +
+ + + + +
uint8_t m_slotId
+
+protected
+
+ +

Definition at line 85 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_subframeId

+ +
+
+ + + + + +
+ + + + +
uint8_t m_subframeId
+
+protected
+
+ +

Definition at line 85 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_symNum

+ +
+
+ + + + + +
+ + + + +
uint8_t m_symNum
+
+protected
+
+ +

Definition at line 86 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_symStart

+ +
+
+ + + + + +
+ + + + +
uint8_t m_symStart
+
+protected
+
+ +

Definition at line 86 of file c_plane_tests.cc.

+ +
+
+ +

◆ m_timeOffset

+ +
+
+ + + + + +
+ + + + +
uint16_t m_timeOffset
+
+protected
+
+ +

Definition at line 94 of file c_plane_tests.cc.

+ +
+
+ +

◆ parallelization_factor

+ +
+
+ + + + + +
+ + + + +
int parallelization_factor = 1
+
+protectedinherited
+
+ +

Definition at line 216 of file common.hpp.

+ +
+
+ +

◆ result_units

+ +
+
+ + + + + +
+ + + + +
std::string result_units = "None"
+
+protectedinherited
+
+ +

Definition at line 215 of file common.hpp.

+ +
+
+ +

◆ test_type

+ +
+
+ + + + + +
+ + + + +
std::string test_type
+
+staticinherited
+
+ +

Definition at line 160 of file common.hpp.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + +