257 lines
		
	
	
		
			7.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			257 lines
		
	
	
		
			7.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /* SPDX-License-Identifier: GPL-2.0-only */
 | |
| /*
 | |
|  * Skylake SST DSP Support
 | |
|  *
 | |
|  * Copyright (C) 2014-15, Intel Corporation.
 | |
|  */
 | |
| 
 | |
| #ifndef __SKL_SST_DSP_H__
 | |
| #define __SKL_SST_DSP_H__
 | |
| 
 | |
| #include <linux/interrupt.h>
 | |
| #include <linux/uuid.h>
 | |
| #include <linux/firmware.h>
 | |
| #include <sound/memalloc.h>
 | |
| #include "skl-sst-cldma.h"
 | |
| 
 | |
| struct sst_dsp;
 | |
| struct sst_dsp_device;
 | |
| struct skl_lib_info;
 | |
| struct skl_dev;
 | |
| 
 | |
| /* Intel HD Audio General DSP Registers */
 | |
| #define SKL_ADSP_GEN_BASE		0x0
 | |
| #define SKL_ADSP_REG_ADSPCS		(SKL_ADSP_GEN_BASE + 0x04)
 | |
| #define SKL_ADSP_REG_ADSPIC		(SKL_ADSP_GEN_BASE + 0x08)
 | |
| #define SKL_ADSP_REG_ADSPIS		(SKL_ADSP_GEN_BASE + 0x0C)
 | |
| #define SKL_ADSP_REG_ADSPIC2		(SKL_ADSP_GEN_BASE + 0x10)
 | |
| #define SKL_ADSP_REG_ADSPIS2		(SKL_ADSP_GEN_BASE + 0x14)
 | |
| 
 | |
| /* Intel HD Audio Inter-Processor Communication Registers */
 | |
| #define SKL_ADSP_IPC_BASE		0x40
 | |
| #define SKL_ADSP_REG_HIPCT		(SKL_ADSP_IPC_BASE + 0x00)
 | |
| #define SKL_ADSP_REG_HIPCTE		(SKL_ADSP_IPC_BASE + 0x04)
 | |
| #define SKL_ADSP_REG_HIPCI		(SKL_ADSP_IPC_BASE + 0x08)
 | |
| #define SKL_ADSP_REG_HIPCIE		(SKL_ADSP_IPC_BASE + 0x0C)
 | |
| #define SKL_ADSP_REG_HIPCCTL		(SKL_ADSP_IPC_BASE + 0x10)
 | |
| 
 | |
| /*  HIPCI */
 | |
| #define SKL_ADSP_REG_HIPCI_BUSY		BIT(31)
 | |
| 
 | |
| /* HIPCIE */
 | |
| #define SKL_ADSP_REG_HIPCIE_DONE	BIT(30)
 | |
| 
 | |
| /* HIPCCTL */
 | |
| #define SKL_ADSP_REG_HIPCCTL_DONE	BIT(1)
 | |
| #define SKL_ADSP_REG_HIPCCTL_BUSY	BIT(0)
 | |
| 
 | |
| /* HIPCT */
 | |
| #define SKL_ADSP_REG_HIPCT_BUSY		BIT(31)
 | |
| 
 | |
| /* FW base IDs */
 | |
| #define SKL_INSTANCE_ID			0
 | |
| #define SKL_BASE_FW_MODULE_ID		0
 | |
| 
 | |
| /* Intel HD Audio SRAM Window 1 */
 | |
| #define SKL_ADSP_SRAM1_BASE		0xA000
 | |
| 
 | |
| #define SKL_ADSP_MMIO_LEN		0x10000
 | |
| 
 | |
| #define SKL_ADSP_W0_STAT_SZ		0x1000
 | |
| 
 | |
| #define SKL_ADSP_W0_UP_SZ		0x1000
 | |
| 
 | |
| #define SKL_ADSP_W1_SZ			0x1000
 | |
| 
 | |
| #define SKL_FW_STS_MASK			0xf
 | |
| 
 | |
| #define SKL_FW_INIT			0x1
 | |
| #define SKL_FW_RFW_START		0xf
 | |
| #define BXT_FW_ROM_INIT_RETRY		3
 | |
| #define BXT_INIT_TIMEOUT		300
 | |
| 
 | |
| #define SKL_ADSPIC_IPC			1
 | |
| #define SKL_ADSPIS_IPC			1
 | |
| 
 | |
| /* Core ID of core0 */
 | |
| #define SKL_DSP_CORE0_ID		0
 | |
| 
 | |
| /* Mask for a given core index, c = 0.. number of supported cores - 1 */
 | |
| #define SKL_DSP_CORE_MASK(c)		BIT(c)
 | |
| 
 | |
| /*
 | |
|  * Core 0 mask = SKL_DSP_CORE_MASK(0); Defined separately
 | |
|  * since Core0 is primary core and it is used often
 | |
|  */
 | |
| #define SKL_DSP_CORE0_MASK		BIT(0)
 | |
| 
 | |
| /*
 | |
|  * Mask for a given number of cores
 | |
|  * nc = number of supported cores
 | |
|  */
 | |
