pd.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /*
  3. * Copyright 2015-2017 Google, Inc
  4. */
  5. #ifndef __LINUX_USB_PD_H
  6. #define __LINUX_USB_PD_H
  7. #include <linux/kernel.h>
  8. #include <linux/types.h>
  9. #include <linux/usb/typec.h>
  10. /* USB PD Messages */
  11. enum pd_ctrl_msg_type {
  12. /* 0 Reserved */
  13. PD_CTRL_GOOD_CRC = 1,
  14. PD_CTRL_GOTO_MIN = 2,
  15. PD_CTRL_ACCEPT = 3,
  16. PD_CTRL_REJECT = 4,
  17. PD_CTRL_PING = 5,
  18. PD_CTRL_PS_RDY = 6,
  19. PD_CTRL_GET_SOURCE_CAP = 7,
  20. PD_CTRL_GET_SINK_CAP = 8,
  21. PD_CTRL_DR_SWAP = 9,
  22. PD_CTRL_PR_SWAP = 10,
  23. PD_CTRL_VCONN_SWAP = 11,
  24. PD_CTRL_WAIT = 12,
  25. PD_CTRL_SOFT_RESET = 13,
  26. /* 14-15 Reserved */
  27. PD_CTRL_NOT_SUPP = 16,
  28. PD_CTRL_GET_SOURCE_CAP_EXT = 17,
  29. PD_CTRL_GET_STATUS = 18,
  30. PD_CTRL_FR_SWAP = 19,
  31. PD_CTRL_GET_PPS_STATUS = 20,
  32. PD_CTRL_GET_COUNTRY_CODES = 21,
  33. /* 22-31 Reserved */
  34. };
  35. enum pd_data_msg_type {
  36. /* 0 Reserved */
  37. PD_DATA_SOURCE_CAP = 1,
  38. PD_DATA_REQUEST = 2,
  39. PD_DATA_BIST = 3,
  40. PD_DATA_SINK_CAP = 4,
  41. PD_DATA_BATT_STATUS = 5,
  42. PD_DATA_ALERT = 6,
  43. PD_DATA_GET_COUNTRY_INFO = 7,
  44. PD_DATA_ENTER_USB = 8,
  45. /* 9-14 Reserved */
  46. PD_DATA_VENDOR_DEF = 15,
  47. /* 16-31 Reserved */
  48. };
  49. enum pd_ext_msg_type {
  50. /* 0 Reserved */
  51. PD_EXT_SOURCE_CAP_EXT = 1,
  52. PD_EXT_STATUS = 2,
  53. PD_EXT_GET_BATT_CAP = 3,
  54. PD_EXT_GET_BATT_STATUS = 4,
  55. PD_EXT_BATT_CAP = 5,
  56. PD_EXT_GET_MANUFACTURER_INFO = 6,
  57. PD_EXT_MANUFACTURER_INFO = 7,
  58. PD_EXT_SECURITY_REQUEST = 8,
  59. PD_EXT_SECURITY_RESPONSE = 9,
  60. PD_EXT_FW_UPDATE_REQUEST = 10,
  61. PD_EXT_FW_UPDATE_RESPONSE = 11,
  62. PD_EXT_PPS_STATUS = 12,
  63. PD_EXT_COUNTRY_INFO = 13,
  64. PD_EXT_COUNTRY_CODES = 14,
  65. /* 15-31 Reserved */
  66. };
  67. #define PD_REV10 0x0
  68. #define PD_REV20 0x1
  69. #define PD_REV30 0x2
  70. #define PD_MAX_REV PD_REV30
  71. #define PD_HEADER_EXT_HDR BIT(15)
  72. #define PD_HEADER_CNT_SHIFT 12
  73. #define PD_HEADER_CNT_MASK 0x7
  74. #define PD_HEADER_ID_SHIFT 9
  75. #define PD_HEADER_ID_MASK 0x7
  76. #define PD_HEADER_PWR_ROLE BIT(8)
  77. #define PD_HEADER_REV_SHIFT 6
  78. #define PD_HEADER_REV_MASK 0x3
  79. #define PD_HEADER_DATA_ROLE BIT(5)
  80. #define PD_HEADER_TYPE_SHIFT 0
  81. #define PD_HEADER_TYPE_MASK 0x1f
  82. #define PD_HEADER(type, pwr, data, rev, id, cnt, ext_hdr) \
  83. ((((type) & PD_HEADER_TYPE_MASK) << PD_HEADER_TYPE_SHIFT) | \
  84. ((pwr) == TYPEC_SOURCE ? PD_HEADER_PWR_ROLE : 0) | \
  85. ((data) == TYPEC_HOST ? PD_HEADER_DATA_ROLE : 0) | \
  86. (rev << PD_HEADER_REV_SHIFT) | \
  87. (((id) & PD_HEADER_ID_MASK) << PD_HEADER_ID_SHIFT) | \
  88. (((cnt) & PD_HEADER_CNT_MASK) << PD_HEADER_CNT_SHIFT) | \
  89. ((ext_hdr) ? PD_HEADER_EXT_HDR : 0))
  90. #define PD_HEADER_LE(type, pwr, data, rev, id, cnt) \
  91. cpu_to_le16(PD_HEADER((type), (pwr), (data), (rev), (id), (cnt), (0)))
  92. static inline unsigned int pd_header_cnt(u16 header)
  93. {
  94. return (header >> PD_HEADER_CNT_SHIFT) & PD_HEADER_CNT_MASK;
  95. }
  96. static inline unsigned int pd_header_cnt_le(__le16 header)
  97. {
  98. return pd_header_cnt(le16_to_cpu(header));
  99. }
  100. static inline unsigned int pd_header_type(u16 header)
  101. {
  102. return (header >> PD_HEADER_TYPE_SHIFT) & PD_HEADER_TYPE_MASK;
  103. }
  104. static inline unsigned int pd_header_type_le(__le16 header)
  105. {
  106. return pd_header_type(le16_to_cpu(header));
  107. }
  108. static inline unsigned int pd_header_msgid(u16 header)
  109. {
  110. return (header >> PD_HEADER_ID_SHIFT) & PD_HEADER_ID_MASK;
  111. }
  112. static inline unsigned int pd_header_msgid_le(__le16 header)
  113. {
  114. return pd_header_msgid(le16_to_cpu(header));
  115. }
  116. static inline unsigned int pd_header_rev(u16 header)
  117. {
  118. return (header >> PD_HEADER_REV_SHIFT) & PD_HEADER_REV_MASK;
  119. }
  120. static inline unsigned int pd_header_rev_le(__le16 header)
  121. {
  122. return pd_header_rev(le16_to_cpu(header));
  123. }
  124. #define PD_EXT_HDR_CHUNKED BIT(15)
  125. #define PD_EXT_HDR_CHUNK_NUM_SHIFT 11
  126. #define PD_EXT_HDR_CHUNK_NUM_MASK 0xf
  127. #define PD_EXT_HDR_REQ_CHUNK BIT(10)
  128. #define PD_EXT_HDR_DATA_SIZE_SHIFT 0
  129. #define PD_EXT_HDR_DATA_SIZE_MASK 0x1ff
  130. #define PD_EXT_HDR(data_size, req_chunk, chunk_num, chunked) \
  131. ((((data_size) & PD_EXT_HDR_DATA_SIZE_MASK) << PD_EXT_HDR_DATA_SIZE_SHIFT) | \
  132. ((req_chunk) ? PD_EXT_HDR_REQ_CHUNK : 0) | \
  133. (((chunk_num) & PD_EXT_HDR_CHUNK_NUM_MASK) << PD_EXT_HDR_CHUNK_NUM_SHIFT) | \
  134. ((chunked) ? PD_EXT_HDR_CHUNKED : 0))
  135. #define PD_EXT_HDR_LE(data_size, req_chunk, chunk_num, chunked) \
  136. cpu_to_le16(PD_EXT_HDR((data_size), (req_chunk), (chunk_num), (chunked)))
  137. static inline unsigned int pd_ext_header_chunk_num(u16 ext_header)
  138. {
  139. return (ext_header >> PD_EXT_HDR_CHUNK_NUM_SHIFT) &
  140. PD_EXT_HDR_CHUNK_NUM_MASK;
  141. }
  142. static inline unsigned int pd_ext_header_data_size(u16 ext_header)
  143. {
  144. return (ext_header >> PD_EXT_HDR_DATA_SIZE_SHIFT) &
  145. PD_EXT_HDR_DATA_SIZE_MASK;
  146. }
  147. static inline unsigned int pd_ext_header_data_size_le(__le16 ext_header)
  148. {
  149. return pd_ext_header_data_size(le16_to_cpu(ext_header));
  150. }
  151. #define PD_MAX_PAYLOAD 7
  152. #define PD_EXT_MAX_CHUNK_DATA 26
  153. /**
  154. * struct pd_chunked_ext_message_data - PD chunked extended message data as
  155. * seen on wire
  156. * @header: PD extended message header
  157. * @data: PD extended message data
  158. */
  159. struct pd_chunked_ext_message_data {
  160. __le16 header;
  161. u8 data[PD_EXT_MAX_CHUNK_DATA];
  162. } __packed;
  163. /**
  164. * struct pd_message - PD message as seen on wire
  165. * @header: PD message header
  166. * @payload: PD message payload
  167. * @ext_msg: PD message chunked extended message data
  168. */
  169. struct pd_message {
  170. __le16 header;
  171. union {
  172. __le32 payload[PD_MAX_PAYLOAD];
  173. struct pd_chunked_ext_message_data ext_msg;
  174. };
  175. } __packed;
  176. /* PDO: Power Data Object */
  177. #define PDO_MAX_OBJECTS 7
  178. enum pd_pdo_type {
  179. PDO_TYPE_FIXED = 0,
  180. PDO_TYPE_BATT = 1,
  181. PDO_TYPE_VAR = 2,
  182. PDO_TYPE_APDO = 3,
  183. };
  184. #define PDO_TYPE_SHIFT 30
  185. #define PDO_TYPE_MASK 0x3
  186. #define PDO_TYPE(t) ((t) << PDO_TYPE_SHIFT)
  187. #define PDO_VOLT_MASK 0x3ff
  188. #define PDO_CURR_MASK 0x3ff
  189. #define PDO_PWR_MASK 0x3ff
  190. #define PDO_FIXED_DUAL_ROLE BIT(29) /* Power role swap supported */
  191. #define PDO_FIXED_SUSPEND BIT(28) /* USB Suspend supported (Source) */
  192. #define PDO_FIXED_HIGHER_CAP BIT(28) /* Requires more than vSafe5V (Sink) */
  193. #define PDO_FIXED_EXTPOWER BIT(27) /* Externally powered */
  194. #define PDO_FIXED_USB_COMM BIT(26) /* USB communications capable */
  195. #define PDO_FIXED_DATA_SWAP BIT(25) /* Data role swap supported */
  196. #define PDO_FIXED_UNCHUNK_EXT BIT(24) /* Unchunked Extended Message supported (Source) */
  197. #define PDO_FIXED_FRS_CURR_MASK (BIT(24) | BIT(23)) /* FR_Swap Current (Sink) */
  198. #define PDO_FIXED_FRS_CURR_SHIFT 23
  199. #define PDO_FIXED_VOLT_SHIFT 10 /* 50mV units */
  200. #define PDO_FIXED_CURR_SHIFT 0 /* 10mA units */
  201. #define PDO_FIXED_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT)
  202. #define PDO_FIXED_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT)
  203. #define PDO_FIXED(mv, ma, flags) \
  204. (PDO_TYPE(PDO_TYPE_FIXED) | (flags) | \
  205. PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma))
  206. #define VSAFE5V 5000 /* mv units */
  207. #define PDO_BATT_MAX_VOLT_SHIFT 20 /* 50mV units */
  208. #define PDO_BATT_MIN_VOLT_SHIFT 10 /* 50mV units */
  209. #define PDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */
  210. #define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT)
  211. #define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT)
  212. #define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT)
  213. #define PDO_BATT(min_mv, max_mv, max_mw) \
  214. (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) | \
  215. PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw))
  216. #define PDO_VAR_MAX_VOLT_SHIFT 20 /* 50mV units */
  217. #define PDO_VAR_MIN_VOLT_SHIFT 10 /* 50mV units */
  218. #define PDO_VAR_MAX_CURR_SHIFT 0 /* 10mA units */
  219. #define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT)
  220. #define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT)
  221. #define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT)
  222. #define PDO_VAR(min_mv, max_mv, max_ma) \
  223. (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) | \
  224. PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma))
  225. enum pd_apdo_type {
  226. APDO_TYPE_PPS = 0,
  227. };
  228. #define PDO_APDO_TYPE_SHIFT 28 /* Only valid value currently is 0x0 - PPS */
  229. #define PDO_APDO_TYPE_MASK 0x3
  230. #define PDO_APDO_TYPE(t) ((t) << PDO_APDO_TYPE_SHIFT)
  231. #define PDO_PPS_APDO_MAX_VOLT_SHIFT 17 /* 100mV units */
  232. #define PDO_PPS_APDO_MIN_VOLT_SHIFT 8 /* 100mV units */
  233. #define PDO_PPS_APDO_MAX_CURR_SHIFT 0 /* 50mA units */
  234. #define PDO_PPS_APDO_VOLT_MASK 0xff
  235. #define PDO_PPS_APDO_CURR_MASK 0x7f
  236. #define PDO_PPS_APDO_MIN_VOLT(mv) \
  237. ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MIN_VOLT_SHIFT)
  238. #define PDO_PPS_APDO_MAX_VOLT(mv) \
  239. ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MAX_VOLT_SHIFT)
  240. #define PDO_PPS_APDO_MAX_CURR(ma) \
  241. ((((ma) / 50) & PDO_PPS_APDO_CURR_MASK) << PDO_PPS_APDO_MAX_CURR_SHIFT)
  242. #define PDO_PPS_APDO(min_mv, max_mv, max_ma) \
  243. (PDO_TYPE(PDO_TYPE_APDO) | PDO_APDO_TYPE(APDO_TYPE_PPS) | \
  244. PDO_PPS_APDO_MIN_VOLT(min_mv) | PDO_PPS_APDO_MAX_VOLT(max_mv) | \
  245. PDO_PPS_APDO_MAX_CURR(max_ma))
  246. static inline enum pd_pdo_type pdo_type(u32 pdo)
  247. {
  248. return (pdo >> PDO_TYPE_SHIFT) & PDO_TYPE_MASK;
  249. }
  250. static inline unsigned int pdo_fixed_voltage(u32 pdo)
  251. {
  252. return ((pdo >> PDO_FIXED_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
  253. }
  254. static inline unsigned int pdo_min_voltage(u32 pdo)
  255. {
  256. return ((pdo >> PDO_VAR_MIN_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
  257. }
  258. static inline unsigned int pdo_max_voltage(u32 pdo)
  259. {
  260. return ((pdo >> PDO_VAR_MAX_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
  261. }
  262. static inline unsigned int pdo_max_current(u32 pdo)
  263. {
  264. return ((pdo >> PDO_VAR_MAX_CURR_SHIFT) & PDO_CURR_MASK) * 10;
  265. }
  266. static inline unsigned int pdo_max_power(u32 pdo)
  267. {
  268. return ((pdo >> PDO_BATT_MAX_PWR_SHIFT) & PDO_PWR_MASK) * 250;
  269. }
  270. static inline enum pd_apdo_type pdo_apdo_type(u32 pdo)
  271. {
  272. return (pdo >> PDO_APDO_TYPE_SHIFT) & PDO_APDO_TYPE_MASK;
  273. }
  274. static inline unsigned int pdo_pps_apdo_min_voltage(u32 pdo)
  275. {
  276. return ((pdo >> PDO_PPS_APDO_MIN_VOLT_SHIFT) &
  277. PDO_PPS_APDO_VOLT_MASK) * 100;
  278. }
  279. static inline unsigned int pdo_pps_apdo_max_voltage(u32 pdo)
  280. {
  281. return ((pdo >> PDO_PPS_APDO_MAX_VOLT_SHIFT) &
  282. PDO_PPS_APDO_VOLT_MASK) * 100;
  283. }
  284. static inline unsigned int pdo_pps_apdo_max_current(u32 pdo)
  285. {
  286. return ((pdo >> PDO_PPS_APDO_MAX_CURR_SHIFT) &
  287. PDO_PPS_APDO_CURR_MASK) * 50;
  288. }
  289. /* RDO: Request Data Object */
  290. #define RDO_OBJ_POS_SHIFT 28
  291. #define RDO_OBJ_POS_MASK 0x7
  292. #define RDO_GIVE_BACK BIT(27) /* Supports reduced operating current */
  293. #define RDO_CAP_MISMATCH BIT(26) /* Not satisfied by source caps */
  294. #define RDO_USB_COMM BIT(25) /* USB communications capable */
  295. #define RDO_NO_SUSPEND BIT(24) /* USB Suspend not supported */
  296. #define RDO_PWR_MASK 0x3ff
  297. #define RDO_CURR_MASK 0x3ff
  298. #define RDO_FIXED_OP_CURR_SHIFT 10
  299. #define RDO_FIXED_MAX_CURR_SHIFT 0
  300. #define RDO_OBJ(idx) (((idx) & RDO_OBJ_POS_MASK) << RDO_OBJ_POS_SHIFT)
  301. #define PDO_FIXED_OP_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_OP_CURR_SHIFT)
  302. #define PDO_FIXED_MAX_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_MAX_CURR_SHIFT)
  303. #define RDO_FIXED(idx, op_ma, max_ma, flags) \
  304. (RDO_OBJ(idx) | (flags) | \
  305. PDO_FIXED_OP_CURR(op_ma) | PDO_FIXED_MAX_CURR(max_ma))
  306. #define RDO_BATT_OP_PWR_SHIFT 10 /* 250mW units */
  307. #define RDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */
  308. #define RDO_BATT_OP_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_OP_PWR_SHIFT)
  309. #define RDO_BATT_MAX_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_MAX_PWR_SHIFT)
  310. #define RDO_BATT(idx, op_mw, max_mw, flags) \
  311. (RDO_OBJ(idx) | (flags) | \
  312. RDO_BATT_OP_PWR(op_mw) | RDO_BATT_MAX_PWR(max_mw))
  313. #define RDO_PROG_VOLT_MASK 0x7ff
  314. #define RDO_PROG_CURR_MASK 0x7f
  315. #define RDO_PROG_VOLT_SHIFT 9
  316. #define RDO_PROG_CURR_SHIFT 0
  317. #define RDO_PROG_VOLT_MV_STEP 20
  318. #define RDO_PROG_CURR_MA_STEP 50
  319. #define PDO_PROG_OUT_VOLT(mv) \
  320. ((((mv) / RDO_PROG_VOLT_MV_STEP) & RDO_PROG_VOLT_MASK) << RDO_PROG_VOLT_SHIFT)
  321. #define PDO_PROG_OP_CURR(ma) \
  322. ((((ma) / RDO_PROG_CURR_MA_STEP) & RDO_PROG_CURR_MASK) << RDO_PROG_CURR_SHIFT)
  323. #define RDO_PROG(idx, out_mv, op_ma, flags) \
  324. (RDO_OBJ(idx) | (flags) | \
  325. PDO_PROG_OUT_VOLT(out_mv) | PDO_PROG_OP_CURR(op_ma))
  326. static inline unsigned int rdo_index(u32 rdo)
  327. {
  328. return (rdo >> RDO_OBJ_POS_SHIFT) & RDO_OBJ_POS_MASK;
  329. }
  330. static inline unsigned int rdo_op_current(u32 rdo)
  331. {
  332. return ((rdo >> RDO_FIXED_OP_CURR_SHIFT) & RDO_CURR_MASK) * 10;
  333. }
  334. static inline unsigned int rdo_max_current(u32 rdo)
  335. {
  336. return ((rdo >> RDO_FIXED_MAX_CURR_SHIFT) &
  337. RDO_CURR_MASK) * 10;
  338. }
  339. static inline unsigned int rdo_op_power(u32 rdo)
  340. {
  341. return ((rdo >> RDO_BATT_OP_PWR_SHIFT) & RDO_PWR_MASK) * 250;
  342. }
  343. static inline unsigned int rdo_max_power(u32 rdo)
  344. {
  345. return ((rdo >> RDO_BATT_MAX_PWR_SHIFT) & RDO_PWR_MASK) * 250;
  346. }
  347. /* Enter_USB Data Object */
  348. #define EUDO_USB_MODE_MASK GENMASK(30, 28)
  349. #define EUDO_USB_MODE_SHIFT 28
  350. #define EUDO_USB_MODE_USB2 0
  351. #define EUDO_USB_MODE_USB3 1
  352. #define EUDO_USB_MODE_USB4 2
  353. #define EUDO_USB4_DRD BIT(26)
  354. #define EUDO_USB3_DRD BIT(25)
  355. #define EUDO_CABLE_SPEED_MASK GENMASK(23, 21)
  356. #define EUDO_CABLE_SPEED_SHIFT 21
  357. #define EUDO_CABLE_SPEED_USB2 0
  358. #define EUDO_CABLE_SPEED_USB3_GEN1 1
  359. #define EUDO_CABLE_SPEED_USB4_GEN2 2
  360. #define EUDO_CABLE_SPEED_USB4_GEN3 3
  361. #define EUDO_CABLE_TYPE_MASK GENMASK(20, 19)
  362. #define EUDO_CABLE_TYPE_SHIFT 19
  363. #define EUDO_CABLE_TYPE_PASSIVE 0
  364. #define EUDO_CABLE_TYPE_RE_TIMER 1
  365. #define EUDO_CABLE_TYPE_RE_DRIVER 2
  366. #define EUDO_CABLE_TYPE_OPTICAL 3
  367. #define EUDO_CABLE_CURRENT_MASK GENMASK(18, 17)
  368. #define EUDO_CABLE_CURRENT_SHIFT 17
  369. #define EUDO_CABLE_CURRENT_NOTSUPP 0
  370. #define EUDO_CABLE_CURRENT_3A 2
  371. #define EUDO_CABLE_CURRENT_5A 3
  372. #define EUDO_PCIE_SUPPORT BIT(16)
  373. #define EUDO_DP_SUPPORT BIT(15)
  374. #define EUDO_TBT_SUPPORT BIT(14)
  375. #define EUDO_HOST_PRESENT BIT(13)
  376. /* USB PD timers and counters */
  377. #define PD_T_NO_RESPONSE 5000 /* 4.5 - 5.5 seconds */
  378. #define PD_T_DB_DETECT 10000 /* 10 - 15 seconds */
  379. #define PD_T_SEND_SOURCE_CAP 150 /* 100 - 200 ms */
  380. #define PD_T_SENDER_RESPONSE 60 /* 24 - 30 ms, relaxed */
  381. #define PD_T_RECEIVER_RESPONSE 15 /* 15ms max */
  382. #define PD_T_SOURCE_ACTIVITY 45
  383. #define PD_T_SINK_ACTIVITY 135
  384. #define PD_T_SINK_WAIT_CAP 310 /* 310 - 620 ms */
  385. #define PD_T_PS_TRANSITION 500
  386. #define PD_T_SRC_TRANSITION 35
  387. #define PD_T_DRP_SNK 40
  388. #define PD_T_DRP_SRC 30
  389. #define PD_T_PS_SOURCE_OFF 920
  390. #define PD_T_PS_SOURCE_ON 480
  391. #define PD_T_PS_SOURCE_ON_PRS 450 /* 390 - 480ms */
  392. #define PD_T_PS_HARD_RESET 30
  393. #define PD_T_SRC_RECOVER 760
  394. #define PD_T_SRC_RECOVER_MAX 1000
  395. #define PD_T_SRC_TURN_ON 275
  396. #define PD_T_SAFE_0V 650
  397. #define PD_T_VCONN_SOURCE_ON 100
  398. #define PD_T_SINK_REQUEST 100 /* 100 ms minimum */
  399. #define PD_T_ERROR_RECOVERY 100 /* minimum 25 is insufficient */
  400. #define PD_T_SRCSWAPSTDBY 625 /* Maximum of 650ms */
  401. #define PD_T_NEWSRC 250 /* Maximum of 275ms */
  402. #define PD_T_SWAP_SRC_START 20 /* Minimum of 20ms */
  403. #define PD_T_BIST_CONT_MODE 50 /* 30 - 60 ms */
  404. #define PD_T_SINK_TX 16 /* 16 - 20 ms */
  405. #define PD_T_CHUNK_NOT_SUPP 42 /* 40 - 50 ms */
  406. #define PD_T_DRP_TRY 100 /* 75 - 150 ms */
  407. #define PD_T_DRP_TRYWAIT 600 /* 400 - 800 ms */
  408. #define PD_T_CC_DEBOUNCE 200 /* 100 - 200 ms */
  409. #define PD_T_PD_DEBOUNCE 20 /* 10 - 20 ms */
  410. #define PD_T_TRY_CC_DEBOUNCE 15 /* 10 - 20 ms */
  411. #define PD_N_CAPS_COUNT (PD_T_NO_RESPONSE / PD_T_SEND_SOURCE_CAP)
  412. #define PD_N_HARD_RESET_COUNT 2
  413. #define PD_P_SNK_STDBY_MW 2500 /* 2500 mW */
  414. #if IS_ENABLED(CONFIG_TYPEC)
  415. struct usb_power_delivery;
  416. /**
  417. * usb_power_delivery_desc - USB Power Delivery Descriptor
  418. * @revision: USB Power Delivery Specification Revision
  419. * @version: USB Power Delivery Specicication Version - optional
  420. */
  421. struct usb_power_delivery_desc {
  422. u16 revision;
  423. u16 version;
  424. };
  425. /**
  426. * usb_power_delivery_capabilities_desc - Description of USB Power Delivery Capabilities Message
  427. * @pdo: The Power Data Objects in the Capability Message
  428. * @role: Power role of the capabilities
  429. */
  430. struct usb_power_delivery_capabilities_desc {
  431. u32 pdo[PDO_MAX_OBJECTS];
  432. enum typec_role role;
  433. };
  434. struct usb_power_delivery_capabilities *
  435. usb_power_delivery_register_capabilities(struct usb_power_delivery *pd,
  436. struct usb_power_delivery_capabilities_desc *desc);
  437. void usb_power_delivery_unregister_capabilities(struct usb_power_delivery_capabilities *cap);
  438. struct usb_power_delivery *usb_power_delivery_register(struct device *parent,
  439. struct usb_power_delivery_desc *desc);
  440. void usb_power_delivery_unregister(struct usb_power_delivery *pd);
  441. int usb_power_delivery_link_device(struct usb_power_delivery *pd, struct device *dev);
  442. void usb_power_delivery_unlink_device(struct usb_power_delivery *pd, struct device *dev);
  443. #endif /* CONFIG_TYPEC */
  444. #endif /* __LINUX_USB_PD_H */