X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fcommon__typedef__xran_8h.html;fp=docs%2FAPI%2Fcommon__typedef__xran_8h.html;h=a81fbc23572c717302dc1de841b39209b7ebe5cb;hb=870e1b86b0c74169b215c166dee787c7c1a20d06;hp=0000000000000000000000000000000000000000;hpb=298022ce50fa8133cc880507170c4b7120d227b5;p=o-du%2Fphy.git diff --git a/docs/API/common__typedef__xran_8h.html b/docs/API/common__typedef__xran_8h.html new file mode 100644 index 0000000..a81fbc2 --- /dev/null +++ b/docs/API/common__typedef__xran_8h.html @@ -0,0 +1,377 @@ + + + + + + + +o-du/phy: common_typedef_xran.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
o-du/phy +
+
Intel O-RAN/X-RAN Generated Doxygen Documentation
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Data Structures | +Macros | +Typedefs | +Enumerations
+
+
common_typedef_xran.h File Reference
+
+
+ +

This header file defines those data type both used by eNB and UE. +More...

+
#include <stdint.h>
+#include <stdio.h>
+#include <stdbool.h>
+
+Include dependency graph for common_typedef_xran.h:
+
+
+ + +
+
+This graph shows which files directly or indirectly include this file:
+
+
+ + + + + + + + + + + + + + +
+
+

Go to the source code of this file.

+ + + + + + + + + + + + + + + + + + + + +

+Data Structures

struct  COMPLEX32
 Defines 64-bit complex structure; both real part and image part have 32 bit width. More...
 
struct  complex_int16_t
 Defines 32-bit complex structure; both real part and image part have 16 bit width. More...
 
struct  complex_int32_t
 Defines 64-bit complex structure; both real part and image part have 32 bit width. More...
 
struct  complex_float
 Defines 64-bit complex structure; both real part and image part have 32 bit width. More...
 
struct  complex_double
 Defines 128-bit complex structure; both real part and image part have 64 bit width. More...
 
struct  complex_half
 Defines 32-bit complex structure; both real part and image part have 16 bit width. More...
 
+ + + + + + + + + +

+Macros

#define __align(x)   __attribute__((aligned(x)))
 
#define _aligned_malloc(x, y)   memalign(y,x)
 
#define TIME   40
 
#define LOOP   30
 
+ + + + + + + +

+Typedefs

typedef int16_t half
 half is a 16-bit IEEE floating-point standard number format. More...
 
typedef struct complex_int16_t COMPLEX16
 
+ + + + + + + +

+Enumerations

enum  instruction_cpu_support {
+  CPU_GENERIC, +SSE4_2, +AVX, +AVX2, +
+  AVX_512 +
+ }
 Define instruction the CPU can support. More...
 
enum  bblib_modulation_order {
+  BBLIB_BPSK = 1, +BBLIB_QPSK = 2, +BBLIB_PAM4 = 3, +BBLIB_QAM16 = 4, +
+  BBLIB_PAM8 = 5, +BBLIB_QAM64 = 6, +BBLIB_PAM16 = 7, +BBLIB_QAM256 = 8 +
+ }
 Common enums for modulation order. More...
 
+

Detailed Description

+

This header file defines those data type both used by eNB and UE.

+ +

Definition in file common_typedef_xran.h.

+

Macro Definition Documentation

+ +

◆ __align

+ +
+
+ + + + + + + + +
#define __align( x)   __attribute__((aligned(x)))
+
+ +

Definition at line 127 of file common_typedef_xran.h.

+ +
+
+ +

◆ _aligned_malloc

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define _aligned_malloc( x,
 
)   memalign(y,x)
+
+ +

Definition at line 128 of file common_typedef_xran.h.

+ +
+
+ +

◆ LOOP

+ +
+
+ + + + +
#define LOOP   30
+
+ +

Definition at line 133 of file common_typedef_xran.h.

+ +
+
+ +

◆ TIME

+ +
+
+ + + + +
#define TIME   40
+
+ +

Definition at line 132 of file common_typedef_xran.h.

+ +
+
+

Typedef Documentation

+ +

◆ COMPLEX16

+ +
+
+ + + + +
typedef struct complex_int16_t COMPLEX16
+
+ +
+
+ +

◆ half

+ +
+
+ + + + +
half
+
+ +

half is a 16-bit IEEE floating-point standard number format.

+
Note
In future this will be known as `short float' or `__fp16'.
+
+Older compilers must provide proxy support for it as a plain 16-bit integer
+ +

Definition at line 85 of file common_typedef_xran.h.

+ +
+
+

Enumeration Type Documentation

+ +

◆ bblib_modulation_order

+ +
+
+ + + + +
enum bblib_modulation_order
+
+ +

Common enums for modulation order.

+ + + + + + + + + +
Enumerator
BBLIB_BPSK 

BPSK

+
BBLIB_QPSK 

QPSK

+
BBLIB_PAM4 

PAM4

+
BBLIB_QAM16 

QAM16

+
BBLIB_PAM8 

PAM8

+
BBLIB_QAM64 

QAM64

+
BBLIB_PAM16 

PAM16

+
BBLIB_QAM256 

QAM256

+
+ +

Definition at line 112 of file common_typedef_xran.h.

+ +
+
+ +

◆ instruction_cpu_support

+ +
+
+ + + + +
enum instruction_cpu_support
+
+ +

Define instruction the CPU can support.

+ + + + + + +
Enumerator
CPU_GENERIC 

C

+
SSE4_2 

SSE4_2

+
AVX 

AVX

+
AVX2 

AVX2

+
AVX_512 

AVX512

+
+ +

Definition at line 100 of file common_typedef_xran.h.

+ +
+
+
+ + + +