| #define SKL_DSP_CORES_MASK(nc)	GENMASK((nc - 1), 0)
 | |
| 
 | |
| /* ADSPCS - Audio DSP Control & Status */
 | |
| 
 | |
| /*
 | |
|  * Core Reset - asserted high
 | |
|  * CRST Mask for a given core mask pattern, cm
 | |
|  */
 | |
| #define SKL_ADSPCS_CRST_SHIFT		0
 | |
| #define SKL_ADSPCS_CRST_MASK(cm)	((cm) << SKL_ADSPCS_CRST_SHIFT)
 | |
| 
 | |
| /*
 | |
|  * Core run/stall - when set to '1' core is stalled
 | |
|  * CSTALL Mask for a given core mask pattern, cm
 | |
|  */
 | |
| #define SKL_ADSPCS_CSTALL_SHIFT		8
 | |
| #define SKL_ADSPCS_CSTALL_MASK(cm)	((cm) << SKL_ADSPCS_CSTALL_SHIFT)
 | |
| 
 | |
| /*
 | |
|  * Set Power Active - when set to '1' turn cores on
 | |
|  * SPA Mask for a given core mask pattern, cm
 | |
|  */
 | |
| #define SKL_ADSPCS_SPA_SHIFT		16
 | |
| #define SKL_ADSPCS_SPA_MASK(cm)		((cm) << SKL_ADSPCS_SPA_SHIFT)
 | |
| 
 | |
| /*
 | |
|  * Current Power Active - power status of cores, set by hardware
 | |
|  * CPA Mask for a given core mask pattern, cm
 | |
|  */
 | |
| #define SKL_ADSPCS_CPA_SHIFT		24
 | |
| #define SKL_ADSPCS_CPA_MASK(cm)		((cm) << SKL_ADSPCS_CPA_SHIFT)
 | |
| 
 | |
| /* DSP Core state */
 | |
| enum skl_dsp_states {
 | |
| 	SKL_DSP_RUNNING = 1,
 | |
| 	/* Running in D0i3 state; can be in streaming or non-streaming D0i3 */
 | |
| 	SKL_DSP_RUNNING_D0I3, /* Running in D0i3 state*/
 | |
| 	SKL_DSP_RESET,
 | |
| };
 | |
| 
 | |
| /* D0i3 substates */
 | |
| enum skl_dsp_d0i3_states {
 | |
| 	SKL_DSP_D0I3_NONE = -1, /* No D0i3 */
 | |
| 	SKL_DSP_D0I3_NON_STREAMING = 0,
 | |
| 	SKL_DSP_D0I3_STREAMING = 1,
 | |
| };
 | |
| 
 | |
| struct skl_dsp_fw_ops {
 | |
| 	int (*load_fw)(struct sst_dsp  *ctx);
 | |
| 	/* FW module parser/loader */
 | |
| 	int (*load_library)(struct sst_dsp *ctx,
 | |
| 		struct skl_lib_info *linfo, int lib_count);
 | |
| 	int (*parse_fw)(struct sst_dsp *ctx);
 | |
| 	int (*set_state_D0)(struct sst_dsp *ctx, unsigned int core_id);
 | |
| 	int (*set_state_D3)(struct sst_dsp *ctx, unsigned int core_id);
 | |
| 	int (*set_state_D0i3)(struct sst_dsp *ctx);
 | |
| 	int (*set_state_D0i0)(struct sst_dsp *ctx);
 | |
| 	unsigned int (*get_fw_errcode)(struct sst_dsp *ctx);
 | |
| 	int (*load_mod)(struct sst_dsp *ctx, u16 mod_id, u8 *mod_name);
 | |
| 	int (*unload_mod)(struct sst_dsp *ctx, u16 mod_id);
 | |
| 
 | |
| };
 | |
| 
 | |
| struct skl_dsp_loader_ops {
 | |
| 	int stream_tag;
 | |
| 
 | |
| 	int (*alloc_dma_buf)(struct device *dev,
 | |
| 		struct snd_dma_buffer *dmab, size_t size);
 | |
| 	int (*free_dma_buf)(struct device *dev,
 | |
| 		struct snd_dma_buffer *dmab);
 | |
| 	int (*prepare)(struct device *dev, unsigned int format,
 | |
| 				unsigned int byte_size,
 | |
| 				struct snd_dma_buffer *bufp);
 | |
| 	int (*trigger)(struct device *dev, bool start, int stream_tag);
 | |
| 
 | |
| 	int (*cleanup)(struct device *dev, struct snd_dma_buffer *dmab,
 | |
| 				 int stream_tag);
 | |
| };
 | |
| 
 | |
| #define MAX_INSTANCE_BUFF 2
 | |
| 
 | |
| struct uuid_module {
 | |
| 	guid_t uuid;
 | |
| 	int id;
 | |
| 	int is_loadable;
 | |
| 	int max_instance;
 | |
| 	u64 pvt_id[MAX_INSTANCE_BUFF];
 | |
| 	int *instance_id;
 | |
| 
 | |
| 	struct list_head list;
 | |
| };
 | |
