drm_dp_helper.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530
  1. /*
  2. * Copyright © 2008 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. #ifndef _DRM_DP_HELPER_H_
  23. #define _DRM_DP_HELPER_H_
  24. #include <linux/types.h>
  25. #include <linux/i2c.h>
  26. #include <linux/delay.h>
  27. /*
  28. * Unless otherwise noted, all values are from the DP 1.1a spec. Note that
  29. * DP and DPCD versions are independent. Differences from 1.0 are not noted,
  30. * 1.0 devices basically don't exist in the wild.
  31. *
  32. * Abbreviations, in chronological order:
  33. *
  34. * eDP: Embedded DisplayPort version 1
  35. * DPI: DisplayPort Interoperability Guideline v1.1a
  36. * 1.2: DisplayPort 1.2
  37. *
  38. * 1.2 formally includes both eDP and DPI definitions.
  39. */
  40. #define DP_AUX_I2C_WRITE 0x0
  41. #define DP_AUX_I2C_READ 0x1
  42. #define DP_AUX_I2C_STATUS 0x2
  43. #define DP_AUX_I2C_MOT 0x4
  44. #define DP_AUX_NATIVE_WRITE 0x8
  45. #define DP_AUX_NATIVE_READ 0x9
  46. #define DP_AUX_NATIVE_REPLY_ACK (0x0 << 0)
  47. #define DP_AUX_NATIVE_REPLY_NACK (0x1 << 0)
  48. #define DP_AUX_NATIVE_REPLY_DEFER (0x2 << 0)
  49. #define DP_AUX_NATIVE_REPLY_MASK (0x3 << 0)
  50. #define DP_AUX_I2C_REPLY_ACK (0x0 << 2)
  51. #define DP_AUX_I2C_REPLY_NACK (0x1 << 2)
  52. #define DP_AUX_I2C_REPLY_DEFER (0x2 << 2)
  53. #define DP_AUX_I2C_REPLY_MASK (0x3 << 2)
  54. /* AUX CH addresses */
  55. /* DPCD */
  56. #define DP_DPCD_REV 0x000
  57. #define DP_MAX_LINK_RATE 0x001
  58. #define DP_MAX_LANE_COUNT 0x002
  59. # define DP_MAX_LANE_COUNT_MASK 0x1f
  60. # define DP_TPS3_SUPPORTED (1 << 6) /* 1.2 */
  61. # define DP_ENHANCED_FRAME_CAP (1 << 7)
  62. #define DP_MAX_DOWNSPREAD 0x003
  63. # define DP_NO_AUX_HANDSHAKE_LINK_TRAINING (1 << 6)
  64. #define DP_NORP 0x004
  65. #define DP_DOWNSTREAMPORT_PRESENT 0x005
  66. # define DP_DWN_STRM_PORT_PRESENT (1 << 0)
  67. # define DP_DWN_STRM_PORT_TYPE_MASK 0x06
  68. # define DP_DWN_STRM_PORT_TYPE_DP (0 << 1)
  69. # define DP_DWN_STRM_PORT_TYPE_ANALOG (1 << 1)
  70. # define DP_DWN_STRM_PORT_TYPE_TMDS (2 << 1)
  71. # define DP_DWN_STRM_PORT_TYPE_OTHER (3 << 1)
  72. # define DP_FORMAT_CONVERSION (1 << 3)
  73. # define DP_DETAILED_CAP_INFO_AVAILABLE (1 << 4) /* DPI */
  74. #define DP_MAIN_LINK_CHANNEL_CODING 0x006
  75. #define DP_DOWN_STREAM_PORT_COUNT 0x007
  76. # define DP_PORT_COUNT_MASK 0x0f
  77. # define DP_MSA_TIMING_PAR_IGNORED (1 << 6) /* eDP */
  78. # define DP_OUI_SUPPORT (1 << 7)
  79. #define DP_I2C_SPEED_CAP 0x00c /* DPI */
  80. # define DP_I2C_SPEED_1K 0x01
  81. # define DP_I2C_SPEED_5K 0x02
  82. # define DP_I2C_SPEED_10K 0x04
  83. # define DP_I2C_SPEED_100K 0x08
  84. # define DP_I2C_SPEED_400K 0x10
  85. # define DP_I2C_SPEED_1M 0x20
  86. #define DP_EDP_CONFIGURATION_CAP 0x00d /* XXX 1.2? */
  87. #define DP_TRAINING_AUX_RD_INTERVAL 0x00e /* XXX 1.2? */
  88. /* Multiple stream transport */
  89. #define DP_MSTM_CAP 0x021 /* 1.2 */
  90. # define DP_MST_CAP (1 << 0)
  91. #define DP_PSR_SUPPORT 0x070 /* XXX 1.2? */
  92. # define DP_PSR_IS_SUPPORTED 1
  93. #define DP_PSR_CAPS 0x071 /* XXX 1.2? */
  94. # define DP_PSR_NO_TRAIN_ON_EXIT 1
  95. # define DP_PSR_SETUP_TIME_330 (0 << 1)
  96. # define DP_PSR_SETUP_TIME_275 (1 << 1)
  97. # define DP_PSR_SETUP_TIME_220 (2 << 1)
  98. # define DP_PSR_SETUP_TIME_165 (3 << 1)
  99. # define DP_PSR_SETUP_TIME_110 (4 << 1)
  100. # define DP_PSR_SETUP_TIME_55 (5 << 1)
  101. # define DP_PSR_SETUP_TIME_0 (6 << 1)
  102. # define DP_PSR_SETUP_TIME_MASK (7 << 1)
  103. # define DP_PSR_SETUP_TIME_SHIFT 1
  104. /*
  105. * 0x80-0x8f describe downstream port capabilities, but there are two layouts
  106. * based on whether DP_DETAILED_CAP_INFO_AVAILABLE was set. If it was not,
  107. * each port's descriptor is one byte wide. If it was set, each port's is
  108. * four bytes wide, starting with the one byte from the base info. As of
  109. * DP interop v1.1a only VGA defines additional detail.
  110. */
  111. /* offset 0 */
  112. #define DP_DOWNSTREAM_PORT_0 0x80
  113. # define DP_DS_PORT_TYPE_MASK (7 << 0)
  114. # define DP_DS_PORT_TYPE_DP 0
  115. # define DP_DS_PORT_TYPE_VGA 1
  116. # define DP_DS_PORT_TYPE_DVI 2
  117. # define DP_DS_PORT_TYPE_HDMI 3
  118. # define DP_DS_PORT_TYPE_NON_EDID 4
  119. # define DP_DS_PORT_HPD (1 << 3)
  120. /* offset 1 for VGA is maximum megapixels per second / 8 */
  121. /* offset 2 */
  122. # define DP_DS_VGA_MAX_BPC_MASK (3 << 0)
  123. # define DP_DS_VGA_8BPC 0
  124. # define DP_DS_VGA_10BPC 1
  125. # define DP_DS_VGA_12BPC 2
  126. # define DP_DS_VGA_16BPC 3
  127. /* link configuration */
  128. #define DP_LINK_BW_SET 0x100
  129. # define DP_LINK_BW_1_62 0x06
  130. # define DP_LINK_BW_2_7 0x0a
  131. # define DP_LINK_BW_5_4 0x14 /* 1.2 */
  132. #define DP_LANE_COUNT_SET 0x101
  133. # define DP_LANE_COUNT_MASK 0x0f
  134. # define DP_LANE_COUNT_ENHANCED_FRAME_EN (1 << 7)
  135. #define DP_TRAINING_PATTERN_SET 0x102
  136. # define DP_TRAINING_PATTERN_DISABLE 0
  137. # define DP_TRAINING_PATTERN_1 1
  138. # define DP_TRAINING_PATTERN_2 2
  139. # define DP_TRAINING_PATTERN_3 3 /* 1.2 */
  140. # define DP_TRAINING_PATTERN_MASK 0x3
  141. # define DP_LINK_QUAL_PATTERN_DISABLE (0 << 2)
  142. # define DP_LINK_QUAL_PATTERN_D10_2 (1 << 2)
  143. # define DP_LINK_QUAL_PATTERN_ERROR_RATE (2 << 2)
  144. # define DP_LINK_QUAL_PATTERN_PRBS7 (3 << 2)
  145. # define DP_LINK_QUAL_PATTERN_MASK (3 << 2)
  146. # define DP_RECOVERED_CLOCK_OUT_EN (1 << 4)
  147. # define DP_LINK_SCRAMBLING_DISABLE (1 << 5)
  148. # define DP_SYMBOL_ERROR_COUNT_BOTH (0 << 6)
  149. # define DP_SYMBOL_ERROR_COUNT_DISPARITY (1 << 6)
  150. # define DP_SYMBOL_ERROR_COUNT_SYMBOL (2 << 6)
  151. # define DP_SYMBOL_ERROR_COUNT_MASK (3 << 6)
  152. #define DP_TRAINING_LANE0_SET 0x103
  153. #define DP_TRAINING_LANE1_SET 0x104
  154. #define DP_TRAINING_LANE2_SET 0x105
  155. #define DP_TRAINING_LANE3_SET 0x106
  156. # define DP_TRAIN_VOLTAGE_SWING_MASK 0x3
  157. # define DP_TRAIN_VOLTAGE_SWING_SHIFT 0
  158. # define DP_TRAIN_MAX_SWING_REACHED (1 << 2)
  159. # define DP_TRAIN_VOLTAGE_SWING_400 (0 << 0)
  160. # define DP_TRAIN_VOLTAGE_SWING_600 (1 << 0)
  161. # define DP_TRAIN_VOLTAGE_SWING_800 (2 << 0)
  162. # define DP_TRAIN_VOLTAGE_SWING_1200 (3 << 0)
  163. # define DP_TRAIN_PRE_EMPHASIS_MASK (3 << 3)
  164. # define DP_TRAIN_PRE_EMPHASIS_0 (0 << 3)
  165. # define DP_TRAIN_PRE_EMPHASIS_3_5 (1 << 3)
  166. # define DP_TRAIN_PRE_EMPHASIS_6 (2 << 3)
  167. # define DP_TRAIN_PRE_EMPHASIS_9_5 (3 << 3)
  168. # define DP_TRAIN_PRE_EMPHASIS_SHIFT 3
  169. # define DP_TRAIN_MAX_PRE_EMPHASIS_REACHED (1 << 5)
  170. #define DP_DOWNSPREAD_CTRL 0x107
  171. # define DP_SPREAD_AMP_0_5 (1 << 4)
  172. # define DP_MSA_TIMING_PAR_IGNORE_EN (1 << 7) /* eDP */
  173. #define DP_MAIN_LINK_CHANNEL_CODING_SET 0x108
  174. # define DP_SET_ANSI_8B10B (1 << 0)
  175. #define DP_I2C_SPEED_CONTROL_STATUS 0x109 /* DPI */
  176. /* bitmask as for DP_I2C_SPEED_CAP */
  177. #define DP_EDP_CONFIGURATION_SET 0x10a /* XXX 1.2? */
  178. #define DP_MSTM_CTRL 0x111 /* 1.2 */
  179. # define DP_MST_EN (1 << 0)
  180. # define DP_UP_REQ_EN (1 << 1)
  181. # define DP_UPSTREAM_IS_SRC (1 << 2)
  182. #define DP_PSR_EN_CFG 0x170 /* XXX 1.2? */
  183. # define DP_PSR_ENABLE (1 << 0)
  184. # define DP_PSR_MAIN_LINK_ACTIVE (1 << 1)
  185. # define DP_PSR_CRC_VERIFICATION (1 << 2)
  186. # define DP_PSR_FRAME_CAPTURE (1 << 3)
  187. #define DP_SINK_COUNT 0x200
  188. /* prior to 1.2 bit 7 was reserved mbz */
  189. # define DP_GET_SINK_COUNT(x) ((((x) & 0x80) >> 1) | ((x) & 0x3f))
  190. # define DP_SINK_CP_READY (1 << 6)
  191. #define DP_DEVICE_SERVICE_IRQ_VECTOR 0x201
  192. # define DP_REMOTE_CONTROL_COMMAND_PENDING (1 << 0)
  193. # define DP_AUTOMATED_TEST_REQUEST (1 << 1)
  194. # define DP_CP_IRQ (1 << 2)
  195. # define DP_SINK_SPECIFIC_IRQ (1 << 6)
  196. #define DP_LANE0_1_STATUS 0x202
  197. #define DP_LANE2_3_STATUS 0x203
  198. # define DP_LANE_CR_DONE (1 << 0)
  199. # define DP_LANE_CHANNEL_EQ_DONE (1 << 1)
  200. # define DP_LANE_SYMBOL_LOCKED (1 << 2)
  201. #define DP_CHANNEL_EQ_BITS (DP_LANE_CR_DONE | \
  202. DP_LANE_CHANNEL_EQ_DONE | \
  203. DP_LANE_SYMBOL_LOCKED)
  204. #define DP_LANE_ALIGN_STATUS_UPDATED 0x204
  205. #define DP_INTERLANE_ALIGN_DONE (1 << 0)
  206. #define DP_DOWNSTREAM_PORT_STATUS_CHANGED (1 << 6)
  207. #define DP_LINK_STATUS_UPDATED (1 << 7)
  208. #define DP_SINK_STATUS 0x205
  209. #define DP_RECEIVE_PORT_0_STATUS (1 << 0)
  210. #define DP_RECEIVE_PORT_1_STATUS (1 << 1)
  211. #define DP_ADJUST_REQUEST_LANE0_1 0x206
  212. #define DP_ADJUST_REQUEST_LANE2_3 0x207
  213. # define DP_ADJUST_VOLTAGE_SWING_LANE0_MASK 0x03
  214. # define DP_ADJUST_VOLTAGE_SWING_LANE0_SHIFT 0
  215. # define DP_ADJUST_PRE_EMPHASIS_LANE0_MASK 0x0c
  216. # define DP_ADJUST_PRE_EMPHASIS_LANE0_SHIFT 2
  217. # define DP_ADJUST_VOLTAGE_SWING_LANE1_MASK 0x30
  218. # define DP_ADJUST_VOLTAGE_SWING_LANE1_SHIFT 4
  219. # define DP_ADJUST_PRE_EMPHASIS_LANE1_MASK 0xc0
  220. # define DP_ADJUST_PRE_EMPHASIS_LANE1_SHIFT 6
  221. #define DP_TEST_REQUEST 0x218
  222. # define DP_TEST_LINK_TRAINING (1 << 0)
  223. # define DP_TEST_LINK_VIDEO_PATTERN (1 << 1)
  224. # define DP_TEST_LINK_EDID_READ (1 << 2)
  225. # define DP_TEST_LINK_PHY_TEST_PATTERN (1 << 3) /* DPCD >= 1.1 */
  226. # define DP_TEST_LINK_FAUX_PATTERN (1 << 4) /* DPCD >= 1.2 */
  227. #define DP_TEST_LINK_RATE 0x219
  228. # define DP_LINK_RATE_162 (0x6)
  229. # define DP_LINK_RATE_27 (0xa)
  230. #define DP_TEST_LANE_COUNT 0x220
  231. #define DP_TEST_PATTERN 0x221
  232. #define DP_TEST_CRC_R_CR 0x240
  233. #define DP_TEST_CRC_G_Y 0x242
  234. #define DP_TEST_CRC_B_CB 0x244
  235. #define DP_TEST_SINK_MISC 0x246
  236. #define DP_TEST_CRC_SUPPORTED (1 << 5)
  237. #define DP_TEST_RESPONSE 0x260
  238. # define DP_TEST_ACK (1 << 0)
  239. # define DP_TEST_NAK (1 << 1)
  240. # define DP_TEST_EDID_CHECKSUM_WRITE (1 << 2)
  241. #define DP_TEST_SINK 0x270
  242. #define DP_TEST_SINK_START (1 << 0)
  243. #define DP_SOURCE_OUI 0x300
  244. #define DP_SINK_OUI 0x400
  245. #define DP_BRANCH_OUI 0x500
  246. #define DP_SET_POWER 0x600
  247. # define DP_SET_POWER_D0 0x1
  248. # define DP_SET_POWER_D3 0x2
  249. # define DP_SET_POWER_MASK 0x3
  250. #define DP_PSR_ERROR_STATUS 0x2006 /* XXX 1.2? */
  251. # define DP_PSR_LINK_CRC_ERROR (1 << 0)
  252. # define DP_PSR_RFB_STORAGE_ERROR (1 << 1)
  253. #define DP_PSR_ESI 0x2007 /* XXX 1.2? */
  254. # define DP_PSR_CAPS_CHANGE (1 << 0)
  255. #define DP_PSR_STATUS 0x2008 /* XXX 1.2? */
  256. # define DP_PSR_SINK_INACTIVE 0
  257. # define DP_PSR_SINK_ACTIVE_SRC_SYNCED 1
  258. # define DP_PSR_SINK_ACTIVE_RFB 2
  259. # define DP_PSR_SINK_ACTIVE_SINK_SYNCED 3
  260. # define DP_PSR_SINK_ACTIVE_RESYNC 4
  261. # define DP_PSR_SINK_INTERNAL_ERROR 7
  262. # define DP_PSR_SINK_STATE_MASK 0x07
  263. #define MODE_I2C_START 1
  264. #define MODE_I2C_WRITE 2
  265. #define MODE_I2C_READ 4
  266. #define MODE_I2C_STOP 8
  267. /**
  268. * struct i2c_algo_dp_aux_data - driver interface structure for i2c over dp
  269. * aux algorithm
  270. * @running: set by the algo indicating whether an i2c is ongoing or whether
  271. * the i2c bus is quiescent
  272. * @address: i2c target address for the currently ongoing transfer
  273. * @aux_ch: driver callback to transfer a single byte of the i2c payload
  274. */
  275. struct i2c_algo_dp_aux_data {
  276. bool running;
  277. u16 address;
  278. int (*aux_ch) (struct i2c_adapter *adapter,
  279. int mode, uint8_t write_byte,
  280. uint8_t *read_byte);
  281. };
  282. int
  283. i2c_dp_aux_add_bus(struct i2c_adapter *adapter);
  284. #define DP_LINK_STATUS_SIZE 6
  285. bool drm_dp_channel_eq_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
  286. int lane_count);
  287. bool drm_dp_clock_recovery_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
  288. int lane_count);
  289. u8 drm_dp_get_adjust_request_voltage(const u8 link_status[DP_LINK_STATUS_SIZE],
  290. int lane);
  291. u8 drm_dp_get_adjust_request_pre_emphasis(const u8 link_status[DP_LINK_STATUS_SIZE],
  292. int lane);
  293. #define DP_RECEIVER_CAP_SIZE 0xf
  294. #define EDP_PSR_RECEIVER_CAP_SIZE 2
  295. void drm_dp_link_train_clock_recovery_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]);
  296. void drm_dp_link_train_channel_eq_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]);
  297. u8 drm_dp_link_rate_to_bw_code(int link_rate);
  298. int drm_dp_bw_code_to_link_rate(u8 link_bw);
  299. struct edp_sdp_header {
  300. u8 HB0; /* Secondary Data Packet ID */
  301. u8 HB1; /* Secondary Data Packet Type */
  302. u8 HB2; /* 7:5 reserved, 4:0 revision number */
  303. u8 HB3; /* 7:5 reserved, 4:0 number of valid data bytes */
  304. } __packed;
  305. #define EDP_SDP_HEADER_REVISION_MASK 0x1F
  306. #define EDP_SDP_HEADER_VALID_PAYLOAD_BYTES 0x1F
  307. struct edp_vsc_psr {
  308. struct edp_sdp_header sdp_header;
  309. u8 DB0; /* Stereo Interface */
  310. u8 DB1; /* 0 - PSR State; 1 - Update RFB; 2 - CRC Valid */
  311. u8 DB2; /* CRC value bits 7:0 of the R or Cr component */
  312. u8 DB3; /* CRC value bits 15:8 of the R or Cr component */
  313. u8 DB4; /* CRC value bits 7:0 of the G or Y component */
  314. u8 DB5; /* CRC value bits 15:8 of the G or Y component */
  315. u8 DB6; /* CRC value bits 7:0 of the B or Cb component */
  316. u8 DB7; /* CRC value bits 15:8 of the B or Cb component */
  317. u8 DB8_31[24]; /* Reserved */
  318. } __packed;
  319. #define EDP_VSC_PSR_STATE_ACTIVE (1<<0)
  320. #define EDP_VSC_PSR_UPDATE_RFB (1<<1)
  321. #define EDP_VSC_PSR_CRC_VALUES_VALID (1<<2)
  322. static inline int
  323. drm_dp_max_link_rate(const u8 dpcd[DP_RECEIVER_CAP_SIZE])
  324. {
  325. return drm_dp_bw_code_to_link_rate(dpcd[DP_MAX_LINK_RATE]);
  326. }
  327. static inline u8
  328. drm_dp_max_lane_count(const u8 dpcd[DP_RECEIVER_CAP_SIZE])
  329. {
  330. return dpcd[DP_MAX_LANE_COUNT] & DP_MAX_LANE_COUNT_MASK;
  331. }
  332. static inline bool
  333. drm_dp_enhanced_frame_cap(const u8 dpcd[DP_RECEIVER_CAP_SIZE])
  334. {
  335. return dpcd[DP_DPCD_REV] >= 0x11 &&
  336. (dpcd[DP_MAX_LANE_COUNT] & DP_ENHANCED_FRAME_CAP);
  337. }
  338. /*
  339. * DisplayPort AUX channel
  340. */
  341. /**
  342. * struct drm_dp_aux_msg - DisplayPort AUX channel transaction
  343. * @address: address of the (first) register to access
  344. * @request: contains the type of transaction (see DP_AUX_* macros)
  345. * @reply: upon completion, contains the reply type of the transaction
  346. * @buffer: pointer to a transmission or reception buffer
  347. * @size: size of @buffer
  348. */
  349. struct drm_dp_aux_msg {
  350. unsigned int address;
  351. u8 request;
  352. u8 reply;
  353. void *buffer;
  354. size_t size;
  355. };
  356. /**
  357. * struct drm_dp_aux - DisplayPort AUX channel
  358. * @ddc: I2C adapter that can be used for I2C-over-AUX communication
  359. * @dev: pointer to struct device that is the parent for this AUX channel
  360. * @transfer: transfers a message representing a single AUX transaction
  361. *
  362. * The .dev field should be set to a pointer to the device that implements
  363. * the AUX channel.
  364. *
  365. * The .name field may be used to specify the name of the I2C adapter. If set to
  366. * NULL, dev_name() of .dev will be used.
  367. *
  368. * Drivers provide a hardware-specific implementation of how transactions
  369. * are executed via the .transfer() function. A pointer to a drm_dp_aux_msg
  370. * structure describing the transaction is passed into this function. Upon
  371. * success, the implementation should return the number of payload bytes
  372. * that were transferred, or a negative error-code on failure. Helpers
  373. * propagate errors from the .transfer() function, with the exception of
  374. * the -EBUSY error, which causes a transaction to be retried. On a short,
  375. * helpers will return -EPROTO to make it simpler to check for failure.
  376. *
  377. * An AUX channel can also be used to transport I2C messages to a sink. A
  378. * typical application of that is to access an EDID that's present in the
  379. * sink device. The .transfer() function can also be used to execute such
  380. * transactions. The drm_dp_aux_register_i2c_bus() function registers an
  381. * I2C adapter that can be passed to drm_probe_ddc(). Upon removal, drivers
  382. * should call drm_dp_aux_unregister_i2c_bus() to remove the I2C adapter.
  383. *
  384. * Note that the aux helper code assumes that the .transfer() function
  385. * only modifies the reply field of the drm_dp_aux_msg structure. The
  386. * retry logic and i2c helpers assume this is the case.
  387. */
  388. struct drm_dp_aux {
  389. const char *name;
  390. struct i2c_adapter ddc;
  391. struct device *dev;
  392. ssize_t (*transfer)(struct drm_dp_aux *aux,
  393. struct drm_dp_aux_msg *msg);
  394. };
  395. ssize_t drm_dp_dpcd_read(struct drm_dp_aux *aux, unsigned int offset,
  396. void *buffer, size_t size);
  397. ssize_t drm_dp_dpcd_write(struct drm_dp_aux *aux, unsigned int offset,
  398. void *buffer, size_t size);
  399. /**
  400. * drm_dp_dpcd_readb() - read a single byte from the DPCD
  401. * @aux: DisplayPort AUX channel
  402. * @offset: address of the register to read
  403. * @valuep: location where the value of the register will be stored
  404. *
  405. * Returns the number of bytes transferred (1) on success, or a negative
  406. * error code on failure.
  407. */
  408. static inline ssize_t drm_dp_dpcd_readb(struct drm_dp_aux *aux,
  409. unsigned int offset, u8 *valuep)
  410. {
  411. return drm_dp_dpcd_read(aux, offset, valuep, 1);
  412. }
  413. /**
  414. * drm_dp_dpcd_writeb() - write a single byte to the DPCD
  415. * @aux: DisplayPort AUX channel
  416. * @offset: address of the register to write
  417. * @value: value to write to the register
  418. *
  419. * Returns the number of bytes transferred (1) on success, or a negative
  420. * error code on failure.
  421. */
  422. static inline ssize_t drm_dp_dpcd_writeb(struct drm_dp_aux *aux,
  423. unsigned int offset, u8 value)
  424. {
  425. return drm_dp_dpcd_write(aux, offset, &value, 1);
  426. }
  427. int drm_dp_dpcd_read_link_status(struct drm_dp_aux *aux,
  428. u8 status[DP_LINK_STATUS_SIZE]);
  429. /*
  430. * DisplayPort link
  431. */
  432. #define DP_LINK_CAP_ENHANCED_FRAMING (1 << 0)
  433. struct drm_dp_link {
  434. unsigned char revision;
  435. unsigned int rate;
  436. unsigned int num_lanes;
  437. unsigned long capabilities;
  438. };
  439. int drm_dp_link_probe(struct drm_dp_aux *aux, struct drm_dp_link *link);
  440. int drm_dp_link_power_up(struct drm_dp_aux *aux, struct drm_dp_link *link);
  441. int drm_dp_link_configure(struct drm_dp_aux *aux, struct drm_dp_link *link);
  442. int drm_dp_aux_register_i2c_bus(struct drm_dp_aux *aux);
  443. void drm_dp_aux_unregister_i2c_bus(struct drm_dp_aux *aux);
  444. #endif /* _DRM_DP_HELPER_H_ */