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