mpipe_player Struct Reference

Player instance. More...

#include <mpipe_player.h>

Data Fields
struct mpipe *	pipeline
	Controlled pipeline.
struct k_msgq	cmd_q
	Command queue feeding the worker thread.
char	cmd_buf [CONFIG_MPIPE_PLAYER_CMD_QUEUE_DEPTH *sizeof(struct mpipe_player_cmd_msg)]
	Backing buffer for the command queue.
uint8_t	run_id
	Run counter, bumped by the worker each time a run starts.
struct mpipe_message	last_error
	Last error the bus listener saw, reported by the worker.
struct k_thread	worker
	Worker thread control block.
struct k_sem	exited
	Signaled by the worker just before it exits.

Detailed Description

Player instance.

All fields are for internal use; treat the struct as opaque and only pass a pointer to the mpipe_player_*() API.

Field Documentation

cmd_buf

char mpipe_player::cmd_buf[CONFIG_MPIPE_PLAYER_CMD_QUEUE_DEPTH *sizeof(struct mpipe_player_cmd_msg)]

Backing buffer for the command queue.

cmd_q

struct k_msgq mpipe_player::cmd_q

Command queue feeding the worker thread.

exited

struct k_sem mpipe_player::exited

Signaled by the worker just before it exits.

last_error

struct mpipe_message mpipe_player::last_error

Last error the bus listener saw, reported by the worker.

pipeline

struct mpipe* mpipe_player::pipeline

Controlled pipeline.

run_id

uint8_t mpipe_player::run_id

Run counter, bumped by the worker each time a run starts.

worker

struct k_thread mpipe_player::worker

Worker thread control block.

---

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

• include/zephyr/mpipe/utils/mpipe_player.h