[deliverable/linux.git] / sound / soc / intel / skylake / skl-topology.h

/*
 *  skl_topology.h - Intel HDA Platform topology header file
 *
 *  Copyright (C) 2014-15 Intel Corp
 *  Author: Jeeja KP <jeeja.kp@intel.com>
 *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 */

#ifndef __SKL_TOPOLOGY_H__
#define __SKL_TOPOLOGY_H__

#include <linux/types.h>

#include <sound/hdaudio_ext.h>
#include <sound/soc.h>
#include "skl.h"
#include "skl-tplg-interface.h"

#define BITS_PER_BYTE 8
#define MAX_TS_GROUPS 8
#define MAX_DMIC_TS_GROUPS 4
#define MAX_FIXED_DMIC_PARAMS_SIZE 727

/* Maximum number of coefficients up down mixer module */
#define UP_DOWN_MIXER_MAX_COEFF		6

#define MODULE_MAX_IN_PINS	8
#define MODULE_MAX_OUT_PINS	8

enum skl_channel_index {
	SKL_CHANNEL_LEFT = 0,
	SKL_CHANNEL_RIGHT = 1,
	SKL_CHANNEL_CENTER = 2,
	SKL_CHANNEL_LEFT_SURROUND = 3,
	SKL_CHANNEL_CENTER_SURROUND = 3,
	SKL_CHANNEL_RIGHT_SURROUND = 4,
	SKL_CHANNEL_LFE = 7,
	SKL_CHANNEL_INVALID = 0xF,
};

enum skl_bitdepth {
	SKL_DEPTH_8BIT = 8,
	SKL_DEPTH_16BIT = 16,
	SKL_DEPTH_24BIT = 24,
	SKL_DEPTH_32BIT = 32,
	SKL_DEPTH_INVALID
};


enum skl_s_freq {
	SKL_FS_8000 = 8000,
	SKL_FS_11025 = 11025,
	SKL_FS_12000 = 12000,
	SKL_FS_16000 = 16000,
	SKL_FS_22050 = 22050,
	SKL_FS_24000 = 24000,
	SKL_FS_32000 = 32000,
	SKL_FS_44100 = 44100,
	SKL_FS_48000 = 48000,
	SKL_FS_64000 = 64000,
	SKL_FS_88200 = 88200,
	SKL_FS_96000 = 96000,
	SKL_FS_128000 = 128000,
	SKL_FS_176400 = 176400,
	SKL_FS_192000 = 192000,
	SKL_FS_INVALID
};

enum skl_widget_type {
	SKL_WIDGET_VMIXER = 1,
	SKL_WIDGET_MIXER = 2,
	SKL_WIDGET_PGA = 3,
	SKL_WIDGET_MUX = 4
};

struct skl_audio_data_format {
	enum skl_s_freq s_freq;
	enum skl_bitdepth bit_depth;
	u32 channel_map;
	enum skl_ch_cfg ch_cfg;
	enum skl_interleaving interleaving;
	u8 number_of_channels;
	u8 valid_bit_depth;
	u8 sample_type;
	u8 reserved[1];
} __packed;

struct skl_base_cfg {
	u32 cps;
	u32 ibs;
	u32 obs;
	u32 is_pages;
	struct skl_audio_data_format audio_fmt;
};

struct skl_cpr_gtw_cfg {
	u32 node_id;
	u32 dma_buffer_size;
	u32 config_length;
	/* not mandatory; required only for DMIC/I2S */
	u32 config_data[1];
} __packed;

struct skl_cpr_cfg {
	struct skl_base_cfg base_cfg;
	struct skl_audio_data_format out_fmt;
	u32 cpr_feature_mask;
	struct skl_cpr_gtw_cfg gtw_cfg;
} __packed;


struct skl_src_module_cfg {
	struct skl_base_cfg base_cfg;
	enum skl_s_freq src_cfg;
} __packed;

struct notification_mask {
	u32 notify;
	u32 enable;
} __packed;

struct skl_up_down_mixer_cfg {
	struct skl_base_cfg base_cfg;
	enum skl_ch_cfg out_ch_cfg;
	/* This should be set to 1 if user coefficients are required */
	u32 coeff_sel;
	/* Pass the user coeff in this array */
	s32 coeff[UP_DOWN_MIXER_MAX_COEFF];
} __packed;

