Keith Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 1 | /* |
| 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 Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 26 | #include <linux/init.h> |
| 27 | #include <linux/errno.h> |
| 28 | #include <linux/sched.h> |
| 29 | #include <linux/i2c.h> |
David Howells | 760285e | 2012-10-02 18:01:07 +0100 | [diff] [blame] | 30 | #include <drm/drm_dp_helper.h> |
| 31 | #include <drm/drmP.h> |
Keith Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 32 | |
Daniel Vetter | 28164fd | 2012-11-01 14:45:18 +0100 | [diff] [blame] | 33 | /** |
| 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 | |
Keith Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 42 | /* Run a single AUX_CH I2C transaction, writing/reading data as necessary */ |
Keith Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 43 | static int |
| 44 | i2c_algo_dp_aux_transaction(struct i2c_adapter *adapter, int mode, |
| 45 | uint8_t write_byte, uint8_t *read_byte) |
| 46 | { |
| 47 | struct i2c_algo_dp_aux_data *algo_data = adapter->algo_data; |
Keith Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 48 | int ret; |
Daniel Vetter | 00ae9a4 | 2012-10-18 10:15:23 +0200 | [diff] [blame] | 49 | |
Dave Airlie | ab2c067 | 2009-12-04 10:55:24 +1000 | [diff] [blame] | 50 | ret = (*algo_data->aux_ch)(adapter, mode, |
| 51 | write_byte, read_byte); |
| 52 | return ret; |
Keith Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 53 | } |
| 54 | |
| 55 | /* |
| 56 | * I2C over AUX CH |
| 57 | */ |
| 58 | |
| 59 | /* |
| 60 | * Send the address. If the I2C link is running, this 'restarts' |
| 61 | * the connection with the new address, this is used for doing |
| 62 | * a write followed by a read (as needed for DDC) |
| 63 | */ |
| 64 | static int |
| 65 | i2c_algo_dp_aux_address(struct i2c_adapter *adapter, u16 address, bool reading) |
| 66 | { |
| 67 | struct i2c_algo_dp_aux_data *algo_data = adapter->algo_data; |
| 68 | int mode = MODE_I2C_START; |
| 69 | int ret; |
| 70 | |
| 71 | if (reading) |
| 72 | mode |= MODE_I2C_READ; |
| 73 | else |
| 74 | mode |= MODE_I2C_WRITE; |
| 75 | algo_data->address = address; |
| 76 | algo_data->running = true; |
| 77 | ret = i2c_algo_dp_aux_transaction(adapter, mode, 0, NULL); |
| 78 | return ret; |
| 79 | } |
| 80 | |
| 81 | /* |
| 82 | * Stop the I2C transaction. This closes out the link, sending |
| 83 | * a bare address packet with the MOT bit turned off |
| 84 | */ |
| 85 | static void |
| 86 | i2c_algo_dp_aux_stop(struct i2c_adapter *adapter, bool reading) |
| 87 | { |
| 88 | struct i2c_algo_dp_aux_data *algo_data = adapter->algo_data; |
| 89 | int mode = MODE_I2C_STOP; |
| 90 | |
| 91 | if (reading) |
| 92 | mode |= MODE_I2C_READ; |
| 93 | else |
| 94 | mode |= MODE_I2C_WRITE; |
| 95 | if (algo_data->running) { |
| 96 | (void) i2c_algo_dp_aux_transaction(adapter, mode, 0, NULL); |
| 97 | algo_data->running = false; |
| 98 | } |
| 99 | } |
| 100 | |
| 101 | /* |
| 102 | * Write a single byte to the current I2C address, the |
| 103 | * the I2C link must be running or this returns -EIO |
| 104 | */ |
| 105 | static int |
| 106 | i2c_algo_dp_aux_put_byte(struct i2c_adapter *adapter, u8 byte) |
| 107 | { |
| 108 | struct i2c_algo_dp_aux_data *algo_data = adapter->algo_data; |
| 109 | int ret; |
| 110 | |
| 111 | if (!algo_data->running) |
| 112 | return -EIO; |
| 113 | |
| 114 | ret = i2c_algo_dp_aux_transaction(adapter, MODE_I2C_WRITE, byte, NULL); |
| 115 | return ret; |
| 116 | } |
| 117 | |
| 118 | /* |
| 119 | * Read a single byte from the current I2C address, the |
| 120 | * I2C link must be running or this returns -EIO |
| 121 | */ |
| 122 | static int |
| 123 | i2c_algo_dp_aux_get_byte(struct i2c_adapter *adapter, u8 *byte_ret) |
| 124 | { |
| 125 | struct i2c_algo_dp_aux_data *algo_data = adapter->algo_data; |
| 126 | int ret; |
| 127 | |
| 128 | if (!algo_data->running) |
| 129 | return -EIO; |
| 130 | |
| 131 | ret = i2c_algo_dp_aux_transaction(adapter, MODE_I2C_READ, 0, byte_ret); |
| 132 | return ret; |
| 133 | } |
| 134 | |
| 135 | static int |
| 136 | i2c_algo_dp_aux_xfer(struct i2c_adapter *adapter, |
| 137 | struct i2c_msg *msgs, |
| 138 | int num) |
| 139 | { |
| 140 | int ret = 0; |
| 141 | bool reading = false; |
| 142 | int m; |
| 143 | int b; |
| 144 | |
| 145 | for (m = 0; m < num; m++) { |
| 146 | u16 len = msgs[m].len; |
| 147 | u8 *buf = msgs[m].buf; |
| 148 | reading = (msgs[m].flags & I2C_M_RD) != 0; |
| 149 | ret = i2c_algo_dp_aux_address(adapter, msgs[m].addr, reading); |
| 150 | if (ret < 0) |
| 151 | break; |
| 152 | if (reading) { |
| 153 | for (b = 0; b < len; b++) { |
| 154 | ret = i2c_algo_dp_aux_get_byte(adapter, &buf[b]); |
| 155 | if (ret < 0) |
| 156 | break; |
| 157 | } |
| 158 | } else { |
| 159 | for (b = 0; b < len; b++) { |
| 160 | ret = i2c_algo_dp_aux_put_byte(adapter, buf[b]); |
| 161 | if (ret < 0) |
| 162 | break; |
| 163 | } |
| 164 | } |
| 165 | if (ret < 0) |
| 166 | break; |
| 167 | } |
| 168 | if (ret >= 0) |
| 169 | ret = num; |
| 170 | i2c_algo_dp_aux_stop(adapter, reading); |
Zhao Yakui | 28c9773 | 2009-10-09 11:39:41 +0800 | [diff] [blame] | 171 | DRM_DEBUG_KMS("dp_aux_xfer return %d\n", ret); |
Keith Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 172 | return ret; |
| 173 | } |
| 174 | |
| 175 | static u32 |
| 176 | i2c_algo_dp_aux_functionality(struct i2c_adapter *adapter) |
| 177 | { |
| 178 | return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | |
| 179 | I2C_FUNC_SMBUS_READ_BLOCK_DATA | |
| 180 | I2C_FUNC_SMBUS_BLOCK_PROC_CALL | |
| 181 | I2C_FUNC_10BIT_ADDR; |
| 182 | } |
| 183 | |
| 184 | static const struct i2c_algorithm i2c_dp_aux_algo = { |
| 185 | .master_xfer = i2c_algo_dp_aux_xfer, |
| 186 | .functionality = i2c_algo_dp_aux_functionality, |
| 187 | }; |
| 188 | |
| 189 | static void |
| 190 | i2c_dp_aux_reset_bus(struct i2c_adapter *adapter) |
| 191 | { |
| 192 | (void) i2c_algo_dp_aux_address(adapter, 0, false); |
| 193 | (void) i2c_algo_dp_aux_stop(adapter, false); |
Keith Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 194 | } |
| 195 | |
| 196 | static int |
| 197 | i2c_dp_aux_prepare_bus(struct i2c_adapter *adapter) |
| 198 | { |
| 199 | adapter->algo = &i2c_dp_aux_algo; |
| 200 | adapter->retries = 3; |
| 201 | i2c_dp_aux_reset_bus(adapter); |
| 202 | return 0; |
| 203 | } |
| 204 | |
Daniel Vetter | 28164fd | 2012-11-01 14:45:18 +0100 | [diff] [blame] | 205 | /** |
| 206 | * i2c_dp_aux_add_bus() - register an i2c adapter using the aux ch helper |
| 207 | * @adapter: i2c adapter to register |
| 208 | * |
Thierry Reding | 171f975 | 2014-04-29 11:44:37 +0200 | [diff] [blame] | 209 | * This registers an i2c adapter that uses dp aux channel as it's underlaying |
Daniel Vetter | 28164fd | 2012-11-01 14:45:18 +0100 | [diff] [blame] | 210 | * transport. The driver needs to fill out the &i2c_algo_dp_aux_data structure |
| 211 | * and store it in the algo_data member of the @adapter argument. This will be |
| 212 | * used by the i2c over dp aux algorithm to drive the hardware. |
| 213 | * |
| 214 | * RETURNS: |
| 215 | * 0 on success, -ERRNO on failure. |
Daniel Vetter | 2a8dc63 | 2014-05-07 10:23:55 +0200 | [diff] [blame^] | 216 | * |
| 217 | * IMPORTANT: |
| 218 | * This interface is deprecated, please switch to the new dp aux helpers and |
| 219 | * drm_dp_aux_register_i2c_bus(). |
Daniel Vetter | 28164fd | 2012-11-01 14:45:18 +0100 | [diff] [blame] | 220 | */ |
Keith Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 221 | int |
| 222 | i2c_dp_aux_add_bus(struct i2c_adapter *adapter) |
| 223 | { |
| 224 | int error; |
Daniel Vetter | 00ae9a4 | 2012-10-18 10:15:23 +0200 | [diff] [blame] | 225 | |
Keith Packard | a4fc5ed | 2009-04-07 16:16:42 -0700 | [diff] [blame] | 226 | error = i2c_dp_aux_prepare_bus(adapter); |
| 227 | if (error) |
| 228 | return error; |
| 229 | error = i2c_add_adapter(adapter); |
| 230 | return error; |
| 231 | } |
| 232 | EXPORT_SYMBOL(i2c_dp_aux_add_bus); |
Daniel Vetter | 1ffdff1 | 2012-10-18 10:15:24 +0200 | [diff] [blame] | 233 | |
| 234 | /* Helpers for DP link training */ |
Jani Nikula | 0aec288 | 2013-09-27 19:01:01 +0300 | [diff] [blame] | 235 | static u8 dp_link_status(const u8 link_status[DP_LINK_STATUS_SIZE], int r) |
Daniel Vetter | 1ffdff1 | 2012-10-18 10:15:24 +0200 | [diff] [blame] | 236 | { |
| 237 | return link_status[r - DP_LANE0_1_STATUS]; |
| 238 | } |
| 239 | |
Jani Nikula | 0aec288 | 2013-09-27 19:01:01 +0300 | [diff] [blame] | 240 | static u8 dp_get_lane_status(const u8 link_status[DP_LINK_STATUS_SIZE], |
Daniel Vetter | 1ffdff1 | 2012-10-18 10:15:24 +0200 | [diff] [blame] | 241 | int lane) |
| 242 | { |
| 243 | int i = DP_LANE0_1_STATUS + (lane >> 1); |
| 244 | int s = (lane & 1) * 4; |
| 245 | u8 l = dp_link_status(link_status, i); |
| 246 | return (l >> s) & 0xf; |
| 247 | } |
| 248 | |
Jani Nikula | 0aec288 | 2013-09-27 19:01:01 +0300 | [diff] [blame] | 249 | bool drm_dp_channel_eq_ok(const u8 link_status[DP_LINK_STATUS_SIZE], |
Daniel Vetter | 1ffdff1 | 2012-10-18 10:15:24 +0200 | [diff] [blame] | 250 | int lane_count) |
| 251 | { |
| 252 | u8 lane_align; |
| 253 | u8 lane_status; |
| 254 | int lane; |
| 255 | |
| 256 | lane_align = dp_link_status(link_status, |
| 257 | DP_LANE_ALIGN_STATUS_UPDATED); |
| 258 | if ((lane_align & DP_INTERLANE_ALIGN_DONE) == 0) |
| 259 | return false; |
| 260 | for (lane = 0; lane < lane_count; lane++) { |
| 261 | lane_status = dp_get_lane_status(link_status, lane); |
| 262 | if ((lane_status & DP_CHANNEL_EQ_BITS) != DP_CHANNEL_EQ_BITS) |
| 263 | return false; |
| 264 | } |
| 265 | return true; |
| 266 | } |
| 267 | EXPORT_SYMBOL(drm_dp_channel_eq_ok); |
| 268 | |
Jani Nikula | 0aec288 | 2013-09-27 19:01:01 +0300 | [diff] [blame] | 269 | bool drm_dp_clock_recovery_ok(const u8 link_status[DP_LINK_STATUS_SIZE], |
Daniel Vetter | 1ffdff1 | 2012-10-18 10:15:24 +0200 | [diff] [blame] | 270 | int lane_count) |
| 271 | { |
| 272 | int lane; |
| 273 | u8 lane_status; |
| 274 | |
| 275 | for (lane = 0; lane < lane_count; lane++) { |
| 276 | lane_status = dp_get_lane_status(link_status, lane); |
| 277 | if ((lane_status & DP_LANE_CR_DONE) == 0) |
| 278 | return false; |
| 279 | } |
| 280 | return true; |
| 281 | } |
| 282 | EXPORT_SYMBOL(drm_dp_clock_recovery_ok); |
Daniel Vetter | 0f037bd | 2012-10-18 10:15:27 +0200 | [diff] [blame] | 283 | |
Jani Nikula | 0aec288 | 2013-09-27 19:01:01 +0300 | [diff] [blame] | 284 | u8 drm_dp_get_adjust_request_voltage(const u8 link_status[DP_LINK_STATUS_SIZE], |
Daniel Vetter | 0f037bd | 2012-10-18 10:15:27 +0200 | [diff] [blame] | 285 | int lane) |
| 286 | { |
| 287 | int i = DP_ADJUST_REQUEST_LANE0_1 + (lane >> 1); |
| 288 | int s = ((lane & 1) ? |
| 289 | DP_ADJUST_VOLTAGE_SWING_LANE1_SHIFT : |
| 290 | DP_ADJUST_VOLTAGE_SWING_LANE0_SHIFT); |
| 291 | u8 l = dp_link_status(link_status, i); |
| 292 | |
| 293 | return ((l >> s) & 0x3) << DP_TRAIN_VOLTAGE_SWING_SHIFT; |
| 294 | } |
| 295 | EXPORT_SYMBOL(drm_dp_get_adjust_request_voltage); |
| 296 | |
Jani Nikula | 0aec288 | 2013-09-27 19:01:01 +0300 | [diff] [blame] | 297 | u8 drm_dp_get_adjust_request_pre_emphasis(const u8 link_status[DP_LINK_STATUS_SIZE], |
Daniel Vetter | 0f037bd | 2012-10-18 10:15:27 +0200 | [diff] [blame] | 298 | int lane) |
| 299 | { |
| 300 | int i = DP_ADJUST_REQUEST_LANE0_1 + (lane >> 1); |
| 301 | int s = ((lane & 1) ? |
| 302 | DP_ADJUST_PRE_EMPHASIS_LANE1_SHIFT : |
| 303 | DP_ADJUST_PRE_EMPHASIS_LANE0_SHIFT); |
| 304 | u8 l = dp_link_status(link_status, i); |
| 305 | |
| 306 | return ((l >> s) & 0x3) << DP_TRAIN_PRE_EMPHASIS_SHIFT; |
| 307 | } |
| 308 | EXPORT_SYMBOL(drm_dp_get_adjust_request_pre_emphasis); |
| 309 | |
Jani Nikula | 0aec288 | 2013-09-27 19:01:01 +0300 | [diff] [blame] | 310 | void drm_dp_link_train_clock_recovery_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]) { |
Daniel Vetter | 1a644cd | 2012-10-18 15:32:40 +0200 | [diff] [blame] | 311 | if (dpcd[DP_TRAINING_AUX_RD_INTERVAL] == 0) |
| 312 | udelay(100); |
| 313 | else |
| 314 | mdelay(dpcd[DP_TRAINING_AUX_RD_INTERVAL] * 4); |
| 315 | } |
| 316 | EXPORT_SYMBOL(drm_dp_link_train_clock_recovery_delay); |
| 317 | |
Jani Nikula | 0aec288 | 2013-09-27 19:01:01 +0300 | [diff] [blame] | 318 | void drm_dp_link_train_channel_eq_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]) { |
Daniel Vetter | 1a644cd | 2012-10-18 15:32:40 +0200 | [diff] [blame] | 319 | if (dpcd[DP_TRAINING_AUX_RD_INTERVAL] == 0) |
| 320 | udelay(400); |
| 321 | else |
| 322 | mdelay(dpcd[DP_TRAINING_AUX_RD_INTERVAL] * 4); |
| 323 | } |
| 324 | EXPORT_SYMBOL(drm_dp_link_train_channel_eq_delay); |
Daniel Vetter | 3b5c662 | 2012-10-18 10:15:31 +0200 | [diff] [blame] | 325 | |
| 326 | u8 drm_dp_link_rate_to_bw_code(int link_rate) |
| 327 | { |
| 328 | switch (link_rate) { |
| 329 | case 162000: |
| 330 | default: |
| 331 | return DP_LINK_BW_1_62; |
| 332 | case 270000: |
| 333 | return DP_LINK_BW_2_7; |
| 334 | case 540000: |
| 335 | return DP_LINK_BW_5_4; |
| 336 | } |
| 337 | } |
| 338 | EXPORT_SYMBOL(drm_dp_link_rate_to_bw_code); |
| 339 | |
| 340 | int drm_dp_bw_code_to_link_rate(u8 link_bw) |
| 341 | { |
| 342 | switch (link_bw) { |
| 343 | case DP_LINK_BW_1_62: |
| 344 | default: |
| 345 | return 162000; |
| 346 | case DP_LINK_BW_2_7: |
| 347 | return 270000; |
| 348 | case DP_LINK_BW_5_4: |
| 349 | return 540000; |
| 350 | } |
| 351 | } |
| 352 | EXPORT_SYMBOL(drm_dp_bw_code_to_link_rate); |
Thierry Reding | c197db7 | 2013-11-28 11:31:00 +0100 | [diff] [blame] | 353 | |
| 354 | /** |
| 355 | * DOC: dp helpers |
| 356 | * |
| 357 | * The DisplayPort AUX channel is an abstraction to allow generic, driver- |
| 358 | * independent access to AUX functionality. Drivers can take advantage of |
| 359 | * this by filling in the fields of the drm_dp_aux structure. |
| 360 | * |
| 361 | * Transactions are described using a hardware-independent drm_dp_aux_msg |
| 362 | * structure, which is passed into a driver's .transfer() implementation. |
| 363 | * Both native and I2C-over-AUX transactions are supported. |
Thierry Reding | c197db7 | 2013-11-28 11:31:00 +0100 | [diff] [blame] | 364 | */ |
| 365 | |
| 366 | static int drm_dp_dpcd_access(struct drm_dp_aux *aux, u8 request, |
| 367 | unsigned int offset, void *buffer, size_t size) |
| 368 | { |
| 369 | struct drm_dp_aux_msg msg; |
| 370 | unsigned int retry; |
| 371 | int err; |
| 372 | |
| 373 | memset(&msg, 0, sizeof(msg)); |
| 374 | msg.address = offset; |
| 375 | msg.request = request; |
| 376 | msg.buffer = buffer; |
| 377 | msg.size = size; |
| 378 | |
| 379 | /* |
| 380 | * The specification doesn't give any recommendation on how often to |
| 381 | * retry native transactions, so retry 7 times like for I2C-over-AUX |
| 382 | * transactions. |
| 383 | */ |
| 384 | for (retry = 0; retry < 7; retry++) { |
| 385 | err = aux->transfer(aux, &msg); |
| 386 | if (err < 0) { |
| 387 | if (err == -EBUSY) |
| 388 | continue; |
| 389 | |
| 390 | return err; |
| 391 | } |
| 392 | |
Thierry Reding | c197db7 | 2013-11-28 11:31:00 +0100 | [diff] [blame] | 393 | |
| 394 | switch (msg.reply & DP_AUX_NATIVE_REPLY_MASK) { |
| 395 | case DP_AUX_NATIVE_REPLY_ACK: |
Dave Airlie | aa17edf | 2014-04-04 11:34:37 +1000 | [diff] [blame] | 396 | if (err < size) |
| 397 | return -EPROTO; |
Thierry Reding | c197db7 | 2013-11-28 11:31:00 +0100 | [diff] [blame] | 398 | return err; |
| 399 | |
| 400 | case DP_AUX_NATIVE_REPLY_NACK: |
| 401 | return -EIO; |
| 402 | |
| 403 | case DP_AUX_NATIVE_REPLY_DEFER: |
| 404 | usleep_range(400, 500); |
| 405 | break; |
| 406 | } |
| 407 | } |
| 408 | |
Alex Deucher | 743b1e3 | 2014-03-21 10:34:06 -0400 | [diff] [blame] | 409 | DRM_DEBUG_KMS("too many retries, giving up\n"); |
Thierry Reding | c197db7 | 2013-11-28 11:31:00 +0100 | [diff] [blame] | 410 | return -EIO; |
| 411 | } |
| 412 | |
| 413 | /** |
| 414 | * drm_dp_dpcd_read() - read a series of bytes from the DPCD |
| 415 | * @aux: DisplayPort AUX channel |
| 416 | * @offset: address of the (first) register to read |
| 417 | * @buffer: buffer to store the register values |
| 418 | * @size: number of bytes in @buffer |
| 419 | * |
| 420 | * Returns the number of bytes transferred on success, or a negative error |
| 421 | * code on failure. -EIO is returned if the request was NAKed by the sink or |
| 422 | * if the retry count was exceeded. If not all bytes were transferred, this |
| 423 | * function returns -EPROTO. Errors from the underlying AUX channel transfer |
| 424 | * function, with the exception of -EBUSY (which causes the transaction to |
| 425 | * be retried), are propagated to the caller. |
| 426 | */ |
| 427 | ssize_t drm_dp_dpcd_read(struct drm_dp_aux *aux, unsigned int offset, |
| 428 | void *buffer, size_t size) |
| 429 | { |
| 430 | return drm_dp_dpcd_access(aux, DP_AUX_NATIVE_READ, offset, buffer, |
| 431 | size); |
| 432 | } |
| 433 | EXPORT_SYMBOL(drm_dp_dpcd_read); |
| 434 | |
| 435 | /** |
| 436 | * drm_dp_dpcd_write() - write a series of bytes to the DPCD |
| 437 | * @aux: DisplayPort AUX channel |
| 438 | * @offset: address of the (first) register to write |
| 439 | * @buffer: buffer containing the values to write |
| 440 | * @size: number of bytes in @buffer |
| 441 | * |
| 442 | * Returns the number of bytes transferred on success, or a negative error |
| 443 | * code on failure. -EIO is returned if the request was NAKed by the sink or |
| 444 | * if the retry count was exceeded. If not all bytes were transferred, this |
| 445 | * function returns -EPROTO. Errors from the underlying AUX channel transfer |
| 446 | * function, with the exception of -EBUSY (which causes the transaction to |
| 447 | * be retried), are propagated to the caller. |
| 448 | */ |
| 449 | ssize_t drm_dp_dpcd_write(struct drm_dp_aux *aux, unsigned int offset, |
| 450 | void *buffer, size_t size) |
| 451 | { |
| 452 | return drm_dp_dpcd_access(aux, DP_AUX_NATIVE_WRITE, offset, buffer, |
| 453 | size); |
| 454 | } |
| 455 | EXPORT_SYMBOL(drm_dp_dpcd_write); |
Thierry Reding | 8d4adc6 | 2013-11-22 16:37:57 +0100 | [diff] [blame] | 456 | |
| 457 | /** |
| 458 | * drm_dp_dpcd_read_link_status() - read DPCD link status (bytes 0x202-0x207) |
| 459 | * @aux: DisplayPort AUX channel |
| 460 | * @status: buffer to store the link status in (must be at least 6 bytes) |
| 461 | * |
| 462 | * Returns the number of bytes transferred on success or a negative error |
| 463 | * code on failure. |
| 464 | */ |
| 465 | int drm_dp_dpcd_read_link_status(struct drm_dp_aux *aux, |
| 466 | u8 status[DP_LINK_STATUS_SIZE]) |
| 467 | { |
| 468 | return drm_dp_dpcd_read(aux, DP_LANE0_1_STATUS, status, |
| 469 | DP_LINK_STATUS_SIZE); |
| 470 | } |
| 471 | EXPORT_SYMBOL(drm_dp_dpcd_read_link_status); |
Thierry Reding | 516c0f7 | 2013-12-09 11:47:55 +0100 | [diff] [blame] | 472 | |
| 473 | /** |
| 474 | * drm_dp_link_probe() - probe a DisplayPort link for capabilities |
| 475 | * @aux: DisplayPort AUX channel |
| 476 | * @link: pointer to structure in which to return link capabilities |
| 477 | * |
| 478 | * The structure filled in by this function can usually be passed directly |
| 479 | * into drm_dp_link_power_up() and drm_dp_link_configure() to power up and |
| 480 | * configure the link based on the link's capabilities. |
| 481 | * |
| 482 | * Returns 0 on success or a negative error code on failure. |
| 483 | */ |
| 484 | int drm_dp_link_probe(struct drm_dp_aux *aux, struct drm_dp_link *link) |
| 485 | { |
| 486 | u8 values[3]; |
| 487 | int err; |
| 488 | |
| 489 | memset(link, 0, sizeof(*link)); |
| 490 | |
| 491 | err = drm_dp_dpcd_read(aux, DP_DPCD_REV, values, sizeof(values)); |
| 492 | if (err < 0) |
| 493 | return err; |
| 494 | |
| 495 | link->revision = values[0]; |
| 496 | link->rate = drm_dp_bw_code_to_link_rate(values[1]); |
| 497 | link->num_lanes = values[2] & DP_MAX_LANE_COUNT_MASK; |
| 498 | |
| 499 | if (values[2] & DP_ENHANCED_FRAME_CAP) |
| 500 | link->capabilities |= DP_LINK_CAP_ENHANCED_FRAMING; |
| 501 | |
| 502 | return 0; |
| 503 | } |
| 504 | EXPORT_SYMBOL(drm_dp_link_probe); |
| 505 | |
| 506 | /** |
| 507 | * drm_dp_link_power_up() - power up a DisplayPort link |
| 508 | * @aux: DisplayPort AUX channel |
| 509 | * @link: pointer to a structure containing the link configuration |
| 510 | * |
| 511 | * Returns 0 on success or a negative error code on failure. |
| 512 | */ |
| 513 | int drm_dp_link_power_up(struct drm_dp_aux *aux, struct drm_dp_link *link) |
| 514 | { |
| 515 | u8 value; |
| 516 | int err; |
| 517 | |
| 518 | /* DP_SET_POWER register is only available on DPCD v1.1 and later */ |
| 519 | if (link->revision < 0x11) |
| 520 | return 0; |
| 521 | |
| 522 | err = drm_dp_dpcd_readb(aux, DP_SET_POWER, &value); |
| 523 | if (err < 0) |
| 524 | return err; |
| 525 | |
| 526 | value &= ~DP_SET_POWER_MASK; |
| 527 | value |= DP_SET_POWER_D0; |
| 528 | |
| 529 | err = drm_dp_dpcd_writeb(aux, DP_SET_POWER, value); |
| 530 | if (err < 0) |
| 531 | return err; |
| 532 | |
| 533 | /* |
| 534 | * According to the DP 1.1 specification, a "Sink Device must exit the |
| 535 | * power saving state within 1 ms" (Section 2.5.3.1, Table 5-52, "Sink |
| 536 | * Control Field" (register 0x600). |
| 537 | */ |
| 538 | usleep_range(1000, 2000); |
| 539 | |
| 540 | return 0; |
| 541 | } |
| 542 | EXPORT_SYMBOL(drm_dp_link_power_up); |
| 543 | |
| 544 | /** |
| 545 | * drm_dp_link_configure() - configure a DisplayPort link |
| 546 | * @aux: DisplayPort AUX channel |
| 547 | * @link: pointer to a structure containing the link configuration |
| 548 | * |
| 549 | * Returns 0 on success or a negative error code on failure. |
| 550 | */ |
| 551 | int drm_dp_link_configure(struct drm_dp_aux *aux, struct drm_dp_link *link) |
| 552 | { |
| 553 | u8 values[2]; |
| 554 | int err; |
| 555 | |
| 556 | values[0] = drm_dp_link_rate_to_bw_code(link->rate); |
| 557 | values[1] = link->num_lanes; |
| 558 | |
| 559 | if (link->capabilities & DP_LINK_CAP_ENHANCED_FRAMING) |
| 560 | values[1] |= DP_LANE_COUNT_ENHANCED_FRAME_EN; |
| 561 | |
| 562 | err = drm_dp_dpcd_write(aux, DP_LINK_BW_SET, values, sizeof(values)); |
| 563 | if (err < 0) |
| 564 | return err; |
| 565 | |
| 566 | return 0; |
| 567 | } |
| 568 | EXPORT_SYMBOL(drm_dp_link_configure); |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 569 | |
| 570 | /* |
| 571 | * I2C-over-AUX implementation |
| 572 | */ |
| 573 | |
| 574 | static u32 drm_dp_i2c_functionality(struct i2c_adapter *adapter) |
| 575 | { |
| 576 | return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | |
| 577 | I2C_FUNC_SMBUS_READ_BLOCK_DATA | |
| 578 | I2C_FUNC_SMBUS_BLOCK_PROC_CALL | |
| 579 | I2C_FUNC_10BIT_ADDR; |
| 580 | } |
| 581 | |
| 582 | /* |
| 583 | * Transfer a single I2C-over-AUX message and handle various error conditions, |
Alex Deucher | 732d50b | 2014-04-07 10:33:45 -0400 | [diff] [blame] | 584 | * retrying the transaction as appropriate. It is assumed that the |
| 585 | * aux->transfer function does not modify anything in the msg other than the |
| 586 | * reply field. |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 587 | */ |
| 588 | static int drm_dp_i2c_do_msg(struct drm_dp_aux *aux, struct drm_dp_aux_msg *msg) |
| 589 | { |
| 590 | unsigned int retry; |
| 591 | int err; |
| 592 | |
| 593 | /* |
| 594 | * DP1.2 sections 2.7.7.1.5.6.1 and 2.7.7.1.6.6.1: A DP Source device |
| 595 | * is required to retry at least seven times upon receiving AUX_DEFER |
| 596 | * before giving up the AUX transaction. |
| 597 | */ |
| 598 | for (retry = 0; retry < 7; retry++) { |
| 599 | err = aux->transfer(aux, msg); |
| 600 | if (err < 0) { |
| 601 | if (err == -EBUSY) |
| 602 | continue; |
| 603 | |
| 604 | DRM_DEBUG_KMS("transaction failed: %d\n", err); |
| 605 | return err; |
| 606 | } |
| 607 | |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 608 | |
| 609 | switch (msg->reply & DP_AUX_NATIVE_REPLY_MASK) { |
| 610 | case DP_AUX_NATIVE_REPLY_ACK: |
| 611 | /* |
| 612 | * For I2C-over-AUX transactions this isn't enough, we |
| 613 | * need to check for the I2C ACK reply. |
| 614 | */ |
| 615 | break; |
| 616 | |
| 617 | case DP_AUX_NATIVE_REPLY_NACK: |
| 618 | DRM_DEBUG_KMS("native nack\n"); |
| 619 | return -EREMOTEIO; |
| 620 | |
| 621 | case DP_AUX_NATIVE_REPLY_DEFER: |
| 622 | DRM_DEBUG_KMS("native defer"); |
| 623 | /* |
| 624 | * We could check for I2C bit rate capabilities and if |
| 625 | * available adjust this interval. We could also be |
| 626 | * more careful with DP-to-legacy adapters where a |
| 627 | * long legacy cable may force very low I2C bit rates. |
| 628 | * |
| 629 | * For now just defer for long enough to hopefully be |
| 630 | * safe for all use-cases. |
| 631 | */ |
| 632 | usleep_range(500, 600); |
| 633 | continue; |
| 634 | |
| 635 | default: |
| 636 | DRM_ERROR("invalid native reply %#04x\n", msg->reply); |
| 637 | return -EREMOTEIO; |
| 638 | } |
| 639 | |
| 640 | switch (msg->reply & DP_AUX_I2C_REPLY_MASK) { |
| 641 | case DP_AUX_I2C_REPLY_ACK: |
| 642 | /* |
| 643 | * Both native ACK and I2C ACK replies received. We |
| 644 | * can assume the transfer was successful. |
| 645 | */ |
Dave Airlie | aa17edf | 2014-04-04 11:34:37 +1000 | [diff] [blame] | 646 | if (err < msg->size) |
| 647 | return -EPROTO; |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 648 | return 0; |
| 649 | |
| 650 | case DP_AUX_I2C_REPLY_NACK: |
| 651 | DRM_DEBUG_KMS("I2C nack\n"); |
| 652 | return -EREMOTEIO; |
| 653 | |
| 654 | case DP_AUX_I2C_REPLY_DEFER: |
| 655 | DRM_DEBUG_KMS("I2C defer\n"); |
| 656 | usleep_range(400, 500); |
| 657 | continue; |
| 658 | |
| 659 | default: |
| 660 | DRM_ERROR("invalid I2C reply %#04x\n", msg->reply); |
| 661 | return -EREMOTEIO; |
| 662 | } |
| 663 | } |
| 664 | |
Alex Deucher | 743b1e3 | 2014-03-21 10:34:06 -0400 | [diff] [blame] | 665 | DRM_DEBUG_KMS("too many retries, giving up\n"); |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 666 | return -EREMOTEIO; |
| 667 | } |
| 668 | |
| 669 | static int drm_dp_i2c_xfer(struct i2c_adapter *adapter, struct i2c_msg *msgs, |
| 670 | int num) |
| 671 | { |
| 672 | struct drm_dp_aux *aux = adapter->algo_data; |
| 673 | unsigned int i, j; |
Alex Deucher | ccdb516 | 2014-04-07 10:33:44 -0400 | [diff] [blame] | 674 | struct drm_dp_aux_msg msg; |
| 675 | int err = 0; |
| 676 | |
| 677 | memset(&msg, 0, sizeof(msg)); |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 678 | |
| 679 | for (i = 0; i < num; i++) { |
Alex Deucher | ccdb516 | 2014-04-07 10:33:44 -0400 | [diff] [blame] | 680 | msg.address = msgs[i].addr; |
| 681 | msg.request = (msgs[i].flags & I2C_M_RD) ? |
| 682 | DP_AUX_I2C_READ : |
| 683 | DP_AUX_I2C_WRITE; |
| 684 | msg.request |= DP_AUX_I2C_MOT; |
| 685 | /* Send a bare address packet to start the transaction. |
| 686 | * Zero sized messages specify an address only (bare |
| 687 | * address) transaction. |
| 688 | */ |
| 689 | msg.buffer = NULL; |
| 690 | msg.size = 0; |
| 691 | err = drm_dp_i2c_do_msg(aux, &msg); |
| 692 | if (err < 0) |
| 693 | break; |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 694 | /* |
| 695 | * Many hardware implementations support FIFOs larger than a |
| 696 | * single byte, but it has been empirically determined that |
| 697 | * transferring data in larger chunks can actually lead to |
| 698 | * decreased performance. Therefore each message is simply |
| 699 | * transferred byte-by-byte. |
| 700 | */ |
| 701 | for (j = 0; j < msgs[i].len; j++) { |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 702 | msg.buffer = msgs[i].buf + j; |
| 703 | msg.size = 1; |
| 704 | |
| 705 | err = drm_dp_i2c_do_msg(aux, &msg); |
| 706 | if (err < 0) |
Alex Deucher | ccdb516 | 2014-04-07 10:33:44 -0400 | [diff] [blame] | 707 | break; |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 708 | } |
Alex Deucher | ccdb516 | 2014-04-07 10:33:44 -0400 | [diff] [blame] | 709 | if (err < 0) |
| 710 | break; |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 711 | } |
Alex Deucher | ccdb516 | 2014-04-07 10:33:44 -0400 | [diff] [blame] | 712 | if (err >= 0) |
| 713 | err = num; |
| 714 | /* Send a bare address packet to close out the transaction. |
| 715 | * Zero sized messages specify an address only (bare |
| 716 | * address) transaction. |
| 717 | */ |
| 718 | msg.request &= ~DP_AUX_I2C_MOT; |
| 719 | msg.buffer = NULL; |
| 720 | msg.size = 0; |
| 721 | (void)drm_dp_i2c_do_msg(aux, &msg); |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 722 | |
Alex Deucher | ccdb516 | 2014-04-07 10:33:44 -0400 | [diff] [blame] | 723 | return err; |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 724 | } |
| 725 | |
| 726 | static const struct i2c_algorithm drm_dp_i2c_algo = { |
| 727 | .functionality = drm_dp_i2c_functionality, |
| 728 | .master_xfer = drm_dp_i2c_xfer, |
| 729 | }; |
| 730 | |
| 731 | /** |
| 732 | * drm_dp_aux_register_i2c_bus() - register an I2C adapter for I2C-over-AUX |
| 733 | * @aux: DisplayPort AUX channel |
| 734 | * |
| 735 | * Returns 0 on success or a negative error code on failure. |
| 736 | */ |
| 737 | int drm_dp_aux_register_i2c_bus(struct drm_dp_aux *aux) |
| 738 | { |
| 739 | aux->ddc.algo = &drm_dp_i2c_algo; |
| 740 | aux->ddc.algo_data = aux; |
| 741 | aux->ddc.retries = 3; |
| 742 | |
| 743 | aux->ddc.class = I2C_CLASS_DDC; |
| 744 | aux->ddc.owner = THIS_MODULE; |
| 745 | aux->ddc.dev.parent = aux->dev; |
| 746 | aux->ddc.dev.of_node = aux->dev->of_node; |
| 747 | |
Jani Nikula | 9dc4056 | 2014-03-14 16:51:12 +0200 | [diff] [blame] | 748 | strlcpy(aux->ddc.name, aux->name ? aux->name : dev_name(aux->dev), |
| 749 | sizeof(aux->ddc.name)); |
Thierry Reding | 8875968 | 2013-12-12 09:57:53 +0100 | [diff] [blame] | 750 | |
| 751 | return i2c_add_adapter(&aux->ddc); |
| 752 | } |
| 753 | EXPORT_SYMBOL(drm_dp_aux_register_i2c_bus); |
| 754 | |
| 755 | /** |
| 756 | * drm_dp_aux_unregister_i2c_bus() - unregister an I2C-over-AUX adapter |
| 757 | * @aux: DisplayPort AUX channel |
| 758 | */ |
| 759 | void drm_dp_aux_unregister_i2c_bus(struct drm_dp_aux *aux) |
| 760 | { |
| 761 | i2c_del_adapter(&aux->ddc); |
| 762 | } |
| 763 | EXPORT_SYMBOL(drm_dp_aux_unregister_i2c_bus); |