firmware: qcom: scm: Move the scm driver to drivers/firmware
[deliverable/linux.git] / drivers / firmware / qcom_scm.c
CommitLineData
2a1eb58a
SB
1/* Copyright (c) 2010, Code Aurora Forum. All rights reserved.
2 *
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License version 2 and
5 * only version 2 as published by the Free Software Foundation.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15 * 02110-1301, USA.
16 */
17
18#include <linux/slab.h>
19#include <linux/io.h>
20#include <linux/module.h>
21#include <linux/mutex.h>
22#include <linux/errno.h>
23#include <linux/err.h>
916f743d 24#include <linux/qcom_scm.h>
2a1eb58a 25
f76c6916 26#include <asm/outercache.h>
2a1eb58a
SB
27#include <asm/cacheflush.h>
28
2a1eb58a 29
4de43476
KG
30#define QCOM_SCM_ENOMEM -5
31#define QCOM_SCM_EOPNOTSUPP -4
32#define QCOM_SCM_EINVAL_ADDR -3
33#define QCOM_SCM_EINVAL_ARG -2
34#define QCOM_SCM_ERROR -1
35#define QCOM_SCM_INTERRUPTED 1
2a1eb58a 36
4de43476 37static DEFINE_MUTEX(qcom_scm_lock);
2a1eb58a
SB
38
39/**
4de43476 40 * struct qcom_scm_command - one SCM command buffer
2a1eb58a
SB
41 * @len: total available memory for command and response
42 * @buf_offset: start of command buffer
43 * @resp_hdr_offset: start of response buffer
44 * @id: command to be executed
4de43476 45 * @buf: buffer returned from qcom_scm_get_command_buffer()
2a1eb58a 46 *
25985edc 47 * An SCM command is laid out in memory as follows:
2a1eb58a 48 *
4de43476 49 * ------------------- <--- struct qcom_scm_command
2a1eb58a 50 * | command header |
4de43476 51 * ------------------- <--- qcom_scm_get_command_buffer()
2a1eb58a 52 * | command buffer |
4de43476
KG
53 * ------------------- <--- struct qcom_scm_response and
54 * | response header | qcom_scm_command_to_response()
55 * ------------------- <--- qcom_scm_get_response_buffer()
2a1eb58a
SB
56 * | response buffer |
57 * -------------------
58 *
59 * There can be arbitrary padding between the headers and buffers so
4de43476 60 * you should always use the appropriate qcom_scm_get_*_buffer() routines
2a1eb58a
SB
61 * to access the buffers in a safe manner.
62 */
4de43476 63struct qcom_scm_command {
7279db92
SB
64 __le32 len;
65 __le32 buf_offset;
66 __le32 resp_hdr_offset;
67 __le32 id;
68 __le32 buf[0];
2a1eb58a
SB
69};
70
71/**
4de43476 72 * struct qcom_scm_response - one SCM response buffer
2a1eb58a 73 * @len: total available memory for response
4de43476 74 * @buf_offset: start of response data relative to start of qcom_scm_response
2a1eb58a
SB
75 * @is_complete: indicates if the command has finished processing
76 */
4de43476 77struct qcom_scm_response {
7279db92
SB
78 __le32 len;
79 __le32 buf_offset;
80 __le32 is_complete;
2a1eb58a
SB
81};
82
83/**
4de43476 84 * alloc_qcom_scm_command() - Allocate an SCM command
2a1eb58a
SB
85 * @cmd_size: size of the command buffer
86 * @resp_size: size of the response buffer
87 *
88 * Allocate an SCM command, including enough room for the command
89 * and response headers as well as the command and response buffers.
90 *
4de43476 91 * Returns a valid &qcom_scm_command on success or %NULL if the allocation fails.
2a1eb58a 92 */
4de43476 93static struct qcom_scm_command *alloc_qcom_scm_command(size_t cmd_size, size_t resp_size)
2a1eb58a 94{
4de43476
KG
95 struct qcom_scm_command *cmd;
96 size_t len = sizeof(*cmd) + sizeof(struct qcom_scm_response) + cmd_size +
2a1eb58a 97 resp_size;
7279db92 98 u32 offset;
2a1eb58a
SB
99
100 cmd = kzalloc(PAGE_ALIGN(len), GFP_KERNEL);
101 if (cmd) {
7279db92 102 cmd->len = cpu_to_le32(len);
4de43476 103 offset = offsetof(struct qcom_scm_command, buf);
7279db92
SB
104 cmd->buf_offset = cpu_to_le32(offset);
105 cmd->resp_hdr_offset = cpu_to_le32(offset + cmd_size);
2a1eb58a
SB
106 }
107 return cmd;
108}
109
110/**
4de43476 111 * free_qcom_scm_command() - Free an SCM command
2a1eb58a
SB
112 * @cmd: command to free
113 *
114 * Free an SCM command.
115 */
4de43476 116static inline void free_qcom_scm_command(struct qcom_scm_command *cmd)
2a1eb58a
SB
117{
118 kfree(cmd);
119}
120
121/**
4de43476 122 * qcom_scm_command_to_response() - Get a pointer to a qcom_scm_response
2a1eb58a
SB
123 * @cmd: command
124 *
125 * Returns a pointer to a response for a command.
126 */
4de43476
KG
127static inline struct qcom_scm_response *qcom_scm_command_to_response(
128 const struct qcom_scm_command *cmd)
2a1eb58a 129{
7279db92 130 return (void *)cmd + le32_to_cpu(cmd->resp_hdr_offset);
2a1eb58a
SB
131}
132
133/**
4de43476 134 * qcom_scm_get_command_buffer() - Get a pointer to a command buffer
2a1eb58a
SB
135 * @cmd: command
136 *
137 * Returns a pointer to the command buffer of a command.
138 */
4de43476 139static inline void *qcom_scm_get_command_buffer(const struct qcom_scm_command *cmd)
2a1eb58a
SB
140{
141 return (void *)cmd->buf;
142}
143
144/**
4de43476 145 * qcom_scm_get_response_buffer() - Get a pointer to a response buffer
2a1eb58a
SB
146 * @rsp: response
147 *
148 * Returns a pointer to a response buffer of a response.
149 */
4de43476 150static inline void *qcom_scm_get_response_buffer(const struct qcom_scm_response *rsp)
2a1eb58a 151{
7279db92 152 return (void *)rsp + le32_to_cpu(rsp->buf_offset);
2a1eb58a
SB
153}
154
4de43476 155static int qcom_scm_remap_error(int err)
2a1eb58a 156{
4de43476 157 pr_err("qcom_scm_call failed with error code %d\n", err);
2a1eb58a 158 switch (err) {
4de43476 159 case QCOM_SCM_ERROR:
2a1eb58a 160 return -EIO;
4de43476
KG
161 case QCOM_SCM_EINVAL_ADDR:
162 case QCOM_SCM_EINVAL_ARG:
2a1eb58a 163 return -EINVAL;
4de43476 164 case QCOM_SCM_EOPNOTSUPP:
2a1eb58a 165 return -EOPNOTSUPP;
4de43476 166 case QCOM_SCM_ENOMEM:
2a1eb58a
SB
167 return -ENOMEM;
168 }
169 return -EINVAL;
170}
171
172static u32 smc(u32 cmd_addr)
173{
174 int context_id;
175 register u32 r0 asm("r0") = 1;
176 register u32 r1 asm("r1") = (u32)&context_id;
177 register u32 r2 asm("r2") = cmd_addr;
8e76a809
SB
178 do {
179 asm volatile(
180 __asmeq("%0", "r0")
181 __asmeq("%1", "r0")
182 __asmeq("%2", "r1")
183 __asmeq("%3", "r2")
eca55f4d
MZ
184#ifdef REQUIRES_SEC
185 ".arch_extension sec\n"
186#endif
8e76a809
SB
187 "smc #0 @ switch to secure world\n"
188 : "=r" (r0)
189 : "r" (r0), "r" (r1), "r" (r2)
190 : "r3");
4de43476 191 } while (r0 == QCOM_SCM_INTERRUPTED);
8e76a809 192
2a1eb58a
SB
193 return r0;
194}
195
4de43476 196static int __qcom_scm_call(const struct qcom_scm_command *cmd)
2a1eb58a
SB
197{
198 int ret;
199 u32 cmd_addr = virt_to_phys(cmd);
200
201 /*
404b5a97
VM
202 * Flush the command buffer so that the secure world sees
203 * the correct data.
2a1eb58a 204 */
404b5a97
VM
205 __cpuc_flush_dcache_area((void *)cmd, cmd->len);
206 outer_flush_range(cmd_addr, cmd_addr + cmd->len);
207
8e76a809
SB
208 ret = smc(cmd_addr);
209 if (ret < 0)
4de43476 210 ret = qcom_scm_remap_error(ret);
2a1eb58a
SB
211
212 return ret;
213}
214
4de43476 215static void qcom_scm_inv_range(unsigned long start, unsigned long end)
f76c6916 216{
30cbb0c0
SB
217 u32 cacheline_size, ctr;
218
219 asm volatile("mrc p15, 0, %0, c0, c0, 1" : "=r" (ctr));
220 cacheline_size = 4 << ((ctr >> 16) & 0xf);
221
222 start = round_down(start, cacheline_size);
223 end = round_up(end, cacheline_size);
f76c6916
SB
224 outer_inv_range(start, end);
225 while (start < end) {
226 asm ("mcr p15, 0, %0, c7, c6, 1" : : "r" (start)
227 : "memory");
30cbb0c0 228 start += cacheline_size;
f76c6916
SB
229 }
230 dsb();
231 isb();
232}
233
2a1eb58a 234/**
4de43476 235 * qcom_scm_call() - Send an SCM command
2a1eb58a
SB
236 * @svc_id: service identifier
237 * @cmd_id: command identifier
238 * @cmd_buf: command buffer
239 * @cmd_len: length of the command buffer
240 * @resp_buf: response buffer
241 * @resp_len: length of the response buffer
242 *
243 * Sends a command to the SCM and waits for the command to finish processing.
404b5a97
VM
244 *
245 * A note on cache maintenance:
246 * Note that any buffers that are expected to be accessed by the secure world
4de43476
KG
247 * must be flushed before invoking qcom_scm_call and invalidated in the cache
248 * immediately after qcom_scm_call returns. Cache maintenance on the command
249 * and response buffers is taken care of by qcom_scm_call; however, callers are
404b5a97 250 * responsible for any other cached buffers passed over to the secure world.
2a1eb58a 251 */
4de43476
KG
252static int qcom_scm_call(u32 svc_id, u32 cmd_id, const void *cmd_buf,
253 size_t cmd_len, void *resp_buf, size_t resp_len)
2a1eb58a
SB
254{
255 int ret;
4de43476
KG
256 struct qcom_scm_command *cmd;
257 struct qcom_scm_response *rsp;
f76c6916 258 unsigned long start, end;
2a1eb58a 259
4de43476 260 cmd = alloc_qcom_scm_command(cmd_len, resp_len);
2a1eb58a
SB
261 if (!cmd)
262 return -ENOMEM;
263
7279db92 264 cmd->id = cpu_to_le32((svc_id << 10) | cmd_id);
2a1eb58a 265 if (cmd_buf)
4de43476 266 memcpy(qcom_scm_get_command_buffer(cmd), cmd_buf, cmd_len);
2a1eb58a 267
4de43476
KG
268 mutex_lock(&qcom_scm_lock);
269 ret = __qcom_scm_call(cmd);
270 mutex_unlock(&qcom_scm_lock);
2a1eb58a
SB
271 if (ret)
272 goto out;
273
4de43476 274 rsp = qcom_scm_command_to_response(cmd);
f76c6916
SB
275 start = (unsigned long)rsp;
276
2a1eb58a 277 do {
4de43476 278 qcom_scm_inv_range(start, start + sizeof(*rsp));
2a1eb58a
SB
279 } while (!rsp->is_complete);
280
4de43476
KG
281 end = (unsigned long)qcom_scm_get_response_buffer(rsp) + resp_len;
282 qcom_scm_inv_range(start, end);
f76c6916 283
2a1eb58a 284 if (resp_buf)
4de43476 285 memcpy(resp_buf, qcom_scm_get_response_buffer(rsp), resp_len);
2a1eb58a 286out:
4de43476 287 free_qcom_scm_command(cmd);
2a1eb58a
SB
288 return ret;
289}
2a1eb58a 290
4de43476 291u32 qcom_scm_get_version(void)
2a1eb58a
SB
292{
293 int context_id;
294 static u32 version = -1;
98d4ded6
SB
295 register u32 r0 asm("r0");
296 register u32 r1 asm("r1");
2a1eb58a
SB
297
298 if (version != -1)
299 return version;
300
4de43476 301 mutex_lock(&qcom_scm_lock);
98d4ded6
SB
302
303 r0 = 0x1 << 8;
304 r1 = (u32)&context_id;
8e76a809
SB
305 do {
306 asm volatile(
307 __asmeq("%0", "r0")
308 __asmeq("%1", "r1")
309 __asmeq("%2", "r0")
310 __asmeq("%3", "r1")
26e87b13
SB
311#ifdef REQUIRES_SEC
312 ".arch_extension sec\n"
313#endif
8e76a809
SB
314 "smc #0 @ switch to secure world\n"
315 : "=r" (r0), "=r" (r1)
316 : "r" (r0), "r" (r1)
317 : "r2", "r3");
4de43476 318 } while (r0 == QCOM_SCM_INTERRUPTED);
8e76a809 319
2a1eb58a 320 version = r1;
4de43476 321 mutex_unlock(&qcom_scm_lock);
2a1eb58a
SB
322
323 return version;
324}
4de43476 325EXPORT_SYMBOL(qcom_scm_get_version);
3d9b448b 326
4de43476
KG
327#define QCOM_SCM_SVC_BOOT 0x1
328#define QCOM_SCM_BOOT_ADDR 0x1
3d9b448b
KG
329/*
330 * Set the cold/warm boot address for one of the CPU cores.
331 */
4de43476 332int qcom_scm_set_boot_addr(u32 addr, int flags)
3d9b448b
KG
333{
334 struct {
335 __le32 flags;
336 __le32 addr;
337 } cmd;
338
339 cmd.addr = cpu_to_le32(addr);
340 cmd.flags = cpu_to_le32(flags);
4de43476 341 return qcom_scm_call(QCOM_SCM_SVC_BOOT, QCOM_SCM_BOOT_ADDR,
3d9b448b
KG
342 &cmd, sizeof(cmd), NULL, 0);
343}
4de43476 344EXPORT_SYMBOL(qcom_scm_set_boot_addr);
This page took 0.23307 seconds and 5 git commands to generate.