1 /*
2 * Copyright (c) 2017-2019, Arm Limited and Contributors. All rights reserved.
3 * Copyright (c) 2022-2023, Advanced Micro Devices, Inc. All rights reserved.
4 *
5 * SPDX-License-Identifier: BSD-3-Clause
6 */
7
8 /*
9 * Top-level SMC handler for ZynqMP IPI Mailbox doorbell functions.
10 */
11
12 #include <errno.h>
13 #include <string.h>
14
15 #include <common/debug.h>
16 #include <common/runtime_svc.h>
17 #include <lib/bakery_lock.h>
18 #include <lib/mmio.h>
19
20 #include <ipi.h>
21 #include "ipi_mailbox_svc.h"
22 #include <plat_ipi.h>
23 #include <plat_private.h>
24
25 /*********************************************************************
26 * Macros definitions
27 ********************************************************************/
28
29 /* IPI SMC calls macros: */
30 #define IPI_SMC_OPEN_IRQ_MASK 0x00000001U /* IRQ enable bit in IPI
31 * open SMC call
32 */
33 #define IPI_SMC_NOTIFY_BLOCK_MASK 0x00000001U /* Flag to indicate if
34 * IPI notification needs
35 * to be blocking.
36 */
37 #define IPI_SMC_ENQUIRY_DIRQ_MASK 0x00000001U /* Flag to indicate if
38 * notification interrupt
39 * to be disabled.
40 */
41 #define IPI_SMC_ACK_EIRQ_MASK 0x00000001U /* Flag to indicate if
42 * notification interrupt
43 * to be enable.
44 */
45
46 #define UNSIGNED32_MASK 0xFFFFFFFFU /* 32bit mask */
47
48 /**
49 * ipi_smc_handler() - SMC handler for IPI SMC calls.
50 * @smc_fid: Function identifier.
51 * @x1: Arguments.
52 * @x2: Arguments.
53 * @x3: Arguments.
54 * @x4: Arguments.
55 * @cookie: Unused.
56 * @handle: Pointer to caller's context structure.
57 * @flags: SECURE_FLAG or NON_SECURE_FLAG.
58 *
59 * Return: Unused.
60 *
61 * Determines that smc_fid is valid and supported PM SMC Function ID from the
62 * list of pm_api_ids, otherwise completes the request with
63 * the unknown SMC Function ID.
64 *
65 * The SMC calls for PM service are forwarded from SIP Service SMC handler
66 * function with rt_svc_handle signature.
67 *
68 */
ipi_smc_handler(uint32_t smc_fid,uint64_t x1,uint64_t x2,uint64_t x3,uint64_t x4,const void * cookie,void * handle,uint64_t flags)69 uint64_t ipi_smc_handler(uint32_t smc_fid, uint64_t x1, uint64_t x2,
70 uint64_t x3, uint64_t x4, const void *cookie,
71 void *handle, uint64_t flags)
72 {
73 (void) x4;
74 (void) flags;
75 (void) cookie;
76 int32_t ret;
77 uint32_t ipi_local_id;
78 uint32_t ipi_remote_id;
79 uint32_t is_secure;
80
81 ipi_local_id = x1 & UNSIGNED32_MASK;
82 ipi_remote_id = x2 & UNSIGNED32_MASK;
83
84 /* OEN Number 48 to 63 is for Trusted App and OS
85 * GET_SMC_OEN limits the return value of OEN number to 63 by bitwise
86 * AND operation with 0x3F.
87 * Upper limit check for OEN value is not required.
88 */
89 if (GET_SMC_OEN(smc_fid) >= OEN_TAP_START) {
90 is_secure = 1;
91 } else {
92 is_secure = 0;
93 }
94
95 /* Validate IPI mailbox access */
96 ret = ipi_mb_validate(ipi_local_id, ipi_remote_id, is_secure);
97 if (ret != 0)
98 SMC_RET1(handle, ret);
99
100 switch (GET_SMC_NUM(smc_fid)) {
101 case IPI_MAILBOX_OPEN:
102 ipi_mb_open(ipi_local_id, ipi_remote_id);
103 SMC_RET1(handle, 0);
104 case IPI_MAILBOX_RELEASE:
105 ipi_mb_release(ipi_local_id, ipi_remote_id);
106 SMC_RET1(handle, 0);
107 case IPI_MAILBOX_STATUS_ENQUIRY:
108 {
109 int32_t disable_interrupt;
110
111 disable_interrupt = (x3 & IPI_SMC_ENQUIRY_DIRQ_MASK) ? 1 : 0;
112 ret = ipi_mb_enquire_status(ipi_local_id, ipi_remote_id);
113 if ((ret & IPI_MB_STATUS_RECV_PENDING) && disable_interrupt)
114 ipi_mb_disable_irq(ipi_local_id, ipi_remote_id);
115 SMC_RET1(handle, ret);
116 }
117 case IPI_MAILBOX_NOTIFY:
118 {
119 uint32_t is_blocking;
120
121 is_blocking = (x3 & IPI_SMC_NOTIFY_BLOCK_MASK) ? 1 : 0;
122 ipi_mb_notify(ipi_local_id, ipi_remote_id, is_blocking);
123 SMC_RET1(handle, 0);
124 }
125 case IPI_MAILBOX_ACK:
126 {
127 int32_t enable_interrupt;
128
129 enable_interrupt = (x3 & IPI_SMC_ACK_EIRQ_MASK) ? 1 : 0;
130 ipi_mb_ack(ipi_local_id, ipi_remote_id);
131 if (enable_interrupt != 0)
132 ipi_mb_enable_irq(ipi_local_id, ipi_remote_id);
133 SMC_RET1(handle, 0);
134 }
135 case IPI_MAILBOX_ENABLE_IRQ:
136 ipi_mb_enable_irq(ipi_local_id, ipi_remote_id);
137 SMC_RET1(handle, 0);
138 case IPI_MAILBOX_DISABLE_IRQ:
139 ipi_mb_disable_irq(ipi_local_id, ipi_remote_id);
140 SMC_RET1(handle, 0);
141 default:
142 WARN("Unimplemented IPI service call: 0x%x\n", smc_fid);
143 SMC_RET1(handle, SMC_UNK);
144 }
145 }
146