topology.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_IPC_TOPOLOGY_H__
#define __SOF_IPC_TOPOLOGY_H__
 
#include <sof/audio/buffer.h>
#include <sof/audio/ipc-config.h>
#include <sof/audio/pipeline.h>
#include <rtos/alloc.h>
#include <sof/lib/memory.h>
#include <sof/list.h>
#include <sof/platform.h>
#include <rtos/task.h>
#include <rtos/sof.h>
#include <rtos/spinlock.h>
#include <sof/trace/trace.h>
#include <sof/ipc/common.h>
#include <stdbool.h>
#include <stdint.h>
 
/* generic IPC pipeline regardless of ABI MAJOR type that is always 4 byte aligned */
typedef uint32_t ipc_pipe_new;
typedef uint32_t ipc_pipe_comp_connect;
typedef uint32_t ipc_comp;
 
/*
 * Topology IPC logic uses standard types for abstract IPC features. This means all ABI MAJOR
 * abstraction is done in the IPC layer only and not in the surrounding infrastructure.
 */
#if CONFIG_IPC_MAJOR_3
#include <ipc/topology.h>
#define ipc_from_pipe_new(x) ((struct sof_ipc_pipe_new *)x)
#define ipc_from_pipe_connect(x) ((struct sof_ipc_pipe_comp_connect *)x)
#define ipc_from_comp_new(x) ((struct sof_ipc_comp *)x)
#define ipc_from_dai_config(x) ((struct sof_ipc_dai_config *)x)
#elif CONFIG_IPC_MAJOR_4
#include <ipc4/pipeline.h>
#include <ipc4/module.h>
#include <ipc4/gateway.h>
#define ipc_from_pipe_new(x) ((struct ipc4_pipeline_create *)x)
#define ipc_from_pipe_connect(x) ((struct ipc4_module_bind_unbind *)x)
 
struct ipc_comp_dev;
const struct comp_driver *ipc4_get_comp_drv(uint32_t module_id);
struct comp_dev *ipc4_get_comp_dev(uint32_t comp_id);
int ipc4_add_comp_dev(struct comp_dev *dev);
#ifdef CONFIG_SOF_USERSPACE_LL
struct ipc4_message_request;
struct comp_driver;
struct comp_dev *comp_new_ipc4_user(struct ipc4_message_request *ipc4,
                    const struct comp_driver *drv);
#endif
int ipc4_chain_manager_create(const struct ipc4_chain_dma *cdma);
int ipc4_chain_dma_state(struct comp_dev *dev, const struct ipc4_chain_dma *cdma);
int ipc4_create_chain_dma(struct ipc *ipc, struct ipc4_chain_dma *cdma);
int ipc4_trigger_chain_dma(struct ipc *ipc, struct ipc4_chain_dma *cdma, bool *delay);
int ipc4_process_on_core(uint32_t core, bool blocking);
int ipc4_pipeline_complete(struct ipc *ipc, uint32_t comp_id, uint32_t cmd);
int ipc4_find_dma_config(struct ipc_config_dai *dai, uint8_t *data_buffer, uint32_t size);
int ipc4_find_all_dma_configs_tlvs_only(struct ipc_config_dai *dai,
                    uint8_t *data_buffer, size_t size);
int ipc4_pipeline_prepare(struct ipc_comp_dev *ppl_icd, uint32_t cmd);
int ipc4_pipeline_trigger(struct ipc_comp_dev *ppl_icd, uint32_t cmd, bool *delayed);
int ipc4_find_dma_config_multiple(struct ipc_config_dai *dai, uint8_t *data_buffer,
                  uint32_t size, uint32_t device_id, int dma_cfg_idx);
const struct ipc4_pipeline_set_state_data *ipc4_get_pipeline_data_wrapper(void);
 
#else
#error "No or invalid IPC MAJOR version selected."
#endif
 
#define ipc_to_pipe_new(x)  ((ipc_pipe_new *)x)
#define ipc_to_pipe_connect(x)  ((ipc_pipe_comp_connect *)x)
#define ipc_to_comp_new(x)  ((ipc_comp *)x)
 
struct ipc_msg;
 
#define COMP_TYPE_ANY       0
#define COMP_TYPE_COMPONENT 1
#define COMP_TYPE_BUFFER    2
#define COMP_TYPE_PIPELINE  3
 
#define IPC_COMP_ALL        0
#define IPC_COMP_IGNORE_REMOTE  1
 
/* IPC generic component device */
struct ipc_comp_dev {
    uint16_t type;  /* COMP_TYPE_ */
    uint16_t core;
    uint32_t id;
 
    /* component type data */
    union {
        struct comp_dev *cd;
        struct comp_buffer *cb;
        struct pipeline *pipeline;
    };
 
    /* lists */
    struct list_item list;      /* list in components */
};

int ipc_comp_new(struct ipc *ipc, ipc_comp *new);

int ipc_comp_free(struct ipc *ipc, uint32_t comp_id);

int ipc_buffer_new(struct ipc *ipc, const struct sof_ipc_buffer *buffer);

int ipc_buffer_free(struct ipc *ipc, uint32_t buffer_id);

int ipc_pipeline_new(struct ipc *ipc, ipc_pipe_new *pipeline);

int ipc_pipeline_free(struct ipc *ipc, uint32_t comp_id);

int ipc_pipeline_complete(struct ipc *ipc, uint32_t comp_id);

int ipc_comp_connect(struct ipc *ipc, ipc_pipe_comp_connect *connect);

int ipc_comp_disconnect(struct ipc *ipc, ipc_pipe_comp_connect *connect);

struct ipc_comp_dev *ipc_get_comp_dev(struct ipc *ipc, uint16_t type, uint32_t id);

struct ipc_comp_dev *ipc_get_comp_by_ppl_id(struct ipc *ipc, uint16_t type,
                        uint32_t ppl_id, uint32_t ignore_remote);
struct ipc_comp_dev *ipc_get_ppl_comp(struct ipc *ipc,
                      uint32_t pipeline_id, int dir);

int32_t ipc_comp_pipe_id(const struct ipc_comp_dev *icd);

int ipc_comp_dai_config(struct ipc *ipc, struct ipc_config_dai *common_config,
            void *spec_config);
 
/*
 * Warning: duplicate declaration in component.h
 */
int comp_verify_params(struct comp_dev *dev, uint32_t flag,
               struct sof_ipc_stream_params *params);

int comp_buffer_connect(struct comp_dev *comp, uint32_t comp_core,
            struct comp_buffer *buffer, uint32_t dir);
 
#define ipc_get_comp_by_id(ipc, comp_id) ipc_get_comp_dev(ipc, COMP_TYPE_COMPONENT, comp_id)
#define ipc_get_pipeline_by_id(ipc, ppln_id) ipc_get_comp_dev(ipc, COMP_TYPE_PIPELINE, ppln_id)
#define ipc_get_buffer_by_id(ipc, buf_id) ipc_get_comp_dev(ipc, COMP_TYPE_BUFFER, buf_id)
 
#endif