Linux 4.15.6
[linux/fpc-iii.git] / sound / soc / intel / skylake / skl-sst-ipc.h
blob55f2d2ce09df4017fc0c27a8229e5696dc4834d4
1 /*
2 * Intel SKL IPC Support
4 * Copyright (C) 2014-15, Intel Corporation.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as version 2, as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
16 #ifndef __SKL_IPC_H
17 #define __SKL_IPC_H
19 #include <linux/irqreturn.h>
20 #include "../common/sst-ipc.h"
22 struct sst_dsp;
23 struct skl_sst;
24 struct sst_generic_ipc;
26 enum skl_ipc_pipeline_state {
27 PPL_INVALID_STATE = 0,
28 PPL_UNINITIALIZED = 1,
29 PPL_RESET = 2,
30 PPL_PAUSED = 3,
31 PPL_RUNNING = 4,
32 PPL_ERROR_STOP = 5,
33 PPL_SAVED = 6,
34 PPL_RESTORED = 7
37 struct skl_ipc_dxstate_info {
38 u32 core_mask;
39 u32 dx_mask;
42 struct skl_ipc_header {
43 u32 primary;
44 u32 extension;
47 struct skl_dsp_cores {
48 unsigned int count;
49 enum skl_dsp_states *state;
50 int *usage_count;
53 /**
54 * skl_d0i3_data: skl D0i3 counters data struct
56 * @streaming: Count of usecases that can attempt streaming D0i3
57 * @non_streaming: Count of usecases that can attempt non-streaming D0i3
58 * @non_d0i3: Count of usecases that cannot attempt D0i3
59 * @state: current state
60 * @work: D0i3 worker thread
62 struct skl_d0i3_data {
63 int streaming;
64 int non_streaming;
65 int non_d0i3;
66 enum skl_dsp_d0i3_states state;
67 struct delayed_work work;
70 #define SKL_LIB_NAME_LENGTH 128
71 #define SKL_MAX_LIB 16
73 struct skl_lib_info {
74 char name[SKL_LIB_NAME_LENGTH];
75 const struct firmware *fw;
78 struct skl_sst {
79 struct device *dev;
80 struct sst_dsp *dsp;
82 /* boot */
83 wait_queue_head_t boot_wait;
84 bool boot_complete;
86 /* module load */
87 wait_queue_head_t mod_load_wait;
88 bool mod_load_complete;
89 bool mod_load_status;
91 /* IPC messaging */
92 struct sst_generic_ipc ipc;
94 /* callback for miscbdge */
95 void (*enable_miscbdcge)(struct device *dev, bool enable);
96 /* Is CGCTL.MISCBDCGE disabled */
97 bool miscbdcg_disabled;
99 /* Populate module information */
100 struct list_head uuid_list;
102 /* Is firmware loaded */
103 bool fw_loaded;
105 /* first boot ? */
106 bool is_first_boot;
108 /* multi-core */
109 struct skl_dsp_cores cores;
111 /* library info */
112 struct skl_lib_info lib_info[SKL_MAX_LIB];
113 int lib_count;
115 /* Callback to update D0i3C register */
116 void (*update_d0i3c)(struct device *dev, bool enable);
118 struct skl_d0i3_data d0i3;
120 const struct skl_dsp_ops *dsp_ops;
123 struct skl_ipc_init_instance_msg {
124 u32 module_id;
125 u32 instance_id;
126 u16 param_data_size;
127 u8 ppl_instance_id;
128 u8 core_id;
129 u8 domain;
132 struct skl_ipc_bind_unbind_msg {
133 u32 module_id;
134 u32 instance_id;
135 u32 dst_module_id;
136 u32 dst_instance_id;
137 u8 src_queue;
138 u8 dst_queue;
139 bool bind;
142 struct skl_ipc_large_config_msg {
143 u32 module_id;
144 u32 instance_id;
145 u32 large_param_id;
146 u32 param_data_size;
149 struct skl_ipc_d0ix_msg {
150 u32 module_id;
151 u32 instance_id;
152 u8 streaming;
153 u8 wake;
156 #define SKL_IPC_BOOT_MSECS 3000
158 #define SKL_IPC_D3_MASK 0
159 #define SKL_IPC_D0_MASK 3
161 irqreturn_t skl_dsp_irq_thread_handler(int irq, void *context);
163 int skl_ipc_create_pipeline(struct sst_generic_ipc *sst_ipc,
164 u16 ppl_mem_size, u8 ppl_type, u8 instance_id, u8 lp_mode);
166 int skl_ipc_delete_pipeline(struct sst_generic_ipc *sst_ipc, u8 instance_id);
168 int skl_ipc_set_pipeline_state(struct sst_generic_ipc *sst_ipc,
169 u8 instance_id, enum skl_ipc_pipeline_state state);
171 int skl_ipc_save_pipeline(struct sst_generic_ipc *ipc,
172 u8 instance_id, int dma_id);
174 int skl_ipc_restore_pipeline(struct sst_generic_ipc *ipc, u8 instance_id);
176 int skl_ipc_init_instance(struct sst_generic_ipc *sst_ipc,
177 struct skl_ipc_init_instance_msg *msg, void *param_data);
179 int skl_ipc_bind_unbind(struct sst_generic_ipc *sst_ipc,
180 struct skl_ipc_bind_unbind_msg *msg);
182 int skl_ipc_load_modules(struct sst_generic_ipc *ipc,
183 u8 module_cnt, void *data);
185 int skl_ipc_unload_modules(struct sst_generic_ipc *ipc,
186 u8 module_cnt, void *data);
188 int skl_ipc_set_dx(struct sst_generic_ipc *ipc,
189 u8 instance_id, u16 module_id, struct skl_ipc_dxstate_info *dx);
191 int skl_ipc_set_large_config(struct sst_generic_ipc *ipc,
192 struct skl_ipc_large_config_msg *msg, u32 *param);
194 int skl_ipc_get_large_config(struct sst_generic_ipc *ipc,
195 struct skl_ipc_large_config_msg *msg, u32 *param);
197 int skl_sst_ipc_load_library(struct sst_generic_ipc *ipc,
198 u8 dma_id, u8 table_id, bool wait);
200 int skl_ipc_set_d0ix(struct sst_generic_ipc *ipc,
201 struct skl_ipc_d0ix_msg *msg);
203 int skl_ipc_check_D0i0(struct sst_dsp *dsp, bool state);
205 void skl_ipc_int_enable(struct sst_dsp *dsp);
206 void skl_ipc_op_int_enable(struct sst_dsp *ctx);
207 void skl_ipc_op_int_disable(struct sst_dsp *ctx);
208 void skl_ipc_int_disable(struct sst_dsp *dsp);
210 bool skl_ipc_int_status(struct sst_dsp *dsp);
211 void skl_ipc_free(struct sst_generic_ipc *ipc);
212 int skl_ipc_init(struct device *dev, struct skl_sst *skl);
213 void skl_clear_module_cnt(struct sst_dsp *ctx);
215 void skl_ipc_process_reply(struct sst_generic_ipc *ipc,
216 struct skl_ipc_header header);
217 int skl_ipc_process_notification(struct sst_generic_ipc *ipc,
218 struct skl_ipc_header header);
219 void skl_ipc_tx_data_copy(struct ipc_message *msg, char *tx_data,
220 size_t tx_size);
221 #endif /* __SKL_IPC_H */