module_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>
 */
 
#ifndef __SOF_MODULE_INTERFACE__
#define __SOF_MODULE_INTERFACE__
 
#include <sof/compiler_attributes.h>
#include <sof/audio/sink_api.h>
#include <sof/audio/source_api.h>
 
/*
 * Definition used to extend structure definitions to include fields for exclusive use by SOF.
 * This is a temporary solution used until work on separating a common interface for loadable
 * modules is completed.
 */
#define SOF_MODULE_API_PRIVATE
 
#include <module/module/interface.h>
 
struct comp_dev;
struct timestamp_data;
struct dai_ts_data;
struct sof_ipc_stream_posn;
 
struct module_endpoint_ops {
    uint64_t (*get_total_data_processed)(struct comp_dev *dev, uint32_t stream_no, bool input);
    int (*position)(struct comp_dev *dev, struct sof_ipc_stream_posn *posn);
    int (*dai_ts_config)(struct comp_dev *dev);
 
    int (*dai_ts_start)(struct comp_dev *dev);
 
    int (*dai_ts_stop)(struct comp_dev *dev);
 
#if CONFIG_ZEPHYR_NATIVE_DRIVERS
    int (*dai_ts_get)(struct comp_dev *dev, struct dai_ts_data *tsd);
#else
    int (*dai_ts_get)(struct comp_dev *dev, struct timestamp_data *tsd);
#endif
 
    int (*dai_get_hw_params)(struct comp_dev *dev,
                 struct sof_ipc_stream_params *params, int dir);
 
    int (*trigger)(struct comp_dev *dev, int cmd);
};
 
/* Convert first_block/last_block indicator to fragment position */
static inline enum module_cfg_fragment_position
first_last_block_to_frag_pos(bool first_block, bool last_block)
{
    int frag_position = (last_block << 1) | first_block;
 
    return (enum module_cfg_fragment_position)frag_position;
}
 
#endif /* __SOF_MODULE_INTERFACE__ */