1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */ 2 /* Copyright(c) 2015-17 Intel Corporation. */ 3 4 #ifndef __SDW_INTEL_H 5 #define __SDW_INTEL_H 6 7 #include <linux/irqreturn.h> 8 #include <linux/soundwire/sdw.h> 9 10 #define SDW_SHIM_BASE 0x2C000 11 #define SDW_ALH_BASE 0x2C800 12 #define SDW_SHIM_BASE_ACE 0x38000 13 #define SDW_ALH_BASE_ACE 0x24000 14 #define SDW_LINK_BASE 0x30000 15 #define SDW_LINK_SIZE 0x10000 16 17 /* Intel SHIM Registers Definition */ 18 /* LCAP */ 19 #define SDW_SHIM_LCAP 0x0 20 #define SDW_SHIM_LCAP_LCOUNT_MASK GENMASK(2, 0) 21 22 /* LCTL */ 23 #define SDW_SHIM_LCTL 0x4 24 25 #define SDW_SHIM_LCTL_SPA BIT(0) 26 #define SDW_SHIM_LCTL_SPA_MASK GENMASK(3, 0) 27 #define SDW_SHIM_LCTL_CPA BIT(8) 28 #define SDW_SHIM_LCTL_CPA_MASK GENMASK(11, 8) 29 30 /* SYNC */ 31 #define SDW_SHIM_SYNC 0xC 32 33 #define SDW_SHIM_SYNC_SYNCPRD_VAL_24 (24000 / SDW_CADENCE_GSYNC_KHZ - 1) 34 #define SDW_SHIM_SYNC_SYNCPRD_VAL_38_4 (38400 / SDW_CADENCE_GSYNC_KHZ - 1) 35 #define SDW_SHIM_SYNC_SYNCPRD GENMASK(14, 0) 36 #define SDW_SHIM_SYNC_SYNCCPU BIT(15) 37 #define SDW_SHIM_SYNC_CMDSYNC_MASK GENMASK(19, 16) 38 #define SDW_SHIM_SYNC_CMDSYNC BIT(16) 39 #define SDW_SHIM_SYNC_SYNCGO BIT(24) 40 41 /* Control stream capabililities and channel mask */ 42 #define SDW_SHIM_CTLSCAP(x) (0x010 + 0x60 * (x)) 43 #define SDW_SHIM_CTLS0CM(x) (0x012 + 0x60 * (x)) 44 #define SDW_SHIM_CTLS1CM(x) (0x014 + 0x60 * (x)) 45 #define SDW_SHIM_CTLS2CM(x) (0x016 + 0x60 * (x)) 46 #define SDW_SHIM_CTLS3CM(x) (0x018 + 0x60 * (x)) 47 48 /* PCM Stream capabilities */ 49 #define SDW_SHIM_PCMSCAP(x) (0x020 + 0x60 * (x)) 50 51 #define SDW_SHIM_PCMSCAP_ISS GENMASK(3, 0) 52 #define SDW_SHIM_PCMSCAP_OSS GENMASK(7, 4) 53 #define SDW_SHIM_PCMSCAP_BSS GENMASK(12, 8) 54 55 /* PCM Stream Channel Map */ 56 #define SDW_SHIM_PCMSYCHM(x, y) (0x022 + (0x60 * (x)) + (0x2 * (y))) 57 58 /* PCM Stream Channel Count */ 59 #define SDW_SHIM_PCMSYCHC(x, y) (0x042 + (0x60 * (x)) + (0x2 * (y))) 60 61 #define SDW_SHIM_PCMSYCM_LCHN GENMASK(3, 0) 62 #define SDW_SHIM_PCMSYCM_HCHN GENMASK(7, 4) 63 #define SDW_SHIM_PCMSYCM_STREAM GENMASK(13, 8) 64 #define SDW_SHIM_PCMSYCM_DIR BIT(15) 65 66 /* IO control */ 67 #define SDW_SHIM_IOCTL(x) (0x06C + 0x60 * (x)) 68 69 #define SDW_SHIM_IOCTL_MIF BIT(0) 70 #define SDW_SHIM_IOCTL_CO BIT(1) 71 #define SDW_SHIM_IOCTL_COE BIT(2) 72 #define SDW_SHIM_IOCTL_DO BIT(3) 73 #define SDW_SHIM_IOCTL_DOE BIT(4) 74 #define SDW_SHIM_IOCTL_BKE BIT(5) 75 #define SDW_SHIM_IOCTL_WPDD BIT(6) 76 #define SDW_SHIM_IOCTL_CIBD BIT(8) 77 #define SDW_SHIM_IOCTL_DIBD BIT(9) 78 79 /* Wake Enable*/ 80 #define SDW_SHIM_WAKEEN 0x190 81 82 #define SDW_SHIM_WAKEEN_ENABLE BIT(0) 83 84 /* Wake Status */ 85 #define SDW_SHIM_WAKESTS 0x192 86 87 #define SDW_SHIM_WAKESTS_STATUS BIT(0) 88 89 /* AC Timing control */ 90 #define SDW_SHIM_CTMCTL(x) (0x06E + 0x60 * (x)) 91 92 #define SDW_SHIM_CTMCTL_DACTQE BIT(0) 93 #define SDW_SHIM_CTMCTL_DODS BIT(1) 94 #define SDW_SHIM_CTMCTL_DOAIS GENMASK(4, 3) 95 96 /* Intel ALH Register definitions */ 97 #define SDW_ALH_STRMZCFG(x) (0x000 + (0x4 * (x))) 98 #define SDW_ALH_NUM_STREAMS 64 99 100 #define SDW_ALH_STRMZCFG_DMAT_VAL 0x3 101 #define SDW_ALH_STRMZCFG_DMAT GENMASK(7, 0) 102 #define SDW_ALH_STRMZCFG_CHN GENMASK(19, 16) 103 104 /** 105 * struct sdw_intel_stream_params_data: configuration passed during 106 * the @params_stream callback, e.g. for interaction with DSP 107 * firmware. 108 */ 109 struct sdw_intel_stream_params_data { 110 int stream; 111 struct snd_soc_dai *dai; 112 struct snd_pcm_hw_params *hw_params; 113 int link_id; 114 int alh_stream_id; 115 }; 116 117 /** 118 * struct sdw_intel_stream_free_data: configuration passed during 119 * the @free_stream callback, e.g. for interaction with DSP 120 * firmware. 121 */ 122 struct sdw_intel_stream_free_data { 123 int stream; 124 struct snd_soc_dai *dai; 125 int link_id; 126 }; 127 128 /** 129 * struct sdw_intel_ops: Intel audio driver callback ops 130 * 131 */ 132 struct sdw_intel_ops { 133 int (*params_stream)(struct device *dev, 134 struct sdw_intel_stream_params_data *params_data); 135 int (*free_stream)(struct device *dev, 136 struct sdw_intel_stream_free_data *free_data); 137 int (*trigger)(struct snd_soc_dai *dai, int cmd, int stream); 138 }; 139 140 /** 141 * struct sdw_intel_acpi_info - Soundwire Intel information found in ACPI tables 142 * @handle: ACPI controller handle 143 * @count: link count found with "sdw-master-count" property 144 * @link_mask: bit-wise mask listing links enabled by BIOS menu 145 * 146 * this structure could be expanded to e.g. provide all the _ADR 147 * information in case the link_mask is not sufficient to identify 148 * platform capabilities. 149 */ 150 struct sdw_intel_acpi_info { 151 acpi_handle handle; 152 int count; 153 u32 link_mask; 154 }; 155 156 struct sdw_intel_link_dev; 157 158 /* Intel clock-stop/pm_runtime quirk definitions */ 159 160 /* 161 * Force the clock to remain on during pm_runtime suspend. This might 162 * be needed if Slave devices do not have an alternate clock source or 163 * if the latency requirements are very strict. 164 */ 165 #define SDW_INTEL_CLK_STOP_NOT_ALLOWED BIT(0) 166 167 /* 168 * Stop the bus during pm_runtime suspend. If set, a complete bus 169 * reset and re-enumeration will be performed when the bus 170 * restarts. This mode shall not be used if Slave devices can generate 171 * in-band wakes. 172 */ 173 #define SDW_INTEL_CLK_STOP_TEARDOWN BIT(1) 174 175 /* 176 * Stop the bus during pm_suspend if Slaves are not wake capable 177 * (e.g. speaker amplifiers). The clock-stop mode is typically 178 * slightly higher power than when the IP is completely powered-off. 179 */ 180 #define SDW_INTEL_CLK_STOP_WAKE_CAPABLE_ONLY BIT(2) 181 182 /* 183 * Require a bus reset (and complete re-enumeration) when exiting 184 * clock stop modes. This may be needed if the controller power was 185 * turned off and all context lost. This quirk shall not be used if a 186 * Slave device needs to remain enumerated and keep its context, 187 * e.g. to provide the reasons for the wake, report acoustic events or 188 * pass a history buffer. 189 */ 190 #define SDW_INTEL_CLK_STOP_BUS_RESET BIT(3) 191 192 struct sdw_intel_slave_id { 193 int link_id; 194 struct sdw_slave_id id; 195 }; 196 197 /** 198 * struct sdw_intel_ctx - context allocated by the controller 199 * driver probe 200 * @count: link count 201 * @mmio_base: mmio base of SoundWire registers, only used to check 202 * hardware capabilities after all power dependencies are settled. 203 * @link_mask: bit-wise mask listing SoundWire links reported by the 204 * Controller 205 * @num_slaves: total number of devices exposed across all enabled links 206 * @handle: ACPI parent handle 207 * @ldev: information for each link (controller-specific and kept 208 * opaque here) 209 * @ids: array of slave_id, representing Slaves exposed across all enabled 210 * links 211 * @link_list: list to handle interrupts across all links 212 * @shim_lock: mutex to handle concurrent rmw access to shared SHIM registers. 213 * @shim_mask: flags to track initialization of SHIM shared registers 214 * @shim_base: sdw shim base. 215 * @alh_base: sdw alh base. 216 */ 217 struct sdw_intel_ctx { 218 int count; 219 void __iomem *mmio_base; 220 u32 link_mask; 221 int num_slaves; 222 acpi_handle handle; 223 struct sdw_intel_link_dev **ldev; 224 struct sdw_intel_slave_id *ids; 225 struct list_head link_list; 226 struct mutex shim_lock; /* lock for access to shared SHIM registers */ 227 u32 shim_mask; 228 u32 shim_base; 229 u32 alh_base; 230 }; 231 232 /** 233 * struct sdw_intel_res - Soundwire Intel global resource structure, 234 * typically populated by the DSP driver 235 * 236 * @hw_ops: abstraction for platform ops 237 * @count: link count 238 * @mmio_base: mmio base of SoundWire registers 239 * @irq: interrupt number 240 * @handle: ACPI parent handle 241 * @parent: parent device 242 * @ops: callback ops 243 * @dev: device implementing hwparams and free callbacks 244 * @link_mask: bit-wise mask listing links selected by the DSP driver 245 * This mask may be a subset of the one reported by the controller since 246 * machine-specific quirks are handled in the DSP driver. 247 * @clock_stop_quirks: mask array of possible behaviors requested by the 248 * DSP driver. The quirks are common for all links for now. 249 * @shim_base: sdw shim base. 250 * @alh_base: sdw alh base. 251 */ 252 struct sdw_intel_res { 253 const struct sdw_intel_hw_ops *hw_ops; 254 int count; 255 void __iomem *mmio_base; 256 int irq; 257 acpi_handle handle; 258 struct device *parent; 259 const struct sdw_intel_ops *ops; 260 struct device *dev; 261 u32 link_mask; 262 u32 clock_stop_quirks; 263 u32 shim_base; 264 u32 alh_base; 265 }; 266 267 /* 268 * On Intel platforms, the SoundWire IP has dependencies on power 269 * rails shared with the DSP, and the initialization steps are split 270 * in three. First an ACPI scan to check what the firmware describes 271 * in DSDT tables, then an allocation step (with no hardware 272 * configuration but with all the relevant devices created) and last 273 * the actual hardware configuration. The final stage is a global 274 * interrupt enable which is controlled by the DSP driver. Splitting 275 * these phases helps simplify the boot flow and make early decisions 276 * on e.g. which machine driver to select (I2S mode, HDaudio or 277 * SoundWire). 278 */ 279 int sdw_intel_acpi_scan(acpi_handle *parent_handle, 280 struct sdw_intel_acpi_info *info); 281 282 void sdw_intel_process_wakeen_event(struct sdw_intel_ctx *ctx); 283 284 struct sdw_intel_ctx * 285 sdw_intel_probe(struct sdw_intel_res *res); 286 287 int sdw_intel_startup(struct sdw_intel_ctx *ctx); 288 289 void sdw_intel_exit(struct sdw_intel_ctx *ctx); 290 291 irqreturn_t sdw_intel_thread(int irq, void *dev_id); 292 293 #define SDW_INTEL_QUIRK_MASK_BUS_DISABLE BIT(1) 294 295 struct sdw_intel; 296 297 /* struct intel_sdw_hw_ops - SoundWire ops for Intel platforms. 298 * @debugfs_init: initialize all debugfs capabilities 299 * @debugfs_exit: close and cleanup debugfs capabilities 300 * @register_dai: read all PDI information and register DAIs 301 * @check_clock_stop: throw error message if clock is not stopped. 302 * @start_bus: normal start 303 * @start_bus_after_reset: start after reset 304 * @start_bus_after_clock_stop: start after mode0 clock stop 305 * @stop_bus: stop all bus 306 * @link_power_up: power-up using chip-specific helpers 307 * @link_power_down: power-down with chip-specific helpers 308 * @shim_check_wake: check if a wake was received 309 * @shim_wake: enable/disable in-band wake management 310 * @pre_bank_switch: helper for bus management 311 * @post_bank_switch: helper for bus management 312 * @sync_arm: helper for multi-link synchronization 313 * @sync_go_unlocked: helper for multi-link synchronization - 314 * shim_lock is assumed to be locked at higher level 315 * @sync_go: helper for multi-link synchronization 316 * @sync_check_cmdsync_unlocked: helper for multi-link synchronization 317 * and bank switch - shim_lock is assumed to be locked at higher level 318 */ 319 struct sdw_intel_hw_ops { 320 void (*debugfs_init)(struct sdw_intel *sdw); 321 void (*debugfs_exit)(struct sdw_intel *sdw); 322 323 int (*register_dai)(struct sdw_intel *sdw); 324 325 void (*check_clock_stop)(struct sdw_intel *sdw); 326 int (*start_bus)(struct sdw_intel *sdw); 327 int (*start_bus_after_reset)(struct sdw_intel *sdw); 328 int (*start_bus_after_clock_stop)(struct sdw_intel *sdw); 329 int (*stop_bus)(struct sdw_intel *sdw, bool clock_stop); 330 331 int (*link_power_up)(struct sdw_intel *sdw); 332 int (*link_power_down)(struct sdw_intel *sdw); 333 334 int (*shim_check_wake)(struct sdw_intel *sdw); 335 void (*shim_wake)(struct sdw_intel *sdw, bool wake_enable); 336 337 int (*pre_bank_switch)(struct sdw_intel *sdw); 338 int (*post_bank_switch)(struct sdw_intel *sdw); 339 340 void (*sync_arm)(struct sdw_intel *sdw); 341 int (*sync_go_unlocked)(struct sdw_intel *sdw); 342 int (*sync_go)(struct sdw_intel *sdw); 343 bool (*sync_check_cmdsync_unlocked)(struct sdw_intel *sdw); 344 }; 345 346 extern const struct sdw_intel_hw_ops sdw_intel_cnl_hw_ops; 347 348 #endif 349