enum skl_dma_type {
	SKL_DMA_HDA_HOST_OUTPUT_CLASS = 0,
	SKL_DMA_HDA_HOST_INPUT_CLASS = 1,
	SKL_DMA_HDA_HOST_INOUT_CLASS = 2,
	SKL_DMA_HDA_LINK_OUTPUT_CLASS = 8,
	SKL_DMA_HDA_LINK_INPUT_CLASS = 9,
	SKL_DMA_HDA_LINK_INOUT_CLASS = 0xA,
	SKL_DMA_DMIC_LINK_INPUT_CLASS = 0xB,
	SKL_DMA_I2S_LINK_OUTPUT_CLASS = 0xC,
	SKL_DMA_I2S_LINK_INPUT_CLASS = 0xD,
};

union skl_ssp_dma_node {
	u8 val;
	struct {
		u8 time_slot_index:4;
		u8 i2s_instance:4;
	} dma_node;
};

union skl_connector_node_id {
	u32 val;
	struct {
		u32 vindex:8;
		u32 dma_type:4;
		u32 rsvd:20;
	} node;
};

struct skl_module_fmt {
	u32 channels;
	u32 s_freq;
	u32 bit_depth;
	u32 valid_bit_depth;
	u32 ch_cfg;
	u32 interleaving_style;
	u32 sample_type;
	u32 ch_map;
};

struct skl_module_cfg;

struct skl_module_inst_id {
	u32 module_id;
	u32 instance_id;
};

enum skl_module_pin_state {
	SKL_PIN_UNBIND = 0,
	SKL_PIN_BIND_DONE = 1,
};

struct skl_module_pin {
	struct skl_module_inst_id id;
	bool is_dynamic;
	bool in_use;
	enum skl_module_pin_state pin_state;
	struct skl_module_cfg *tgt_mcfg;
};

struct skl_specific_cfg {
	u32 caps_size;
	u32 *caps;
};

enum skl_pipe_state {
	SKL_PIPE_INVALID = 0,
	SKL_PIPE_CREATED = 1,
	SKL_PIPE_PAUSED = 2,
	SKL_PIPE_STARTED = 3
};

struct skl_pipe_module {
	struct snd_soc_dapm_widget *w;
	struct list_head node;
};

struct skl_pipe_params {
	u8 host_dma_id;
	u8 link_dma_id;
	u32 ch;
	u32 s_freq;
	u32 s_fmt;
	u8 linktype;
	int stream;
};

struct skl_pipe {
	u8 ppl_id;
	u8 pipe_priority;
	u16 conn_type;
	u32 memory_pages;
	struct skl_pipe_params *p_params;
	enum skl_pipe_state state;
	struct list_head w_list;
};

enum skl_module_state {
	SKL_MODULE_UNINIT = 0,
	SKL_MODULE_INIT_DONE = 1,
	SKL_MODULE_LOADED = 2,
	SKL_MODULE_UNLOADED = 3,
	SKL_MODULE_BIND_DONE = 4
};

struct skl_module_cfg {
	char guid[SKL_UUID_STR_SZ];
	struct skl_module_inst_id id;
	u8 domain;
	bool homogenous_inputs;
	bool homogenous_outputs;
	struct skl_module_fmt in_fmt[MODULE_MAX_IN_PINS];
	struct skl_module_fmt out_fmt[MODULE_MAX_OUT_PINS];
	u8 max_in_queue;
	u8 max_out_queue;
	u8 in_queue_mask;
	u8 out_queue_mask;
	u8 in_queue;
	u8 out_queue;
	u32 mcps;
	u32 ibs;
	u32 obs;
	u8 is_loadable;
	u8 core_id;
	u8 dev_type;
	u8 dma_id;
	u8 time_slot;
	u32 params_fixup;
	u32 converter;
	u32 vbus_id;
	struct skl_module_pin *m_in_pin;
	struct skl_module_pin *m_out_pin;
	enum skl_module_type m_type;
	enum skl_hw_conn_type  hw_conn_type;
	enum skl_module_state m_state;
	struct skl_pipe *pipe;
	struct skl_specific_cfg formats_config;
};

struct skl_pipeline {
	struct skl_pipe *pipe;
	struct list_head node;
};

static inline struct skl *get_skl_ctx(struct device *dev)
{
	struct hdac_ext_bus *ebus = dev_get_drvdata(dev);

	return ebus_to_skl(ebus);
}

int skl_tplg_be_update_params(struct snd_soc_dai *dai,
	struct skl_pipe_params *params);
void skl_tplg_set_be_dmic_config(struct snd_soc_dai *dai,
	struct skl_pipe_params *params, int stream);
int skl_tplg_init(struct snd_soc_platform *platform,
				struct hdac_ext_bus *ebus);
struct skl_module_cfg *skl_tplg_fe_get_cpr_module(
		struct snd_soc_dai *dai, int stream);
