component_ext.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2016 Intel Corporation. All rights reserved.
 *
 * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
 *         Keyon Jie <yang.jie@linux.intel.com>
 */
 
#ifndef __SOF_AUDIO_COMPONENT_INT_H__
#define __SOF_AUDIO_COMPONENT_INT_H__
 
#include <sof/audio/component.h>
#include <ipc/topology.h>
/* TODO: the cross-core helpers below send IDC messages, which is kernel only */
#include <rtos/idc.h>
#include <sof/lib/dai.h>
#include <sof/schedule/schedule.h>
 
struct comp_driver_list {
    struct list_item list;  
};
 
#define comp_buffer_list(comp, dir) \
    ((dir) == PPL_DIR_DOWNSTREAM ? &(comp)->bsink_list :    \
     &(comp)->bsource_list)
 
#if CONFIG_IPC_MAJOR_3
struct comp_dev *comp_new(struct sof_ipc_comp *comp);
#elif CONFIG_IPC_MAJOR_4
struct comp_dev *comp_new_ipc4(const struct ipc4_module_init_instance *module_init);
#endif
 
static inline void comp_free(struct comp_dev *dev)
{
    const struct comp_driver *drv = dev->drv;
 
    assert(drv->ops.free);
 
    /*
     * In DP case this will run in DP thread context, so the task can only
     * be freed after this.
     */
    drv->ops.free(dev);
}
 
static inline int comp_params_remote(struct comp_dev *dev,
                     struct sof_ipc_stream_params *params)
{
    struct idc_msg msg = { IDC_MSG_PARAMS, IDC_MSG_PARAMS_EXT(dev->ipc_config.id),
        dev->ipc_config.core, sizeof(*params), params, };
 
    return idc_send_msg(&msg, IDC_BLOCKING);
}
 
static inline int comp_params(struct comp_dev *dev,
                  struct sof_ipc_stream_params *params)
{
    int ret = 0;
 
    if (dev->is_shared && !cpu_is_me(dev->ipc_config.core)) {
        ret = comp_params_remote(dev, params);
    } else {
        if (dev->drv->ops.params) {
            ret = dev->drv->ops.params(dev, params);
        } else {
            /* not defined, run the default handler */
            ret = comp_verify_params(dev, 0, params);
 
/* BugLink: https://github.com/zephyrproject-rtos/zephyr/issues/43786
 * TODO: Remove this once the bug gets fixed.
 */
#ifndef __ZEPHYR__
            if (ret < 0)
                comp_err(dev, "pcm params verification failed");
#endif
        }
    }
 
    return ret;
}
 
static inline int comp_dai_get_hw_params(struct comp_dev *dev,
                     struct sof_ipc_stream_params *params,
                     int dir)
{
    if (dev->drv->ops.dai_get_hw_params)
        return dev->drv->ops.dai_get_hw_params(dev, params, dir);
 
    return -EINVAL;
}
 
#if CONFIG_IPC_MAJOR_3
static inline int comp_cmd(struct comp_dev *dev, int cmd, void *data,
               int max_data_size)
{
    LOG_MODULE_DECLARE(component, CONFIG_SOF_LOG_LEVEL);
 
    struct sof_ipc_ctrl_data *cdata = ASSUME_ALIGNED(data, 4);
 
    if (cmd == COMP_CMD_SET_DATA &&
        (cdata->data->magic != SOF_ABI_MAGIC ||
         SOF_ABI_VERSION_INCOMPATIBLE(SOF_ABI_VERSION, cdata->data->abi))) {
        comp_err(dev, "comp_cmd(): invalid version, data->magic = %u, data->abi = %u",
             cdata->data->magic, cdata->data->abi);
        return -EINVAL;
    }
 
    if (dev->drv->ops.cmd)
        return dev->drv->ops.cmd(dev, cmd, data, max_data_size);
 
    return -EINVAL;
}
#endif
 
static inline int comp_trigger_remote(struct comp_dev *dev, int cmd)
{
    struct idc_msg msg = { IDC_MSG_TRIGGER,
        IDC_MSG_TRIGGER_EXT(dev->ipc_config.id), dev->ipc_config.core, sizeof(cmd),
        &cmd, };
 
    return idc_send_msg(&msg, IDC_BLOCKING);
}
 
static inline int comp_trigger_local(struct comp_dev *dev, int cmd)
{
    int ret;
 
    ret = dev->drv->ops.trigger(dev, cmd);
    if (ret)
        return ret;
 
    /* start a thread in case of shared component or DP scheduling */
    if (dev->task) {
        /* schedule or cancel task */
        switch (cmd) {
        case COMP_TRIGGER_START:
            ret = schedule_task(dev->task, 0, dev->period);
            break;
        case COMP_TRIGGER_RELEASE:
        case COMP_TRIGGER_XRUN:
        case COMP_TRIGGER_PAUSE:
        case COMP_TRIGGER_STOP:
            break;
        }
    }
 
    return ret;
}
 
