mirror of
https://github.com/torvalds/linux.git
synced 2025-11-04 10:40:15 +02:00
53e0c72d98
Define an IPC ABI for all host <--> DSP communication. This ABI should be transport agnostic. i.e. it should work on MMIO and SPI/I2C style interfaces. Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com> Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> Reviewed-by: Takashi Iwai <tiwai@suse.de> Signed-off-by: Mark Brown <broonie@kernel.org>
118 lines
2.9 KiB
C
118 lines
2.9 KiB
C
/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) */
|
|
/*
|
|
* This file is provided under a dual BSD/GPLv2 license. When using or
|
|
* redistributing this file, you may do so under either license.
|
|
*
|
|
* Copyright(c) 2018 Intel Corporation. All rights reserved.
|
|
*/
|
|
|
|
#ifndef __INCLUDE_SOUND_SOF_INFO_H__
|
|
#define __INCLUDE_SOUND_SOF_INFO_H__
|
|
|
|
#include <sound/sof/header.h>
|
|
#include <sound/sof/stream.h>
|
|
|
|
/*
|
|
* Firmware boot and version
|
|
*/
|
|
|
|
#define SOF_IPC_MAX_ELEMS 16
|
|
|
|
/* extended data types that can be appended onto end of sof_ipc_fw_ready */
|
|
enum sof_ipc_ext_data {
|
|
SOF_IPC_EXT_DMA_BUFFER = 0,
|
|
SOF_IPC_EXT_WINDOW,
|
|
};
|
|
|
|
/* FW version - SOF_IPC_GLB_VERSION */
|
|
struct sof_ipc_fw_version {
|
|
struct sof_ipc_hdr hdr;
|
|
uint16_t major;
|
|
uint16_t minor;
|
|
uint16_t micro;
|
|
uint16_t build;
|
|
uint8_t date[12];
|
|
uint8_t time[10];
|
|
uint8_t tag[6];
|
|
uint32_t abi_version;
|
|
|
|
/* reserved for future use */
|
|
uint32_t reserved[4];
|
|
} __packed;
|
|
|
|
/* FW ready Message - sent by firmware when boot has completed */
|
|
struct sof_ipc_fw_ready {
|
|
struct sof_ipc_cmd_hdr hdr;
|
|
uint32_t dspbox_offset; /* dsp initiated IPC mailbox */
|
|
uint32_t hostbox_offset; /* host initiated IPC mailbox */
|
|
uint32_t dspbox_size;
|
|
uint32_t hostbox_size;
|
|
struct sof_ipc_fw_version version;
|
|
|
|
/* Miscellaneous debug flags showing build/debug features enabled */
|
|
union {
|
|
uint64_t reserved;
|
|
struct {
|
|
uint64_t build:1;
|
|
uint64_t locks:1;
|
|
uint64_t locks_verbose:1;
|
|
uint64_t gdb:1;
|
|
} bits;
|
|
} debug;
|
|
|
|
/* reserved for future use */
|
|
uint32_t reserved[4];
|
|
} __packed;
|
|
|
|
/*
|
|
* Extended Firmware data. All optional, depends on platform/arch.
|
|
*/
|
|
enum sof_ipc_region {
|
|
SOF_IPC_REGION_DOWNBOX = 0,
|
|
SOF_IPC_REGION_UPBOX,
|
|
SOF_IPC_REGION_TRACE,
|
|
SOF_IPC_REGION_DEBUG,
|
|
SOF_IPC_REGION_STREAM,
|
|
SOF_IPC_REGION_REGS,
|
|
SOF_IPC_REGION_EXCEPTION,
|
|
};
|
|
|
|
struct sof_ipc_ext_data_hdr {
|
|
struct sof_ipc_cmd_hdr hdr;
|
|
uint32_t type; /**< SOF_IPC_EXT_ */
|
|
} __packed;
|
|
|
|
struct sof_ipc_dma_buffer_elem {
|
|
struct sof_ipc_hdr hdr;
|
|
uint32_t type; /**< SOF_IPC_REGION_ */
|
|
uint32_t id; /**< platform specific - used to map to host memory */
|
|
struct sof_ipc_host_buffer buffer;
|
|
} __packed;
|
|
|
|
/* extended data DMA buffers for IPC, trace and debug */
|
|
struct sof_ipc_dma_buffer_data {
|
|
struct sof_ipc_ext_data_hdr ext_hdr;
|
|
uint32_t num_buffers;
|
|
|
|
/* host files in buffer[n].buffer */
|
|
struct sof_ipc_dma_buffer_elem buffer[];
|
|
} __packed;
|
|
|
|
struct sof_ipc_window_elem {
|
|
struct sof_ipc_hdr hdr;
|
|
uint32_t type; /**< SOF_IPC_REGION_ */
|
|
uint32_t id; /**< platform specific - used to map to host memory */
|
|
uint32_t flags; /**< R, W, RW, etc - to define */
|
|
uint32_t size; /**< size of region in bytes */
|
|
/* offset in window region as windows can be partitioned */
|
|
uint32_t offset;
|
|
} __packed;
|
|
|
|
/* extended data memory windows for IPC, trace and debug */
|
|
struct sof_ipc_window {
|
|
struct sof_ipc_ext_data_hdr ext_hdr;
|
|
uint32_t num_windows;
|
|
struct sof_ipc_window_elem window[];
|
|
} __packed;
|
|
|
|
#endif
|