int skl_tplg_update_pipe_params(struct device *dev,
		struct skl_module_cfg *mconfig, struct skl_pipe_params *params);

int skl_create_pipeline(struct skl_sst *ctx, struct skl_pipe *pipe);

int skl_run_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);

int skl_pause_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);

int skl_delete_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);

int skl_stop_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);

int skl_init_module(struct skl_sst *ctx, struct skl_module_cfg *module_config);

int skl_bind_modules(struct skl_sst *ctx, struct skl_module_cfg
	*src_module, struct skl_module_cfg *dst_module);

int skl_unbind_modules(struct skl_sst *ctx, struct skl_module_cfg
	*src_module, struct skl_module_cfg *dst_module);

int skl_set_module_params(struct skl_sst *ctx, u32 *params, int size,
			u32 param_id, struct skl_module_cfg *mcfg);

enum skl_bitdepth skl_get_bit_depth(int params);
#endif
Commit	Line	Data
23db472b JK	1	/*
	2	* skl_topology.h - Intel HDA Platform topology header file
	3	*
	4	* Copyright (C) 2014-15 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 __SKL_TOPOLOGY_H__
	22	#define __SKL_TOPOLOGY_H__
	23
	24	#include <linux/types.h>
	25
	26	#include <sound/hdaudio_ext.h>
	27	#include <sound/soc.h>
	28	#include "skl.h"
	29	#include "skl-tplg-interface.h"
	30
	31	#define BITS_PER_BYTE 8
	32	#define MAX_TS_GROUPS 8
	33	#define MAX_DMIC_TS_GROUPS 4
	34	#define MAX_FIXED_DMIC_PARAMS_SIZE 727
	35
	36	/* Maximum number of coefficients up down mixer module */
	37	#define UP_DOWN_MIXER_MAX_COEFF 6
	38
4cd9899f HS	39	#define MODULE_MAX_IN_PINS 8
	40	#define MODULE_MAX_OUT_PINS 8
	41
23db472b JK	42	enum skl_channel_index {
	43	SKL_CHANNEL_LEFT = 0,
	44	SKL_CHANNEL_RIGHT = 1,
	45	SKL_CHANNEL_CENTER = 2,
	46	SKL_CHANNEL_LEFT_SURROUND = 3,
	47	SKL_CHANNEL_CENTER_SURROUND = 3,
	48	SKL_CHANNEL_RIGHT_SURROUND = 4,
	49	SKL_CHANNEL_LFE = 7,
	50	SKL_CHANNEL_INVALID = 0xF,
	51	};
	52
	53	enum skl_bitdepth {
	54	SKL_DEPTH_8BIT = 8,
	55	SKL_DEPTH_16BIT = 16,
	56	SKL_DEPTH_24BIT = 24,
	57	SKL_DEPTH_32BIT = 32,
	58	SKL_DEPTH_INVALID
	59	};
	60
23db472b JK	61
	62	enum skl_s_freq {
	63	SKL_FS_8000 = 8000,
	64	SKL_FS_11025 = 11025,
	65	SKL_FS_12000 = 12000,
	66	SKL_FS_16000 = 16000,
	67	SKL_FS_22050 = 22050,
	68	SKL_FS_24000 = 24000,
	69	SKL_FS_32000 = 32000,
	70	SKL_FS_44100 = 44100,
	71	SKL_FS_48000 = 48000,
	72	SKL_FS_64000 = 64000,
	73	SKL_FS_88200 = 88200,
	74	SKL_FS_96000 = 96000,
	75	SKL_FS_128000 = 128000,
	76	SKL_FS_176400 = 176400,
	77	SKL_FS_192000 = 192000,
	78	SKL_FS_INVALID
	79	};
	80
	81	enum skl_widget_type {
	82	SKL_WIDGET_VMIXER = 1,
	83	SKL_WIDGET_MIXER = 2,
	84	SKL_WIDGET_PGA = 3,
	85	SKL_WIDGET_MUX = 4
	86	};
	87
	88	struct skl_audio_data_format {
	89	enum skl_s_freq s_freq;
	90	enum skl_bitdepth bit_depth;
	91	u32 channel_map;
	92	enum skl_ch_cfg ch_cfg;
	93	enum skl_interleaving interleaving;
	94	u8 number_of_channels;
	95	u8 valid_bit_depth;
	96	u8 sample_type;
	97	u8 reserved[1];
	98	} __packed;
	99
	100	struct skl_base_cfg {
	101	u32 cps;
	102	u32 ibs;
	103	u32 obs;
	104	u32 is_pages;
	105	struct skl_audio_data_format audio_fmt;
	106	};
	107
	108	struct skl_cpr_gtw_cfg {
	109	u32 node_id;
	110	u32 dma_buffer_size;
	111	u32 config_length;
	112	/* not mandatory; required only for DMIC/I2S */
	113	u32 config_data[1];
	114	} __packed;
	115
	116	struct skl_cpr_cfg {
	117	struct skl_base_cfg base_cfg;
	118	struct skl_audio_data_format out_fmt;
	119	u32 cpr_feature_mask;
	120	struct skl_cpr_gtw_cfg gtw_cfg;
	121	} __packed;
	122