static inline int comp_trigger(struct comp_dev *dev, int cmd)
{
    int ret;
    assert(dev->drv->ops.trigger);
 
    if (dev->is_shared && !cpu_is_me(dev->ipc_config.core))
        ret = comp_trigger_remote(dev, cmd);
    else
        ret = comp_trigger_local(dev, cmd);
 
    return ret;
}
 
static inline int comp_prepare_remote(struct comp_dev *dev)
{
    struct idc_msg msg = { IDC_MSG_PREPARE,
        IDC_MSG_PREPARE_EXT(dev->ipc_config.id), dev->ipc_config.core, };
 
    return idc_send_msg(&msg, IDC_BLOCKING);
}
 
static inline int comp_prepare(struct comp_dev *dev)
{
    if (dev->drv->ops.prepare)
        return (dev->is_shared && !cpu_is_me(dev->ipc_config.core)) ?
            comp_prepare_remote(dev) : dev->drv->ops.prepare(dev);
 
    return 0;
}
 
int comp_copy(struct comp_dev *dev);
 
#if CONFIG_IPC_MAJOR_4
struct get_attribute_remote_payload {
    uint32_t type; 
    void *value;   
};
 
static inline int comp_ipc4_get_attribute_remote(struct comp_dev *dev, uint32_t type,
                         void *value)
{
    struct ipc4_base_module_cfg *base_cfg;
    struct get_attribute_remote_payload payload = {};
    struct idc_msg msg = { IDC_MSG_GET_ATTRIBUTE,
        IDC_EXTENSION(dev->ipc_config.id), dev->ipc_config.core,
        sizeof(payload), &payload};
    int ret;
 
    /* Only COMP_ATTR_BASE_CONFIG is supported for remote access */
    if (type != COMP_ATTR_BASE_CONFIG)
        return -EINVAL;
 
    base_cfg = rzalloc(SOF_MEM_FLAG_USER | SOF_MEM_FLAG_COHERENT, sizeof(*base_cfg));
    if (!base_cfg)
        return -ENOMEM;
 
    payload.type = type;
    payload.value = base_cfg;
 
    ret = idc_send_msg(&msg, IDC_BLOCKING);
 
    if (ret == 0)
        memcpy_s(value, sizeof(struct ipc4_base_module_cfg),
             base_cfg, sizeof(struct ipc4_base_module_cfg));
 
    rfree(base_cfg);
    return ret;
}
#endif  /* CONFIG_IPC_MAJOR_4 */
 
static inline int comp_get_attribute(struct comp_dev *dev, uint32_t type,
                     void *value)
{
#if CONFIG_IPC_MAJOR_4
    if (dev->drv->ops.get_attribute)
        return cpu_is_me(dev->ipc_config.core) ?
            dev->drv->ops.get_attribute(dev, type, value) :
            comp_ipc4_get_attribute_remote(dev, type, value);
 
    return 0;
#else
    if (dev->drv->ops.get_attribute)
        return dev->drv->ops.get_attribute(dev, type, value);
 
    return 0;
#endif
}
 
static inline int comp_set_attribute(struct comp_dev *dev, uint32_t type,
                     void *value)
{
    if (dev->drv->ops.set_attribute)
        return dev->drv->ops.set_attribute(dev, type, value);
 
    return 0;
}
 
static inline int comp_reset_remote(struct comp_dev *dev)
{
    struct idc_msg msg = { IDC_MSG_RESET,
        IDC_MSG_RESET_EXT(dev->ipc_config.id), dev->ipc_config.core, };
 
    return idc_send_msg(&msg, IDC_BLOCKING);
}
 
static inline int comp_reset(struct comp_dev *dev)
{
    if (dev->drv->ops.reset)
        return (dev->is_shared && !cpu_is_me(dev->ipc_config.core)) ?
            comp_reset_remote(dev) : dev->drv->ops.reset(dev);
 
    return 0;
}
 
#if CONFIG_IPC_MAJOR_3
static inline int comp_dai_config(struct comp_dev *dev, struct ipc_config_dai *config,
                  const void *spec_config)
{
    struct dai_data *dd = comp_get_drvdata(dev);
 
    if (dev->drv->ops.dai_config)
        return dev->drv->ops.dai_config(dd, dev, config, spec_config);
 
    return 0;
}
#elif CONFIG_IPC_MAJOR_4
static inline int comp_dai_config(struct dai_data *dd, struct comp_dev *dev,
                  struct ipc_config_dai *config, const void *spec_config)
{
    return dai_config(dd, dev, config, spec_config);
}
#else
#error Unknown IPC major version
#endif
 
static inline int comp_position(struct comp_dev *dev,
                struct sof_ipc_stream_posn *posn)
{
    if (dev->drv->ops.position)
        return dev->drv->ops.position(dev, posn);
 
    return 0;
}
 
void sys_comp_init(struct sof *sof);
 
