1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (c) 2010,2015, The Linux Foundation. All rights reserved.
6 * Copyright (C) 2015 Linaro Ltd.
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>
18 #include <linux/of_address.h>
19 #include <linux/of_platform.h>
20 #include <linux/clk.h>
21 #include <linux/reset-controller.h>
25 static bool download_mode = IS_ENABLED(CONFIG_QCOM_SCM_DOWNLOAD_MODE_DEFAULT);
26 module_param(download_mode, bool, 0);
28 #define SCM_HAS_CORE_CLK BIT(0)
29 #define SCM_HAS_IFACE_CLK BIT(1)
30 #define SCM_HAS_BUS_CLK BIT(2)
35 struct clk *iface_clk;
37 struct reset_controller_dev reset;
42 struct qcom_scm_current_perm_info {
50 struct qcom_scm_mem_map_info {
55 static struct qcom_scm *__scm;
57 static int qcom_scm_clk_enable(void)
61 ret = clk_prepare_enable(__scm->core_clk);
65 ret = clk_prepare_enable(__scm->iface_clk);
69 ret = clk_prepare_enable(__scm->bus_clk);
76 clk_disable_unprepare(__scm->iface_clk);
78 clk_disable_unprepare(__scm->core_clk);
83 static void qcom_scm_clk_disable(void)
85 clk_disable_unprepare(__scm->core_clk);
86 clk_disable_unprepare(__scm->iface_clk);
87 clk_disable_unprepare(__scm->bus_clk);
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
95 * Set the cold boot address of the cpus. Any cpu outside the supported
96 * range would be removed from the cpu present mask.
98 int qcom_scm_set_cold_boot_addr(void *entry, const cpumask_t *cpus)
100 return __qcom_scm_set_cold_boot_addr(entry, cpus);
102 EXPORT_SYMBOL(qcom_scm_set_cold_boot_addr);
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
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.
112 int qcom_scm_set_warm_boot_addr(void *entry, const cpumask_t *cpus)
114 return __qcom_scm_set_warm_boot_addr(__scm->dev, entry, cpus);
116 EXPORT_SYMBOL(qcom_scm_set_warm_boot_addr);
119 * qcom_scm_cpu_power_down() - Power down the cpu
120 * @flags - Flags to flush cache
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.
126 void qcom_scm_cpu_power_down(u32 flags)
128 __qcom_scm_cpu_power_down(flags);
130 EXPORT_SYMBOL(qcom_scm_cpu_power_down);
133 * qcom_scm_hdcp_available() - Check if secure environment supports HDCP.
135 * Return true if HDCP is supported, false if not.
137 bool qcom_scm_hdcp_available(void)
139 int ret = qcom_scm_clk_enable();
144 ret = __qcom_scm_is_call_available(__scm->dev, QCOM_SCM_SVC_HDCP,
147 qcom_scm_clk_disable();
149 return ret > 0 ? true : false;
151 EXPORT_SYMBOL(qcom_scm_hdcp_available);
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
159 * Write HDCP register(s) through SCM.
161 int qcom_scm_hdcp_req(struct qcom_scm_hdcp_req *req, u32 req_cnt, u32 *resp)
163 int ret = qcom_scm_clk_enable();
168 ret = __qcom_scm_hdcp_req(__scm->dev, req, req_cnt, resp);
169 qcom_scm_clk_disable();
172 EXPORT_SYMBOL(qcom_scm_hdcp_req);
175 * qcom_scm_pas_supported() - Check if the peripheral authentication service is
176 * available for the given peripherial
177 * @peripheral: peripheral id
179 * Returns true if PAS is supported for this peripheral, otherwise false.
181 bool qcom_scm_pas_supported(u32 peripheral)
185 ret = __qcom_scm_is_call_available(__scm->dev, QCOM_SCM_SVC_PIL,
186 QCOM_SCM_PAS_IS_SUPPORTED_CMD);
190 return __qcom_scm_pas_supported(__scm->dev, peripheral);
192 EXPORT_SYMBOL(qcom_scm_pas_supported);
195 * qcom_scm_pas_init_image() - Initialize peripheral authentication service
196 * state machine for a given peripheral, using the
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
204 * Returns 0 on success.
206 int qcom_scm_pas_init_image(u32 peripheral, const void *metadata, size_t size)
208 dma_addr_t mdata_phys;
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.
217 mdata_buf = dma_alloc_coherent(__scm->dev, size, &mdata_phys,
220 dev_err(__scm->dev, "Allocation of metadata buffer failed.\n");
223 memcpy(mdata_buf, metadata, size);
225 ret = qcom_scm_clk_enable();
229 ret = __qcom_scm_pas_init_image(__scm->dev, peripheral, mdata_phys);
231 qcom_scm_clk_disable();
234 dma_free_coherent(__scm->dev, size, mdata_buf, mdata_phys);
238 EXPORT_SYMBOL(qcom_scm_pas_init_image);
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
247 * Returns 0 on success.
249 int qcom_scm_pas_mem_setup(u32 peripheral, phys_addr_t addr, phys_addr_t size)
253 ret = qcom_scm_clk_enable();
257 ret = __qcom_scm_pas_mem_setup(__scm->dev, peripheral, addr, size);
258 qcom_scm_clk_disable();
262 EXPORT_SYMBOL(qcom_scm_pas_mem_setup);
265 * qcom_scm_pas_auth_and_reset() - Authenticate the given peripheral firmware
266 * and reset the remote processor
267 * @peripheral: peripheral id
269 * Return 0 on success.
271 int qcom_scm_pas_auth_and_reset(u32 peripheral)
275 ret = qcom_scm_clk_enable();
279 ret = __qcom_scm_pas_auth_and_reset(__scm->dev, peripheral);
280 qcom_scm_clk_disable();
284 EXPORT_SYMBOL(qcom_scm_pas_auth_and_reset);
287 * qcom_scm_pas_shutdown() - Shut down the remote processor
288 * @peripheral: peripheral id
290 * Returns 0 on success.
292 int qcom_scm_pas_shutdown(u32 peripheral)
296 ret = qcom_scm_clk_enable();
300 ret = __qcom_scm_pas_shutdown(__scm->dev, peripheral);
301 qcom_scm_clk_disable();
305 EXPORT_SYMBOL(qcom_scm_pas_shutdown);
307 static int qcom_scm_pas_reset_assert(struct reset_controller_dev *rcdev,
313 return __qcom_scm_pas_mss_reset(__scm->dev, 1);
316 static int qcom_scm_pas_reset_deassert(struct reset_controller_dev *rcdev,
322 return __qcom_scm_pas_mss_reset(__scm->dev, 0);
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,
330 int qcom_scm_restore_sec_cfg(u32 device_id, u32 spare)
332 return __qcom_scm_restore_sec_cfg(__scm->dev, device_id, spare);
334 EXPORT_SYMBOL(qcom_scm_restore_sec_cfg);
336 int qcom_scm_iommu_secure_ptbl_size(u32 spare, size_t *size)
338 return __qcom_scm_iommu_secure_ptbl_size(__scm->dev, spare, size);
340 EXPORT_SYMBOL(qcom_scm_iommu_secure_ptbl_size);
342 int qcom_scm_iommu_secure_ptbl_init(u64 addr, u32 size, u32 spare)
344 return __qcom_scm_iommu_secure_ptbl_init(__scm->dev, addr, size, spare);
346 EXPORT_SYMBOL(qcom_scm_iommu_secure_ptbl_init);
348 int qcom_scm_io_readl(phys_addr_t addr, unsigned int *val)
350 return __qcom_scm_io_readl(__scm->dev, addr, val);
352 EXPORT_SYMBOL(qcom_scm_io_readl);
354 int qcom_scm_io_writel(phys_addr_t addr, unsigned int val)
356 return __qcom_scm_io_writel(__scm->dev, addr, val);
358 EXPORT_SYMBOL(qcom_scm_io_writel);
360 static void qcom_scm_set_download_mode(bool enable)
365 avail = __qcom_scm_is_call_available(__scm->dev,
367 QCOM_SCM_SET_DLOAD_MODE);
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);
375 "No available mechanism for setting download mode\n");
379 dev_err(__scm->dev, "failed to set download mode: %d\n", ret);
382 static int qcom_scm_find_dload_address(struct device *dev, u64 *addr)
384 struct device_node *tcsr;
385 struct device_node *np = dev->of_node;
390 tcsr = of_parse_phandle(np, "qcom,dload-mode", 0);
394 ret = of_address_to_resource(tcsr, 0, &res);
399 ret = of_property_read_u32_index(np, "qcom,dload-mode", 1, &offset);
403 *addr = res.start + offset;
409 * qcom_scm_is_available() - Checks if SCM is available
411 bool qcom_scm_is_available(void)
415 EXPORT_SYMBOL(qcom_scm_is_available);
417 int qcom_scm_set_remote_state(u32 state, u32 id)
419 return __qcom_scm_set_remote_state(__scm->dev, state, id);
421 EXPORT_SYMBOL(qcom_scm_set_remote_state);
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 corresponding permission
431 * @dest_cnt: number of owners in next set.
433 * Return negative errno on failure or 0 on success with @srcvm updated.
435 int qcom_scm_assign_mem(phys_addr_t mem_addr, size_t mem_sz,
437 const struct qcom_scm_vmperm *newvm,
438 unsigned int dest_cnt)
440 struct qcom_scm_current_perm_info *destvm;
441 struct qcom_scm_mem_map_info *mem_to_map;
442 phys_addr_t mem_to_map_phys;
443 phys_addr_t dest_phys;
444 phys_addr_t ptr_phys;
446 size_t mem_to_map_sz;
454 unsigned long srcvm_bits = *srcvm;
456 src_sz = hweight_long(srcvm_bits) * 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);
462 ptr = dma_alloc_coherent(__scm->dev, ptr_sz, &ptr_dma, GFP_KERNEL);
465 ptr_phys = dma_to_phys(__scm->dev, ptr_dma);
467 /* Fill source vmid detail */
470 for_each_set_bit(b, &srcvm_bits, BITS_PER_LONG)
471 src[i++] = cpu_to_le32(b);
473 /* Fill details of mem buff to map */
474 mem_to_map = ptr + ALIGN(src_sz, SZ_64);
475 mem_to_map_phys = ptr_phys + ALIGN(src_sz, SZ_64);
476 mem_to_map->mem_addr = cpu_to_le64(mem_addr);
477 mem_to_map->mem_size = cpu_to_le64(mem_sz);
480 /* Fill details of next vmid detail */
481 destvm = ptr + ALIGN(mem_to_map_sz, SZ_64) + ALIGN(src_sz, SZ_64);
482 dest_phys = ptr_phys + ALIGN(mem_to_map_sz, SZ_64) + ALIGN(src_sz, SZ_64);
483 for (i = 0; i < dest_cnt; i++, destvm++, newvm++) {
484 destvm->vmid = cpu_to_le32(newvm->vmid);
485 destvm->perm = cpu_to_le32(newvm->perm);
487 destvm->ctx_size = 0;
488 next_vm |= BIT(newvm->vmid);
491 ret = __qcom_scm_assign_mem(__scm->dev, mem_to_map_phys, mem_to_map_sz,
492 ptr_phys, src_sz, dest_phys, dest_sz);
493 dma_free_coherent(__scm->dev, ptr_sz, ptr, ptr_dma);
496 "Assign memory protection call failed %d\n", ret);
503 EXPORT_SYMBOL(qcom_scm_assign_mem);
505 static int qcom_scm_probe(struct platform_device *pdev)
507 struct qcom_scm *scm;
511 scm = devm_kzalloc(&pdev->dev, sizeof(*scm), GFP_KERNEL);
515 ret = qcom_scm_find_dload_address(&pdev->dev, &scm->dload_mode_addr);
519 clks = (unsigned long)of_device_get_match_data(&pdev->dev);
521 scm->core_clk = devm_clk_get(&pdev->dev, "core");
522 if (IS_ERR(scm->core_clk)) {
523 if (PTR_ERR(scm->core_clk) == -EPROBE_DEFER)
524 return PTR_ERR(scm->core_clk);
526 if (clks & SCM_HAS_CORE_CLK) {
527 dev_err(&pdev->dev, "failed to acquire core clk\n");
528 return PTR_ERR(scm->core_clk);
531 scm->core_clk = NULL;
534 scm->iface_clk = devm_clk_get(&pdev->dev, "iface");
535 if (IS_ERR(scm->iface_clk)) {
536 if (PTR_ERR(scm->iface_clk) == -EPROBE_DEFER)
537 return PTR_ERR(scm->iface_clk);
539 if (clks & SCM_HAS_IFACE_CLK) {
540 dev_err(&pdev->dev, "failed to acquire iface clk\n");
541 return PTR_ERR(scm->iface_clk);
544 scm->iface_clk = NULL;
547 scm->bus_clk = devm_clk_get(&pdev->dev, "bus");
548 if (IS_ERR(scm->bus_clk)) {
549 if (PTR_ERR(scm->bus_clk) == -EPROBE_DEFER)
550 return PTR_ERR(scm->bus_clk);
552 if (clks & SCM_HAS_BUS_CLK) {
553 dev_err(&pdev->dev, "failed to acquire bus clk\n");
554 return PTR_ERR(scm->bus_clk);
560 scm->reset.ops = &qcom_scm_pas_reset_ops;
561 scm->reset.nr_resets = 1;
562 scm->reset.of_node = pdev->dev.of_node;
563 ret = devm_reset_controller_register(&pdev->dev, &scm->reset);
567 /* vote for max clk rate for highest performance */
568 ret = clk_set_rate(scm->core_clk, INT_MAX);
573 __scm->dev = &pdev->dev;
578 * If requested enable "download mode", from this point on warmboot
579 * will cause the the boot stages to enter download mode, unless
580 * disabled below by a clean shutdown/reboot.
583 qcom_scm_set_download_mode(true);
588 static void qcom_scm_shutdown(struct platform_device *pdev)
590 /* Clean shutdown, disable download mode to allow normal restart */
592 qcom_scm_set_download_mode(false);
595 static const struct of_device_id qcom_scm_dt_match[] = {
596 { .compatible = "qcom,scm-apq8064",
597 /* FIXME: This should have .data = (void *) SCM_HAS_CORE_CLK */
599 { .compatible = "qcom,scm-apq8084", .data = (void *)(SCM_HAS_CORE_CLK |
603 { .compatible = "qcom,scm-ipq4019" },
604 { .compatible = "qcom,scm-msm8660", .data = (void *) SCM_HAS_CORE_CLK },
605 { .compatible = "qcom,scm-msm8960", .data = (void *) SCM_HAS_CORE_CLK },
606 { .compatible = "qcom,scm-msm8916", .data = (void *)(SCM_HAS_CORE_CLK |
610 { .compatible = "qcom,scm-msm8974", .data = (void *)(SCM_HAS_CORE_CLK |
614 { .compatible = "qcom,scm-msm8996" },
615 { .compatible = "qcom,scm" },
619 static struct platform_driver qcom_scm_driver = {
622 .of_match_table = qcom_scm_dt_match,
624 .probe = qcom_scm_probe,
625 .shutdown = qcom_scm_shutdown,
628 static int __init qcom_scm_init(void)
630 return platform_driver_register(&qcom_scm_driver);
632 subsys_initcall(qcom_scm_init);