a0ffe48b HS	123
	124	struct skl_src_module_cfg {
	125	struct skl_base_cfg base_cfg;
	126	enum skl_s_freq src_cfg;
	127	} __packed;
	128
4e10996b JK	129	struct notification_mask {
	130	u32 notify;
	131	u32 enable;
	132	} __packed;
	133
a0ffe48b HS	134	struct skl_up_down_mixer_cfg {
	135	struct skl_base_cfg base_cfg;
	136	enum skl_ch_cfg out_ch_cfg;
	137	/* This should be set to 1 if user coefficients are required */
	138	u32 coeff_sel;
	139	/* Pass the user coeff in this array */
	140	s32 coeff[UP_DOWN_MIXER_MAX_COEFF];
	141	} __packed;
	142
23db472b JK	143	enum skl_dma_type {
	144	SKL_DMA_HDA_HOST_OUTPUT_CLASS = 0,
	145	SKL_DMA_HDA_HOST_INPUT_CLASS = 1,
	146	SKL_DMA_HDA_HOST_INOUT_CLASS = 2,
	147	SKL_DMA_HDA_LINK_OUTPUT_CLASS = 8,
	148	SKL_DMA_HDA_LINK_INPUT_CLASS = 9,
	149	SKL_DMA_HDA_LINK_INOUT_CLASS = 0xA,
	150	SKL_DMA_DMIC_LINK_INPUT_CLASS = 0xB,
	151	SKL_DMA_I2S_LINK_OUTPUT_CLASS = 0xC,
	152	SKL_DMA_I2S_LINK_INPUT_CLASS = 0xD,
	153	};
	154
	155	union skl_ssp_dma_node {
	156	u8 val;
	157	struct {
d7b18813	158	u8 time_slot_index:4;
23db472b JK	159	u8 i2s_instance:4;
	160	} dma_node;
	161	};
	162
	163	union skl_connector_node_id {
	164	u32 val;
	165	struct {
	166	u32 vindex:8;
	167	u32 dma_type:4;
	168	u32 rsvd:20;
	169	} node;
	170	};
	171
	172	struct skl_module_fmt {
	173	u32 channels;
	174	u32 s_freq;
	175	u32 bit_depth;
	176	u32 valid_bit_depth;
	177	u32 ch_cfg;
4cd9899f HS	178	u32 interleaving_style;
	179	u32 sample_type;
	180	u32 ch_map;
23db472b JK	181	};
23db472b JK	182
4f745708 JK	183	struct skl_module_cfg;
4f745708 JK	184
23db472b JK	185	struct skl_module_inst_id {
	186	u32 module_id;
	187	u32 instance_id;
	188	};
	189
4f745708 JK	190	enum skl_module_pin_state {
	191	SKL_PIN_UNBIND = 0,
	192	SKL_PIN_BIND_DONE = 1,
	193	};
	194
