]> rtime.felk.cvut.cz Git - linux-imx.git/blob - drivers/gpu/drm/i915/intel_i2c.c
acf8aec9ada7162543954e4adf7c7b28d1bb4770
[linux-imx.git] / 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 <drm/drmP.h>
33 #include "intel_drv.h"
34 #include <drm/i915_drm.h>
35 #include "i915_drv.h"
36
37 struct gmbus_port {
38         const char *name;
39         int reg;
40 };
41
42 static const struct gmbus_port gmbus_ports[] = {
43         { "ssc", GPIOB },
44         { "vga", GPIOA },
45         { "panel", GPIOC },
46         { "dpc", GPIOD },
47         { "dpb", GPIOE },
48         { "dpd", GPIOF },
49 };
50
51 /* Intel GPIO access functions */
52
53 #define I2C_RISEFALL_TIME 10
54
55 static inline struct intel_gmbus *
56 to_intel_gmbus(struct i2c_adapter *i2c)
57 {
58         return container_of(i2c, struct intel_gmbus, adapter);
59 }
60
61 void
62 intel_i2c_reset(struct drm_device *dev)
63 {
64         struct drm_i915_private *dev_priv = dev->dev_private;
65         I915_WRITE(dev_priv->gpio_mmio_base + GMBUS0, 0);
66         I915_WRITE(dev_priv->gpio_mmio_base + GMBUS4, 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 #define HAS_GMBUS_IRQ(dev) (INTEL_INFO(dev)->gen >= 4)
207 static int
208 gmbus_wait_hw_status(struct drm_i915_private *dev_priv,
209                      u32 gmbus2_status,
210                      u32 gmbus4_irq_en)
211 {
212         int i;
213         int reg_offset = dev_priv->gpio_mmio_base;
214         u32 gmbus2 = 0;
215         DEFINE_WAIT(wait);
216
217         /* Important: The hw handles only the first bit, so set only one! Since
218          * we also need to check for NAKs besides the hw ready/idle signal, we
219          * need to wake up periodically and check that ourselves. */
220         I915_WRITE(GMBUS4 + reg_offset, gmbus4_irq_en);
221
222         for (i = 0; i < msecs_to_jiffies(50) + 1; i++) {
223                 prepare_to_wait(&dev_priv->gmbus_wait_queue, &wait,
224                                 TASK_UNINTERRUPTIBLE);
225
226                 gmbus2 = I915_READ_NOTRACE(GMBUS2 + reg_offset);
227                 if (gmbus2 & (GMBUS_SATOER | gmbus2_status))
228                         break;
229
230                 schedule_timeout(1);
231         }
232         finish_wait(&dev_priv->gmbus_wait_queue, &wait);
233
234         I915_WRITE(GMBUS4 + reg_offset, 0);
235
236         if (gmbus2 & GMBUS_SATOER)
237                 return -ENXIO;
238         if (gmbus2 & gmbus2_status)
239                 return 0;
240         return -ETIMEDOUT;
241 }
242
243 static int
244 gmbus_wait_idle(struct drm_i915_private *dev_priv)
245 {
246         int ret;
247         int reg_offset = dev_priv->gpio_mmio_base;
248
249 #define C ((I915_READ_NOTRACE(GMBUS2 + reg_offset) & GMBUS_ACTIVE) == 0)
250
251         if (!HAS_GMBUS_IRQ(dev_priv->dev))
252                 return wait_for(C, 10);
253
254         /* Important: The hw handles only the first bit, so set only one! */
255         I915_WRITE(GMBUS4 + reg_offset, GMBUS_IDLE_EN);
256
257         ret = wait_event_timeout(dev_priv->gmbus_wait_queue, C, 10);
258
259         I915_WRITE(GMBUS4 + reg_offset, 0);
260
261         if (ret)
262                 return 0;
263         else
264                 return -ETIMEDOUT;
265 #undef C
266 }
267
268 static int
269 gmbus_xfer_read(struct drm_i915_private *dev_priv, struct i2c_msg *msg,
270                 u32 gmbus1_index)
271 {
272         int reg_offset = dev_priv->gpio_mmio_base;
273         u16 len = msg->len;
274         u8 *buf = msg->buf;
275
276         I915_WRITE(GMBUS1 + reg_offset,
277                    gmbus1_index |
278                    GMBUS_CYCLE_WAIT |
279                    (len << GMBUS_BYTE_COUNT_SHIFT) |
280                    (msg->addr << GMBUS_SLAVE_ADDR_SHIFT) |
281                    GMBUS_SLAVE_READ | GMBUS_SW_RDY);
282         while (len) {
283                 int ret;
284                 u32 val, loop = 0;
285
286                 ret = gmbus_wait_hw_status(dev_priv, GMBUS_HW_RDY,
287                                            GMBUS_HW_RDY_EN);
288                 if (ret)
289                         return ret;
290
291                 val = I915_READ(GMBUS3 + reg_offset);
292                 do {
293                         *buf++ = val & 0xff;
294                         val >>= 8;
295                 } while (--len && ++loop < 4);
296         }
297
298         return 0;
299 }
300
301 static int
302 gmbus_xfer_write(struct drm_i915_private *dev_priv, struct i2c_msg *msg)
303 {
304         int reg_offset = dev_priv->gpio_mmio_base;
305         u16 len = msg->len;
306         u8 *buf = msg->buf;
307         u32 val, loop;
308
309         val = loop = 0;
310         while (len && loop < 4) {
311                 val |= *buf++ << (8 * loop++);
312                 len -= 1;
313         }
314
315         I915_WRITE(GMBUS3 + reg_offset, val);
316         I915_WRITE(GMBUS1 + reg_offset,
317                    GMBUS_CYCLE_WAIT |
318                    (msg->len << GMBUS_BYTE_COUNT_SHIFT) |
319                    (msg->addr << GMBUS_SLAVE_ADDR_SHIFT) |
320                    GMBUS_SLAVE_WRITE | GMBUS_SW_RDY);
321         while (len) {
322                 int ret;
323
324                 val = loop = 0;
325                 do {
326                         val |= *buf++ << (8 * loop);
327                 } while (--len && ++loop < 4);
328
329                 I915_WRITE(GMBUS3 + reg_offset, val);
330
331                 ret = gmbus_wait_hw_status(dev_priv, GMBUS_HW_RDY,
332                                            GMBUS_HW_RDY_EN);
333                 if (ret)
334                         return ret;
335         }
336         return 0;
337 }
338
339 /*
340  * The gmbus controller can combine a 1 or 2 byte write with a read that
341  * immediately follows it by using an "INDEX" cycle.
342  */
343 static bool
344 gmbus_is_index_read(struct i2c_msg *msgs, int i, int num)
345 {
346         return (i + 1 < num &&
347                 !(msgs[i].flags & I2C_M_RD) && msgs[i].len <= 2 &&
348                 (msgs[i + 1].flags & I2C_M_RD));
349 }
350
351 static int
352 gmbus_xfer_index_read(struct drm_i915_private *dev_priv, struct i2c_msg *msgs)
353 {
354         int reg_offset = dev_priv->gpio_mmio_base;
355         u32 gmbus1_index = 0;
356         u32 gmbus5 = 0;
357         int ret;
358
359         if (msgs[0].len == 2)
360                 gmbus5 = GMBUS_2BYTE_INDEX_EN |
361                          msgs[0].buf[1] | (msgs[0].buf[0] << 8);
362         if (msgs[0].len == 1)
363                 gmbus1_index = GMBUS_CYCLE_INDEX |
364                                (msgs[0].buf[0] << GMBUS_SLAVE_INDEX_SHIFT);
365
366         /* GMBUS5 holds 16-bit index */
367         if (gmbus5)
368                 I915_WRITE(GMBUS5 + reg_offset, gmbus5);
369
370         ret = gmbus_xfer_read(dev_priv, &msgs[1], gmbus1_index);
371
372         /* Clear GMBUS5 after each index transfer */
373         if (gmbus5)
374                 I915_WRITE(GMBUS5 + reg_offset, 0);
375
376         return ret;
377 }
378
379 static int
380 gmbus_xfer(struct i2c_adapter *adapter,
381            struct i2c_msg *msgs,
382            int num)
383 {
384         struct intel_gmbus *bus = container_of(adapter,
385                                                struct intel_gmbus,
386                                                adapter);
387         struct drm_i915_private *dev_priv = bus->dev_priv;
388         int i, reg_offset;
389         int ret = 0;
390
391         mutex_lock(&dev_priv->gmbus_mutex);
392
393         if (bus->force_bit) {
394                 ret = i2c_bit_algo.master_xfer(adapter, msgs, num);
395                 goto out;
396         }
397
398         reg_offset = dev_priv->gpio_mmio_base;
399
400         I915_WRITE(GMBUS0 + reg_offset, bus->reg0);
401
402         for (i = 0; i < num; i++) {
403                 if (gmbus_is_index_read(msgs, i, num)) {
404                         ret = gmbus_xfer_index_read(dev_priv, &msgs[i]);
405                         i += 1;  /* set i to the index of the read xfer */
406                 } else if (msgs[i].flags & I2C_M_RD) {
407                         ret = gmbus_xfer_read(dev_priv, &msgs[i], 0);
408                 } else {
409                         ret = gmbus_xfer_write(dev_priv, &msgs[i]);
410                 }
411
412                 if (ret == -ETIMEDOUT)
413                         goto timeout;
414                 if (ret == -ENXIO)
415                         goto clear_err;
416
417                 ret = gmbus_wait_hw_status(dev_priv, GMBUS_HW_WAIT_PHASE,
418                                            GMBUS_HW_WAIT_EN);
419                 if (ret == -ENXIO)
420                         goto clear_err;
421                 if (ret)
422                         goto timeout;
423         }
424
425         /* Generate a STOP condition on the bus. Note that gmbus can't generata
426          * a STOP on the very first cycle. To simplify the code we
427          * unconditionally generate the STOP condition with an additional gmbus
428          * cycle. */
429         I915_WRITE(GMBUS1 + reg_offset, GMBUS_CYCLE_STOP | GMBUS_SW_RDY);
430
431         /* Mark the GMBUS interface as disabled after waiting for idle.
432          * We will re-enable it at the start of the next xfer,
433          * till then let it sleep.
434          */
435         if (gmbus_wait_idle(dev_priv)) {
436                 DRM_DEBUG_KMS("GMBUS [%s] timed out waiting for idle\n",
437                          adapter->name);
438                 ret = -ETIMEDOUT;
439         }
440         I915_WRITE(GMBUS0 + reg_offset, 0);
441         ret = ret ?: i;
442         goto out;
443
444 clear_err:
445         /*
446          * Wait for bus to IDLE before clearing NAK.
447          * If we clear the NAK while bus is still active, then it will stay
448          * active and the next transaction may fail.
449          *
450          * If no ACK is received during the address phase of a transaction, the
451          * adapter must report -ENXIO. It is not clear what to return if no ACK
452          * is received at other times. But we have to be careful to not return
453          * spurious -ENXIO because that will prevent i2c and drm edid functions
454          * from retrying. So return -ENXIO only when gmbus properly quiescents -
455          * timing out seems to happen when there _is_ a ddc chip present, but
456          * it's slow responding and only answers on the 2nd retry.
457          */
458         ret = -ENXIO;
459         if (gmbus_wait_idle(dev_priv)) {
460                 DRM_DEBUG_KMS("GMBUS [%s] timed out after NAK\n",
461                               adapter->name);
462                 ret = -ETIMEDOUT;
463         }
464
465         /* Toggle the Software Clear Interrupt bit. This has the effect
466          * of resetting the GMBUS controller and so clearing the
467          * BUS_ERROR raised by the slave's NAK.
468          */
469         I915_WRITE(GMBUS1 + reg_offset, GMBUS_SW_CLR_INT);
470         I915_WRITE(GMBUS1 + reg_offset, 0);
471         I915_WRITE(GMBUS0 + reg_offset, 0);
472
473         DRM_DEBUG_KMS("GMBUS [%s] NAK for addr: %04x %c(%d)\n",
474                          adapter->name, msgs[i].addr,
475                          (msgs[i].flags & I2C_M_RD) ? 'r' : 'w', msgs[i].len);
476
477         goto out;
478
479 timeout:
480         DRM_INFO("GMBUS [%s] timed out, falling back to bit banging on pin %d\n",
481                  bus->adapter.name, bus->reg0 & 0xff);
482         I915_WRITE(GMBUS0 + reg_offset, 0);
483
484         /* Hardware may not support GMBUS over these pins? Try GPIO bitbanging instead. */
485         bus->force_bit = 1;
486         ret = i2c_bit_algo.master_xfer(adapter, msgs, num);
487
488 out:
489         mutex_unlock(&dev_priv->gmbus_mutex);
490         return ret;
491 }
492
493 static u32 gmbus_func(struct i2c_adapter *adapter)
494 {
495         return i2c_bit_algo.functionality(adapter) &
496                 (I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
497                 /* I2C_FUNC_10BIT_ADDR | */
498                 I2C_FUNC_SMBUS_READ_BLOCK_DATA |
499                 I2C_FUNC_SMBUS_BLOCK_PROC_CALL);
500 }
501
502 static const struct i2c_algorithm gmbus_algorithm = {
503         .master_xfer    = gmbus_xfer,
504         .functionality  = gmbus_func
505 };
506
507 /**
508  * intel_gmbus_setup - instantiate all Intel i2c GMBuses
509  * @dev: DRM device
510  */
511 int intel_setup_gmbus(struct drm_device *dev)
512 {
513         struct drm_i915_private *dev_priv = dev->dev_private;
514         int ret, i;
515
516         if (HAS_PCH_SPLIT(dev))
517                 dev_priv->gpio_mmio_base = PCH_GPIOA - GPIOA;
518         else if (IS_VALLEYVIEW(dev))
519                 dev_priv->gpio_mmio_base = VLV_DISPLAY_BASE;
520         else
521                 dev_priv->gpio_mmio_base = 0;
522
523         mutex_init(&dev_priv->gmbus_mutex);
524         init_waitqueue_head(&dev_priv->gmbus_wait_queue);
525
526         for (i = 0; i < GMBUS_NUM_PORTS; i++) {
527                 struct intel_gmbus *bus = &dev_priv->gmbus[i];
528                 u32 port = i + 1; /* +1 to map gmbus index to pin pair */
529
530                 bus->adapter.owner = THIS_MODULE;
531                 bus->adapter.class = I2C_CLASS_DDC;
532                 snprintf(bus->adapter.name,
533                          sizeof(bus->adapter.name),
534                          "i915 gmbus %s",
535                          gmbus_ports[i].name);
536
537                 bus->adapter.dev.parent = &dev->pdev->dev;
538                 bus->dev_priv = dev_priv;
539
540                 bus->adapter.algo = &gmbus_algorithm;
541
542                 /* By default use a conservative clock rate */
543                 bus->reg0 = port | GMBUS_RATE_100KHZ;
544
545                 /* gmbus seems to be broken on i830 */
546                 if (IS_I830(dev))
547                         bus->force_bit = 1;
548
549                 intel_gpio_setup(bus, port);
550
551                 ret = i2c_add_adapter(&bus->adapter);
552                 if (ret)
553                         goto err;
554         }
555
556         intel_i2c_reset(dev_priv->dev);
557
558         return 0;
559
560 err:
561         while (--i) {
562                 struct intel_gmbus *bus = &dev_priv->gmbus[i];
563                 i2c_del_adapter(&bus->adapter);
564         }
565         return ret;
566 }
567
568 struct i2c_adapter *intel_gmbus_get_adapter(struct drm_i915_private *dev_priv,
569                                             unsigned port)
570 {
571         WARN_ON(!intel_gmbus_is_port_valid(port));
572         /* -1 to map pin pair to gmbus index */
573         return (intel_gmbus_is_port_valid(port)) ?
574                 &dev_priv->gmbus[port - 1].adapter : NULL;
575 }
576
577 void intel_gmbus_set_speed(struct i2c_adapter *adapter, int speed)
578 {
579         struct intel_gmbus *bus = to_intel_gmbus(adapter);
580
581         bus->reg0 = (bus->reg0 & ~(0x3 << 8)) | speed;
582 }
583
584 void intel_gmbus_force_bit(struct i2c_adapter *adapter, bool force_bit)
585 {
586         struct intel_gmbus *bus = to_intel_gmbus(adapter);
587
588         bus->force_bit += force_bit ? 1 : -1;
589         DRM_DEBUG_KMS("%sabling bit-banging on %s. force bit now %d\n",
590                       force_bit ? "en" : "dis", adapter->name,
591                       bus->force_bit);
592 }
593
594 void intel_teardown_gmbus(struct drm_device *dev)
595 {
596         struct drm_i915_private *dev_priv = dev->dev_private;
597         int i;
598
599         for (i = 0; i < GMBUS_NUM_PORTS; i++) {
600                 struct intel_gmbus *bus = &dev_priv->gmbus[i];
601                 i2c_del_adapter(&bus->adapter);
602         }
603 }