drivers/gpu/drm/i915/intel_opregion.c

   1 /*
   2  * Copyright 2008 Intel Corporation <hong.liu@intel.com>
   3  * Copyright 2008 Red Hat <mjg@redhat.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sub license, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the
  14  * next paragraph) shall be included in all copies or substantial
  15  * portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20  * NON-INFRINGEMENT.  IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE
  21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  22  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  23  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  *
  26  */
  27
  28 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  29
  30 #include <linux/acpi.h>
  31 #include <linux/acpi_io.h>
  32 #include <acpi/video.h>
  33
  34 #include <drm/drmP.h>
  35 #include <drm/i915_drm.h>
  36 #include "i915_drv.h"
  37 #include "intel_drv.h"
  38
  39 #define PCI_ASLE 0xe4
  40 #define PCI_ASLS 0xfc
  41
  42 #define OPREGION_HEADER_OFFSET 0
  43 #define OPREGION_ACPI_OFFSET   0x100
  44 #define   ACPI_CLID 0x01ac /* current lid state indicator */
  45 #define   ACPI_CDCK 0x01b0 /* current docking state indicator */
  46 #define OPREGION_SWSCI_OFFSET  0x200
  47 #define OPREGION_ASLE_OFFSET   0x300
  48 #define OPREGION_VBT_OFFSET    0x400
  49
  50 #define OPREGION_SIGNATURE "IntelGraphicsMem"
  51 #define MBOX_ACPI      (1<<0)
  52 #define MBOX_SWSCI     (1<<1)
  53 #define MBOX_ASLE      (1<<2)
  54
  55 struct opregion_header {
  56         u8 signature[16];
  57         u32 size;
  58         u32 opregion_ver;
  59         u8 bios_ver[32];
  60         u8 vbios_ver[16];
  61         u8 driver_ver[16];
  62         u32 mboxes;
  63         u8 reserved[164];
  64 } __attribute__((packed));
  65
  66 /* OpRegion mailbox #1: public ACPI methods */
  67 struct opregion_acpi {
  68         u32 drdy;       /* driver readiness */
  69         u32 csts;       /* notification status */
  70         u32 cevt;       /* current event */
  71         u8 rsvd1[20];
  72         u32 didl[8];    /* supported display devices ID list */
  73         u32 cpdl[8];    /* currently presented display list */
  74         u32 cadl[8];    /* currently active display list */
  75         u32 nadl[8];    /* next active devices list */
  76         u32 aslp;       /* ASL sleep time-out */
  77         u32 tidx;       /* toggle table index */
  78         u32 chpd;       /* current hotplug enable indicator */
  79         u32 clid;       /* current lid state*/
  80         u32 cdck;       /* current docking state */
  81         u32 sxsw;       /* Sx state resume */
  82         u32 evts;       /* ASL supported events */
  83         u32 cnot;       /* current OS notification */
  84         u32 nrdy;       /* driver status */
  85         u8 rsvd2[60];
  86 } __attribute__((packed));
  87
  88 /* OpRegion mailbox #2: SWSCI */
  89 struct opregion_swsci {
  90         u32 scic;       /* SWSCI command|status|data */
  91         u32 parm;       /* command parameters */
  92         u32 dslp;       /* driver sleep time-out */
  93         u8 rsvd[244];
  94 } __attribute__((packed));
  95
  96 /* OpRegion mailbox #3: ASLE */
  97 struct opregion_asle {
  98         u32 ardy;       /* driver readiness */
  99         u32 aslc;       /* ASLE interrupt command */
 100         u32 tche;       /* technology enabled indicator */
 101         u32 alsi;       /* current ALS illuminance reading */
 102         u32 bclp;       /* backlight brightness to set */
 103         u32 pfit;       /* panel fitting state */
 104         u32 cblv;       /* current brightness level */
 105         u16 bclm[20];   /* backlight level duty cycle mapping table */
 106         u32 cpfm;       /* current panel fitting mode */
 107         u32 epfm;       /* enabled panel fitting modes */
 108         u8 plut[74];    /* panel LUT and identifier */
 109         u32 pfmb;       /* PWM freq and min brightness */
 110         u8 rsvd[102];
 111 } __attribute__((packed));
 112
 113 /* ASLE irq request bits */
 114 #define ASLE_SET_ALS_ILLUM     (1 << 0)
 115 #define ASLE_SET_BACKLIGHT     (1 << 1)
 116 #define ASLE_SET_PFIT          (1 << 2)
 117 #define ASLE_SET_PWM_FREQ      (1 << 3)
 118 #define ASLE_REQ_MSK           0xf
 119
 120 /* response bits of ASLE irq request */
 121 #define ASLE_ALS_ILLUM_FAILED   (1<<10)
 122 #define ASLE_BACKLIGHT_FAILED   (1<<12)
 123 #define ASLE_PFIT_FAILED        (1<<14)
 124 #define ASLE_PWM_FREQ_FAILED    (1<<16)
 125
 126 /* ASLE backlight brightness to set */
 127 #define ASLE_BCLP_VALID                (1<<31)
 128 #define ASLE_BCLP_MSK          (~(1<<31))
 129
 130 /* ASLE panel fitting request */
 131 #define ASLE_PFIT_VALID         (1<<31)
 132 #define ASLE_PFIT_CENTER (1<<0)
 133 #define ASLE_PFIT_STRETCH_TEXT (1<<1)
 134 #define ASLE_PFIT_STRETCH_GFX (1<<2)
 135
 136 /* PWM frequency and minimum brightness */
 137 #define ASLE_PFMB_BRIGHTNESS_MASK (0xff)
 138 #define ASLE_PFMB_BRIGHTNESS_VALID (1<<8)
 139 #define ASLE_PFMB_PWM_MASK (0x7ffffe00)
 140 #define ASLE_PFMB_PWM_VALID (1<<31)
 141
 142 #define ASLE_CBLV_VALID         (1<<31)
 143
 144 #define ACPI_OTHER_OUTPUT (0<<8)
 145 #define ACPI_VGA_OUTPUT (1<<8)
 146 #define ACPI_TV_OUTPUT (2<<8)
 147 #define ACPI_DIGITAL_OUTPUT (3<<8)
 148 #define ACPI_LVDS_OUTPUT (4<<8)
 149
 150 #ifdef CONFIG_ACPI
 151 static u32 asle_set_backlight(struct drm_device *dev, u32 bclp)
 152 {
 153         struct drm_i915_private *dev_priv = dev->dev_private;
 154         struct opregion_asle __iomem *asle = dev_priv->opregion.asle;
 155         u32 max;
 156
 157         DRM_DEBUG_DRIVER("bclp = 0x%08x\n", bclp);
 158
 159         if (!(bclp & ASLE_BCLP_VALID))
 160                 return ASLE_BACKLIGHT_FAILED;
 161
 162         bclp &= ASLE_BCLP_MSK;
 163         if (bclp > 255)
 164                 return ASLE_BACKLIGHT_FAILED;
 165
 166         max = intel_panel_get_max_backlight(dev);
 167         intel_panel_set_backlight(dev, bclp * max / 255);
 168         iowrite32((bclp*0x64)/0xff | ASLE_CBLV_VALID, &asle->cblv);
 169
 170         return 0;
 171 }
 172
 173 static u32 asle_set_als_illum(struct drm_device *dev, u32 alsi)
 174 {
 175         /* alsi is the current ALS reading in lux. 0 indicates below sensor
 176            range, 0xffff indicates above sensor range. 1-0xfffe are valid */
 177         return 0;
 178 }
 179
 180 static u32 asle_set_pwm_freq(struct drm_device *dev, u32 pfmb)
 181 {
 182         struct drm_i915_private *dev_priv = dev->dev_private;
 183         if (pfmb & ASLE_PFMB_PWM_VALID) {
 184                 u32 blc_pwm_ctl = I915_READ(BLC_PWM_CTL);
 185                 u32 pwm = pfmb & ASLE_PFMB_PWM_MASK;
 186                 blc_pwm_ctl &= BACKLIGHT_DUTY_CYCLE_MASK;
 187                 pwm = pwm >> 9;
 188                 /* FIXME - what do we do with the PWM? */
 189         }
 190         return 0;
 191 }
 192
 193 static u32 asle_set_pfit(struct drm_device *dev, u32 pfit)
 194 {
 195         /* Panel fitting is currently controlled by the X code, so this is a
 196            noop until modesetting support works fully */
 197         if (!(pfit & ASLE_PFIT_VALID))
 198                 return ASLE_PFIT_FAILED;
 199         return 0;
 200 }
 201
 202 void intel_opregion_asle_intr(struct drm_device *dev)
 203 {
 204         struct drm_i915_private *dev_priv = dev->dev_private;
 205         struct opregion_asle __iomem *asle = dev_priv->opregion.asle;
 206         u32 asle_stat = 0;
 207         u32 asle_req;
 208
 209         if (!asle)
 210                 return;
 211
 212         asle_req = ioread32(&asle->aslc) & ASLE_REQ_MSK;
 213
 214         if (!asle_req) {
 215                 DRM_DEBUG_DRIVER("non asle set request??\n");
 216                 return;
 217         }
 218
 219         if (asle_req & ASLE_SET_ALS_ILLUM)
 220                 asle_stat |= asle_set_als_illum(dev, ioread32(&asle->alsi));
 221
 222         if (asle_req & ASLE_SET_BACKLIGHT)
 223                 asle_stat |= asle_set_backlight(dev, ioread32(&asle->bclp));
 224
 225         if (asle_req & ASLE_SET_PFIT)
 226                 asle_stat |= asle_set_pfit(dev, ioread32(&asle->pfit));
 227
 228         if (asle_req & ASLE_SET_PWM_FREQ)
 229                 asle_stat |= asle_set_pwm_freq(dev, ioread32(&asle->pfmb));
 230
 231         iowrite32(asle_stat, &asle->aslc);
 232 }
 233
 234 void intel_opregion_gse_intr(struct drm_device *dev)
 235 {
 236         struct drm_i915_private *dev_priv = dev->dev_private;
 237         struct opregion_asle __iomem *asle = dev_priv->opregion.asle;
 238         u32 asle_stat = 0;
 239         u32 asle_req;
 240
 241         if (!asle)
 242                 return;
 243
 244         asle_req = ioread32(&asle->aslc) & ASLE_REQ_MSK;
 245
 246         if (!asle_req) {
 247                 DRM_DEBUG_DRIVER("non asle set request??\n");
 248                 return;
 249         }
 250
 251         if (asle_req & ASLE_SET_ALS_ILLUM) {
 252                 DRM_DEBUG_DRIVER("Illum is not supported\n");
 253                 asle_stat |= ASLE_ALS_ILLUM_FAILED;
 254         }
 255
 256         if (asle_req & ASLE_SET_BACKLIGHT)
 257                 asle_stat |= asle_set_backlight(dev, ioread32(&asle->bclp));
 258
 259         if (asle_req & ASLE_SET_PFIT) {
 260                 DRM_DEBUG_DRIVER("Pfit is not supported\n");
 261                 asle_stat |= ASLE_PFIT_FAILED;
 262         }
 263
 264         if (asle_req & ASLE_SET_PWM_FREQ) {
 265                 DRM_DEBUG_DRIVER("PWM freq is not supported\n");
 266                 asle_stat |= ASLE_PWM_FREQ_FAILED;
 267         }
 268
 269         iowrite32(asle_stat, &asle->aslc);
 270 }
 271 #define ASLE_ALS_EN    (1<<0)
 272 #define ASLE_BLC_EN    (1<<1)
 273 #define ASLE_PFIT_EN   (1<<2)
 274 #define ASLE_PFMB_EN   (1<<3)
 275
 276 void intel_opregion_enable_asle(struct drm_device *dev)
 277 {
 278         struct drm_i915_private *dev_priv = dev->dev_private;
 279         struct opregion_asle __iomem *asle = dev_priv->opregion.asle;
 280
 281         if (asle) {
 282                 if (IS_MOBILE(dev))
 283                         intel_enable_asle(dev);
 284
 285                 iowrite32(ASLE_ALS_EN | ASLE_BLC_EN | ASLE_PFIT_EN |
 286                           ASLE_PFMB_EN,
 287                           &asle->tche);
 288                 iowrite32(1, &asle->ardy);
 289         }
 290 }
 291
 292 #define ACPI_EV_DISPLAY_SWITCH (1<<0)
 293 #define ACPI_EV_LID            (1<<1)
 294 #define ACPI_EV_DOCK           (1<<2)
 295
 296 static struct intel_opregion *system_opregion;
 297
 298 static int intel_opregion_video_event(struct notifier_block *nb,
 299                                       unsigned long val, void *data)
 300 {
 301         /* The only video events relevant to opregion are 0x80. These indicate
 302            either a docking event, lid switch or display switch request. In
 303            Linux, these are handled by the dock, button and video drivers.
 304         */
 305
 306         struct opregion_acpi __iomem *acpi;
 307         struct acpi_bus_event *event = data;
 308         int ret = NOTIFY_OK;
 309
 310         if (strcmp(event->device_class, ACPI_VIDEO_CLASS) != 0)
 311                 return NOTIFY_DONE;
 312
 313         if (!system_opregion)
 314                 return NOTIFY_DONE;
 315
 316         acpi = system_opregion->acpi;
 317
 318         if (event->type == 0x80 &&
 319             (ioread32(&acpi->cevt) & 1) == 0)
 320                 ret = NOTIFY_BAD;
 321
 322         iowrite32(0, &acpi->csts);
 323
 324         return ret;
 325 }
 326
 327 static struct notifier_block intel_opregion_notifier = {
 328         .notifier_call = intel_opregion_video_event,
 329 };
 330
 331 /*
 332  * Initialise the DIDL field in opregion. This passes a list of devices to
 333  * the firmware. Values are defined by section B.4.2 of the ACPI specification
 334  * (version 3)
 335  */
 336
 337 static void intel_didl_outputs(struct drm_device *dev)
 338 {
 339         struct drm_i915_private *dev_priv = dev->dev_private;
 340         struct intel_opregion *opregion = &dev_priv->opregion;
 341         struct drm_connector *connector;
 342         acpi_handle handle;
 343         struct acpi_device *acpi_dev, *acpi_cdev, *acpi_video_bus = NULL;
 344         unsigned long long device_id;
 345         acpi_status status;
 346         u32 temp;
 347         int i = 0;
 348
 349         handle = DEVICE_ACPI_HANDLE(&dev->pdev->dev);
 350         if (!handle || acpi_bus_get_device(handle, &acpi_dev))
 351                 return;
 352
 353         if (acpi_is_video_device(handle))
 354                 acpi_video_bus = acpi_dev;
 355         else {
 356                 list_for_each_entry(acpi_cdev, &acpi_dev->children, node) {
 357                         if (acpi_is_video_device(acpi_cdev->handle)) {
 358                                 acpi_video_bus = acpi_cdev;
 359                                 break;
 360                         }
 361                 }
 362         }
 363
 364         if (!acpi_video_bus) {
 365                 pr_warn("No ACPI video bus found\n");
 366                 return;
 367         }
 368
 369         list_for_each_entry(acpi_cdev, &acpi_video_bus->children, node) {
 370                 if (i >= 8) {
 371                         dev_printk(KERN_ERR, &dev->pdev->dev,
 372                                     "More than 8 outputs detected\n");
 373                         return;
 374                 }
 375                 status =
 376                         acpi_evaluate_integer(acpi_cdev->handle, "_ADR",
 377                                                 NULL, &device_id);
 378                 if (ACPI_SUCCESS(status)) {
 379                         if (!device_id)
 380                                 goto blind_set;
 381                         iowrite32((u32)(device_id & 0x0f0f),
 382                                   &opregion->acpi->didl[i]);
 383                         i++;
 384                 }
 385         }
 386
 387 end:
 388         /* If fewer than 8 outputs, the list must be null terminated */
 389         if (i < 8)
 390                 iowrite32(0, &opregion->acpi->didl[i]);
 391         return;
 392
 393 blind_set:
 394         i = 0;
 395         list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
 396                 int output_type = ACPI_OTHER_OUTPUT;
 397                 if (i >= 8) {
 398                         dev_printk(KERN_ERR, &dev->pdev->dev,
 399                                     "More than 8 outputs detected\n");
 400                         return;
 401                 }
 402                 switch (connector->connector_type) {
 403                 case DRM_MODE_CONNECTOR_VGA:
 404                 case DRM_MODE_CONNECTOR_DVIA:
 405                         output_type = ACPI_VGA_OUTPUT;
 406                         break;
 407                 case DRM_MODE_CONNECTOR_Composite:
 408                 case DRM_MODE_CONNECTOR_SVIDEO:
 409                 case DRM_MODE_CONNECTOR_Component:
 410                 case DRM_MODE_CONNECTOR_9PinDIN:
 411                         output_type = ACPI_TV_OUTPUT;
 412                         break;
 413                 case DRM_MODE_CONNECTOR_DVII:
 414                 case DRM_MODE_CONNECTOR_DVID:
 415                 case DRM_MODE_CONNECTOR_DisplayPort:
 416                 case DRM_MODE_CONNECTOR_HDMIA:
 417                 case DRM_MODE_CONNECTOR_HDMIB:
 418                         output_type = ACPI_DIGITAL_OUTPUT;
 419                         break;
 420                 case DRM_MODE_CONNECTOR_LVDS:
 421                         output_type = ACPI_LVDS_OUTPUT;
 422                         break;
 423                 }
 424                 temp = ioread32(&opregion->acpi->didl[i]);
 425                 iowrite32(temp | (1<<31) | output_type | i,
 426                           &opregion->acpi->didl[i]);
 427                 i++;
 428         }
 429         goto end;
 430 }
 431
 432 static void intel_setup_cadls(struct drm_device *dev)
 433 {
 434         struct drm_i915_private *dev_priv = dev->dev_private;
 435         struct intel_opregion *opregion = &dev_priv->opregion;
 436         int i = 0;
 437         u32 disp_id;
 438
 439         /* Initialize the CADL field by duplicating the DIDL values.
 440          * Technically, this is not always correct as display outputs may exist,
 441          * but not active. This initialization is necessary for some Clevo
 442          * laptops that check this field before processing the brightness and
 443          * display switching hotkeys. Just like DIDL, CADL is NULL-terminated if
 444          * there are less than eight devices. */
 445         do {
 446                 disp_id = ioread32(&opregion->acpi->didl[i]);
 447                 iowrite32(disp_id, &opregion->acpi->cadl[i]);
 448         } while (++i < 8 && disp_id != 0);
 449 }
 450
 451 void intel_opregion_init(struct drm_device *dev)
 452 {
 453         struct drm_i915_private *dev_priv = dev->dev_private;
 454         struct intel_opregion *opregion = &dev_priv->opregion;
 455
 456         if (!opregion->header)
 457                 return;
 458
 459         if (opregion->acpi) {
 460                 if (drm_core_check_feature(dev, DRIVER_MODESET)) {
 461                         intel_didl_outputs(dev);
 462                         intel_setup_cadls(dev);
 463                 }
 464
 465                 /* Notify BIOS we are ready to handle ACPI video ext notifs.
 466                  * Right now, all the events are handled by the ACPI video module.
 467                  * We don't actually need to do anything with them. */
 468                 iowrite32(0, &opregion->acpi->csts);
 469                 iowrite32(1, &opregion->acpi->drdy);
 470
 471                 system_opregion = opregion;
 472                 register_acpi_notifier(&intel_opregion_notifier);
 473         }
 474
 475         if (opregion->asle)
 476                 intel_opregion_enable_asle(dev);
 477 }
 478
 479 void intel_opregion_fini(struct drm_device *dev)
 480 {
 481         struct drm_i915_private *dev_priv = dev->dev_private;
 482         struct intel_opregion *opregion = &dev_priv->opregion;
 483
 484         if (!opregion->header)
 485                 return;
 486
 487         if (opregion->acpi) {
 488                 iowrite32(0, &opregion->acpi->drdy);
 489
 490                 system_opregion = NULL;
 491                 unregister_acpi_notifier(&intel_opregion_notifier);
 492         }
 493
 494         /* just clear all opregion memory pointers now */
 495         iounmap(opregion->header);
 496         opregion->header = NULL;
 497         opregion->acpi = NULL;
 498         opregion->swsci = NULL;
 499         opregion->asle = NULL;
 500         opregion->vbt = NULL;
 501 }
 502 #endif
 503
 504 int intel_opregion_setup(struct drm_device *dev)
 505 {
 506         struct drm_i915_private *dev_priv = dev->dev_private;
 507         struct intel_opregion *opregion = &dev_priv->opregion;
 508         void __iomem *base;
 509         u32 asls, mboxes;
 510         char buf[sizeof(OPREGION_SIGNATURE)];
 511         int err = 0;
 512
 513         pci_read_config_dword(dev->pdev, PCI_ASLS, &asls);
 514         DRM_DEBUG_DRIVER("graphic opregion physical addr: 0x%x\n", asls);
 515         if (asls == 0) {
 516                 DRM_DEBUG_DRIVER("ACPI OpRegion not supported!\n");
 517                 return -ENOTSUPP;
 518         }
 519
 520         base = acpi_os_ioremap(asls, OPREGION_SIZE);
 521         if (!base)
 522                 return -ENOMEM;
 523
 524         memcpy_fromio(buf, base, sizeof(buf));
 525
 526         if (memcmp(buf, OPREGION_SIGNATURE, 16)) {
 527                 DRM_DEBUG_DRIVER("opregion signature mismatch\n");
 528                 err = -EINVAL;
 529                 goto err_out;
 530         }
 531         opregion->header = base;
 532         opregion->vbt = base + OPREGION_VBT_OFFSET;
 533
 534         opregion->lid_state = base + ACPI_CLID;
 535
 536         mboxes = ioread32(&opregion->header->mboxes);
 537         if (mboxes & MBOX_ACPI) {
 538                 DRM_DEBUG_DRIVER("Public ACPI methods supported\n");
 539                 opregion->acpi = base + OPREGION_ACPI_OFFSET;
 540         }
 541
 542         if (mboxes & MBOX_SWSCI) {
 543                 DRM_DEBUG_DRIVER("SWSCI supported\n");
 544                 opregion->swsci = base + OPREGION_SWSCI_OFFSET;
 545         }
 546         if (mboxes & MBOX_ASLE) {
 547                 DRM_DEBUG_DRIVER("ASLE supported\n");
 548                 opregion->asle = base + OPREGION_ASLE_OFFSET;
 549         }
 550
 551         return 0;
 552
 553 err_out:
 554         iounmap(base);
 555         return err;
 556 }