23db472b JK	195	struct skl_module_pin {
23db472b JK	196	struct skl_module_inst_id id;
23db472b JK	197	bool is_dynamic;
23db472b JK	198	bool in_use;
4f745708 JK	199	enum skl_module_pin_state pin_state;
4f745708 JK	200	struct skl_module_cfg *tgt_mcfg;
23db472b JK	201	};
	202
	203	struct skl_specific_cfg {
	204	u32 caps_size;
	205	u32 *caps;
	206	};
	207
	208	enum skl_pipe_state {
	209	SKL_PIPE_INVALID = 0,
	210	SKL_PIPE_CREATED = 1,
	211	SKL_PIPE_PAUSED = 2,
	212	SKL_PIPE_STARTED = 3
	213	};
	214
	215	struct skl_pipe_module {
	216	struct snd_soc_dapm_widget *w;
	217	struct list_head node;
	218	};
	219
	220	struct skl_pipe_params {
	221	u8 host_dma_id;
	222	u8 link_dma_id;
	223	u32 ch;
	224	u32 s_freq;
	225	u32 s_fmt;
	226	u8 linktype;
	227	int stream;
	228	};
	229
	230	struct skl_pipe {
	231	u8 ppl_id;
	232	u8 pipe_priority;
	233	u16 conn_type;
	234	u32 memory_pages;
	235	struct skl_pipe_params *p_params;
	236	enum skl_pipe_state state;
	237	struct list_head w_list;
	238	};
	239
	240	enum skl_module_state {
	241	SKL_MODULE_UNINIT = 0,
	242	SKL_MODULE_INIT_DONE = 1,
	243	SKL_MODULE_LOADED = 2,
	244	SKL_MODULE_UNLOADED = 3,
	245	SKL_MODULE_BIND_DONE = 4
	246	};
	247
	248	struct skl_module_cfg {
65aecfa8	249	char guid[SKL_UUID_STR_SZ];
23db472b	250	struct skl_module_inst_id id;
04afbbbb	251	u8 domain;
4cd9899f HS	252	bool homogenous_inputs;
	253	bool homogenous_outputs;
	254	struct skl_module_fmt in_fmt[MODULE_MAX_IN_PINS];
	255	struct skl_module_fmt out_fmt[MODULE_MAX_OUT_PINS];
23db472b JK	256	u8 max_in_queue;
	257	u8 max_out_queue;
	258	u8 in_queue_mask;
	259	u8 out_queue_mask;
	260	u8 in_queue;
	261	u8 out_queue;
	262	u32 mcps;
	263	u32 ibs;
	264	u32 obs;
	265	u8 is_loadable;
	266	u8 core_id;
	267	u8 dev_type;
	268	u8 dma_id;
	269	u8 time_slot;
	270	u32 params_fixup;
	271	u32 converter;
	272	u32 vbus_id;
	273	struct skl_module_pin *m_in_pin;
	274	struct skl_module_pin *m_out_pin;
	275	enum skl_module_type m_type;
	276	enum skl_hw_conn_type hw_conn_type;
	277	enum skl_module_state m_state;
	278	struct skl_pipe *pipe;
	279	struct skl_specific_cfg formats_config;
	280	};
a0ffe48b	281
e4e2d2f4 JK	282	struct skl_pipeline {
	283	struct skl_pipe *pipe;
	284	struct list_head node;
	285	};
	286
d93f8e55 VK	287	static inline struct skl get_skl_ctx(struct device dev)
	288	{
	289	struct hdac_ext_bus *ebus = dev_get_drvdata(dev);
	290
	291	return ebus_to_skl(ebus);
	292	}
	293
cfb0a873 VK	294	int skl_tplg_be_update_params(struct snd_soc_dai *dai,
	295	struct skl_pipe_params *params);
	296	void skl_tplg_set_be_dmic_config(struct snd_soc_dai *dai,
	297	struct skl_pipe_params *params, int stream);
	298	int skl_tplg_init(struct snd_soc_platform *platform,
	299	struct hdac_ext_bus *ebus);
	300	struct skl_module_cfg *skl_tplg_fe_get_cpr_module(
	301	struct snd_soc_dai *dai, int stream);
	302	int skl_tplg_update_pipe_params(struct device *dev,
	303	struct skl_module_cfg mconfig, struct skl_pipe_params params);
	304
c9b1e834 JK	305	int skl_create_pipeline(struct skl_sst ctx, struct skl_pipe pipe);
	306
	307	int skl_run_pipe(struct skl_sst ctx, struct skl_pipe pipe);
	308
	309	int skl_pause_pipe(struct skl_sst ctx, struct skl_pipe pipe);
	310
	311	int skl_delete_pipe(struct skl_sst ctx, struct skl_pipe pipe);
	312
	313	int skl_stop_pipe(struct skl_sst ctx, struct skl_pipe pipe);
	314
9939a9c3	315	int skl_init_module(struct skl_sst ctx, struct skl_module_cfg module_config);
beb73b26 JK	316
	317	int skl_bind_modules(struct skl_sst *ctx, struct skl_module_cfg
	318	src_module, struct skl_module_cfg dst_module);
	319
	320	int skl_unbind_modules(struct skl_sst *ctx, struct skl_module_cfg
	321	src_module, struct skl_module_cfg dst_module);
	322
9939a9c3 JK	323	int skl_set_module_params(struct skl_sst ctx, u32 params, int size,
	324	u32 param_id, struct skl_module_cfg *mcfg);
	325
23db472b JK	326	enum skl_bitdepth skl_get_bit_depth(int params);
23db472b JK	327	#endif