drivers/gpu/drm/i915/intel_psr.c

   1 /*
   2  * Copyright © 2014 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
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 /**
  25  * DOC: Panel Self Refresh (PSR/SRD)
  26  *
  27  * Since Haswell Display controller supports Panel Self-Refresh on display
  28  * panels witch have a remote frame buffer (RFB) implemented according to PSR
  29  * spec in eDP1.3. PSR feature allows the display to go to lower standby states
  30  * when system is idle but display is on as it eliminates display refresh
  31  * request to DDR memory completely as long as the frame buffer for that
  32  * display is unchanged.
  33  *
  34  * Panel Self Refresh must be supported by both Hardware (source) and
  35  * Panel (sink).
  36  *
  37  * PSR saves power by caching the framebuffer in the panel RFB, which allows us
  38  * to power down the link and memory controller. For DSI panels the same idea
  39  * is called "manual mode".
  40  *
  41  * The implementation uses the hardware-based PSR support which automatically
  42  * enters/exits self-refresh mode. The hardware takes care of sending the
  43  * required DP aux message and could even retrain the link (that part isn't
  44  * enabled yet though). The hardware also keeps track of any frontbuffer
  45  * changes to know when to exit self-refresh mode again. Unfortunately that
  46  * part doesn't work too well, hence why the i915 PSR support uses the
  47  * software frontbuffer tracking to make sure it doesn't miss a screen
  48  * update. For this integration intel_psr_invalidate() and intel_psr_flush()
  49  * get called by the frontbuffer tracking code. Note that because of locking
  50  * issues the self-refresh re-enable code is done from a work queue, which
  51  * must be correctly synchronized/cancelled when shutting down the pipe."
  52  */
  53
  54 #include <drm/drmP.h>
  55
  56 #include "intel_drv.h"
  57 #include "i915_drv.h"
  58
  59 static bool is_edp_psr(struct intel_dp *intel_dp)
  60 {
  61         return intel_dp->psr_dpcd[0] & DP_PSR_IS_SUPPORTED;
  62 }
  63
  64 bool intel_psr_is_enabled(struct drm_device *dev)
  65 {
  66         struct drm_i915_private *dev_priv = dev->dev_private;
  67
  68         if (!HAS_PSR(dev))
  69                 return false;
  70
  71         return I915_READ(EDP_PSR_CTL(dev)) & EDP_PSR_ENABLE;
  72 }
  73
  74 static void intel_psr_write_vsc(struct intel_dp *intel_dp,
  75                                     struct edp_vsc_psr *vsc_psr)
  76 {
  77         struct intel_digital_port *dig_port = dp_to_dig_port(intel_dp);
  78         struct drm_device *dev = dig_port->base.base.dev;
  79         struct drm_i915_private *dev_priv = dev->dev_private;
  80         struct intel_crtc *crtc = to_intel_crtc(dig_port->base.base.crtc);
  81         u32 ctl_reg = HSW_TVIDEO_DIP_CTL(crtc->config.cpu_transcoder);
  82         u32 data_reg = HSW_TVIDEO_DIP_VSC_DATA(crtc->config.cpu_transcoder);
  83         uint32_t *data = (uint32_t *) vsc_psr;
  84         unsigned int i;
  85
  86         /* As per BSPec (Pipe Video Data Island Packet), we need to disable
  87            the video DIP being updated before program video DIP data buffer
  88            registers for DIP being updated. */
  89         I915_WRITE(ctl_reg, 0);
  90         POSTING_READ(ctl_reg);
  91
  92         for (i = 0; i < VIDEO_DIP_VSC_DATA_SIZE; i += 4) {
  93                 if (i < sizeof(struct edp_vsc_psr))
  94                         I915_WRITE(data_reg + i, *data++);
  95                 else
  96                         I915_WRITE(data_reg + i, 0);
  97         }
  98
  99         I915_WRITE(ctl_reg, VIDEO_DIP_ENABLE_VSC_HSW);
 100         POSTING_READ(ctl_reg);
 101 }
 102
 103 static void intel_psr_setup_vsc(struct intel_dp *intel_dp)
 104 {
 105         struct edp_vsc_psr psr_vsc;
 106
 107         /* Prepare VSC packet as per EDP 1.3 spec, Table 3.10 */
 108         memset(&psr_vsc, 0, sizeof(psr_vsc));
 109         psr_vsc.sdp_header.HB0 = 0;
 110         psr_vsc.sdp_header.HB1 = 0x7;
 111         psr_vsc.sdp_header.HB2 = 0x2;
 112         psr_vsc.sdp_header.HB3 = 0x8;
 113         intel_psr_write_vsc(intel_dp, &psr_vsc);
 114 }
 115
 116 static void intel_psr_enable_sink(struct intel_dp *intel_dp)
 117 {
 118         struct intel_digital_port *dig_port = dp_to_dig_port(intel_dp);
 119         struct drm_device *dev = dig_port->base.base.dev;
 120         struct drm_i915_private *dev_priv = dev->dev_private;
 121         uint32_t aux_clock_divider;
 122         int precharge = 0x3;
 123         bool only_standby = dev_priv->vbt.psr.full_link;
 124         static const uint8_t aux_msg[] = {
 125                 [0] = DP_AUX_NATIVE_WRITE << 4,
 126                 [1] = DP_SET_POWER >> 8,
 127                 [2] = DP_SET_POWER & 0xff,
 128                 [3] = 1 - 1,
 129                 [4] = DP_SET_POWER_D0,
 130         };
 131         int i;
 132
 133         BUILD_BUG_ON(sizeof(aux_msg) > 20);
 134
 135         aux_clock_divider = intel_dp->get_aux_clock_divider(intel_dp, 0);
 136
 137         if (IS_BROADWELL(dev) && dig_port->port != PORT_A)
 138                 only_standby = true;
 139
 140         /* Enable PSR in sink */
 141         if (intel_dp->psr_dpcd[1] & DP_PSR_NO_TRAIN_ON_EXIT || only_standby)
 142                 drm_dp_dpcd_writeb(&intel_dp->aux, DP_PSR_EN_CFG,
 143                                    DP_PSR_ENABLE & ~DP_PSR_MAIN_LINK_ACTIVE);
 144         else
 145                 drm_dp_dpcd_writeb(&intel_dp->aux, DP_PSR_EN_CFG,
 146                                    DP_PSR_ENABLE | DP_PSR_MAIN_LINK_ACTIVE);
 147
 148         /* Setup AUX registers */
 149         for (i = 0; i < sizeof(aux_msg); i += 4)
 150                 I915_WRITE(EDP_PSR_AUX_DATA1(dev) + i,
 151                            intel_dp_pack_aux(&aux_msg[i], sizeof(aux_msg) - i));
 152
 153         I915_WRITE(EDP_PSR_AUX_CTL(dev),
 154                    DP_AUX_CH_CTL_TIME_OUT_400us |
 155                    (sizeof(aux_msg) << DP_AUX_CH_CTL_MESSAGE_SIZE_SHIFT) |
 156                    (precharge << DP_AUX_CH_CTL_PRECHARGE_2US_SHIFT) |
 157                    (aux_clock_divider << DP_AUX_CH_CTL_BIT_CLOCK_2X_SHIFT));
 158 }
 159
 160 static void intel_psr_enable_source(struct intel_dp *intel_dp)
 161 {
 162         struct intel_digital_port *dig_port = dp_to_dig_port(intel_dp);
 163         struct drm_device *dev = dig_port->base.base.dev;
 164         struct drm_i915_private *dev_priv = dev->dev_private;
 165         uint32_t max_sleep_time = 0x1f;
 166         /* Lately it was identified that depending on panel idle frame count
 167          * calculated at HW can be off by 1. So let's use what came
 168          * from VBT + 1 and at minimum 2 to be on the safe side.
 169          */
 170         uint32_t idle_frames = dev_priv->vbt.psr.idle_frames ?
 171                                dev_priv->vbt.psr.idle_frames + 1 : 2;
 172         uint32_t val = 0x0;
 173         const uint32_t link_entry_time = EDP_PSR_MIN_LINK_ENTRY_TIME_8_LINES;
 174         bool only_standby = false;
 175
 176         if (IS_BROADWELL(dev) && dig_port->port != PORT_A)
 177                 only_standby = true;
 178
 179         if (intel_dp->psr_dpcd[1] & DP_PSR_NO_TRAIN_ON_EXIT || only_standby) {
 180                 val |= EDP_PSR_LINK_STANDBY;
 181                 val |= EDP_PSR_TP2_TP3_TIME_0us;
 182                 val |= EDP_PSR_TP1_TIME_0us;
 183                 val |= EDP_PSR_SKIP_AUX_EXIT;
 184         } else
 185                 val |= EDP_PSR_LINK_DISABLE;
 186
 187         I915_WRITE(EDP_PSR_CTL(dev), val |
 188                    (IS_BROADWELL(dev) ? 0 : link_entry_time) |
 189                    max_sleep_time << EDP_PSR_MAX_SLEEP_TIME_SHIFT |
 190                    idle_frames << EDP_PSR_IDLE_FRAME_SHIFT |
 191                    EDP_PSR_ENABLE);
 192 }
 193
 194 static bool intel_psr_match_conditions(struct intel_dp *intel_dp)
 195 {
 196         struct intel_digital_port *dig_port = dp_to_dig_port(intel_dp);
 197         struct drm_device *dev = dig_port->base.base.dev;
 198         struct drm_i915_private *dev_priv = dev->dev_private;
 199         struct drm_crtc *crtc = dig_port->base.base.crtc;
 200         struct intel_crtc *intel_crtc = to_intel_crtc(crtc);
 201
 202         lockdep_assert_held(&dev_priv->psr.lock);
 203         WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
 204         WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
 205
 206         dev_priv->psr.source_ok = false;
 207
 208         if (IS_HASWELL(dev) && dig_port->port != PORT_A) {
 209                 DRM_DEBUG_KMS("HSW ties PSR to DDI A (eDP)\n");
 210                 return false;
 211         }
 212
 213         if (!i915.enable_psr) {
 214                 DRM_DEBUG_KMS("PSR disable by flag\n");
 215                 return false;
 216         }
 217
 218         /* Below limitations aren't valid for Broadwell */
 219         if (IS_BROADWELL(dev))
 220                 goto out;
 221
 222         if (I915_READ(HSW_STEREO_3D_CTL(intel_crtc->config.cpu_transcoder)) &
 223             S3D_ENABLE) {
 224                 DRM_DEBUG_KMS("PSR condition failed: Stereo 3D is Enabled\n");
 225                 return false;
 226         }
 227
 228         if (intel_crtc->config.adjusted_mode.flags & DRM_MODE_FLAG_INTERLACE) {
 229                 DRM_DEBUG_KMS("PSR condition failed: Interlaced is Enabled\n");
 230                 return false;
 231         }
 232
 233  out:
 234         dev_priv->psr.source_ok = true;
 235         return true;
 236 }
 237
 238 static void intel_psr_do_enable(struct intel_dp *intel_dp)
 239 {
 240         struct intel_digital_port *intel_dig_port = dp_to_dig_port(intel_dp);
 241         struct drm_device *dev = intel_dig_port->base.base.dev;
 242         struct drm_i915_private *dev_priv = dev->dev_private;
 243
 244         WARN_ON(I915_READ(EDP_PSR_CTL(dev)) & EDP_PSR_ENABLE);
 245         WARN_ON(dev_priv->psr.active);
 246         lockdep_assert_held(&dev_priv->psr.lock);
 247
 248         /* Enable/Re-enable PSR on the host */
 249         intel_psr_enable_source(intel_dp);
 250
 251         dev_priv->psr.active = true;
 252 }
 253
 254 /**
 255  * intel_psr_enable - Enable PSR
 256  * @intel_dp: Intel DP
 257  *
 258  * This function can only be called after the pipe is fully trained and enabled.
 259  */
 260 void intel_psr_enable(struct intel_dp *intel_dp)
 261 {
 262         struct intel_digital_port *intel_dig_port = dp_to_dig_port(intel_dp);
 263         struct drm_device *dev = intel_dig_port->base.base.dev;
 264         struct drm_i915_private *dev_priv = dev->dev_private;
 265
 266         if (!HAS_PSR(dev)) {
 267                 DRM_DEBUG_KMS("PSR not supported on this platform\n");
 268                 return;
 269         }
 270
 271         if (!is_edp_psr(intel_dp)) {
 272                 DRM_DEBUG_KMS("PSR not supported by this panel\n");
 273                 return;
 274         }
 275
 276         mutex_lock(&dev_priv->psr.lock);
 277         if (dev_priv->psr.enabled) {
 278                 DRM_DEBUG_KMS("PSR already in use\n");
 279                 goto unlock;
 280         }
 281
 282         if (!intel_psr_match_conditions(intel_dp))
 283                 goto unlock;
 284
 285         dev_priv->psr.busy_frontbuffer_bits = 0;
 286
 287         intel_psr_setup_vsc(intel_dp);
 288
 289         /* Avoid continuous PSR exit by masking memup and hpd */
 290         I915_WRITE(EDP_PSR_DEBUG_CTL(dev), EDP_PSR_DEBUG_MASK_MEMUP |
 291                    EDP_PSR_DEBUG_MASK_HPD | EDP_PSR_DEBUG_MASK_LPSP);
 292
 293         /* Enable PSR on the panel */
 294         intel_psr_enable_sink(intel_dp);
 295
 296         dev_priv->psr.enabled = intel_dp;
 297 unlock:
 298         mutex_unlock(&dev_priv->psr.lock);
 299 }
 300
 301 /**
 302  * intel_psr_disable - Disable PSR
 303  * @intel_dp: Intel DP
 304  *
 305  * This function needs to be called before disabling pipe.
 306  */
 307 void intel_psr_disable(struct intel_dp *intel_dp)
 308 {
 309         struct intel_digital_port *intel_dig_port = dp_to_dig_port(intel_dp);
 310         struct drm_device *dev = intel_dig_port->base.base.dev;
 311         struct drm_i915_private *dev_priv = dev->dev_private;
 312
 313         mutex_lock(&dev_priv->psr.lock);
 314         if (!dev_priv->psr.enabled) {
 315                 mutex_unlock(&dev_priv->psr.lock);
 316                 return;
 317         }
 318
 319         if (dev_priv->psr.active) {
 320                 I915_WRITE(EDP_PSR_CTL(dev),
 321                            I915_READ(EDP_PSR_CTL(dev)) & ~EDP_PSR_ENABLE);
 322
 323                 /* Wait till PSR is idle */
 324                 if (_wait_for((I915_READ(EDP_PSR_STATUS_CTL(dev)) &
 325                                EDP_PSR_STATUS_STATE_MASK) == 0, 2000, 10))
 326                         DRM_ERROR("Timed out waiting for PSR Idle State\n");
 327
 328                 dev_priv->psr.active = false;
 329         } else {
 330                 WARN_ON(I915_READ(EDP_PSR_CTL(dev)) & EDP_PSR_ENABLE);
 331         }
 332
 333         dev_priv->psr.enabled = NULL;
 334         mutex_unlock(&dev_priv->psr.lock);
 335
 336         cancel_delayed_work_sync(&dev_priv->psr.work);
 337 }
 338
 339 static void intel_psr_work(struct work_struct *work)
 340 {
 341         struct drm_i915_private *dev_priv =
 342                 container_of(work, typeof(*dev_priv), psr.work.work);
 343         struct intel_dp *intel_dp = dev_priv->psr.enabled;
 344
 345         /* We have to make sure PSR is ready for re-enable
 346          * otherwise it keeps disabled until next full enable/disable cycle.
 347          * PSR might take some time to get fully disabled
 348          * and be ready for re-enable.
 349          */
 350         if (wait_for((I915_READ(EDP_PSR_STATUS_CTL(dev_priv->dev)) &
 351                       EDP_PSR_STATUS_STATE_MASK) == 0, 50)) {
 352                 DRM_ERROR("Timed out waiting for PSR Idle for re-enable\n");
 353                 return;
 354         }
 355
 356         mutex_lock(&dev_priv->psr.lock);
 357         intel_dp = dev_priv->psr.enabled;
 358
 359         if (!intel_dp)
 360                 goto unlock;
 361
 362         /*
 363          * The delayed work can race with an invalidate hence we need to
 364          * recheck. Since psr_flush first clears this and then reschedules we
 365          * won't ever miss a flush when bailing out here.
 366          */
 367         if (dev_priv->psr.busy_frontbuffer_bits)
 368                 goto unlock;
 369
 370         intel_psr_do_enable(intel_dp);
 371 unlock:
 372         mutex_unlock(&dev_priv->psr.lock);
 373 }
 374
 375 static void intel_psr_exit(struct drm_device *dev)
 376 {
 377         struct drm_i915_private *dev_priv = dev->dev_private;
 378
 379         if (dev_priv->psr.active) {
 380                 u32 val = I915_READ(EDP_PSR_CTL(dev));
 381
 382                 WARN_ON(!(val & EDP_PSR_ENABLE));
 383
 384                 I915_WRITE(EDP_PSR_CTL(dev), val & ~EDP_PSR_ENABLE);
 385
 386                 dev_priv->psr.active = false;
 387         }
 388
 389 }
 390
 391 /**
 392  * intel_psr_invalidate - Invalidade PSR
 393  * @dev: DRM device
 394  * @frontbuffer_bits: frontbuffer plane tracking bits
 395  *
 396  * Since the hardware frontbuffer tracking has gaps we need to integrate
 397  * with the software frontbuffer tracking. This function gets called every
 398  * time frontbuffer rendering starts and a buffer gets dirtied. PSR must be
 399  * disabled if the frontbuffer mask contains a buffer relevant to PSR.
 400  *
 401  * Dirty frontbuffers relevant to PSR are tracked in busy_frontbuffer_bits."
 402  */
 403 void intel_psr_invalidate(struct drm_device *dev,
 404                               unsigned frontbuffer_bits)
 405 {
 406         struct drm_i915_private *dev_priv = dev->dev_private;
 407         struct drm_crtc *crtc;
 408         enum pipe pipe;
 409
 410         mutex_lock(&dev_priv->psr.lock);
 411         if (!dev_priv->psr.enabled) {
 412                 mutex_unlock(&dev_priv->psr.lock);
 413                 return;
 414         }
 415
 416         crtc = dp_to_dig_port(dev_priv->psr.enabled)->base.base.crtc;
 417         pipe = to_intel_crtc(crtc)->pipe;
 418
 419         intel_psr_exit(dev);
 420
 421         frontbuffer_bits &= INTEL_FRONTBUFFER_ALL_MASK(pipe);
 422
 423         dev_priv->psr.busy_frontbuffer_bits |= frontbuffer_bits;
 424         mutex_unlock(&dev_priv->psr.lock);
 425 }
 426
 427 /**
 428  * intel_psr_flush - Flush PSR
 429  * @dev: DRM device
 430  * @frontbuffer_bits: frontbuffer plane tracking bits
 431  *
 432  * Since the hardware frontbuffer tracking has gaps we need to integrate
 433  * with the software frontbuffer tracking. This function gets called every
 434  * time frontbuffer rendering has completed and flushed out to memory. PSR
 435  * can be enabled again if no other frontbuffer relevant to PSR is dirty.
 436  *
 437  * Dirty frontbuffers relevant to PSR are tracked in busy_frontbuffer_bits.
 438  */
 439 void intel_psr_flush(struct drm_device *dev,
 440                          unsigned frontbuffer_bits)
 441 {
 442         struct drm_i915_private *dev_priv = dev->dev_private;
 443         struct drm_crtc *crtc;
 444         enum pipe pipe;
 445
 446         mutex_lock(&dev_priv->psr.lock);
 447         if (!dev_priv->psr.enabled) {
 448                 mutex_unlock(&dev_priv->psr.lock);
 449                 return;
 450         }
 451
 452         crtc = dp_to_dig_port(dev_priv->psr.enabled)->base.base.crtc;
 453         pipe = to_intel_crtc(crtc)->pipe;
 454         dev_priv->psr.busy_frontbuffer_bits &= ~frontbuffer_bits;
 455
 456         /*
 457          * On Haswell sprite plane updates don't result in a psr invalidating
 458          * signal in the hardware. Which means we need to manually fake this in
 459          * software for all flushes, not just when we've seen a preceding
 460          * invalidation through frontbuffer rendering.
 461          */
 462         if (IS_HASWELL(dev) &&
 463             (frontbuffer_bits & INTEL_FRONTBUFFER_SPRITE(pipe)))
 464                 intel_psr_exit(dev);
 465
 466         if (!dev_priv->psr.active && !dev_priv->psr.busy_frontbuffer_bits)
 467                 schedule_delayed_work(&dev_priv->psr.work,
 468                                       msecs_to_jiffies(100));
 469         mutex_unlock(&dev_priv->psr.lock);
 470 }
 471
 472 /**
 473  * intel_psr_init - Init basic PSR work and mutex.
 474  * @dev: DRM device
 475  *
 476  * This function is  called only once at driver load to initialize basic
 477  * PSR stuff.
 478  */
 479 void intel_psr_init(struct drm_device *dev)
 480 {
 481         struct drm_i915_private *dev_priv = dev->dev_private;
 482
 483         INIT_DELAYED_WORK(&dev_priv->psr.work, intel_psr_work);
 484         mutex_init(&dev_priv->psr.lock);
 485 }