Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) 2017-2018, Intel Corporation
4 */
5
6#include <linux/completion.h>
7#include <linux/delay.h>
8#include <linux/genalloc.h>
9#include <linux/io.h>
10#include <linux/kfifo.h>
11#include <linux/kthread.h>
12#include <linux/module.h>
13#include <linux/mutex.h>
14#include <linux/of.h>
15#include <linux/of_platform.h>
16#include <linux/platform_device.h>
17#include <linux/slab.h>
18#include <linux/spinlock.h>
19#include <linux/firmware/intel/stratix10-smc.h>
20#include <linux/firmware/intel/stratix10-svc-client.h>
21#include <linux/types.h>
22
23/**
24 * SVC_NUM_DATA_IN_FIFO - number of struct stratix10_svc_data in the FIFO
25 *
26 * SVC_NUM_CHANNEL - number of channel supported by service layer driver
27 *
28 * FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS - claim back the submitted buffer(s)
29 * from the secure world for FPGA manager to reuse, or to free the buffer(s)
30 * when all bit-stream data had be send.
31 *
32 * FPGA_CONFIG_STATUS_TIMEOUT_SEC - poll the FPGA configuration status,
33 * service layer will return error to FPGA manager when timeout occurs,
34 * timeout is set to 30 seconds (30 * 1000) at Intel Stratix10 SoC.
35 */
36#define SVC_NUM_DATA_IN_FIFO 32
37#define SVC_NUM_CHANNEL 3
38#define FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS 200
39#define FPGA_CONFIG_STATUS_TIMEOUT_SEC 30
40
41/* stratix10 service layer clients */
42#define STRATIX10_RSU "stratix10-rsu"
43#define INTEL_FCS "intel-fcs"
44
45typedef void (svc_invoke_fn)(unsigned long, unsigned long, unsigned long,
46 unsigned long, unsigned long, unsigned long,
47 unsigned long, unsigned long,
48 struct arm_smccc_res *);
49struct stratix10_svc_chan;
50
51/**
52 * struct stratix10_svc - svc private data
53 * @stratix10_svc_rsu: pointer to stratix10 RSU device
54 */
55struct stratix10_svc {
56 struct platform_device *stratix10_svc_rsu;
57 struct platform_device *intel_svc_fcs;
58};
59
60/**
61 * struct stratix10_svc_sh_memory - service shared memory structure
62 * @sync_complete: state for a completion
63 * @addr: physical address of shared memory block
64 * @size: size of shared memory block
65 * @invoke_fn: function to issue secure monitor or hypervisor call
66 *
67 * This struct is used to save physical address and size of shared memory
68 * block. The shared memory blocked is allocated by secure monitor software
69 * at secure world.
70 *
71 * Service layer driver uses the physical address and size to create a memory
72 * pool, then allocates data buffer from that memory pool for service client.
73 */
74struct stratix10_svc_sh_memory {
75 struct completion sync_complete;
76 unsigned long addr;
77 unsigned long size;
78 svc_invoke_fn *invoke_fn;
79};
80
81/**
82 * struct stratix10_svc_data_mem - service memory structure
83 * @vaddr: virtual address
84 * @paddr: physical address
85 * @size: size of memory
86 * @node: link list head node
87 *
88 * This struct is used in a list that keeps track of buffers which have
89 * been allocated or freed from the memory pool. Service layer driver also
90 * uses this struct to transfer physical address to virtual address.
91 */
92struct stratix10_svc_data_mem {
93 void *vaddr;
94 phys_addr_t paddr;
95 size_t size;
96 struct list_head node;
97};
98
99/**
100 * struct stratix10_svc_data - service data structure
101 * @chan: service channel
102 * @paddr: physical address of to be processed payload
103 * @size: to be processed playload size
104 * @paddr_output: physical address of processed payload
105 * @size_output: processed payload size
106 * @command: service command requested by client
107 * @flag: configuration type (full or partial)
108 * @arg: args to be passed via registers and not physically mapped buffers
109 *
110 * This struct is used in service FIFO for inter-process communication.
111 */
112struct stratix10_svc_data {
113 struct stratix10_svc_chan *chan;
114 phys_addr_t paddr;
115 size_t size;
116 phys_addr_t paddr_output;
117 size_t size_output;
118 u32 command;
119 u32 flag;
120 u64 arg[3];
121};
122
123/**
124 * struct stratix10_svc_controller - service controller
125 * @dev: device
126 * @chans: array of service channels
127 * @num_chans: number of channels in 'chans' array
128 * @num_active_client: number of active service client
129 * @node: list management
130 * @genpool: memory pool pointing to the memory region
131 * @task: pointer to the thread task which handles SMC or HVC call
132 * @svc_fifo: a queue for storing service message data
133 * @complete_status: state for completion
134 * @svc_fifo_lock: protect access to service message data queue
135 * @invoke_fn: function to issue secure monitor call or hypervisor call
136 *
137 * This struct is used to create communication channels for service clients, to
138 * handle secure monitor or hypervisor call.
139 */
140struct stratix10_svc_controller {
141 struct device *dev;
142 struct stratix10_svc_chan *chans;
143 int num_chans;
144 int num_active_client;
145 struct list_head node;
146 struct gen_pool *genpool;
147 struct task_struct *task;
148 struct kfifo svc_fifo;
149 struct completion complete_status;
150 spinlock_t svc_fifo_lock;
151 svc_invoke_fn *invoke_fn;
152};
153
154/**
155 * struct stratix10_svc_chan - service communication channel
156 * @ctrl: pointer to service controller which is the provider of this channel
157 * @scl: pointer to service client which owns the channel
158 * @name: service client name associated with the channel
159 * @lock: protect access to the channel
160 *
161 * This struct is used by service client to communicate with service layer, each
162 * service client has its own channel created by service controller.
163 */
164struct stratix10_svc_chan {
165 struct stratix10_svc_controller *ctrl;
166 struct stratix10_svc_client *scl;
167 char *name;
168 spinlock_t lock;
169};
170
171static LIST_HEAD(svc_ctrl);
172static LIST_HEAD(svc_data_mem);
173
174/**
175 * svc_pa_to_va() - translate physical address to virtual address
176 * @addr: to be translated physical address
177 *
178 * Return: valid virtual address or NULL if the provided physical
179 * address doesn't exist.
180 */
181static void *svc_pa_to_va(unsigned long addr)
182{
183 struct stratix10_svc_data_mem *pmem;
184
185 pr_debug("claim back P-addr=0x%016x\n", (unsigned int)addr);
186 list_for_each_entry(pmem, &svc_data_mem, node)
187 if (pmem->paddr == addr)
188 return pmem->vaddr;
189
190 /* physical address is not found */
191 return NULL;
192}
193
194/**
195 * svc_thread_cmd_data_claim() - claim back buffer from the secure world
196 * @ctrl: pointer to service layer controller
197 * @p_data: pointer to service data structure
198 * @cb_data: pointer to callback data structure to service client
199 *
200 * Claim back the submitted buffers from the secure world and pass buffer
201 * back to service client (FPGA manager, etc) for reuse.
202 */
203static void svc_thread_cmd_data_claim(struct stratix10_svc_controller *ctrl,
204 struct stratix10_svc_data *p_data,
205 struct stratix10_svc_cb_data *cb_data)
206{
207 struct arm_smccc_res res;
208 unsigned long timeout;
209
210 reinit_completion(&ctrl->complete_status);
211 timeout = msecs_to_jiffies(FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS);
212
213 pr_debug("%s: claim back the submitted buffer\n", __func__);
214 do {
215 ctrl->invoke_fn(INTEL_SIP_SMC_FPGA_CONFIG_COMPLETED_WRITE,
216 0, 0, 0, 0, 0, 0, 0, &res);
217
218 if (res.a0 == INTEL_SIP_SMC_STATUS_OK) {
219 if (!res.a1) {
220 complete(&ctrl->complete_status);
221 break;
222 }
223 cb_data->status = BIT(SVC_STATUS_BUFFER_DONE);
224 cb_data->kaddr1 = svc_pa_to_va(res.a1);
225 cb_data->kaddr2 = (res.a2) ?
226 svc_pa_to_va(res.a2) : NULL;
227 cb_data->kaddr3 = (res.a3) ?
228 svc_pa_to_va(res.a3) : NULL;
229 p_data->chan->scl->receive_cb(p_data->chan->scl,
230 cb_data);
231 } else {
232 pr_debug("%s: secure world busy, polling again\n",
233 __func__);
234 }
235 } while (res.a0 == INTEL_SIP_SMC_STATUS_OK ||
236 res.a0 == INTEL_SIP_SMC_STATUS_BUSY ||
237 wait_for_completion_timeout(&ctrl->complete_status, timeout));
238}
239
240/**
241 * svc_thread_cmd_config_status() - check configuration status
242 * @ctrl: pointer to service layer controller
243 * @p_data: pointer to service data structure
244 * @cb_data: pointer to callback data structure to service client
245 *
246 * Check whether the secure firmware at secure world has finished the FPGA
247 * configuration, and then inform FPGA manager the configuration status.
248 */
249static void svc_thread_cmd_config_status(struct stratix10_svc_controller *ctrl,
250 struct stratix10_svc_data *p_data,
251 struct stratix10_svc_cb_data *cb_data)
252{
253 struct arm_smccc_res res;
254 int count_in_sec;
255 unsigned long a0, a1, a2;
256
257 cb_data->kaddr1 = NULL;
258 cb_data->kaddr2 = NULL;
259 cb_data->kaddr3 = NULL;
260 cb_data->status = BIT(SVC_STATUS_ERROR);
261
262 pr_debug("%s: polling config status\n", __func__);
263
264 a0 = INTEL_SIP_SMC_FPGA_CONFIG_ISDONE;
265 a1 = (unsigned long)p_data->paddr;
266 a2 = (unsigned long)p_data->size;
267
268 if (p_data->command == COMMAND_POLL_SERVICE_STATUS)
269 a0 = INTEL_SIP_SMC_SERVICE_COMPLETED;
270
271 count_in_sec = FPGA_CONFIG_STATUS_TIMEOUT_SEC;
272 while (count_in_sec) {
273 ctrl->invoke_fn(a0, a1, a2, 0, 0, 0, 0, 0, &res);
274 if ((res.a0 == INTEL_SIP_SMC_STATUS_OK) ||
275 (res.a0 == INTEL_SIP_SMC_STATUS_ERROR) ||
276 (res.a0 == INTEL_SIP_SMC_STATUS_REJECTED))
277 break;
278
279 /*
280 * request is still in progress, wait one second then
281 * poll again
282 */
283 msleep(1000);
284 count_in_sec--;
285 }
286
287 if (!count_in_sec) {
288 pr_err("%s: poll status timeout\n", __func__);
289 cb_data->status = BIT(SVC_STATUS_BUSY);
290 } else if (res.a0 == INTEL_SIP_SMC_STATUS_OK) {
291 cb_data->status = BIT(SVC_STATUS_COMPLETED);
292 cb_data->kaddr2 = (res.a2) ?
293 svc_pa_to_va(res.a2) : NULL;
294 cb_data->kaddr3 = (res.a3) ? &res.a3 : NULL;
295 } else {
296 pr_err("%s: poll status error\n", __func__);
297 cb_data->kaddr1 = &res.a1;
298 cb_data->kaddr2 = (res.a2) ?
299 svc_pa_to_va(res.a2) : NULL;
300 cb_data->kaddr3 = (res.a3) ? &res.a3 : NULL;
301 cb_data->status = BIT(SVC_STATUS_ERROR);
302 }
303
304 p_data->chan->scl->receive_cb(p_data->chan->scl, cb_data);
305}
306
307/**
308 * svc_thread_recv_status_ok() - handle the successful status
309 * @p_data: pointer to service data structure
310 * @cb_data: pointer to callback data structure to service client
311 * @res: result from SMC or HVC call
312 *
313 * Send back the correspond status to the service clients.
314 */
315static void svc_thread_recv_status_ok(struct stratix10_svc_data *p_data,
316 struct stratix10_svc_cb_data *cb_data,
317 struct arm_smccc_res res)
318{
319 cb_data->kaddr1 = NULL;
320 cb_data->kaddr2 = NULL;
321 cb_data->kaddr3 = NULL;
322
323 switch (p_data->command) {
324 case COMMAND_RECONFIG:
325 case COMMAND_RSU_UPDATE:
326 case COMMAND_RSU_NOTIFY:
327 case COMMAND_FCS_REQUEST_SERVICE:
328 case COMMAND_FCS_SEND_CERTIFICATE:
329 case COMMAND_FCS_DATA_ENCRYPTION:
330 case COMMAND_FCS_DATA_DECRYPTION:
331 cb_data->status = BIT(SVC_STATUS_OK);
332 break;
333 case COMMAND_RECONFIG_DATA_SUBMIT:
334 cb_data->status = BIT(SVC_STATUS_BUFFER_SUBMITTED);
335 break;
336 case COMMAND_RECONFIG_STATUS:
337 cb_data->status = BIT(SVC_STATUS_COMPLETED);
338 break;
339 case COMMAND_RSU_RETRY:
340 case COMMAND_RSU_MAX_RETRY:
341 case COMMAND_RSU_DCMF_STATUS:
342 case COMMAND_FIRMWARE_VERSION:
343 cb_data->status = BIT(SVC_STATUS_OK);
344 cb_data->kaddr1 = &res.a1;
345 break;
346 case COMMAND_SMC_SVC_VERSION:
347 cb_data->status = BIT(SVC_STATUS_OK);
348 cb_data->kaddr1 = &res.a1;
349 cb_data->kaddr2 = &res.a2;
350 break;
351 case COMMAND_RSU_DCMF_VERSION:
352 cb_data->status = BIT(SVC_STATUS_OK);
353 cb_data->kaddr1 = &res.a1;
354 cb_data->kaddr2 = &res.a2;
355 break;
356 case COMMAND_FCS_RANDOM_NUMBER_GEN:
357 case COMMAND_FCS_GET_PROVISION_DATA:
358 case COMMAND_POLL_SERVICE_STATUS:
359 cb_data->status = BIT(SVC_STATUS_OK);
360 cb_data->kaddr1 = &res.a1;
361 cb_data->kaddr2 = svc_pa_to_va(res.a2);
362 cb_data->kaddr3 = &res.a3;
363 break;
364 default:
365 pr_warn("it shouldn't happen\n");
366 break;
367 }
368
369 pr_debug("%s: call receive_cb\n", __func__);
370 p_data->chan->scl->receive_cb(p_data->chan->scl, cb_data);
371}
372
373/**
374 * svc_normal_to_secure_thread() - the function to run in the kthread
375 * @data: data pointer for kthread function
376 *
377 * Service layer driver creates stratix10_svc_smc_hvc_call kthread on CPU
378 * node 0, its function stratix10_svc_secure_call_thread is used to handle
379 * SMC or HVC calls between kernel driver and secure monitor software.
380 *
381 * Return: 0 for success or -ENOMEM on error.
382 */
383static int svc_normal_to_secure_thread(void *data)
384{
385 struct stratix10_svc_controller
386 *ctrl = (struct stratix10_svc_controller *)data;
387 struct stratix10_svc_data *pdata;
388 struct stratix10_svc_cb_data *cbdata;
389 struct arm_smccc_res res;
390 unsigned long a0, a1, a2, a3, a4, a5, a6, a7;
391 int ret_fifo = 0;
392
393 pdata = kmalloc(sizeof(*pdata), GFP_KERNEL);
394 if (!pdata)
395 return -ENOMEM;
396
397 cbdata = kmalloc(sizeof(*cbdata), GFP_KERNEL);
398 if (!cbdata) {
399 kfree(pdata);
400 return -ENOMEM;
401 }
402
403 /* default set, to remove build warning */
404 a0 = INTEL_SIP_SMC_FPGA_CONFIG_LOOPBACK;
405 a1 = 0;
406 a2 = 0;
407 a3 = 0;
408 a4 = 0;
409 a5 = 0;
410 a6 = 0;
411 a7 = 0;
412
413 pr_debug("smc_hvc_shm_thread is running\n");
414
415 while (!kthread_should_stop()) {
416 ret_fifo = kfifo_out_spinlocked(&ctrl->svc_fifo,
417 pdata, sizeof(*pdata),
418 &ctrl->svc_fifo_lock);
419
420 if (!ret_fifo)
421 continue;
422
423 pr_debug("get from FIFO pa=0x%016x, command=%u, size=%u\n",
424 (unsigned int)pdata->paddr, pdata->command,
425 (unsigned int)pdata->size);
426
427 switch (pdata->command) {
428 case COMMAND_RECONFIG_DATA_CLAIM:
429 svc_thread_cmd_data_claim(ctrl, pdata, cbdata);
430 continue;
431 case COMMAND_RECONFIG:
432 a0 = INTEL_SIP_SMC_FPGA_CONFIG_START;
433 pr_debug("conf_type=%u\n", (unsigned int)pdata->flag);
434 a1 = pdata->flag;
435 a2 = 0;
436 break;
437 case COMMAND_RECONFIG_DATA_SUBMIT:
438 a0 = INTEL_SIP_SMC_FPGA_CONFIG_WRITE;
439 a1 = (unsigned long)pdata->paddr;
440 a2 = (unsigned long)pdata->size;
441 break;
442 case COMMAND_RECONFIG_STATUS:
443 a0 = INTEL_SIP_SMC_FPGA_CONFIG_ISDONE;
444 a1 = 0;
445 a2 = 0;
446 break;
447 case COMMAND_RSU_STATUS:
448 a0 = INTEL_SIP_SMC_RSU_STATUS;
449 a1 = 0;
450 a2 = 0;
451 break;
452 case COMMAND_RSU_UPDATE:
453 a0 = INTEL_SIP_SMC_RSU_UPDATE;
454 a1 = pdata->arg[0];
455 a2 = 0;
456 break;
457 case COMMAND_RSU_NOTIFY:
458 a0 = INTEL_SIP_SMC_RSU_NOTIFY;
459 a1 = pdata->arg[0];
460 a2 = 0;
461 break;
462 case COMMAND_RSU_RETRY:
463 a0 = INTEL_SIP_SMC_RSU_RETRY_COUNTER;
464 a1 = 0;
465 a2 = 0;
466 break;
467 case COMMAND_RSU_MAX_RETRY:
468 a0 = INTEL_SIP_SMC_RSU_MAX_RETRY;
469 a1 = 0;
470 a2 = 0;
471 break;
472 case COMMAND_RSU_DCMF_VERSION:
473 a0 = INTEL_SIP_SMC_RSU_DCMF_VERSION;
474 a1 = 0;
475 a2 = 0;
476 break;
477 case COMMAND_FIRMWARE_VERSION:
478 a0 = INTEL_SIP_SMC_FIRMWARE_VERSION;
479 a1 = 0;
480 a2 = 0;
481 break;
482
483 /* for FCS */
484 case COMMAND_FCS_DATA_ENCRYPTION:
485 a0 = INTEL_SIP_SMC_FCS_CRYPTION;
486 a1 = 1;
487 a2 = (unsigned long)pdata->paddr;
488 a3 = (unsigned long)pdata->size;
489 a4 = (unsigned long)pdata->paddr_output;
490 a5 = (unsigned long)pdata->size_output;
491 break;
492 case COMMAND_FCS_DATA_DECRYPTION:
493 a0 = INTEL_SIP_SMC_FCS_CRYPTION;
494 a1 = 0;
495 a2 = (unsigned long)pdata->paddr;
496 a3 = (unsigned long)pdata->size;
497 a4 = (unsigned long)pdata->paddr_output;
498 a5 = (unsigned long)pdata->size_output;
499 break;
500 case COMMAND_FCS_RANDOM_NUMBER_GEN:
501 a0 = INTEL_SIP_SMC_FCS_RANDOM_NUMBER;
502 a1 = (unsigned long)pdata->paddr;
503 a2 = 0;
504 break;
505 case COMMAND_FCS_REQUEST_SERVICE:
506 a0 = INTEL_SIP_SMC_FCS_SERVICE_REQUEST;
507 a1 = (unsigned long)pdata->paddr;
508 a2 = (unsigned long)pdata->size;
509 break;
510 case COMMAND_FCS_SEND_CERTIFICATE:
511 a0 = INTEL_SIP_SMC_FCS_SEND_CERTIFICATE;
512 a1 = (unsigned long)pdata->paddr;
513 a2 = (unsigned long)pdata->size;
514 break;
515 case COMMAND_FCS_GET_PROVISION_DATA:
516 a0 = INTEL_SIP_SMC_FCS_GET_PROVISION_DATA;
517 a1 = (unsigned long)pdata->paddr;
518 a2 = 0;
519 break;
520
521 /* for polling */
522 case COMMAND_POLL_SERVICE_STATUS:
523 a0 = INTEL_SIP_SMC_SERVICE_COMPLETED;
524 a1 = (unsigned long)pdata->paddr;
525 a2 = (unsigned long)pdata->size;
526 break;
527 case COMMAND_RSU_DCMF_STATUS:
528 a0 = INTEL_SIP_SMC_RSU_DCMF_STATUS;
529 a1 = 0;
530 a2 = 0;
531 break;
532 case COMMAND_SMC_SVC_VERSION:
533 a0 = INTEL_SIP_SMC_SVC_VERSION;
534 a1 = 0;
535 a2 = 0;
536 break;
537 default:
538 pr_warn("it shouldn't happen\n");
539 break;
540 }
541 pr_debug("%s: before SMC call -- a0=0x%016x a1=0x%016x",
542 __func__,
543 (unsigned int)a0,
544 (unsigned int)a1);
545 pr_debug(" a2=0x%016x\n", (unsigned int)a2);
546 pr_debug(" a3=0x%016x\n", (unsigned int)a3);
547 pr_debug(" a4=0x%016x\n", (unsigned int)a4);
548 pr_debug(" a5=0x%016x\n", (unsigned int)a5);
549 ctrl->invoke_fn(a0, a1, a2, a3, a4, a5, a6, a7, &res);
550
551 pr_debug("%s: after SMC call -- res.a0=0x%016x",
552 __func__, (unsigned int)res.a0);
553 pr_debug(" res.a1=0x%016x, res.a2=0x%016x",
554 (unsigned int)res.a1, (unsigned int)res.a2);
555 pr_debug(" res.a3=0x%016x\n", (unsigned int)res.a3);
556
557 if (pdata->command == COMMAND_RSU_STATUS) {
558 if (res.a0 == INTEL_SIP_SMC_RSU_ERROR)
559 cbdata->status = BIT(SVC_STATUS_ERROR);
560 else
561 cbdata->status = BIT(SVC_STATUS_OK);
562
563 cbdata->kaddr1 = &res;
564 cbdata->kaddr2 = NULL;
565 cbdata->kaddr3 = NULL;
566 pdata->chan->scl->receive_cb(pdata->chan->scl, cbdata);
567 continue;
568 }
569
570 switch (res.a0) {
571 case INTEL_SIP_SMC_STATUS_OK:
572 svc_thread_recv_status_ok(pdata, cbdata, res);
573 break;
574 case INTEL_SIP_SMC_STATUS_BUSY:
575 switch (pdata->command) {
576 case COMMAND_RECONFIG_DATA_SUBMIT:
577 svc_thread_cmd_data_claim(ctrl,
578 pdata, cbdata);
579 break;
580 case COMMAND_RECONFIG_STATUS:
581 case COMMAND_POLL_SERVICE_STATUS:
582 svc_thread_cmd_config_status(ctrl,
583 pdata, cbdata);
584 break;
585 default:
586 pr_warn("it shouldn't happen\n");
587 break;
588 }
589 break;
590 case INTEL_SIP_SMC_STATUS_REJECTED:
591 pr_debug("%s: STATUS_REJECTED\n", __func__);
592 /* for FCS */
593 switch (pdata->command) {
594 case COMMAND_FCS_REQUEST_SERVICE:
595 case COMMAND_FCS_SEND_CERTIFICATE:
596 case COMMAND_FCS_GET_PROVISION_DATA:
597 case COMMAND_FCS_DATA_ENCRYPTION:
598 case COMMAND_FCS_DATA_DECRYPTION:
599 case COMMAND_FCS_RANDOM_NUMBER_GEN:
600 cbdata->status = BIT(SVC_STATUS_INVALID_PARAM);
601 cbdata->kaddr1 = NULL;
602 cbdata->kaddr2 = NULL;
603 cbdata->kaddr3 = NULL;
604 pdata->chan->scl->receive_cb(pdata->chan->scl,
605 cbdata);
606 break;
607 }
608 break;
609 case INTEL_SIP_SMC_STATUS_ERROR:
610 case INTEL_SIP_SMC_RSU_ERROR:
611 pr_err("%s: STATUS_ERROR\n", __func__);
612 cbdata->status = BIT(SVC_STATUS_ERROR);
613 cbdata->kaddr1 = &res.a1;
614 cbdata->kaddr2 = (res.a2) ?
615 svc_pa_to_va(res.a2) : NULL;
616 cbdata->kaddr3 = (res.a3) ? &res.a3 : NULL;
617 pdata->chan->scl->receive_cb(pdata->chan->scl, cbdata);
618 break;
619 default:
620 pr_warn("Secure firmware doesn't support...\n");
621
622 /*
623 * be compatible with older version firmware which
624 * doesn't support newer RSU commands
625 */
626 if ((pdata->command != COMMAND_RSU_UPDATE) &&
627 (pdata->command != COMMAND_RSU_STATUS)) {
628 cbdata->status =
629 BIT(SVC_STATUS_NO_SUPPORT);
630 cbdata->kaddr1 = NULL;
631 cbdata->kaddr2 = NULL;
632 cbdata->kaddr3 = NULL;
633 pdata->chan->scl->receive_cb(
634 pdata->chan->scl, cbdata);
635 }
636 break;
637
638 }
639 }
640
641 kfree(cbdata);
642 kfree(pdata);
643
644 return 0;
645}
646
647/**
648 * svc_normal_to_secure_shm_thread() - the function to run in the kthread
649 * @data: data pointer for kthread function
650 *
651 * Service layer driver creates stratix10_svc_smc_hvc_shm kthread on CPU
652 * node 0, its function stratix10_svc_secure_shm_thread is used to query the
653 * physical address of memory block reserved by secure monitor software at
654 * secure world.
655 *
656 * svc_normal_to_secure_shm_thread() terminates directly since it is a
657 * standlone thread for which no one will call kthread_stop() or return when
658 * 'kthread_should_stop()' is true.
659 */
660static int svc_normal_to_secure_shm_thread(void *data)
661{
662 struct stratix10_svc_sh_memory
663 *sh_mem = (struct stratix10_svc_sh_memory *)data;
664 struct arm_smccc_res res;
665
666 /* SMC or HVC call to get shared memory info from secure world */
667 sh_mem->invoke_fn(INTEL_SIP_SMC_FPGA_CONFIG_GET_MEM,
668 0, 0, 0, 0, 0, 0, 0, &res);
669 if (res.a0 == INTEL_SIP_SMC_STATUS_OK) {
670 sh_mem->addr = res.a1;
671 sh_mem->size = res.a2;
672 } else {
673 pr_err("%s: after SMC call -- res.a0=0x%016x", __func__,
674 (unsigned int)res.a0);
675 sh_mem->addr = 0;
676 sh_mem->size = 0;
677 }
678
679 complete(&sh_mem->sync_complete);
680 return 0;
681}
682
683/**
684 * svc_get_sh_memory() - get memory block reserved by secure monitor SW
685 * @pdev: pointer to service layer device
686 * @sh_memory: pointer to service shared memory structure
687 *
688 * Return: zero for successfully getting the physical address of memory block
689 * reserved by secure monitor software, or negative value on error.
690 */
691static int svc_get_sh_memory(struct platform_device *pdev,
692 struct stratix10_svc_sh_memory *sh_memory)
693{
694 struct device *dev = &pdev->dev;
695 struct task_struct *sh_memory_task;
696 unsigned int cpu = 0;
697
698 init_completion(&sh_memory->sync_complete);
699
700 /* smc or hvc call happens on cpu 0 bound kthread */
701 sh_memory_task = kthread_create_on_node(svc_normal_to_secure_shm_thread,
702 (void *)sh_memory,
703 cpu_to_node(cpu),
704 "svc_smc_hvc_shm_thread");
705 if (IS_ERR(sh_memory_task)) {
706 dev_err(dev, "fail to create stratix10_svc_smc_shm_thread\n");
707 return -EINVAL;
708 }
709
710 wake_up_process(sh_memory_task);
711
712 if (!wait_for_completion_timeout(&sh_memory->sync_complete, 10 * HZ)) {
713 dev_err(dev,
714 "timeout to get sh-memory paras from secure world\n");
715 return -ETIMEDOUT;
716 }
717
718 if (!sh_memory->addr || !sh_memory->size) {
719 dev_err(dev,
720 "failed to get shared memory info from secure world\n");
721 return -ENOMEM;
722 }
723
724 dev_dbg(dev, "SM software provides paddr: 0x%016x, size: 0x%08x\n",
725 (unsigned int)sh_memory->addr,
726 (unsigned int)sh_memory->size);
727
728 return 0;
729}
730
731/**
732 * svc_create_memory_pool() - create a memory pool from reserved memory block
733 * @pdev: pointer to service layer device
734 * @sh_memory: pointer to service shared memory structure
735 *
736 * Return: pool allocated from reserved memory block or ERR_PTR() on error.
737 */
738static struct gen_pool *
739svc_create_memory_pool(struct platform_device *pdev,
740 struct stratix10_svc_sh_memory *sh_memory)
741{
742 struct device *dev = &pdev->dev;
743 struct gen_pool *genpool;
744 unsigned long vaddr;
745 phys_addr_t paddr;
746 size_t size;
747 phys_addr_t begin;
748 phys_addr_t end;
749 void *va;
750 size_t page_mask = PAGE_SIZE - 1;
751 int min_alloc_order = 3;
752 int ret;
753
754 begin = roundup(sh_memory->addr, PAGE_SIZE);
755 end = rounddown(sh_memory->addr + sh_memory->size, PAGE_SIZE);
756 paddr = begin;
757 size = end - begin;
758 va = memremap(paddr, size, MEMREMAP_WC);
759 if (!va) {
760 dev_err(dev, "fail to remap shared memory\n");
761 return ERR_PTR(-EINVAL);
762 }
763 vaddr = (unsigned long)va;
764 dev_dbg(dev,
765 "reserved memory vaddr: %p, paddr: 0x%16x size: 0x%8x\n",
766 va, (unsigned int)paddr, (unsigned int)size);
767 if ((vaddr & page_mask) || (paddr & page_mask) ||
768 (size & page_mask)) {
769 dev_err(dev, "page is not aligned\n");
770 return ERR_PTR(-EINVAL);
771 }
772 genpool = gen_pool_create(min_alloc_order, -1);
773 if (!genpool) {
774 dev_err(dev, "fail to create genpool\n");
775 return ERR_PTR(-ENOMEM);
776 }
777 gen_pool_set_algo(genpool, gen_pool_best_fit, NULL);
778 ret = gen_pool_add_virt(genpool, vaddr, paddr, size, -1);
779 if (ret) {
780 dev_err(dev, "fail to add memory chunk to the pool\n");
781 gen_pool_destroy(genpool);
782 return ERR_PTR(ret);
783 }
784
785 return genpool;
786}
787
788/**
789 * svc_smccc_smc() - secure monitor call between normal and secure world
790 * @a0: argument passed in registers 0
791 * @a1: argument passed in registers 1
792 * @a2: argument passed in registers 2
793 * @a3: argument passed in registers 3
794 * @a4: argument passed in registers 4
795 * @a5: argument passed in registers 5
796 * @a6: argument passed in registers 6
797 * @a7: argument passed in registers 7
798 * @res: result values from register 0 to 3
799 */
800static void svc_smccc_smc(unsigned long a0, unsigned long a1,
801 unsigned long a2, unsigned long a3,
802 unsigned long a4, unsigned long a5,
803 unsigned long a6, unsigned long a7,
804 struct arm_smccc_res *res)
805{
806 arm_smccc_smc(a0, a1, a2, a3, a4, a5, a6, a7, res);
807}
808
809/**
810 * svc_smccc_hvc() - hypervisor call between normal and secure world
811 * @a0: argument passed in registers 0
812 * @a1: argument passed in registers 1
813 * @a2: argument passed in registers 2
814 * @a3: argument passed in registers 3
815 * @a4: argument passed in registers 4
816 * @a5: argument passed in registers 5
817 * @a6: argument passed in registers 6
818 * @a7: argument passed in registers 7
819 * @res: result values from register 0 to 3
820 */
821static void svc_smccc_hvc(unsigned long a0, unsigned long a1,
822 unsigned long a2, unsigned long a3,
823 unsigned long a4, unsigned long a5,
824 unsigned long a6, unsigned long a7,
825 struct arm_smccc_res *res)
826{
827 arm_smccc_hvc(a0, a1, a2, a3, a4, a5, a6, a7, res);
828}
829
830/**
831 * get_invoke_func() - invoke SMC or HVC call
832 * @dev: pointer to device
833 *
834 * Return: function pointer to svc_smccc_smc or svc_smccc_hvc.
835 */
836static svc_invoke_fn *get_invoke_func(struct device *dev)
837{
838 const char *method;
839
840 if (of_property_read_string(dev->of_node, "method", &method)) {
841 dev_warn(dev, "missing \"method\" property\n");
842 return ERR_PTR(-ENXIO);
843 }
844
845 if (!strcmp(method, "smc"))
846 return svc_smccc_smc;
847 if (!strcmp(method, "hvc"))
848 return svc_smccc_hvc;
849
850 dev_warn(dev, "invalid \"method\" property: %s\n", method);
851
852 return ERR_PTR(-EINVAL);
853}
854
855/**
856 * stratix10_svc_request_channel_byname() - request a service channel
857 * @client: pointer to service client
858 * @name: service client name
859 *
860 * This function is used by service client to request a service channel.
861 *
862 * Return: a pointer to channel assigned to the client on success,
863 * or ERR_PTR() on error.
864 */
865struct stratix10_svc_chan *stratix10_svc_request_channel_byname(
866 struct stratix10_svc_client *client, const char *name)
867{
868 struct device *dev = client->dev;
869 struct stratix10_svc_controller *controller;
870 struct stratix10_svc_chan *chan = NULL;
871 unsigned long flag;
872 int i;
873
874 /* if probe was called after client's, or error on probe */
875 if (list_empty(&svc_ctrl))
876 return ERR_PTR(-EPROBE_DEFER);
877
878 controller = list_first_entry(&svc_ctrl,
879 struct stratix10_svc_controller, node);
880 for (i = 0; i < SVC_NUM_CHANNEL; i++) {
881 if (!strcmp(controller->chans[i].name, name)) {
882 chan = &controller->chans[i];
883 break;
884 }
885 }
886
887 /* if there was no channel match */
888 if (i == SVC_NUM_CHANNEL) {
889 dev_err(dev, "%s: channel not allocated\n", __func__);
890 return ERR_PTR(-EINVAL);
891 }
892
893 if (chan->scl || !try_module_get(controller->dev->driver->owner)) {
894 dev_dbg(dev, "%s: svc not free\n", __func__);
895 return ERR_PTR(-EBUSY);
896 }
897
898 spin_lock_irqsave(&chan->lock, flag);
899 chan->scl = client;
900 chan->ctrl->num_active_client++;
901 spin_unlock_irqrestore(&chan->lock, flag);
902
903 return chan;
904}
905EXPORT_SYMBOL_GPL(stratix10_svc_request_channel_byname);
906
907/**
908 * stratix10_svc_free_channel() - free service channel
909 * @chan: service channel to be freed
910 *
911 * This function is used by service client to free a service channel.
912 */
913void stratix10_svc_free_channel(struct stratix10_svc_chan *chan)
914{
915 unsigned long flag;
916
917 spin_lock_irqsave(&chan->lock, flag);
918 chan->scl = NULL;
919 chan->ctrl->num_active_client--;
920 module_put(chan->ctrl->dev->driver->owner);
921 spin_unlock_irqrestore(&chan->lock, flag);
922}
923EXPORT_SYMBOL_GPL(stratix10_svc_free_channel);
924
925/**
926 * stratix10_svc_send() - send a message data to the remote
927 * @chan: service channel assigned to the client
928 * @msg: message data to be sent, in the format of
929 * "struct stratix10_svc_client_msg"
930 *
931 * This function is used by service client to add a message to the service
932 * layer driver's queue for being sent to the secure world.
933 *
934 * Return: 0 for success, -ENOMEM or -ENOBUFS on error.
935 */
936int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg)
937{
938 struct stratix10_svc_client_msg
939 *p_msg = (struct stratix10_svc_client_msg *)msg;
940 struct stratix10_svc_data_mem *p_mem;
941 struct stratix10_svc_data *p_data;
942 int ret = 0;
943 unsigned int cpu = 0;
944
945 p_data = kzalloc(sizeof(*p_data), GFP_KERNEL);
946 if (!p_data)
947 return -ENOMEM;
948
949 /* first client will create kernel thread */
950 if (!chan->ctrl->task) {
951 chan->ctrl->task =
952 kthread_create_on_node(svc_normal_to_secure_thread,
953 (void *)chan->ctrl,
954 cpu_to_node(cpu),
955 "svc_smc_hvc_thread");
956 if (IS_ERR(chan->ctrl->task)) {
957 dev_err(chan->ctrl->dev,
958 "failed to create svc_smc_hvc_thread\n");
959 kfree(p_data);
960 return -EINVAL;
961 }
962 kthread_bind(chan->ctrl->task, cpu);
963 wake_up_process(chan->ctrl->task);
964 }
965
966 pr_debug("%s: sent P-va=%p, P-com=%x, P-size=%u\n", __func__,
967 p_msg->payload, p_msg->command,
968 (unsigned int)p_msg->payload_length);
969
970 if (list_empty(&svc_data_mem)) {
971 if (p_msg->command == COMMAND_RECONFIG) {
972 struct stratix10_svc_command_config_type *ct =
973 (struct stratix10_svc_command_config_type *)
974 p_msg->payload;
975 p_data->flag = ct->flags;
976 }
977 } else {
978 list_for_each_entry(p_mem, &svc_data_mem, node)
979 if (p_mem->vaddr == p_msg->payload) {
980 p_data->paddr = p_mem->paddr;
981 p_data->size = p_msg->payload_length;
982 break;
983 }
984 if (p_msg->payload_output) {
985 list_for_each_entry(p_mem, &svc_data_mem, node)
986 if (p_mem->vaddr == p_msg->payload_output) {
987 p_data->paddr_output =
988 p_mem->paddr;
989 p_data->size_output =
990 p_msg->payload_length_output;
991 break;
992 }
993 }
994 }
995
996 p_data->command = p_msg->command;
997 p_data->arg[0] = p_msg->arg[0];
998 p_data->arg[1] = p_msg->arg[1];
999 p_data->arg[2] = p_msg->arg[2];
1000 p_data->size = p_msg->payload_length;
1001 p_data->chan = chan;
1002 pr_debug("%s: put to FIFO pa=0x%016x, cmd=%x, size=%u\n", __func__,
1003 (unsigned int)p_data->paddr, p_data->command,
1004 (unsigned int)p_data->size);
1005 ret = kfifo_in_spinlocked(&chan->ctrl->svc_fifo, p_data,
1006 sizeof(*p_data),
1007 &chan->ctrl->svc_fifo_lock);
1008
1009 kfree(p_data);
1010
1011 if (!ret)
1012 return -ENOBUFS;
1013
1014 return 0;
1015}
1016EXPORT_SYMBOL_GPL(stratix10_svc_send);
1017
1018/**
1019 * stratix10_svc_done() - complete service request transactions
1020 * @chan: service channel assigned to the client
1021 *
1022 * This function should be called when client has finished its request
1023 * or there is an error in the request process. It allows the service layer
1024 * to stop the running thread to have maximize savings in kernel resources.
1025 */
1026void stratix10_svc_done(struct stratix10_svc_chan *chan)
1027{
1028 /* stop thread when thread is running AND only one active client */
1029 if (chan->ctrl->task && chan->ctrl->num_active_client <= 1) {
1030 pr_debug("svc_smc_hvc_shm_thread is stopped\n");
1031 kthread_stop(chan->ctrl->task);
1032 chan->ctrl->task = NULL;
1033 }
1034}
1035EXPORT_SYMBOL_GPL(stratix10_svc_done);
1036
1037/**
1038 * stratix10_svc_allocate_memory() - allocate memory
1039 * @chan: service channel assigned to the client
1040 * @size: memory size requested by a specific service client
1041 *
1042 * Service layer allocates the requested number of bytes buffer from the
1043 * memory pool, service client uses this function to get allocated buffers.
1044 *
1045 * Return: address of allocated memory on success, or ERR_PTR() on error.
1046 */
1047void *stratix10_svc_allocate_memory(struct stratix10_svc_chan *chan,
1048 size_t size)
1049{
1050 struct stratix10_svc_data_mem *pmem;
1051 unsigned long va;
1052 phys_addr_t pa;
1053 struct gen_pool *genpool = chan->ctrl->genpool;
1054 size_t s = roundup(size, 1 << genpool->min_alloc_order);
1055
1056 pmem = devm_kzalloc(chan->ctrl->dev, sizeof(*pmem), GFP_KERNEL);
1057 if (!pmem)
1058 return ERR_PTR(-ENOMEM);
1059
1060 va = gen_pool_alloc(genpool, s);
1061 if (!va)
1062 return ERR_PTR(-ENOMEM);
1063
1064 memset((void *)va, 0, s);
1065 pa = gen_pool_virt_to_phys(genpool, va);
1066
1067 pmem->vaddr = (void *)va;
1068 pmem->paddr = pa;
1069 pmem->size = s;
1070 list_add_tail(&pmem->node, &svc_data_mem);
1071 pr_debug("%s: va=%p, pa=0x%016x\n", __func__,
1072 pmem->vaddr, (unsigned int)pmem->paddr);
1073
1074 return (void *)va;
1075}
1076EXPORT_SYMBOL_GPL(stratix10_svc_allocate_memory);
1077
1078/**
1079 * stratix10_svc_free_memory() - free allocated memory
1080 * @chan: service channel assigned to the client
1081 * @kaddr: memory to be freed
1082 *
1083 * This function is used by service client to free allocated buffers.
1084 */
1085void stratix10_svc_free_memory(struct stratix10_svc_chan *chan, void *kaddr)
1086{
1087 struct stratix10_svc_data_mem *pmem;
1088
1089 list_for_each_entry(pmem, &svc_data_mem, node)
1090 if (pmem->vaddr == kaddr) {
1091 gen_pool_free(chan->ctrl->genpool,
1092 (unsigned long)kaddr, pmem->size);
1093 pmem->vaddr = NULL;
1094 list_del(&pmem->node);
1095 return;
1096 }
1097
1098 list_del(&svc_data_mem);
1099}
1100EXPORT_SYMBOL_GPL(stratix10_svc_free_memory);
1101
1102static const struct of_device_id stratix10_svc_drv_match[] = {
1103 {.compatible = "intel,stratix10-svc"},
1104 {.compatible = "intel,agilex-svc"},
1105 {},
1106};
1107
1108static int stratix10_svc_drv_probe(struct platform_device *pdev)
1109{
1110 struct device *dev = &pdev->dev;
1111 struct stratix10_svc_controller *controller;
1112 struct stratix10_svc_chan *chans;
1113 struct gen_pool *genpool;
1114 struct stratix10_svc_sh_memory *sh_memory;
1115 struct stratix10_svc *svc;
1116
1117 svc_invoke_fn *invoke_fn;
1118 size_t fifo_size;
1119 int ret;
1120
1121 /* get SMC or HVC function */
1122 invoke_fn = get_invoke_func(dev);
1123 if (IS_ERR(invoke_fn))
1124 return -EINVAL;
1125
1126 sh_memory = devm_kzalloc(dev, sizeof(*sh_memory), GFP_KERNEL);
1127 if (!sh_memory)
1128 return -ENOMEM;
1129
1130 sh_memory->invoke_fn = invoke_fn;
1131 ret = svc_get_sh_memory(pdev, sh_memory);
1132 if (ret)
1133 return ret;
1134
1135 genpool = svc_create_memory_pool(pdev, sh_memory);
1136 if (!genpool)
1137 return -ENOMEM;
1138
1139 /* allocate service controller and supporting channel */
1140 controller = devm_kzalloc(dev, sizeof(*controller), GFP_KERNEL);
1141 if (!controller)
1142 return -ENOMEM;
1143
1144 chans = devm_kmalloc_array(dev, SVC_NUM_CHANNEL,
1145 sizeof(*chans), GFP_KERNEL | __GFP_ZERO);
1146 if (!chans)
1147 return -ENOMEM;
1148
1149 controller->dev = dev;
1150 controller->num_chans = SVC_NUM_CHANNEL;
1151 controller->num_active_client = 0;
1152 controller->chans = chans;
1153 controller->genpool = genpool;
1154 controller->task = NULL;
1155 controller->invoke_fn = invoke_fn;
1156 init_completion(&controller->complete_status);
1157
1158 fifo_size = sizeof(struct stratix10_svc_data) * SVC_NUM_DATA_IN_FIFO;
1159 ret = kfifo_alloc(&controller->svc_fifo, fifo_size, GFP_KERNEL);
1160 if (ret) {
1161 dev_err(dev, "failed to allocate FIFO\n");
1162 return ret;
1163 }
1164 spin_lock_init(&controller->svc_fifo_lock);
1165
1166 chans[0].scl = NULL;
1167 chans[0].ctrl = controller;
1168 chans[0].name = SVC_CLIENT_FPGA;
1169 spin_lock_init(&chans[0].lock);
1170
1171 chans[1].scl = NULL;
1172 chans[1].ctrl = controller;
1173 chans[1].name = SVC_CLIENT_RSU;
1174 spin_lock_init(&chans[1].lock);
1175
1176 chans[2].scl = NULL;
1177 chans[2].ctrl = controller;
1178 chans[2].name = SVC_CLIENT_FCS;
1179 spin_lock_init(&chans[2].lock);
1180
1181 list_add_tail(&controller->node, &svc_ctrl);
1182 platform_set_drvdata(pdev, controller);
1183
1184 /* add svc client device(s) */
1185 svc = devm_kzalloc(dev, sizeof(*svc), GFP_KERNEL);
1186 if (!svc) {
1187 ret = -ENOMEM;
1188 goto err_free_kfifo;
1189 }
1190
1191 svc->stratix10_svc_rsu = platform_device_alloc(STRATIX10_RSU, 0);
1192 if (!svc->stratix10_svc_rsu) {
1193 dev_err(dev, "failed to allocate %s device\n", STRATIX10_RSU);
1194 ret = -ENOMEM;
1195 goto err_free_kfifo;
1196 }
1197
1198 ret = platform_device_add(svc->stratix10_svc_rsu);
1199 if (ret) {
1200 platform_device_put(svc->stratix10_svc_rsu);
1201 return ret;
1202 }
1203
1204 svc->intel_svc_fcs = platform_device_alloc(INTEL_FCS, 1);
1205 if (!svc->intel_svc_fcs) {
1206 dev_err(dev, "failed to allocate %s device\n", INTEL_FCS);
1207 return -ENOMEM;
1208 }
1209
1210 ret = platform_device_add(svc->intel_svc_fcs);
1211 if (ret) {
1212 platform_device_put(svc->intel_svc_fcs);
1213 return ret;
1214 }
1215
1216 dev_set_drvdata(dev, svc);
1217
1218 pr_info("Intel Service Layer Driver Initialized\n");
1219
1220 return 0;
1221
1222err_free_kfifo:
1223 kfifo_free(&controller->svc_fifo);
1224 return ret;
1225}
1226
1227static int stratix10_svc_drv_remove(struct platform_device *pdev)
1228{
1229 struct stratix10_svc *svc = dev_get_drvdata(&pdev->dev);
1230 struct stratix10_svc_controller *ctrl = platform_get_drvdata(pdev);
1231
1232 platform_device_unregister(svc->intel_svc_fcs);
1233 platform_device_unregister(svc->stratix10_svc_rsu);
1234
1235 kfifo_free(&ctrl->svc_fifo);
1236 if (ctrl->task) {
1237 kthread_stop(ctrl->task);
1238 ctrl->task = NULL;
1239 }
1240 if (ctrl->genpool)
1241 gen_pool_destroy(ctrl->genpool);
1242 list_del(&ctrl->node);
1243
1244 return 0;
1245}
1246
1247static struct platform_driver stratix10_svc_driver = {
1248 .probe = stratix10_svc_drv_probe,
1249 .remove = stratix10_svc_drv_remove,
1250 .driver = {
1251 .name = "stratix10-svc",
1252 .of_match_table = stratix10_svc_drv_match,
1253 },
1254};
1255
1256static int __init stratix10_svc_init(void)
1257{
1258 struct device_node *fw_np;
1259 struct device_node *np;
1260 int ret;
1261
1262 fw_np = of_find_node_by_name(NULL, "firmware");
1263 if (!fw_np)
1264 return -ENODEV;
1265
1266 np = of_find_matching_node(fw_np, stratix10_svc_drv_match);
1267 if (!np)
1268 return -ENODEV;
1269
1270 of_node_put(np);
1271 ret = of_platform_populate(fw_np, stratix10_svc_drv_match, NULL, NULL);
1272 if (ret)
1273 return ret;
1274
1275 return platform_driver_register(&stratix10_svc_driver);
1276}
1277
1278static void __exit stratix10_svc_exit(void)
1279{
1280 return platform_driver_unregister(&stratix10_svc_driver);
1281}
1282
1283subsys_initcall(stratix10_svc_init);
1284module_exit(stratix10_svc_exit);
1285
1286MODULE_LICENSE("GPL v2");
1287MODULE_DESCRIPTION("Intel Stratix10 Service Layer Driver");
1288MODULE_AUTHOR("Richard Gong <richard.gong@intel.com>");
1289MODULE_ALIAS("platform:stratix10-svc");
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) 2017-2018, Intel Corporation
4 */
5
6#include <linux/completion.h>
7#include <linux/delay.h>
8#include <linux/genalloc.h>
9#include <linux/io.h>
10#include <linux/kfifo.h>
11#include <linux/kthread.h>
12#include <linux/module.h>
13#include <linux/mutex.h>
14#include <linux/of.h>
15#include <linux/of_platform.h>
16#include <linux/platform_device.h>
17#include <linux/slab.h>
18#include <linux/spinlock.h>
19#include <linux/firmware/intel/stratix10-smc.h>
20#include <linux/firmware/intel/stratix10-svc-client.h>
21#include <linux/types.h>
22
23/**
24 * SVC_NUM_DATA_IN_FIFO - number of struct stratix10_svc_data in the FIFO
25 *
26 * SVC_NUM_CHANNEL - number of channel supported by service layer driver
27 *
28 * FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS - claim back the submitted buffer(s)
29 * from the secure world for FPGA manager to reuse, or to free the buffer(s)
30 * when all bit-stream data had be send.
31 *
32 * FPGA_CONFIG_STATUS_TIMEOUT_SEC - poll the FPGA configuration status,
33 * service layer will return error to FPGA manager when timeout occurs,
34 * timeout is set to 30 seconds (30 * 1000) at Intel Stratix10 SoC.
35 */
36#define SVC_NUM_DATA_IN_FIFO 32
37#define SVC_NUM_CHANNEL 2
38#define FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS 200
39#define FPGA_CONFIG_STATUS_TIMEOUT_SEC 30
40
41/* stratix10 service layer clients */
42#define STRATIX10_RSU "stratix10-rsu"
43
44typedef void (svc_invoke_fn)(unsigned long, unsigned long, unsigned long,
45 unsigned long, unsigned long, unsigned long,
46 unsigned long, unsigned long,
47 struct arm_smccc_res *);
48struct stratix10_svc_chan;
49
50/**
51 * struct stratix10_svc - svc private data
52 * @stratix10_svc_rsu: pointer to stratix10 RSU device
53 */
54struct stratix10_svc {
55 struct platform_device *stratix10_svc_rsu;
56};
57
58/**
59 * struct stratix10_svc_sh_memory - service shared memory structure
60 * @sync_complete: state for a completion
61 * @addr: physical address of shared memory block
62 * @size: size of shared memory block
63 * @invoke_fn: function to issue secure monitor or hypervisor call
64 *
65 * This struct is used to save physical address and size of shared memory
66 * block. The shared memory blocked is allocated by secure monitor software
67 * at secure world.
68 *
69 * Service layer driver uses the physical address and size to create a memory
70 * pool, then allocates data buffer from that memory pool for service client.
71 */
72struct stratix10_svc_sh_memory {
73 struct completion sync_complete;
74 unsigned long addr;
75 unsigned long size;
76 svc_invoke_fn *invoke_fn;
77};
78
79/**
80 * struct stratix10_svc_data_mem - service memory structure
81 * @vaddr: virtual address
82 * @paddr: physical address
83 * @size: size of memory
84 * @node: link list head node
85 *
86 * This struct is used in a list that keeps track of buffers which have
87 * been allocated or freed from the memory pool. Service layer driver also
88 * uses this struct to transfer physical address to virtual address.
89 */
90struct stratix10_svc_data_mem {
91 void *vaddr;
92 phys_addr_t paddr;
93 size_t size;
94 struct list_head node;
95};
96
97/**
98 * struct stratix10_svc_data - service data structure
99 * @chan: service channel
100 * @paddr: playload physical address
101 * @size: playload size
102 * @command: service command requested by client
103 * @flag: configuration type (full or partial)
104 * @arg: args to be passed via registers and not physically mapped buffers
105 *
106 * This struct is used in service FIFO for inter-process communication.
107 */
108struct stratix10_svc_data {
109 struct stratix10_svc_chan *chan;
110 phys_addr_t paddr;
111 size_t size;
112 u32 command;
113 u32 flag;
114 u64 arg[3];
115};
116
117/**
118 * struct stratix10_svc_controller - service controller
119 * @dev: device
120 * @chans: array of service channels
121 * @num_chans: number of channels in 'chans' array
122 * @num_active_client: number of active service client
123 * @node: list management
124 * @genpool: memory pool pointing to the memory region
125 * @task: pointer to the thread task which handles SMC or HVC call
126 * @svc_fifo: a queue for storing service message data
127 * @complete_status: state for completion
128 * @svc_fifo_lock: protect access to service message data queue
129 * @invoke_fn: function to issue secure monitor call or hypervisor call
130 *
131 * This struct is used to create communication channels for service clients, to
132 * handle secure monitor or hypervisor call.
133 */
134struct stratix10_svc_controller {
135 struct device *dev;
136 struct stratix10_svc_chan *chans;
137 int num_chans;
138 int num_active_client;
139 struct list_head node;
140 struct gen_pool *genpool;
141 struct task_struct *task;
142 struct kfifo svc_fifo;
143 struct completion complete_status;
144 spinlock_t svc_fifo_lock;
145 svc_invoke_fn *invoke_fn;
146};
147
148/**
149 * struct stratix10_svc_chan - service communication channel
150 * @ctrl: pointer to service controller which is the provider of this channel
151 * @scl: pointer to service client which owns the channel
152 * @name: service client name associated with the channel
153 * @lock: protect access to the channel
154 *
155 * This struct is used by service client to communicate with service layer, each
156 * service client has its own channel created by service controller.
157 */
158struct stratix10_svc_chan {
159 struct stratix10_svc_controller *ctrl;
160 struct stratix10_svc_client *scl;
161 char *name;
162 spinlock_t lock;
163};
164
165static LIST_HEAD(svc_ctrl);
166static LIST_HEAD(svc_data_mem);
167
168/**
169 * svc_pa_to_va() - translate physical address to virtual address
170 * @addr: to be translated physical address
171 *
172 * Return: valid virtual address or NULL if the provided physical
173 * address doesn't exist.
174 */
175static void *svc_pa_to_va(unsigned long addr)
176{
177 struct stratix10_svc_data_mem *pmem;
178
179 pr_debug("claim back P-addr=0x%016x\n", (unsigned int)addr);
180 list_for_each_entry(pmem, &svc_data_mem, node)
181 if (pmem->paddr == addr)
182 return pmem->vaddr;
183
184 /* physical address is not found */
185 return NULL;
186}
187
188/**
189 * svc_thread_cmd_data_claim() - claim back buffer from the secure world
190 * @ctrl: pointer to service layer controller
191 * @p_data: pointer to service data structure
192 * @cb_data: pointer to callback data structure to service client
193 *
194 * Claim back the submitted buffers from the secure world and pass buffer
195 * back to service client (FPGA manager, etc) for reuse.
196 */
197static void svc_thread_cmd_data_claim(struct stratix10_svc_controller *ctrl,
198 struct stratix10_svc_data *p_data,
199 struct stratix10_svc_cb_data *cb_data)
200{
201 struct arm_smccc_res res;
202 unsigned long timeout;
203
204 reinit_completion(&ctrl->complete_status);
205 timeout = msecs_to_jiffies(FPGA_CONFIG_DATA_CLAIM_TIMEOUT_MS);
206
207 pr_debug("%s: claim back the submitted buffer\n", __func__);
208 do {
209 ctrl->invoke_fn(INTEL_SIP_SMC_FPGA_CONFIG_COMPLETED_WRITE,
210 0, 0, 0, 0, 0, 0, 0, &res);
211
212 if (res.a0 == INTEL_SIP_SMC_STATUS_OK) {
213 if (!res.a1) {
214 complete(&ctrl->complete_status);
215 break;
216 }
217 cb_data->status = BIT(SVC_STATUS_RECONFIG_BUFFER_DONE);
218 cb_data->kaddr1 = svc_pa_to_va(res.a1);
219 cb_data->kaddr2 = (res.a2) ?
220 svc_pa_to_va(res.a2) : NULL;
221 cb_data->kaddr3 = (res.a3) ?
222 svc_pa_to_va(res.a3) : NULL;
223 p_data->chan->scl->receive_cb(p_data->chan->scl,
224 cb_data);
225 } else {
226 pr_debug("%s: secure world busy, polling again\n",
227 __func__);
228 }
229 } while (res.a0 == INTEL_SIP_SMC_STATUS_OK ||
230 res.a0 == INTEL_SIP_SMC_FPGA_CONFIG_STATUS_BUSY ||
231 wait_for_completion_timeout(&ctrl->complete_status, timeout));
232}
233
234/**
235 * svc_thread_cmd_config_status() - check configuration status
236 * @ctrl: pointer to service layer controller
237 * @p_data: pointer to service data structure
238 * @cb_data: pointer to callback data structure to service client
239 *
240 * Check whether the secure firmware at secure world has finished the FPGA
241 * configuration, and then inform FPGA manager the configuration status.
242 */
243static void svc_thread_cmd_config_status(struct stratix10_svc_controller *ctrl,
244 struct stratix10_svc_data *p_data,
245 struct stratix10_svc_cb_data *cb_data)
246{
247 struct arm_smccc_res res;
248 int count_in_sec;
249
250 cb_data->kaddr1 = NULL;
251 cb_data->kaddr2 = NULL;
252 cb_data->kaddr3 = NULL;
253 cb_data->status = BIT(SVC_STATUS_RECONFIG_ERROR);
254
255 pr_debug("%s: polling config status\n", __func__);
256
257 count_in_sec = FPGA_CONFIG_STATUS_TIMEOUT_SEC;
258 while (count_in_sec) {
259 ctrl->invoke_fn(INTEL_SIP_SMC_FPGA_CONFIG_ISDONE,
260 0, 0, 0, 0, 0, 0, 0, &res);
261 if ((res.a0 == INTEL_SIP_SMC_STATUS_OK) ||
262 (res.a0 == INTEL_SIP_SMC_FPGA_CONFIG_STATUS_ERROR))
263 break;
264
265 /*
266 * configuration is still in progress, wait one second then
267 * poll again
268 */
269 msleep(1000);
270 count_in_sec--;
271 };
272
273 if (res.a0 == INTEL_SIP_SMC_STATUS_OK && count_in_sec)
274 cb_data->status = BIT(SVC_STATUS_RECONFIG_COMPLETED);
275
276 p_data->chan->scl->receive_cb(p_data->chan->scl, cb_data);
277}
278
279/**
280 * svc_thread_recv_status_ok() - handle the successful status
281 * @p_data: pointer to service data structure
282 * @cb_data: pointer to callback data structure to service client
283 * @res: result from SMC or HVC call
284 *
285 * Send back the correspond status to the service clients.
286 */
287static void svc_thread_recv_status_ok(struct stratix10_svc_data *p_data,
288 struct stratix10_svc_cb_data *cb_data,
289 struct arm_smccc_res res)
290{
291 cb_data->kaddr1 = NULL;
292 cb_data->kaddr2 = NULL;
293 cb_data->kaddr3 = NULL;
294
295 switch (p_data->command) {
296 case COMMAND_RECONFIG:
297 cb_data->status = BIT(SVC_STATUS_RECONFIG_REQUEST_OK);
298 break;
299 case COMMAND_RECONFIG_DATA_SUBMIT:
300 cb_data->status = BIT(SVC_STATUS_RECONFIG_BUFFER_SUBMITTED);
301 break;
302 case COMMAND_NOOP:
303 cb_data->status = BIT(SVC_STATUS_RECONFIG_BUFFER_SUBMITTED);
304 cb_data->kaddr1 = svc_pa_to_va(res.a1);
305 break;
306 case COMMAND_RECONFIG_STATUS:
307 cb_data->status = BIT(SVC_STATUS_RECONFIG_COMPLETED);
308 break;
309 case COMMAND_RSU_UPDATE:
310 case COMMAND_RSU_NOTIFY:
311 cb_data->status = BIT(SVC_STATUS_RSU_OK);
312 break;
313 case COMMAND_RSU_RETRY:
314 cb_data->status = BIT(SVC_STATUS_RSU_OK);
315 cb_data->kaddr1 = &res.a1;
316 break;
317 default:
318 pr_warn("it shouldn't happen\n");
319 break;
320 }
321
322 pr_debug("%s: call receive_cb\n", __func__);
323 p_data->chan->scl->receive_cb(p_data->chan->scl, cb_data);
324}
325
326/**
327 * svc_normal_to_secure_thread() - the function to run in the kthread
328 * @data: data pointer for kthread function
329 *
330 * Service layer driver creates stratix10_svc_smc_hvc_call kthread on CPU
331 * node 0, its function stratix10_svc_secure_call_thread is used to handle
332 * SMC or HVC calls between kernel driver and secure monitor software.
333 *
334 * Return: 0 for success or -ENOMEM on error.
335 */
336static int svc_normal_to_secure_thread(void *data)
337{
338 struct stratix10_svc_controller
339 *ctrl = (struct stratix10_svc_controller *)data;
340 struct stratix10_svc_data *pdata;
341 struct stratix10_svc_cb_data *cbdata;
342 struct arm_smccc_res res;
343 unsigned long a0, a1, a2;
344 int ret_fifo = 0;
345
346 pdata = kmalloc(sizeof(*pdata), GFP_KERNEL);
347 if (!pdata)
348 return -ENOMEM;
349
350 cbdata = kmalloc(sizeof(*cbdata), GFP_KERNEL);
351 if (!cbdata) {
352 kfree(pdata);
353 return -ENOMEM;
354 }
355
356 /* default set, to remove build warning */
357 a0 = INTEL_SIP_SMC_FPGA_CONFIG_LOOPBACK;
358 a1 = 0;
359 a2 = 0;
360
361 pr_debug("smc_hvc_shm_thread is running\n");
362
363 while (!kthread_should_stop()) {
364 ret_fifo = kfifo_out_spinlocked(&ctrl->svc_fifo,
365 pdata, sizeof(*pdata),
366 &ctrl->svc_fifo_lock);
367
368 if (!ret_fifo)
369 continue;
370
371 pr_debug("get from FIFO pa=0x%016x, command=%u, size=%u\n",
372 (unsigned int)pdata->paddr, pdata->command,
373 (unsigned int)pdata->size);
374
375 switch (pdata->command) {
376 case COMMAND_RECONFIG_DATA_CLAIM:
377 svc_thread_cmd_data_claim(ctrl, pdata, cbdata);
378 continue;
379 case COMMAND_RECONFIG:
380 a0 = INTEL_SIP_SMC_FPGA_CONFIG_START;
381 pr_debug("conf_type=%u\n", (unsigned int)pdata->flag);
382 a1 = pdata->flag;
383 a2 = 0;
384 break;
385 case COMMAND_RECONFIG_DATA_SUBMIT:
386 a0 = INTEL_SIP_SMC_FPGA_CONFIG_WRITE;
387 a1 = (unsigned long)pdata->paddr;
388 a2 = (unsigned long)pdata->size;
389 break;
390 case COMMAND_RECONFIG_STATUS:
391 a0 = INTEL_SIP_SMC_FPGA_CONFIG_ISDONE;
392 a1 = 0;
393 a2 = 0;
394 break;
395 case COMMAND_RSU_STATUS:
396 a0 = INTEL_SIP_SMC_RSU_STATUS;
397 a1 = 0;
398 a2 = 0;
399 break;
400 case COMMAND_RSU_UPDATE:
401 a0 = INTEL_SIP_SMC_RSU_UPDATE;
402 a1 = pdata->arg[0];
403 a2 = 0;
404 break;
405 case COMMAND_RSU_NOTIFY:
406 a0 = INTEL_SIP_SMC_RSU_NOTIFY;
407 a1 = pdata->arg[0];
408 a2 = 0;
409 break;
410 case COMMAND_RSU_RETRY:
411 a0 = INTEL_SIP_SMC_RSU_RETRY_COUNTER;
412 a1 = 0;
413 a2 = 0;
414 break;
415 default:
416 pr_warn("it shouldn't happen\n");
417 break;
418 }
419 pr_debug("%s: before SMC call -- a0=0x%016x a1=0x%016x",
420 __func__, (unsigned int)a0, (unsigned int)a1);
421 pr_debug(" a2=0x%016x\n", (unsigned int)a2);
422
423 ctrl->invoke_fn(a0, a1, a2, 0, 0, 0, 0, 0, &res);
424
425 pr_debug("%s: after SMC call -- res.a0=0x%016x",
426 __func__, (unsigned int)res.a0);
427 pr_debug(" res.a1=0x%016x, res.a2=0x%016x",
428 (unsigned int)res.a1, (unsigned int)res.a2);
429 pr_debug(" res.a3=0x%016x\n", (unsigned int)res.a3);
430
431 if (pdata->command == COMMAND_RSU_STATUS) {
432 if (res.a0 == INTEL_SIP_SMC_RSU_ERROR)
433 cbdata->status = BIT(SVC_STATUS_RSU_ERROR);
434 else
435 cbdata->status = BIT(SVC_STATUS_RSU_OK);
436
437 cbdata->kaddr1 = &res;
438 cbdata->kaddr2 = NULL;
439 cbdata->kaddr3 = NULL;
440 pdata->chan->scl->receive_cb(pdata->chan->scl, cbdata);
441 continue;
442 }
443
444 switch (res.a0) {
445 case INTEL_SIP_SMC_STATUS_OK:
446 svc_thread_recv_status_ok(pdata, cbdata, res);
447 break;
448 case INTEL_SIP_SMC_FPGA_CONFIG_STATUS_BUSY:
449 switch (pdata->command) {
450 case COMMAND_RECONFIG_DATA_SUBMIT:
451 svc_thread_cmd_data_claim(ctrl,
452 pdata, cbdata);
453 break;
454 case COMMAND_RECONFIG_STATUS:
455 svc_thread_cmd_config_status(ctrl,
456 pdata, cbdata);
457 break;
458 default:
459 pr_warn("it shouldn't happen\n");
460 break;
461 }
462 break;
463 case INTEL_SIP_SMC_FPGA_CONFIG_STATUS_REJECTED:
464 pr_debug("%s: STATUS_REJECTED\n", __func__);
465 break;
466 case INTEL_SIP_SMC_FPGA_CONFIG_STATUS_ERROR:
467 case INTEL_SIP_SMC_RSU_ERROR:
468 pr_err("%s: STATUS_ERROR\n", __func__);
469 switch (pdata->command) {
470 /* for FPGA mgr */
471 case COMMAND_RECONFIG_DATA_CLAIM:
472 case COMMAND_RECONFIG:
473 case COMMAND_RECONFIG_DATA_SUBMIT:
474 case COMMAND_RECONFIG_STATUS:
475 cbdata->status =
476 BIT(SVC_STATUS_RECONFIG_ERROR);
477 break;
478
479 /* for RSU */
480 case COMMAND_RSU_STATUS:
481 case COMMAND_RSU_UPDATE:
482 case COMMAND_RSU_NOTIFY:
483 case COMMAND_RSU_RETRY:
484 cbdata->status =
485 BIT(SVC_STATUS_RSU_ERROR);
486 break;
487 }
488
489 cbdata->status = BIT(SVC_STATUS_RECONFIG_ERROR);
490 cbdata->kaddr1 = NULL;
491 cbdata->kaddr2 = NULL;
492 cbdata->kaddr3 = NULL;
493 pdata->chan->scl->receive_cb(pdata->chan->scl, cbdata);
494 break;
495 default:
496 pr_warn("it shouldn't happen\n");
497 break;
498 }
499 };
500
501 kfree(cbdata);
502 kfree(pdata);
503
504 return 0;
505}
506
507/**
508 * svc_normal_to_secure_shm_thread() - the function to run in the kthread
509 * @data: data pointer for kthread function
510 *
511 * Service layer driver creates stratix10_svc_smc_hvc_shm kthread on CPU
512 * node 0, its function stratix10_svc_secure_shm_thread is used to query the
513 * physical address of memory block reserved by secure monitor software at
514 * secure world.
515 *
516 * svc_normal_to_secure_shm_thread() calls do_exit() directly since it is a
517 * standlone thread for which no one will call kthread_stop() or return when
518 * 'kthread_should_stop()' is true.
519 */
520static int svc_normal_to_secure_shm_thread(void *data)
521{
522 struct stratix10_svc_sh_memory
523 *sh_mem = (struct stratix10_svc_sh_memory *)data;
524 struct arm_smccc_res res;
525
526 /* SMC or HVC call to get shared memory info from secure world */
527 sh_mem->invoke_fn(INTEL_SIP_SMC_FPGA_CONFIG_GET_MEM,
528 0, 0, 0, 0, 0, 0, 0, &res);
529 if (res.a0 == INTEL_SIP_SMC_STATUS_OK) {
530 sh_mem->addr = res.a1;
531 sh_mem->size = res.a2;
532 } else {
533 pr_err("%s: after SMC call -- res.a0=0x%016x", __func__,
534 (unsigned int)res.a0);
535 sh_mem->addr = 0;
536 sh_mem->size = 0;
537 }
538
539 complete(&sh_mem->sync_complete);
540 do_exit(0);
541}
542
543/**
544 * svc_get_sh_memory() - get memory block reserved by secure monitor SW
545 * @pdev: pointer to service layer device
546 * @sh_memory: pointer to service shared memory structure
547 *
548 * Return: zero for successfully getting the physical address of memory block
549 * reserved by secure monitor software, or negative value on error.
550 */
551static int svc_get_sh_memory(struct platform_device *pdev,
552 struct stratix10_svc_sh_memory *sh_memory)
553{
554 struct device *dev = &pdev->dev;
555 struct task_struct *sh_memory_task;
556 unsigned int cpu = 0;
557
558 init_completion(&sh_memory->sync_complete);
559
560 /* smc or hvc call happens on cpu 0 bound kthread */
561 sh_memory_task = kthread_create_on_node(svc_normal_to_secure_shm_thread,
562 (void *)sh_memory,
563 cpu_to_node(cpu),
564 "svc_smc_hvc_shm_thread");
565 if (IS_ERR(sh_memory_task)) {
566 dev_err(dev, "fail to create stratix10_svc_smc_shm_thread\n");
567 return -EINVAL;
568 }
569
570 wake_up_process(sh_memory_task);
571
572 if (!wait_for_completion_timeout(&sh_memory->sync_complete, 10 * HZ)) {
573 dev_err(dev,
574 "timeout to get sh-memory paras from secure world\n");
575 return -ETIMEDOUT;
576 }
577
578 if (!sh_memory->addr || !sh_memory->size) {
579 dev_err(dev,
580 "failed to get shared memory info from secure world\n");
581 return -ENOMEM;
582 }
583
584 dev_dbg(dev, "SM software provides paddr: 0x%016x, size: 0x%08x\n",
585 (unsigned int)sh_memory->addr,
586 (unsigned int)sh_memory->size);
587
588 return 0;
589}
590
591/**
592 * svc_create_memory_pool() - create a memory pool from reserved memory block
593 * @pdev: pointer to service layer device
594 * @sh_memory: pointer to service shared memory structure
595 *
596 * Return: pool allocated from reserved memory block or ERR_PTR() on error.
597 */
598static struct gen_pool *
599svc_create_memory_pool(struct platform_device *pdev,
600 struct stratix10_svc_sh_memory *sh_memory)
601{
602 struct device *dev = &pdev->dev;
603 struct gen_pool *genpool;
604 unsigned long vaddr;
605 phys_addr_t paddr;
606 size_t size;
607 phys_addr_t begin;
608 phys_addr_t end;
609 void *va;
610 size_t page_mask = PAGE_SIZE - 1;
611 int min_alloc_order = 3;
612 int ret;
613
614 begin = roundup(sh_memory->addr, PAGE_SIZE);
615 end = rounddown(sh_memory->addr + sh_memory->size, PAGE_SIZE);
616 paddr = begin;
617 size = end - begin;
618 va = memremap(paddr, size, MEMREMAP_WC);
619 if (!va) {
620 dev_err(dev, "fail to remap shared memory\n");
621 return ERR_PTR(-EINVAL);
622 }
623 vaddr = (unsigned long)va;
624 dev_dbg(dev,
625 "reserved memory vaddr: %p, paddr: 0x%16x size: 0x%8x\n",
626 va, (unsigned int)paddr, (unsigned int)size);
627 if ((vaddr & page_mask) || (paddr & page_mask) ||
628 (size & page_mask)) {
629 dev_err(dev, "page is not aligned\n");
630 return ERR_PTR(-EINVAL);
631 }
632 genpool = gen_pool_create(min_alloc_order, -1);
633 if (!genpool) {
634 dev_err(dev, "fail to create genpool\n");
635 return ERR_PTR(-ENOMEM);
636 }
637 gen_pool_set_algo(genpool, gen_pool_best_fit, NULL);
638 ret = gen_pool_add_virt(genpool, vaddr, paddr, size, -1);
639 if (ret) {
640 dev_err(dev, "fail to add memory chunk to the pool\n");
641 gen_pool_destroy(genpool);
642 return ERR_PTR(ret);
643 }
644
645 return genpool;
646}
647
648/**
649 * svc_smccc_smc() - secure monitor call between normal and secure world
650 * @a0: argument passed in registers 0
651 * @a1: argument passed in registers 1
652 * @a2: argument passed in registers 2
653 * @a3: argument passed in registers 3
654 * @a4: argument passed in registers 4
655 * @a5: argument passed in registers 5
656 * @a6: argument passed in registers 6
657 * @a7: argument passed in registers 7
658 * @res: result values from register 0 to 3
659 */
660static void svc_smccc_smc(unsigned long a0, unsigned long a1,
661 unsigned long a2, unsigned long a3,
662 unsigned long a4, unsigned long a5,
663 unsigned long a6, unsigned long a7,
664 struct arm_smccc_res *res)
665{
666 arm_smccc_smc(a0, a1, a2, a3, a4, a5, a6, a7, res);
667}
668
669/**
670 * svc_smccc_hvc() - hypervisor call between normal and secure world
671 * @a0: argument passed in registers 0
672 * @a1: argument passed in registers 1
673 * @a2: argument passed in registers 2
674 * @a3: argument passed in registers 3
675 * @a4: argument passed in registers 4
676 * @a5: argument passed in registers 5
677 * @a6: argument passed in registers 6
678 * @a7: argument passed in registers 7
679 * @res: result values from register 0 to 3
680 */
681static void svc_smccc_hvc(unsigned long a0, unsigned long a1,
682 unsigned long a2, unsigned long a3,
683 unsigned long a4, unsigned long a5,
684 unsigned long a6, unsigned long a7,
685 struct arm_smccc_res *res)
686{
687 arm_smccc_hvc(a0, a1, a2, a3, a4, a5, a6, a7, res);
688}
689
690/**
691 * get_invoke_func() - invoke SMC or HVC call
692 * @dev: pointer to device
693 *
694 * Return: function pointer to svc_smccc_smc or svc_smccc_hvc.
695 */
696static svc_invoke_fn *get_invoke_func(struct device *dev)
697{
698 const char *method;
699
700 if (of_property_read_string(dev->of_node, "method", &method)) {
701 dev_warn(dev, "missing \"method\" property\n");
702 return ERR_PTR(-ENXIO);
703 }
704
705 if (!strcmp(method, "smc"))
706 return svc_smccc_smc;
707 if (!strcmp(method, "hvc"))
708 return svc_smccc_hvc;
709
710 dev_warn(dev, "invalid \"method\" property: %s\n", method);
711
712 return ERR_PTR(-EINVAL);
713}
714
715/**
716 * stratix10_svc_request_channel_byname() - request a service channel
717 * @client: pointer to service client
718 * @name: service client name
719 *
720 * This function is used by service client to request a service channel.
721 *
722 * Return: a pointer to channel assigned to the client on success,
723 * or ERR_PTR() on error.
724 */
725struct stratix10_svc_chan *stratix10_svc_request_channel_byname(
726 struct stratix10_svc_client *client, const char *name)
727{
728 struct device *dev = client->dev;
729 struct stratix10_svc_controller *controller;
730 struct stratix10_svc_chan *chan = NULL;
731 unsigned long flag;
732 int i;
733
734 /* if probe was called after client's, or error on probe */
735 if (list_empty(&svc_ctrl))
736 return ERR_PTR(-EPROBE_DEFER);
737
738 controller = list_first_entry(&svc_ctrl,
739 struct stratix10_svc_controller, node);
740 for (i = 0; i < SVC_NUM_CHANNEL; i++) {
741 if (!strcmp(controller->chans[i].name, name)) {
742 chan = &controller->chans[i];
743 break;
744 }
745 }
746
747 /* if there was no channel match */
748 if (i == SVC_NUM_CHANNEL) {
749 dev_err(dev, "%s: channel not allocated\n", __func__);
750 return ERR_PTR(-EINVAL);
751 }
752
753 if (chan->scl || !try_module_get(controller->dev->driver->owner)) {
754 dev_dbg(dev, "%s: svc not free\n", __func__);
755 return ERR_PTR(-EBUSY);
756 }
757
758 spin_lock_irqsave(&chan->lock, flag);
759 chan->scl = client;
760 chan->ctrl->num_active_client++;
761 spin_unlock_irqrestore(&chan->lock, flag);
762
763 return chan;
764}
765EXPORT_SYMBOL_GPL(stratix10_svc_request_channel_byname);
766
767/**
768 * stratix10_svc_free_channel() - free service channel
769 * @chan: service channel to be freed
770 *
771 * This function is used by service client to free a service channel.
772 */
773void stratix10_svc_free_channel(struct stratix10_svc_chan *chan)
774{
775 unsigned long flag;
776
777 spin_lock_irqsave(&chan->lock, flag);
778 chan->scl = NULL;
779 chan->ctrl->num_active_client--;
780 module_put(chan->ctrl->dev->driver->owner);
781 spin_unlock_irqrestore(&chan->lock, flag);
782}
783EXPORT_SYMBOL_GPL(stratix10_svc_free_channel);
784
785/**
786 * stratix10_svc_send() - send a message data to the remote
787 * @chan: service channel assigned to the client
788 * @msg: message data to be sent, in the format of
789 * "struct stratix10_svc_client_msg"
790 *
791 * This function is used by service client to add a message to the service
792 * layer driver's queue for being sent to the secure world.
793 *
794 * Return: 0 for success, -ENOMEM or -ENOBUFS on error.
795 */
796int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg)
797{
798 struct stratix10_svc_client_msg
799 *p_msg = (struct stratix10_svc_client_msg *)msg;
800 struct stratix10_svc_data_mem *p_mem;
801 struct stratix10_svc_data *p_data;
802 int ret = 0;
803 unsigned int cpu = 0;
804
805 p_data = kzalloc(sizeof(*p_data), GFP_KERNEL);
806 if (!p_data)
807 return -ENOMEM;
808
809 /* first client will create kernel thread */
810 if (!chan->ctrl->task) {
811 chan->ctrl->task =
812 kthread_create_on_node(svc_normal_to_secure_thread,
813 (void *)chan->ctrl,
814 cpu_to_node(cpu),
815 "svc_smc_hvc_thread");
816 if (IS_ERR(chan->ctrl->task)) {
817 dev_err(chan->ctrl->dev,
818 "failed to create svc_smc_hvc_thread\n");
819 kfree(p_data);
820 return -EINVAL;
821 }
822 kthread_bind(chan->ctrl->task, cpu);
823 wake_up_process(chan->ctrl->task);
824 }
825
826 pr_debug("%s: sent P-va=%p, P-com=%x, P-size=%u\n", __func__,
827 p_msg->payload, p_msg->command,
828 (unsigned int)p_msg->payload_length);
829
830 if (list_empty(&svc_data_mem)) {
831 if (p_msg->command == COMMAND_RECONFIG) {
832 struct stratix10_svc_command_config_type *ct =
833 (struct stratix10_svc_command_config_type *)
834 p_msg->payload;
835 p_data->flag = ct->flags;
836 }
837 } else {
838 list_for_each_entry(p_mem, &svc_data_mem, node)
839 if (p_mem->vaddr == p_msg->payload) {
840 p_data->paddr = p_mem->paddr;
841 break;
842 }
843 }
844
845 p_data->command = p_msg->command;
846 p_data->arg[0] = p_msg->arg[0];
847 p_data->arg[1] = p_msg->arg[1];
848 p_data->arg[2] = p_msg->arg[2];
849 p_data->size = p_msg->payload_length;
850 p_data->chan = chan;
851 pr_debug("%s: put to FIFO pa=0x%016x, cmd=%x, size=%u\n", __func__,
852 (unsigned int)p_data->paddr, p_data->command,
853 (unsigned int)p_data->size);
854 ret = kfifo_in_spinlocked(&chan->ctrl->svc_fifo, p_data,
855 sizeof(*p_data),
856 &chan->ctrl->svc_fifo_lock);
857
858 kfree(p_data);
859
860 if (!ret)
861 return -ENOBUFS;
862
863 return 0;
864}
865EXPORT_SYMBOL_GPL(stratix10_svc_send);
866
867/**
868 * stratix10_svc_done() - complete service request transactions
869 * @chan: service channel assigned to the client
870 *
871 * This function should be called when client has finished its request
872 * or there is an error in the request process. It allows the service layer
873 * to stop the running thread to have maximize savings in kernel resources.
874 */
875void stratix10_svc_done(struct stratix10_svc_chan *chan)
876{
877 /* stop thread when thread is running AND only one active client */
878 if (chan->ctrl->task && chan->ctrl->num_active_client <= 1) {
879 pr_debug("svc_smc_hvc_shm_thread is stopped\n");
880 kthread_stop(chan->ctrl->task);
881 chan->ctrl->task = NULL;
882 }
883}
884EXPORT_SYMBOL_GPL(stratix10_svc_done);
885
886/**
887 * stratix10_svc_allocate_memory() - allocate memory
888 * @chan: service channel assigned to the client
889 * @size: memory size requested by a specific service client
890 *
891 * Service layer allocates the requested number of bytes buffer from the
892 * memory pool, service client uses this function to get allocated buffers.
893 *
894 * Return: address of allocated memory on success, or ERR_PTR() on error.
895 */
896void *stratix10_svc_allocate_memory(struct stratix10_svc_chan *chan,
897 size_t size)
898{
899 struct stratix10_svc_data_mem *pmem;
900 unsigned long va;
901 phys_addr_t pa;
902 struct gen_pool *genpool = chan->ctrl->genpool;
903 size_t s = roundup(size, 1 << genpool->min_alloc_order);
904
905 pmem = devm_kzalloc(chan->ctrl->dev, sizeof(*pmem), GFP_KERNEL);
906 if (!pmem)
907 return ERR_PTR(-ENOMEM);
908
909 va = gen_pool_alloc(genpool, s);
910 if (!va)
911 return ERR_PTR(-ENOMEM);
912
913 memset((void *)va, 0, s);
914 pa = gen_pool_virt_to_phys(genpool, va);
915
916 pmem->vaddr = (void *)va;
917 pmem->paddr = pa;
918 pmem->size = s;
919 list_add_tail(&pmem->node, &svc_data_mem);
920 pr_debug("%s: va=%p, pa=0x%016x\n", __func__,
921 pmem->vaddr, (unsigned int)pmem->paddr);
922
923 return (void *)va;
924}
925EXPORT_SYMBOL_GPL(stratix10_svc_allocate_memory);
926
927/**
928 * stratix10_svc_free_memory() - free allocated memory
929 * @chan: service channel assigned to the client
930 * @kaddr: memory to be freed
931 *
932 * This function is used by service client to free allocated buffers.
933 */
934void stratix10_svc_free_memory(struct stratix10_svc_chan *chan, void *kaddr)
935{
936 struct stratix10_svc_data_mem *pmem;
937 size_t size = 0;
938
939 list_for_each_entry(pmem, &svc_data_mem, node)
940 if (pmem->vaddr == kaddr) {
941 size = pmem->size;
942 break;
943 }
944
945 gen_pool_free(chan->ctrl->genpool, (unsigned long)kaddr, size);
946 pmem->vaddr = NULL;
947 list_del(&pmem->node);
948}
949EXPORT_SYMBOL_GPL(stratix10_svc_free_memory);
950
951static const struct of_device_id stratix10_svc_drv_match[] = {
952 {.compatible = "intel,stratix10-svc"},
953 {},
954};
955
956static int stratix10_svc_drv_probe(struct platform_device *pdev)
957{
958 struct device *dev = &pdev->dev;
959 struct stratix10_svc_controller *controller;
960 struct stratix10_svc_chan *chans;
961 struct gen_pool *genpool;
962 struct stratix10_svc_sh_memory *sh_memory;
963 struct stratix10_svc *svc;
964
965 svc_invoke_fn *invoke_fn;
966 size_t fifo_size;
967 int ret;
968
969 /* get SMC or HVC function */
970 invoke_fn = get_invoke_func(dev);
971 if (IS_ERR(invoke_fn))
972 return -EINVAL;
973
974 sh_memory = devm_kzalloc(dev, sizeof(*sh_memory), GFP_KERNEL);
975 if (!sh_memory)
976 return -ENOMEM;
977
978 sh_memory->invoke_fn = invoke_fn;
979 ret = svc_get_sh_memory(pdev, sh_memory);
980 if (ret)
981 return ret;
982
983 genpool = svc_create_memory_pool(pdev, sh_memory);
984 if (!genpool)
985 return -ENOMEM;
986
987 /* allocate service controller and supporting channel */
988 controller = devm_kzalloc(dev, sizeof(*controller), GFP_KERNEL);
989 if (!controller)
990 return -ENOMEM;
991
992 chans = devm_kmalloc_array(dev, SVC_NUM_CHANNEL,
993 sizeof(*chans), GFP_KERNEL | __GFP_ZERO);
994 if (!chans)
995 return -ENOMEM;
996
997 controller->dev = dev;
998 controller->num_chans = SVC_NUM_CHANNEL;
999 controller->num_active_client = 0;
1000 controller->chans = chans;
1001 controller->genpool = genpool;
1002 controller->task = NULL;
1003 controller->invoke_fn = invoke_fn;
1004 init_completion(&controller->complete_status);
1005
1006 fifo_size = sizeof(struct stratix10_svc_data) * SVC_NUM_DATA_IN_FIFO;
1007 ret = kfifo_alloc(&controller->svc_fifo, fifo_size, GFP_KERNEL);
1008 if (ret) {
1009 dev_err(dev, "failed to allocate FIFO\n");
1010 return ret;
1011 }
1012 spin_lock_init(&controller->svc_fifo_lock);
1013
1014 chans[0].scl = NULL;
1015 chans[0].ctrl = controller;
1016 chans[0].name = SVC_CLIENT_FPGA;
1017 spin_lock_init(&chans[0].lock);
1018
1019 chans[1].scl = NULL;
1020 chans[1].ctrl = controller;
1021 chans[1].name = SVC_CLIENT_RSU;
1022 spin_lock_init(&chans[1].lock);
1023
1024 list_add_tail(&controller->node, &svc_ctrl);
1025 platform_set_drvdata(pdev, controller);
1026
1027 /* add svc client device(s) */
1028 svc = devm_kzalloc(dev, sizeof(*svc), GFP_KERNEL);
1029 if (!svc)
1030 return -ENOMEM;
1031
1032 svc->stratix10_svc_rsu = platform_device_alloc(STRATIX10_RSU, 0);
1033 if (!svc->stratix10_svc_rsu) {
1034 dev_err(dev, "failed to allocate %s device\n", STRATIX10_RSU);
1035 return -ENOMEM;
1036 }
1037
1038 ret = platform_device_add(svc->stratix10_svc_rsu);
1039 if (ret) {
1040 platform_device_put(svc->stratix10_svc_rsu);
1041 return ret;
1042 }
1043 dev_set_drvdata(dev, svc);
1044
1045 pr_info("Intel Service Layer Driver Initialized\n");
1046
1047 return ret;
1048}
1049
1050static int stratix10_svc_drv_remove(struct platform_device *pdev)
1051{
1052 struct stratix10_svc *svc = dev_get_drvdata(&pdev->dev);
1053 struct stratix10_svc_controller *ctrl = platform_get_drvdata(pdev);
1054
1055 platform_device_unregister(svc->stratix10_svc_rsu);
1056
1057 kfifo_free(&ctrl->svc_fifo);
1058 if (ctrl->task) {
1059 kthread_stop(ctrl->task);
1060 ctrl->task = NULL;
1061 }
1062 if (ctrl->genpool)
1063 gen_pool_destroy(ctrl->genpool);
1064 list_del(&ctrl->node);
1065
1066 return 0;
1067}
1068
1069static struct platform_driver stratix10_svc_driver = {
1070 .probe = stratix10_svc_drv_probe,
1071 .remove = stratix10_svc_drv_remove,
1072 .driver = {
1073 .name = "stratix10-svc",
1074 .of_match_table = stratix10_svc_drv_match,
1075 },
1076};
1077
1078static int __init stratix10_svc_init(void)
1079{
1080 struct device_node *fw_np;
1081 struct device_node *np;
1082 int ret;
1083
1084 fw_np = of_find_node_by_name(NULL, "firmware");
1085 if (!fw_np)
1086 return -ENODEV;
1087
1088 np = of_find_matching_node(fw_np, stratix10_svc_drv_match);
1089 if (!np)
1090 return -ENODEV;
1091
1092 of_node_put(np);
1093 ret = of_platform_populate(fw_np, stratix10_svc_drv_match, NULL, NULL);
1094 if (ret)
1095 return ret;
1096
1097 return platform_driver_register(&stratix10_svc_driver);
1098}
1099
1100static void __exit stratix10_svc_exit(void)
1101{
1102 return platform_driver_unregister(&stratix10_svc_driver);
1103}
1104
1105subsys_initcall(stratix10_svc_init);
1106module_exit(stratix10_svc_exit);
1107
1108MODULE_LICENSE("GPL v2");
1109MODULE_DESCRIPTION("Intel Stratix10 Service Layer Driver");
1110MODULE_AUTHOR("Richard Gong <richard.gong@intel.com>");
1111MODULE_ALIAS("platform:stratix10-svc");