X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fstructxran__flat__buffer.html;fp=docs%2FAPI%2Fstructxran__flat__buffer.html;h=0000000000000000000000000000000000000000;hb=bdbd414e8038630c154ee3c6b8bc9b3aeb954be6;hp=142a4918f73f64d80557f05213dbad2465d7806f;hpb=e9403c457453dba780e64af7de9462fad7217aa3;p=o-du%2Fphy.git diff --git a/docs/API/structxran__flat__buffer.html b/docs/API/structxran__flat__buffer.html deleted file mode 100644 index 142a491..0000000 --- a/docs/API/structxran__flat__buffer.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - - -o-du/phy: xran_flat_buffer Struct Reference - - - - - - - - - -
-
- - - - - - -
-
o-du/phy -
-
Intel O-RAN/X-RAN Generated Doxygen Documentation
-
-
- - - - - - - - -
-
- - -
- -
- -
-
-
-Data Fields
-
-
xran_flat_buffer Struct Reference
-
-
- -

#include <xran_fh_o_du.h>

-
-Collaboration diagram for xran_flat_buffer:
-
-
Collaboration graph
-
- - - - - - - - - - - - - - -

-Data Fields

uint32_t nElementLenInBytes
 
uint32_t nNumberOfElements
 
uint32_t nOffsetInBytes
 
uint32_t nIsPhyAddr
 
uint8_t * pData
 
void * pCtrl
 
-

Detailed Description

-

A flat buffer structure. The data pointer, pData, is a virtual address. The API requires the memory to by physically contiguous. Each flat buffer segment may contain several equally sized elements.

- -

Definition at line 553 of file xran_fh_o_du.h.

-

Field Documentation

- -

◆ nElementLenInBytes

- -
-
- - - - -
uint32_t nElementLenInBytes
-
-

The Element length specified in bytes. This parameter specifies the size of a single element in the buffer. The total size of the buffer is described as bufferSize = nElementLenInBytes * nNumberOfElements

- -

Definition at line 555 of file xran_fh_o_du.h.

- -
-
- -

◆ nIsPhyAddr

- -
-
- - - - -
uint32_t nIsPhyAddr
-
- -

Definition at line 565 of file xran_fh_o_du.h.

- -
-
- -

◆ nNumberOfElements

- -
-
- - - - -
uint32_t nNumberOfElements
-
-

The number of elements in the physical contiguous memory segment

- -

Definition at line 560 of file xran_fh_o_du.h.

- -
-
- -

◆ nOffsetInBytes

- -
-
- - - - -
uint32_t nOffsetInBytes
-
-

Offset in bytes to the start of the data in the physical contiguous memory segment

- -

Definition at line 562 of file xran_fh_o_du.h.

- -
-
- -

◆ pCtrl

- -
-
- - - - -
void* pCtrl
-
-

pointer to control section coresponding to data buffer

- -

Definition at line 570 of file xran_fh_o_du.h.

- -
-
- -

◆ pData

- -
-
- - - - -
uint8_t* pData
-
-

The data pointer is a virtual address, however the actual data pointed to is required to be in contiguous physical memory unless the field requiresPhysicallyContiguousMemory in CpaInstanceInfo is false.

- -

Definition at line 566 of file xran_fh_o_du.h.

- -
-
-
The documentation for this struct was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.13 -
- -