1/* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */ 2/* Copyright(c) 2015-17 Intel Corporation. */ 3 4#ifndef __SDW_INTEL_LOCAL_H 5#define __SDW_INTEL_LOCAL_H 6 7struct hdac_bus; 8 9/** 10 * struct sdw_intel_link_res - Soundwire Intel link resource structure, 11 * typically populated by the controller driver. 12 * @hw_ops: platform-specific ops 13 * @mmio_base: mmio base of SoundWire registers 14 * @registers: Link IO registers base 15 * @ip_offset: offset for MCP_IP registers 16 * @shim: Audio shim pointer 17 * @shim_vs: Audio vendor-specific shim pointer 18 * @alh: ALH (Audio Link Hub) pointer 19 * @irq: Interrupt line 20 * @ops: Shim callback ops 21 * @dev: device implementing hw_params and free callbacks 22 * @shim_lock: mutex to handle access to shared SHIM registers 23 * @shim_mask: global pointer to check SHIM register initialization 24 * @clock_stop_quirks: mask defining requested behavior on pm_suspend 25 * @link_mask: global mask needed for power-up/down sequences 26 * @cdns: Cadence master descriptor 27 * @list: used to walk-through all masters exposed by the same controller 28 * @hbus: hdac_bus pointer, needed for power management 29 */ 30struct sdw_intel_link_res { 31 const struct sdw_intel_hw_ops *hw_ops; 32 33 void __iomem *mmio_base; /* not strictly needed, useful for debug */ 34 void __iomem *registers; 35 u32 ip_offset; 36 void __iomem *shim; 37 void __iomem *shim_vs; 38 void __iomem *alh; 39 int irq; 40 const struct sdw_intel_ops *ops; 41 struct device *dev; 42 struct mutex *shim_lock; /* protect shared registers */ 43 u32 *shim_mask; 44 u32 clock_stop_quirks; 45 u32 link_mask; 46 struct sdw_cdns *cdns; 47 struct list_head list; 48 struct hdac_bus *hbus; 49}; 50 51struct sdw_intel { 52 struct sdw_cdns cdns; 53 int instance; 54 struct sdw_intel_link_res *link_res; 55 bool startup_done; 56#ifdef CONFIG_DEBUG_FS 57 struct dentry *debugfs; 58#endif 59}; 60 61enum intel_pdi_type { 62 INTEL_PDI_IN = 0, 63 INTEL_PDI_OUT = 1, 64 INTEL_PDI_BD = 2, 65}; 66 67/* 68 * Read, write helpers for HW registers 69 */ 70static inline int intel_readl(void __iomem *base, int offset) 71{ 72 return readl(base + offset); 73} 74 75static inline void intel_writel(void __iomem *base, int offset, int value) 76{ 77 writel(value, base + offset); 78} 79 80static inline u16 intel_readw(void __iomem *base, int offset) 81{ 82 return readw(base + offset); 83} 84 85static inline void intel_writew(void __iomem *base, int offset, u16 value) 86{ 87 writew(value, base + offset); 88} 89 90#define cdns_to_intel(_cdns) container_of(_cdns, struct sdw_intel, cdns) 91 92#define INTEL_MASTER_RESET_ITERATIONS 10 93 94#define SDW_INTEL_CHECK_OPS(sdw, cb) ((sdw) && (sdw)->link_res && (sdw)->link_res->hw_ops && \ 95 (sdw)->link_res->hw_ops->cb) 96#define SDW_INTEL_OPS(sdw, cb) ((sdw)->link_res->hw_ops->cb) 97 98#ifdef CONFIG_DEBUG_FS 99void intel_ace2x_debugfs_init(struct sdw_intel *sdw); 100void intel_ace2x_debugfs_exit(struct sdw_intel *sdw); 101#else 102static inline void intel_ace2x_debugfs_init(struct sdw_intel *sdw) {} 103static inline void intel_ace2x_debugfs_exit(struct sdw_intel *sdw) {} 104#endif 105 106static inline void sdw_intel_debugfs_init(struct sdw_intel *sdw) 107{ 108 if (SDW_INTEL_CHECK_OPS(sdw, debugfs_init)) 109 SDW_INTEL_OPS(sdw, debugfs_init)(sdw); 110} 111 112static inline void sdw_intel_debugfs_exit(struct sdw_intel *sdw) 113{ 114 if (SDW_INTEL_CHECK_OPS(sdw, debugfs_exit)) 115 SDW_INTEL_OPS(sdw, debugfs_exit)(sdw); 116} 117 118static inline int sdw_intel_register_dai(struct sdw_intel *sdw) 119{ 120 if (SDW_INTEL_CHECK_OPS(sdw, register_dai)) 121 return SDW_INTEL_OPS(sdw, register_dai)(sdw); 122 return -ENOTSUPP; 123} 124 125static inline void sdw_intel_check_clock_stop(struct sdw_intel *sdw) 126{ 127 if (SDW_INTEL_CHECK_OPS(sdw, check_clock_stop)) 128 SDW_INTEL_OPS(sdw, check_clock_stop)(sdw); 129} 130 131static inline int sdw_intel_start_bus(struct sdw_intel *sdw) 132{ 133 if (SDW_INTEL_CHECK_OPS(sdw, start_bus)) 134 return SDW_INTEL_OPS(sdw, start_bus)(sdw); 135 return -ENOTSUPP; 136} 137 138static inline int sdw_intel_start_bus_after_reset(struct sdw_intel *sdw) 139{ 140 if (SDW_INTEL_CHECK_OPS(sdw, start_bus_after_reset)) 141 return SDW_INTEL_OPS(sdw, start_bus_after_reset)(sdw); 142 return -ENOTSUPP; 143} 144 145static inline int sdw_intel_start_bus_after_clock_stop(struct sdw_intel *sdw) 146{ 147 if (SDW_INTEL_CHECK_OPS(sdw, start_bus_after_clock_stop)) 148 return SDW_INTEL_OPS(sdw, start_bus_after_clock_stop)(sdw); 149 return -ENOTSUPP; 150} 151 152static inline int sdw_intel_stop_bus(struct sdw_intel *sdw, bool clock_stop) 153{ 154 if (SDW_INTEL_CHECK_OPS(sdw, stop_bus)) 155 return SDW_INTEL_OPS(sdw, stop_bus)(sdw, clock_stop); 156 return -ENOTSUPP; 157} 158 159static inline int sdw_intel_link_power_up(struct sdw_intel *sdw) 160{ 161 if (SDW_INTEL_CHECK_OPS(sdw, link_power_up)) 162 return SDW_INTEL_OPS(sdw, link_power_up)(sdw); 163 return -ENOTSUPP; 164} 165 166static inline int sdw_intel_link_power_down(struct sdw_intel *sdw) 167{ 168 if (SDW_INTEL_CHECK_OPS(sdw, link_power_down)) 169 return SDW_INTEL_OPS(sdw, link_power_down)(sdw); 170 return -ENOTSUPP; 171} 172 173static inline int sdw_intel_shim_check_wake(struct sdw_intel *sdw) 174{ 175 if (SDW_INTEL_CHECK_OPS(sdw, shim_check_wake)) 176 return SDW_INTEL_OPS(sdw, shim_check_wake)(sdw); 177 return -ENOTSUPP; 178} 179 180static inline void sdw_intel_shim_wake(struct sdw_intel *sdw, bool wake_enable) 181{ 182 if (SDW_INTEL_CHECK_OPS(sdw, shim_wake)) 183 SDW_INTEL_OPS(sdw, shim_wake)(sdw, wake_enable); 184} 185 186static inline void sdw_intel_sync_arm(struct sdw_intel *sdw) 187{ 188 if (SDW_INTEL_CHECK_OPS(sdw, sync_arm)) 189 SDW_INTEL_OPS(sdw, sync_arm)(sdw); 190} 191 192static inline int sdw_intel_sync_go_unlocked(struct sdw_intel *sdw) 193{ 194 if (SDW_INTEL_CHECK_OPS(sdw, sync_go_unlocked)) 195 return SDW_INTEL_OPS(sdw, sync_go_unlocked)(sdw); 196 return -ENOTSUPP; 197} 198 199static inline int sdw_intel_sync_go(struct sdw_intel *sdw) 200{ 201 if (SDW_INTEL_CHECK_OPS(sdw, sync_go)) 202 return SDW_INTEL_OPS(sdw, sync_go)(sdw); 203 return -ENOTSUPP; 204} 205 206static inline bool sdw_intel_sync_check_cmdsync_unlocked(struct sdw_intel *sdw) 207{ 208 if (SDW_INTEL_CHECK_OPS(sdw, sync_check_cmdsync_unlocked)) 209 return SDW_INTEL_OPS(sdw, sync_check_cmdsync_unlocked)(sdw); 210 return false; 211} 212 213/* common bus management */ 214int intel_start_bus(struct sdw_intel *sdw); 215int intel_start_bus_after_reset(struct sdw_intel *sdw); 216void intel_check_clock_stop(struct sdw_intel *sdw); 217int intel_start_bus_after_clock_stop(struct sdw_intel *sdw); 218int intel_stop_bus(struct sdw_intel *sdw, bool clock_stop); 219 220/* common bank switch routines */ 221int intel_pre_bank_switch(struct sdw_intel *sdw); 222int intel_post_bank_switch(struct sdw_intel *sdw); 223 224#endif /* __SDW_INTEL_LOCAL_H */ 225