k3-sec-proxy.c 11 KB

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