Pileus Git - ~andy/linux/blob - 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 /* Intel GPIO access functions */
  39
  40 #define I2C_RISEFALL_TIME 10
  41
  42 static inline struct intel_gmbus *
  43 to_intel_gmbus(struct i2c_adapter *i2c)
  44 {
  45         return container_of(i2c, struct intel_gmbus, adapter);
  46 }
  47
  48 void
  49 intel_i2c_reset(struct drm_device *dev)
  50 {
  51         struct drm_i915_private *dev_priv = dev->dev_private;
  52         I915_WRITE(dev_priv->gpio_mmio_base + GMBUS0, 0);
  53 }
  54
  55 static void intel_i2c_quirk_set(struct drm_i915_private *dev_priv, bool enable)
  56 {
  57         u32 val;
  58
  59         /* When using bit bashing for I2C, this bit needs to be set to 1 */
  60         if (!IS_PINEVIEW(dev_priv->dev))
  61                 return;
  62
  63         val = I915_READ(DSPCLK_GATE_D);
  64         if (enable)
  65                 val |= DPCUNIT_CLOCK_GATE_DISABLE;
  66         else
  67                 val &= ~DPCUNIT_CLOCK_GATE_DISABLE;
  68         I915_WRITE(DSPCLK_GATE_D, val);
  69 }
  70
  71 static u32 get_reserved(struct intel_gmbus *bus)
  72 {
  73         struct drm_i915_private *dev_priv = bus->dev_priv;
  74         struct drm_device *dev = dev_priv->dev;
  75         u32 reserved = 0;
  76
  77         /* On most chips, these bits must be preserved in software. */
  78         if (!IS_I830(dev) && !IS_845G(dev))
  79                 reserved = I915_READ_NOTRACE(bus->gpio_reg) &
  80                                              (GPIO_DATA_PULLUP_DISABLE |
  81                                               GPIO_CLOCK_PULLUP_DISABLE);
  82
  83         return reserved;
  84 }
  85
  86 static int get_clock(void *data)
  87 {
  88         struct intel_gmbus *bus = data;
  89         struct drm_i915_private *dev_priv = bus->dev_priv;
  90         u32 reserved = get_reserved(bus);
  91         I915_WRITE_NOTRACE(bus->gpio_reg, reserved | GPIO_CLOCK_DIR_MASK);
  92         I915_WRITE_NOTRACE(bus->gpio_reg, reserved);
  93         return (I915_READ_NOTRACE(bus->gpio_reg) & GPIO_CLOCK_VAL_IN) != 0;
  94 }
  95
  96 static int get_data(void *data)
  97 {
  98         struct intel_gmbus *bus = data;
  99         struct drm_i915_private *dev_priv = bus->dev_priv;
 100         u32 reserved = get_reserved(bus);
 101         I915_WRITE_NOTRACE(bus->gpio_reg, reserved | GPIO_DATA_DIR_MASK);
 102         I915_WRITE_NOTRACE(bus->gpio_reg, reserved);
 103         return (I915_READ_NOTRACE(bus->gpio_reg) & GPIO_DATA_VAL_IN) != 0;
 104 }
 105
 106 static void set_clock(void *data, int state_high)
 107 {
 108         struct intel_gmbus *bus = data;
 109         struct drm_i915_private *dev_priv = bus->dev_priv;
 110         u32 reserved = get_reserved(bus);
 111         u32 clock_bits;
 112
 113         if (state_high)
 114                 clock_bits = GPIO_CLOCK_DIR_IN | GPIO_CLOCK_DIR_MASK;
 115         else
 116                 clock_bits = GPIO_CLOCK_DIR_OUT | GPIO_CLOCK_DIR_MASK |
 117                         GPIO_CLOCK_VAL_MASK;
 118
 119         I915_WRITE_NOTRACE(bus->gpio_reg, reserved | clock_bits);
 120         POSTING_READ(bus->gpio_reg);
 121 }
 122
 123 static void set_data(void *data, int state_high)
 124 {
 125         struct intel_gmbus *bus = data;
 126         struct drm_i915_private *dev_priv = bus->dev_priv;
 127         u32 reserved = get_reserved(bus);
 128         u32 data_bits;
 129
 130         if (state_high)
 131                 data_bits = GPIO_DATA_DIR_IN | GPIO_DATA_DIR_MASK;
 132         else
 133                 data_bits = GPIO_DATA_DIR_OUT | GPIO_DATA_DIR_MASK |
 134                         GPIO_DATA_VAL_MASK;
 135
 136         I915_WRITE_NOTRACE(bus->gpio_reg, reserved | data_bits);
 137         POSTING_READ(bus->gpio_reg);
 138 }
 139
 140 static int
 141 intel_gpio_pre_xfer(struct i2c_adapter *adapter)
 142 {
 143         struct intel_gmbus *bus = container_of(adapter,
 144                                                struct intel_gmbus,
 145                                                adapter);
 146         struct drm_i915_private *dev_priv = bus->dev_priv;
 147
 148         intel_i2c_reset(dev_priv->dev);
 149         intel_i2c_quirk_set(dev_priv, true);
 150         set_data(bus, 1);
 151         set_clock(bus, 1);
 152         udelay(I2C_RISEFALL_TIME);
 153         return 0;
 154 }
 155
 156 static void
 157 intel_gpio_post_xfer(struct i2c_adapter *adapter)
 158 {
 159         struct intel_gmbus *bus = container_of(adapter,
 160                                                struct intel_gmbus,
 161                                                adapter);
 162         struct drm_i915_private *dev_priv = bus->dev_priv;
 163
 164         set_data(bus, 1);
 165         set_clock(bus, 1);
 166         intel_i2c_quirk_set(dev_priv, false);
 167 }
 168
 169 static bool
 170 intel_gpio_setup(struct intel_gmbus *bus, u32 pin)
 171 {
 172         struct drm_i915_private *dev_priv = bus->dev_priv;
 173         static const int map_pin_to_reg[] = {
 174                 0,
 175                 GPIOB,
 176                 GPIOA,
 177                 GPIOC,
 178                 GPIOD,
 179                 GPIOE,
 180                 GPIOF,
 181                 0,
 182         };
 183         struct i2c_algo_bit_data *algo;
 184
 185         if (pin >= ARRAY_SIZE(map_pin_to_reg) || !map_pin_to_reg[pin])
 186                 return false;
 187
 188         algo = &bus->bit_algo;
 189
 190         bus->gpio_reg = map_pin_to_reg[pin];
 191         bus->gpio_reg += dev_priv->gpio_mmio_base;
 192
 193         bus->adapter.algo_data = algo;
 194         algo->setsda = set_data;
 195         algo->setscl = set_clock;
 196         algo->getsda = get_data;
 197         algo->getscl = get_clock;
 198         algo->pre_xfer = intel_gpio_pre_xfer;
 199         algo->post_xfer = intel_gpio_post_xfer;
 200         algo->udelay = I2C_RISEFALL_TIME;
 201         algo->timeout = usecs_to_jiffies(2200);
 202         algo->data = bus;
 203
 204         return true;
 205 }
 206
 207 static int
 208 gmbus_xfer_read(struct drm_i915_private *dev_priv, struct i2c_msg *msg,
 209                 bool last)
 210 {
 211         int reg_offset = dev_priv->gpio_mmio_base;
 212         u16 len = msg->len;
 213         u8 *buf = msg->buf;
 214
 215         I915_WRITE(GMBUS1 + reg_offset,
 216                    GMBUS_CYCLE_WAIT |
 217                    (last ? GMBUS_CYCLE_STOP : 0) |
 218                    (len << GMBUS_BYTE_COUNT_SHIFT) |
 219                    (msg->addr << GMBUS_SLAVE_ADDR_SHIFT) |
 220                    GMBUS_SLAVE_READ | GMBUS_SW_RDY);
 221         POSTING_READ(GMBUS2 + reg_offset);
 222         do {
 223                 u32 val, loop = 0;
 224
 225                 if (wait_for(I915_READ(GMBUS2 + reg_offset) &
 226                              (GMBUS_SATOER | GMBUS_HW_RDY),
 227                              50))
 228                         return -ETIMEDOUT;
 229                 if (I915_READ(GMBUS2 + reg_offset) & GMBUS_SATOER)
 230                         return -ENXIO;
 231
 232                 val = I915_READ(GMBUS3 + reg_offset);
 233                 do {
 234                         *buf++ = val & 0xff;
 235                         val >>= 8;
 236                 } while (--len && ++loop < 4);
 237         } while (len);
 238
 239         return 0;
 240 }
 241
 242 static int
 243 gmbus_xfer_write(struct drm_i915_private *dev_priv, struct i2c_msg *msg,
 244                 bool last)
 245 {
 246         int reg_offset = dev_priv->gpio_mmio_base;
 247         u16 len = msg->len;
 248         u8 *buf = msg->buf;
 249         u32 val, loop;
 250
 251         val = loop = 0;
 252         do {
 253                 val |= *buf++ << (8 * loop);
 254         } while (--len && ++loop < 4);
 255
 256         I915_WRITE(GMBUS3 + reg_offset, val);
 257         I915_WRITE(GMBUS1 + reg_offset,
 258                    GMBUS_CYCLE_WAIT |
 259                    (last ? GMBUS_CYCLE_STOP : 0) |
 260                    (msg->len << GMBUS_BYTE_COUNT_SHIFT) |
 261                    (msg->addr << GMBUS_SLAVE_ADDR_SHIFT) |
 262                    GMBUS_SLAVE_WRITE | GMBUS_SW_RDY);
 263         POSTING_READ(GMBUS2 + reg_offset);
 264         while (len) {
 265                 if (wait_for(I915_READ(GMBUS2 + reg_offset) &
 266                              (GMBUS_SATOER | GMBUS_HW_RDY),
 267                              50))
 268                         return -ETIMEDOUT;
 269                 if (I915_READ(GMBUS2 + reg_offset) & GMBUS_SATOER)
 270                         return -ENXIO;
 271
 272                 val = loop = 0;
 273                 do {
 274                         val |= *buf++ << (8 * loop);
 275                 } while (--len && ++loop < 4);
 276
 277                 I915_WRITE(GMBUS3 + reg_offset, val);
 278                 POSTING_READ(GMBUS2 + reg_offset);
 279         }
 280         return 0;
 281 }
 282
 283 static int
 284 gmbus_xfer(struct i2c_adapter *adapter,
 285            struct i2c_msg *msgs,
 286            int num)
 287 {
 288         struct intel_gmbus *bus = container_of(adapter,
 289                                                struct intel_gmbus,
 290                                                adapter);
 291         struct drm_i915_private *dev_priv = bus->dev_priv;
 292         int i, reg_offset, ret;
 293
 294         mutex_lock(&dev_priv->gmbus_mutex);
 295
 296         if (bus->force_bit) {
 297                 ret = i2c_bit_algo.master_xfer(adapter, msgs, num);
 298                 goto out;
 299         }
 300
 301         reg_offset = dev_priv->gpio_mmio_base;
 302
 303         I915_WRITE(GMBUS0 + reg_offset, bus->reg0);
 304
 305         for (i = 0; i < num; i++) {
 306                 bool last = i + 1 == num;
 307
 308                 if (msgs[i].flags & I2C_M_RD)
 309                         ret = gmbus_xfer_read(dev_priv, &msgs[i], last);
 310                 else
 311                         ret = gmbus_xfer_write(dev_priv, &msgs[i], last);
 312
 313                 if (ret == -ETIMEDOUT)
 314                         goto timeout;
 315                 if (ret == -ENXIO)
 316                         goto clear_err;
 317
 318                 if (!last &&
 319                     wait_for(I915_READ(GMBUS2 + reg_offset) &
 320                              (GMBUS_SATOER | GMBUS_HW_WAIT_PHASE),
 321                              50))
 322                         goto timeout;
 323                 if (I915_READ(GMBUS2 + reg_offset) & GMBUS_SATOER)
 324                         goto clear_err;
 325         }
 326
 327         goto done;
 328
 329 clear_err:
 330         /* Toggle the Software Clear Interrupt bit. This has the effect
 331          * of resetting the GMBUS controller and so clearing the
 332          * BUS_ERROR raised by the slave's NAK.
 333          */
 334         I915_WRITE(GMBUS1 + reg_offset, GMBUS_SW_CLR_INT);
 335         I915_WRITE(GMBUS1 + reg_offset, 0);
 336
 337 done:
 338         /* Mark the GMBUS interface as disabled after waiting for idle.
 339          * We will re-enable it at the start of the next xfer,
 340          * till then let it sleep.
 341          */
 342         if (wait_for((I915_READ(GMBUS2 + reg_offset) & GMBUS_ACTIVE) == 0, 10))
 343                 DRM_INFO("GMBUS [%s] timed out waiting for idle\n",
 344                          bus->adapter.name);
 345         I915_WRITE(GMBUS0 + reg_offset, 0);
 346         ret = i;
 347         goto out;
 348
 349 timeout:
 350         DRM_INFO("GMBUS [%s] timed out, falling back to bit banging on pin %d\n",
 351                  bus->adapter.name, bus->reg0 & 0xff);
 352         I915_WRITE(GMBUS0 + reg_offset, 0);
 353
 354         /* Hardware may not support GMBUS over these pins?
 355          * Try GPIO bitbanging instead.
 356          */
 357         if (!bus->has_gpio) {
 358                 ret = -EIO;
 359         } else {
 360                 bus->force_bit = true;
 361                 ret = i2c_bit_algo.master_xfer(adapter, msgs, num);
 362         }
 363
 364 out:
 365         mutex_unlock(&dev_priv->gmbus_mutex);
 366         return ret;
 367 }
 368
 369 static u32 gmbus_func(struct i2c_adapter *adapter)
 370 {
 371         return i2c_bit_algo.functionality(adapter) &
 372                 (I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
 373                 /* I2C_FUNC_10BIT_ADDR | */
 374                 I2C_FUNC_SMBUS_READ_BLOCK_DATA |
 375                 I2C_FUNC_SMBUS_BLOCK_PROC_CALL);
 376 }
 377
 378 static const struct i2c_algorithm gmbus_algorithm = {
 379         .master_xfer    = gmbus_xfer,
 380         .functionality  = gmbus_func
 381 };
 382
 383 /**
 384  * intel_gmbus_setup - instantiate all Intel i2c GMBuses
 385  * @dev: DRM device
 386  */
 387 int intel_setup_gmbus(struct drm_device *dev)
 388 {
 389         static const char *names[GMBUS_NUM_PORTS] = {
 390                 "disabled",
 391                 "ssc",
 392                 "vga",
 393                 "panel",
 394                 "dpc",
 395                 "dpb",
 396                 "dpd",
 397                 "reserved",
 398         };
 399         struct drm_i915_private *dev_priv = dev->dev_private;
 400         int ret, i;
 401
 402         if (HAS_PCH_SPLIT(dev))
 403                 dev_priv->gpio_mmio_base = PCH_GPIOA - GPIOA;
 404         else
 405                 dev_priv->gpio_mmio_base = 0;
 406
 407         dev_priv->gmbus = kcalloc(GMBUS_NUM_PORTS, sizeof(struct intel_gmbus),
 408                                   GFP_KERNEL);
 409         if (dev_priv->gmbus == NULL)
 410                 return -ENOMEM;
 411
 412         mutex_init(&dev_priv->gmbus_mutex);
 413
 414         for (i = 0; i < GMBUS_NUM_PORTS; i++) {
 415                 struct intel_gmbus *bus = &dev_priv->gmbus[i];
 416
 417                 bus->adapter.owner = THIS_MODULE;
 418                 bus->adapter.class = I2C_CLASS_DDC;
 419                 snprintf(bus->adapter.name,
 420                          sizeof(bus->adapter.name),
 421                          "i915 gmbus %s",
 422                          names[i]);
 423
 424                 bus->adapter.dev.parent = &dev->pdev->dev;
 425                 bus->dev_priv = dev_priv;
 426
 427                 bus->adapter.algo = &gmbus_algorithm;
 428                 ret = i2c_add_adapter(&bus->adapter);
 429                 if (ret)
 430                         goto err;
 431
 432                 /* By default use a conservative clock rate */
 433                 bus->reg0 = i | GMBUS_RATE_100KHZ;
 434
 435                 bus->has_gpio = intel_gpio_setup(bus, i);
 436         }
 437
 438         intel_i2c_reset(dev_priv->dev);
 439
 440         return 0;
 441
 442 err:
 443         while (--i) {
 444                 struct intel_gmbus *bus = &dev_priv->gmbus[i];
 445                 i2c_del_adapter(&bus->adapter);
 446         }
 447         kfree(dev_priv->gmbus);
 448         dev_priv->gmbus = NULL;
 449         return ret;
 450 }
 451
 452 void intel_gmbus_set_speed(struct i2c_adapter *adapter, int speed)
 453 {
 454         struct intel_gmbus *bus = to_intel_gmbus(adapter);
 455
 456         bus->reg0 = (bus->reg0 & ~(0x3 << 8)) | speed;
 457 }
 458
 459 void intel_gmbus_force_bit(struct i2c_adapter *adapter, bool force_bit)
 460 {
 461         struct intel_gmbus *bus = to_intel_gmbus(adapter);
 462
 463         if (bus->has_gpio)
 464                 bus->force_bit = force_bit;
 465 }
 466
 467 void intel_teardown_gmbus(struct drm_device *dev)
 468 {
 469         struct drm_i915_private *dev_priv = dev->dev_private;
 470         int i;
 471
 472         if (dev_priv->gmbus == NULL)
 473                 return;
 474
 475         for (i = 0; i < GMBUS_NUM_PORTS; i++) {
 476                 struct intel_gmbus *bus = &dev_priv->gmbus[i];
 477                 i2c_del_adapter(&bus->adapter);
 478         }
 479
 480         kfree(dev_priv->gmbus);
 481         dev_priv->gmbus = NULL;
 482 }