doxygen/html/mpipe__pipeline_8h_source.html

/*

 * Copyright 2025-2026 NXP

 *

 * SPDX-License-Identifier: Apache-2.0

 */


#ifndef ZEPHYR_INCLUDE_MPIPE_MPIPE_PIPELINE_H_

#define ZEPHYR_INCLUDE_MPIPE_MPIPE_PIPELINE_H_


#include <stdint.h>


#include <zephyr/net_buf.h>

#include <zephyr/sys/atomic.h>

#include <zephyr/zbus/zbus.h>


#include <zephyr/mpipe/mpipe_bin.h>

#include <zephyr/mpipe/mpipe_message.h>

#include <zephyr/mpipe/mpipe_thread.h>


enum mpipe_prop_pipeline {

        MPIPE_PROP_PIPELINE_THREAD_PRIORITY,

};


struct mpipe {

        struct mpipe_bin bin;

        struct mpipe_thread thread;

        uint32_t num_sinks;

        atomic_t eos_count;

};


int mpipe_pipeline_init(struct mpipe *pipe, uint8_t id);


int mpipe_push_buffer(struct mpipe_pad *src_pad, struct net_buf *buffer);


#endif /* ZEPHYR_INCLUDE_MPIPE_MPIPE_PIPELINE_H_ */

atomic_t
long atomic_t
Atomic integer variable.
Definition atomic_types.h:31

mpipe_prop_pipeline
mpipe_prop_pipeline
Properties for a pipeline.
Definition mpipe_pipeline.h:61

mpipe_push_buffer
int mpipe_push_buffer(struct mpipe_pad *src_pad, struct net_buf *buffer)
Push a buffer downstream starting from a given source pad.

mpipe_pipeline_init
int mpipe_pipeline_init(struct mpipe *pipe, uint8_t id)
Initialize a pipeline.

MPIPE_PROP_PIPELINE_THREAD_PRIORITY
@ MPIPE_PROP_PIPELINE_THREAD_PRIORITY
Thread scheduling priority used when the pipeline thread is created.
Definition mpipe_pipeline.h:65

mpipe_bin.h
Bin: an element that contains other elements.

mpipe_message.h
Bus message: what an element reports to the application.

mpipe_thread.h
Simple wrapper of k_thread to reuse a thread's stack after its termination.

net_buf.h
Buffer management.

stdint.h

uint32_t
__UINT32_TYPE__ uint32_t
Definition stdint.h:90

uint8_t
__UINT8_TYPE__ uint8_t
Definition stdint.h:88

mpipe_bin
Bin structure.
Definition mpipe_bin.h:54

mpipe_pad
Pad structure.
Definition mpipe_pad.h:128

mpipe_thread
Simple wrapper around k_thread.
Definition mpipe_thread.h:54

mpipe
A pipeline: the top-level bin that runs a graph.
Definition mpipe_pipeline.h:75

mpipe::thread
struct mpipe_thread thread
Thread associated with the pipeline.
Definition mpipe_pipeline.h:79

mpipe::eos_count
atomic_t eos_count
Number of EOS messages seen so far during the current run.
Definition mpipe_pipeline.h:83

mpipe::bin
struct mpipe_bin bin
Base bin container.
Definition mpipe_pipeline.h:77

mpipe::num_sinks
uint32_t num_sinks
Number of sink elements in the pipeline (computed on READY->PAUSED).
Definition mpipe_pipeline.h:81

net_buf
Network buffer representation.
Definition net_buf.h:1054

atomic.h
Header file for the Atomic operations API.

zbus.h