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 #include <linux/acpi.h>
  29 #include <linux/dmi.h>
  30 #include <acpi/video.h>
  31
  32 #include <drm/drmP.h>
  33 #include <drm/i915_drm.h>
  34 #include "i915_drv.h"
  35 #include "intel_drv.h"
  36
  37 #define OPREGION_HEADER_OFFSET 0
  38 #define OPREGION_ACPI_OFFSET   0x100
  39 #define   ACPI_CLID 0x01ac /* current lid state indicator */
  40 #define   ACPI_CDCK 0x01b0 /* current docking state indicator */
  41 #define OPREGION_SWSCI_OFFSET  0x200
  42 #define OPREGION_ASLE_OFFSET   0x300
  43 #define OPREGION_VBT_OFFSET    0x400
  44 #define OPREGION_ASLE_EXT_OFFSET        0x1C00
  45
  46 #define OPREGION_SIGNATURE "IntelGraphicsMem"
  47 #define MBOX_ACPI      (1<<0)
  48 #define MBOX_SWSCI     (1<<1)
  49 #define MBOX_ASLE      (1<<2)
  50 #define MBOX_ASLE_EXT  (1<<4)
  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         u32 driver_model;
  61         u32 pcon;
  62         u8 dver[32];
  63         u8 rsvd[124];
  64 } __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         u32 did2[7];    /* extended supported display devices ID list */
  86         u32 cpd2[7];    /* extended attached display devices list */
  87         u8 rsvd2[4];
  88 } __packed;
  89
  90 /* OpRegion mailbox #2: SWSCI */
  91 struct opregion_swsci {
  92         u32 scic;       /* SWSCI command|status|data */
  93         u32 parm;       /* command parameters */
  94         u32 dslp;       /* driver sleep time-out */
  95         u8 rsvd[244];
  96 } __packed;
  97
  98 /* OpRegion mailbox #3: ASLE */
  99 struct opregion_asle {
 100         u32 ardy;       /* driver readiness */
 101         u32 aslc;       /* ASLE interrupt command */
 102         u32 tche;       /* technology enabled indicator */
 103         u32 alsi;       /* current ALS illuminance reading */
 104         u32 bclp;       /* backlight brightness to set */
 105         u32 pfit;       /* panel fitting state */
 106         u32 cblv;       /* current brightness level */
 107         u16 bclm[20];   /* backlight level duty cycle mapping table */
 108         u32 cpfm;       /* current panel fitting mode */
 109         u32 epfm;       /* enabled panel fitting modes */
 110         u8 plut[74];    /* panel LUT and identifier */
 111         u32 pfmb;       /* PWM freq and min brightness */
 112         u32 cddv;       /* color correction default values */
 113         u32 pcft;       /* power conservation features */
 114         u32 srot;       /* supported rotation angles */
 115         u32 iuer;       /* IUER events */
 116         u64 fdss;
 117         u32 fdsp;
 118         u32 stat;
 119         u64 rvda;       /* Physical address of raw vbt data */
 120         u32 rvds;       /* Size of raw vbt data */
 121         u8 rsvd[58];
 122 } __packed;
 123
 124 /* OpRegion mailbox #5: ASLE ext */
 125 struct opregion_asle_ext {
 126         u32 phed;       /* Panel Header */
 127         u8 bddc[256];   /* Panel EDID */
 128         u8 rsvd[764];
 129 } __packed;
 130
 131 /* Driver readiness indicator */
 132 #define ASLE_ARDY_READY         (1 << 0)
 133 #define ASLE_ARDY_NOT_READY     (0 << 0)
 134
 135 /* ASLE Interrupt Command (ASLC) bits */
 136 #define ASLC_SET_ALS_ILLUM              (1 << 0)
 137 #define ASLC_SET_BACKLIGHT              (1 << 1)
 138 #define ASLC_SET_PFIT                   (1 << 2)
 139 #define ASLC_SET_PWM_FREQ               (1 << 3)
 140 #define ASLC_SUPPORTED_ROTATION_ANGLES  (1 << 4)
 141 #define ASLC_BUTTON_ARRAY               (1 << 5)
 142 #define ASLC_CONVERTIBLE_INDICATOR      (1 << 6)
 143 #define ASLC_DOCKING_INDICATOR          (1 << 7)
 144 #define ASLC_ISCT_STATE_CHANGE          (1 << 8)
 145 #define ASLC_REQ_MSK                    0x1ff
 146 /* response bits */
 147 #define ASLC_ALS_ILLUM_FAILED           (1 << 10)
 148 #define ASLC_BACKLIGHT_FAILED           (1 << 12)
 149 #define ASLC_PFIT_FAILED                (1 << 14)
 150 #define ASLC_PWM_FREQ_FAILED            (1 << 16)
 151 #define ASLC_ROTATION_ANGLES_FAILED     (1 << 18)
 152 #define ASLC_BUTTON_ARRAY_FAILED        (1 << 20)
 153 #define ASLC_CONVERTIBLE_FAILED         (1 << 22)
 154 #define ASLC_DOCKING_FAILED             (1 << 24)
 155 #define ASLC_ISCT_STATE_FAILED          (1 << 26)
 156
 157 /* Technology enabled indicator */
 158 #define ASLE_TCHE_ALS_EN        (1 << 0)
 159 #define ASLE_TCHE_BLC_EN        (1 << 1)
 160 #define ASLE_TCHE_PFIT_EN       (1 << 2)
 161 #define ASLE_TCHE_PFMB_EN       (1 << 3)
 162
 163 /* ASLE backlight brightness to set */
 164 #define ASLE_BCLP_VALID                (1<<31)
 165 #define ASLE_BCLP_MSK          (~(1<<31))
 166
 167 /* ASLE panel fitting request */
 168 #define ASLE_PFIT_VALID         (1<<31)
 169 #define ASLE_PFIT_CENTER (1<<0)
 170 #define ASLE_PFIT_STRETCH_TEXT (1<<1)
 171 #define ASLE_PFIT_STRETCH_GFX (1<<2)
 172
 173 /* PWM frequency and minimum brightness */
 174 #define ASLE_PFMB_BRIGHTNESS_MASK (0xff)
 175 #define ASLE_PFMB_BRIGHTNESS_VALID (1<<8)
 176 #define ASLE_PFMB_PWM_MASK (0x7ffffe00)
 177 #define ASLE_PFMB_PWM_VALID (1<<31)
 178
 179 #define ASLE_CBLV_VALID         (1<<31)
 180
 181 /* IUER */
 182 #define ASLE_IUER_DOCKING               (1 << 7)
 183 #define ASLE_IUER_CONVERTIBLE           (1 << 6)
 184 #define ASLE_IUER_ROTATION_LOCK_BTN     (1 << 4)
 185 #define ASLE_IUER_VOLUME_DOWN_BTN       (1 << 3)
 186 #define ASLE_IUER_VOLUME_UP_BTN         (1 << 2)
 187 #define ASLE_IUER_WINDOWS_BTN           (1 << 1)
 188 #define ASLE_IUER_POWER_BTN             (1 << 0)
 189
 190 /* Software System Control Interrupt (SWSCI) */
 191 #define SWSCI_SCIC_INDICATOR            (1 << 0)
 192 #define SWSCI_SCIC_MAIN_FUNCTION_SHIFT  1
 193 #define SWSCI_SCIC_MAIN_FUNCTION_MASK   (0xf << 1)
 194 #define SWSCI_SCIC_SUB_FUNCTION_SHIFT   8
 195 #define SWSCI_SCIC_SUB_FUNCTION_MASK    (0xff << 8)
 196 #define SWSCI_SCIC_EXIT_PARAMETER_SHIFT 8
 197 #define SWSCI_SCIC_EXIT_PARAMETER_MASK  (0xff << 8)
 198 #define SWSCI_SCIC_EXIT_STATUS_SHIFT    5
 199 #define SWSCI_SCIC_EXIT_STATUS_MASK     (7 << 5)
 200 #define SWSCI_SCIC_EXIT_STATUS_SUCCESS  1
 201
 202 #define SWSCI_FUNCTION_CODE(main, sub) \
 203         ((main) << SWSCI_SCIC_MAIN_FUNCTION_SHIFT | \
 204          (sub) << SWSCI_SCIC_SUB_FUNCTION_SHIFT)
 205
 206 /* SWSCI: Get BIOS Data (GBDA) */
 207 #define SWSCI_GBDA                      4
 208 #define SWSCI_GBDA_SUPPORTED_CALLS      SWSCI_FUNCTION_CODE(SWSCI_GBDA, 0)
 209 #define SWSCI_GBDA_REQUESTED_CALLBACKS  SWSCI_FUNCTION_CODE(SWSCI_GBDA, 1)
 210 #define SWSCI_GBDA_BOOT_DISPLAY_PREF    SWSCI_FUNCTION_CODE(SWSCI_GBDA, 4)
 211 #define SWSCI_GBDA_PANEL_DETAILS        SWSCI_FUNCTION_CODE(SWSCI_GBDA, 5)
 212 #define SWSCI_GBDA_TV_STANDARD          SWSCI_FUNCTION_CODE(SWSCI_GBDA, 6)
 213 #define SWSCI_GBDA_INTERNAL_GRAPHICS    SWSCI_FUNCTION_CODE(SWSCI_GBDA, 7)
 214 #define SWSCI_GBDA_SPREAD_SPECTRUM      SWSCI_FUNCTION_CODE(SWSCI_GBDA, 10)
 215
 216 /* SWSCI: System BIOS Callbacks (SBCB) */
 217 #define SWSCI_SBCB                      6
 218 #define SWSCI_SBCB_SUPPORTED_CALLBACKS  SWSCI_FUNCTION_CODE(SWSCI_SBCB, 0)
 219 #define SWSCI_SBCB_INIT_COMPLETION      SWSCI_FUNCTION_CODE(SWSCI_SBCB, 1)
 220 #define SWSCI_SBCB_PRE_HIRES_SET_MODE   SWSCI_FUNCTION_CODE(SWSCI_SBCB, 3)
 221 #define SWSCI_SBCB_POST_HIRES_SET_MODE  SWSCI_FUNCTION_CODE(SWSCI_SBCB, 4)
 222 #define SWSCI_SBCB_DISPLAY_SWITCH       SWSCI_FUNCTION_CODE(SWSCI_SBCB, 5)
 223 #define SWSCI_SBCB_SET_TV_FORMAT        SWSCI_FUNCTION_CODE(SWSCI_SBCB, 6)
 224 #define SWSCI_SBCB_ADAPTER_POWER_STATE  SWSCI_FUNCTION_CODE(SWSCI_SBCB, 7)
 225 #define SWSCI_SBCB_DISPLAY_POWER_STATE  SWSCI_FUNCTION_CODE(SWSCI_SBCB, 8)
 226 #define SWSCI_SBCB_SET_BOOT_DISPLAY     SWSCI_FUNCTION_CODE(SWSCI_SBCB, 9)
 227 #define SWSCI_SBCB_SET_PANEL_DETAILS    SWSCI_FUNCTION_CODE(SWSCI_SBCB, 10)
 228 #define SWSCI_SBCB_SET_INTERNAL_GFX     SWSCI_FUNCTION_CODE(SWSCI_SBCB, 11)
 229 #define SWSCI_SBCB_POST_HIRES_TO_DOS_FS SWSCI_FUNCTION_CODE(SWSCI_SBCB, 16)
 230 #define SWSCI_SBCB_SUSPEND_RESUME       SWSCI_FUNCTION_CODE(SWSCI_SBCB, 17)
 231 #define SWSCI_SBCB_SET_SPREAD_SPECTRUM  SWSCI_FUNCTION_CODE(SWSCI_SBCB, 18)
 232 #define SWSCI_SBCB_POST_VBE_PM          SWSCI_FUNCTION_CODE(SWSCI_SBCB, 19)
 233 #define SWSCI_SBCB_ENABLE_DISABLE_AUDIO SWSCI_FUNCTION_CODE(SWSCI_SBCB, 21)
 234
 235 #define ACPI_OTHER_OUTPUT (0<<8)
 236 #define ACPI_VGA_OUTPUT (1<<8)
 237 #define ACPI_TV_OUTPUT (2<<8)
 238 #define ACPI_DIGITAL_OUTPUT (3<<8)
 239 #define ACPI_LVDS_OUTPUT (4<<8)
 240
 241 #define MAX_DSLP        1500
 242
 243 static int swsci(struct drm_device *dev, u32 function, u32 parm, u32 *parm_out)
 244 {
 245         struct drm_i915_private *dev_priv = dev->dev_private;
 246         struct opregion_swsci *swsci = dev_priv->opregion.swsci;
 247         u32 main_function, sub_function, scic;
 248         u16 swsci_val;
 249         u32 dslp;
 250
 251         if (!swsci)
 252                 return -ENODEV;
 253
 254         main_function = (function & SWSCI_SCIC_MAIN_FUNCTION_MASK) >>
 255                 SWSCI_SCIC_MAIN_FUNCTION_SHIFT;
 256         sub_function = (function & SWSCI_SCIC_SUB_FUNCTION_MASK) >>
 257                 SWSCI_SCIC_SUB_FUNCTION_SHIFT;
 258
 259         /* Check if we can call the function. See swsci_setup for details. */
 260         if (main_function == SWSCI_SBCB) {
 261                 if ((dev_priv->opregion.swsci_sbcb_sub_functions &
 262                      (1 << sub_function)) == 0)
 263                         return -EINVAL;
 264         } else if (main_function == SWSCI_GBDA) {
 265                 if ((dev_priv->opregion.swsci_gbda_sub_functions &
 266                      (1 << sub_function)) == 0)
 267                         return -EINVAL;
 268         }
 269
 270         /* Driver sleep timeout in ms. */
 271         dslp = swsci->dslp;
 272         if (!dslp) {
 273                 /* The spec says 2ms should be the default, but it's too small
 274                  * for some machines. */
 275                 dslp = 50;
 276         } else if (dslp > MAX_DSLP) {
 277                 /* Hey bios, trust must be earned. */
 278                 DRM_INFO_ONCE("ACPI BIOS requests an excessive sleep of %u ms, "
 279                               "using %u ms instead\n", dslp, MAX_DSLP);
 280                 dslp = MAX_DSLP;
 281         }
 282
 283         /* The spec tells us to do this, but we are the only user... */
 284         scic = swsci->scic;
 285         if (scic & SWSCI_SCIC_INDICATOR) {
 286                 DRM_DEBUG_DRIVER("SWSCI request already in progress\n");
 287                 return -EBUSY;
 288         }
 289
 290         scic = function | SWSCI_SCIC_INDICATOR;
 291
 292         swsci->parm = parm;
 293         swsci->scic = scic;
 294
 295         /* Ensure SCI event is selected and event trigger is cleared. */
 296         pci_read_config_word(dev->pdev, SWSCI, &swsci_val);
 297         if (!(swsci_val & SWSCI_SCISEL) || (swsci_val & SWSCI_GSSCIE)) {
 298                 swsci_val |= SWSCI_SCISEL;
 299                 swsci_val &= ~SWSCI_GSSCIE;
 300                 pci_write_config_word(dev->pdev, SWSCI, swsci_val);
 301         }
 302
 303         /* Use event trigger to tell bios to check the mail. */
 304         swsci_val |= SWSCI_GSSCIE;
 305         pci_write_config_word(dev->pdev, SWSCI, swsci_val);
 306
 307         /* Poll for the result. */
 308 #define C (((scic = swsci->scic) & SWSCI_SCIC_INDICATOR) == 0)
 309         if (wait_for(C, dslp)) {
 310                 DRM_DEBUG_DRIVER("SWSCI request timed out\n");
 311                 return -ETIMEDOUT;
 312         }
 313
 314         scic = (scic & SWSCI_SCIC_EXIT_STATUS_MASK) >>
 315                 SWSCI_SCIC_EXIT_STATUS_SHIFT;
 316
 317         /* Note: scic == 0 is an error! */
 318         if (scic != SWSCI_SCIC_EXIT_STATUS_SUCCESS) {
 319                 DRM_DEBUG_DRIVER("SWSCI request error %u\n", scic);
 320                 return -EIO;
 321         }
 322
 323         if (parm_out)
 324                 *parm_out = swsci->parm;
 325
 326         return 0;
 327
 328 #undef C
 329 }
 330
 331 #define DISPLAY_TYPE_CRT                        0
 332 #define DISPLAY_TYPE_TV                         1
 333 #define DISPLAY_TYPE_EXTERNAL_FLAT_PANEL        2
 334 #define DISPLAY_TYPE_INTERNAL_FLAT_PANEL        3
 335
 336 int intel_opregion_notify_encoder(struct intel_encoder *intel_encoder,
 337                                   bool enable)
 338 {
 339         struct drm_device *dev = intel_encoder->base.dev;
 340         u32 parm = 0;
 341         u32 type = 0;
 342         u32 port;
 343
 344         /* don't care about old stuff for now */
 345         if (!HAS_DDI(dev))
 346                 return 0;
 347
 348         if (intel_encoder->type == INTEL_OUTPUT_DSI)
 349                 port = 0;
 350         else
 351                 port = intel_ddi_get_encoder_port(intel_encoder);
 352
 353         if (port == PORT_E)  {
 354                 port = 0;
 355         } else {
 356                 parm |= 1 << port;
 357                 port++;
 358         }
 359
 360         if (!enable)
 361                 parm |= 4 << 8;
 362
 363         switch (intel_encoder->type) {
 364         case INTEL_OUTPUT_ANALOG:
 365                 type = DISPLAY_TYPE_CRT;
 366                 break;
 367         case INTEL_OUTPUT_UNKNOWN:
 368         case INTEL_OUTPUT_DISPLAYPORT:
 369         case INTEL_OUTPUT_HDMI:
 370         case INTEL_OUTPUT_DP_MST:
 371                 type = DISPLAY_TYPE_EXTERNAL_FLAT_PANEL;
 372                 break;
 373         case INTEL_OUTPUT_EDP:
 374         case INTEL_OUTPUT_DSI:
 375                 type = DISPLAY_TYPE_INTERNAL_FLAT_PANEL;
 376                 break;
 377         default:
 378                 WARN_ONCE(1, "unsupported intel_encoder type %d\n",
 379                           intel_encoder->type);
 380                 return -EINVAL;
 381         }
 382
 383         parm |= type << (16 + port * 3);
 384
 385         return swsci(dev, SWSCI_SBCB_DISPLAY_POWER_STATE, parm, NULL);
 386 }
 387
 388 static const struct {
 389         pci_power_t pci_power_state;
 390         u32 parm;
 391 } power_state_map[] = {
 392         { PCI_D0,       0x00 },
 393         { PCI_D1,       0x01 },
 394         { PCI_D2,       0x02 },
 395         { PCI_D3hot,    0x04 },
 396         { PCI_D3cold,   0x04 },
 397 };
 398
 399 int intel_opregion_notify_adapter(struct drm_device *dev, pci_power_t state)
 400 {
 401         int i;
 402
 403         if (!HAS_DDI(dev))
 404                 return 0;
 405
 406         for (i = 0; i < ARRAY_SIZE(power_state_map); i++) {
 407                 if (state == power_state_map[i].pci_power_state)
 408                         return swsci(dev, SWSCI_SBCB_ADAPTER_POWER_STATE,
 409                                      power_state_map[i].parm, NULL);
 410         }
 411
 412         return -EINVAL;
 413 }
 414
 415 static u32 asle_set_backlight(struct drm_device *dev, u32 bclp)
 416 {
 417         struct drm_i915_private *dev_priv = dev->dev_private;
 418         struct intel_connector *connector;
 419         struct opregion_asle *asle = dev_priv->opregion.asle;
 420
 421         DRM_DEBUG_DRIVER("bclp = 0x%08x\n", bclp);
 422
 423         if (acpi_video_get_backlight_type() == acpi_backlight_native) {
 424                 DRM_DEBUG_KMS("opregion backlight request ignored\n");
 425                 return 0;
 426         }
 427
 428         if (!(bclp & ASLE_BCLP_VALID))
 429                 return ASLC_BACKLIGHT_FAILED;
 430
 431         bclp &= ASLE_BCLP_MSK;
 432         if (bclp > 255)
 433                 return ASLC_BACKLIGHT_FAILED;
 434
 435         drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
 436
 437         /*
 438          * Update backlight on all connectors that support backlight (usually
 439          * only one).
 440          */
 441         DRM_DEBUG_KMS("updating opregion backlight %d/255\n", bclp);
 442         for_each_intel_connector(dev, connector)
 443                 intel_panel_set_backlight_acpi(connector, bclp, 255);
 444         asle->cblv = DIV_ROUND_UP(bclp * 100, 255) | ASLE_CBLV_VALID;
 445
 446         drm_modeset_unlock(&dev->mode_config.connection_mutex);
 447
 448
 449         return 0;
 450 }
 451
 452 static u32 asle_set_als_illum(struct drm_device *dev, u32 alsi)
 453 {
 454         /* alsi is the current ALS reading in lux. 0 indicates below sensor
 455            range, 0xffff indicates above sensor range. 1-0xfffe are valid */
 456         DRM_DEBUG_DRIVER("Illum is not supported\n");
 457         return ASLC_ALS_ILLUM_FAILED;
 458 }
 459
 460 static u32 asle_set_pwm_freq(struct drm_device *dev, u32 pfmb)
 461 {
 462         DRM_DEBUG_DRIVER("PWM freq is not supported\n");
 463         return ASLC_PWM_FREQ_FAILED;
 464 }
 465
 466 static u32 asle_set_pfit(struct drm_device *dev, u32 pfit)
 467 {
 468         /* Panel fitting is currently controlled by the X code, so this is a
 469            noop until modesetting support works fully */
 470         DRM_DEBUG_DRIVER("Pfit is not supported\n");
 471         return ASLC_PFIT_FAILED;
 472 }
 473
 474 static u32 asle_set_supported_rotation_angles(struct drm_device *dev, u32 srot)
 475 {
 476         DRM_DEBUG_DRIVER("SROT is not supported\n");
 477         return ASLC_ROTATION_ANGLES_FAILED;
 478 }
 479
 480 static u32 asle_set_button_array(struct drm_device *dev, u32 iuer)
 481 {
 482         if (!iuer)
 483                 DRM_DEBUG_DRIVER("Button array event is not supported (nothing)\n");
 484         if (iuer & ASLE_IUER_ROTATION_LOCK_BTN)
 485                 DRM_DEBUG_DRIVER("Button array event is not supported (rotation lock)\n");
 486         if (iuer & ASLE_IUER_VOLUME_DOWN_BTN)
 487                 DRM_DEBUG_DRIVER("Button array event is not supported (volume down)\n");
 488         if (iuer & ASLE_IUER_VOLUME_UP_BTN)
 489                 DRM_DEBUG_DRIVER("Button array event is not supported (volume up)\n");
 490         if (iuer & ASLE_IUER_WINDOWS_BTN)
 491                 DRM_DEBUG_DRIVER("Button array event is not supported (windows)\n");
 492         if (iuer & ASLE_IUER_POWER_BTN)
 493                 DRM_DEBUG_DRIVER("Button array event is not supported (power)\n");
 494
 495         return ASLC_BUTTON_ARRAY_FAILED;
 496 }
 497
 498 static u32 asle_set_convertible(struct drm_device *dev, u32 iuer)
 499 {
 500         if (iuer & ASLE_IUER_CONVERTIBLE)
 501                 DRM_DEBUG_DRIVER("Convertible is not supported (clamshell)\n");
 502         else
 503                 DRM_DEBUG_DRIVER("Convertible is not supported (slate)\n");
 504
 505         return ASLC_CONVERTIBLE_FAILED;
 506 }
 507
 508 static u32 asle_set_docking(struct drm_device *dev, u32 iuer)
 509 {
 510         if (iuer & ASLE_IUER_DOCKING)
 511                 DRM_DEBUG_DRIVER("Docking is not supported (docked)\n");
 512         else
 513                 DRM_DEBUG_DRIVER("Docking is not supported (undocked)\n");
 514
 515         return ASLC_DOCKING_FAILED;
 516 }
 517
 518 static u32 asle_isct_state(struct drm_device *dev)
 519 {
 520         DRM_DEBUG_DRIVER("ISCT is not supported\n");
 521         return ASLC_ISCT_STATE_FAILED;
 522 }
 523
 524 static void asle_work(struct work_struct *work)
 525 {
 526         struct intel_opregion *opregion =
 527                 container_of(work, struct intel_opregion, asle_work);
 528         struct drm_i915_private *dev_priv =
 529                 container_of(opregion, struct drm_i915_private, opregion);
 530         struct drm_device *dev = dev_priv->dev;
 531         struct opregion_asle *asle = dev_priv->opregion.asle;
 532         u32 aslc_stat = 0;
 533         u32 aslc_req;
 534
 535         if (!asle)
 536                 return;
 537
 538         aslc_req = asle->aslc;
 539
 540         if (!(aslc_req & ASLC_REQ_MSK)) {
 541                 DRM_DEBUG_DRIVER("No request on ASLC interrupt 0x%08x\n",
 542                                  aslc_req);
 543                 return;
 544         }
 545
 546         if (aslc_req & ASLC_SET_ALS_ILLUM)
 547                 aslc_stat |= asle_set_als_illum(dev, asle->alsi);
 548
 549         if (aslc_req & ASLC_SET_BACKLIGHT)
 550                 aslc_stat |= asle_set_backlight(dev, asle->bclp);
 551
 552         if (aslc_req & ASLC_SET_PFIT)
 553                 aslc_stat |= asle_set_pfit(dev, asle->pfit);
 554
 555         if (aslc_req & ASLC_SET_PWM_FREQ)
 556                 aslc_stat |= asle_set_pwm_freq(dev, asle->pfmb);
 557
 558         if (aslc_req & ASLC_SUPPORTED_ROTATION_ANGLES)
 559                 aslc_stat |= asle_set_supported_rotation_angles(dev,
 560                                                         asle->srot);
 561
 562         if (aslc_req & ASLC_BUTTON_ARRAY)
 563                 aslc_stat |= asle_set_button_array(dev, asle->iuer);
 564
 565         if (aslc_req & ASLC_CONVERTIBLE_INDICATOR)
 566                 aslc_stat |= asle_set_convertible(dev, asle->iuer);
 567
 568         if (aslc_req & ASLC_DOCKING_INDICATOR)
 569                 aslc_stat |= asle_set_docking(dev, asle->iuer);
 570
 571         if (aslc_req & ASLC_ISCT_STATE_CHANGE)
 572                 aslc_stat |= asle_isct_state(dev);
 573
 574         asle->aslc = aslc_stat;
 575 }
 576
 577 void intel_opregion_asle_intr(struct drm_device *dev)
 578 {
 579         struct drm_i915_private *dev_priv = dev->dev_private;
 580
 581         if (dev_priv->opregion.asle)
 582                 schedule_work(&dev_priv->opregion.asle_work);
 583 }
 584
 585 #define ACPI_EV_DISPLAY_SWITCH (1<<0)
 586 #define ACPI_EV_LID            (1<<1)
 587 #define ACPI_EV_DOCK           (1<<2)
 588
 589 static struct intel_opregion *system_opregion;
 590
 591 static int intel_opregion_video_event(struct notifier_block *nb,
 592                                       unsigned long val, void *data)
 593 {
 594         /* The only video events relevant to opregion are 0x80. These indicate
 595            either a docking event, lid switch or display switch request. In
 596            Linux, these are handled by the dock, button and video drivers.
 597         */
 598
 599         struct acpi_bus_event *event = data;
 600         struct opregion_acpi *acpi;
 601         int ret = NOTIFY_OK;
 602
 603         if (strcmp(event->device_class, ACPI_VIDEO_CLASS) != 0)
 604                 return NOTIFY_DONE;
 605
 606         if (!system_opregion)
 607                 return NOTIFY_DONE;
 608
 609         acpi = system_opregion->acpi;
 610
 611         if (event->type == 0x80 && ((acpi->cevt & 1) == 0))
 612                 ret = NOTIFY_BAD;
 613
 614         acpi->csts = 0;
 615
 616         return ret;
 617 }
 618
 619 static struct notifier_block intel_opregion_notifier = {
 620         .notifier_call = intel_opregion_video_event,
 621 };
 622
 623 /*
 624  * Initialise the DIDL field in opregion. This passes a list of devices to
 625  * the firmware. Values are defined by section B.4.2 of the ACPI specification
 626  * (version 3)
 627  */
 628
 629 static u32 get_did(struct intel_opregion *opregion, int i)
 630 {
 631         u32 did;
 632
 633         if (i < ARRAY_SIZE(opregion->acpi->didl)) {
 634                 did = opregion->acpi->didl[i];
 635         } else {
 636                 i -= ARRAY_SIZE(opregion->acpi->didl);
 637
 638                 if (WARN_ON(i >= ARRAY_SIZE(opregion->acpi->did2)))
 639                         return 0;
 640
 641                 did = opregion->acpi->did2[i];
 642         }
 643
 644         return did;
 645 }
 646
 647 static void set_did(struct intel_opregion *opregion, int i, u32 val)
 648 {
 649         if (i < ARRAY_SIZE(opregion->acpi->didl)) {
 650                 opregion->acpi->didl[i] = val;
 651         } else {
 652                 i -= ARRAY_SIZE(opregion->acpi->didl);
 653
 654                 if (WARN_ON(i >= ARRAY_SIZE(opregion->acpi->did2)))
 655                         return;
 656
 657                 opregion->acpi->did2[i] = val;
 658         }
 659 }
 660
 661 static void intel_didl_outputs(struct drm_device *dev)
 662 {
 663         struct drm_i915_private *dev_priv = dev->dev_private;
 664         struct intel_opregion *opregion = &dev_priv->opregion;
 665         struct drm_connector *connector;
 666         acpi_handle handle;
 667         struct acpi_device *acpi_dev, *acpi_cdev, *acpi_video_bus = NULL;
 668         unsigned long long device_id;
 669         acpi_status status;
 670         u32 temp, max_outputs;
 671         int i = 0;
 672
 673         handle = ACPI_HANDLE(&dev->pdev->dev);
 674         if (!handle || acpi_bus_get_device(handle, &acpi_dev))
 675                 return;
 676
 677         if (acpi_is_video_device(handle))
 678                 acpi_video_bus = acpi_dev;
 679         else {
 680                 list_for_each_entry(acpi_cdev, &acpi_dev->children, node) {
 681                         if (acpi_is_video_device(acpi_cdev->handle)) {
 682                                 acpi_video_bus = acpi_cdev;
 683                                 break;
 684                         }
 685                 }
 686         }
 687
 688         if (!acpi_video_bus) {
 689                 DRM_DEBUG_KMS("No ACPI video bus found\n");
 690                 return;
 691         }
 692
 693         /*
 694          * In theory, did2, the extended didl, gets added at opregion version
 695          * 3.0. In practice, however, we're supposed to set it for earlier
 696          * versions as well, since a BIOS that doesn't understand did2 should
 697          * not look at it anyway. Use a variable so we can tweak this if a need
 698          * arises later.
 699          */
 700         max_outputs = ARRAY_SIZE(opregion->acpi->didl) +
 701                 ARRAY_SIZE(opregion->acpi->did2);
 702
 703         list_for_each_entry(acpi_cdev, &acpi_video_bus->children, node) {
 704                 if (i >= max_outputs) {
 705                         DRM_DEBUG_KMS("More than %u outputs detected via ACPI\n",
 706                                       max_outputs);
 707                         return;
 708                 }
 709                 status = acpi_evaluate_integer(acpi_cdev->handle, "_ADR",
 710                                                NULL, &device_id);
 711                 if (ACPI_SUCCESS(status)) {
 712                         if (!device_id)
 713                                 goto blind_set;
 714                         set_did(opregion, i++, (u32)(device_id & 0x0f0f));
 715                 }
 716         }
 717
 718 end:
 719         DRM_DEBUG_KMS("%d outputs detected\n", i);
 720
 721         /* If fewer than max outputs, the list must be null terminated */
 722         if (i < max_outputs)
 723                 set_did(opregion, i, 0);
 724         return;
 725
 726 blind_set:
 727         i = 0;
 728         list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
 729                 int output_type = ACPI_OTHER_OUTPUT;
 730                 if (i >= max_outputs) {
 731                         DRM_DEBUG_KMS("More than %u outputs in connector list\n",
 732                                       max_outputs);
 733                         return;
 734                 }
 735                 switch (connector->connector_type) {
 736                 case DRM_MODE_CONNECTOR_VGA:
 737                 case DRM_MODE_CONNECTOR_DVIA:
 738                         output_type = ACPI_VGA_OUTPUT;
 739                         break;
 740                 case DRM_MODE_CONNECTOR_Composite:
 741                 case DRM_MODE_CONNECTOR_SVIDEO:
 742                 case DRM_MODE_CONNECTOR_Component:
 743                 case DRM_MODE_CONNECTOR_9PinDIN:
 744                         output_type = ACPI_TV_OUTPUT;
 745                         break;
 746                 case DRM_MODE_CONNECTOR_DVII:
 747                 case DRM_MODE_CONNECTOR_DVID:
 748                 case DRM_MODE_CONNECTOR_DisplayPort:
 749                 case DRM_MODE_CONNECTOR_HDMIA:
 750                 case DRM_MODE_CONNECTOR_HDMIB:
 751                         output_type = ACPI_DIGITAL_OUTPUT;
 752                         break;
 753                 case DRM_MODE_CONNECTOR_LVDS:
 754                         output_type = ACPI_LVDS_OUTPUT;
 755                         break;
 756                 }
 757                 temp = get_did(opregion, i);
 758                 set_did(opregion, i, temp | (1 << 31) | output_type | i);
 759                 i++;
 760         }
 761         goto end;
 762 }
 763
 764 static void intel_setup_cadls(struct drm_device *dev)
 765 {
 766         struct drm_i915_private *dev_priv = dev->dev_private;
 767         struct intel_opregion *opregion = &dev_priv->opregion;
 768         int i = 0;
 769         u32 disp_id;
 770
 771         /* Initialize the CADL field by duplicating the DIDL values.
 772          * Technically, this is not always correct as display outputs may exist,
 773          * but not active. This initialization is necessary for some Clevo
 774          * laptops that check this field before processing the brightness and
 775          * display switching hotkeys. Just like DIDL, CADL is NULL-terminated if
 776          * there are less than eight devices. */
 777         do {
 778                 disp_id = get_did(opregion, i);
 779                 opregion->acpi->cadl[i] = disp_id;
 780         } while (++i < 8 && disp_id != 0);
 781 }
 782
 783 void intel_opregion_init(struct drm_device *dev)
 784 {
 785         struct drm_i915_private *dev_priv = dev->dev_private;
 786         struct intel_opregion *opregion = &dev_priv->opregion;
 787
 788         if (!opregion->header)
 789                 return;
 790
 791         if (opregion->acpi) {
 792                 intel_didl_outputs(dev);
 793                 intel_setup_cadls(dev);
 794
 795                 /* Notify BIOS we are ready to handle ACPI video ext notifs.
 796                  * Right now, all the events are handled by the ACPI video module.
 797                  * We don't actually need to do anything with them. */
 798                 opregion->acpi->csts = 0;
 799                 opregion->acpi->drdy = 1;
 800
 801                 system_opregion = opregion;
 802                 register_acpi_notifier(&intel_opregion_notifier);
 803         }
 804
 805         if (opregion->asle) {
 806                 opregion->asle->tche = ASLE_TCHE_BLC_EN;
 807                 opregion->asle->ardy = ASLE_ARDY_READY;
 808         }
 809 }
 810
 811 void intel_opregion_fini(struct drm_device *dev)
 812 {
 813         struct drm_i915_private *dev_priv = dev->dev_private;
 814         struct intel_opregion *opregion = &dev_priv->opregion;
 815
 816         if (!opregion->header)
 817                 return;
 818
 819         if (opregion->asle)
 820                 opregion->asle->ardy = ASLE_ARDY_NOT_READY;
 821
 822         cancel_work_sync(&dev_priv->opregion.asle_work);
 823
 824         if (opregion->acpi) {
 825                 opregion->acpi->drdy = 0;
 826
 827                 system_opregion = NULL;
 828                 unregister_acpi_notifier(&intel_opregion_notifier);
 829         }
 830
 831         /* just clear all opregion memory pointers now */
 832         memunmap(opregion->header);
 833         if (opregion->rvda) {
 834                 memunmap(opregion->rvda);
 835                 opregion->rvda = NULL;
 836         }
 837         opregion->header = NULL;
 838         opregion->acpi = NULL;
 839         opregion->swsci = NULL;
 840         opregion->asle = NULL;
 841         opregion->vbt = NULL;
 842         opregion->lid_state = NULL;
 843 }
 844
 845 static void swsci_setup(struct drm_device *dev)
 846 {
 847         struct drm_i915_private *dev_priv = dev->dev_private;
 848         struct intel_opregion *opregion = &dev_priv->opregion;
 849         bool requested_callbacks = false;
 850         u32 tmp;
 851
 852         /* Sub-function code 0 is okay, let's allow them. */
 853         opregion->swsci_gbda_sub_functions = 1;
 854         opregion->swsci_sbcb_sub_functions = 1;
 855
 856         /* We use GBDA to ask for supported GBDA calls. */
 857         if (swsci(dev, SWSCI_GBDA_SUPPORTED_CALLS, 0, &tmp) == 0) {
 858                 /* make the bits match the sub-function codes */
 859                 tmp <<= 1;
 860                 opregion->swsci_gbda_sub_functions |= tmp;
 861         }
 862
 863         /*
 864          * We also use GBDA to ask for _requested_ SBCB callbacks. The driver
 865          * must not call interfaces that are not specifically requested by the
 866          * bios.
 867          */
 868         if (swsci(dev, SWSCI_GBDA_REQUESTED_CALLBACKS, 0, &tmp) == 0) {
 869                 /* here, the bits already match sub-function codes */
 870                 opregion->swsci_sbcb_sub_functions |= tmp;
 871                 requested_callbacks = true;
 872         }
 873
 874         /*
 875          * But we use SBCB to ask for _supported_ SBCB calls. This does not mean
 876          * the callback is _requested_. But we still can't call interfaces that
 877          * are not requested.
 878          */
 879         if (swsci(dev, SWSCI_SBCB_SUPPORTED_CALLBACKS, 0, &tmp) == 0) {
 880                 /* make the bits match the sub-function codes */
 881                 u32 low = tmp & 0x7ff;
 882                 u32 high = tmp & ~0xfff; /* bit 11 is reserved */
 883                 tmp = (high << 4) | (low << 1) | 1;
 884
 885                 /* best guess what to do with supported wrt requested */
 886                 if (requested_callbacks) {
 887                         u32 req = opregion->swsci_sbcb_sub_functions;
 888                         if ((req & tmp) != req)
 889                                 DRM_DEBUG_DRIVER("SWSCI BIOS requested (%08x) SBCB callbacks that are not supported (%08x)\n", req, tmp);
 890                         /* XXX: for now, trust the requested callbacks */
 891                         /* opregion->swsci_sbcb_sub_functions &= tmp; */
 892                 } else {
 893                         opregion->swsci_sbcb_sub_functions |= tmp;
 894                 }
 895         }
 896
 897         DRM_DEBUG_DRIVER("SWSCI GBDA callbacks %08x, SBCB callbacks %08x\n",
 898                          opregion->swsci_gbda_sub_functions,
 899                          opregion->swsci_sbcb_sub_functions);
 900 }
 901
 902 static int intel_no_opregion_vbt_callback(const struct dmi_system_id *id)
 903 {
 904         DRM_DEBUG_KMS("Falling back to manually reading VBT from "
 905                       "VBIOS ROM for %s\n", id->ident);
 906         return 1;
 907 }
 908
 909 static const struct dmi_system_id intel_no_opregion_vbt[] = {
 910         {
 911                 .callback = intel_no_opregion_vbt_callback,
 912                 .ident = "ThinkCentre A57",
 913                 .matches = {
 914                         DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
 915                         DMI_MATCH(DMI_PRODUCT_NAME, "97027RG"),
 916                 },
 917         },
 918         { }
 919 };
 920
 921 int intel_opregion_setup(struct drm_device *dev)
 922 {
 923         struct drm_i915_private *dev_priv = dev->dev_private;
 924         struct intel_opregion *opregion = &dev_priv->opregion;
 925         u32 asls, mboxes;
 926         char buf[sizeof(OPREGION_SIGNATURE)];
 927         int err = 0;
 928         void *base;
 929
 930         BUILD_BUG_ON(sizeof(struct opregion_header) != 0x100);
 931         BUILD_BUG_ON(sizeof(struct opregion_acpi) != 0x100);
 932         BUILD_BUG_ON(sizeof(struct opregion_swsci) != 0x100);
 933         BUILD_BUG_ON(sizeof(struct opregion_asle) != 0x100);
 934         BUILD_BUG_ON(sizeof(struct opregion_asle_ext) != 0x400);
 935
 936         pci_read_config_dword(dev->pdev, ASLS, &asls);
 937         DRM_DEBUG_DRIVER("graphic opregion physical addr: 0x%x\n", asls);
 938         if (asls == 0) {
 939                 DRM_DEBUG_DRIVER("ACPI OpRegion not supported!\n");
 940                 return -ENOTSUPP;
 941         }
 942
 943         INIT_WORK(&opregion->asle_work, asle_work);
 944
 945         base = memremap(asls, OPREGION_SIZE, MEMREMAP_WB);
 946         if (!base)
 947                 return -ENOMEM;
 948
 949         memcpy(buf, base, sizeof(buf));
 950
 951         if (memcmp(buf, OPREGION_SIGNATURE, 16)) {
 952                 DRM_DEBUG_DRIVER("opregion signature mismatch\n");
 953                 err = -EINVAL;
 954                 goto err_out;
 955         }
 956         opregion->header = base;
 957         opregion->lid_state = base + ACPI_CLID;
 958
 959         mboxes = opregion->header->mboxes;
 960         if (mboxes & MBOX_ACPI) {
 961                 DRM_DEBUG_DRIVER("Public ACPI methods supported\n");
 962                 opregion->acpi = base + OPREGION_ACPI_OFFSET;
 963         }
 964
 965         if (mboxes & MBOX_SWSCI) {
 966                 DRM_DEBUG_DRIVER("SWSCI supported\n");
 967                 opregion->swsci = base + OPREGION_SWSCI_OFFSET;
 968                 swsci_setup(dev);
 969         }
 970
 971         if (mboxes & MBOX_ASLE) {
 972                 DRM_DEBUG_DRIVER("ASLE supported\n");
 973                 opregion->asle = base + OPREGION_ASLE_OFFSET;
 974
 975                 opregion->asle->ardy = ASLE_ARDY_NOT_READY;
 976         }
 977
 978         if (mboxes & MBOX_ASLE_EXT)
 979                 DRM_DEBUG_DRIVER("ASLE extension supported\n");
 980
 981         if (!dmi_check_system(intel_no_opregion_vbt)) {
 982                 const void *vbt = NULL;
 983                 u32 vbt_size = 0;
 984
 985                 if (opregion->header->opregion_ver >= 2 && opregion->asle &&
 986                     opregion->asle->rvda && opregion->asle->rvds) {
 987                         opregion->rvda = memremap(opregion->asle->rvda,
 988                                                   opregion->asle->rvds,
 989                                                   MEMREMAP_WB);
 990                         vbt = opregion->rvda;
 991                         vbt_size = opregion->asle->rvds;
 992                 }
 993
 994                 if (intel_bios_is_valid_vbt(vbt, vbt_size)) {
 995                         DRM_DEBUG_KMS("Found valid VBT in ACPI OpRegion (RVDA)\n");
 996                         opregion->vbt = vbt;
 997                         opregion->vbt_size = vbt_size;
 998                 } else {
 999                         vbt = base + OPREGION_VBT_OFFSET;
1000                         vbt_size = OPREGION_ASLE_EXT_OFFSET - OPREGION_VBT_OFFSET;
1001                         if (intel_bios_is_valid_vbt(vbt, vbt_size)) {
1002                                 DRM_DEBUG_KMS("Found valid VBT in ACPI OpRegion (Mailbox #4)\n");
1003                                 opregion->vbt = vbt;
1004                                 opregion->vbt_size = vbt_size;
1005                         }
1006                 }
1007         }
1008
1009         return 0;
1010
1011 err_out:
1012         memunmap(base);
1013         return err;
1014 }
1015
1016 int
1017 intel_opregion_get_panel_type(struct drm_device *dev)
1018 {
1019         u32 panel_details;
1020         int ret;
1021
1022         ret = swsci(dev, SWSCI_GBDA_PANEL_DETAILS, 0x0, &panel_details);
1023         if (ret) {
1024                 DRM_DEBUG_KMS("Failed to get panel details from OpRegion (%d)\n",
1025                               ret);
1026                 return ret;
1027         }
1028
1029         ret = (panel_details >> 8) & 0xff;
1030         if (ret > 0x10) {
1031                 DRM_DEBUG_KMS("Invalid OpRegion panel type 0x%x\n", ret);
1032                 return -EINVAL;
1033         }
1034
1035         /* fall back to VBT panel type? */
1036         if (ret == 0x0) {
1037                 DRM_DEBUG_KMS("No panel type in OpRegion\n");
1038                 return -ENODEV;
1039         }
1040
1041         /*
1042          * FIXME On Dell XPS 13 9350 the OpRegion panel type (0) gives us
1043          * low vswing for eDP, whereas the VBT panel type (2) gives us normal
1044          * vswing instead. Low vswing results in some display flickers, so
1045          * let's simply ignore the OpRegion panel type on SKL for now.
1046          */
1047         if (IS_SKYLAKE(dev)) {
1048                 DRM_DEBUG_KMS("Ignoring OpRegion panel type (%d)\n", ret - 1);
1049                 return -ENODEV;
1050         }
1051
1052         return ret - 1;
1053 }