k3-sec-proxy.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Texas Instruments' K3 Secure proxy Driver
  4. *
  5. * Copyright (C) 2017-2018 Texas Instruments Incorporated - http://www.ti.com/
  6. * Lokesh Vutla <lokeshvutla@ti.com>
  7. */
  8. #include <common.h>
  9. #include <malloc.h>
  10. #include <asm/io.h>
  11. #include <dm/device_compat.h>
  12. #include <linux/types.h>
  13. #include <linux/bitops.h>
  14. #include <linux/soc/ti/k3-sec-proxy.h>
  15. #include <dm.h>
  16. #include <mailbox-uclass.h>
  17. DECLARE_GLOBAL_DATA_PTR;
  18. /* SEC PROXY RT THREAD STATUS */
  19. #define RT_THREAD_STATUS 0x0
  20. #define RT_THREAD_THRESHOLD 0x4
  21. #define RT_THREAD_STATUS_ERROR_SHIFT 31
  22. #define RT_THREAD_STATUS_ERROR_MASK BIT(31)
  23. #define RT_THREAD_STATUS_CUR_CNT_SHIFT 0
  24. #define RT_THREAD_STATUS_CUR_CNT_MASK GENMASK(7, 0)
  25. /* SEC PROXY SCFG THREAD CTRL */
  26. #define SCFG_THREAD_CTRL 0x1000
  27. #define SCFG_THREAD_CTRL_DIR_SHIFT 31
  28. #define SCFG_THREAD_CTRL_DIR_MASK BIT(31)
  29. #define SEC_PROXY_THREAD(base, x) ((base) + (0x1000 * (x)))
  30. #define THREAD_IS_RX 1
  31. #define THREAD_IS_TX 0
  32. /**
  33. * struct k3_sec_proxy_desc - Description of secure proxy integration.
  34. * @thread_count: Number of Threads.
  35. * @max_msg_size: Message size in bytes.
  36. * @data_start_offset: Offset of the First data register of the thread
  37. * @data_end_offset: Offset of the Last data register of the thread
  38. * @valid_threads: List of Valid threads that the processor can access
  39. * @num_valid_threads: Number of valid threads.
  40. */
  41. struct k3_sec_proxy_desc {
  42. u16 thread_count;
  43. u16 max_msg_size;
  44. u16 data_start_offset;
  45. u16 data_end_offset;
  46. const u32 *valid_threads;
  47. u32 num_valid_threads;
  48. };
  49. /**
  50. * struct k3_sec_proxy_thread - Description of a secure proxy Thread
  51. * @id: Thread ID
  52. * @data: Thread Data path region for target
  53. * @scfg: Secure Config Region for Thread
  54. * @rt: RealTime Region for Thread
  55. * @rx_buf: Receive buffer data, max message size.
  56. */
  57. struct k3_sec_proxy_thread {
  58. u32 id;
  59. void __iomem *data;
  60. void __iomem *scfg;
  61. void __iomem *rt;
  62. u32 *rx_buf;
  63. };
  64. /**
  65. * struct k3_sec_proxy_mbox - Description of a Secure Proxy Instance
  66. * @chan: Mailbox Channel
  67. * @desc: Description of the SoC integration
  68. * @chans: Array for valid thread instances
  69. * @target_data: Secure Proxy region for Target Data
  70. * @scfg: Secure Proxy Region for Secure configuration.
  71. * @rt: Secure proxy Region for Real Time Region.
  72. */
  73. struct k3_sec_proxy_mbox {
  74. struct mbox_chan chan;
  75. struct k3_sec_proxy_desc *desc;
  76. struct k3_sec_proxy_thread *chans;
  77. phys_addr_t target_data;
  78. phys_addr_t scfg;
  79. phys_addr_t rt;
  80. };
  81. static inline u32 sp_readl(void __iomem *addr, unsigned int offset)
  82. {
  83. return readl(addr + offset);
  84. }
  85. static inline void sp_writel(void __iomem *addr, unsigned int offset, u32 data)
  86. {
  87. writel(data, addr + offset);
  88. }
  89. /**
  90. * k3_sec_proxy_of_xlate() - Translation of phandle to channel
  91. * @chan: Mailbox channel
  92. * @args: Phandle Pointer
  93. *
  94. * Translates the phandle args and fills up the Mailbox channel from client.
  95. * Return: 0 if all goes good, else return corresponding error message.
  96. */
  97. static int k3_sec_proxy_of_xlate(struct mbox_chan *chan,
  98. struct ofnode_phandle_args *args)
  99. {
  100. struct k3_sec_proxy_mbox *spm = dev_get_priv(chan->dev);
  101. int ind, i;
  102. debug("%s(chan=%p)\n", __func__, chan);
  103. if (args->args_count != 1) {
  104. debug("Invaild args_count: %d\n", args->args_count);
  105. return -EINVAL;
  106. }
  107. ind = args->args[0];
  108. for (i = 0; i < spm->desc->num_valid_threads; i++)
  109. if (spm->chans[i].id == ind) {
  110. chan->id = ind;
  111. chan->con_priv = &spm->chans[i];
  112. return 0;
  113. }
  114. dev_err(chan->dev, "%s: Invalid Thread ID %d\n", __func__, ind);
  115. return -ENOENT;
  116. }
  117. /**
  118. * k3_sec_proxy_request() - Request for mailbox channel
  119. * @chan: Channel Pointer
  120. */
  121. static int k3_sec_proxy_request(struct mbox_chan *chan)
  122. {
  123. debug("%s(chan=%p)\n", __func__, chan);
  124. return 0;
  125. }
  126. /**
  127. * k3_sec_proxy_free() - Free the mailbox channel
  128. * @chan: Channel Pointer
  129. */
  130. static int k3_sec_proxy_free(struct mbox_chan *chan)
  131. {
  132. debug("%s(chan=%p)\n", __func__, chan);
  133. return 0;
  134. }
  135. /**
  136. * k3_sec_proxy_verify_thread() - Verify thread status before
  137. * sending/receiving data.
  138. * @spt: pointer to secure proxy thread description
  139. * @dir: Direction of the thread
  140. *
  141. * Return: 0 if all goes good, else appropriate error message.
  142. */
  143. static inline int k3_sec_proxy_verify_thread(struct k3_sec_proxy_thread *spt,
  144. u8 dir)
  145. {
  146. /* Check for any errors already available */
  147. if (sp_readl(spt->rt, RT_THREAD_STATUS) &
  148. RT_THREAD_STATUS_ERROR_MASK) {
  149. printf("%s: Thread %d is corrupted, cannot send data.\n",
  150. __func__, spt->id);
  151. return -EINVAL;
  152. }
  153. /* Make sure thread is configured for right direction */
  154. if ((sp_readl(spt->scfg, SCFG_THREAD_CTRL)
  155. & SCFG_THREAD_CTRL_DIR_MASK) >> SCFG_THREAD_CTRL_DIR_SHIFT != dir) {
  156. if (dir)
  157. printf("%s: Trying to receive data on tx Thread %d\n",
  158. __func__, spt->id);
  159. else
  160. printf("%s: Trying to send data on rx Thread %d\n",
  161. __func__, spt->id);
  162. return -EINVAL;
  163. }
  164. /* Check the message queue before sending/receiving data */
  165. if (!(sp_readl(spt->rt, RT_THREAD_STATUS) &
  166. RT_THREAD_STATUS_CUR_CNT_MASK))
  167. return -ENODATA;
  168. return 0;
  169. }
  170. /**
  171. * k3_sec_proxy_send() - Send data via mailbox channel
  172. * @chan: Channel Pointer
  173. * @data: Pointer to k3_sec_proxy_msg
  174. *
  175. * Return: 0 if all goes good, else appropriate error message.
  176. */
  177. static int k3_sec_proxy_send(struct mbox_chan *chan, const void *data)
  178. {
  179. const struct k3_sec_proxy_msg *msg = (struct k3_sec_proxy_msg *)data;
  180. struct k3_sec_proxy_mbox *spm = dev_get_priv(chan->dev);
  181. struct k3_sec_proxy_thread *spt = chan->con_priv;
  182. int num_words, trail_bytes, ret;
  183. void __iomem *data_reg;
  184. u32 *word_data;
  185. debug("%s(chan=%p, data=%p)\n", __func__, chan, data);
  186. ret = k3_sec_proxy_verify_thread(spt, THREAD_IS_TX);
  187. if (ret) {
  188. dev_err(dev, "%s: Thread%d verification failed. ret = %d\n",
  189. __func__, spt->id, ret);
  190. return ret;
  191. }
  192. /* Check the message size. */
  193. if (msg->len > spm->desc->max_msg_size) {
  194. printf("%s: Thread %ld message length %zu > max msg size %d\n",
  195. __func__, chan->id, msg->len, spm->desc->max_msg_size);
  196. return -EINVAL;
  197. }
  198. /* Send the message */
  199. data_reg = spt->data + spm->desc->data_start_offset;
  200. for (num_words = msg->len / sizeof(u32), word_data = (u32 *)msg->buf;
  201. num_words;
  202. num_words--, data_reg += sizeof(u32), word_data++)
  203. writel(*word_data, data_reg);
  204. trail_bytes = msg->len % sizeof(u32);
  205. if (trail_bytes) {
  206. u32 data_trail = *word_data;
  207. /* Ensure all unused data is 0 */
  208. data_trail &= 0xFFFFFFFF >> (8 * (sizeof(u32) - trail_bytes));
  209. writel(data_trail, data_reg);
  210. data_reg++;
  211. }
  212. /*
  213. * 'data_reg' indicates next register to write. If we did not already
  214. * write on tx complete reg(last reg), we must do so for transmit
  215. */
  216. if (data_reg <= (spt->data + spm->desc->data_end_offset))
  217. sp_writel(spt->data, spm->desc->data_end_offset, 0);
  218. debug("%s: Message successfully sent on thread %ld\n",
  219. __func__, chan->id);
  220. return 0;
  221. }
  222. /**
  223. * k3_sec_proxy_recv() - Receive data via mailbox channel
  224. * @chan: Channel Pointer
  225. * @data: Pointer to k3_sec_proxy_msg
  226. *
  227. * Return: 0 if all goes good, else appropriate error message.
  228. */
  229. static int k3_sec_proxy_recv(struct mbox_chan *chan, void *data)
  230. {
  231. struct k3_sec_proxy_mbox *spm = dev_get_priv(chan->dev);
  232. struct k3_sec_proxy_thread *spt = chan->con_priv;
  233. struct k3_sec_proxy_msg *msg = data;
  234. void __iomem *data_reg;
  235. int num_words, ret;
  236. u32 *word_data;
  237. debug("%s(chan=%p, data=%p)\n", __func__, chan, data);
  238. ret = k3_sec_proxy_verify_thread(spt, THREAD_IS_RX);
  239. if (ret)
  240. return ret;
  241. msg->len = spm->desc->max_msg_size;
  242. msg->buf = spt->rx_buf;
  243. data_reg = spt->data + spm->desc->data_start_offset;
  244. word_data = spt->rx_buf;
  245. for (num_words = spm->desc->max_msg_size / sizeof(u32);
  246. num_words;
  247. num_words--, data_reg += sizeof(u32), word_data++)
  248. *word_data = readl(data_reg);
  249. debug("%s: Message successfully received from thread %ld\n",
  250. __func__, chan->id);
  251. return 0;
  252. }
  253. struct mbox_ops k3_sec_proxy_mbox_ops = {
  254. .of_xlate = k3_sec_proxy_of_xlate,
  255. .request = k3_sec_proxy_request,
  256. .rfree = k3_sec_proxy_free,
  257. .send = k3_sec_proxy_send,
  258. .recv = k3_sec_proxy_recv,
  259. };
  260. /**
  261. * k3_sec_proxy_of_to_priv() - generate private data from device tree
  262. * @dev: corresponding k3 secure proxy device
  263. * @spm: pointer to driver specific private data
  264. *
  265. * Return: 0 if all went ok, else corresponding error message.
  266. */
  267. static int k3_sec_proxy_of_to_priv(struct udevice *dev,
  268. struct k3_sec_proxy_mbox *spm)
  269. {
  270. const void *blob = gd->fdt_blob;
  271. if (!blob) {
  272. debug("'%s' no dt?\n", dev->name);
  273. return -ENODEV;
  274. }
  275. spm->target_data = devfdt_get_addr_name(dev, "target_data");
  276. if (spm->target_data == FDT_ADDR_T_NONE) {
  277. dev_err(dev, "No reg property for target data base\n");
  278. return -EINVAL;
  279. }
  280. spm->scfg = devfdt_get_addr_name(dev, "scfg");
  281. if (spm->rt == FDT_ADDR_T_NONE) {
  282. dev_err(dev, "No reg property for Secure Cfg base\n");
  283. return -EINVAL;
  284. }
  285. spm->rt = devfdt_get_addr_name(dev, "rt");
  286. if (spm->rt == FDT_ADDR_T_NONE) {
  287. dev_err(dev, "No reg property for Real Time Cfg base\n");
  288. return -EINVAL;
  289. }
  290. return 0;
  291. }
  292. /**
  293. * k3_sec_proxy_thread_setup - Initialize the parameters for all valid threads
  294. * @spm: Mailbox instance for which threads needs to be initialized
  295. *
  296. * Return: 0 if all went ok, else corresponding error message
  297. */
  298. static int k3_sec_proxy_thread_setup(struct k3_sec_proxy_mbox *spm)
  299. {
  300. struct k3_sec_proxy_thread *spt;
  301. int i, ind;
  302. for (i = 0; i < spm->desc->num_valid_threads; i++) {
  303. spt = &spm->chans[i];
  304. ind = spm->desc->valid_threads[i];
  305. spt->id = ind;
  306. spt->data = (void *)SEC_PROXY_THREAD(spm->target_data, ind);
  307. spt->scfg = (void *)SEC_PROXY_THREAD(spm->scfg, ind);
  308. spt->rt = (void *)SEC_PROXY_THREAD(spm->rt, ind);
  309. spt->rx_buf = calloc(1, spm->desc->max_msg_size);
  310. if (!spt->rx_buf)
  311. return -ENOMEM;
  312. }
  313. return 0;
  314. }
  315. /**
  316. * k3_sec_proxy_probe() - Basic probe
  317. * @dev: corresponding mailbox device
  318. *
  319. * Return: 0 if all went ok, else corresponding error message
  320. */
  321. static int k3_sec_proxy_probe(struct udevice *dev)
  322. {
  323. struct k3_sec_proxy_mbox *spm = dev_get_priv(dev);
  324. int ret;
  325. debug("%s(dev=%p)\n", __func__, dev);
  326. ret = k3_sec_proxy_of_to_priv(dev, spm);
  327. if (ret)
  328. return ret;
  329. spm->desc = (void *)dev_get_driver_data(dev);
  330. spm->chans = calloc(spm->desc->num_valid_threads,
  331. sizeof(struct k3_sec_proxy_thread));
  332. if (!spm->chans)
  333. return -ENOMEM;
  334. ret = k3_sec_proxy_thread_setup(spm);
  335. if (ret) {
  336. debug("%s: secure proxy thread setup failed\n", __func__);
  337. return ret;
  338. }
  339. return 0;
  340. }
  341. static int k3_sec_proxy_remove(struct udevice *dev)
  342. {
  343. struct k3_sec_proxy_mbox *spm = dev_get_priv(dev);
  344. debug("%s(dev=%p)\n", __func__, dev);
  345. free(spm->chans);
  346. return 0;
  347. }
  348. /*
  349. * Thread ID #4: ROM request
  350. * Thread ID #5: ROM response, SYSFW notify
  351. * Thread ID #6: SYSFW request response
  352. * Thread ID #7: SYSFW request high priority
  353. * Thread ID #8: SYSFW request low priority
  354. * Thread ID #9: SYSFW notify response
  355. */
  356. static const u32 am6x_valid_threads[] = { 4, 5, 6, 7, 8, 9, 11, 13 };
  357. static const struct k3_sec_proxy_desc am654_desc = {
  358. .thread_count = 90,
  359. .max_msg_size = 60,
  360. .data_start_offset = 0x4,
  361. .data_end_offset = 0x3C,
  362. .valid_threads = am6x_valid_threads,
  363. .num_valid_threads = ARRAY_SIZE(am6x_valid_threads),
  364. };
  365. static const struct udevice_id k3_sec_proxy_ids[] = {
  366. { .compatible = "ti,am654-secure-proxy", .data = (ulong)&am654_desc},
  367. { }
  368. };
  369. U_BOOT_DRIVER(k3_sec_proxy) = {
  370. .name = "k3-secure-proxy",
  371. .id = UCLASS_MAILBOX,
  372. .of_match = k3_sec_proxy_ids,
  373. .probe = k3_sec_proxy_probe,
  374. .remove = k3_sec_proxy_remove,
  375. .priv_auto_alloc_size = sizeof(struct k3_sec_proxy_mbox),
  376. .ops = &k3_sec_proxy_mbox_ops,
  377. };