2 * Copyright (c) 2006 Dave Airlie <airlied@linux.ie>
3 * Copyright © 2006-2008,2010 Intel Corporation
4 * Jesse Barnes <jesse.barnes@intel.com>
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:
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
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.
26 * Eric Anholt <eric@anholt.net>
27 * Chris Wilson <chris@chris-wilson.co.uk>
29 #include <linux/i2c.h>
30 #include <linux/i2c-algo-bit.h>
31 #include <linux/export.h>
33 #include "intel_drv.h"
34 #include <drm/i915_drm.h>
47 static const struct gmbus_port gmbus_ports
[] = {
56 /* Intel GPIO access functions */
58 #define I2C_RISEFALL_TIME 10
60 static inline struct intel_gmbus
*
61 to_intel_gmbus(struct i2c_adapter
*i2c
)
63 return container_of(i2c
, struct intel_gmbus
, adapter
);
66 static int get_disp_clk_div(struct drm_i915_private
*dev_priv
,
72 reg_val
= I915_READ(CZCLK_CDCLK_FREQ_RATIO
);
76 ((reg_val
& CDCLK_FREQ_MASK
) >> CDCLK_FREQ_SHIFT
) + 1;
78 clk_ratio
= (reg_val
& CZCLK_FREQ_MASK
) + 1;
83 static void gmbus_set_freq(struct drm_i915_private
*dev_priv
)
85 int vco_freq
[] = { 800, 1600, 2000, 2400 };
86 int gmbus_freq
= 0, cdclk_div
, hpll_freq
;
88 BUG_ON(!IS_VALLEYVIEW(dev_priv
->dev
));
90 /* Skip setting the gmbus freq if BIOS has already programmed it */
91 if (I915_READ(GMBUSFREQ_VLV
) != 0xA0)
94 /* Obtain SKU information */
95 mutex_lock(&dev_priv
->dpio_lock
);
97 vlv_cck_read(dev_priv
, CCK_FUSE_REG
) & CCK_FUSE_HPLL_FREQ_MASK
;
98 mutex_unlock(&dev_priv
->dpio_lock
);
100 /* Get the CDCLK divide ratio */
101 cdclk_div
= get_disp_clk_div(dev_priv
, CDCLK
);
104 * Program the gmbus_freq based on the cdclk frequency.
105 * BSpec erroneously claims we should aim for 4MHz, but
106 * in fact 1MHz is the correct frequency.
109 gmbus_freq
= (vco_freq
[hpll_freq
] << 1) / cdclk_div
;
111 if (WARN_ON(gmbus_freq
== 0))
114 I915_WRITE(GMBUSFREQ_VLV
, gmbus_freq
);
118 intel_i2c_reset(struct drm_device
*dev
)
120 struct drm_i915_private
*dev_priv
= dev
->dev_private
;
123 * In BIOS-less system, program the correct gmbus frequency
124 * before reading edid.
126 if (IS_VALLEYVIEW(dev
))
127 gmbus_set_freq(dev_priv
);
129 I915_WRITE(dev_priv
->gpio_mmio_base
+ GMBUS0
, 0);
130 I915_WRITE(dev_priv
->gpio_mmio_base
+ GMBUS4
, 0);
133 static void intel_i2c_quirk_set(struct drm_i915_private
*dev_priv
, bool enable
)
137 /* When using bit bashing for I2C, this bit needs to be set to 1 */
138 if (!IS_PINEVIEW(dev_priv
->dev
))
141 val
= I915_READ(DSPCLK_GATE_D
);
143 val
|= DPCUNIT_CLOCK_GATE_DISABLE
;
145 val
&= ~DPCUNIT_CLOCK_GATE_DISABLE
;
146 I915_WRITE(DSPCLK_GATE_D
, val
);
149 static u32
get_reserved(struct intel_gmbus
*bus
)
151 struct drm_i915_private
*dev_priv
= bus
->dev_priv
;
152 struct drm_device
*dev
= dev_priv
->dev
;
155 /* On most chips, these bits must be preserved in software. */
156 if (!IS_I830(dev
) && !IS_845G(dev
))
157 reserved
= I915_READ_NOTRACE(bus
->gpio_reg
) &
158 (GPIO_DATA_PULLUP_DISABLE
|
159 GPIO_CLOCK_PULLUP_DISABLE
);
164 static int get_clock(void *data
)
166 struct intel_gmbus
*bus
= data
;
167 struct drm_i915_private
*dev_priv
= bus
->dev_priv
;
168 u32 reserved
= get_reserved(bus
);
169 I915_WRITE_NOTRACE(bus
->gpio_reg
, reserved
| GPIO_CLOCK_DIR_MASK
);
170 I915_WRITE_NOTRACE(bus
->gpio_reg
, reserved
);
171 return (I915_READ_NOTRACE(bus
->gpio_reg
) & GPIO_CLOCK_VAL_IN
) != 0;
174 static int get_data(void *data
)
176 struct intel_gmbus
*bus
= data
;
177 struct drm_i915_private
*dev_priv
= bus
->dev_priv
;
178 u32 reserved
= get_reserved(bus
);
179 I915_WRITE_NOTRACE(bus
->gpio_reg
, reserved
| GPIO_DATA_DIR_MASK
);
180 I915_WRITE_NOTRACE(bus
->gpio_reg
, reserved
);
181 return (I915_READ_NOTRACE(bus
->gpio_reg
) & GPIO_DATA_VAL_IN
) != 0;
184 static void set_clock(void *data
, int state_high
)
186 struct intel_gmbus
*bus
= data
;
187 struct drm_i915_private
*dev_priv
= bus
->dev_priv
;
188 u32 reserved
= get_reserved(bus
);
192 clock_bits
= GPIO_CLOCK_DIR_IN
| GPIO_CLOCK_DIR_MASK
;
194 clock_bits
= GPIO_CLOCK_DIR_OUT
| GPIO_CLOCK_DIR_MASK
|
197 I915_WRITE_NOTRACE(bus
->gpio_reg
, reserved
| clock_bits
);
198 POSTING_READ(bus
->gpio_reg
);
201 static void set_data(void *data
, int state_high
)
203 struct intel_gmbus
*bus
= data
;
204 struct drm_i915_private
*dev_priv
= bus
->dev_priv
;
205 u32 reserved
= get_reserved(bus
);
209 data_bits
= GPIO_DATA_DIR_IN
| GPIO_DATA_DIR_MASK
;
211 data_bits
= GPIO_DATA_DIR_OUT
| GPIO_DATA_DIR_MASK
|
214 I915_WRITE_NOTRACE(bus
->gpio_reg
, reserved
| data_bits
);
215 POSTING_READ(bus
->gpio_reg
);
219 intel_gpio_pre_xfer(struct i2c_adapter
*adapter
)
221 struct intel_gmbus
*bus
= container_of(adapter
,
224 struct drm_i915_private
*dev_priv
= bus
->dev_priv
;
226 intel_i2c_reset(dev_priv
->dev
);
227 intel_i2c_quirk_set(dev_priv
, true);
230 udelay(I2C_RISEFALL_TIME
);
235 intel_gpio_post_xfer(struct i2c_adapter
*adapter
)
237 struct intel_gmbus
*bus
= container_of(adapter
,
240 struct drm_i915_private
*dev_priv
= bus
->dev_priv
;
244 intel_i2c_quirk_set(dev_priv
, false);
248 intel_gpio_setup(struct intel_gmbus
*bus
, u32 pin
)
250 struct drm_i915_private
*dev_priv
= bus
->dev_priv
;
251 struct i2c_algo_bit_data
*algo
;
253 algo
= &bus
->bit_algo
;
255 /* -1 to map pin pair to gmbus index */
256 bus
->gpio_reg
= dev_priv
->gpio_mmio_base
+ gmbus_ports
[pin
- 1].reg
;
258 bus
->adapter
.algo_data
= algo
;
259 algo
->setsda
= set_data
;
260 algo
->setscl
= set_clock
;
261 algo
->getsda
= get_data
;
262 algo
->getscl
= get_clock
;
263 algo
->pre_xfer
= intel_gpio_pre_xfer
;
264 algo
->post_xfer
= intel_gpio_post_xfer
;
265 algo
->udelay
= I2C_RISEFALL_TIME
;
266 algo
->timeout
= usecs_to_jiffies(2200);
271 * gmbus on gen4 seems to be able to generate legacy interrupts even when in MSI
272 * mode. This results in spurious interrupt warnings if the legacy irq no. is
273 * shared with another device. The kernel then disables that interrupt source
274 * and so prevents the other device from working properly.
276 #define HAS_GMBUS_IRQ(dev) (INTEL_INFO(dev)->gen >= 5)
278 gmbus_wait_hw_status(struct drm_i915_private
*dev_priv
,
283 int reg_offset
= dev_priv
->gpio_mmio_base
;
287 if (!HAS_GMBUS_IRQ(dev_priv
->dev
))
290 /* Important: The hw handles only the first bit, so set only one! Since
291 * we also need to check for NAKs besides the hw ready/idle signal, we
292 * need to wake up periodically and check that ourselves. */
293 I915_WRITE(GMBUS4
+ reg_offset
, gmbus4_irq_en
);
295 for (i
= 0; i
< msecs_to_jiffies_timeout(50); i
++) {
296 prepare_to_wait(&dev_priv
->gmbus_wait_queue
, &wait
,
297 TASK_UNINTERRUPTIBLE
);
299 gmbus2
= I915_READ_NOTRACE(GMBUS2
+ reg_offset
);
300 if (gmbus2
& (GMBUS_SATOER
| gmbus2_status
))
305 finish_wait(&dev_priv
->gmbus_wait_queue
, &wait
);
307 I915_WRITE(GMBUS4
+ reg_offset
, 0);
309 if (gmbus2
& GMBUS_SATOER
)
311 if (gmbus2
& gmbus2_status
)
317 gmbus_wait_idle(struct drm_i915_private
*dev_priv
)
320 int reg_offset
= dev_priv
->gpio_mmio_base
;
322 #define C ((I915_READ_NOTRACE(GMBUS2 + reg_offset) & GMBUS_ACTIVE) == 0)
324 if (!HAS_GMBUS_IRQ(dev_priv
->dev
))
325 return wait_for(C
, 10);
327 /* Important: The hw handles only the first bit, so set only one! */
328 I915_WRITE(GMBUS4
+ reg_offset
, GMBUS_IDLE_EN
);
330 ret
= wait_event_timeout(dev_priv
->gmbus_wait_queue
, C
,
331 msecs_to_jiffies_timeout(10));
333 I915_WRITE(GMBUS4
+ reg_offset
, 0);
343 gmbus_xfer_read(struct drm_i915_private
*dev_priv
, struct i2c_msg
*msg
,
346 int reg_offset
= dev_priv
->gpio_mmio_base
;
350 I915_WRITE(GMBUS1
+ reg_offset
,
353 (len
<< GMBUS_BYTE_COUNT_SHIFT
) |
354 (msg
->addr
<< GMBUS_SLAVE_ADDR_SHIFT
) |
355 GMBUS_SLAVE_READ
| GMBUS_SW_RDY
);
360 ret
= gmbus_wait_hw_status(dev_priv
, GMBUS_HW_RDY
,
365 val
= I915_READ(GMBUS3
+ reg_offset
);
369 } while (--len
&& ++loop
< 4);
376 gmbus_xfer_write(struct drm_i915_private
*dev_priv
, struct i2c_msg
*msg
)
378 int reg_offset
= dev_priv
->gpio_mmio_base
;
384 while (len
&& loop
< 4) {
385 val
|= *buf
++ << (8 * loop
++);
389 I915_WRITE(GMBUS3
+ reg_offset
, val
);
390 I915_WRITE(GMBUS1
+ reg_offset
,
392 (msg
->len
<< GMBUS_BYTE_COUNT_SHIFT
) |
393 (msg
->addr
<< GMBUS_SLAVE_ADDR_SHIFT
) |
394 GMBUS_SLAVE_WRITE
| GMBUS_SW_RDY
);
400 val
|= *buf
++ << (8 * loop
);
401 } while (--len
&& ++loop
< 4);
403 I915_WRITE(GMBUS3
+ reg_offset
, val
);
405 ret
= gmbus_wait_hw_status(dev_priv
, GMBUS_HW_RDY
,
414 * The gmbus controller can combine a 1 or 2 byte write with a read that
415 * immediately follows it by using an "INDEX" cycle.
418 gmbus_is_index_read(struct i2c_msg
*msgs
, int i
, int num
)
420 return (i
+ 1 < num
&&
421 !(msgs
[i
].flags
& I2C_M_RD
) && msgs
[i
].len
<= 2 &&
422 (msgs
[i
+ 1].flags
& I2C_M_RD
));
426 gmbus_xfer_index_read(struct drm_i915_private
*dev_priv
, struct i2c_msg
*msgs
)
428 int reg_offset
= dev_priv
->gpio_mmio_base
;
429 u32 gmbus1_index
= 0;
433 if (msgs
[0].len
== 2)
434 gmbus5
= GMBUS_2BYTE_INDEX_EN
|
435 msgs
[0].buf
[1] | (msgs
[0].buf
[0] << 8);
436 if (msgs
[0].len
== 1)
437 gmbus1_index
= GMBUS_CYCLE_INDEX
|
438 (msgs
[0].buf
[0] << GMBUS_SLAVE_INDEX_SHIFT
);
440 /* GMBUS5 holds 16-bit index */
442 I915_WRITE(GMBUS5
+ reg_offset
, gmbus5
);
444 ret
= gmbus_xfer_read(dev_priv
, &msgs
[1], gmbus1_index
);
446 /* Clear GMBUS5 after each index transfer */
448 I915_WRITE(GMBUS5
+ reg_offset
, 0);
454 gmbus_xfer(struct i2c_adapter
*adapter
,
455 struct i2c_msg
*msgs
,
458 struct intel_gmbus
*bus
= container_of(adapter
,
461 struct drm_i915_private
*dev_priv
= bus
->dev_priv
;
465 intel_aux_display_runtime_get(dev_priv
);
466 mutex_lock(&dev_priv
->gmbus_mutex
);
468 if (bus
->force_bit
) {
469 ret
= i2c_bit_algo
.master_xfer(adapter
, msgs
, num
);
473 reg_offset
= dev_priv
->gpio_mmio_base
;
475 I915_WRITE(GMBUS0
+ reg_offset
, bus
->reg0
);
477 for (i
= 0; i
< num
; i
++) {
478 if (gmbus_is_index_read(msgs
, i
, num
)) {
479 ret
= gmbus_xfer_index_read(dev_priv
, &msgs
[i
]);
480 i
+= 1; /* set i to the index of the read xfer */
481 } else if (msgs
[i
].flags
& I2C_M_RD
) {
482 ret
= gmbus_xfer_read(dev_priv
, &msgs
[i
], 0);
484 ret
= gmbus_xfer_write(dev_priv
, &msgs
[i
]);
487 if (ret
== -ETIMEDOUT
)
492 ret
= gmbus_wait_hw_status(dev_priv
, GMBUS_HW_WAIT_PHASE
,
500 /* Generate a STOP condition on the bus. Note that gmbus can't generata
501 * a STOP on the very first cycle. To simplify the code we
502 * unconditionally generate the STOP condition with an additional gmbus
504 I915_WRITE(GMBUS1
+ reg_offset
, GMBUS_CYCLE_STOP
| GMBUS_SW_RDY
);
506 /* Mark the GMBUS interface as disabled after waiting for idle.
507 * We will re-enable it at the start of the next xfer,
508 * till then let it sleep.
510 if (gmbus_wait_idle(dev_priv
)) {
511 DRM_DEBUG_KMS("GMBUS [%s] timed out waiting for idle\n",
515 I915_WRITE(GMBUS0
+ reg_offset
, 0);
521 * Wait for bus to IDLE before clearing NAK.
522 * If we clear the NAK while bus is still active, then it will stay
523 * active and the next transaction may fail.
525 * If no ACK is received during the address phase of a transaction, the
526 * adapter must report -ENXIO. It is not clear what to return if no ACK
527 * is received at other times. But we have to be careful to not return
528 * spurious -ENXIO because that will prevent i2c and drm edid functions
529 * from retrying. So return -ENXIO only when gmbus properly quiescents -
530 * timing out seems to happen when there _is_ a ddc chip present, but
531 * it's slow responding and only answers on the 2nd retry.
534 if (gmbus_wait_idle(dev_priv
)) {
535 DRM_DEBUG_KMS("GMBUS [%s] timed out after NAK\n",
540 /* Toggle the Software Clear Interrupt bit. This has the effect
541 * of resetting the GMBUS controller and so clearing the
542 * BUS_ERROR raised by the slave's NAK.
544 I915_WRITE(GMBUS1
+ reg_offset
, GMBUS_SW_CLR_INT
);
545 I915_WRITE(GMBUS1
+ reg_offset
, 0);
546 I915_WRITE(GMBUS0
+ reg_offset
, 0);
548 DRM_DEBUG_KMS("GMBUS [%s] NAK for addr: %04x %c(%d)\n",
549 adapter
->name
, msgs
[i
].addr
,
550 (msgs
[i
].flags
& I2C_M_RD
) ? 'r' : 'w', msgs
[i
].len
);
555 DRM_INFO("GMBUS [%s] timed out, falling back to bit banging on pin %d\n",
556 bus
->adapter
.name
, bus
->reg0
& 0xff);
557 I915_WRITE(GMBUS0
+ reg_offset
, 0);
559 /* Hardware may not support GMBUS over these pins? Try GPIO bitbanging instead. */
561 ret
= i2c_bit_algo
.master_xfer(adapter
, msgs
, num
);
564 mutex_unlock(&dev_priv
->gmbus_mutex
);
565 intel_aux_display_runtime_put(dev_priv
);
569 static u32
gmbus_func(struct i2c_adapter
*adapter
)
571 return i2c_bit_algo
.functionality(adapter
) &
572 (I2C_FUNC_I2C
| I2C_FUNC_SMBUS_EMUL
|
573 /* I2C_FUNC_10BIT_ADDR | */
574 I2C_FUNC_SMBUS_READ_BLOCK_DATA
|
575 I2C_FUNC_SMBUS_BLOCK_PROC_CALL
);
578 static const struct i2c_algorithm gmbus_algorithm
= {
579 .master_xfer
= gmbus_xfer
,
580 .functionality
= gmbus_func
584 * intel_gmbus_setup - instantiate all Intel i2c GMBuses
587 int intel_setup_gmbus(struct drm_device
*dev
)
589 struct drm_i915_private
*dev_priv
= dev
->dev_private
;
592 if (HAS_PCH_NOP(dev
))
594 else if (HAS_PCH_SPLIT(dev
))
595 dev_priv
->gpio_mmio_base
= PCH_GPIOA
- GPIOA
;
596 else if (IS_VALLEYVIEW(dev
))
597 dev_priv
->gpio_mmio_base
= VLV_DISPLAY_BASE
;
599 dev_priv
->gpio_mmio_base
= 0;
601 mutex_init(&dev_priv
->gmbus_mutex
);
602 init_waitqueue_head(&dev_priv
->gmbus_wait_queue
);
604 for (i
= 0; i
< GMBUS_NUM_PORTS
; i
++) {
605 struct intel_gmbus
*bus
= &dev_priv
->gmbus
[i
];
606 u32 port
= i
+ 1; /* +1 to map gmbus index to pin pair */
608 bus
->adapter
.owner
= THIS_MODULE
;
609 bus
->adapter
.class = I2C_CLASS_DDC
;
610 snprintf(bus
->adapter
.name
,
611 sizeof(bus
->adapter
.name
),
613 gmbus_ports
[i
].name
);
615 bus
->adapter
.dev
.parent
= &dev
->pdev
->dev
;
616 bus
->dev_priv
= dev_priv
;
618 bus
->adapter
.algo
= &gmbus_algorithm
;
620 /* By default use a conservative clock rate */
621 bus
->reg0
= port
| GMBUS_RATE_100KHZ
;
623 /* gmbus seems to be broken on i830 */
627 intel_gpio_setup(bus
, port
);
629 ret
= i2c_add_adapter(&bus
->adapter
);
634 intel_i2c_reset(dev_priv
->dev
);
640 struct intel_gmbus
*bus
= &dev_priv
->gmbus
[i
];
641 i2c_del_adapter(&bus
->adapter
);
646 struct i2c_adapter
*intel_gmbus_get_adapter(struct drm_i915_private
*dev_priv
,
649 WARN_ON(!intel_gmbus_is_port_valid(port
));
650 /* -1 to map pin pair to gmbus index */
651 return (intel_gmbus_is_port_valid(port
)) ?
652 &dev_priv
->gmbus
[port
- 1].adapter
: NULL
;
655 void intel_gmbus_set_speed(struct i2c_adapter
*adapter
, int speed
)
657 struct intel_gmbus
*bus
= to_intel_gmbus(adapter
);
659 bus
->reg0
= (bus
->reg0
& ~(0x3 << 8)) | speed
;
662 void intel_gmbus_force_bit(struct i2c_adapter
*adapter
, bool force_bit
)
664 struct intel_gmbus
*bus
= to_intel_gmbus(adapter
);
666 bus
->force_bit
+= force_bit
? 1 : -1;
667 DRM_DEBUG_KMS("%sabling bit-banging on %s. force bit now %d\n",
668 force_bit
? "en" : "dis", adapter
->name
,
672 void intel_teardown_gmbus(struct drm_device
*dev
)
674 struct drm_i915_private
*dev_priv
= dev
->dev_private
;
677 for (i
= 0; i
< GMBUS_NUM_PORTS
; i
++) {
678 struct intel_gmbus
*bus
= &dev_priv
->gmbus
[i
];
679 i2c_del_adapter(&bus
->adapter
);