blob: 214a4c649d568a7230d3a7917e6771273af4213d [file] [log] [blame]
Keith Packarda4fc5ed2009-04-07 16:16:42 -07001/*
2 * Copyright © 2009 Keith Packard
3 *
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that copyright
7 * notice and this permission notice appear in supporting documentation, and
8 * that the name of the copyright holders not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. The copyright holders make no representations
11 * about the suitability of this software for any purpose. It is provided "as
12 * is" without express or implied warranty.
13 *
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
20 * OF THIS SOFTWARE.
21 */
22
23#include <linux/kernel.h>
24#include <linux/module.h>
25#include <linux/delay.h>
Keith Packarda4fc5ed2009-04-07 16:16:42 -070026#include <linux/init.h>
27#include <linux/errno.h>
28#include <linux/sched.h>
29#include <linux/i2c.h>
David Howells760285e2012-10-02 18:01:07 +010030#include <drm/drm_dp_helper.h>
31#include <drm/drmP.h>
Keith Packarda4fc5ed2009-04-07 16:16:42 -070032
Daniel Vetter28164fd2012-11-01 14:45:18 +010033/**
34 * DOC: dp helpers
35 *
36 * These functions contain some common logic and helpers at various abstraction
37 * levels to deal with Display Port sink devices and related things like DP aux
38 * channel transfers, EDID reading over DP aux channels, decoding certain DPCD
39 * blocks, ...
40 */
41
Daniel Vetter1ffdff12012-10-18 10:15:24 +020042/* Helpers for DP link training */
Jani Nikula0aec2882013-09-27 19:01:01 +030043static u8 dp_link_status(const u8 link_status[DP_LINK_STATUS_SIZE], int r)
Daniel Vetter1ffdff12012-10-18 10:15:24 +020044{
45 return link_status[r - DP_LANE0_1_STATUS];
46}
47
Jani Nikula0aec2882013-09-27 19:01:01 +030048static u8 dp_get_lane_status(const u8 link_status[DP_LINK_STATUS_SIZE],
Daniel Vetter1ffdff12012-10-18 10:15:24 +020049 int lane)
50{
51 int i = DP_LANE0_1_STATUS + (lane >> 1);
52 int s = (lane & 1) * 4;
53 u8 l = dp_link_status(link_status, i);
54 return (l >> s) & 0xf;
55}
56
Jani Nikula0aec2882013-09-27 19:01:01 +030057bool drm_dp_channel_eq_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
Daniel Vetter1ffdff12012-10-18 10:15:24 +020058 int lane_count)
59{
60 u8 lane_align;
61 u8 lane_status;
62 int lane;
63
64 lane_align = dp_link_status(link_status,
65 DP_LANE_ALIGN_STATUS_UPDATED);
66 if ((lane_align & DP_INTERLANE_ALIGN_DONE) == 0)
67 return false;
68 for (lane = 0; lane < lane_count; lane++) {
69 lane_status = dp_get_lane_status(link_status, lane);
70 if ((lane_status & DP_CHANNEL_EQ_BITS) != DP_CHANNEL_EQ_BITS)
71 return false;
72 }
73 return true;
74}
75EXPORT_SYMBOL(drm_dp_channel_eq_ok);
76
Jani Nikula0aec2882013-09-27 19:01:01 +030077bool drm_dp_clock_recovery_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
Daniel Vetter1ffdff12012-10-18 10:15:24 +020078 int lane_count)
79{
80 int lane;
81 u8 lane_status;
82
83 for (lane = 0; lane < lane_count; lane++) {
84 lane_status = dp_get_lane_status(link_status, lane);
85 if ((lane_status & DP_LANE_CR_DONE) == 0)
86 return false;
87 }
88 return true;
89}
90EXPORT_SYMBOL(drm_dp_clock_recovery_ok);
Daniel Vetter0f037bd2012-10-18 10:15:27 +020091
Jani Nikula0aec2882013-09-27 19:01:01 +030092u8 drm_dp_get_adjust_request_voltage(const u8 link_status[DP_LINK_STATUS_SIZE],
Daniel Vetter0f037bd2012-10-18 10:15:27 +020093 int lane)
94{
95 int i = DP_ADJUST_REQUEST_LANE0_1 + (lane >> 1);
96 int s = ((lane & 1) ?
97 DP_ADJUST_VOLTAGE_SWING_LANE1_SHIFT :
98 DP_ADJUST_VOLTAGE_SWING_LANE0_SHIFT);
99 u8 l = dp_link_status(link_status, i);
100
101 return ((l >> s) & 0x3) << DP_TRAIN_VOLTAGE_SWING_SHIFT;
102}
103EXPORT_SYMBOL(drm_dp_get_adjust_request_voltage);
104
Jani Nikula0aec2882013-09-27 19:01:01 +0300105u8 drm_dp_get_adjust_request_pre_emphasis(const u8 link_status[DP_LINK_STATUS_SIZE],
Daniel Vetter0f037bd2012-10-18 10:15:27 +0200106 int lane)
107{
108 int i = DP_ADJUST_REQUEST_LANE0_1 + (lane >> 1);
109 int s = ((lane & 1) ?
110 DP_ADJUST_PRE_EMPHASIS_LANE1_SHIFT :
111 DP_ADJUST_PRE_EMPHASIS_LANE0_SHIFT);
112 u8 l = dp_link_status(link_status, i);
113
114 return ((l >> s) & 0x3) << DP_TRAIN_PRE_EMPHASIS_SHIFT;
115}
116EXPORT_SYMBOL(drm_dp_get_adjust_request_pre_emphasis);
117
Jani Nikula0aec2882013-09-27 19:01:01 +0300118void drm_dp_link_train_clock_recovery_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]) {
Daniel Vetter1a644cd2012-10-18 15:32:40 +0200119 if (dpcd[DP_TRAINING_AUX_RD_INTERVAL] == 0)
120 udelay(100);
121 else
122 mdelay(dpcd[DP_TRAINING_AUX_RD_INTERVAL] * 4);
123}
124EXPORT_SYMBOL(drm_dp_link_train_clock_recovery_delay);
125
Jani Nikula0aec2882013-09-27 19:01:01 +0300126void drm_dp_link_train_channel_eq_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]) {
Daniel Vetter1a644cd2012-10-18 15:32:40 +0200127 if (dpcd[DP_TRAINING_AUX_RD_INTERVAL] == 0)
128 udelay(400);
129 else
130 mdelay(dpcd[DP_TRAINING_AUX_RD_INTERVAL] * 4);
131}
132EXPORT_SYMBOL(drm_dp_link_train_channel_eq_delay);
Daniel Vetter3b5c6622012-10-18 10:15:31 +0200133
134u8 drm_dp_link_rate_to_bw_code(int link_rate)
135{
136 switch (link_rate) {
137 case 162000:
138 default:
139 return DP_LINK_BW_1_62;
140 case 270000:
141 return DP_LINK_BW_2_7;
142 case 540000:
143 return DP_LINK_BW_5_4;
144 }
145}
146EXPORT_SYMBOL(drm_dp_link_rate_to_bw_code);
147
148int drm_dp_bw_code_to_link_rate(u8 link_bw)
149{
150 switch (link_bw) {
151 case DP_LINK_BW_1_62:
152 default:
153 return 162000;
154 case DP_LINK_BW_2_7:
155 return 270000;
156 case DP_LINK_BW_5_4:
157 return 540000;
158 }
159}
160EXPORT_SYMBOL(drm_dp_bw_code_to_link_rate);
Thierry Redingc197db72013-11-28 11:31:00 +0100161
Ville Syrjälä79a2b162015-08-26 22:55:05 +0300162#define AUX_RETRY_INTERVAL 500 /* us */
163
Thierry Redingc197db72013-11-28 11:31:00 +0100164/**
165 * DOC: dp helpers
166 *
167 * The DisplayPort AUX channel is an abstraction to allow generic, driver-
168 * independent access to AUX functionality. Drivers can take advantage of
169 * this by filling in the fields of the drm_dp_aux structure.
170 *
171 * Transactions are described using a hardware-independent drm_dp_aux_msg
172 * structure, which is passed into a driver's .transfer() implementation.
173 * Both native and I2C-over-AUX transactions are supported.
Thierry Redingc197db72013-11-28 11:31:00 +0100174 */
175
176static int drm_dp_dpcd_access(struct drm_dp_aux *aux, u8 request,
177 unsigned int offset, void *buffer, size_t size)
178{
179 struct drm_dp_aux_msg msg;
180 unsigned int retry;
181 int err;
182
183 memset(&msg, 0, sizeof(msg));
184 msg.address = offset;
185 msg.request = request;
186 msg.buffer = buffer;
187 msg.size = size;
188
189 /*
190 * The specification doesn't give any recommendation on how often to
Dave Airlie19a93f02014-11-26 13:13:09 +1000191 * retry native transactions. We used to retry 7 times like for
192 * aux i2c transactions but real world devices this wasn't
193 * sufficient, bump to 32 which makes Dell 4k monitors happier.
Thierry Redingc197db72013-11-28 11:31:00 +0100194 */
Dave Airlie19a93f02014-11-26 13:13:09 +1000195 for (retry = 0; retry < 32; retry++) {
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000196
197 mutex_lock(&aux->hw_mutex);
Thierry Redingc197db72013-11-28 11:31:00 +0100198 err = aux->transfer(aux, &msg);
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000199 mutex_unlock(&aux->hw_mutex);
Thierry Redingc197db72013-11-28 11:31:00 +0100200 if (err < 0) {
201 if (err == -EBUSY)
202 continue;
203
204 return err;
205 }
206
Thierry Redingc197db72013-11-28 11:31:00 +0100207
208 switch (msg.reply & DP_AUX_NATIVE_REPLY_MASK) {
209 case DP_AUX_NATIVE_REPLY_ACK:
Dave Airlieaa17edf2014-04-04 11:34:37 +1000210 if (err < size)
211 return -EPROTO;
Thierry Redingc197db72013-11-28 11:31:00 +0100212 return err;
213
214 case DP_AUX_NATIVE_REPLY_NACK:
215 return -EIO;
216
217 case DP_AUX_NATIVE_REPLY_DEFER:
Ville Syrjälä79a2b162015-08-26 22:55:05 +0300218 usleep_range(AUX_RETRY_INTERVAL, AUX_RETRY_INTERVAL + 100);
Thierry Redingc197db72013-11-28 11:31:00 +0100219 break;
220 }
221 }
222
Alex Deucher743b1e32014-03-21 10:34:06 -0400223 DRM_DEBUG_KMS("too many retries, giving up\n");
Thierry Redingc197db72013-11-28 11:31:00 +0100224 return -EIO;
225}
226
227/**
228 * drm_dp_dpcd_read() - read a series of bytes from the DPCD
229 * @aux: DisplayPort AUX channel
230 * @offset: address of the (first) register to read
231 * @buffer: buffer to store the register values
232 * @size: number of bytes in @buffer
233 *
234 * Returns the number of bytes transferred on success, or a negative error
235 * code on failure. -EIO is returned if the request was NAKed by the sink or
236 * if the retry count was exceeded. If not all bytes were transferred, this
237 * function returns -EPROTO. Errors from the underlying AUX channel transfer
238 * function, with the exception of -EBUSY (which causes the transaction to
239 * be retried), are propagated to the caller.
240 */
241ssize_t drm_dp_dpcd_read(struct drm_dp_aux *aux, unsigned int offset,
242 void *buffer, size_t size)
243{
244 return drm_dp_dpcd_access(aux, DP_AUX_NATIVE_READ, offset, buffer,
245 size);
246}
247EXPORT_SYMBOL(drm_dp_dpcd_read);
248
249/**
250 * drm_dp_dpcd_write() - write a series of bytes to the DPCD
251 * @aux: DisplayPort AUX channel
252 * @offset: address of the (first) register to write
253 * @buffer: buffer containing the values to write
254 * @size: number of bytes in @buffer
255 *
256 * Returns the number of bytes transferred on success, or a negative error
257 * code on failure. -EIO is returned if the request was NAKed by the sink or
258 * if the retry count was exceeded. If not all bytes were transferred, this
259 * function returns -EPROTO. Errors from the underlying AUX channel transfer
260 * function, with the exception of -EBUSY (which causes the transaction to
261 * be retried), are propagated to the caller.
262 */
263ssize_t drm_dp_dpcd_write(struct drm_dp_aux *aux, unsigned int offset,
264 void *buffer, size_t size)
265{
266 return drm_dp_dpcd_access(aux, DP_AUX_NATIVE_WRITE, offset, buffer,
267 size);
268}
269EXPORT_SYMBOL(drm_dp_dpcd_write);
Thierry Reding8d4adc62013-11-22 16:37:57 +0100270
271/**
272 * drm_dp_dpcd_read_link_status() - read DPCD link status (bytes 0x202-0x207)
273 * @aux: DisplayPort AUX channel
274 * @status: buffer to store the link status in (must be at least 6 bytes)
275 *
276 * Returns the number of bytes transferred on success or a negative error
277 * code on failure.
278 */
279int drm_dp_dpcd_read_link_status(struct drm_dp_aux *aux,
280 u8 status[DP_LINK_STATUS_SIZE])
281{
282 return drm_dp_dpcd_read(aux, DP_LANE0_1_STATUS, status,
283 DP_LINK_STATUS_SIZE);
284}
285EXPORT_SYMBOL(drm_dp_dpcd_read_link_status);
Thierry Reding516c0f72013-12-09 11:47:55 +0100286
287/**
288 * drm_dp_link_probe() - probe a DisplayPort link for capabilities
289 * @aux: DisplayPort AUX channel
290 * @link: pointer to structure in which to return link capabilities
291 *
292 * The structure filled in by this function can usually be passed directly
293 * into drm_dp_link_power_up() and drm_dp_link_configure() to power up and
294 * configure the link based on the link's capabilities.
295 *
296 * Returns 0 on success or a negative error code on failure.
297 */
298int drm_dp_link_probe(struct drm_dp_aux *aux, struct drm_dp_link *link)
299{
300 u8 values[3];
301 int err;
302
303 memset(link, 0, sizeof(*link));
304
305 err = drm_dp_dpcd_read(aux, DP_DPCD_REV, values, sizeof(values));
306 if (err < 0)
307 return err;
308
309 link->revision = values[0];
310 link->rate = drm_dp_bw_code_to_link_rate(values[1]);
311 link->num_lanes = values[2] & DP_MAX_LANE_COUNT_MASK;
312
313 if (values[2] & DP_ENHANCED_FRAME_CAP)
314 link->capabilities |= DP_LINK_CAP_ENHANCED_FRAMING;
315
316 return 0;
317}
318EXPORT_SYMBOL(drm_dp_link_probe);
319
320/**
321 * drm_dp_link_power_up() - power up a DisplayPort link
322 * @aux: DisplayPort AUX channel
323 * @link: pointer to a structure containing the link configuration
324 *
325 * Returns 0 on success or a negative error code on failure.
326 */
327int drm_dp_link_power_up(struct drm_dp_aux *aux, struct drm_dp_link *link)
328{
329 u8 value;
330 int err;
331
332 /* DP_SET_POWER register is only available on DPCD v1.1 and later */
333 if (link->revision < 0x11)
334 return 0;
335
336 err = drm_dp_dpcd_readb(aux, DP_SET_POWER, &value);
337 if (err < 0)
338 return err;
339
340 value &= ~DP_SET_POWER_MASK;
341 value |= DP_SET_POWER_D0;
342
343 err = drm_dp_dpcd_writeb(aux, DP_SET_POWER, value);
344 if (err < 0)
345 return err;
346
347 /*
348 * According to the DP 1.1 specification, a "Sink Device must exit the
349 * power saving state within 1 ms" (Section 2.5.3.1, Table 5-52, "Sink
350 * Control Field" (register 0x600).
351 */
352 usleep_range(1000, 2000);
353
354 return 0;
355}
356EXPORT_SYMBOL(drm_dp_link_power_up);
357
358/**
Rob Clarkd816f072014-12-02 10:43:07 -0500359 * drm_dp_link_power_down() - power down a DisplayPort link
360 * @aux: DisplayPort AUX channel
361 * @link: pointer to a structure containing the link configuration
362 *
363 * Returns 0 on success or a negative error code on failure.
364 */
365int drm_dp_link_power_down(struct drm_dp_aux *aux, struct drm_dp_link *link)
366{
367 u8 value;
368 int err;
369
370 /* DP_SET_POWER register is only available on DPCD v1.1 and later */
371 if (link->revision < 0x11)
372 return 0;
373
374 err = drm_dp_dpcd_readb(aux, DP_SET_POWER, &value);
375 if (err < 0)
376 return err;
377
378 value &= ~DP_SET_POWER_MASK;
379 value |= DP_SET_POWER_D3;
380
381 err = drm_dp_dpcd_writeb(aux, DP_SET_POWER, value);
382 if (err < 0)
383 return err;
384
385 return 0;
386}
387EXPORT_SYMBOL(drm_dp_link_power_down);
388
389/**
Thierry Reding516c0f72013-12-09 11:47:55 +0100390 * drm_dp_link_configure() - configure a DisplayPort link
391 * @aux: DisplayPort AUX channel
392 * @link: pointer to a structure containing the link configuration
393 *
394 * Returns 0 on success or a negative error code on failure.
395 */
396int drm_dp_link_configure(struct drm_dp_aux *aux, struct drm_dp_link *link)
397{
398 u8 values[2];
399 int err;
400
401 values[0] = drm_dp_link_rate_to_bw_code(link->rate);
402 values[1] = link->num_lanes;
403
404 if (link->capabilities & DP_LINK_CAP_ENHANCED_FRAMING)
405 values[1] |= DP_LANE_COUNT_ENHANCED_FRAME_EN;
406
407 err = drm_dp_dpcd_write(aux, DP_LINK_BW_SET, values, sizeof(values));
408 if (err < 0)
409 return err;
410
411 return 0;
412}
413EXPORT_SYMBOL(drm_dp_link_configure);
Thierry Reding88759682013-12-12 09:57:53 +0100414
415/*
416 * I2C-over-AUX implementation
417 */
418
419static u32 drm_dp_i2c_functionality(struct i2c_adapter *adapter)
420{
421 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
422 I2C_FUNC_SMBUS_READ_BLOCK_DATA |
423 I2C_FUNC_SMBUS_BLOCK_PROC_CALL |
424 I2C_FUNC_10BIT_ADDR;
425}
426
Ville Syrjälä4efa83c2015-09-01 20:12:54 +0300427#define AUX_PRECHARGE_LEN 10 /* 10 to 16 */
428#define AUX_SYNC_LEN (16 + 4) /* preamble + AUX_SYNC_END */
429#define AUX_STOP_LEN 4
430#define AUX_CMD_LEN 4
431#define AUX_ADDRESS_LEN 20
432#define AUX_REPLY_PAD_LEN 4
433#define AUX_LENGTH_LEN 8
434
435/*
436 * Calculate the duration of the AUX request/reply in usec. Gives the
437 * "best" case estimate, ie. successful while as short as possible.
438 */
439static int drm_dp_aux_req_duration(const struct drm_dp_aux_msg *msg)
440{
441 int len = AUX_PRECHARGE_LEN + AUX_SYNC_LEN + AUX_STOP_LEN +
442 AUX_CMD_LEN + AUX_ADDRESS_LEN + AUX_LENGTH_LEN;
443
444 if ((msg->request & DP_AUX_I2C_READ) == 0)
445 len += msg->size * 8;
446
447 return len;
448}
449
450static int drm_dp_aux_reply_duration(const struct drm_dp_aux_msg *msg)
451{
452 int len = AUX_PRECHARGE_LEN + AUX_SYNC_LEN + AUX_STOP_LEN +
453 AUX_CMD_LEN + AUX_REPLY_PAD_LEN;
454
455 /*
456 * For read we expect what was asked. For writes there will
457 * be 0 or 1 data bytes. Assume 0 for the "best" case.
458 */
459 if (msg->request & DP_AUX_I2C_READ)
460 len += msg->size * 8;
461
462 return len;
463}
464
465#define I2C_START_LEN 1
466#define I2C_STOP_LEN 1
467#define I2C_ADDR_LEN 9 /* ADDRESS + R/W + ACK/NACK */
468#define I2C_DATA_LEN 9 /* DATA + ACK/NACK */
469
470/*
471 * Calculate the length of the i2c transfer in usec, assuming
472 * the i2c bus speed is as specified. Gives the the "worst"
473 * case estimate, ie. successful while as long as possible.
474 * Doesn't account the the "MOT" bit, and instead assumes each
475 * message includes a START, ADDRESS and STOP. Neither does it
476 * account for additional random variables such as clock stretching.
477 */
478static int drm_dp_i2c_msg_duration(const struct drm_dp_aux_msg *msg,
479 int i2c_speed_khz)
480{
481 /* AUX bitrate is 1MHz, i2c bitrate as specified */
482 return DIV_ROUND_UP((I2C_START_LEN + I2C_ADDR_LEN +
483 msg->size * I2C_DATA_LEN +
484 I2C_STOP_LEN) * 1000, i2c_speed_khz);
485}
486
487/*
488 * Deterine how many retries should be attempted to successfully transfer
489 * the specified message, based on the estimated durations of the
490 * i2c and AUX transfers.
491 */
492static int drm_dp_i2c_retry_count(const struct drm_dp_aux_msg *msg,
493 int i2c_speed_khz)
494{
495 int aux_time_us = drm_dp_aux_req_duration(msg) +
496 drm_dp_aux_reply_duration(msg);
497 int i2c_time_us = drm_dp_i2c_msg_duration(msg, i2c_speed_khz);
498
499 return DIV_ROUND_UP(i2c_time_us, aux_time_us + AUX_RETRY_INTERVAL);
500}
501
Thierry Reding88759682013-12-12 09:57:53 +0100502/*
503 * Transfer a single I2C-over-AUX message and handle various error conditions,
Alex Deucher732d50b2014-04-07 10:33:45 -0400504 * retrying the transaction as appropriate. It is assumed that the
505 * aux->transfer function does not modify anything in the msg other than the
506 * reply field.
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000507 *
508 * Returns bytes transferred on success, or a negative error code on failure.
Thierry Reding88759682013-12-12 09:57:53 +0100509 */
510static int drm_dp_i2c_do_msg(struct drm_dp_aux *aux, struct drm_dp_aux_msg *msg)
511{
Todd Previte396aa442015-04-18 00:04:18 -0700512 unsigned int retry, defer_i2c;
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000513 int ret;
Thierry Reding88759682013-12-12 09:57:53 +0100514 /*
515 * DP1.2 sections 2.7.7.1.5.6.1 and 2.7.7.1.6.6.1: A DP Source device
516 * is required to retry at least seven times upon receiving AUX_DEFER
517 * before giving up the AUX transaction.
Ville Syrjälä4efa83c2015-09-01 20:12:54 +0300518 *
519 * We also try to account for the i2c bus speed.
520 * FIXME currently assumes 10 kHz as some real world devices seem
521 * to require it. We should query/set the speed via DPCD if supported.
Thierry Reding88759682013-12-12 09:57:53 +0100522 */
Ville Syrjälä4efa83c2015-09-01 20:12:54 +0300523 int max_retries = max(7, drm_dp_i2c_retry_count(msg, 10));
524
525 for (retry = 0, defer_i2c = 0; retry < (max_retries + defer_i2c); retry++) {
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000526 mutex_lock(&aux->hw_mutex);
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000527 ret = aux->transfer(aux, msg);
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000528 mutex_unlock(&aux->hw_mutex);
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000529 if (ret < 0) {
530 if (ret == -EBUSY)
Thierry Reding88759682013-12-12 09:57:53 +0100531 continue;
532
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000533 DRM_DEBUG_KMS("transaction failed: %d\n", ret);
534 return ret;
Thierry Reding88759682013-12-12 09:57:53 +0100535 }
536
Thierry Reding88759682013-12-12 09:57:53 +0100537
538 switch (msg->reply & DP_AUX_NATIVE_REPLY_MASK) {
539 case DP_AUX_NATIVE_REPLY_ACK:
540 /*
541 * For I2C-over-AUX transactions this isn't enough, we
542 * need to check for the I2C ACK reply.
543 */
544 break;
545
546 case DP_AUX_NATIVE_REPLY_NACK:
Ville Syrjäläfb8c5e42015-03-19 13:38:57 +0200547 DRM_DEBUG_KMS("native nack (result=%d, size=%zu)\n", ret, msg->size);
Thierry Reding88759682013-12-12 09:57:53 +0100548 return -EREMOTEIO;
549
550 case DP_AUX_NATIVE_REPLY_DEFER:
Todd Previte747552b92015-04-15 08:38:47 -0700551 DRM_DEBUG_KMS("native defer\n");
Thierry Reding88759682013-12-12 09:57:53 +0100552 /*
553 * We could check for I2C bit rate capabilities and if
554 * available adjust this interval. We could also be
555 * more careful with DP-to-legacy adapters where a
556 * long legacy cable may force very low I2C bit rates.
557 *
558 * For now just defer for long enough to hopefully be
559 * safe for all use-cases.
560 */
Ville Syrjälä79a2b162015-08-26 22:55:05 +0300561 usleep_range(AUX_RETRY_INTERVAL, AUX_RETRY_INTERVAL + 100);
Thierry Reding88759682013-12-12 09:57:53 +0100562 continue;
563
564 default:
565 DRM_ERROR("invalid native reply %#04x\n", msg->reply);
566 return -EREMOTEIO;
567 }
568
569 switch (msg->reply & DP_AUX_I2C_REPLY_MASK) {
570 case DP_AUX_I2C_REPLY_ACK:
571 /*
572 * Both native ACK and I2C ACK replies received. We
573 * can assume the transfer was successful.
574 */
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000575 return ret;
Thierry Reding88759682013-12-12 09:57:53 +0100576
577 case DP_AUX_I2C_REPLY_NACK:
Ville Syrjäläfb8c5e42015-03-19 13:38:57 +0200578 DRM_DEBUG_KMS("I2C nack (result=%d, size=%zu\n", ret, msg->size);
Todd Previtee9cf6192014-11-04 15:17:35 -0700579 aux->i2c_nack_count++;
Thierry Reding88759682013-12-12 09:57:53 +0100580 return -EREMOTEIO;
581
582 case DP_AUX_I2C_REPLY_DEFER:
583 DRM_DEBUG_KMS("I2C defer\n");
Todd Previte396aa442015-04-18 00:04:18 -0700584 /* DP Compliance Test 4.2.2.5 Requirement:
585 * Must have at least 7 retries for I2C defers on the
586 * transaction to pass this test
587 */
Todd Previtee9cf6192014-11-04 15:17:35 -0700588 aux->i2c_defer_count++;
Todd Previte396aa442015-04-18 00:04:18 -0700589 if (defer_i2c < 7)
590 defer_i2c++;
Ville Syrjälä79a2b162015-08-26 22:55:05 +0300591 usleep_range(AUX_RETRY_INTERVAL, AUX_RETRY_INTERVAL + 100);
Thierry Reding88759682013-12-12 09:57:53 +0100592 continue;
593
594 default:
595 DRM_ERROR("invalid I2C reply %#04x\n", msg->reply);
596 return -EREMOTEIO;
597 }
598 }
599
Alex Deucher743b1e32014-03-21 10:34:06 -0400600 DRM_DEBUG_KMS("too many retries, giving up\n");
Thierry Reding88759682013-12-12 09:57:53 +0100601 return -EREMOTEIO;
602}
603
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000604/*
605 * Keep retrying drm_dp_i2c_do_msg until all data has been transferred.
606 *
607 * Returns an error code on failure, or a recommended transfer size on success.
608 */
609static int drm_dp_i2c_drain_msg(struct drm_dp_aux *aux, struct drm_dp_aux_msg *orig_msg)
610{
611 int err, ret = orig_msg->size;
612 struct drm_dp_aux_msg msg = *orig_msg;
613
614 while (msg.size > 0) {
615 err = drm_dp_i2c_do_msg(aux, &msg);
616 if (err <= 0)
617 return err == 0 ? -EPROTO : err;
618
619 if (err < msg.size && err < ret) {
620 DRM_DEBUG_KMS("Partial I2C reply: requested %zu bytes got %d bytes\n",
621 msg.size, err);
622 ret = err;
623 }
624
625 msg.size -= err;
626 msg.buffer += err;
627 }
628
629 return ret;
630}
631
632/*
633 * Bizlink designed DP->DVI-D Dual Link adapters require the I2C over AUX
634 * packets to be as large as possible. If not, the I2C transactions never
635 * succeed. Hence the default is maximum.
636 */
637static int dp_aux_i2c_transfer_size __read_mostly = DP_AUX_MAX_PAYLOAD_BYTES;
638module_param_unsafe(dp_aux_i2c_transfer_size, int, 0644);
639MODULE_PARM_DESC(dp_aux_i2c_transfer_size,
640 "Number of bytes to transfer in a single I2C over DP AUX CH message, (1-16, default 16)");
641
Thierry Reding88759682013-12-12 09:57:53 +0100642static int drm_dp_i2c_xfer(struct i2c_adapter *adapter, struct i2c_msg *msgs,
643 int num)
644{
645 struct drm_dp_aux *aux = adapter->algo_data;
646 unsigned int i, j;
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000647 unsigned transfer_size;
Alex Deucherccdb5162014-04-07 10:33:44 -0400648 struct drm_dp_aux_msg msg;
649 int err = 0;
650
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000651 dp_aux_i2c_transfer_size = clamp(dp_aux_i2c_transfer_size, 1, DP_AUX_MAX_PAYLOAD_BYTES);
652
Alex Deucherccdb5162014-04-07 10:33:44 -0400653 memset(&msg, 0, sizeof(msg));
Thierry Reding88759682013-12-12 09:57:53 +0100654
655 for (i = 0; i < num; i++) {
Alex Deucherccdb5162014-04-07 10:33:44 -0400656 msg.address = msgs[i].addr;
657 msg.request = (msgs[i].flags & I2C_M_RD) ?
658 DP_AUX_I2C_READ :
659 DP_AUX_I2C_WRITE;
660 msg.request |= DP_AUX_I2C_MOT;
661 /* Send a bare address packet to start the transaction.
662 * Zero sized messages specify an address only (bare
663 * address) transaction.
664 */
665 msg.buffer = NULL;
666 msg.size = 0;
667 err = drm_dp_i2c_do_msg(aux, &msg);
668 if (err < 0)
669 break;
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000670 /* We want each transaction to be as large as possible, but
671 * we'll go to smaller sizes if the hardware gives us a
672 * short reply.
Thierry Reding88759682013-12-12 09:57:53 +0100673 */
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000674 transfer_size = dp_aux_i2c_transfer_size;
675 for (j = 0; j < msgs[i].len; j += msg.size) {
Thierry Reding88759682013-12-12 09:57:53 +0100676 msg.buffer = msgs[i].buf + j;
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000677 msg.size = min(transfer_size, msgs[i].len - j);
Thierry Reding88759682013-12-12 09:57:53 +0100678
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000679 err = drm_dp_i2c_drain_msg(aux, &msg);
Thierry Reding88759682013-12-12 09:57:53 +0100680 if (err < 0)
Alex Deucherccdb5162014-04-07 10:33:44 -0400681 break;
Simon Farnsworth1d002fa2015-02-10 18:38:08 +0000682 transfer_size = err;
Thierry Reding88759682013-12-12 09:57:53 +0100683 }
Alex Deucherccdb5162014-04-07 10:33:44 -0400684 if (err < 0)
685 break;
Thierry Reding88759682013-12-12 09:57:53 +0100686 }
Alex Deucherccdb5162014-04-07 10:33:44 -0400687 if (err >= 0)
688 err = num;
689 /* Send a bare address packet to close out the transaction.
690 * Zero sized messages specify an address only (bare
691 * address) transaction.
692 */
693 msg.request &= ~DP_AUX_I2C_MOT;
694 msg.buffer = NULL;
695 msg.size = 0;
696 (void)drm_dp_i2c_do_msg(aux, &msg);
Thierry Reding88759682013-12-12 09:57:53 +0100697
Alex Deucherccdb5162014-04-07 10:33:44 -0400698 return err;
Thierry Reding88759682013-12-12 09:57:53 +0100699}
700
701static const struct i2c_algorithm drm_dp_i2c_algo = {
702 .functionality = drm_dp_i2c_functionality,
703 .master_xfer = drm_dp_i2c_xfer,
704};
705
706/**
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000707 * drm_dp_aux_register() - initialise and register aux channel
Thierry Reding88759682013-12-12 09:57:53 +0100708 * @aux: DisplayPort AUX channel
709 *
710 * Returns 0 on success or a negative error code on failure.
711 */
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000712int drm_dp_aux_register(struct drm_dp_aux *aux)
Thierry Reding88759682013-12-12 09:57:53 +0100713{
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000714 mutex_init(&aux->hw_mutex);
715
Thierry Reding88759682013-12-12 09:57:53 +0100716 aux->ddc.algo = &drm_dp_i2c_algo;
717 aux->ddc.algo_data = aux;
718 aux->ddc.retries = 3;
719
720 aux->ddc.class = I2C_CLASS_DDC;
721 aux->ddc.owner = THIS_MODULE;
722 aux->ddc.dev.parent = aux->dev;
723 aux->ddc.dev.of_node = aux->dev->of_node;
724
Jani Nikula9dc40562014-03-14 16:51:12 +0200725 strlcpy(aux->ddc.name, aux->name ? aux->name : dev_name(aux->dev),
726 sizeof(aux->ddc.name));
Thierry Reding88759682013-12-12 09:57:53 +0100727
728 return i2c_add_adapter(&aux->ddc);
729}
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000730EXPORT_SYMBOL(drm_dp_aux_register);
Thierry Reding88759682013-12-12 09:57:53 +0100731
732/**
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000733 * drm_dp_aux_unregister() - unregister an AUX adapter
Thierry Reding88759682013-12-12 09:57:53 +0100734 * @aux: DisplayPort AUX channel
735 */
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000736void drm_dp_aux_unregister(struct drm_dp_aux *aux)
Thierry Reding88759682013-12-12 09:57:53 +0100737{
738 i2c_del_adapter(&aux->ddc);
739}
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000740EXPORT_SYMBOL(drm_dp_aux_unregister);