pipeline Struct Reference

Audio pipeline structure representing a stream graph and execution context. More...

#include <src/include/sof/audio/pipeline.h>

Collaboration diagram for pipeline:

Data Fields
struct mod_alloc_ctx *	alloc
	Alloc context used for allocating this pipeline.
uint32_t	comp_id
	Component ID for pipeline.
uint32_t	pipeline_id
	Pipeline ID.
uint32_t	sched_id
	Scheduling component ID.
uint32_t	core
	Core we run on.
uint32_t	period
	Execution period in microseconds.
uint32_t	priority
	Priority level 0 (low) to 10 (max)
uint32_t	period_mips
	Worst case instruction count per period.
uint32_t	frames_per_sched
	Output frames of pipeline, 0 is variable.
uint32_t	xrun_limit_usecs
	Report xruns greater than limit.
uint32_t	time_domain
	Scheduling time domain.
uint32_t	attributes
	Pipeline attributes from IPC extension message.
int32_t	xrun_bytes
	Last xrun length in bytes.
uint32_t	status
	Pipeline status flags.
struct tr_ctx	tctx
	Trace settings.
struct task *	trigger_task
	IPC4 pipeline trigger task.
struct task *	pipe_task
	IPC3 pipeline processing task or IPC4 pipeline copy task.
struct pipeline *	sched_next
	Pipeline scheduled after this.
struct pipeline *	sched_prev
	Pipeline scheduled before this.
struct comp_dev *	sched_comp
	Component that drives scheduling in this pipe.
struct comp_dev *	source_comp
	Source component for this pipe.
struct comp_dev *	sink_comp
	Sink component for this pipe.
struct list_item	list
	List item in walk context.
uint32_t	posn_offset
	Position update array offset.
struct ipc_msg *	msg
	IPC message pointer for position updates.
struct {
int   cmd
	Trigger command. More...
struct comp_dev *   host
	Associated host component device. More...
unsigned int   delay
	Period count delay. More...
bool   aborted
	STOP or PAUSE failed, stay active. More...
bool   pending
	Trigger scheduled but not executed yet. More...
}	trigger
	Pipeline trigger control structure.

Detailed Description

Audio pipeline structure representing a stream graph and execution context.

Field Documentation

aborted

bool pipeline::aborted

STOP or PAUSE failed, stay active.

alloc

struct mod_alloc_ctx* pipeline::alloc

Alloc context used for allocating this pipeline.

attributes

uint32_t pipeline::attributes

Pipeline attributes from IPC extension message.

cmd

int pipeline::cmd

Trigger command.

comp_id

uint32_t pipeline::comp_id

Component ID for pipeline.

core

uint32_t pipeline::core

Core we run on.

delay

unsigned int pipeline::delay

Period count delay.

frames_per_sched

uint32_t pipeline::frames_per_sched

Output frames of pipeline, 0 is variable.

host

struct comp_dev* pipeline::host

Associated host component device.

list

struct list_item pipeline::list

List item in walk context.

msg

struct ipc_msg* pipeline::msg

IPC message pointer for position updates.

pending

bool pipeline::pending

Trigger scheduled but not executed yet.

period

uint32_t pipeline::period

Execution period in microseconds.

period_mips

uint32_t pipeline::period_mips

Worst case instruction count per period.

pipe_task

struct task* pipeline::pipe_task

IPC3 pipeline processing task or IPC4 pipeline copy task.

pipeline_id

uint32_t pipeline::pipeline_id

Pipeline ID.

posn_offset

uint32_t pipeline::posn_offset

Position update array offset.

priority

uint32_t pipeline::priority

Priority level 0 (low) to 10 (max)

sched_comp

struct comp_dev* pipeline::sched_comp

Component that drives scheduling in this pipe.

sched_id

uint32_t pipeline::sched_id

Scheduling component ID.

sched_next

struct pipeline* pipeline::sched_next

Pipeline scheduled after this.

sched_prev

struct pipeline* pipeline::sched_prev

Pipeline scheduled before this.

sink_comp

struct comp_dev* pipeline::sink_comp

Sink component for this pipe.

source_comp

struct comp_dev* pipeline::source_comp

Source component for this pipe.

status

uint32_t pipeline::status

Pipeline status flags.

tctx

struct tr_ctx pipeline::tctx

Trace settings.

time_domain

uint32_t pipeline::time_domain

Scheduling time domain.

[struct]

struct { ... } pipeline::trigger

Pipeline trigger control structure.

trigger_task

struct task* pipeline::trigger_task

IPC4 pipeline trigger task.

xrun_bytes

int32_t pipeline::xrun_bytes

Last xrun length in bytes.

xrun_limit_usecs

uint32_t pipeline::xrun_limit_usecs

Report xruns greater than limit.

---

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

• src/include/sof/audio/pipeline.h