123859465SPierre-Louis Bossart /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */ 223859465SPierre-Louis Bossart /* Copyright(c) 2015-17 Intel Corporation. */ 371bb8a1bSVinod Koul 471bb8a1bSVinod Koul #ifndef __SDW_INTEL_LOCAL_H 571bb8a1bSVinod Koul #define __SDW_INTEL_LOCAL_H 671bb8a1bSVinod Koul 771bb8a1bSVinod Koul /** 8f98f690fSPierre-Louis Bossart * struct sdw_intel_link_res - Soundwire Intel link resource structure, 9f98f690fSPierre-Louis Bossart * typically populated by the controller driver. 10b3ad31f3SPierre-Louis Bossart * @hw_ops: platform-specific ops 11f98f690fSPierre-Louis Bossart * @mmio_base: mmio base of SoundWire registers 1271bb8a1bSVinod Koul * @registers: Link IO registers base 1371bb8a1bSVinod Koul * @shim: Audio shim pointer 1471bb8a1bSVinod Koul * @alh: ALH (Audio Link Hub) pointer 1571bb8a1bSVinod Koul * @irq: Interrupt line 16c46302ecSVinod Koul * @ops: Shim callback ops 174b206d34SRander Wang * @dev: device implementing hw_params and free callbacks 184a17c441SPierre-Louis Bossart * @shim_lock: mutex to handle access to shared SHIM registers 194a17c441SPierre-Louis Bossart * @shim_mask: global pointer to check SHIM register initialization 20a320f41eSPierre-Louis Bossart * @clock_stop_quirks: mask defining requested behavior on pm_suspend 21de763fa8SPierre-Louis Bossart * @link_mask: global mask needed for power-up/down sequences 224a98a6b2SBard Liao * @cdns: Cadence master descriptor 234a98a6b2SBard Liao * @list: used to walk-through all masters exposed by the same controller 2471bb8a1bSVinod Koul */ 2571bb8a1bSVinod Koul struct sdw_intel_link_res { 26b3ad31f3SPierre-Louis Bossart const struct sdw_intel_hw_ops *hw_ops; 27b3ad31f3SPierre-Louis Bossart 28f98f690fSPierre-Louis Bossart void __iomem *mmio_base; /* not strictly needed, useful for debug */ 2971bb8a1bSVinod Koul void __iomem *registers; 3071bb8a1bSVinod Koul void __iomem *shim; 3171bb8a1bSVinod Koul void __iomem *alh; 3271bb8a1bSVinod Koul int irq; 33c46302ecSVinod Koul const struct sdw_intel_ops *ops; 344b206d34SRander Wang struct device *dev; 354a17c441SPierre-Louis Bossart struct mutex *shim_lock; /* protect shared registers */ 364a17c441SPierre-Louis Bossart u32 *shim_mask; 37a320f41eSPierre-Louis Bossart u32 clock_stop_quirks; 38de763fa8SPierre-Louis Bossart u32 link_mask; 394a98a6b2SBard Liao struct sdw_cdns *cdns; 404a98a6b2SBard Liao struct list_head list; 4171bb8a1bSVinod Koul }; 4271bb8a1bSVinod Koul 43b6109dd6SPierre-Louis Bossart struct sdw_intel { 44b6109dd6SPierre-Louis Bossart struct sdw_cdns cdns; 45b6109dd6SPierre-Louis Bossart int instance; 46b6109dd6SPierre-Louis Bossart struct sdw_intel_link_res *link_res; 47e4401abbSPierre-Louis Bossart bool startup_done; 48b6109dd6SPierre-Louis Bossart #ifdef CONFIG_DEBUG_FS 49b6109dd6SPierre-Louis Bossart struct dentry *debugfs; 50b6109dd6SPierre-Louis Bossart #endif 51b6109dd6SPierre-Louis Bossart }; 52b6109dd6SPierre-Louis Bossart 53*7cbf00bdSPierre-Louis Bossart #define cdns_to_intel(_cdns) container_of(_cdns, struct sdw_intel, cdns) 5429a269c6SPierre-Louis Bossart 55*7cbf00bdSPierre-Louis Bossart #define INTEL_MASTER_RESET_ITERATIONS 10 566d2c6669SPierre-Louis Bossart 57fb2dc6a0SPierre-Louis Bossart #define SDW_INTEL_CHECK_OPS(sdw, cb) ((sdw) && (sdw)->link_res && (sdw)->link_res->hw_ops && \ 58fb2dc6a0SPierre-Louis Bossart (sdw)->link_res->hw_ops->cb) 59fb2dc6a0SPierre-Louis Bossart #define SDW_INTEL_OPS(sdw, cb) ((sdw)->link_res->hw_ops->cb) 60fb2dc6a0SPierre-Louis Bossart 61fb2dc6a0SPierre-Louis Bossart static inline void sdw_intel_debugfs_init(struct sdw_intel *sdw) 62fb2dc6a0SPierre-Louis Bossart { 63fb2dc6a0SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, debugfs_init)) 64fb2dc6a0SPierre-Louis Bossart SDW_INTEL_OPS(sdw, debugfs_init)(sdw); 65fb2dc6a0SPierre-Louis Bossart } 66fb2dc6a0SPierre-Louis Bossart 67fb2dc6a0SPierre-Louis Bossart static inline void sdw_intel_debugfs_exit(struct sdw_intel *sdw) 68fb2dc6a0SPierre-Louis Bossart { 69fb2dc6a0SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, debugfs_exit)) 70fb2dc6a0SPierre-Louis Bossart SDW_INTEL_OPS(sdw, debugfs_exit)(sdw); 71fb2dc6a0SPierre-Louis Bossart } 72fb2dc6a0SPierre-Louis Bossart 73b6234bccSPierre-Louis Bossart static inline int sdw_intel_register_dai(struct sdw_intel *sdw) 74b6234bccSPierre-Louis Bossart { 75b6234bccSPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, register_dai)) 76b6234bccSPierre-Louis Bossart return SDW_INTEL_OPS(sdw, register_dai)(sdw); 77b6234bccSPierre-Louis Bossart return -ENOTSUPP; 78b6234bccSPierre-Louis Bossart } 79b6234bccSPierre-Louis Bossart 803db0c5a6SPierre-Louis Bossart static inline void sdw_intel_check_clock_stop(struct sdw_intel *sdw) 813db0c5a6SPierre-Louis Bossart { 823db0c5a6SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, check_clock_stop)) 833db0c5a6SPierre-Louis Bossart SDW_INTEL_OPS(sdw, check_clock_stop)(sdw); 843db0c5a6SPierre-Louis Bossart } 853db0c5a6SPierre-Louis Bossart 863db0c5a6SPierre-Louis Bossart static inline int sdw_intel_start_bus(struct sdw_intel *sdw) 873db0c5a6SPierre-Louis Bossart { 883db0c5a6SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, start_bus)) 893db0c5a6SPierre-Louis Bossart return SDW_INTEL_OPS(sdw, start_bus)(sdw); 903db0c5a6SPierre-Louis Bossart return -ENOTSUPP; 913db0c5a6SPierre-Louis Bossart } 923db0c5a6SPierre-Louis Bossart 933db0c5a6SPierre-Louis Bossart static inline int sdw_intel_start_bus_after_reset(struct sdw_intel *sdw) 943db0c5a6SPierre-Louis Bossart { 953db0c5a6SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, start_bus_after_reset)) 963db0c5a6SPierre-Louis Bossart return SDW_INTEL_OPS(sdw, start_bus_after_reset)(sdw); 973db0c5a6SPierre-Louis Bossart return -ENOTSUPP; 983db0c5a6SPierre-Louis Bossart } 993db0c5a6SPierre-Louis Bossart 1003db0c5a6SPierre-Louis Bossart static inline int sdw_intel_start_bus_after_clock_stop(struct sdw_intel *sdw) 1013db0c5a6SPierre-Louis Bossart { 1023db0c5a6SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, start_bus_after_clock_stop)) 1033db0c5a6SPierre-Louis Bossart return SDW_INTEL_OPS(sdw, start_bus_after_clock_stop)(sdw); 1043db0c5a6SPierre-Louis Bossart return -ENOTSUPP; 1053db0c5a6SPierre-Louis Bossart } 1063db0c5a6SPierre-Louis Bossart 1073db0c5a6SPierre-Louis Bossart static inline int sdw_intel_stop_bus(struct sdw_intel *sdw, bool clock_stop) 1083db0c5a6SPierre-Louis Bossart { 1093db0c5a6SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, stop_bus)) 1103db0c5a6SPierre-Louis Bossart return SDW_INTEL_OPS(sdw, stop_bus)(sdw, clock_stop); 1113db0c5a6SPierre-Louis Bossart return -ENOTSUPP; 1123db0c5a6SPierre-Louis Bossart } 1133db0c5a6SPierre-Louis Bossart 11449c9ff45SPierre-Louis Bossart static inline int sdw_intel_link_power_up(struct sdw_intel *sdw) 11549c9ff45SPierre-Louis Bossart { 11649c9ff45SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, link_power_up)) 11749c9ff45SPierre-Louis Bossart return SDW_INTEL_OPS(sdw, link_power_up)(sdw); 11849c9ff45SPierre-Louis Bossart return -ENOTSUPP; 11949c9ff45SPierre-Louis Bossart } 12049c9ff45SPierre-Louis Bossart 12149c9ff45SPierre-Louis Bossart static inline int sdw_intel_link_power_down(struct sdw_intel *sdw) 12249c9ff45SPierre-Louis Bossart { 12349c9ff45SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, link_power_down)) 12449c9ff45SPierre-Louis Bossart return SDW_INTEL_OPS(sdw, link_power_down)(sdw); 12549c9ff45SPierre-Louis Bossart return -ENOTSUPP; 12649c9ff45SPierre-Louis Bossart } 12749c9ff45SPierre-Louis Bossart 12836e3b385SPierre-Louis Bossart static inline int sdw_intel_shim_check_wake(struct sdw_intel *sdw) 12936e3b385SPierre-Louis Bossart { 13036e3b385SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, shim_check_wake)) 13136e3b385SPierre-Louis Bossart return SDW_INTEL_OPS(sdw, shim_check_wake)(sdw); 13236e3b385SPierre-Louis Bossart return -ENOTSUPP; 13336e3b385SPierre-Louis Bossart } 13436e3b385SPierre-Louis Bossart 13536e3b385SPierre-Louis Bossart static inline void sdw_intel_shim_wake(struct sdw_intel *sdw, bool wake_enable) 13636e3b385SPierre-Louis Bossart { 13736e3b385SPierre-Louis Bossart if (SDW_INTEL_CHECK_OPS(sdw, shim_wake)) 13836e3b385SPierre-Louis Bossart SDW_INTEL_OPS(sdw, shim_wake)(sdw, wake_enable); 13936e3b385SPierre-Louis Bossart } 14036e3b385SPierre-Louis Bossart 14171bb8a1bSVinod Koul #endif /* __SDW_INTEL_LOCAL_H */ 142