k3-sec-proxy.c 11 KB

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