include/sound/sof/info.h

   1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
   2 /*
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * Copyright(c) 2018 Intel Corporation. All rights reserved.
   7  */
   8
   9 #ifndef __INCLUDE_SOUND_SOF_INFO_H__
  10 #define __INCLUDE_SOUND_SOF_INFO_H__
  11
  12 #include <sound/sof/header.h>
  13 #include <sound/sof/stream.h>
  14
  15 /*
  16  * Firmware boot and version
  17  */
  18
  19 #define SOF_IPC_MAX_ELEMS       16
  20
  21 /*
  22  * Firmware boot info flag bits (64-bit)
  23  */
  24 #define SOF_IPC_INFO_BUILD              BIT(0)
  25 #define SOF_IPC_INFO_LOCKS              BIT(1)
  26 #define SOF_IPC_INFO_LOCKSV             BIT(2)
  27 #define SOF_IPC_INFO_GDB                BIT(3)
  28
  29 /* extended data types that can be appended onto end of sof_ipc_fw_ready */
  30 enum sof_ipc_ext_data {
  31         SOF_IPC_EXT_DMA_BUFFER = 0,
  32         SOF_IPC_EXT_WINDOW,
  33 };
  34
  35 /* FW version - SOF_IPC_GLB_VERSION */
  36 struct sof_ipc_fw_version {
  37         struct sof_ipc_hdr hdr;
  38         uint16_t major;
  39         uint16_t minor;
  40         uint16_t micro;
  41         uint16_t build;
  42         uint8_t date[12];
  43         uint8_t time[10];
  44         uint8_t tag[6];
  45         uint32_t abi_version;
  46
  47         /* reserved for future use */
  48         uint32_t reserved[4];
  49 } __packed;
  50
  51 /* FW ready Message - sent by firmware when boot has completed */
  52 struct sof_ipc_fw_ready {
  53         struct sof_ipc_cmd_hdr hdr;
  54         uint32_t dspbox_offset;  /* dsp initiated IPC mailbox */
  55         uint32_t hostbox_offset; /* host initiated IPC mailbox */
  56         uint32_t dspbox_size;
  57         uint32_t hostbox_size;
  58         struct sof_ipc_fw_version version;
  59
  60         /* Miscellaneous flags */
  61         uint64_t flags;
  62
  63         /* reserved for future use */
  64         uint32_t reserved[4];
  65 } __packed;
  66
  67 /*
  68  * Extended Firmware data. All optional, depends on platform/arch.
  69  */
  70 enum sof_ipc_region {
  71         SOF_IPC_REGION_DOWNBOX  = 0,
  72         SOF_IPC_REGION_UPBOX,
  73         SOF_IPC_REGION_TRACE,
  74         SOF_IPC_REGION_DEBUG,
  75         SOF_IPC_REGION_STREAM,
  76         SOF_IPC_REGION_REGS,
  77         SOF_IPC_REGION_EXCEPTION,
  78 };
  79
  80 struct sof_ipc_ext_data_hdr {
  81         struct sof_ipc_cmd_hdr hdr;
  82         uint32_t type;          /**< SOF_IPC_EXT_ */
  83 } __packed;
  84
  85 struct sof_ipc_dma_buffer_elem {
  86         struct sof_ipc_hdr hdr;
  87         uint32_t type;          /**< SOF_IPC_REGION_ */
  88         uint32_t id;            /**< platform specific - used to map to host memory */
  89         struct sof_ipc_host_buffer buffer;
  90 } __packed;
  91
  92 /* extended data DMA buffers for IPC, trace and debug */
  93 struct sof_ipc_dma_buffer_data {
  94         struct sof_ipc_ext_data_hdr ext_hdr;
  95         uint32_t num_buffers;
  96
  97         /* host files in buffer[n].buffer */
  98         struct sof_ipc_dma_buffer_elem buffer[];
  99 }  __packed;
 100
 101 struct sof_ipc_window_elem {
 102         struct sof_ipc_hdr hdr;
 103         uint32_t type;          /**< SOF_IPC_REGION_ */
 104         uint32_t id;            /**< platform specific - used to map to host memory */
 105         uint32_t flags;         /**< R, W, RW, etc - to define */
 106         uint32_t size;          /**< size of region in bytes */
 107         /* offset in window region as windows can be partitioned */
 108         uint32_t offset;
 109 } __packed;
 110
 111 /* extended data memory windows for IPC, trace and debug */
 112 struct sof_ipc_window {
 113         struct sof_ipc_ext_data_hdr ext_hdr;
 114         uint32_t num_windows;
 115         struct sof_ipc_window_elem window[];
 116 }  __packed;
 117
 118 #endif