xref: /openbmc/linux/sound/soc/intel/skylake/skl.h (revision d236d361)
1 /*
2  *  skl.h - HD Audio skylake defintions.
3  *
4  *  Copyright (C) 2015 Intel Corp
5  *  Author: Jeeja KP <jeeja.kp@intel.com>
6  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; version 2 of the License.
11  *
12  *  This program is distributed in the hope that it will be useful, but
13  *  WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  *  General Public License for more details.
16  *
17  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18  *
19  */
20 
21 #ifndef __SOUND_SOC_SKL_H
22 #define __SOUND_SOC_SKL_H
23 
24 #include <sound/hda_register.h>
25 #include <sound/hdaudio_ext.h>
26 #include "skl-nhlt.h"
27 
28 #define SKL_SUSPEND_DELAY 2000
29 
30 #define AZX_PCIREG_PGCTL		0x44
31 #define AZX_PGCTL_LSRMD_MASK		(1 << 4)
32 #define AZX_PCIREG_CGCTL		0x48
33 #define AZX_CGCTL_MISCBDCGE_MASK	(1 << 6)
34 /* D0I3C Register fields */
35 #define AZX_REG_VS_D0I3C_CIP      0x1 /* Command in progress */
36 #define AZX_REG_VS_D0I3C_I3       0x4 /* D0i3 enable */
37 
38 struct skl_dsp_resource {
39 	u32 max_mcps;
40 	u32 max_mem;
41 	u32 mcps;
42 	u32 mem;
43 };
44 
45 struct skl {
46 	struct hdac_ext_bus ebus;
47 	struct pci_dev *pci;
48 
49 	unsigned int init_done:1; /* delayed init status */
50 	struct platform_device *dmic_dev;
51 	struct platform_device *i2s_dev;
52 	struct snd_soc_platform *platform;
53 
54 	struct nhlt_acpi_table *nhlt; /* nhlt ptr */
55 	struct skl_sst *skl_sst; /* sst skl ctx */
56 
57 	struct skl_dsp_resource resource;
58 	struct list_head ppl_list;
59 	struct list_head bind_list;
60 
61 	const char *fw_name;
62 	char tplg_name[64];
63 	unsigned short pci_id;
64 	const struct firmware *tplg;
65 
66 	int supend_active;
67 
68 	struct work_struct probe_work;
69 };
70 
71 #define skl_to_ebus(s)	(&(s)->ebus)
72 #define ebus_to_skl(sbus) \
73 	container_of(sbus, struct skl, sbus)
74 
75 /* to pass dai dma data */
76 struct skl_dma_params {
77 	u32 format;
78 	u8 stream_tag;
79 };
80 
81 /* to pass dmic data */
82 struct skl_machine_pdata {
83 	u32 dmic_num;
84 };
85 
86 struct skl_dsp_ops {
87 	int id;
88 	struct skl_dsp_loader_ops (*loader_ops)(void);
89 	int (*init)(struct device *dev, void __iomem *mmio_base,
90 			int irq, const char *fw_name,
91 			struct skl_dsp_loader_ops loader_ops,
92 			struct skl_sst **skl_sst);
93 	int (*init_fw)(struct device *dev, struct skl_sst *ctx);
94 	void (*cleanup)(struct device *dev, struct skl_sst *ctx);
95 };
96 
97 int skl_platform_unregister(struct device *dev);
98 int skl_platform_register(struct device *dev);
99 
100 struct nhlt_acpi_table *skl_nhlt_init(struct device *dev);
101 void skl_nhlt_free(struct nhlt_acpi_table *addr);
102 struct nhlt_specific_cfg *skl_get_ep_blob(struct skl *skl, u32 instance,
103 					u8 link_type, u8 s_fmt, u8 no_ch,
104 					u32 s_rate, u8 dirn, u8 dev_type);
105 
106 int skl_get_dmic_geo(struct skl *skl);
107 int skl_nhlt_update_topology_bin(struct skl *skl);
108 int skl_init_dsp(struct skl *skl);
109 int skl_free_dsp(struct skl *skl);
110 int skl_suspend_late_dsp(struct skl *skl);
111 int skl_suspend_dsp(struct skl *skl);
112 int skl_resume_dsp(struct skl *skl);
113 void skl_cleanup_resources(struct skl *skl);
114 const struct skl_dsp_ops *skl_get_dsp_ops(int pci_id);
115 void skl_update_d0i3c(struct device *dev, bool enable);
116 int skl_nhlt_create_sysfs(struct skl *skl);
117 void skl_nhlt_remove_sysfs(struct skl *skl);
118 
119 #endif /* __SOUND_SOC_SKL_H */
120