sys/dev/drm/i915/dvo_ivch.c

   1 /*
   2  * Copyright © 2006 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Eric Anholt <eric@anholt.net>
  25  *    Thomas Richter <thor@math.tu-berlin.de>
  26  *
  27  * Minor modifications (Dithering enable):
  28  *    Thomas Richter <thor@math.tu-berlin.de>
  29  *
  30  */
  31
  32 #include "dvo.h"
  33
  34 /*
  35  * register definitions for the i82807aa.
  36  *
  37  * Documentation on this chipset can be found in datasheet #29069001 at
  38  * intel.com.
  39  */
  40
  41 /*
  42  * VCH Revision & GMBus Base Addr
  43  */
  44 #define VR00            0x00
  45 # define VR00_BASE_ADDRESS_MASK         0x007f
  46
  47 /*
  48  * Functionality Enable
  49  */
  50 #define VR01            0x01
  51
  52 /*
  53  * Enable the panel fitter
  54  */
  55 # define VR01_PANEL_FIT_ENABLE          (1 << 3)
  56 /*
  57  * Enables the LCD display.
  58  *
  59  * This must not be set while VR01_DVO_BYPASS_ENABLE is set.
  60  */
  61 # define VR01_LCD_ENABLE                (1 << 2)
  62 /** Enables the DVO repeater. */
  63 # define VR01_DVO_BYPASS_ENABLE         (1 << 1)
  64 /** Enables the DVO clock */
  65 # define VR01_DVO_ENABLE                (1 << 0)
  66 /** Enable dithering for 18bpp panels. Not documented. */
  67 # define VR01_DITHER_ENABLE             (1 << 4)
  68
  69 /*
  70  * LCD Interface Format
  71  */
  72 #define VR10            0x10
  73 /** Enables LVDS output instead of CMOS */
  74 # define VR10_LVDS_ENABLE               (1 << 4)
  75 /** Enables 18-bit LVDS output. */
  76 # define VR10_INTERFACE_1X18            (0 << 2)
  77 /** Enables 24-bit LVDS or CMOS output */
  78 # define VR10_INTERFACE_1X24            (1 << 2)
  79 /** Enables 2x18-bit LVDS or CMOS output. */
  80 # define VR10_INTERFACE_2X18            (2 << 2)
  81 /** Enables 2x24-bit LVDS output */
  82 # define VR10_INTERFACE_2X24            (3 << 2)
  83 /** Mask that defines the depth of the pipeline */
  84 # define VR10_INTERFACE_DEPTH_MASK      (3 << 2)
  85
  86 /*
  87  * VR20 LCD Horizontal Display Size
  88  */
  89 #define VR20    0x20
  90
  91 /*
  92  * LCD Vertical Display Size
  93  */
  94 #define VR21    0x21
  95
  96 /*
  97  * Panel power down status
  98  */
  99 #define VR30            0x30
 100 /** Read only bit indicating that the panel is not in a safe poweroff state. */
 101 # define VR30_PANEL_ON                  (1 << 15)
 102
 103 #define VR40            0x40
 104 # define VR40_STALL_ENABLE              (1 << 13)
 105 # define VR40_VERTICAL_INTERP_ENABLE    (1 << 12)
 106 # define VR40_ENHANCED_PANEL_FITTING    (1 << 11)
 107 # define VR40_HORIZONTAL_INTERP_ENABLE  (1 << 10)
 108 # define VR40_AUTO_RATIO_ENABLE         (1 << 9)
 109 # define VR40_CLOCK_GATING_ENABLE       (1 << 8)
 110
 111 /*
 112  * Panel Fitting Vertical Ratio
 113  * (((image_height - 1) << 16) / ((panel_height - 1))) >> 2
 114  */
 115 #define VR41            0x41
 116
 117 /*
 118  * Panel Fitting Horizontal Ratio
 119  * (((image_width - 1) << 16) / ((panel_width - 1))) >> 2
 120  */
 121 #define VR42            0x42
 122
 123 /*
 124  * Horizontal Image Size
 125  */
 126 #define VR43            0x43
 127
 128 /* VR80 GPIO 0
 129  */
 130 #define VR80        0x80
 131 #define VR81        0x81
 132 #define VR82        0x82
 133 #define VR83        0x83
 134 #define VR84        0x84
 135 #define VR85        0x85
 136 #define VR86        0x86
 137 #define VR87        0x87
 138
 139 /* VR88 GPIO 8
 140  */
 141 #define VR88        0x88
 142
 143 /* Graphics BIOS scratch 0
 144  */
 145 #define VR8E        0x8E
 146 # define VR8E_PANEL_TYPE_MASK           (0xf << 0)
 147 # define VR8E_PANEL_INTERFACE_CMOS      (0 << 4)
 148 # define VR8E_PANEL_INTERFACE_LVDS      (1 << 4)
 149 # define VR8E_FORCE_DEFAULT_PANEL       (1 << 5)
 150
 151 /* Graphics BIOS scratch 1
 152  */
 153 #define VR8F        0x8F
 154 # define VR8F_VCH_PRESENT               (1 << 0)
 155 # define VR8F_DISPLAY_CONN              (1 << 1)
 156 # define VR8F_POWER_MASK                (0x3c)
 157 # define VR8F_POWER_POS                 (2)
 158
 159 /* Some Bios implementations do not restore the DVO state upon
 160  * resume from standby. Thus, this driver has to handle it
 161  * instead. The following list contains all registers that
 162  * require saving.
 163  */
 164 static const uint16_t backup_addresses[] = {
 165         0x11, 0x12,
 166         0x18, 0x19, 0x1a, 0x1f,
 167         0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
 168         0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
 169         0x8e, 0x8f,
 170         0x10            /* this must come last */
 171 };
 172
 173
 174 struct ivch_priv {
 175         bool quiet;
 176
 177         uint16_t width, height;
 178
 179         /* Register backup */
 180
 181         uint16_t reg_backup[ARRAY_SIZE(backup_addresses)];
 182 };
 183
 184
 185 static void ivch_dump_regs(struct intel_dvo_device *dvo);
 186 /**
 187  * Reads a register on the ivch.
 188  *
 189  * Each of the 256 registers are 16 bits long.
 190  */
 191 static bool ivch_read(struct intel_dvo_device *dvo, int addr, uint16_t *data)
 192 {
 193         struct ivch_priv *priv = dvo->dev_priv;
 194         struct i2c_adapter *adapter = dvo->i2c_bus;
 195         u8 out_buf[1];
 196         u8 in_buf[2];
 197
 198         struct i2c_msg msgs[] = {
 199                 {
 200                         .addr = dvo->slave_addr,
 201                         .flags = I2C_M_RD,
 202                         .len = 0,
 203                 },
 204                 {
 205                         .addr = 0,
 206                         .flags = I2C_M_NOSTART,
 207                         .len = 1,
 208                         .buf = out_buf,
 209                 },
 210                 {
 211                         .addr = dvo->slave_addr,
 212                         .flags = I2C_M_RD | I2C_M_NOSTART,
 213                         .len = 2,
 214                         .buf = in_buf,
 215                 }
 216         };
 217
 218         *data = 0;      /* silence gcc warnings */
 219         out_buf[0] = addr;
 220
 221         if (i2c_transfer(adapter, msgs, 3) == 3) {
 222                 *data = (in_buf[1] << 8) | in_buf[0];
 223                 return true;
 224         }
 225
 226         if (!priv->quiet) {
 227                 DRM_DEBUG_KMS("Unable to read register 0x%02x from "
 228                                 "%s:%02x.\n",
 229                           addr, adapter->name, dvo->slave_addr);
 230         }
 231         return false;
 232 }
 233
 234 /** Writes a 16-bit register on the ivch */
 235 static bool ivch_write(struct intel_dvo_device *dvo, int addr, uint16_t data)
 236 {
 237         struct ivch_priv *priv = dvo->dev_priv;
 238         struct i2c_adapter *adapter = dvo->i2c_bus;
 239         u8 out_buf[3];
 240         struct i2c_msg msg = {
 241                 .addr = dvo->slave_addr,
 242                 .flags = 0,
 243                 .len = 3,
 244                 .buf = out_buf,
 245         };
 246
 247         out_buf[0] = addr;
 248         out_buf[1] = data & 0xff;
 249         out_buf[2] = data >> 8;
 250
 251         if (i2c_transfer(adapter, &msg, 1) == 1)
 252                 return true;
 253
 254         if (!priv->quiet) {
 255                 DRM_DEBUG_KMS("Unable to write register 0x%02x to %s:%d.\n",
 256                           addr, adapter->name, dvo->slave_addr);
 257         }
 258
 259         return false;
 260 }
 261
 262 /** Probes the given bus and slave address for an ivch */
 263 static bool ivch_init(struct intel_dvo_device *dvo,
 264                       struct i2c_adapter *adapter)
 265 {
 266         struct ivch_priv *priv;
 267         uint16_t temp;
 268         int i;
 269
 270         priv = kzalloc(sizeof(struct ivch_priv), GFP_KERNEL);
 271         if (priv == NULL)
 272                 return false;
 273
 274         dvo->i2c_bus = adapter;
 275         dvo->dev_priv = priv;
 276         priv->quiet = true;
 277
 278         if (!ivch_read(dvo, VR00, &temp))
 279                 goto out;
 280         priv->quiet = false;
 281
 282         /* Since the identification bits are probably zeroes, which doesn't seem
 283          * very unique, check that the value in the base address field matches
 284          * the address it's responding on.
 285          */
 286         if ((temp & VR00_BASE_ADDRESS_MASK) != dvo->slave_addr) {
 287                 DRM_DEBUG_KMS("ivch detect failed due to address mismatch "
 288                           "(%d vs %d)\n",
 289                           (temp & VR00_BASE_ADDRESS_MASK), dvo->slave_addr);
 290                 goto out;
 291         }
 292
 293         ivch_read(dvo, VR20, &priv->width);
 294         ivch_read(dvo, VR21, &priv->height);
 295
 296         /* Make a backup of the registers to be able to restore them
 297          * upon suspend.
 298          */
 299         for (i = 0; i < ARRAY_SIZE(backup_addresses); i++)
 300                 ivch_read(dvo, backup_addresses[i], priv->reg_backup + i);
 301
 302         ivch_dump_regs(dvo);
 303
 304         return true;
 305
 306 out:
 307         kfree(priv);
 308         return false;
 309 }
 310
 311 static enum drm_connector_status ivch_detect(struct intel_dvo_device *dvo)
 312 {
 313         return connector_status_connected;
 314 }
 315
 316 static enum drm_mode_status ivch_mode_valid(struct intel_dvo_device *dvo,
 317                                             struct drm_display_mode *mode)
 318 {
 319         if (mode->clock > 112000)
 320                 return MODE_CLOCK_HIGH;
 321
 322         return MODE_OK;
 323 }
 324
 325 /* Restore the DVO registers after a resume
 326  * from RAM. Registers have been saved during
 327  * the initialization.
 328  */
 329 static void ivch_reset(struct intel_dvo_device *dvo)
 330 {
 331         struct ivch_priv *priv = dvo->dev_priv;
 332         int i;
 333
 334         DRM_DEBUG_KMS("Resetting the IVCH registers\n");
 335
 336         ivch_write(dvo, VR10, 0x0000);
 337
 338         for (i = 0; i < ARRAY_SIZE(backup_addresses); i++)
 339                 ivch_write(dvo, backup_addresses[i], priv->reg_backup[i]);
 340 }
 341
 342 /** Sets the power state of the panel connected to the ivch */
 343 static void ivch_dpms(struct intel_dvo_device *dvo, bool enable)
 344 {
 345         int i;
 346         uint16_t vr01, vr30, backlight;
 347
 348         ivch_reset(dvo);
 349
 350         /* Set the new power state of the panel. */
 351         if (!ivch_read(dvo, VR01, &vr01))
 352                 return;
 353
 354         if (enable)
 355                 backlight = 1;
 356         else
 357                 backlight = 0;
 358
 359         ivch_write(dvo, VR80, backlight);
 360
 361         if (enable)
 362                 vr01 |= VR01_LCD_ENABLE | VR01_DVO_ENABLE;
 363         else
 364                 vr01 &= ~(VR01_LCD_ENABLE | VR01_DVO_ENABLE);
 365
 366         ivch_write(dvo, VR01, vr01);
 367
 368         /* Wait for the panel to make its state transition */
 369         for (i = 0; i < 100; i++) {
 370                 if (!ivch_read(dvo, VR30, &vr30))
 371                         break;
 372
 373                 if (((vr30 & VR30_PANEL_ON) != 0) == enable)
 374                         break;
 375                 udelay(1000);
 376         }
 377         /* wait some more; vch may fail to resync sometimes without this */
 378         udelay(16 * 1000);
 379 }
 380
 381 static bool ivch_get_hw_state(struct intel_dvo_device *dvo)
 382 {
 383         uint16_t vr01;
 384
 385         ivch_reset(dvo);
 386
 387         /* Set the new power state of the panel. */
 388         if (!ivch_read(dvo, VR01, &vr01))
 389                 return false;
 390
 391         if (vr01 & VR01_LCD_ENABLE)
 392                 return true;
 393         else
 394                 return false;
 395 }
 396
 397 static void ivch_mode_set(struct intel_dvo_device *dvo,
 398                           const struct drm_display_mode *mode,
 399                           const struct drm_display_mode *adjusted_mode)
 400 {
 401         struct ivch_priv *priv = dvo->dev_priv;
 402         uint16_t vr40 = 0;
 403         uint16_t vr01 = 0;
 404         uint16_t vr10;
 405
 406         ivch_reset(dvo);
 407
 408         vr10 = priv->reg_backup[ARRAY_SIZE(backup_addresses) - 1];
 409
 410         /* Enable dithering for 18 bpp pipelines */
 411         vr10 &= VR10_INTERFACE_DEPTH_MASK;
 412         if (vr10 == VR10_INTERFACE_2X18 || vr10 == VR10_INTERFACE_1X18)
 413                 vr01 = VR01_DITHER_ENABLE;
 414
 415         vr40 = (VR40_STALL_ENABLE | VR40_VERTICAL_INTERP_ENABLE |
 416                 VR40_HORIZONTAL_INTERP_ENABLE);
 417
 418         if (mode->hdisplay != adjusted_mode->crtc_hdisplay ||
 419             mode->vdisplay != adjusted_mode->crtc_vdisplay) {
 420                 uint16_t x_ratio, y_ratio;
 421
 422                 vr01 |= VR01_PANEL_FIT_ENABLE;
 423                 vr40 |= VR40_CLOCK_GATING_ENABLE;
 424                 x_ratio = (((mode->hdisplay - 1) << 16) /
 425                            (adjusted_mode->crtc_hdisplay - 1)) >> 2;
 426                 y_ratio = (((mode->vdisplay - 1) << 16) /
 427                            (adjusted_mode->crtc_vdisplay - 1)) >> 2;
 428                 ivch_write(dvo, VR42, x_ratio);
 429                 ivch_write(dvo, VR41, y_ratio);
 430         } else {
 431                 vr01 &= ~VR01_PANEL_FIT_ENABLE;
 432                 vr40 &= ~VR40_CLOCK_GATING_ENABLE;
 433         }
 434         vr40 &= ~VR40_AUTO_RATIO_ENABLE;
 435
 436         ivch_write(dvo, VR01, vr01);
 437         ivch_write(dvo, VR40, vr40);
 438 }
 439
 440 static void ivch_dump_regs(struct intel_dvo_device *dvo)
 441 {
 442         uint16_t val;
 443
 444         ivch_read(dvo, VR00, &val);
 445         DRM_DEBUG_KMS("VR00: 0x%04x\n", val);
 446         ivch_read(dvo, VR01, &val);
 447         DRM_DEBUG_KMS("VR01: 0x%04x\n", val);
 448         ivch_read(dvo, VR10, &val);
 449         DRM_DEBUG_KMS("VR10: 0x%04x\n", val);
 450         ivch_read(dvo, VR30, &val);
 451         DRM_DEBUG_KMS("VR30: 0x%04x\n", val);
 452         ivch_read(dvo, VR40, &val);
 453         DRM_DEBUG_KMS("VR40: 0x%04x\n", val);
 454
 455         /* GPIO registers */
 456         ivch_read(dvo, VR80, &val);
 457         DRM_DEBUG_KMS("VR80: 0x%04x\n", val);
 458         ivch_read(dvo, VR81, &val);
 459         DRM_DEBUG_KMS("VR81: 0x%04x\n", val);
 460         ivch_read(dvo, VR82, &val);
 461         DRM_DEBUG_KMS("VR82: 0x%04x\n", val);
 462         ivch_read(dvo, VR83, &val);
 463         DRM_DEBUG_KMS("VR83: 0x%04x\n", val);
 464         ivch_read(dvo, VR84, &val);
 465         DRM_DEBUG_KMS("VR84: 0x%04x\n", val);
 466         ivch_read(dvo, VR85, &val);
 467         DRM_DEBUG_KMS("VR85: 0x%04x\n", val);
 468         ivch_read(dvo, VR86, &val);
 469         DRM_DEBUG_KMS("VR86: 0x%04x\n", val);
 470         ivch_read(dvo, VR87, &val);
 471         DRM_DEBUG_KMS("VR87: 0x%04x\n", val);
 472         ivch_read(dvo, VR88, &val);
 473         DRM_DEBUG_KMS("VR88: 0x%04x\n", val);
 474
 475         /* Scratch register 0 - AIM Panel type */
 476         ivch_read(dvo, VR8E, &val);
 477         DRM_DEBUG_KMS("VR8E: 0x%04x\n", val);
 478
 479         /* Scratch register 1 - Status register */
 480         ivch_read(dvo, VR8F, &val);
 481         DRM_DEBUG_KMS("VR8F: 0x%04x\n", val);
 482 }
 483
 484 static void ivch_destroy(struct intel_dvo_device *dvo)
 485 {
 486         struct ivch_priv *priv = dvo->dev_priv;
 487
 488         if (priv) {
 489                 kfree(priv);
 490                 dvo->dev_priv = NULL;
 491         }
 492 }
 493
 494 const struct intel_dvo_dev_ops ivch_ops = {
 495         .init = ivch_init,
 496         .dpms = ivch_dpms,
 497         .get_hw_state = ivch_get_hw_state,
 498         .mode_valid = ivch_mode_valid,
 499         .mode_set = ivch_mode_set,
 500         .detect = ivch_detect,
 501         .dump_regs = ivch_dump_regs,
 502         .destroy = ivch_destroy,
 503 };