2 * Intel Smart Sound Technology
4 * Copyright (C) 2013, Intel Corporation. All rights reserved.
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.
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.
17 #ifndef __SOUND_SOC_SST_DSP_PRIV_H
18 #define __SOUND_SOC_SST_DSP_PRIV_H
20 #include <linux/kernel.h>
21 #include <linux/types.h>
22 #include <linux/interrupt.h>
23 #include <linux/firmware.h>
29 /* do we need to remove or keep */
30 #define DSP_DRAM_ADDR_OFFSET 0x400000
33 * DSP Operations exported by platform Audio DSP driver.
36 /* DSP core boot / reset */
37 void (*boot)(struct sst_dsp *);
38 void (*reset)(struct sst_dsp *);
39 int (*wake)(struct sst_dsp *);
40 void (*sleep)(struct sst_dsp *);
41 void (*stall)(struct sst_dsp *);
44 void (*write)(void __iomem *addr, u32 offset, u32 value);
45 u32 (*read)(void __iomem *addr, u32 offset);
46 void (*write64)(void __iomem *addr, u32 offset, u64 value);
47 u64 (*read64)(void __iomem *addr, u32 offset);
50 void (*ram_read)(struct sst_dsp *sst, void *dest, void __iomem *src,
52 void (*ram_write)(struct sst_dsp *sst, void __iomem *dest, void *src,
55 void (*dump)(struct sst_dsp *);
58 irqreturn_t (*irq_handler)(int irq, void *context);
60 /* SST init and free */
61 int (*init)(struct sst_dsp *sst, struct sst_pdata *pdata);
62 void (*free)(struct sst_dsp *sst);
64 /* FW module parser/loader */
65 int (*parse_fw)(struct sst_fw *sst_fw);
69 * Audio DSP memory offsets and addresses.
80 void __iomem *pci_cfg;
85 * Audio DSP Mailbox configuration.
88 void __iomem *in_base;
89 void __iomem *out_base;
95 * Audio DSP memory block types.
105 * Audio DSP Generic Firmware File.
107 * SST Firmware files can consist of 1..N modules. This generic structure is
108 * used to manage each firmware file and it's modules regardless of SST firmware
109 * type. A SST driver may load multiple FW files.
114 /* base addresses of FW file data */
115 dma_addr_t dmable_fw_paddr; /* physical address of fw data */
116 void *dma_buf; /* virtual address of fw data */
117 u32 size; /* size of fw data */
120 struct list_head list; /* DSP list of FW */
121 struct list_head module_list; /* FW list of modules */
123 void *private; /* core doesn't touch this */
127 * Audio DSP Generic Module Template.
129 * Used to define and register a new FW module. This data is extracted from
130 * FW module header information.
132 struct sst_module_template {
134 u32 entry; /* entry point */
140 * Block Allocator - Used to allocate blocks of DSP memory.
142 struct sst_block_allocator {
146 enum sst_mem_type type;
150 * Runtime Module Instance - A module object can be instanciated multiple
151 * times within the DSP FW.
153 struct sst_module_runtime {
156 struct sst_module *module; /* parent module we belong too */
158 u32 persistent_offset; /* private memory offset */
161 struct list_head list;
162 struct list_head block_list; /* list of blocks used */
166 * Runtime Module Context - The runtime context must be manually stored by the
167 * driver prior to enter S3 and restored after leaving S3. This should really be
168 * part of the memory context saved by the enter D3 message IPC ???
170 struct sst_module_runtime_context {
171 dma_addr_t dma_buffer;
176 * Audio DSP Module State
178 enum sst_module_state {
179 SST_MODULE_STATE_UNLOADED = 0, /* default state */
180 SST_MODULE_STATE_LOADED,
181 SST_MODULE_STATE_INITIALIZED, /* and inactive */
182 SST_MODULE_STATE_ACTIVE,
186 * Audio DSP Generic Module.
188 * Each Firmware file can consist of 1..N modules. A module can span multiple
189 * ADSP memory blocks. The simplest FW will be a file with 1 module. A module
190 * can be instanciated multiple times in the DSP.
194 struct sst_fw *sst_fw; /* parent FW we belong too */
196 /* module configuration */
198 u32 entry; /* module entry point */
199 s32 offset; /* module offset in firmware file */
200 u32 size; /* module size */
201 u32 scratch_size; /* global scratch memory required */
202 u32 persistent_size; /* private memory required */
203 enum sst_mem_type type; /* destination memory type */
204 u32 data_offset; /* offset in ADSP memory space */
205 void *data; /* module data */
208 u32 usage_count; /* can be unloaded if count == 0 */
209 void *private; /* core doesn't touch this */
212 struct list_head block_list; /* Module list of blocks in use */
213 struct list_head list; /* DSP list of modules */
214 struct list_head list_fw; /* FW list of modules */
215 struct list_head runtime_list; /* list of runtime module objects*/
218 enum sst_module_state state;
222 * SST Memory Block operations.
224 struct sst_block_ops {
225 int (*enable)(struct sst_mem_block *block);
226 int (*disable)(struct sst_mem_block *block);
230 * SST Generic Memory Block.
232 * SST ADP memory has multiple IRAM and DRAM blocks. Some ADSP blocks can be
235 struct sst_mem_block {
237 struct sst_module *module; /* module that uses this block */
240 u32 offset; /* offset from base */
241 u32 size; /* block size */
242 u32 index; /* block index 0..N */
243 enum sst_mem_type type; /* block memory type IRAM/DRAM */
244 struct sst_block_ops *ops; /* block operations, if any */
247 u32 bytes_used; /* bytes in use by modules */
248 void *private; /* generic core does not touch this */
249 int users; /* number of modules using this block */
252 struct list_head module_list; /* Module list of blocks */
253 struct list_head list; /* Map list of free/used blocks */
257 * Generic SST Shim Interface.
262 struct sst_dsp_device *sst_dev;
263 spinlock_t spinlock; /* IPC locking */
264 struct mutex mutex; /* DSP FW lock */
266 struct device *dma_dev;
267 void *thread_context;
271 /* list of free and used ADSP memory blocks */
272 struct list_head used_block_list;
273 struct list_head free_block_list;
279 struct dentry *debugfs_root;
282 struct sst_addr addr;
285 struct sst_mailbox mailbox;
287 /* SST FW files loaded and their modules */
288 struct list_head module_list;
289 struct list_head fw_list;
292 struct list_head scratch_block_list;
297 struct sst_pdata *pdata;
304 /* Size optimised DRAM/IRAM memcpy */
305 static inline void sst_dsp_write(struct sst_dsp *sst, void *src,
306 u32 dest_offset, size_t bytes)
308 sst->ops->ram_write(sst, sst->addr.lpe + dest_offset, src, bytes);
311 static inline void sst_dsp_read(struct sst_dsp *sst, void *dest,
312 u32 src_offset, size_t bytes)
314 sst->ops->ram_read(sst, dest, sst->addr.lpe + src_offset, bytes);
317 static inline void *sst_dsp_get_thread_context(struct sst_dsp *sst)
319 return sst->thread_context;
322 /* Create/Free FW files - can contain multiple modules */
323 struct sst_fw *sst_fw_new(struct sst_dsp *dsp,
324 const struct firmware *fw, void *private);
325 void sst_fw_free(struct sst_fw *sst_fw);
326 void sst_fw_free_all(struct sst_dsp *dsp);
327 int sst_fw_reload(struct sst_fw *sst_fw);
328 void sst_fw_unload(struct sst_fw *sst_fw);
330 /* Create/Free firmware modules */
331 struct sst_module *sst_module_new(struct sst_fw *sst_fw,
332 struct sst_module_template *template, void *private);
333 void sst_module_free(struct sst_module *module);
334 struct sst_module *sst_module_get_from_id(struct sst_dsp *dsp, u32 id);
335 int sst_module_alloc_blocks(struct sst_module *module);
336 int sst_module_free_blocks(struct sst_module *module);
338 /* Create/Free firmware module runtime instances */
339 struct sst_module_runtime *sst_module_runtime_new(struct sst_module *module,
340 int id, void *private);
341 void sst_module_runtime_free(struct sst_module_runtime *runtime);
342 struct sst_module_runtime *sst_module_runtime_get_from_id(
343 struct sst_module *module, u32 id);
344 int sst_module_runtime_alloc_blocks(struct sst_module_runtime *runtime,
346 int sst_module_runtime_free_blocks(struct sst_module_runtime *runtime);
347 int sst_module_runtime_save(struct sst_module_runtime *runtime,
348 struct sst_module_runtime_context *context);
349 int sst_module_runtime_restore(struct sst_module_runtime *runtime,
350 struct sst_module_runtime_context *context);
352 /* generic block allocation */
353 int sst_alloc_blocks(struct sst_dsp *dsp, struct sst_block_allocator *ba,
354 struct list_head *block_list);
355 int sst_free_blocks(struct sst_dsp *dsp, struct list_head *block_list);
357 /* scratch allocation */
358 int sst_block_alloc_scratch(struct sst_dsp *dsp);
359 void sst_block_free_scratch(struct sst_dsp *dsp);
361 /* Register the DSPs memory blocks - would be nice to read from ACPI */
362 struct sst_mem_block *sst_mem_block_register(struct sst_dsp *dsp, u32 offset,
363 u32 size, enum sst_mem_type type, struct sst_block_ops *ops, u32 index,
365 void sst_mem_block_unregister_all(struct sst_dsp *dsp);
367 /* Create/Free DMA resources */
368 int sst_dma_new(struct sst_dsp *sst);
369 void sst_dma_free(struct sst_dma *dma);
371 u32 sst_dsp_get_offset(struct sst_dsp *dsp, u32 offset,
372 enum sst_mem_type type);