| .. | .. |
|---|
| 1 | +/* SPDX-License-Identifier: GPL-2.0-only */ |
|---|
| 1 | 2 | /* |
|---|
| 2 | 3 | * Intel Smart Sound Technology (SST) Core |
|---|
| 3 | 4 | * |
|---|
| 4 | 5 | * Copyright (C) 2013, Intel Corporation. All rights reserved. |
|---|
| 5 | | - * |
|---|
| 6 | | - * This program is free software; you can redistribute it and/or |
|---|
| 7 | | - * modify it under the terms of the GNU General Public License version |
|---|
| 8 | | - * 2 as published by the Free Software Foundation. |
|---|
| 9 | | - * |
|---|
| 10 | | - * This program is distributed in the hope that it will be useful, |
|---|
| 11 | | - * but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 12 | | - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 13 | | - * GNU General Public License for more details. |
|---|
| 14 | | - * |
|---|
| 15 | 6 | */ |
|---|
| 16 | 7 | |
|---|
| 17 | 8 | #ifndef __SOUND_SOC_SST_DSP_H |
|---|
| .. | .. |
|---|
| 20 | 11 | #include <linux/kernel.h> |
|---|
| 21 | 12 | #include <linux/types.h> |
|---|
| 22 | 13 | #include <linux/interrupt.h> |
|---|
| 23 | | - |
|---|
| 24 | | -/* SST Device IDs */ |
|---|
| 25 | | -#define SST_DEV_ID_LYNX_POINT 0x33C8 |
|---|
| 26 | | -#define SST_DEV_ID_WILDCAT_POINT 0x3438 |
|---|
| 27 | | -#define SST_DEV_ID_BYT 0x0F28 |
|---|
| 28 | | - |
|---|
| 29 | | -/* Supported SST DMA Devices */ |
|---|
| 30 | | -#define SST_DMA_TYPE_DW 1 |
|---|
| 31 | | - |
|---|
| 32 | | -/* autosuspend delay 5s*/ |
|---|
| 33 | | -#define SST_RUNTIME_SUSPEND_DELAY (5 * 1000) |
|---|
| 34 | | - |
|---|
| 35 | | -/* SST Shim register map |
|---|
| 36 | | - * The register naming can differ between products. Some products also |
|---|
| 37 | | - * contain extra functionality. |
|---|
| 38 | | - */ |
|---|
| 39 | | -#define SST_CSR 0x00 |
|---|
| 40 | | -#define SST_PISR 0x08 |
|---|
| 41 | | -#define SST_PIMR 0x10 |
|---|
| 42 | | -#define SST_ISRX 0x18 |
|---|
| 43 | | -#define SST_ISRD 0x20 |
|---|
| 44 | | -#define SST_IMRX 0x28 |
|---|
| 45 | | -#define SST_IMRD 0x30 |
|---|
| 46 | | -#define SST_IPCX 0x38 /* IPC IA -> SST */ |
|---|
| 47 | | -#define SST_IPCD 0x40 /* IPC SST -> IA */ |
|---|
| 48 | | -#define SST_ISRSC 0x48 |
|---|
| 49 | | -#define SST_ISRLPESC 0x50 |
|---|
| 50 | | -#define SST_IMRSC 0x58 |
|---|
| 51 | | -#define SST_IMRLPESC 0x60 |
|---|
| 52 | | -#define SST_IPCSC 0x68 |
|---|
| 53 | | -#define SST_IPCLPESC 0x70 |
|---|
| 54 | | -#define SST_CLKCTL 0x78 |
|---|
| 55 | | -#define SST_CSR2 0x80 |
|---|
| 56 | | -#define SST_LTRC 0xE0 |
|---|
| 57 | | -#define SST_HMDC 0xE8 |
|---|
| 58 | | - |
|---|
| 59 | | -#define SST_SHIM_BEGIN SST_CSR |
|---|
| 60 | | -#define SST_SHIM_END SST_HDMC |
|---|
| 61 | | - |
|---|
| 62 | | -#define SST_DBGO 0xF0 |
|---|
| 63 | | - |
|---|
| 64 | | -#define SST_SHIM_SIZE 0x100 |
|---|
| 65 | | -#define SST_PWMCTRL 0x1000 |
|---|
| 66 | | - |
|---|
| 67 | | -/* SST Shim Register bits |
|---|
| 68 | | - * The register bit naming can differ between products. Some products also |
|---|
| 69 | | - * contain extra functionality. |
|---|
| 70 | | - */ |
|---|
| 71 | | - |
|---|
| 72 | | -/* CSR / CS */ |
|---|
| 73 | | -#define SST_CSR_RST (0x1 << 1) |
|---|
| 74 | | -#define SST_CSR_SBCS0 (0x1 << 2) |
|---|
| 75 | | -#define SST_CSR_SBCS1 (0x1 << 3) |
|---|
| 76 | | -#define SST_CSR_DCS(x) (x << 4) |
|---|
| 77 | | -#define SST_CSR_DCS_MASK (0x7 << 4) |
|---|
| 78 | | -#define SST_CSR_STALL (0x1 << 10) |
|---|
| 79 | | -#define SST_CSR_S0IOCS (0x1 << 21) |
|---|
| 80 | | -#define SST_CSR_S1IOCS (0x1 << 23) |
|---|
| 81 | | -#define SST_CSR_LPCS (0x1 << 31) |
|---|
| 82 | | -#define SST_CSR_24MHZ_LPCS (SST_CSR_SBCS0 | SST_CSR_SBCS1 | SST_CSR_LPCS) |
|---|
| 83 | | -#define SST_CSR_24MHZ_NO_LPCS (SST_CSR_SBCS0 | SST_CSR_SBCS1) |
|---|
| 84 | | -#define SST_BYT_CSR_RST (0x1 << 0) |
|---|
| 85 | | -#define SST_BYT_CSR_VECTOR_SEL (0x1 << 1) |
|---|
| 86 | | -#define SST_BYT_CSR_STALL (0x1 << 2) |
|---|
| 87 | | -#define SST_BYT_CSR_PWAITMODE (0x1 << 3) |
|---|
| 88 | | - |
|---|
| 89 | | -/* ISRX / ISC */ |
|---|
| 90 | | -#define SST_ISRX_BUSY (0x1 << 1) |
|---|
| 91 | | -#define SST_ISRX_DONE (0x1 << 0) |
|---|
| 92 | | -#define SST_BYT_ISRX_REQUEST (0x1 << 1) |
|---|
| 93 | | - |
|---|
| 94 | | -/* ISRD / ISD */ |
|---|
| 95 | | -#define SST_ISRD_BUSY (0x1 << 1) |
|---|
| 96 | | -#define SST_ISRD_DONE (0x1 << 0) |
|---|
| 97 | | - |
|---|
| 98 | | -/* IMRX / IMC */ |
|---|
| 99 | | -#define SST_IMRX_BUSY (0x1 << 1) |
|---|
| 100 | | -#define SST_IMRX_DONE (0x1 << 0) |
|---|
| 101 | | -#define SST_BYT_IMRX_REQUEST (0x1 << 1) |
|---|
| 102 | | - |
|---|
| 103 | | -/* IMRD / IMD */ |
|---|
| 104 | | -#define SST_IMRD_DONE (0x1 << 0) |
|---|
| 105 | | -#define SST_IMRD_BUSY (0x1 << 1) |
|---|
| 106 | | -#define SST_IMRD_SSP0 (0x1 << 16) |
|---|
| 107 | | -#define SST_IMRD_DMAC0 (0x1 << 21) |
|---|
| 108 | | -#define SST_IMRD_DMAC1 (0x1 << 22) |
|---|
| 109 | | -#define SST_IMRD_DMAC (SST_IMRD_DMAC0 | SST_IMRD_DMAC1) |
|---|
| 110 | | - |
|---|
| 111 | | -/* IPCX / IPCC */ |
|---|
| 112 | | -#define SST_IPCX_DONE (0x1 << 30) |
|---|
| 113 | | -#define SST_IPCX_BUSY (0x1 << 31) |
|---|
| 114 | | -#define SST_BYT_IPCX_DONE ((u64)0x1 << 62) |
|---|
| 115 | | -#define SST_BYT_IPCX_BUSY ((u64)0x1 << 63) |
|---|
| 116 | | - |
|---|
| 117 | | -/* IPCD */ |
|---|
| 118 | | -#define SST_IPCD_DONE (0x1 << 30) |
|---|
| 119 | | -#define SST_IPCD_BUSY (0x1 << 31) |
|---|
| 120 | | -#define SST_BYT_IPCD_DONE ((u64)0x1 << 62) |
|---|
| 121 | | -#define SST_BYT_IPCD_BUSY ((u64)0x1 << 63) |
|---|
| 122 | | - |
|---|
| 123 | | -/* CLKCTL */ |
|---|
| 124 | | -#define SST_CLKCTL_SMOS(x) (x << 24) |
|---|
| 125 | | -#define SST_CLKCTL_MASK (3 << 24) |
|---|
| 126 | | -#define SST_CLKCTL_DCPLCG (1 << 18) |
|---|
| 127 | | -#define SST_CLKCTL_SCOE1 (1 << 17) |
|---|
| 128 | | -#define SST_CLKCTL_SCOE0 (1 << 16) |
|---|
| 129 | | - |
|---|
| 130 | | -/* CSR2 / CS2 */ |
|---|
| 131 | | -#define SST_CSR2_SDFD_SSP0 (1 << 1) |
|---|
| 132 | | -#define SST_CSR2_SDFD_SSP1 (1 << 2) |
|---|
| 133 | | - |
|---|
| 134 | | -/* LTRC */ |
|---|
| 135 | | -#define SST_LTRC_VAL(x) (x << 0) |
|---|
| 136 | | - |
|---|
| 137 | | -/* HMDC */ |
|---|
| 138 | | -#define SST_HMDC_HDDA0(x) (x << 0) |
|---|
| 139 | | -#define SST_HMDC_HDDA1(x) (x << 7) |
|---|
| 140 | | -#define SST_HMDC_HDDA_E0_CH0 1 |
|---|
| 141 | | -#define SST_HMDC_HDDA_E0_CH1 2 |
|---|
| 142 | | -#define SST_HMDC_HDDA_E0_CH2 4 |
|---|
| 143 | | -#define SST_HMDC_HDDA_E0_CH3 8 |
|---|
| 144 | | -#define SST_HMDC_HDDA_E1_CH0 SST_HMDC_HDDA1(SST_HMDC_HDDA_E0_CH0) |
|---|
| 145 | | -#define SST_HMDC_HDDA_E1_CH1 SST_HMDC_HDDA1(SST_HMDC_HDDA_E0_CH1) |
|---|
| 146 | | -#define SST_HMDC_HDDA_E1_CH2 SST_HMDC_HDDA1(SST_HMDC_HDDA_E0_CH2) |
|---|
| 147 | | -#define SST_HMDC_HDDA_E1_CH3 SST_HMDC_HDDA1(SST_HMDC_HDDA_E0_CH3) |
|---|
| 148 | | -#define SST_HMDC_HDDA_E0_ALLCH (SST_HMDC_HDDA_E0_CH0 | SST_HMDC_HDDA_E0_CH1 | \ |
|---|
| 149 | | - SST_HMDC_HDDA_E0_CH2 | SST_HMDC_HDDA_E0_CH3) |
|---|
| 150 | | -#define SST_HMDC_HDDA_E1_ALLCH (SST_HMDC_HDDA_E1_CH0 | SST_HMDC_HDDA_E1_CH1 | \ |
|---|
| 151 | | - SST_HMDC_HDDA_E1_CH2 | SST_HMDC_HDDA_E1_CH3) |
|---|
| 152 | | - |
|---|
| 153 | | - |
|---|
| 154 | | -/* SST Vendor Defined Registers and bits */ |
|---|
| 155 | | -#define SST_VDRTCTL0 0xa0 |
|---|
| 156 | | -#define SST_VDRTCTL1 0xa4 |
|---|
| 157 | | -#define SST_VDRTCTL2 0xa8 |
|---|
| 158 | | -#define SST_VDRTCTL3 0xaC |
|---|
| 159 | | - |
|---|
| 160 | | -/* VDRTCTL0 */ |
|---|
| 161 | | -#define SST_VDRTCL0_D3PGD (1 << 0) |
|---|
| 162 | | -#define SST_VDRTCL0_D3SRAMPGD (1 << 1) |
|---|
| 163 | | -#define SST_VDRTCL0_DSRAMPGE_SHIFT 12 |
|---|
| 164 | | -#define SST_VDRTCL0_DSRAMPGE_MASK (0xfffff << SST_VDRTCL0_DSRAMPGE_SHIFT) |
|---|
| 165 | | -#define SST_VDRTCL0_ISRAMPGE_SHIFT 2 |
|---|
| 166 | | -#define SST_VDRTCL0_ISRAMPGE_MASK (0x3ff << SST_VDRTCL0_ISRAMPGE_SHIFT) |
|---|
| 167 | | - |
|---|
| 168 | | -/* VDRTCTL2 */ |
|---|
| 169 | | -#define SST_VDRTCL2_DCLCGE (1 << 1) |
|---|
| 170 | | -#define SST_VDRTCL2_DTCGE (1 << 10) |
|---|
| 171 | | -#define SST_VDRTCL2_APLLSE_MASK (1 << 31) |
|---|
| 172 | | - |
|---|
| 173 | | -/* PMCS */ |
|---|
| 174 | | -#define SST_PMCS 0x84 |
|---|
| 175 | | -#define SST_PMCS_PS_MASK 0x3 |
|---|
| 176 | 14 | |
|---|
| 177 | 15 | struct sst_dsp; |
|---|
| 178 | 16 | |
|---|
| .. | .. |
|---|
| 188 | 26 | void *thread_context; |
|---|
| 189 | 27 | }; |
|---|
| 190 | 28 | |
|---|
| 191 | | -/* |
|---|
| 192 | | - * SST Platform Data. |
|---|
| 193 | | - */ |
|---|
| 194 | | -struct sst_pdata { |
|---|
| 195 | | - /* ACPI data */ |
|---|
| 196 | | - u32 lpe_base; |
|---|
| 197 | | - u32 lpe_size; |
|---|
| 198 | | - u32 pcicfg_base; |
|---|
| 199 | | - u32 pcicfg_size; |
|---|
| 200 | | - u32 fw_base; |
|---|
| 201 | | - u32 fw_size; |
|---|
| 202 | | - int irq; |
|---|
| 203 | | - |
|---|
| 204 | | - /* Firmware */ |
|---|
| 205 | | - const struct firmware *fw; |
|---|
| 206 | | - |
|---|
| 207 | | - /* DMA */ |
|---|
| 208 | | - int resindex_dma_base; /* other fields invalid if equals to -1 */ |
|---|
| 209 | | - u32 dma_base; |
|---|
| 210 | | - u32 dma_size; |
|---|
| 211 | | - int dma_engine; |
|---|
| 212 | | - struct device *dma_dev; |
|---|
| 213 | | - |
|---|
| 214 | | - /* DSP */ |
|---|
| 215 | | - u32 id; |
|---|
| 216 | | - void *dsp; |
|---|
| 217 | | -}; |
|---|
| 218 | | - |
|---|
| 219 | | -#if IS_ENABLED(CONFIG_DW_DMAC_CORE) |
|---|
| 220 | | -/* Initialization */ |
|---|
| 221 | | -struct sst_dsp *sst_dsp_new(struct device *dev, |
|---|
| 222 | | - struct sst_dsp_device *sst_dev, struct sst_pdata *pdata); |
|---|
| 223 | | -void sst_dsp_free(struct sst_dsp *sst); |
|---|
| 224 | | -#endif |
|---|
| 225 | | - |
|---|
| 226 | 29 | /* SHIM Read / Write */ |
|---|
| 227 | 30 | void sst_dsp_shim_write(struct sst_dsp *sst, u32 offset, u32 value); |
|---|
| 228 | 31 | u32 sst_dsp_shim_read(struct sst_dsp *sst, u32 offset); |
|---|
| 229 | 32 | int sst_dsp_shim_update_bits(struct sst_dsp *sst, u32 offset, |
|---|
| 230 | 33 | u32 mask, u32 value); |
|---|
| 231 | | -void sst_dsp_shim_write64(struct sst_dsp *sst, u32 offset, u64 value); |
|---|
| 232 | | -u64 sst_dsp_shim_read64(struct sst_dsp *sst, u32 offset); |
|---|
| 233 | | -int sst_dsp_shim_update_bits64(struct sst_dsp *sst, u32 offset, |
|---|
| 234 | | - u64 mask, u64 value); |
|---|
| 235 | 34 | void sst_dsp_shim_update_bits_forced(struct sst_dsp *sst, u32 offset, |
|---|
| 236 | 35 | u32 mask, u32 value); |
|---|
| 237 | 36 | |
|---|
| .. | .. |
|---|
| 240 | 39 | u32 sst_dsp_shim_read_unlocked(struct sst_dsp *sst, u32 offset); |
|---|
| 241 | 40 | int sst_dsp_shim_update_bits_unlocked(struct sst_dsp *sst, u32 offset, |
|---|
| 242 | 41 | u32 mask, u32 value); |
|---|
| 243 | | -void sst_dsp_shim_write64_unlocked(struct sst_dsp *sst, u32 offset, u64 value); |
|---|
| 244 | | -u64 sst_dsp_shim_read64_unlocked(struct sst_dsp *sst, u32 offset); |
|---|
| 245 | | -int sst_dsp_shim_update_bits64_unlocked(struct sst_dsp *sst, u32 offset, |
|---|
| 246 | | - u64 mask, u64 value); |
|---|
| 247 | 42 | void sst_dsp_shim_update_bits_forced_unlocked(struct sst_dsp *sst, u32 offset, |
|---|
| 248 | 43 | u32 mask, u32 value); |
|---|
| 249 | 44 | |
|---|
| .. | .. |
|---|
| 252 | 47 | u32 sst_shim32_read(void __iomem *addr, u32 offset); |
|---|
| 253 | 48 | void sst_shim32_write64(void __iomem *addr, u32 offset, u64 value); |
|---|
| 254 | 49 | u64 sst_shim32_read64(void __iomem *addr, u32 offset); |
|---|
| 255 | | -void sst_memcpy_toio_32(struct sst_dsp *sst, |
|---|
| 256 | | - void __iomem *dest, void *src, size_t bytes); |
|---|
| 257 | | -void sst_memcpy_fromio_32(struct sst_dsp *sst, |
|---|
| 258 | | - void *dest, void __iomem *src, size_t bytes); |
|---|
| 259 | | - |
|---|
| 260 | | -/* DSP reset & boot */ |
|---|
| 261 | | -void sst_dsp_reset(struct sst_dsp *sst); |
|---|
| 262 | | -int sst_dsp_boot(struct sst_dsp *sst); |
|---|
| 263 | | -int sst_dsp_wake(struct sst_dsp *sst); |
|---|
| 264 | | -void sst_dsp_sleep(struct sst_dsp *sst); |
|---|
| 265 | | -void sst_dsp_stall(struct sst_dsp *sst); |
|---|
| 266 | | - |
|---|
| 267 | | -/* DMA */ |
|---|
| 268 | | -int sst_dsp_dma_get_channel(struct sst_dsp *dsp, int chan_id); |
|---|
| 269 | | -void sst_dsp_dma_put_channel(struct sst_dsp *dsp); |
|---|
| 270 | | -int sst_dsp_dma_copyfrom(struct sst_dsp *sst, dma_addr_t dest_addr, |
|---|
| 271 | | - dma_addr_t src_addr, size_t size); |
|---|
| 272 | | -int sst_dsp_dma_copyto(struct sst_dsp *sst, dma_addr_t dest_addr, |
|---|
| 273 | | - dma_addr_t src_addr, size_t size); |
|---|
| 274 | | - |
|---|
| 275 | | -/* Msg IO */ |
|---|
| 276 | | -void sst_dsp_ipc_msg_tx(struct sst_dsp *dsp, u32 msg); |
|---|
| 277 | | -u32 sst_dsp_ipc_msg_rx(struct sst_dsp *dsp); |
|---|
| 278 | 50 | |
|---|
| 279 | 51 | /* Mailbox management */ |
|---|
| 280 | | -int sst_dsp_mailbox_init(struct sst_dsp *dsp, u32 inbox_offset, |
|---|
| 52 | +int sst_dsp_mailbox_init(struct sst_dsp *sst, u32 inbox_offset, |
|---|
| 281 | 53 | size_t inbox_size, u32 outbox_offset, size_t outbox_size); |
|---|
| 282 | | -void sst_dsp_inbox_write(struct sst_dsp *dsp, void *message, size_t bytes); |
|---|
| 283 | | -void sst_dsp_inbox_read(struct sst_dsp *dsp, void *message, size_t bytes); |
|---|
| 284 | | -void sst_dsp_outbox_write(struct sst_dsp *dsp, void *message, size_t bytes); |
|---|
| 285 | | -void sst_dsp_outbox_read(struct sst_dsp *dsp, void *message, size_t bytes); |
|---|
| 286 | | -void sst_dsp_mailbox_dump(struct sst_dsp *dsp, size_t bytes); |
|---|
| 287 | | -int sst_dsp_register_poll(struct sst_dsp *dsp, u32 offset, u32 mask, |
|---|
| 288 | | - u32 expected_value, u32 timeout, char *operation); |
|---|
| 289 | | - |
|---|
| 290 | | -/* Debug */ |
|---|
| 291 | | -void sst_dsp_dump(struct sst_dsp *sst); |
|---|
| 54 | +void sst_dsp_inbox_write(struct sst_dsp *sst, void *message, size_t bytes); |
|---|
| 55 | +void sst_dsp_inbox_read(struct sst_dsp *sst, void *message, size_t bytes); |
|---|
| 56 | +void sst_dsp_outbox_write(struct sst_dsp *sst, void *message, size_t bytes); |
|---|
| 57 | +void sst_dsp_outbox_read(struct sst_dsp *sst, void *message, size_t bytes); |
|---|
| 58 | +int sst_dsp_register_poll(struct sst_dsp *ctx, u32 offset, u32 mask, |
|---|
| 59 | + u32 target, u32 time, char *operation); |
|---|
| 292 | 60 | |
|---|
| 293 | 61 | #endif |
|---|