mpipe_pad.h

Go to the documentation of this file.

/*
 * Copyright 2025-2026 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_MPIPE_MPIPE_PAD_H_
#define ZEPHYR_INCLUDE_MPIPE_MPIPE_PAD_H_

 
#include <stdbool.h>
#include <stdint.h>
 
#include <zephyr/sys/atomic.h>
#include <zephyr/sys/util.h>
 
#include <zephyr/kernel.h>
 
#include <zephyr/mpipe/mpipe_buffer.h>
#include <zephyr/mpipe/mpipe_structure.h>
#include <zephyr/mpipe/mpipe_object.h>
 
struct mpipe_dispatch;

enum mpipe_pad_direction {
        MPIPE_PAD_UNKNOWN,
        MPIPE_PAD_SRC,
        MPIPE_PAD_SINK
};

enum mpipe_pad_mode {
        MPIPE_PAD_MODE_NONE,
        MPIPE_PAD_MODE_PUSH,
        MPIPE_PAD_MODE_PULL
};

enum mpipe_pad_presence {
        MPIPE_PAD_ALWAYS,
        MPIPE_PAD_SOMETIMES,
        MPIPE_PAD_REQUEST
};

struct mpipe_pad {
        struct mpipe_object object;
        enum mpipe_pad_direction direction;
        enum mpipe_pad_presence presence;
        enum mpipe_pad_mode mode;
        struct mpipe_pad *peer;
        struct mpipe_structure caps;
        atomic_t flushing;

        int (*chain_fn)(struct mpipe_pad *pad, struct net_buf *in_buf, struct net_buf **out_buf);
        int (*query_fn)(struct mpipe_pad *pad, struct mpipe_dispatch *query);
        int (*event_fn)(struct mpipe_pad *pad, struct mpipe_dispatch *event);
        int (*enum_caps_fn)(struct mpipe_pad *pad, uint32_t index,
                            const struct mpipe_structure *filter, struct mpipe_structure *out);
};

int mpipe_pad_enum_caps(struct mpipe_pad *pad, uint32_t index, const struct mpipe_structure *filter,
                        struct mpipe_structure *out);

int mpipe_pad_enum_first(struct mpipe_pad *pad, const struct mpipe_structure *filter,
                         struct mpipe_structure *out);

int mpipe_pad_answer_caps_query(struct mpipe_pad *pad, struct mpipe_dispatch *query);

int mpipe_pad_enum_filter(const struct mpipe_structure *candidate,
                          const struct mpipe_structure *filter, struct mpipe_structure *out);

void mpipe_pad_init(struct mpipe_pad *pad, uint8_t id, enum mpipe_pad_direction direction,
                    enum mpipe_pad_presence presence);

int mpipe_pad_set_caps(struct mpipe_pad *pad, const struct mpipe_structure *caps);

int mpipe_pad_link(struct mpipe_pad *src_pad, struct mpipe_pad *sink_pad);

int mpipe_pad_send_event(struct mpipe_pad *pad, struct mpipe_dispatch *event);

int mpipe_pad_send_event_default(struct mpipe_pad *pad, struct mpipe_dispatch *event);

int mpipe_pad_query(struct mpipe_pad *pad, struct mpipe_dispatch *query);

 
#endif /* ZEPHYR_INCLUDE_MPIPE_MPIPE_PAD_H_ */