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