Merge branch 'fix/intel' of https://git.kernel.org/pub/scm/linux/kernel/git/broonie...
[sfrench/cifs-2.6.git] / sound / soc / intel / skylake / skl.h
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 <sound/soc.h>
27 #include "skl-nhlt.h"
28 #include "skl-ssp-clk.h"
29
30 #define SKL_SUSPEND_DELAY 2000
31
32 #define SKL_MAX_ASTATE_CFG              3
33
34 #define AZX_PCIREG_PGCTL                0x44
35 #define AZX_PGCTL_LSRMD_MASK            (1 << 4)
36 #define AZX_PCIREG_CGCTL                0x48
37 #define AZX_CGCTL_MISCBDCGE_MASK        (1 << 6)
38 /* D0I3C Register fields */
39 #define AZX_REG_VS_D0I3C_CIP      0x1 /* Command in progress */
40 #define AZX_REG_VS_D0I3C_I3       0x4 /* D0i3 enable */
41
42 struct skl_dsp_resource {
43         u32 max_mcps;
44         u32 max_mem;
45         u32 mcps;
46         u32 mem;
47 };
48
49 struct skl_debug;
50
51 struct skl_astate_param {
52         u32 kcps;
53         u32 clk_src;
54 };
55
56 struct skl_astate_config {
57         u32 count;
58         struct skl_astate_param astate_table[0];
59 };
60
61 struct skl_fw_config {
62         struct skl_astate_config *astate_cfg;
63 };
64
65 struct skl {
66         struct hdac_ext_bus ebus;
67         struct pci_dev *pci;
68
69         unsigned int init_done:1; /* delayed init status */
70         struct platform_device *dmic_dev;
71         struct platform_device *i2s_dev;
72         struct platform_device *clk_dev;
73         struct snd_soc_platform *platform;
74         struct snd_soc_dai_driver *dais;
75
76         struct nhlt_acpi_table *nhlt; /* nhlt ptr */
77         struct skl_sst *skl_sst; /* sst skl ctx */
78
79         struct skl_dsp_resource resource;
80         struct list_head ppl_list;
81         struct list_head bind_list;
82
83         const char *fw_name;
84         char tplg_name[64];
85         unsigned short pci_id;
86         const struct firmware *tplg;
87
88         int supend_active;
89
90         struct work_struct probe_work;
91
92         struct skl_debug *debugfs;
93         u8 nr_modules;
94         struct skl_module **modules;
95         bool use_tplg_pcm;
96         struct skl_fw_config cfg;
97         struct snd_soc_acpi_mach *mach;
98 };
99
100 #define skl_to_ebus(s)  (&(s)->ebus)
101 #define ebus_to_skl(sbus) \
102         container_of(sbus, struct skl, sbus)
103
104 /* to pass dai dma data */
105 struct skl_dma_params {
106         u32 format;
107         u8 stream_tag;
108 };
109
110 struct skl_machine_pdata {
111         u32 dmic_num;
112         bool use_tplg_pcm; /* use dais and dai links from topology */
113 };
114
115 struct skl_dsp_ops {
116         int id;
117         unsigned int num_cores;
118         struct skl_dsp_loader_ops (*loader_ops)(void);
119         int (*init)(struct device *dev, void __iomem *mmio_base,
120                         int irq, const char *fw_name,
121                         struct skl_dsp_loader_ops loader_ops,
122                         struct skl_sst **skl_sst);
123         int (*init_fw)(struct device *dev, struct skl_sst *ctx);
124         void (*cleanup)(struct device *dev, struct skl_sst *ctx);
125 };
126
127 int skl_platform_unregister(struct device *dev);
128 int skl_platform_register(struct device *dev);
129
130 struct nhlt_acpi_table *skl_nhlt_init(struct device *dev);
131 void skl_nhlt_free(struct nhlt_acpi_table *addr);
132 struct nhlt_specific_cfg *skl_get_ep_blob(struct skl *skl, u32 instance,
133                                         u8 link_type, u8 s_fmt, u8 no_ch,
134                                         u32 s_rate, u8 dirn, u8 dev_type);
135
136 int skl_get_dmic_geo(struct skl *skl);
137 int skl_nhlt_update_topology_bin(struct skl *skl);
138 int skl_init_dsp(struct skl *skl);
139 int skl_free_dsp(struct skl *skl);
140 int skl_suspend_late_dsp(struct skl *skl);
141 int skl_suspend_dsp(struct skl *skl);
142 int skl_resume_dsp(struct skl *skl);
143 void skl_cleanup_resources(struct skl *skl);
144 const struct skl_dsp_ops *skl_get_dsp_ops(int pci_id);
145 void skl_update_d0i3c(struct device *dev, bool enable);
146 int skl_nhlt_create_sysfs(struct skl *skl);
147 void skl_nhlt_remove_sysfs(struct skl *skl);
148 void skl_get_clks(struct skl *skl, struct skl_ssp_clk *ssp_clks);
149 struct skl_clk_parent_src *skl_get_parent_clk(u8 clk_id);
150
151 struct skl_module_cfg;
152
153 #ifdef CONFIG_DEBUG_FS
154 struct skl_debug *skl_debugfs_init(struct skl *skl);
155 void skl_debug_init_module(struct skl_debug *d,
156                         struct snd_soc_dapm_widget *w,
157                         struct skl_module_cfg *mconfig);
158 #else
159 static inline struct skl_debug *skl_debugfs_init(struct skl *skl)
160 {
161         return NULL;
162 }
163 static inline void skl_debug_init_module(struct skl_debug *d,
164                                          struct snd_soc_dapm_widget *w,
165                                          struct skl_module_cfg *mconfig)
166 {}
167 #endif
168
169 #endif /* __SOUND_SOC_SKL_H */