drivers/gpu/drm/i915/intel_i2c.c

   1 /*
   2  * Copyright (c) 2006 Dave Airlie <airlied@linux.ie>
   3  * Copyright © 2006-2008,2010 Intel Corporation
   4  *   Jesse Barnes <jesse.barnes@intel.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23  * DEALINGS IN THE SOFTWARE.
  24  *
  25  * Authors:
  26  *      Eric Anholt <eric@anholt.net>
  27  *      Chris Wilson <chris@chris-wilson.co.uk>
  28  */
  29 #include <linux/i2c.h>
  30 #include <linux/i2c-algo-bit.h>
  31 #include <linux/export.h>
  32 #include "drmP.h"
  33 #include "drm.h"
  34 #include "intel_drv.h"
  35 #include "i915_drm.h"
  36 #include "i915_drv.h"
  37
  38 struct gmbus_port {
  39         const char *name;
  40         int reg;
  41 };
  42
  43 static const struct gmbus_port gmbus_ports[] = {
  44         { "ssc", GPIOB },
  45         { "vga", GPIOA },
  46         { "panel", GPIOC },
  47         { "dpc", GPIOD },
  48         { "dpb", GPIOE },
  49         { "dpd", GPIOF },
  50 };
  51
  52 /* Intel GPIO access functions */
  53
  54 #define I2C_RISEFALL_TIME 10
  55
  56 static inline struct intel_gmbus *
  57 to_intel_gmbus(struct i2c_adapter *i2c)
  58 {
  59         return container_of(i2c, struct intel_gmbus, adapter);
  60 }
  61
  62 void
  63 intel_i2c_reset(struct drm_device *dev)
  64 {
  65         struct drm_i915_private *dev_priv = dev->dev_private;
  66         I915_WRITE(dev_priv->gpio_mmio_base + GMBUS0, 0);
  67 }
  68
  69 static void intel_i2c_quirk_set(struct drm_i915_private *dev_priv, bool enable)
  70 {
  71         u32 val;
  72
  73         /* When using bit bashing for I2C, this bit needs to be set to 1 */
  74         if (!IS_PINEVIEW(dev_priv->dev))
  75                 return;
  76
  77         val = I915_READ(DSPCLK_GATE_D);
  78         if (enable)
  79                 val |= DPCUNIT_CLOCK_GATE_DISABLE;
  80         else
  81                 val &= ~DPCUNIT_CLOCK_GATE_DISABLE;
  82         I915_WRITE(DSPCLK_GATE_D, val);
  83 }
  84
  85 static u32 get_reserved(struct intel_gmbus *bus)
  86 {
  87         struct drm_i915_private *dev_priv = bus->dev_priv;
  88         struct drm_device *dev = dev_priv->dev;
  89         u32 reserved = 0;
  90
  91         /* On most chips, these bits must be preserved in software. */
  92         if (!IS_I830(dev) && !IS_845G(dev))
  93                 reserved = I915_READ_NOTRACE(bus->gpio_reg) &
  94                                              (GPIO_DATA_PULLUP_DISABLE |
  95                                               GPIO_CLOCK_PULLUP_DISABLE);
  96
  97         return reserved;
  98 }
  99
 100 static int get_clock(void *data)
 101 {
 102         struct intel_gmbus *bus = data;
 103         struct drm_i915_private *dev_priv = bus->dev_priv;
 104         u32 reserved = get_reserved(bus);
 105         I915_WRITE_NOTRACE(bus->gpio_reg, reserved | GPIO_CLOCK_DIR_MASK);
 106         I915_WRITE_NOTRACE(bus->gpio_reg, reserved);
 107         return (I915_READ_NOTRACE(bus->gpio_reg) & GPIO_CLOCK_VAL_IN) != 0;
 108 }
 109
 110 static int get_data(void *data)
 111 {
 112         struct intel_gmbus *bus = data;
 113         struct drm_i915_private *dev_priv = bus->dev_priv;
 114         u32 reserved = get_reserved(bus);
 115         I915_WRITE_NOTRACE(bus->gpio_reg, reserved | GPIO_DATA_DIR_MASK);
 116         I915_WRITE_NOTRACE(bus->gpio_reg, reserved);
 117         return (I915_READ_NOTRACE(bus->gpio_reg) & GPIO_DATA_VAL_IN) != 0;
 118 }
 119
 120 static void set_clock(void *data, int state_high)
 121 {
 122         struct intel_gmbus *bus = data;
 123         struct drm_i915_private *dev_priv = bus->dev_priv;
 124         u32 reserved = get_reserved(bus);
 125         u32 clock_bits;
 126
 127         if (state_high)
 128                 clock_bits = GPIO_CLOCK_DIR_IN | GPIO_CLOCK_DIR_MASK;
 129         else
 130                 clock_bits = GPIO_CLOCK_DIR_OUT | GPIO_CLOCK_DIR_MASK |
 131                         GPIO_CLOCK_VAL_MASK;
 132
 133         I915_WRITE_NOTRACE(bus->gpio_reg, reserved | clock_bits);
 134         POSTING_READ(bus->gpio_reg);
 135 }
 136
 137 static void set_data(void *data, int state_high)
 138 {
 139         struct intel_gmbus *bus = data;
 140         struct drm_i915_private *dev_priv = bus->dev_priv;
 141         u32 reserved = get_reserved(bus);
 142         u32 data_bits;
 143
 144         if (state_high)
 145                 data_bits = GPIO_DATA_DIR_IN | GPIO_DATA_DIR_MASK;
 146         else
 147                 data_bits = GPIO_DATA_DIR_OUT | GPIO_DATA_DIR_MASK |
 148                         GPIO_DATA_VAL_MASK;
 149
 150         I915_WRITE_NOTRACE(bus->gpio_reg, reserved | data_bits);
 151         POSTING_READ(bus->gpio_reg);
 152 }
 153
 154 static int
 155 intel_gpio_pre_xfer(struct i2c_adapter *adapter)
 156 {
 157         struct intel_gmbus *bus = container_of(adapter,
 158                                                struct intel_gmbus,
 159                                                adapter);
 160         struct drm_i915_private *dev_priv = bus->dev_priv;
 161
 162         intel_i2c_reset(dev_priv->dev);
 163         intel_i2c_quirk_set(dev_priv, true);
 164         set_data(bus, 1);
 165         set_clock(bus, 1);
 166         udelay(I2C_RISEFALL_TIME);
 167         return 0;
 168 }
 169
 170 static void
 171 intel_gpio_post_xfer(struct i2c_adapter *adapter)
 172 {
 173         struct intel_gmbus *bus = container_of(adapter,
 174                                                struct intel_gmbus,
 175                                                adapter);
 176         struct drm_i915_private *dev_priv = bus->dev_priv;
 177
 178         set_data(bus, 1);
 179         set_clock(bus, 1);
 180         intel_i2c_quirk_set(dev_priv, false);
 181 }
 182
 183 static void
 184 intel_gpio_setup(struct intel_gmbus *bus, u32 pin)
 185 {
 186         struct drm_i915_private *dev_priv = bus->dev_priv;
 187         struct i2c_algo_bit_data *algo;
 188
 189         algo = &bus->bit_algo;
 190
 191         /* -1 to map pin pair to gmbus index */
 192         bus->gpio_reg = dev_priv->gpio_mmio_base + gmbus_ports[pin - 1].reg;
 193
 194         bus->adapter.algo_data = algo;
 195         algo->setsda = set_data;
 196         algo->setscl = set_clock;
 197         algo->getsda = get_data;
 198         algo->getscl = get_clock;
 199         algo->pre_xfer = intel_gpio_pre_xfer;
 200         algo->post_xfer = intel_gpio_post_xfer;
 201         algo->udelay = I2C_RISEFALL_TIME;
 202         algo->timeout = usecs_to_jiffies(2200);
 203         algo->data = bus;
 204 }
 205
 206 static int
 207 gmbus_xfer_read(struct drm_i915_private *dev_priv, struct i2c_msg *msg)
 208 {
 209         int reg_offset = dev_priv->gpio_mmio_base;
 210         u16 len = msg->len;
 211         u8 *buf = msg->buf;
 212
 213         I915_WRITE(GMBUS1 + reg_offset,
 214                    GMBUS_CYCLE_WAIT |
 215                    (len << GMBUS_BYTE_COUNT_SHIFT) |
 216                    (msg->addr << GMBUS_SLAVE_ADDR_SHIFT) |
 217                    GMBUS_SLAVE_READ | GMBUS_SW_RDY);
 218         POSTING_READ(GMBUS2 + reg_offset);
 219         do {
 220                 u32 val, loop = 0;
 221
 222                 if (wait_for(I915_READ(GMBUS2 + reg_offset) &
 223                              (GMBUS_SATOER | GMBUS_HW_RDY),
 224                              50))
 225                         return -ETIMEDOUT;
 226                 if (I915_READ(GMBUS2 + reg_offset) & GMBUS_SATOER)
 227                         return -ENXIO;
 228
 229                 val = I915_READ(GMBUS3 + reg_offset);
 230                 do {
 231                         *buf++ = val & 0xff;
 232                         val >>= 8;
 233                 } while (--len && ++loop < 4);
 234         } while (len);
 235
 236         return 0;
 237 }
 238
 239 static int
 240 gmbus_xfer_write(struct drm_i915_private *dev_priv, struct i2c_msg *msg)
 241 {
 242         int reg_offset = dev_priv->gpio_mmio_base;
 243         u16 len = msg->len;
 244         u8 *buf = msg->buf;
 245         u32 val, loop;
 246
 247         val = loop = 0;
 248         while (len && loop < 4) {
 249                 val |= *buf++ << (8 * loop++);
 250                 len -= 1;
 251         }
 252
 253         I915_WRITE(GMBUS3 + reg_offset, val);
 254         I915_WRITE(GMBUS1 + reg_offset,
 255                    GMBUS_CYCLE_WAIT |
 256                    (msg->len << GMBUS_BYTE_COUNT_SHIFT) |
 257                    (msg->addr << GMBUS_SLAVE_ADDR_SHIFT) |
 258                    GMBUS_SLAVE_WRITE | GMBUS_SW_RDY);
 259         POSTING_READ(GMBUS2 + reg_offset);
 260         while (len) {
 261                 val = loop = 0;
 262                 do {
 263                         val |= *buf++ << (8 * loop);
 264                 } while (--len && ++loop < 4);
 265
 266                 I915_WRITE(GMBUS3 + reg_offset, val);
 267                 POSTING_READ(GMBUS2 + reg_offset);
 268
 269                 if (wait_for(I915_READ(GMBUS2 + reg_offset) &
 270                              (GMBUS_SATOER | GMBUS_HW_RDY),
 271                              50))
 272                         return -ETIMEDOUT;
 273                 if (I915_READ(GMBUS2 + reg_offset) & GMBUS_SATOER)
 274                         return -ENXIO;
 275         }
 276         return 0;
 277 }
 278
 279 static int
 280 gmbus_xfer(struct i2c_adapter *adapter,
 281            struct i2c_msg *msgs,
 282            int num)
 283 {
 284         struct intel_gmbus *bus = container_of(adapter,
 285                                                struct intel_gmbus,
 286                                                adapter);
 287         struct drm_i915_private *dev_priv = bus->dev_priv;
 288         int i, reg_offset;
 289         int ret = 0;
 290
 291         mutex_lock(&dev_priv->gmbus_mutex);
 292
 293         if (bus->force_bit) {
 294                 ret = i2c_bit_algo.master_xfer(adapter, msgs, num);
 295                 goto out;
 296         }
 297
 298         reg_offset = dev_priv->gpio_mmio_base;
 299
 300         I915_WRITE(GMBUS0 + reg_offset, bus->reg0);
 301
 302         for (i = 0; i < num; i++) {
 303                 if (msgs[i].flags & I2C_M_RD)
 304                         ret = gmbus_xfer_read(dev_priv, &msgs[i]);
 305                 else
 306                         ret = gmbus_xfer_write(dev_priv, &msgs[i]);
 307
 308                 if (ret == -ETIMEDOUT)
 309                         goto timeout;
 310                 if (ret == -ENXIO)
 311                         goto clear_err;
 312
 313                 if (wait_for(I915_READ(GMBUS2 + reg_offset) &
 314                              (GMBUS_SATOER | GMBUS_HW_WAIT_PHASE),
 315                              50))
 316                         goto timeout;
 317                 if (I915_READ(GMBUS2 + reg_offset) & GMBUS_SATOER)
 318                         goto clear_err;
 319         }
 320
 321         /* Generate a STOP condition on the bus. Note that gmbus can't generata
 322          * a STOP on the very first cycle. To simplify the code we
 323          * unconditionally generate the STOP condition with an additional gmbus
 324          * cycle. */
 325         I915_WRITE(GMBUS1 + reg_offset, GMBUS_CYCLE_STOP | GMBUS_SW_RDY);
 326
 327         /* Mark the GMBUS interface as disabled after waiting for idle.
 328          * We will re-enable it at the start of the next xfer,
 329          * till then let it sleep.
 330          */
 331         if (wait_for((I915_READ(GMBUS2 + reg_offset) & GMBUS_ACTIVE) == 0,
 332                      10)) {
 333                 DRM_INFO("GMBUS [%s] timed out waiting for idle\n",
 334                          adapter->name);
 335                 ret = -ETIMEDOUT;
 336         }
 337         I915_WRITE(GMBUS0 + reg_offset, 0);
 338         ret = ret ?: i;
 339         goto out;
 340
 341 clear_err:
 342         /*
 343          * Wait for bus to IDLE before clearing NAK.
 344          * If we clear the NAK while bus is still active, then it will stay
 345          * active and the next transaction may fail.
 346          */
 347         if (wait_for((I915_READ(GMBUS2 + reg_offset) & GMBUS_ACTIVE) == 0,
 348                      10))
 349                 DRM_INFO("GMBUS [%s] timed out after NAK\n", adapter->name);
 350
 351         /* Toggle the Software Clear Interrupt bit. This has the effect
 352          * of resetting the GMBUS controller and so clearing the
 353          * BUS_ERROR raised by the slave's NAK.
 354          */
 355         I915_WRITE(GMBUS1 + reg_offset, GMBUS_SW_CLR_INT);
 356         I915_WRITE(GMBUS1 + reg_offset, 0);
 357         I915_WRITE(GMBUS0 + reg_offset, 0);
 358
 359         DRM_DEBUG_DRIVER("GMBUS [%s] NAK for addr: %04x %c(%d)\n",
 360                          adapter->name, msgs[i].addr,
 361                          (msgs[i].flags & I2C_M_RD) ? 'r' : 'w', msgs[i].len);
 362
 363         /*
 364          * If no ACK is received during the address phase of a transaction,
 365          * the adapter must report -ENXIO.
 366          * It is not clear what to return if no ACK is received at other times.
 367          * So, we always return -ENXIO in all NAK cases, to ensure we send
 368          * it at least during the one case that is specified.
 369          */
 370         ret = -ENXIO;
 371         goto out;
 372
 373 timeout:
 374         DRM_INFO("GMBUS [%s] timed out, falling back to bit banging on pin %d\n",
 375                  bus->adapter.name, bus->reg0 & 0xff);
 376         I915_WRITE(GMBUS0 + reg_offset, 0);
 377
 378         /* Hardware may not support GMBUS over these pins? Try GPIO bitbanging instead. */
 379         bus->force_bit = true;
 380         ret = i2c_bit_algo.master_xfer(adapter, msgs, num);
 381
 382 out:
 383         mutex_unlock(&dev_priv->gmbus_mutex);
 384         return ret;
 385 }
 386
 387 static u32 gmbus_func(struct i2c_adapter *adapter)
 388 {
 389         return i2c_bit_algo.functionality(adapter) &
 390                 (I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
 391                 /* I2C_FUNC_10BIT_ADDR | */
 392                 I2C_FUNC_SMBUS_READ_BLOCK_DATA |
 393                 I2C_FUNC_SMBUS_BLOCK_PROC_CALL);
 394 }
 395
 396 static const struct i2c_algorithm gmbus_algorithm = {
 397         .master_xfer    = gmbus_xfer,
 398         .functionality  = gmbus_func
 399 };
 400
 401 /**
 402  * intel_gmbus_setup - instantiate all Intel i2c GMBuses
 403  * @dev: DRM device
 404  */
 405 int intel_setup_gmbus(struct drm_device *dev)
 406 {
 407         struct drm_i915_private *dev_priv = dev->dev_private;
 408         int ret, i;
 409
 410         if (HAS_PCH_SPLIT(dev))
 411                 dev_priv->gpio_mmio_base = PCH_GPIOA - GPIOA;
 412         else
 413                 dev_priv->gpio_mmio_base = 0;
 414
 415         mutex_init(&dev_priv->gmbus_mutex);
 416
 417         for (i = 0; i < GMBUS_NUM_PORTS; i++) {
 418                 struct intel_gmbus *bus = &dev_priv->gmbus[i];
 419                 u32 port = i + 1; /* +1 to map gmbus index to pin pair */
 420
 421                 bus->adapter.owner = THIS_MODULE;
 422                 bus->adapter.class = I2C_CLASS_DDC;
 423                 snprintf(bus->adapter.name,
 424                          sizeof(bus->adapter.name),
 425                          "i915 gmbus %s",
 426                          gmbus_ports[i].name);
 427
 428                 bus->adapter.dev.parent = &dev->pdev->dev;
 429                 bus->dev_priv = dev_priv;
 430
 431                 bus->adapter.algo = &gmbus_algorithm;
 432                 ret = i2c_add_adapter(&bus->adapter);
 433                 if (ret)
 434                         goto err;
 435
 436                 /* By default use a conservative clock rate */
 437                 bus->reg0 = port | GMBUS_RATE_100KHZ;
 438
 439                 intel_gpio_setup(bus, port);
 440         }
 441
 442         intel_i2c_reset(dev_priv->dev);
 443
 444         return 0;
 445
 446 err:
 447         while (--i) {
 448                 struct intel_gmbus *bus = &dev_priv->gmbus[i];
 449                 i2c_del_adapter(&bus->adapter);
 450         }
 451         return ret;
 452 }
 453
 454 struct i2c_adapter *intel_gmbus_get_adapter(struct drm_i915_private *dev_priv,
 455                                             unsigned port)
 456 {
 457         WARN_ON(!intel_gmbus_is_port_valid(port));
 458         /* -1 to map pin pair to gmbus index */
 459         return (intel_gmbus_is_port_valid(port)) ?
 460                 &dev_priv->gmbus[port - 1].adapter : NULL;
 461 }
 462
 463 void intel_gmbus_set_speed(struct i2c_adapter *adapter, int speed)
 464 {
 465         struct intel_gmbus *bus = to_intel_gmbus(adapter);
 466
 467         bus->reg0 = (bus->reg0 & ~(0x3 << 8)) | speed;
 468 }
 469
 470 void intel_gmbus_force_bit(struct i2c_adapter *adapter, bool force_bit)
 471 {
 472         struct intel_gmbus *bus = to_intel_gmbus(adapter);
 473
 474         bus->force_bit = force_bit;
 475 }
 476
 477 void intel_teardown_gmbus(struct drm_device *dev)
 478 {
 479         struct drm_i915_private *dev_priv = dev->dev_private;
 480         int i;
 481
 482         if (dev_priv->gmbus == NULL)
 483                 return;
 484
 485         for (i = 0; i < GMBUS_NUM_PORTS; i++) {
 486                 struct intel_gmbus *bus = &dev_priv->gmbus[i];
 487                 i2c_del_adapter(&bus->adapter);
 488         }
 489 }