arch/arm/mach-qcom/scm.c

   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>
  24
  25 #include <asm/outercache.h>
  26 #include <asm/cacheflush.h>
  27
  28 #include "scm.h"
  29
  30 #define SCM_ENOMEM              -5
  31 #define SCM_EOPNOTSUPP          -4
  32 #define SCM_EINVAL_ADDR         -3
  33 #define SCM_EINVAL_ARG          -2
  34 #define SCM_ERROR               -1
  35 #define SCM_INTERRUPTED         1
  36
  37 static DEFINE_MUTEX(scm_lock);
  38
  39 /**
  40  * struct scm_command - one SCM command buffer
  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
  45  * @buf: buffer returned from scm_get_command_buffer()
  46  *
  47  * An SCM command is laid out in memory as follows:
  48  *
  49  *      ------------------- <--- struct scm_command
  50  *      | command header  |
  51  *      ------------------- <--- scm_get_command_buffer()
  52  *      | command buffer  |
  53  *      ------------------- <--- struct scm_response and
  54  *      | response header |      scm_command_to_response()
  55  *      ------------------- <--- scm_get_response_buffer()
  56  *      | response buffer |
  57  *      -------------------
  58  *
  59  * There can be arbitrary padding between the headers and buffers so
  60  * you should always use the appropriate scm_get_*_buffer() routines
  61  * to access the buffers in a safe manner.
  62  */
  63 struct scm_command {
  64         u32     len;
  65         u32     buf_offset;
  66         u32     resp_hdr_offset;
  67         u32     id;
  68         u32     buf[0];
  69 };
  70
  71 /**
  72  * struct scm_response - one SCM response buffer
  73  * @len: total available memory for response
  74  * @buf_offset: start of response data relative to start of scm_response
  75  * @is_complete: indicates if the command has finished processing
  76  */
  77 struct scm_response {
  78         u32     len;
  79         u32     buf_offset;
  80         u32     is_complete;
  81 };
  82
  83 /**
  84  * alloc_scm_command() - Allocate an SCM command
  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  *
  91  * Returns a valid &scm_command on success or %NULL if the allocation fails.
  92  */
  93 static struct scm_command *alloc_scm_command(size_t cmd_size, size_t resp_size)
  94 {
  95         struct scm_command *cmd;
  96         size_t len = sizeof(*cmd) + sizeof(struct scm_response) + cmd_size +
  97                 resp_size;
  98
  99         cmd = kzalloc(PAGE_ALIGN(len), GFP_KERNEL);
 100         if (cmd) {
 101                 cmd->len = len;
 102                 cmd->buf_offset = offsetof(struct scm_command, buf);
 103                 cmd->resp_hdr_offset = cmd->buf_offset + cmd_size;
 104         }
 105         return cmd;
 106 }
 107
 108 /**
 109  * free_scm_command() - Free an SCM command
 110  * @cmd: command to free
 111  *
 112  * Free an SCM command.
 113  */
 114 static inline void free_scm_command(struct scm_command *cmd)
 115 {
 116         kfree(cmd);
 117 }
 118
 119 /**
 120  * scm_command_to_response() - Get a pointer to a scm_response
 121  * @cmd: command
 122  *
 123  * Returns a pointer to a response for a command.
 124  */
 125 static inline struct scm_response *scm_command_to_response(
 126                 const struct scm_command *cmd)
 127 {
 128         return (void *)cmd + cmd->resp_hdr_offset;
 129 }
 130
 131 /**
 132  * scm_get_command_buffer() - Get a pointer to a command buffer
 133  * @cmd: command
 134  *
 135  * Returns a pointer to the command buffer of a command.
 136  */
 137 static inline void *scm_get_command_buffer(const struct scm_command *cmd)
 138 {
 139         return (void *)cmd->buf;
 140 }
 141
 142 /**
 143  * scm_get_response_buffer() - Get a pointer to a response buffer
 144  * @rsp: response
 145  *
 146  * Returns a pointer to a response buffer of a response.
 147  */
 148 static inline void *scm_get_response_buffer(const struct scm_response *rsp)
 149 {
 150         return (void *)rsp + rsp->buf_offset;
 151 }
 152
 153 static int scm_remap_error(int err)
 154 {
 155         pr_err("scm_call failed with error code %d\n", err);
 156         switch (err) {
 157         case SCM_ERROR:
 158                 return -EIO;
 159         case SCM_EINVAL_ADDR:
 160         case SCM_EINVAL_ARG:
 161                 return -EINVAL;
 162         case SCM_EOPNOTSUPP:
 163                 return -EOPNOTSUPP;
 164         case SCM_ENOMEM:
 165                 return -ENOMEM;
 166         }
 167         return -EINVAL;
 168 }
 169
 170 static u32 smc(u32 cmd_addr)
 171 {
 172         int context_id;
 173         register u32 r0 asm("r0") = 1;
 174         register u32 r1 asm("r1") = (u32)&context_id;
 175         register u32 r2 asm("r2") = cmd_addr;
 176         do {
 177                 asm volatile(
 178                         __asmeq("%0", "r0")
 179                         __asmeq("%1", "r0")
 180                         __asmeq("%2", "r1")
 181                         __asmeq("%3", "r2")
 182 #ifdef REQUIRES_SEC
 183                         ".arch_extension sec\n"
 184 #endif
 185                         "smc    #0      @ switch to secure world\n"
 186                         : "=r" (r0)
 187                         : "r" (r0), "r" (r1), "r" (r2)
 188                         : "r3");
 189         } while (r0 == SCM_INTERRUPTED);
 190
 191         return r0;
 192 }
 193
 194 static int __scm_call(const struct scm_command *cmd)
 195 {
 196         int ret;
 197         u32 cmd_addr = virt_to_phys(cmd);
 198
 199         /*
 200          * Flush the command buffer so that the secure world sees
 201          * the correct data.
 202          */
 203         __cpuc_flush_dcache_area((void *)cmd, cmd->len);
 204         outer_flush_range(cmd_addr, cmd_addr + cmd->len);
 205
 206         ret = smc(cmd_addr);
 207         if (ret < 0)
 208                 ret = scm_remap_error(ret);
 209
 210         return ret;
 211 }
 212
 213 static void scm_inv_range(unsigned long start, unsigned long end)
 214 {
 215         u32 cacheline_size, ctr;
 216
 217         asm volatile("mrc p15, 0, %0, c0, c0, 1" : "=r" (ctr));
 218         cacheline_size = 4 << ((ctr >> 16) & 0xf);
 219
 220         start = round_down(start, cacheline_size);
 221         end = round_up(end, cacheline_size);
 222         outer_inv_range(start, end);
 223         while (start < end) {
 224                 asm ("mcr p15, 0, %0, c7, c6, 1" : : "r" (start)
 225                      : "memory");
 226                 start += cacheline_size;
 227         }
 228         dsb();
 229         isb();
 230 }
 231
 232 /**
 233  * scm_call() - Send an SCM command
 234  * @svc_id: service identifier
 235  * @cmd_id: command identifier
 236  * @cmd_buf: command buffer
 237  * @cmd_len: length of the command buffer
 238  * @resp_buf: response buffer
 239  * @resp_len: length of the response buffer
 240  *
 241  * Sends a command to the SCM and waits for the command to finish processing.
 242  *
 243  * A note on cache maintenance:
 244  * Note that any buffers that are expected to be accessed by the secure world
 245  * must be flushed before invoking scm_call and invalidated in the cache
 246  * immediately after scm_call returns. Cache maintenance on the command and
 247  * response buffers is taken care of by scm_call; however, callers are
 248  * responsible for any other cached buffers passed over to the secure world.
 249  */
 250 int scm_call(u32 svc_id, u32 cmd_id, const void *cmd_buf, size_t cmd_len,
 251                 void *resp_buf, size_t resp_len)
 252 {
 253         int ret;
 254         struct scm_command *cmd;
 255         struct scm_response *rsp;
 256         unsigned long start, end;
 257
 258         cmd = alloc_scm_command(cmd_len, resp_len);
 259         if (!cmd)
 260                 return -ENOMEM;
 261
 262         cmd->id = (svc_id << 10) | cmd_id;
 263         if (cmd_buf)
 264                 memcpy(scm_get_command_buffer(cmd), cmd_buf, cmd_len);
 265
 266         mutex_lock(&scm_lock);
 267         ret = __scm_call(cmd);
 268         mutex_unlock(&scm_lock);
 269         if (ret)
 270                 goto out;
 271
 272         rsp = scm_command_to_response(cmd);
 273         start = (unsigned long)rsp;
 274
 275         do {
 276                 scm_inv_range(start, start + sizeof(*rsp));
 277         } while (!rsp->is_complete);
 278
 279         end = (unsigned long)scm_get_response_buffer(rsp) + resp_len;
 280         scm_inv_range(start, end);
 281
 282         if (resp_buf)
 283                 memcpy(resp_buf, scm_get_response_buffer(rsp), resp_len);
 284 out:
 285         free_scm_command(cmd);
 286         return ret;
 287 }
 288 EXPORT_SYMBOL(scm_call);
 289
 290 u32 scm_get_version(void)
 291 {
 292         int context_id;
 293         static u32 version = -1;
 294         register u32 r0 asm("r0");
 295         register u32 r1 asm("r1");
 296
 297         if (version != -1)
 298                 return version;
 299
 300         mutex_lock(&scm_lock);
 301
 302         r0 = 0x1 << 8;
 303         r1 = (u32)&context_id;
 304         do {
 305                 asm volatile(
 306                         __asmeq("%0", "r0")
 307                         __asmeq("%1", "r1")
 308                         __asmeq("%2", "r0")
 309                         __asmeq("%3", "r1")
 310 #ifdef REQUIRES_SEC
 311                         ".arch_extension sec\n"
 312 #endif
 313                         "smc    #0      @ switch to secure world\n"
 314                         : "=r" (r0), "=r" (r1)
 315                         : "r" (r0), "r" (r1)
 316                         : "r2", "r3");
 317         } while (r0 == SCM_INTERRUPTED);
 318
 319         version = r1;
 320         mutex_unlock(&scm_lock);
 321
 322         return version;
 323 }
 324 EXPORT_SYMBOL(scm_get_version);