o-du/phy
Intel O-RAN/X-RAN Generated Doxygen Documentation
Data Fields
xran_buffer_list Struct Reference

#include <xran_fh_o_du.h>

Collaboration diagram for xran_buffer_list:
Collaboration graph

Data Fields

uint32_t nNumBuffers
 
struct xran_flat_bufferpBuffers
 
void * pUserData
 
void * pPrivateMetaData
 

Detailed Description

Scatter/Gather buffer list containing an array of Simple buffers.

A Scatter/Gather buffer list structure. It is expected that this buffer structure will be used where more than one flat buffer can be provided on a particular API.

IMPORTANT - The memory for the pPrivateMetaData member must be allocated by the client as contiguous memory. When allocating memory for pPrivateMetaData a call to cpaCyBufferListGetMetaSize MUST be made to determine the size of the Meta Data Buffer. The returned size (in bytes) may then be passed in a memory allocation routine to allocate the pPrivateMetaData memory.

Definition at line 592 of file xran_fh_o_du.h.

Field Documentation

◆ nNumBuffers

uint32_t nNumBuffers

Number of pointers

Definition at line 594 of file xran_fh_o_du.h.

◆ pBuffers

struct xran_flat_buffer* pBuffers

Pointer to an unbounded array containing the number of CpaFlatBuffers defined by nNumBuffers

Definition at line 596 of file xran_fh_o_du.h.

◆ pPrivateMetaData

void* pPrivateMetaData

Private Meta representation of this buffer List - the memory for this buffer needs to be allocated by the client as contiguous data. The amount of memory required is returned with a call to cpaCyBufferListGetMetaSize. If cpaCyBufferListGetMetaSize returns a size of zero no memory needs to be allocated, and this parameter can be NULL.

Definition at line 601 of file xran_fh_o_du.h.

◆ pUserData

void* pUserData

This is an opaque field that is not read or modified internally.

Definition at line 599 of file xran_fh_o_du.h.


The documentation for this struct was generated from the following file: