Linux-libre 5.3.12-gnu
[librecmc/linux-libre.git] / drivers / firmware / qcom_scm.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Qualcomm SCM driver
4  *
5  * Copyright (c) 2010,2015, The Linux Foundation. All rights reserved.
6  * Copyright (C) 2015 Linaro Ltd.
7  */
8 #include <linux/platform_device.h>
9 #include <linux/init.h>
10 #include <linux/cpumask.h>
11 #include <linux/export.h>
12 #include <linux/dma-direct.h>
13 #include <linux/dma-mapping.h>
14 #include <linux/module.h>
15 #include <linux/types.h>
16 #include <linux/qcom_scm.h>
17 #include <linux/of.h>
18 #include <linux/of_address.h>
19 #include <linux/of_platform.h>
20 #include <linux/clk.h>
21 #include <linux/reset-controller.h>
22
23 #include "qcom_scm.h"
24
25 static bool download_mode = IS_ENABLED(CONFIG_QCOM_SCM_DOWNLOAD_MODE_DEFAULT);
26 module_param(download_mode, bool, 0);
27
28 #define SCM_HAS_CORE_CLK        BIT(0)
29 #define SCM_HAS_IFACE_CLK       BIT(1)
30 #define SCM_HAS_BUS_CLK         BIT(2)
31
32 struct qcom_scm {
33         struct device *dev;
34         struct clk *core_clk;
35         struct clk *iface_clk;
36         struct clk *bus_clk;
37         struct reset_controller_dev reset;
38
39         u64 dload_mode_addr;
40 };
41
42 struct qcom_scm_current_perm_info {
43         __le32 vmid;
44         __le32 perm;
45         __le64 ctx;
46         __le32 ctx_size;
47         __le32 unused;
48 };
49
50 struct qcom_scm_mem_map_info {
51         __le64 mem_addr;
52         __le64 mem_size;
53 };
54
55 static struct qcom_scm *__scm;
56
57 static int qcom_scm_clk_enable(void)
58 {
59         int ret;
60
61         ret = clk_prepare_enable(__scm->core_clk);
62         if (ret)
63                 goto bail;
64
65         ret = clk_prepare_enable(__scm->iface_clk);
66         if (ret)
67                 goto disable_core;
68
69         ret = clk_prepare_enable(__scm->bus_clk);
70         if (ret)
71                 goto disable_iface;
72
73         return 0;
74
75 disable_iface:
76         clk_disable_unprepare(__scm->iface_clk);
77 disable_core:
78         clk_disable_unprepare(__scm->core_clk);
79 bail:
80         return ret;
81 }
82
83 static void qcom_scm_clk_disable(void)
84 {
85         clk_disable_unprepare(__scm->core_clk);
86         clk_disable_unprepare(__scm->iface_clk);
87         clk_disable_unprepare(__scm->bus_clk);
88 }
89
90 /**
91  * qcom_scm_set_cold_boot_addr() - Set the cold boot address for cpus
92  * @entry: Entry point function for the cpus
93  * @cpus: The cpumask of cpus that will use the entry point
94  *
95  * Set the cold boot address of the cpus. Any cpu outside the supported
96  * range would be removed from the cpu present mask.
97  */
98 int qcom_scm_set_cold_boot_addr(void *entry, const cpumask_t *cpus)
99 {
100         return __qcom_scm_set_cold_boot_addr(entry, cpus);
101 }
102 EXPORT_SYMBOL(qcom_scm_set_cold_boot_addr);
103
104 /**
105  * qcom_scm_set_warm_boot_addr() - Set the warm boot address for cpus
106  * @entry: Entry point function for the cpus
107  * @cpus: The cpumask of cpus that will use the entry point
108  *
109  * Set the Linux entry point for the SCM to transfer control to when coming
110  * out of a power down. CPU power down may be executed on cpuidle or hotplug.
111  */
112 int qcom_scm_set_warm_boot_addr(void *entry, const cpumask_t *cpus)
113 {
114         return __qcom_scm_set_warm_boot_addr(__scm->dev, entry, cpus);
115 }
116 EXPORT_SYMBOL(qcom_scm_set_warm_boot_addr);
117
118 /**
119  * qcom_scm_cpu_power_down() - Power down the cpu
120  * @flags - Flags to flush cache
121  *
122  * This is an end point to power down cpu. If there was a pending interrupt,
123  * the control would return from this function, otherwise, the cpu jumps to the
124  * warm boot entry point set for this cpu upon reset.
125  */
126 void qcom_scm_cpu_power_down(u32 flags)
127 {
128         __qcom_scm_cpu_power_down(flags);
129 }
130 EXPORT_SYMBOL(qcom_scm_cpu_power_down);
131
132 /**
133  * qcom_scm_hdcp_available() - Check if secure environment supports HDCP.
134  *
135  * Return true if HDCP is supported, false if not.
136  */
137 bool qcom_scm_hdcp_available(void)
138 {
139         int ret = qcom_scm_clk_enable();
140
141         if (ret)
142                 return ret;
143
144         ret = __qcom_scm_is_call_available(__scm->dev, QCOM_SCM_SVC_HDCP,
145                                                 QCOM_SCM_CMD_HDCP);
146
147         qcom_scm_clk_disable();
148
149         return ret > 0 ? true : false;
150 }
151 EXPORT_SYMBOL(qcom_scm_hdcp_available);
152
153 /**
154  * qcom_scm_hdcp_req() - Send HDCP request.
155  * @req: HDCP request array
156  * @req_cnt: HDCP request array count
157  * @resp: response buffer passed to SCM
158  *
159  * Write HDCP register(s) through SCM.
160  */
161 int qcom_scm_hdcp_req(struct qcom_scm_hdcp_req *req, u32 req_cnt, u32 *resp)
162 {
163         int ret = qcom_scm_clk_enable();
164
165         if (ret)
166                 return ret;
167
168         ret = __qcom_scm_hdcp_req(__scm->dev, req, req_cnt, resp);
169         qcom_scm_clk_disable();
170         return ret;
171 }
172 EXPORT_SYMBOL(qcom_scm_hdcp_req);
173
174 /**
175  * qcom_scm_pas_supported() - Check if the peripheral authentication service is
176  *                            available for the given peripherial
177  * @peripheral: peripheral id
178  *
179  * Returns true if PAS is supported for this peripheral, otherwise false.
180  */
181 bool qcom_scm_pas_supported(u32 peripheral)
182 {
183         int ret;
184
185         ret = __qcom_scm_is_call_available(__scm->dev, QCOM_SCM_SVC_PIL,
186                                            QCOM_SCM_PAS_IS_SUPPORTED_CMD);
187         if (ret <= 0)
188                 return false;
189
190         return __qcom_scm_pas_supported(__scm->dev, peripheral);
191 }
192 EXPORT_SYMBOL(qcom_scm_pas_supported);
193
194 /**
195  * qcom_scm_pas_init_image() - Initialize peripheral authentication service
196  *                             state machine for a given peripheral, using the
197  *                             metadata
198  * @peripheral: peripheral id
199  * @metadata:   pointer to memory containing ELF header, program header table
200  *              and optional blob of data used for authenticating the metadata
201  *              and the rest of the firmware
202  * @size:       size of the metadata
203  *
204  * Returns 0 on success.
205  */
206 int qcom_scm_pas_init_image(u32 peripheral, const void *metadata, size_t size)
207 {
208         dma_addr_t mdata_phys;
209         void *mdata_buf;
210         int ret;
211
212         /*
213          * During the scm call memory protection will be enabled for the meta
214          * data blob, so make sure it's physically contiguous, 4K aligned and
215          * non-cachable to avoid XPU violations.
216          */
217         mdata_buf = dma_alloc_coherent(__scm->dev, size, &mdata_phys,
218                                        GFP_KERNEL);
219         if (!mdata_buf) {
220                 dev_err(__scm->dev, "Allocation of metadata buffer failed.\n");
221                 return -ENOMEM;
222         }
223         memcpy(mdata_buf, metadata, size);
224
225         ret = qcom_scm_clk_enable();
226         if (ret)
227                 goto free_metadata;
228
229         ret = __qcom_scm_pas_init_image(__scm->dev, peripheral, mdata_phys);
230
231         qcom_scm_clk_disable();
232
233 free_metadata:
234         dma_free_coherent(__scm->dev, size, mdata_buf, mdata_phys);
235
236         return ret;
237 }
238 EXPORT_SYMBOL(qcom_scm_pas_init_image);
239
240 /**
241  * qcom_scm_pas_mem_setup() - Prepare the memory related to a given peripheral
242  *                            for firmware loading
243  * @peripheral: peripheral id
244  * @addr:       start address of memory area to prepare
245  * @size:       size of the memory area to prepare
246  *
247  * Returns 0 on success.
248  */
249 int qcom_scm_pas_mem_setup(u32 peripheral, phys_addr_t addr, phys_addr_t size)
250 {
251         int ret;
252
253         ret = qcom_scm_clk_enable();
254         if (ret)
255                 return ret;
256
257         ret = __qcom_scm_pas_mem_setup(__scm->dev, peripheral, addr, size);
258         qcom_scm_clk_disable();
259
260         return ret;
261 }
262 EXPORT_SYMBOL(qcom_scm_pas_mem_setup);
263
264 /**
265  * qcom_scm_pas_auth_and_reset() - Authenticate the given peripheral firmware
266  *                                 and reset the remote processor
267  * @peripheral: peripheral id
268  *
269  * Return 0 on success.
270  */
271 int qcom_scm_pas_auth_and_reset(u32 peripheral)
272 {
273         int ret;
274
275         ret = qcom_scm_clk_enable();
276         if (ret)
277                 return ret;
278
279         ret = __qcom_scm_pas_auth_and_reset(__scm->dev, peripheral);
280         qcom_scm_clk_disable();
281
282         return ret;
283 }
284 EXPORT_SYMBOL(qcom_scm_pas_auth_and_reset);
285
286 /**
287  * qcom_scm_pas_shutdown() - Shut down the remote processor
288  * @peripheral: peripheral id
289  *
290  * Returns 0 on success.
291  */
292 int qcom_scm_pas_shutdown(u32 peripheral)
293 {
294         int ret;
295
296         ret = qcom_scm_clk_enable();
297         if (ret)
298                 return ret;
299
300         ret = __qcom_scm_pas_shutdown(__scm->dev, peripheral);
301         qcom_scm_clk_disable();
302
303         return ret;
304 }
305 EXPORT_SYMBOL(qcom_scm_pas_shutdown);
306
307 static int qcom_scm_pas_reset_assert(struct reset_controller_dev *rcdev,
308                                      unsigned long idx)
309 {
310         if (idx != 0)
311                 return -EINVAL;
312
313         return __qcom_scm_pas_mss_reset(__scm->dev, 1);
314 }
315
316 static int qcom_scm_pas_reset_deassert(struct reset_controller_dev *rcdev,
317                                        unsigned long idx)
318 {
319         if (idx != 0)
320                 return -EINVAL;
321
322         return __qcom_scm_pas_mss_reset(__scm->dev, 0);
323 }
324
325 static const struct reset_control_ops qcom_scm_pas_reset_ops = {
326         .assert = qcom_scm_pas_reset_assert,
327         .deassert = qcom_scm_pas_reset_deassert,
328 };
329
330 int qcom_scm_restore_sec_cfg(u32 device_id, u32 spare)
331 {
332         return __qcom_scm_restore_sec_cfg(__scm->dev, device_id, spare);
333 }
334 EXPORT_SYMBOL(qcom_scm_restore_sec_cfg);
335
336 int qcom_scm_iommu_secure_ptbl_size(u32 spare, size_t *size)
337 {
338         return __qcom_scm_iommu_secure_ptbl_size(__scm->dev, spare, size);
339 }
340 EXPORT_SYMBOL(qcom_scm_iommu_secure_ptbl_size);
341
342 int qcom_scm_iommu_secure_ptbl_init(u64 addr, u32 size, u32 spare)
343 {
344         return __qcom_scm_iommu_secure_ptbl_init(__scm->dev, addr, size, spare);
345 }
346 EXPORT_SYMBOL(qcom_scm_iommu_secure_ptbl_init);
347
348 int qcom_scm_io_readl(phys_addr_t addr, unsigned int *val)
349 {
350         return __qcom_scm_io_readl(__scm->dev, addr, val);
351 }
352 EXPORT_SYMBOL(qcom_scm_io_readl);
353
354 int qcom_scm_io_writel(phys_addr_t addr, unsigned int val)
355 {
356         return __qcom_scm_io_writel(__scm->dev, addr, val);
357 }
358 EXPORT_SYMBOL(qcom_scm_io_writel);
359
360 static void qcom_scm_set_download_mode(bool enable)
361 {
362         bool avail;
363         int ret = 0;
364
365         avail = __qcom_scm_is_call_available(__scm->dev,
366                                              QCOM_SCM_SVC_BOOT,
367                                              QCOM_SCM_SET_DLOAD_MODE);
368         if (avail) {
369                 ret = __qcom_scm_set_dload_mode(__scm->dev, enable);
370         } else if (__scm->dload_mode_addr) {
371                 ret = __qcom_scm_io_writel(__scm->dev, __scm->dload_mode_addr,
372                                            enable ? QCOM_SCM_SET_DLOAD_MODE : 0);
373         } else {
374                 dev_err(__scm->dev,
375                         "No available mechanism for setting download mode\n");
376         }
377
378         if (ret)
379                 dev_err(__scm->dev, "failed to set download mode: %d\n", ret);
380 }
381
382 static int qcom_scm_find_dload_address(struct device *dev, u64 *addr)
383 {
384         struct device_node *tcsr;
385         struct device_node *np = dev->of_node;
386         struct resource res;
387         u32 offset;
388         int ret;
389
390         tcsr = of_parse_phandle(np, "qcom,dload-mode", 0);
391         if (!tcsr)
392                 return 0;
393
394         ret = of_address_to_resource(tcsr, 0, &res);
395         of_node_put(tcsr);
396         if (ret)
397                 return ret;
398
399         ret = of_property_read_u32_index(np, "qcom,dload-mode", 1, &offset);
400         if (ret < 0)
401                 return ret;
402
403         *addr = res.start + offset;
404
405         return 0;
406 }
407
408 /**
409  * qcom_scm_is_available() - Checks if SCM is available
410  */
411 bool qcom_scm_is_available(void)
412 {
413         return !!__scm;
414 }
415 EXPORT_SYMBOL(qcom_scm_is_available);
416
417 int qcom_scm_set_remote_state(u32 state, u32 id)
418 {
419         return __qcom_scm_set_remote_state(__scm->dev, state, id);
420 }
421 EXPORT_SYMBOL(qcom_scm_set_remote_state);
422
423 /**
424  * qcom_scm_assign_mem() - Make a secure call to reassign memory ownership
425  * @mem_addr: mem region whose ownership need to be reassigned
426  * @mem_sz:   size of the region.
427  * @srcvm:    vmid for current set of owners, each set bit in
428  *            flag indicate a unique owner
429  * @newvm:    array having new owners and corrsponding permission
430  *            flags
431  * @dest_cnt: number of owners in next set.
432  *
433  * Return negative errno on failure, 0 on success, with @srcvm updated.
434  */
435 int qcom_scm_assign_mem(phys_addr_t mem_addr, size_t mem_sz,
436                         unsigned int *srcvm,
437                         struct qcom_scm_vmperm *newvm, int dest_cnt)
438 {
439         struct qcom_scm_current_perm_info *destvm;
440         struct qcom_scm_mem_map_info *mem_to_map;
441         phys_addr_t mem_to_map_phys;
442         phys_addr_t dest_phys;
443         phys_addr_t ptr_phys;
444         dma_addr_t ptr_dma;
445         size_t mem_to_map_sz;
446         size_t dest_sz;
447         size_t src_sz;
448         size_t ptr_sz;
449         int next_vm;
450         __le32 *src;
451         void *ptr;
452         int ret;
453         int len;
454         int i;
455
456         src_sz = hweight_long(*srcvm) * sizeof(*src);
457         mem_to_map_sz = sizeof(*mem_to_map);
458         dest_sz = dest_cnt * sizeof(*destvm);
459         ptr_sz = ALIGN(src_sz, SZ_64) + ALIGN(mem_to_map_sz, SZ_64) +
460                         ALIGN(dest_sz, SZ_64);
461
462         ptr = dma_alloc_coherent(__scm->dev, ptr_sz, &ptr_dma, GFP_KERNEL);
463         if (!ptr)
464                 return -ENOMEM;
465         ptr_phys = dma_to_phys(__scm->dev, ptr_dma);
466
467         /* Fill source vmid detail */
468         src = ptr;
469         len = hweight_long(*srcvm);
470         for (i = 0; i < len; i++) {
471                 src[i] = cpu_to_le32(ffs(*srcvm) - 1);
472                 *srcvm ^= 1 << (ffs(*srcvm) - 1);
473         }
474
475         /* Fill details of mem buff to map */
476         mem_to_map = ptr + ALIGN(src_sz, SZ_64);
477         mem_to_map_phys = ptr_phys + ALIGN(src_sz, SZ_64);
478         mem_to_map[0].mem_addr = cpu_to_le64(mem_addr);
479         mem_to_map[0].mem_size = cpu_to_le64(mem_sz);
480
481         next_vm = 0;
482         /* Fill details of next vmid detail */
483         destvm = ptr + ALIGN(mem_to_map_sz, SZ_64) + ALIGN(src_sz, SZ_64);
484         dest_phys = ptr_phys + ALIGN(mem_to_map_sz, SZ_64) + ALIGN(src_sz, SZ_64);
485         for (i = 0; i < dest_cnt; i++) {
486                 destvm[i].vmid = cpu_to_le32(newvm[i].vmid);
487                 destvm[i].perm = cpu_to_le32(newvm[i].perm);
488                 destvm[i].ctx = 0;
489                 destvm[i].ctx_size = 0;
490                 next_vm |= BIT(newvm[i].vmid);
491         }
492
493         ret = __qcom_scm_assign_mem(__scm->dev, mem_to_map_phys, mem_to_map_sz,
494                                     ptr_phys, src_sz, dest_phys, dest_sz);
495         dma_free_coherent(__scm->dev, ptr_sz, ptr, ptr_dma);
496         if (ret) {
497                 dev_err(__scm->dev,
498                         "Assign memory protection call failed %d.\n", ret);
499                 return -EINVAL;
500         }
501
502         *srcvm = next_vm;
503         return 0;
504 }
505 EXPORT_SYMBOL(qcom_scm_assign_mem);
506
507 static int qcom_scm_probe(struct platform_device *pdev)
508 {
509         struct qcom_scm *scm;
510         unsigned long clks;
511         int ret;
512
513         scm = devm_kzalloc(&pdev->dev, sizeof(*scm), GFP_KERNEL);
514         if (!scm)
515                 return -ENOMEM;
516
517         ret = qcom_scm_find_dload_address(&pdev->dev, &scm->dload_mode_addr);
518         if (ret < 0)
519                 return ret;
520
521         clks = (unsigned long)of_device_get_match_data(&pdev->dev);
522
523         scm->core_clk = devm_clk_get(&pdev->dev, "core");
524         if (IS_ERR(scm->core_clk)) {
525                 if (PTR_ERR(scm->core_clk) == -EPROBE_DEFER)
526                         return PTR_ERR(scm->core_clk);
527
528                 if (clks & SCM_HAS_CORE_CLK) {
529                         dev_err(&pdev->dev, "failed to acquire core clk\n");
530                         return PTR_ERR(scm->core_clk);
531                 }
532
533                 scm->core_clk = NULL;
534         }
535
536         scm->iface_clk = devm_clk_get(&pdev->dev, "iface");
537         if (IS_ERR(scm->iface_clk)) {
538                 if (PTR_ERR(scm->iface_clk) == -EPROBE_DEFER)
539                         return PTR_ERR(scm->iface_clk);
540
541                 if (clks & SCM_HAS_IFACE_CLK) {
542                         dev_err(&pdev->dev, "failed to acquire iface clk\n");
543                         return PTR_ERR(scm->iface_clk);
544                 }
545
546                 scm->iface_clk = NULL;
547         }
548
549         scm->bus_clk = devm_clk_get(&pdev->dev, "bus");
550         if (IS_ERR(scm->bus_clk)) {
551                 if (PTR_ERR(scm->bus_clk) == -EPROBE_DEFER)
552                         return PTR_ERR(scm->bus_clk);
553
554                 if (clks & SCM_HAS_BUS_CLK) {
555                         dev_err(&pdev->dev, "failed to acquire bus clk\n");
556                         return PTR_ERR(scm->bus_clk);
557                 }
558
559                 scm->bus_clk = NULL;
560         }
561
562         scm->reset.ops = &qcom_scm_pas_reset_ops;
563         scm->reset.nr_resets = 1;
564         scm->reset.of_node = pdev->dev.of_node;
565         ret = devm_reset_controller_register(&pdev->dev, &scm->reset);
566         if (ret)
567                 return ret;
568
569         /* vote for max clk rate for highest performance */
570         ret = clk_set_rate(scm->core_clk, INT_MAX);
571         if (ret)
572                 return ret;
573
574         __scm = scm;
575         __scm->dev = &pdev->dev;
576
577         __qcom_scm_init();
578
579         /*
580          * If requested enable "download mode", from this point on warmboot
581          * will cause the the boot stages to enter download mode, unless
582          * disabled below by a clean shutdown/reboot.
583          */
584         if (download_mode)
585                 qcom_scm_set_download_mode(true);
586
587         return 0;
588 }
589
590 static void qcom_scm_shutdown(struct platform_device *pdev)
591 {
592         /* Clean shutdown, disable download mode to allow normal restart */
593         if (download_mode)
594                 qcom_scm_set_download_mode(false);
595 }
596
597 static const struct of_device_id qcom_scm_dt_match[] = {
598         { .compatible = "qcom,scm-apq8064",
599           /* FIXME: This should have .data = (void *) SCM_HAS_CORE_CLK */
600         },
601         { .compatible = "qcom,scm-apq8084", .data = (void *)(SCM_HAS_CORE_CLK |
602                                                              SCM_HAS_IFACE_CLK |
603                                                              SCM_HAS_BUS_CLK)
604         },
605         { .compatible = "qcom,scm-ipq4019" },
606         { .compatible = "qcom,scm-msm8660", .data = (void *) SCM_HAS_CORE_CLK },
607         { .compatible = "qcom,scm-msm8960", .data = (void *) SCM_HAS_CORE_CLK },
608         { .compatible = "qcom,scm-msm8916", .data = (void *)(SCM_HAS_CORE_CLK |
609                                                              SCM_HAS_IFACE_CLK |
610                                                              SCM_HAS_BUS_CLK)
611         },
612         { .compatible = "qcom,scm-msm8974", .data = (void *)(SCM_HAS_CORE_CLK |
613                                                              SCM_HAS_IFACE_CLK |
614                                                              SCM_HAS_BUS_CLK)
615         },
616         { .compatible = "qcom,scm-msm8996" },
617         { .compatible = "qcom,scm" },
618         {}
619 };
620
621 static struct platform_driver qcom_scm_driver = {
622         .driver = {
623                 .name   = "qcom_scm",
624                 .of_match_table = qcom_scm_dt_match,
625         },
626         .probe = qcom_scm_probe,
627         .shutdown = qcom_scm_shutdown,
628 };
629
630 static int __init qcom_scm_init(void)
631 {
632         return platform_driver_register(&qcom_scm_driver);
633 }
634 subsys_initcall(qcom_scm_init);