sound/soc/intel/skylake/skl-topology.h - kernel/msm-4.19 - Gitiles

 /*
  *  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

 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_interleaving {
 	/* [s1_ch1...s1_chN,...,sM_ch1...sM_chN] */
 	SKL_INTERLEAVING_PER_CHANNEL = 0,
 	/* [s1_ch1...sM_ch1,...,s1_chN...sM_chN] */
 	SKL_INTERLEAVING_PER_SAMPLE = 1,
 };

 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 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 dual_mono:1;
 		u8 time_slot:3;
 		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;
 };

 struct skl_module_inst_id {
 	u32 module_id;
 	u32 instance_id;
 };

 struct skl_module_pin {
 	struct skl_module_inst_id id;
 	u8 pin_index;
 	bool is_dynamic;
 	bool in_use;
 };

 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 {
 	struct skl_module_inst_id id;
 	struct skl_module_fmt in_fmt;
 	struct skl_module_fmt out_fmt;
 	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;
 };

 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,
 	char *param);

 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);

 enum skl_bitdepth skl_get_bit_depth(int params);
 #endif
	/*
	* 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

	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_interleaving {
	/* [s1_ch1...s1_chN,...,sM_ch1...sM_chN] */
	SKL_INTERLEAVING_PER_CHANNEL = 0,
	/* [s1_ch1...sM_ch1,...,s1_chN...sM_chN] */
	SKL_INTERLEAVING_PER_SAMPLE = 1,
	};

	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 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 dual_mono:1;
	u8 time_slot:3;
	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;
	};

	struct skl_module_inst_id {
	u32 module_id;
	u32 instance_id;
	};

	struct skl_module_pin {
	struct skl_module_inst_id id;
	u8 pin_index;
	bool is_dynamic;
	bool in_use;
	};

	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 {
	struct skl_module_inst_id id;
	struct skl_module_fmt in_fmt;
	struct skl_module_fmt out_fmt;
	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;
	};

	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,
	char *param);

	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);

	enum skl_bitdepth skl_get_bit_depth(int params);
	#endif