zynqmp_firmware.h 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * Xilinx Zynq MPSoC Firmware driver
  4. *
  5. * Copyright (C) 2018-2019 Xilinx, Inc.
  6. */
  7. #ifndef _ZYNQMP_FIRMWARE_H_
  8. #define _ZYNQMP_FIRMWARE_H_
  9. enum pm_api_id {
  10. PM_GET_API_VERSION = 1,
  11. PM_SET_CONFIGURATION = 2,
  12. PM_GET_NODE_STATUS = 3,
  13. PM_GET_OPERATING_CHARACTERISTIC = 4,
  14. PM_REGISTER_NOTIFIER = 5,
  15. /* API for suspending */
  16. PM_REQUEST_SUSPEND = 6,
  17. PM_SELF_SUSPEND = 7,
  18. PM_FORCE_POWERDOWN = 8,
  19. PM_ABORT_SUSPEND = 9,
  20. PM_REQUEST_WAKEUP = 10,
  21. PM_SET_WAKEUP_SOURCE = 11,
  22. PM_SYSTEM_SHUTDOWN = 12,
  23. PM_REQUEST_NODE = 13,
  24. PM_RELEASE_NODE = 14,
  25. PM_SET_REQUIREMENT = 15,
  26. PM_SET_MAX_LATENCY = 16,
  27. /* Direct control API functions: */
  28. PM_RESET_ASSERT = 17,
  29. PM_RESET_GET_STATUS = 18,
  30. PM_MMIO_WRITE = 19,
  31. PM_MMIO_READ = 20,
  32. PM_PM_INIT_FINALIZE = 21,
  33. PM_FPGA_LOAD = 22,
  34. PM_FPGA_GET_STATUS = 23,
  35. PM_GET_CHIPID = 24,
  36. /* ID 25 is been used by U-boot to process secure boot images */
  37. /* Secure library generic API functions */
  38. PM_SECURE_SHA = 26,
  39. PM_SECURE_RSA = 27,
  40. PM_PINCTRL_REQUEST = 28,
  41. PM_PINCTRL_RELEASE = 29,
  42. PM_PINCTRL_GET_FUNCTION = 30,
  43. PM_PINCTRL_SET_FUNCTION = 31,
  44. PM_PINCTRL_CONFIG_PARAM_GET = 32,
  45. PM_PINCTRL_CONFIG_PARAM_SET = 33,
  46. PM_IOCTL = 34,
  47. PM_QUERY_DATA = 35,
  48. PM_CLOCK_ENABLE = 36,
  49. PM_CLOCK_DISABLE = 37,
  50. PM_CLOCK_GETSTATE = 38,
  51. PM_CLOCK_SETDIVIDER = 39,
  52. PM_CLOCK_GETDIVIDER = 40,
  53. PM_CLOCK_SETRATE = 41,
  54. PM_CLOCK_GETRATE = 42,
  55. PM_CLOCK_SETPARENT = 43,
  56. PM_CLOCK_GETPARENT = 44,
  57. PM_SECURE_IMAGE = 45,
  58. PM_FPGA_READ = 46,
  59. PM_SECURE_AES = 47,
  60. PM_CLOCK_PLL_GETPARAM = 49,
  61. /* PM_REGISTER_ACCESS API */
  62. PM_REGISTER_ACCESS = 52,
  63. PM_EFUSE_ACCESS = 53,
  64. PM_FEATURE_CHECK = 63,
  65. PM_API_MAX,
  66. };
  67. enum pm_node_id {
  68. NODE_UNKNOWN = 0,
  69. NODE_APU = 1,
  70. NODE_APU_0 = 2,
  71. NODE_APU_1 = 3,
  72. NODE_APU_2 = 4,
  73. NODE_APU_3 = 5,
  74. NODE_RPU = 6,
  75. NODE_RPU_0 = 7,
  76. NODE_RPU_1 = 8,
  77. NODE_PLD = 9,
  78. NODE_FPD = 10,
  79. NODE_OCM_BANK_0 = 11,
  80. NODE_OCM_BANK_1 = 12,
  81. NODE_OCM_BANK_2 = 13,
  82. NODE_OCM_BANK_3 = 14,
  83. NODE_TCM_0_A = 15,
  84. NODE_TCM_0_B = 16,
  85. NODE_TCM_1_A = 17,
  86. NODE_TCM_1_B = 18,
  87. NODE_L2 = 19,
  88. NODE_GPU_PP_0 = 20,
  89. NODE_GPU_PP_1 = 21,
  90. NODE_USB_0 = 22,
  91. NODE_USB_1 = 23,
  92. NODE_TTC_0 = 24,
  93. NODE_TTC_1 = 25,
  94. NODE_TTC_2 = 26,
  95. NODE_TTC_3 = 27,
  96. NODE_SATA = 28,
  97. NODE_ETH_0 = 29,
  98. NODE_ETH_1 = 30,
  99. NODE_ETH_2 = 31,
  100. NODE_ETH_3 = 32,
  101. NODE_UART_0 = 33,
  102. NODE_UART_1 = 34,
  103. NODE_SPI_0 = 35,
  104. NODE_SPI_1 = 36,
  105. NODE_I2C_0 = 37,
  106. NODE_I2C_1 = 38,
  107. NODE_SD_0 = 39,
  108. NODE_SD_1 = 40,
  109. NODE_DP = 41,
  110. NODE_GDMA = 42,
  111. NODE_ADMA = 43,
  112. NODE_NAND = 44,
  113. NODE_QSPI = 45,
  114. NODE_GPIO = 46,
  115. NODE_CAN_0 = 47,
  116. NODE_CAN_1 = 48,
  117. NODE_EXTERN = 49,
  118. NODE_APLL = 50,
  119. NODE_VPLL = 51,
  120. NODE_DPLL = 52,
  121. NODE_RPLL = 53,
  122. NODE_IOPLL = 54,
  123. NODE_DDR = 55,
  124. NODE_IPI_APU = 56,
  125. NODE_IPI_RPU_0 = 57,
  126. NODE_GPU = 58,
  127. NODE_PCIE = 59,
  128. NODE_PCAP = 60,
  129. NODE_RTC = 61,
  130. NODE_LPD = 62,
  131. NODE_VCU = 63,
  132. NODE_IPI_RPU_1 = 64,
  133. NODE_IPI_PL_0 = 65,
  134. NODE_IPI_PL_1 = 66,
  135. NODE_IPI_PL_2 = 67,
  136. NODE_IPI_PL_3 = 68,
  137. NODE_PL = 69,
  138. NODE_GEM_TSU = 70,
  139. NODE_SWDT_0 = 71,
  140. NODE_SWDT_1 = 72,
  141. NODE_CSU = 73,
  142. NODE_PJTAG = 74,
  143. NODE_TRACE = 75,
  144. NODE_TESTSCAN = 76,
  145. NODE_PMU = 77,
  146. NODE_MAX = 78,
  147. };
  148. enum tap_delay_type {
  149. PM_TAPDELAY_INPUT = 0,
  150. PM_TAPDELAY_OUTPUT = 1,
  151. };
  152. enum dll_reset_type {
  153. PM_DLL_RESET_ASSERT = 0,
  154. PM_DLL_RESET_RELEASE = 1,
  155. PM_DLL_RESET_PULSE = 2,
  156. };
  157. enum pm_query_id {
  158. PM_QID_INVALID = 0,
  159. PM_QID_CLOCK_GET_NAME = 1,
  160. PM_QID_CLOCK_GET_TOPOLOGY = 2,
  161. PM_QID_CLOCK_GET_FIXEDFACTOR_PARAMS = 3,
  162. PM_QID_CLOCK_GET_PARENTS = 4,
  163. PM_QID_CLOCK_GET_ATTRIBUTES = 5,
  164. PM_QID_PINCTRL_GET_NUM_PINS = 6,
  165. PM_QID_PINCTRL_GET_NUM_FUNCTIONS = 7,
  166. PM_QID_PINCTRL_GET_NUM_FUNCTION_GROUPS = 8,
  167. PM_QID_PINCTRL_GET_FUNCTION_NAME = 9,
  168. PM_QID_PINCTRL_GET_FUNCTION_GROUPS = 10,
  169. PM_QID_PINCTRL_GET_PIN_GROUPS = 11,
  170. PM_QID_CLOCK_GET_NUM_CLOCKS = 12,
  171. PM_QID_CLOCK_GET_MAX_DIVISOR = 13,
  172. };
  173. enum zynqmp_pm_reset_action {
  174. PM_RESET_ACTION_RELEASE = 0,
  175. PM_RESET_ACTION_ASSERT = 1,
  176. PM_RESET_ACTION_PULSE = 2,
  177. };
  178. enum zynqmp_pm_reset {
  179. ZYNQMP_PM_RESET_START = 1000,
  180. ZYNQMP_PM_RESET_PCIE_CFG = ZYNQMP_PM_RESET_START,
  181. ZYNQMP_PM_RESET_PCIE_BRIDGE = 1001,
  182. ZYNQMP_PM_RESET_PCIE_CTRL = 1002,
  183. ZYNQMP_PM_RESET_DP = 1003,
  184. ZYNQMP_PM_RESET_SWDT_CRF = 1004,
  185. ZYNQMP_PM_RESET_AFI_FM5 = 1005,
  186. ZYNQMP_PM_RESET_AFI_FM4 = 1006,
  187. ZYNQMP_PM_RESET_AFI_FM3 = 1007,
  188. ZYNQMP_PM_RESET_AFI_FM2 = 1008,
  189. ZYNQMP_PM_RESET_AFI_FM1 = 1009,
  190. ZYNQMP_PM_RESET_AFI_FM0 = 1010,
  191. ZYNQMP_PM_RESET_GDMA = 1011,
  192. ZYNQMP_PM_RESET_GPU_PP1 = 1012,
  193. ZYNQMP_PM_RESET_GPU_PP0 = 1013,
  194. ZYNQMP_PM_RESET_GPU = 1014,
  195. ZYNQMP_PM_RESET_GT = 1015,
  196. ZYNQMP_PM_RESET_SATA = 1016,
  197. ZYNQMP_PM_RESET_ACPU3_PWRON = 1017,
  198. ZYNQMP_PM_RESET_ACPU2_PWRON = 1018,
  199. ZYNQMP_PM_RESET_ACPU1_PWRON = 1019,
  200. ZYNQMP_PM_RESET_ACPU0_PWRON = 1020,
  201. ZYNQMP_PM_RESET_APU_L2 = 1021,
  202. ZYNQMP_PM_RESET_ACPU3 = 1022,
  203. ZYNQMP_PM_RESET_ACPU2 = 1023,
  204. ZYNQMP_PM_RESET_ACPU1 = 1024,
  205. ZYNQMP_PM_RESET_ACPU0 = 1025,
  206. ZYNQMP_PM_RESET_DDR = 1026,
  207. ZYNQMP_PM_RESET_APM_FPD = 1027,
  208. ZYNQMP_PM_RESET_SOFT = 1028,
  209. ZYNQMP_PM_RESET_GEM0 = 1029,
  210. ZYNQMP_PM_RESET_GEM1 = 1030,
  211. ZYNQMP_PM_RESET_GEM2 = 1031,
  212. ZYNQMP_PM_RESET_GEM3 = 1032,
  213. ZYNQMP_PM_RESET_QSPI = 1033,
  214. ZYNQMP_PM_RESET_UART0 = 1034,
  215. ZYNQMP_PM_RESET_UART1 = 1035,
  216. ZYNQMP_PM_RESET_SPI0 = 1036,
  217. ZYNQMP_PM_RESET_SPI1 = 1037,
  218. ZYNQMP_PM_RESET_SDIO0 = 1038,
  219. ZYNQMP_PM_RESET_SDIO1 = 1039,
  220. ZYNQMP_PM_RESET_CAN0 = 1040,
  221. ZYNQMP_PM_RESET_CAN1 = 1041,
  222. ZYNQMP_PM_RESET_I2C0 = 1042,
  223. ZYNQMP_PM_RESET_I2C1 = 1043,
  224. ZYNQMP_PM_RESET_TTC0 = 1044,
  225. ZYNQMP_PM_RESET_TTC1 = 1045,
  226. ZYNQMP_PM_RESET_TTC2 = 1046,
  227. ZYNQMP_PM_RESET_TTC3 = 1047,
  228. ZYNQMP_PM_RESET_SWDT_CRL = 1048,
  229. ZYNQMP_PM_RESET_NAND = 1049,
  230. ZYNQMP_PM_RESET_ADMA = 1050,
  231. ZYNQMP_PM_RESET_GPIO = 1051,
  232. ZYNQMP_PM_RESET_IOU_CC = 1052,
  233. ZYNQMP_PM_RESET_TIMESTAMP = 1053,
  234. ZYNQMP_PM_RESET_RPU_R50 = 1054,
  235. ZYNQMP_PM_RESET_RPU_R51 = 1055,
  236. ZYNQMP_PM_RESET_RPU_AMBA = 1056,
  237. ZYNQMP_PM_RESET_OCM = 1057,
  238. ZYNQMP_PM_RESET_RPU_PGE = 1058,
  239. ZYNQMP_PM_RESET_USB0_CORERESET = 1059,
  240. ZYNQMP_PM_RESET_USB1_CORERESET = 1060,
  241. ZYNQMP_PM_RESET_USB0_HIBERRESET = 1061,
  242. ZYNQMP_PM_RESET_USB1_HIBERRESET = 1062,
  243. ZYNQMP_PM_RESET_USB0_APB = 1063,
  244. ZYNQMP_PM_RESET_USB1_APB = 1064,
  245. ZYNQMP_PM_RESET_IPI = 1065,
  246. ZYNQMP_PM_RESET_APM_LPD = 1066,
  247. ZYNQMP_PM_RESET_RTC = 1067,
  248. ZYNQMP_PM_RESET_SYSMON = 1068,
  249. ZYNQMP_PM_RESET_AFI_FM6 = 1069,
  250. ZYNQMP_PM_RESET_LPD_SWDT = 1070,
  251. ZYNQMP_PM_RESET_FPD = 1071,
  252. ZYNQMP_PM_RESET_RPU_DBG1 = 1072,
  253. ZYNQMP_PM_RESET_RPU_DBG0 = 1073,
  254. ZYNQMP_PM_RESET_DBG_LPD = 1074,
  255. ZYNQMP_PM_RESET_DBG_FPD = 1075,
  256. ZYNQMP_PM_RESET_APLL = 1076,
  257. ZYNQMP_PM_RESET_DPLL = 1077,
  258. ZYNQMP_PM_RESET_VPLL = 1078,
  259. ZYNQMP_PM_RESET_IOPLL = 1079,
  260. ZYNQMP_PM_RESET_RPLL = 1080,
  261. ZYNQMP_PM_RESET_GPO3_PL_0 = 1081,
  262. ZYNQMP_PM_RESET_GPO3_PL_1 = 1082,
  263. ZYNQMP_PM_RESET_GPO3_PL_2 = 1083,
  264. ZYNQMP_PM_RESET_GPO3_PL_3 = 1084,
  265. ZYNQMP_PM_RESET_GPO3_PL_4 = 1085,
  266. ZYNQMP_PM_RESET_GPO3_PL_5 = 1086,
  267. ZYNQMP_PM_RESET_GPO3_PL_6 = 1087,
  268. ZYNQMP_PM_RESET_GPO3_PL_7 = 1088,
  269. ZYNQMP_PM_RESET_GPO3_PL_8 = 1089,
  270. ZYNQMP_PM_RESET_GPO3_PL_9 = 1090,
  271. ZYNQMP_PM_RESET_GPO3_PL_10 = 1091,
  272. ZYNQMP_PM_RESET_GPO3_PL_11 = 1092,
  273. ZYNQMP_PM_RESET_GPO3_PL_12 = 1093,
  274. ZYNQMP_PM_RESET_GPO3_PL_13 = 1094,
  275. ZYNQMP_PM_RESET_GPO3_PL_14 = 1095,
  276. ZYNQMP_PM_RESET_GPO3_PL_15 = 1096,
  277. ZYNQMP_PM_RESET_GPO3_PL_16 = 1097,
  278. ZYNQMP_PM_RESET_GPO3_PL_17 = 1098,
  279. ZYNQMP_PM_RESET_GPO3_PL_18 = 1099,
  280. ZYNQMP_PM_RESET_GPO3_PL_19 = 1100,
  281. ZYNQMP_PM_RESET_GPO3_PL_20 = 1101,
  282. ZYNQMP_PM_RESET_GPO3_PL_21 = 1102,
  283. ZYNQMP_PM_RESET_GPO3_PL_22 = 1103,
  284. ZYNQMP_PM_RESET_GPO3_PL_23 = 1104,
  285. ZYNQMP_PM_RESET_GPO3_PL_24 = 1105,
  286. ZYNQMP_PM_RESET_GPO3_PL_25 = 1106,
  287. ZYNQMP_PM_RESET_GPO3_PL_26 = 1107,
  288. ZYNQMP_PM_RESET_GPO3_PL_27 = 1108,
  289. ZYNQMP_PM_RESET_GPO3_PL_28 = 1109,
  290. ZYNQMP_PM_RESET_GPO3_PL_29 = 1110,
  291. ZYNQMP_PM_RESET_GPO3_PL_30 = 1111,
  292. ZYNQMP_PM_RESET_GPO3_PL_31 = 1112,
  293. ZYNQMP_PM_RESET_RPU_LS = 1113,
  294. ZYNQMP_PM_RESET_PS_ONLY = 1114,
  295. ZYNQMP_PM_RESET_PL = 1115,
  296. ZYNQMP_PM_RESET_PS_PL0 = 1116,
  297. ZYNQMP_PM_RESET_PS_PL1 = 1117,
  298. ZYNQMP_PM_RESET_PS_PL2 = 1118,
  299. ZYNQMP_PM_RESET_PS_PL3 = 1119,
  300. ZYNQMP_PM_RESET_END = ZYNQMP_PM_RESET_PS_PL3
  301. };
  302. enum pm_ioctl_id {
  303. IOCTL_GET_RPU_OPER_MODE = 0,
  304. IOCTL_SET_RPU_OPER_MODE = 1,
  305. IOCTL_RPU_BOOT_ADDR_CONFIG = 2,
  306. IOCTL_TCM_COMB_CONFIG = 3,
  307. IOCTL_SET_TAPDELAY_BYPASS = 4,
  308. IOCTL_SET_SGMII_MODE = 5,
  309. IOCTL_SD_DLL_RESET = 6,
  310. IOCTL_SET_SD_TAPDELAY = 7,
  311. IOCTL_SET_PLL_FRAC_MODE = 8,
  312. IOCTL_GET_PLL_FRAC_MODE = 9,
  313. IOCTL_SET_PLL_FRAC_DATA = 10,
  314. IOCTL_GET_PLL_FRAC_DATA = 11,
  315. IOCTL_WRITE_GGS = 12,
  316. IOCTL_READ_GGS = 13,
  317. IOCTL_WRITE_PGGS = 14,
  318. IOCTL_READ_PGGS = 15,
  319. /* IOCTL for ULPI reset */
  320. IOCTL_ULPI_RESET = 16,
  321. /* Set healthy bit value*/
  322. IOCTL_SET_BOOT_HEALTH_STATUS = 17,
  323. IOCTL_AFI = 18,
  324. /* Probe counter read/write */
  325. IOCTL_PROBE_COUNTER_READ = 19,
  326. IOCTL_PROBE_COUNTER_WRITE = 20,
  327. IOCTL_OSPI_MUX_SELECT = 21,
  328. /* IOCTL for USB power request */
  329. IOCTL_USB_SET_STATE = 22,
  330. /* IOCTL to get last reset reason */
  331. IOCTL_GET_LAST_RESET_REASON = 23,
  332. /* AIE ISR Clear */
  333. IOCTL_AIE_ISR_CLEAR = 24,
  334. };
  335. #define PM_SIP_SVC 0xc2000000
  336. #define ZYNQMP_PM_VERSION_MAJOR 1
  337. #define ZYNQMP_PM_VERSION_MINOR 0
  338. #define ZYNQMP_PM_VERSION_MAJOR_SHIFT 16
  339. #define ZYNQMP_PM_VERSION_MINOR_MASK 0xFFFF
  340. #define ZYNQMP_PM_VERSION \
  341. ((ZYNQMP_PM_VERSION_MAJOR << ZYNQMP_PM_VERSION_MAJOR_SHIFT) | \
  342. ZYNQMP_PM_VERSION_MINOR)
  343. #define ZYNQMP_PM_VERSION_INVALID ~0
  344. #define PMUFW_V1_0 ((1 << ZYNQMP_PM_VERSION_MAJOR_SHIFT) | 0)
  345. /*
  346. * Return payload size
  347. * Not every firmware call expects the same amount of return bytes, however the
  348. * firmware driver always copies 5 bytes from RX buffer to the ret_payload
  349. * buffer. Therefore allocating with this defined value is recommended to avoid
  350. * overflows.
  351. */
  352. #define PAYLOAD_ARG_CNT 5U
  353. unsigned int zynqmp_firmware_version(void);
  354. void zynqmp_pmufw_load_config_object(const void *cfg_obj, size_t size);
  355. int xilinx_pm_request(u32 api_id, u32 arg0, u32 arg1, u32 arg2,
  356. u32 arg3, u32 *ret_payload);
  357. #endif /* _ZYNQMP_FIRMWARE_H_ */