Orange Pi5 kernel

^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   1) /* SPDX-License-Identifier: GPL-2.0-only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   3)  * Copyright(c) 2020 Intel Corporation. All rights reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   4)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   5)  * Author: Cezary Rojewski <cezary.rojewski@intel.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   6)  */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   7) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   8) #ifndef __SND_SOC_INTEL_CATPT_MSG_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   9) #define __SND_SOC_INTEL_CATPT_MSG_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  10) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  11) struct catpt_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  12) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  13) /* IPC messages base types  */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  14) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  15) enum catpt_reply_status {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  16) 	CATPT_REPLY_SUCCESS = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  17) 	CATPT_REPLY_ERROR_INVALID_PARAM = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  18) 	CATPT_REPLY_UNKNOWN_MESSAGE_TYPE = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  19) 	CATPT_REPLY_OUT_OF_RESOURCES = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  20) 	CATPT_REPLY_BUSY = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  21) 	CATPT_REPLY_PENDING = 5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  22) 	CATPT_REPLY_FAILURE = 6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  23) 	CATPT_REPLY_INVALID_REQUEST = 7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  24) 	CATPT_REPLY_UNINITIALIZED = 8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  25) 	CATPT_REPLY_NOT_FOUND = 9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  26) 	CATPT_REPLY_SOURCE_NOT_STARTED = 10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  27) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  28) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  29) /* GLOBAL messages */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  30) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  31) enum catpt_global_msg_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  32) 	CATPT_GLB_GET_FW_VERSION = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  33) 	CATPT_GLB_ALLOCATE_STREAM = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  34) 	CATPT_GLB_FREE_STREAM = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  35) 	CATPT_GLB_STREAM_MESSAGE = 6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  36) 	CATPT_GLB_REQUEST_CORE_DUMP = 7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  37) 	CATPT_GLB_SET_DEVICE_FORMATS = 10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  38) 	CATPT_GLB_ENTER_DX_STATE = 12,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  39) 	CATPT_GLB_GET_MIXER_STREAM_INFO = 13,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  40) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  41) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  42) union catpt_global_msg {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  43) 	u32 val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  44) 	struct {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  45) 		u32 status:5;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  46) 		u32 context:19; /* stream or module specific */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  47) 		u32 global_msg_type:5;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  48) 		u32 fw_ready:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  49) 		u32 done:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  50) 		u32 busy:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  51) 	};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  52) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  53) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  54) #define CATPT_MSG(hdr) { .val = hdr }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  55) #define CATPT_GLOBAL_MSG(msg_type) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  56) 	{ .global_msg_type = CATPT_GLB_##msg_type }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  57) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  58) #define BUILD_HASH_SIZE		40
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  59) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  60) struct catpt_fw_version {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  61) 	u8 build;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  62) 	u8 minor;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  63) 	u8 major;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  64) 	u8 type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  65) 	u8 build_hash[BUILD_HASH_SIZE];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  66) 	u32 log_providers_hash;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  67) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  68) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  69) int catpt_ipc_get_fw_version(struct catpt_dev *cdev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  70) 			     struct catpt_fw_version *version);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  71) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  72) enum catpt_pin_id {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  73) 	CATPT_PIN_ID_SYSTEM = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  74) 	CATPT_PIN_ID_REFERENCE = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  75) 	CATPT_PIN_ID_CAPTURE1 = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  76) 	CATPT_PIN_ID_CAPTURE2 = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  77) 	CATPT_PIN_ID_OFFLOAD1 = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  78) 	CATPT_PIN_ID_OFFLOAD2 = 5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  79) 	CATPT_PIN_ID_MIXER = 7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  80) 	CATPT_PIN_ID_BLUETOOTH_CAPTURE = 8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  81) 	CATPT_PIN_ID_BLUETOOTH_RENDER = 9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  82) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  83) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  84) enum catpt_path_id {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  85) 	CATPT_PATH_SSP0_OUT = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  86) 	CATPT_PATH_SSP0_IN = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  87) 	CATPT_PATH_SSP1_OUT = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  88) 	CATPT_PATH_SSP1_IN = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  89) 	/* duplicated audio in capture path */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  90) 	CATPT_PATH_SSP0_IN_DUP = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  91) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  92) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  93) enum catpt_stream_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  94) 	CATPT_STRM_TYPE_RENDER = 0, /* offload */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  95) 	CATPT_STRM_TYPE_SYSTEM = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  96) 	CATPT_STRM_TYPE_CAPTURE = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  97) 	CATPT_STRM_TYPE_LOOPBACK = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  98) 	CATPT_STRM_TYPE_BLUETOOTH_RENDER = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  99) 	CATPT_STRM_TYPE_BLUETOOTH_CAPTURE = 5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) enum catpt_format_id {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) 	CATPT_FORMAT_PCM = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) 	CATPT_FORMAT_MP3 = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) 	CATPT_FORMAT_AAC = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) 	CATPT_FORMAT_WMA = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) enum catpt_channel_index {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) 	CATPT_CHANNEL_LEFT = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) 	CATPT_CHANNEL_CENTER = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) 	CATPT_CHANNEL_RIGHT = 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) 	CATPT_CHANNEL_LEFT_SURROUND = 0x3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) 	CATPT_CHANNEL_CENTER_SURROUND = 0x3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) 	CATPT_CHANNEL_RIGHT_SURROUND = 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) 	CATPT_CHANNEL_LFE = 0x7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) 	CATPT_CHANNEL_INVALID = 0xF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) enum catpt_channel_config {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) 	CATPT_CHANNEL_CONFIG_MONO	= 0, /* One channel only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) 	CATPT_CHANNEL_CONFIG_STEREO	= 1, /* L & R */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) 	CATPT_CHANNEL_CONFIG_2_POINT_1	= 2, /* L, R & LFE; PCM only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) 	CATPT_CHANNEL_CONFIG_3_POINT_0	= 3, /* L, C & R; MP3 & AAC only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) 	CATPT_CHANNEL_CONFIG_3_POINT_1	= 4, /* L, C, R & LFE; PCM only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) 	CATPT_CHANNEL_CONFIG_QUATRO	= 5, /* L, R, Ls & Rs; PCM only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) 	CATPT_CHANNEL_CONFIG_4_POINT_0	= 6, /* L, C, R & Cs; MP3 & AAC only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) 	CATPT_CHANNEL_CONFIG_5_POINT_0	= 7, /* L, C, R, Ls & Rs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) 	CATPT_CHANNEL_CONFIG_5_POINT_1	= 8, /* L, C, R, Ls, Rs & LFE */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) 	CATPT_CHANNEL_CONFIG_DUAL_MONO	= 9, /* One channel replicated in two */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) 	CATPT_CHANNEL_CONFIG_INVALID	= 10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) enum catpt_interleaving_style {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) 	CATPT_INTERLEAVING_PER_CHANNEL	= 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) 	CATPT_INTERLEAVING_PER_SAMPLE	= 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) struct catpt_audio_format {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) 	u32 sample_rate;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) 	u32 bit_depth;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) 	u32 channel_map;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) 	u32 channel_config;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) 	u32 interleaving;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) 	u8 num_channels;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) 	u8 valid_bit_depth;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) 	u8 reserved[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) struct catpt_ring_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) 	u32 page_table_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) 	u32 num_pages;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) 	u32 size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) 	u32 offset;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) 	u32 ring_first_page_pfn;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) #define CATPT_MODULE_COUNT (CATPT_MODID_LAST + 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) enum catpt_module_id {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) 	CATPT_MODID_BASE_FW		= 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) 	CATPT_MODID_MP3			= 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) 	CATPT_MODID_AAC_5_1		= 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) 	CATPT_MODID_AAC_2_0		= 0x3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) 	CATPT_MODID_SRC			= 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) 	CATPT_MODID_WAVES		= 0x5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) 	CATPT_MODID_DOLBY		= 0x6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) 	CATPT_MODID_BOOST		= 0x7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) 	CATPT_MODID_LPAL		= 0x8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) 	CATPT_MODID_DTS			= 0x9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) 	CATPT_MODID_PCM_CAPTURE		= 0xA,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) 	CATPT_MODID_PCM_SYSTEM		= 0xB,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) 	CATPT_MODID_PCM_REFERENCE	= 0xC,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) 	CATPT_MODID_PCM			= 0xD, /* offload */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) 	CATPT_MODID_BLUETOOTH_RENDER	= 0xE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) 	CATPT_MODID_BLUETOOTH_CAPTURE	= 0xF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) 	CATPT_MODID_LAST		= CATPT_MODID_BLUETOOTH_CAPTURE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) struct catpt_module_entry {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) 	u32 module_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) 	u32 entry_point;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) struct catpt_module_map {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) 	u8 num_entries;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) 	struct catpt_module_entry entries[];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) struct catpt_memory_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) 	u32 offset;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) 	u32 size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) #define CATPT_CHANNELS_MAX	4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) #define CATPT_ALL_CHANNELS_MASK	UINT_MAX
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) struct catpt_stream_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) 	u32 stream_hw_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) 	u32 reserved;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) 	u32 read_pos_regaddr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) 	u32 pres_pos_regaddr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) 	u32 peak_meter_regaddr[CATPT_CHANNELS_MAX];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) 	u32 volume_regaddr[CATPT_CHANNELS_MAX];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) int catpt_ipc_alloc_stream(struct catpt_dev *cdev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) 			   enum catpt_path_id path_id,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) 			   enum catpt_stream_type type,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) 			   struct catpt_audio_format *afmt,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) 			   struct catpt_ring_info *rinfo,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) 			   u8 num_modules,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) 			   struct catpt_module_entry *modules,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) 			   struct resource *persistent,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) 			   struct resource *scratch,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) 			   struct catpt_stream_info *sinfo);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) int catpt_ipc_free_stream(struct catpt_dev *cdev, u8 stream_hw_id);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) enum catpt_ssp_iface {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) 	CATPT_SSP_IFACE_0 = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221) 	CATPT_SSP_IFACE_1 = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) 	CATPT_SSP_IFACE_LAST = CATPT_SSP_IFACE_1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) #define CATPT_SSP_COUNT (CATPT_SSP_IFACE_LAST + 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) enum catpt_mclk_frequency {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) 	CATPT_MCLK_OFF = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) 	CATPT_MCLK_FREQ_6_MHZ = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) 	CATPT_MCLK_FREQ_21_MHZ = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231) 	CATPT_MCLK_FREQ_24_MHZ = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) enum catpt_ssp_mode {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235) 	CATPT_SSP_MODE_I2S_CONSUMER = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236) 	CATPT_SSP_MODE_I2S_PROVIDER = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) 	CATPT_SSP_MODE_TDM_PROVIDER = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240) struct catpt_ssp_device_format {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) 	u32 iface;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) 	u32 mclk;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) 	u32 mode;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) 	u16 clock_divider;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) 	u8 channels;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) int catpt_ipc_set_device_format(struct catpt_dev *cdev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) 				struct catpt_ssp_device_format *devfmt);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) enum catpt_dx_state {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) 	CATPT_DX_STATE_D3 = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) enum catpt_dx_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) 	CATPT_DX_TYPE_FW_IMAGE = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) 	CATPT_DX_TYPE_MEMORY_DUMP = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260) struct catpt_save_meminfo {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261) 	u32 offset;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262) 	u32 size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263) 	u32 source;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266) #define SAVE_MEMINFO_MAX	14
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) struct catpt_dx_context {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269) 	u32 num_meminfo;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270) 	struct catpt_save_meminfo meminfo[SAVE_MEMINFO_MAX];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273) int catpt_ipc_enter_dxstate(struct catpt_dev *cdev, enum catpt_dx_state state,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274) 			    struct catpt_dx_context *context);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) struct catpt_mixer_stream_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) 	u32 mixer_hw_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) 	u32 peak_meter_regaddr[CATPT_CHANNELS_MAX];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) 	u32 volume_regaddr[CATPT_CHANNELS_MAX];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) int catpt_ipc_get_mixer_stream_info(struct catpt_dev *cdev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) 				    struct catpt_mixer_stream_info *info);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285) /* STREAM messages */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287) enum catpt_stream_msg_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288) 	CATPT_STRM_RESET_STREAM = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289) 	CATPT_STRM_PAUSE_STREAM = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) 	CATPT_STRM_RESUME_STREAM = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291) 	CATPT_STRM_STAGE_MESSAGE = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) 	CATPT_STRM_NOTIFICATION = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295) enum catpt_stage_action {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) 	CATPT_STG_SET_VOLUME = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) 	CATPT_STG_SET_WRITE_POSITION = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) 	CATPT_STG_MUTE_LOOPBACK = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301) union catpt_stream_msg {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) 	u32 val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) 	struct {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304) 		u32 status:5;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) 		u32 reserved:7;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) 		u32 stage_action:4;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) 		u32 stream_hw_id:4;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) 		u32 stream_msg_type:4;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) 		u32 global_msg_type:5;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) 		u32 fw_ready:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) 		u32 done:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312) 		u32 busy:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313) 	};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316) #define CATPT_STREAM_MSG(msg_type) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317) { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) 	.stream_msg_type = CATPT_STRM_##msg_type, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319) 	.global_msg_type = CATPT_GLB_STREAM_MESSAGE }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320) #define CATPT_STAGE_MSG(msg_type) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322) 	.stage_action = CATPT_STG_##msg_type, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323) 	.stream_msg_type = CATPT_STRM_STAGE_MESSAGE, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324) 	.global_msg_type = CATPT_GLB_STREAM_MESSAGE }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) int catpt_ipc_reset_stream(struct catpt_dev *cdev, u8 stream_hw_id);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327) int catpt_ipc_pause_stream(struct catpt_dev *cdev, u8 stream_hw_id);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328) int catpt_ipc_resume_stream(struct catpt_dev *cdev, u8 stream_hw_id);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330) /* STREAM messages - STAGE subtype */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332) enum catpt_audio_curve_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333) 	CATPT_AUDIO_CURVE_NONE = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) 	CATPT_AUDIO_CURVE_WINDOWS_FADE = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337) int catpt_ipc_set_volume(struct catpt_dev *cdev, u8 stream_hw_id,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338) 			 u32 channel, u32 volume,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339) 			 u32 curve_duration,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) 			 enum catpt_audio_curve_type curve_type);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342) int catpt_ipc_set_write_pos(struct catpt_dev *cdev, u8 stream_hw_id,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343) 			    u32 pos, bool eob, bool ll);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 344) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 345) int catpt_ipc_mute_loopback(struct catpt_dev *cdev, u8 stream_hw_id, bool mute);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 346) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 347) /* NOTIFICATION messages */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 348) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 349) enum catpt_notify_reason {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 350) 	CATPT_NOTIFY_POSITION_CHANGED = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 351) 	CATPT_NOTIFY_GLITCH_OCCURRED = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 352) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 353) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 354) union catpt_notify_msg {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 355) 	u32 val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 356) 	struct {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 357) 		u32 mailbox_address:29;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 358) 		u32 fw_ready:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 359) 		u32 done:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 360) 		u32 busy:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 361) 	};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 362) 	struct {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 363) 		u32 status:5;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 364) 		u32 reserved:7;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 365) 		u32 notify_reason:4;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 366) 		u32 stream_hw_id:4;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 367) 		u32 stream_msg_type:4;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 368) 		u32 global_msg_type:5;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 369) 		u32 hdr:3; /* fw_ready, done, busy */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 370) 	};
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 371) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 372) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 373) #define FW_INFO_SIZE_MAX	100
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 374) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 375) struct catpt_fw_ready {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 376) 	u32 inbox_offset;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 377) 	u32 outbox_offset;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 378) 	u32 inbox_size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 379) 	u32 outbox_size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 380) 	u32 fw_info_size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 381) 	char fw_info[FW_INFO_SIZE_MAX];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 382) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 383) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 384) struct catpt_notify_position {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 385) 	u32 stream_position;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 386) 	u32 fw_cycle_count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 387) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 388) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 389) enum catpt_glitch_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 390) 	CATPT_GLITCH_UNDERRUN = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 391) 	CATPT_GLITCH_DECODER_ERROR = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 392) 	CATPT_GLITCH_DOUBLED_WRITE_POS = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 393) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 394) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 395) struct catpt_notify_glitch {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 396) 	u32 type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 397) 	u64 presentation_pos;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 398) 	u32 write_pos;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 399) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 400) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 401) #endif