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