c36840fadf179a74de29c1be45e985a1a4fd3c03
[processor-sdk/open-amp.git] / lib / remoteproc / drivers / zynqmp_remoteproc_a53.c
1 /*
2  * Copyright (c) 2014, Mentor Graphics Corporation
3  * All rights reserved.
4  * Copyright (c) 2015 Xilinx, Inc.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice,
10  *    this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  *    this list of conditions and the following disclaimer in the documentation
13  *    and/or other materials provided with the distribution.
14  * 3. Neither the name of Mentor Graphics Corporation nor the names of its
15  *    contributors may be used to endorse or promote products derived from this
16  *    software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
31 /**************************************************************************
32  * FILE NAME
33  *
34  *       platform.c
35  *
36  * DESCRIPTION
37  *
38  *       This file is the Implementation of IPC hardware layer interface
39  *       for Xilinx Zynq ZC702EVK platform.
40  *
41  **************************************************************************/
43 #include <errno.h>
44 #include <string.h>
45 #include "metal/io.h"
46 #include "metal/device.h"
47 #include "metal/utilities.h"
48 #include "metal/atomic.h"
49 #include "metal/irq.h"
50 #include "metal/alloc.h"
51 #include "openamp/hil.h"
52 #include "openamp/virtqueue.h"
54 /* IPI REGs OFFSET */
55 #define IPI_TRIG_OFFSET          0x00000000    /* IPI trigger register offset */
56 #define IPI_OBS_OFFSET           0x00000004    /* IPI observation register offset */
57 #define IPI_ISR_OFFSET           0x00000010    /* IPI interrupt status register offset */
58 #define IPI_IMR_OFFSET           0x00000014    /* IPI interrupt mask register offset */
59 #define IPI_IER_OFFSET           0x00000018    /* IPI interrupt enable register offset */
60 #define IPI_IDR_OFFSET           0x0000001C    /* IPI interrupt disable register offset */
62 #define _rproc_wait() asm volatile("wfi")
64 /* -- FIX ME: ipi info is to be defined -- */
65 struct ipi_info {
66         const char *name;
67         const char *bus_name;
68         struct metal_device *dev;
69         struct metal_io_region *io;
70         metal_phys_addr_t paddr;
71         uint32_t ipi_chn_mask;
72         int registered;
73         atomic_int sync;
74 };
76 /*--------------------------- Declare Functions ------------------------ */
77 static int _enable_interrupt(struct proc_intr *intr);
78 static void _notify(struct hil_proc *proc, struct proc_intr *intr_info);
79 static int _boot_cpu(struct hil_proc *proc, unsigned int load_addr);
80 static void _shutdown_cpu(struct hil_proc *proc);
81 static int _poll(struct hil_proc *proc, int nonblock);
82 static int _initialize(struct hil_proc *proc);
83 static void _release(struct hil_proc *proc);
85 static int _ipi_handler(int vect_id, void *data);
87 /*--------------------------- Globals ---------------------------------- */
88 struct hil_platform_ops zynqmp_r5_a53_proc_ops = {
89         .enable_interrupt     = _enable_interrupt,
90         .notify               = _notify,
91         .boot_cpu             = _boot_cpu,
92         .shutdown_cpu         = _shutdown_cpu,
93         .poll                 = _poll,
94         .initialize    = _initialize,
95         .release    = _release,
96 };
98 int _ipi_handler(int vect_id, void *data)
99 {
100         struct proc_intr *intr = data;
101         struct ipi_info *ipi = intr->data;
102         struct metal_io_region *io = ipi->io;
103         unsigned int ipi_intr_status =
104             (unsigned int)metal_io_read32(io, IPI_ISR_OFFSET);
106         (void) vect_id;
108         if (ipi_intr_status & ipi->ipi_chn_mask) {
109                 atomic_flag_clear(&ipi->sync);
110                 metal_io_write32(io, IPI_ISR_OFFSET,
111                                 ipi->ipi_chn_mask);
112                 return 0;
113         }
114         return -1;
117 static int _enable_interrupt(struct proc_intr *intr)
119         struct ipi_info *ipi =
120             (struct ipi_info *)(intr->data);
121         struct metal_io_region *io = ipi->io;
123         if (ipi->registered) {
124                 return 0;
125         }
127         /* Register ISR */
128         metal_irq_register(intr->vect_id, _ipi_handler,
129                                 intr->dev, intr);
130         /* Enable IPI interrupt */
131         metal_irq_enable(intr->vect_id);
132         metal_io_write32(io, IPI_IER_OFFSET, ipi->ipi_chn_mask);
133         ipi->registered = 1;
134         return 0;
137 static void _notify(struct hil_proc *proc, struct proc_intr *intr_info)
140         (void)proc;
141         struct ipi_info *ipi = (struct ipi_info *)(intr_info->data);
142         if (ipi == NULL)
143                 return;
145         /* Trigger IPI */
146         metal_io_write32(ipi->io, IPI_TRIG_OFFSET, ipi->ipi_chn_mask);
149 static int _boot_cpu(struct hil_proc *proc, unsigned int load_addr)
151         (void)proc;
152         (void)load_addr;
153         return -1;
156 static void _shutdown_cpu(struct hil_proc *proc)
158         (void)proc;
159         return;
162 static int _poll(struct hil_proc *proc, int nonblock)
164         struct proc_vring *vring;
165         struct ipi_info *ipi;
166         unsigned int flags;
168         vring = &proc->vdev.vring_info[1];
169         ipi = (struct ipi_info *)(vring->intr_info.data);
170         while(1) {
171                 flags = metal_irq_save_disable();
172                 if (!(atomic_flag_test_and_set(&ipi->sync))) {
173                         metal_irq_restore_enable(flags);
174                         virtqueue_notification(vring->vq);
175                         return 0;
176                 }
177                 if (nonblock) {
178                         metal_irq_restore_enable(flags);
179                         return -EAGAIN;
180                 }
181                 _rproc_wait();
182                 metal_irq_restore_enable(flags);
183         }
186 static int _initialize(struct hil_proc *proc)
188         int ret;
189         struct proc_intr *intr_info;
190         struct ipi_info *ipi;
192         if (!proc)
193                 return -1;
195         intr_info = &(proc->vdev.intr_info);
196         ipi = intr_info->data;
198         if (ipi && ipi->name && ipi->bus_name) {
199                 ret = metal_device_open(ipi->bus_name, ipi->name,
200                                              &ipi->dev);
201                 if (ret)
202                         return -ENODEV;
203                 ipi->io = metal_device_io_region(ipi->dev, 0);
204         } else if (ipi->paddr) {
205                 ipi->io = metal_allocate_memory(
206                         sizeof(struct metal_io_region));
207                 if (!ipi->io)
208                         goto error;
209                 metal_io_init(ipi->io, (void *)ipi->paddr,
210                         &ipi->paddr, 0x1000,
211                         (unsigned)(-1),
212                         METAL_UNCACHED | METAL_IO_MAPPED,
213                         NULL);
214         }
216         if (ipi->io) {
217                 metal_io_write32(ipi->io, IPI_IDR_OFFSET,
218                         ipi->ipi_chn_mask);
219                 atomic_store(&ipi->sync, 1);
220         }
221         ipi->registered = 0;
222         return 0;
224 error:
225         _release(proc);
226         return -1;
229 static void _release(struct hil_proc *proc)
231         struct proc_intr *intr_info;
232         struct ipi_info *ipi;
234         if (!proc)
235                 return;
236         intr_info = &(proc->vdev.intr_info);
237         ipi = (struct ipi_info *)(intr_info->data);
238         if (ipi) {
239                 if (ipi->io) {
240                         metal_io_write32(ipi->io, IPI_IDR_OFFSET,
241                                 ipi->ipi_chn_mask);
242                         if (ipi->dev) {
243                                 metal_device_close(ipi->dev);
244                                 ipi->dev = NULL;
245                         } else {
246                                 metal_free_memory(ipi->io);
247                         }
248                         ipi->io = NULL;
249                 }
250         }