dspqueue
Asynchronous DSP Packet Queue
dspqueue_buffer Struct Reference

#include <dspqueue.h>

Public Attributes

uint32_t fd
 
uint32_t size
 
uint32_t offset
 
uint32_t flags
 
union {
   void *   ptr
 
   uint64_t   address
 
}; 
 

Detailed Description

Buffer reference in a packet. The buffer must already be mapped to the DSP using the same file descriptor. The subsection of the buffer as specified by offset and size must fit entirely within the mapped buffer. Note that buffer references are tracked based on the buffer file descriptor, and taking/releasing a reference to a buffer applies to the entire buffer as mapped to the DSP, not just the subsection specified.

Member Data Documentation

◆ fd

uint32_t dspqueue_buffer::fd

Buffer file descriptor

◆ flags

uint32_t dspqueue_buffer::flags

Buffer flags, see enum dspqueue_buffer_flags

◆ offset

uint32_t dspqueue_buffer::offset

Offset within the buffer in bytes as allocated and mapped. The virtual address ptr includes the offset

◆ ptr

void* dspqueue_buffer::ptr

Buffer virtual address; NULL if not mapped in the local context

◆ size

uint32_t dspqueue_buffer::size

Buffer size in bytes. The client can set this field to zero when writing packets; in this case the framework will set the field to the size of the buffer as mapped.


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