1 /* 2 * Copyright © 2016 Intel Corporation 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining a 5 * copy of this software and associated documentation files (the "Software"), 6 * to deal in the Software without restriction, including without limitation 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 * and/or sell copies of the Software, and to permit persons to whom the 9 * Software is furnished to do so, subject to the following conditions: 10 * 11 * The above copyright notice and this permission notice (including the next 12 * paragraph) shall be included in all copies or substantial portions of the 13 * Software. 14 * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 21 * IN THE SOFTWARE. 22 * 23 * Authors: 24 * Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> 25 * Jerome Anand <jerome.anand@intel.com> 26 * based on VED patches 27 * 28 */ 29 30 /** 31 * DOC: LPE Audio integration for HDMI or DP playback 32 * 33 * Motivation: 34 * Atom platforms (e.g. valleyview and cherryTrail) integrates a DMA-based 35 * interface as an alternative to the traditional HDaudio path. While this 36 * mode is unrelated to the LPE aka SST audio engine, the documentation refers 37 * to this mode as LPE so we keep this notation for the sake of consistency. 38 * 39 * The interface is handled by a separate standalone driver maintained in the 40 * ALSA subsystem for simplicity. To minimize the interaction between the two 41 * subsystems, a bridge is setup between the hdmi-lpe-audio and i915: 42 * 1. Create a platform device to share MMIO/IRQ resources 43 * 2. Make the platform device child of i915 device for runtime PM. 44 * 3. Create IRQ chip to forward the LPE audio irqs. 45 * the hdmi-lpe-audio driver probes the lpe audio device and creates a new 46 * sound card 47 * 48 * Threats: 49 * Due to the restriction in Linux platform device model, user need manually 50 * uninstall the hdmi-lpe-audio driver before uninstalling i915 module, 51 * otherwise we might run into use-after-free issues after i915 removes the 52 * platform device: even though hdmi-lpe-audio driver is released, the modules 53 * is still in "installed" status. 54 * 55 * Implementation: 56 * The MMIO/REG platform resources are created according to the registers 57 * specification. 58 * When forwarding LPE audio irqs, the flow control handler selection depends 59 * on the platform, for example on valleyview handle_simple_irq is enough. 60 * 61 */ 62 63 #include <linux/acpi.h> 64 #include <linux/device.h> 65 #include <linux/pci.h> 66 #include <linux/pm_runtime.h> 67 68 #include "i915_drv.h" 69 #include <linux/delay.h> 70 #include <drm/intel_lpe_audio.h> 71 72 #define HAS_LPE_AUDIO(dev_priv) ((dev_priv)->lpe_audio.platdev != NULL) 73 74 #if 0 75 static struct platform_device * 76 lpe_audio_platdev_create(struct drm_i915_private *dev_priv) 77 { 78 int ret; 79 struct drm_device *dev = &dev_priv->drm; 80 struct platform_device_info pinfo = {}; 81 struct resource *rsc; 82 struct platform_device *platdev; 83 struct intel_hdmi_lpe_audio_pdata *pdata; 84 85 pdata = kzalloc(sizeof(*pdata), GFP_KERNEL); 86 if (!pdata) 87 return ERR_PTR(-ENOMEM); 88 89 rsc = kcalloc(2, sizeof(*rsc), GFP_KERNEL); 90 if (!rsc) { 91 kfree(pdata); 92 return ERR_PTR(-ENOMEM); 93 } 94 95 rsc[0].start = rsc[0].end = dev_priv->lpe_audio.irq; 96 rsc[0].flags = IORESOURCE_IRQ; 97 rsc[0].name = "hdmi-lpe-audio-irq"; 98 99 rsc[1].start = pci_resource_start(dev->pdev, 0) + 100 I915_HDMI_LPE_AUDIO_BASE; 101 rsc[1].end = pci_resource_start(dev->pdev, 0) + 102 I915_HDMI_LPE_AUDIO_BASE + I915_HDMI_LPE_AUDIO_SIZE - 1; 103 rsc[1].flags = IORESOURCE_MEM; 104 rsc[1].name = "hdmi-lpe-audio-mmio"; 105 106 pinfo.parent = dev->dev; 107 pinfo.name = "hdmi-lpe-audio"; 108 pinfo.id = -1; 109 pinfo.res = rsc; 110 pinfo.num_res = 2; 111 pinfo.data = pdata; 112 pinfo.size_data = sizeof(*pdata); 113 pinfo.dma_mask = DMA_BIT_MASK(32); 114 115 spin_lock_init(&pdata->lpe_audio_slock); 116 117 platdev = platform_device_register_full(&pinfo); 118 if (IS_ERR(platdev)) { 119 ret = PTR_ERR(platdev); 120 DRM_ERROR("Failed to allocate LPE audio platform device\n"); 121 goto err; 122 } 123 124 kfree(rsc); 125 126 pm_runtime_forbid(&platdev->dev); 127 pm_runtime_set_active(&platdev->dev); 128 pm_runtime_enable(&platdev->dev); 129 130 pm_runtime_forbid(&platdev->dev); 131 pm_runtime_set_active(&platdev->dev); 132 pm_runtime_enable(&platdev->dev); 133 134 return platdev; 135 136 err: 137 kfree(rsc); 138 kfree(pdata); 139 return ERR_PTR(ret); 140 } 141 142 static void lpe_audio_platdev_destroy(struct drm_i915_private *dev_priv) 143 { 144 /* XXX Note that platform_device_register_full() allocates a dma_mask 145 * and never frees it. We can't free it here as we cannot guarantee 146 * this is the last reference (i.e. that the dma_mask will not be 147 * used after our unregister). So ee choose to leak the sizeof(u64) 148 * allocation here - it should be fixed in the platform_device rather 149 * than us fiddle with its internals. 150 */ 151 152 platform_device_unregister(dev_priv->lpe_audio.platdev); 153 } 154 155 static void lpe_audio_irq_unmask(struct irq_data *d) 156 { 157 } 158 159 static void lpe_audio_irq_mask(struct irq_data *d) 160 { 161 } 162 163 static struct irq_chip lpe_audio_irqchip = { 164 .name = "hdmi_lpe_audio_irqchip", 165 .irq_mask = lpe_audio_irq_mask, 166 .irq_unmask = lpe_audio_irq_unmask, 167 }; 168 169 static int lpe_audio_irq_init(struct drm_i915_private *dev_priv) 170 { 171 int irq = dev_priv->lpe_audio.irq; 172 173 WARN_ON(!intel_irqs_enabled(dev_priv)); 174 irq_set_chip_and_handler_name(irq, 175 &lpe_audio_irqchip, 176 handle_simple_irq, 177 "hdmi_lpe_audio_irq_handler"); 178 179 return irq_set_chip_data(irq, dev_priv); 180 } 181 182 static bool lpe_audio_detect(struct drm_i915_private *dev_priv) 183 { 184 int lpe_present = false; 185 186 if (IS_VALLEYVIEW(dev_priv) || IS_CHERRYVIEW(dev_priv)) { 187 static const struct pci_device_id atom_hdaudio_ids[] = { 188 /* Baytrail */ 189 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x0f04)}, 190 /* Braswell */ 191 {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x2284)}, 192 {} 193 }; 194 195 if (!pci_dev_present(atom_hdaudio_ids)) { 196 DRM_INFO("%s\n", "HDaudio controller not detected, using LPE audio instead\n"); 197 lpe_present = true; 198 } 199 } 200 return lpe_present; 201 } 202 203 static int lpe_audio_setup(struct drm_i915_private *dev_priv) 204 { 205 int ret; 206 207 dev_priv->lpe_audio.irq = irq_alloc_desc(0); 208 if (dev_priv->lpe_audio.irq < 0) { 209 DRM_ERROR("Failed to allocate IRQ desc: %d\n", 210 dev_priv->lpe_audio.irq); 211 ret = dev_priv->lpe_audio.irq; 212 goto err; 213 } 214 215 DRM_DEBUG("irq = %d\n", dev_priv->lpe_audio.irq); 216 217 ret = lpe_audio_irq_init(dev_priv); 218 219 if (ret) { 220 DRM_ERROR("Failed to initialize irqchip for lpe audio: %d\n", 221 ret); 222 goto err_free_irq; 223 } 224 225 dev_priv->lpe_audio.platdev = lpe_audio_platdev_create(dev_priv); 226 227 if (IS_ERR(dev_priv->lpe_audio.platdev)) { 228 ret = PTR_ERR(dev_priv->lpe_audio.platdev); 229 DRM_ERROR("Failed to create lpe audio platform device: %d\n", 230 ret); 231 goto err_free_irq; 232 } 233 234 /* enable chicken bit; at least this is required for Dell Wyse 3040 235 * with DP outputs (but only sometimes by some reason!) 236 */ 237 I915_WRITE(VLV_AUD_CHICKEN_BIT_REG, VLV_CHICKEN_BIT_DBG_ENABLE); 238 239 return 0; 240 err_free_irq: 241 irq_free_desc(dev_priv->lpe_audio.irq); 242 err: 243 dev_priv->lpe_audio.irq = -1; 244 dev_priv->lpe_audio.platdev = NULL; 245 return ret; 246 } 247 #endif 248 249 /** 250 * intel_lpe_audio_irq_handler() - forwards the LPE audio irq 251 * @dev_priv: the i915 drm device private data 252 * 253 * the LPE Audio irq is forwarded to the irq handler registered by LPE audio 254 * driver. 255 */ 256 void intel_lpe_audio_irq_handler(struct drm_i915_private *dev_priv) 257 { 258 #if 0 259 int ret; 260 261 if (!HAS_LPE_AUDIO(dev_priv)) 262 return; 263 264 ret = generic_handle_irq(dev_priv->lpe_audio.irq); 265 if (ret) 266 DRM_ERROR_RATELIMITED("error handling LPE audio irq: %d\n", 267 ret); 268 #endif 269 } 270 271 /** 272 * intel_lpe_audio_init() - detect and setup the bridge between HDMI LPE Audio 273 * driver and i915 274 * @dev_priv: the i915 drm device private data 275 * 276 * Return: 0 if successful. non-zero if detection or 277 * llocation/initialization fails 278 */ 279 int intel_lpe_audio_init(struct drm_i915_private *dev_priv) 280 { 281 int ret = -ENODEV; 282 283 #if 0 284 if (lpe_audio_detect(dev_priv)) { 285 ret = lpe_audio_setup(dev_priv); 286 if (ret < 0) 287 DRM_ERROR("failed to setup LPE Audio bridge\n"); 288 } 289 #endif 290 return ret; 291 } 292 293 /** 294 * intel_lpe_audio_teardown() - destroy the bridge between HDMI LPE 295 * audio driver and i915 296 * @dev_priv: the i915 drm device private data 297 * 298 * release all the resources for LPE audio <-> i915 bridge. 299 */ 300 void intel_lpe_audio_teardown(struct drm_i915_private *dev_priv) 301 { 302 #if 0 303 struct irq_desc *desc; 304 305 if (!HAS_LPE_AUDIO(dev_priv)) 306 return; 307 308 desc = irq_to_desc(dev_priv->lpe_audio.irq); 309 310 lpe_audio_platdev_destroy(dev_priv); 311 312 irq_free_desc(dev_priv->lpe_audio.irq); 313 #endif 314 } 315 316 317 /** 318 * intel_lpe_audio_notify() - notify lpe audio event 319 * audio driver and i915 320 * @dev_priv: the i915 drm device private data 321 * @eld : ELD data 322 * @pipe: pipe id 323 * @port: port id 324 * @tmds_clk_speed: tmds clock frequency in Hz 325 * 326 * Notify lpe audio driver of eld change. 327 */ 328 void intel_lpe_audio_notify(struct drm_i915_private *dev_priv, 329 void *eld, int port, int pipe, int tmds_clk_speed, 330 bool dp_output, int link_rate) 331 { 332 #if 0 333 unsigned long irq_flags; 334 struct intel_hdmi_lpe_audio_pdata *pdata = NULL; 335 u32 audio_enable; 336 337 if (!HAS_LPE_AUDIO(dev_priv)) 338 return; 339 340 pdata = dev_get_platdata( 341 &(dev_priv->lpe_audio.platdev->dev)); 342 343 spin_lock_irqsave(&pdata->lpe_audio_slock, irq_flags); 344 345 audio_enable = I915_READ(VLV_AUD_PORT_EN_DBG(port)); 346 347 if (eld != NULL) { 348 memcpy(pdata->eld.eld_data, eld, 349 HDMI_MAX_ELD_BYTES); 350 pdata->eld.port_id = port; 351 pdata->eld.pipe_id = pipe; 352 pdata->hdmi_connected = true; 353 354 pdata->dp_output = dp_output; 355 if (tmds_clk_speed) 356 pdata->tmds_clock_speed = tmds_clk_speed; 357 if (link_rate) 358 pdata->link_rate = link_rate; 359 360 /* Unmute the amp for both DP and HDMI */ 361 I915_WRITE(VLV_AUD_PORT_EN_DBG(port), 362 audio_enable & ~VLV_AMP_MUTE); 363 364 } else { 365 memset(pdata->eld.eld_data, 0, 366 HDMI_MAX_ELD_BYTES); 367 pdata->hdmi_connected = false; 368 pdata->dp_output = false; 369 370 /* Mute the amp for both DP and HDMI */ 371 I915_WRITE(VLV_AUD_PORT_EN_DBG(port), 372 audio_enable | VLV_AMP_MUTE); 373 } 374 375 if (pdata->notify_audio_lpe) 376 pdata->notify_audio_lpe(dev_priv->lpe_audio.platdev); 377 else 378 pdata->notify_pending = true; 379 380 spin_unlock_irqrestore(&pdata->lpe_audio_slock, 381 irq_flags); 382 #endif 383 } 384