static inline int comp_is_single_pipeline(struct comp_dev *current,
                      struct comp_dev *previous)
{
    return dev_comp_pipe_id(current) == dev_comp_pipe_id(previous);
}
 
static inline int comp_is_active(struct comp_dev *current)
{
    return current->state == COMP_STATE_ACTIVE;
}
 
static inline int comp_get_requested_state(int cmd)
{
    int state = COMP_STATE_INIT;
 
    switch (cmd) {
    case COMP_TRIGGER_START:
    case COMP_TRIGGER_RELEASE:
        state = COMP_STATE_ACTIVE;
        break;
    case COMP_TRIGGER_PREPARE:
    case COMP_TRIGGER_STOP:
        state = COMP_STATE_PREPARE;
        break;
    case COMP_TRIGGER_PAUSE:
        state = COMP_STATE_PAUSED;
        break;
    case COMP_TRIGGER_XRUN:
    case COMP_TRIGGER_RESET:
        state = COMP_STATE_READY;
        break;
    case COMP_TRIGGER_PRE_START:
    case COMP_TRIGGER_PRE_RELEASE:
        state = COMP_STATE_PRE_ACTIVE;
        break;
    }
 
    return state;
}
 
static inline int comp_get_endpoint_type(struct comp_dev *dev)
{
    switch (dev_comp_type(dev)) {
    case SOF_COMP_HOST:
        return COMP_ENDPOINT_HOST;
    case SOF_COMP_DAI:
        return COMP_ENDPOINT_DAI;
    default:
        return COMP_ENDPOINT_NODE;
    }
}
 
static inline bool comp_is_scheduling_source(struct comp_dev *dev)
{
    return dev == dev->pipeline->sched_comp;
}
 
static inline void comp_make_shared(struct comp_dev *dev)
{
    dev->is_shared = true;
}
 
#ifdef CONFIG_SOF_USERSPACE_LL
struct comp_driver_list *comp_drivers_get(void);
#else
static inline struct comp_driver_list *comp_drivers_get(void)
{
    return sof_get()->comp_drivers;
}
#endif
 
#if CONFIG_IPC_MAJOR_4
static inline int comp_ipc4_bind_remote(struct comp_dev *dev, const struct bind_info *bind_data)
{
    struct idc_msg msg = { IDC_MSG_BIND,
        IDC_EXTENSION(dev->ipc_config.id), dev->ipc_config.core,
        sizeof(*bind_data), bind_data};
 
    return idc_send_msg(&msg, IDC_BLOCKING);
}
#endif
 
static inline int comp_bind(struct comp_dev *dev, const struct bind_info *bind_data)
{
#if CONFIG_IPC_MAJOR_4
    if (dev->drv->ops.bind)
        return cpu_is_me(dev->ipc_config.core) ?
            dev->drv->ops.bind(dev, bind_data) : comp_ipc4_bind_remote(dev, bind_data);
 
    return 0;
#else
    int ret = 0;
 
    if (dev->drv->ops.bind)
        ret = dev->drv->ops.bind(dev, bind_data);
 
    return ret;
#endif
}
 
#if CONFIG_IPC_MAJOR_4
static inline int comp_ipc4_unbind_remote(struct comp_dev *dev, const struct bind_info *unbind_data)
{
    struct idc_msg msg = { IDC_MSG_UNBIND,
        IDC_EXTENSION(dev->ipc_config.id), dev->ipc_config.core,
        sizeof(*unbind_data), unbind_data};
 
    return idc_send_msg(&msg, IDC_BLOCKING);
}
#endif
 
static inline int comp_unbind(struct comp_dev *dev, const struct bind_info *unbind_data)
{
#if CONFIG_IPC_MAJOR_4
    if (dev->drv->ops.unbind)
        return cpu_is_me(dev->ipc_config.core) ?
            dev->drv->ops.unbind(dev, unbind_data) :
            comp_ipc4_unbind_remote(dev, unbind_data);
 
    return 0;
#else
    int ret = 0;
 
    if (dev->drv->ops.unbind)
        ret = dev->drv->ops.unbind(dev, unbind_data);
 
    return ret;
#endif
}
 
static inline uint64_t comp_get_total_data_processed(struct comp_dev *dev, uint32_t stream_no,
                             bool input)
{
    uint64_t ret = 0;
 
    if (dev->drv->ops.get_total_data_processed)
        ret = dev->drv->ops.get_total_data_processed(dev, stream_no, input);
 
    return ret;
}
 
static inline bool comp_same_dir(struct comp_dev *comp, enum sof_ipc_stream_direction dir)
{
    int end_type = comp_get_endpoint_type(comp->pipeline->sink_comp);
 
    if (dir == SOF_IPC_STREAM_PLAYBACK && end_type != COMP_ENDPOINT_DAI)
        return false;
    if (dir == SOF_IPC_STREAM_CAPTURE && end_type != COMP_ENDPOINT_HOST)
        return false;
    return true;
}
 
#endif /* __SOF_AUDIO_COMPONENT_INT_H__ */