k3-sec-proxy.c 12 KB

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