| 
 | |
| struct skl_load_module_info {
 | |
| 	u16 mod_id;
 | |
| 	const struct firmware *fw;
 | |
| };
 | |
| 
 | |
| struct skl_module_table {
 | |
| 	struct skl_load_module_info *mod_info;
 | |
| 	unsigned int usage_cnt;
 | |
| 	struct list_head list;
 | |
| };
 | |
| 
 | |
| void skl_cldma_process_intr(struct sst_dsp *ctx);
 | |
| void skl_cldma_int_disable(struct sst_dsp *ctx);
 | |
| int skl_cldma_prepare(struct sst_dsp *ctx);
 | |
| int skl_cldma_wait_interruptible(struct sst_dsp *ctx);
 | |
| 
 | |
| void skl_dsp_set_state_locked(struct sst_dsp *ctx, int state);
 | |
| struct sst_dsp *skl_dsp_ctx_init(struct device *dev,
 | |
| 		struct sst_dsp_device *sst_dev, int irq);
 | |
| int skl_dsp_acquire_irq(struct sst_dsp *sst);
 | |
| bool is_skl_dsp_running(struct sst_dsp *ctx);
 | |
| 
 | |
| unsigned int skl_dsp_get_enabled_cores(struct sst_dsp *ctx);
 | |
| void skl_dsp_init_core_state(struct sst_dsp *ctx);
 | |
| int skl_dsp_enable_core(struct sst_dsp *ctx, unsigned int core_mask);
 | |
| int skl_dsp_disable_core(struct sst_dsp *ctx, unsigned int core_mask);
 | |
| int skl_dsp_core_power_up(struct sst_dsp *ctx, unsigned int core_mask);
 | |
| int skl_dsp_core_power_down(struct sst_dsp *ctx, unsigned int core_mask);
 | |
| int skl_dsp_core_unset_reset_state(struct sst_dsp *ctx,
 | |
| 					unsigned int core_mask);
 | |
| int skl_dsp_start_core(struct sst_dsp *ctx, unsigned int core_mask);
 | |
| 
 | |
| irqreturn_t skl_dsp_sst_interrupt(int irq, void *dev_id);
 | |
| int skl_dsp_wake(struct sst_dsp *ctx);
 | |
| int skl_dsp_sleep(struct sst_dsp *ctx);
 | |
| void skl_dsp_free(struct sst_dsp *dsp);
 | |
| 
 | |
| int skl_dsp_get_core(struct sst_dsp *ctx, unsigned int core_id);
 | |
| int skl_dsp_put_core(struct sst_dsp *ctx, unsigned int core_id);
 | |
| 
 | |
| int skl_dsp_boot(struct sst_dsp *ctx);
 | |
| int skl_sst_dsp_init(struct device *dev, void __iomem *mmio_base, int irq,
 | |
| 		const char *fw_name, struct skl_dsp_loader_ops dsp_ops,
 | |
| 		struct skl_dev **dsp);
 | |
| int bxt_sst_dsp_init(struct device *dev, void __iomem *mmio_base, int irq,
 | |
| 		const char *fw_name, struct skl_dsp_loader_ops dsp_ops,
 | |
| 		struct skl_dev **dsp);
 | |
| int skl_sst_init_fw(struct device *dev, struct skl_dev *skl);
 | |
| int bxt_sst_init_fw(struct device *dev, struct skl_dev *skl);
 | |
| void skl_sst_dsp_cleanup(struct device *dev, struct skl_dev *skl);
 | |
| void bxt_sst_dsp_cleanup(struct device *dev, struct skl_dev *skl);
 | |
| 
 | |
| int snd_skl_parse_uuids(struct sst_dsp *ctx, const struct firmware *fw,
 | |
| 				unsigned int offset, int index);
 | |
| int skl_get_pvt_id(struct skl_dev *skl, guid_t *uuid_mod, int instance_id);
 | |
| int skl_put_pvt_id(struct skl_dev *skl, guid_t *uuid_mod, int *pvt_id);
 | |
| int skl_get_pvt_instance_id_map(struct skl_dev *skl,
 | |
| 				int module_id, int instance_id);
 | |
| void skl_freeup_uuid_list(struct skl_dev *skl);
 | |
| 
 | |
| int skl_dsp_strip_extended_manifest(struct firmware *fw);
 | |
| 
 | |
| void skl_dsp_set_astate_cfg(struct skl_dev *skl, u32 cnt, void *data);
 | |
| 
 | |
| int skl_sst_ctx_init(struct device *dev, int irq, const char *fw_name,
 | |
| 		struct skl_dsp_loader_ops dsp_ops, struct skl_dev **dsp,
 | |
| 		struct sst_dsp_device *skl_dev);
 | |
| int skl_prepare_lib_load(struct skl_dev *skl, struct skl_lib_info *linfo,
 | |
| 			struct firmware *stripped_fw,
 | |
| 			unsigned int hdr_offset, int index);
 | |
| void skl_release_library(struct skl_lib_info *linfo, int lib_count);
 | |
| 
 | |
| #endif /*__SKL_SST_DSP_H__*/
 |