interface.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause */
/*
 * Copyright(c) 2020 - 2023 Intel Corporation. All rights reserved.
 *
 * Author: Jaroslaw Stelter <jaroslaw.stelter@intel.com>
 *     Adrian Warecki <adrian.warecki@intel.com>
 */
 
#ifndef __MODULE_MODULE_INTERFACE__
#define __MODULE_MODULE_INTERFACE__
 
#include <stdint.h>
#include <stdbool.h>
 
enum module_cfg_fragment_position {
    MODULE_CFG_FRAGMENT_MIDDLE = 0,
    MODULE_CFG_FRAGMENT_FIRST,
    MODULE_CFG_FRAGMENT_LAST,
    MODULE_CFG_FRAGMENT_SINGLE,
};
 
enum module_processing_mode {
    MODULE_PROCESSING_NORMAL = 0,
    MODULE_PROCESSING_BYPASS,
};
 
struct input_stream_buffer {
    void *data; /* data stream buffer */
    uint32_t size; /* size of data in the buffer */
    uint32_t consumed; /* number of bytes consumed by the module */
 
    /* Indicates end of stream condition has occurred on the input stream */
    bool end_of_stream;
};
 
struct output_stream_buffer {
    void *data; /* data stream buffer */
    uint32_t size; /* size of data in the buffer */
};
 
struct processing_module;
struct sof_source;
struct sof_sink;
struct bind_info;
struct bind_info;
 
/*
 * This structure may be used by modules to carry short 16bit parameters.
 */
union config_param_id_data {
    uint32_t dw;
    struct {
        uint32_t data16 : 16;   /* Input/Output small config data */
        uint32_t id : 14;   /* input parameter ID */
        uint32_t _rsvd  : 2;
    } f;
};
 
struct module_interface {
    int (*init)(struct processing_module *mod);
 
    int (*prepare)(struct processing_module *mod,
               struct sof_source **sources, int num_of_sources,
               struct sof_sink **sinks, int num_of_sinks);
 
    bool (*is_ready_to_process)(struct processing_module *mod,
                    struct sof_source **sources, int num_of_sources,
                    struct sof_sink **sinks, int num_of_sinks);
 
    int (*process)(struct processing_module *mod,
               struct sof_source **sources, int num_of_sources,
               struct sof_sink **sinks, int num_of_sinks);
 
    int (*process_audio_stream)(struct processing_module *mod,
                    struct input_stream_buffer *input_buffers,
                    int num_input_buffers,
                    struct output_stream_buffer *output_buffers,
                    int num_output_buffers);
 
    int (*process_raw_data)(struct processing_module *mod,
                struct input_stream_buffer *input_buffers,
                int num_input_buffers,
                struct output_stream_buffer *output_buffers,
                int num_output_buffers);
 
    int (*set_config_param)(struct processing_module *mod, uint32_t param_id_data);
 
    int (*get_config_param)(struct processing_module *mod, uint32_t *param_id_data);
 
    int (*set_configuration)(struct processing_module *mod,
                 uint32_t config_id,
                 enum module_cfg_fragment_position pos, uint32_t data_offset_size,
                 const uint8_t *fragment, size_t fragment_size, uint8_t *response,
                 size_t response_size);
 
    int (*get_configuration)(struct processing_module *mod,
                 uint32_t config_id, uint32_t *data_offset_size,
                 uint8_t *fragment, size_t fragment_size);
 
    int (*set_processing_mode)(struct processing_module *mod,
                   enum module_processing_mode mode);
 
    enum module_processing_mode (*get_processing_mode)(struct processing_module *mod);
 
    int (*reset)(struct processing_module *mod);
 
    int (*free)(struct processing_module *mod);
 
    int (*bind)(struct processing_module *mod, const struct bind_info *bind_data);
 
    int (*unbind)(struct processing_module *mod, const struct bind_info *unbind_data);
 
    int (*trigger)(struct processing_module *mod, int cmd);
 
    /*
     * Ops relevant only for the endpoint devices such as the host copier or DAI copier.
     * Other modules should not implement these.
     *
     * Below #ifdef is a temporary solution used until work on separating a common interface
     * for loadable modules is completed.
     */
#ifdef SOF_MODULE_API_PRIVATE
    const struct module_endpoint_ops *endpoint_ops;
#endif /* SOF_MODULE_PRIVATE */
};
 
#endif /* __MODULE_MODULE_INTERFACE__ */