Add Vayu Family Support for IPU2 (SMP) and DSP1
[ipc/ipcdev.git] / packages / ti / ipc / family / vayu / VirtQueue.c
1 /*
2  * Copyright (c) 2011-2013, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * *  Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * *  Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * *  Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 /** ============================================================================
33  *  @file       VirtQueue.c
34  *
35  *  @brief      Virtio Queue implementation for BIOS
36  *
37  *  Differences between BIOS version and Linux kernel (include/linux/virtio.h):
38  *  - Renamed module from virtio.h to VirtQueue_Object.h to match the API prefixes;
39  *  - BIOS (XDC) types and CamelCasing used;
40  *  - virtio_device concept removed (i.e, assumes no containing device);
41  *  - simplified scatterlist from Linux version;
42  *  - VirtQueue_Objects are created statically here, so just added a VirtQueue_Object_init()
43  *    fxn to take the place of the Virtio vring_new_virtqueue() API;
44  *  - The notify function is implicit in the implementation, and not provided
45  *    by the client, as it is in Linux virtio.
46  *
47  *  All VirtQueue operations can be called in any context.
48  *
49  *  The virtio header should be included in an application as follows:
50  *  @code
51  *  #include <ti/ipc/family/vayu/VirtQueue.h>
52  *  @endcode
53  *
54  */
56 #include <xdc/std.h>
57 #include <xdc/runtime/System.h>
58 #include <xdc/runtime/Error.h>
59 #include <xdc/runtime/Memory.h>
60 #include <xdc/runtime/Log.h>
61 #include <xdc/runtime/Diags.h>
63 #include <ti/sysbios/hal/Hwi.h>
64 #include <ti/sysbios/knl/Clock.h>
65 #include <ti/sysbios/gates/GateAll.h>
66 #include <ti/sysbios/BIOS.h>
67 #include <ti/sysbios/hal/Cache.h>
69 #include <ti/ipc/MultiProc.h>
71 #include <ti/ipc/rpmsg/virtio_ring.h>
72 #ifndef DSP
73 #include <ti/pm/IpcPower.h>
74 #endif
75 #include <string.h>
77 #include <ti/ipc/rpmsg/_VirtQueue.h>
79 #include <ti/sdo/ipc/notifyDrivers/IInterrupt.h>
80 #include "InterruptProxy.h"
81 #include "VirtQueue.h"
84 /* Used for defining the size of the virtqueue registry */
85 #define NUM_QUEUES              4
87 /* Predefined device addresses */
88 #define IPC_MEM_VRING0          0xA0000000
89 #define IPC_MEM_VRING1          0xA0004000
90 #define IPC_MEM_VRING2          0xA0008000
91 #define IPC_MEM_VRING3          0xA000c000
93 /*
94  * Sizes of the virtqueues (expressed in number of buffers supported,
95  * and must be power of two)
96  */
97 #define VQ0_SIZE                256
98 #define VQ1_SIZE                256
99 #define VQ2_SIZE                256
100 #define VQ3_SIZE                256
102 /*
103  * enum - Predefined Mailbox Messages
104  *
105  * @RP_MSG_MBOX_READY: informs the M3's that we're up and running. will be
106  * followed by another mailbox message that carries the A9's virtual address
107  * of the shared buffer. This would allow the A9's drivers to send virtual
108  * addresses of the buffers.
109  *
110  * @RP_MSG_MBOX_STATE_CHANGE: informs the receiver that there is an inbound
111  * message waiting in its own receive-side vring. please note that currently
112  * this message is optional: alternatively, one can explicitly send the index
113  * of the triggered virtqueue itself. the preferred approach will be decided
114  * as we progress and experiment with those design ideas.
115  *
116  * @RP_MSG_MBOX_CRASH: this message indicates that the BIOS side is unhappy
117  *
118  * @RP_MBOX_ECHO_REQUEST: this message requests the remote processor to reply
119  * with RP_MBOX_ECHO_REPLY
120  *
121  * @RP_MBOX_ECHO_REPLY: this is a reply that is sent when RP_MBOX_ECHO_REQUEST
122  * is received.
123  *
124  * @RP_MBOX_ABORT_REQUEST:  tells the M3 to crash on demand
125  *
126  * @RP_MBOX_BOOTINIT_DONE: this message indicates the BIOS side has reached a
127  * certain state during the boot process. This message is used to inform the
128  * host that the basic BIOS initialization is done, and lets the host use this
129  * notification to perform certain actions.
130  */
131 enum {
132     RP_MSG_MBOX_READY           = (Int)0xFFFFFF00,
133     RP_MSG_MBOX_STATE_CHANGE    = (Int)0xFFFFFF01,
134     RP_MSG_MBOX_CRASH           = (Int)0xFFFFFF02,
135     RP_MBOX_ECHO_REQUEST        = (Int)0xFFFFFF03,
136     RP_MBOX_ECHO_REPLY          = (Int)0xFFFFFF04,
137     RP_MBOX_ABORT_REQUEST       = (Int)0xFFFFFF05,
138     RP_MSG_FLUSH_CACHE          = (Int)0xFFFFFF06,
139     RP_MSG_BOOTINIT_DONE        = (Int)0xFFFFFF07,
140     RP_MSG_HIBERNATION          = (Int)0xFFFFFF10,
141     RP_MSG_HIBERNATION_FORCE    = (Int)0xFFFFFF11,
142     RP_MSG_HIBERNATION_ACK      = (Int)0xFFFFFF12,
143     RP_MSG_HIBERNATION_CANCEL   = (Int)0xFFFFFF13
144 };
146 #define DIV_ROUND_UP(n,d)   (((n) + (d) - 1) / (d))
147 #define RP_MSG_NUM_BUFS     (VQ0_SIZE) /* must be power of two */
148 #define RP_MSG_BUF_SIZE     (512)
149 #define RP_MSG_BUFS_SPACE   (RP_MSG_NUM_BUFS * RP_MSG_BUF_SIZE * 2)
151 #define PAGE_SIZE           (4096)
152 /*
153  * The alignment to use between consumer and producer parts of vring.
154  * Note: this is part of the "wire" protocol. If you change this, you need
155  * to update your BIOS image as well
156  */
157 #define RP_MSG_VRING_ALIGN  (4096)
159 /* With 256 buffers, our vring will occupy 3 pages */
160 #define RP_MSG_RING_SIZE    ((DIV_ROUND_UP(vring_size(RP_MSG_NUM_BUFS, \
161                             RP_MSG_VRING_ALIGN), PAGE_SIZE)) * PAGE_SIZE)
163 /* The total IPC space needed to communicate with a remote processor */
164 #define RPMSG_IPC_MEM   (RP_MSG_BUFS_SPACE + 2 * RP_MSG_RING_SIZE)
166 #define ID_SYSM3_TO_A9      ID_SELF_TO_A9
167 #define ID_A9_TO_SYSM3      ID_A9_TO_SELF
168 #define ID_DSP_TO_A9        ID_SELF_TO_A9
169 #define ID_A9_TO_DSP        ID_A9_TO_SELF
170 #define ID_APPM3_TO_A9      2
171 #define ID_A9_TO_APPM3      3
173 typedef struct VirtQueue_Object {
174     /* Id for this VirtQueue_Object */
175     UInt16                  id;
177     /* The function to call when buffers are consumed (can be NULL) */
178     VirtQueue_callback      callback;
180     /* Shared state */
181     struct vring            vring;
183     /* Number of free buffers */
184     UInt16                  num_free;
186     /* Last available index; updated by VirtQueue_getAvailBuf */
187     UInt16                  last_avail_idx;
189     /* Last available index; updated by VirtQueue_addUsedBuf */
190     UInt16                  last_used_idx;
192     /* Will eventually be used to kick remote processor */
193     UInt16                  procId;
195     /* Gate to protect from multiple threads */
196     GateAll_Handle       gateH;
197 } VirtQueue_Object;
199 static struct VirtQueue_Object *queueRegistry[NUM_QUEUES] = {NULL};
201 static UInt16 hostProcId;
202 #ifndef SMP
203 static UInt16 dsp1ProcId;
204 static UInt16 sysm3ProcId;
205 static UInt16 appm3ProcId;
206 #endif
208 #define DSPEVENTID              5
209 IInterrupt_IntInfo intInfo;
211 #if defined(M3_ONLY) && !defined(SMP)
212 extern Void OffloadM3_init();
213 extern Int OffloadM3_processSysM3Tasks(UArg msg);
214 #endif
216 static inline Void * mapPAtoVA(UInt pa)
218     return (Void *)((pa & 0x000fffffU) | IPC_MEM_VRING0);
221 static inline UInt mapVAtoPA(Void * va)
223     return ((UInt)va & 0x000fffffU) | 0x9cf00000U;
226 /*!
227  * ======== VirtQueue_kick ========
228  */
229 Void VirtQueue_kick(VirtQueue_Handle vq)
231     /* For now, simply interrupt remote processor */
232     if (vq->vring.avail->flags & VRING_AVAIL_F_NO_INTERRUPT) {
233         Log_print0(Diags_USER1,
234                 "VirtQueue_kick: no kick because of VRING_AVAIL_F_NO_INTERRUPT\n");
235         return;
236     }
238     Log_print2(Diags_USER1,
239             "VirtQueue_kick: Sending interrupt to proc %d with payload 0x%x\n",
240             (IArg)vq->procId, (IArg)vq->id);
241     InterruptProxy_intSend(vq->procId, NULL, vq->id);
244 /*!
245  * ======== VirtQueue_addUsedBuf ========
246  */
247 Int VirtQueue_addUsedBuf(VirtQueue_Handle vq, Int16 head, Int len)
249     struct vring_used_elem *used;
250     IArg key;
252     key = GateAll_enter(vq->gateH);
253     if ((head > vq->vring.num) || (head < 0)) {
254         GateAll_leave(vq->gateH, key);
255         Error_raise(NULL, Error_E_generic, 0, 0);
256     }
258     /*
259     * The virtqueue contains a ring of used buffers.  Get a pointer to the
260     * next entry in that used ring.
261     */
262     used = &vq->vring.used->ring[vq->vring.used->idx % vq->vring.num];
263     used->id = head;
264     used->len = len;
266     vq->vring.used->idx++;
267     GateAll_leave(vq->gateH, key);
269     return (0);
272 /*!
273  * ======== VirtQueue_addAvailBuf ========
274  */
275 Int VirtQueue_addAvailBuf(VirtQueue_Object *vq, Void *buf)
277     UInt16 avail;
278     IArg key;
280     if (vq->num_free == 0) {
281         /* There's no more space */
282         Error_raise(NULL, Error_E_generic, 0, 0);
283     }
285     vq->num_free--;
287     key = GateAll_enter(vq->gateH);
288     avail =  vq->vring.avail->idx++ % vq->vring.num;
290     vq->vring.desc[avail].addr = mapVAtoPA(buf);
291     vq->vring.desc[avail].len = RP_MSG_BUF_SIZE;
292     GateAll_leave(vq->gateH, key);
294     return (vq->num_free);
297 /*!
298  * ======== VirtQueue_getUsedBuf ========
299  */
300 Void *VirtQueue_getUsedBuf(VirtQueue_Object *vq)
302     UInt16 head;
303     Void *buf;
304     IArg key;
306     key = GateAll_enter(vq->gateH);
307     /* There's nothing available? */
308     if (vq->last_used_idx == vq->vring.used->idx) {
309         buf = NULL;
310     }
311     else {
312         head = vq->vring.used->ring[vq->last_used_idx % vq->vring.num].id;
313         vq->last_used_idx++;
315         buf = mapPAtoVA(vq->vring.desc[head].addr);
316     }
317     GateAll_leave(vq->gateH, key);
319     return (buf);
322 /*!
323  * ======== VirtQueue_getAvailBuf ========
324  */
325 Int16 VirtQueue_getAvailBuf(VirtQueue_Handle vq, Void **buf, Int *len)
327     Int16 head;
328     IArg key;
330     key = GateAll_enter(vq->gateH);
331     Log_print6(Diags_USER1, "getAvailBuf vq: 0x%x %d %d %d 0x%x 0x%x\n",
332         (IArg)vq, vq->last_avail_idx, vq->vring.avail->idx, vq->vring.num,
333         (IArg)&vq->vring.avail, (IArg)vq->vring.avail);
335     /* There's nothing available? */
336     if (vq->last_avail_idx == vq->vring.avail->idx) {
337         /* We need to know about added buffers */
338         vq->vring.used->flags &= ~VRING_USED_F_NO_NOTIFY;
339         head = (-1);
340     }
341     else {
342         /*
343          * Grab the next descriptor number they're advertising, and increment
344          * the index we've seen.
345          */
346         head = vq->vring.avail->ring[vq->last_avail_idx++ % vq->vring.num];
348         *buf = mapPAtoVA(vq->vring.desc[head].addr);
349         *len = vq->vring.desc[head].len;
350     }
351     GateAll_leave(vq->gateH, key);
353     return (head);
356 /*!
357  * ======== VirtQueue_disableCallback ========
358  */
359 Void VirtQueue_disableCallback(VirtQueue_Object *vq)
361     //TODO
362     Log_print0(Diags_USER1, "VirtQueue_disableCallback called.");
365 /*!
366  * ======== VirtQueue_enableCallback ========
367  */
368 Bool VirtQueue_enableCallback(VirtQueue_Object *vq)
370     Log_print0(Diags_USER1, "VirtQueue_enableCallback called.");
372     //TODO
373     return (FALSE);
376 /*!
377  * ======== VirtQueue_isr ========
378  * Note 'arg' is ignored: it is the Hwi argument, not the mailbox argument.
379  */
380 Void VirtQueue_isr(UArg msg)
382     VirtQueue_Object *vq;
384     msg = InterruptProxy_intClear(hostProcId, &intInfo);
386     Log_print1(Diags_USER1, "VirtQueue_isr received msg = 0x%x\n", msg);
388 #ifndef SMP
389     if (MultiProc_self() == sysm3ProcId || MultiProc_self() == dsp1ProcId) {
390 #endif
391         switch(msg) {
392             case (UInt)RP_MSG_MBOX_READY:
393                 return;
395             case (UInt)RP_MBOX_ECHO_REQUEST:
396                 InterruptProxy_intSend(hostProcId, NULL,
397                                        (UInt)(RP_MBOX_ECHO_REPLY));
398                 return;
400             case (UInt)RP_MBOX_ABORT_REQUEST:
401                 {
402                     /* Suppress Coverity Error: FORWARD_NULL: */
403                     // coverity[assign_zero]
404                     Fxn f = (Fxn)0x0;
405                     Log_print0(Diags_USER1, "Crash on demand ...\n");
406                     // coverity[var_deref_op]
407                     f();
408                 }
409                 return;
411             case (UInt)RP_MSG_FLUSH_CACHE:
412                 Cache_wbAll();
413                 return;
415 #ifndef DSP
416             case (UInt)RP_MSG_HIBERNATION:
417                 if (IpcPower_canHibernate() == FALSE) {
418                     InterruptProxy_intSend(hostProcId, NULL,
419                                            (UInt)RP_MSG_HIBERNATION_CANCEL);
420                     return;
421                 }
423             /* Fall through */
424             case (UInt)RP_MSG_HIBERNATION_FORCE:
425 #ifndef SMP
426                 /* Core0 should notify Core1 */
427                 if (MultiProc_self() == sysm3ProcId) {
428                     InterruptProxy_intSend(appm3ProcId, NULL,
429                                            (UInt)(RP_MSG_HIBERNATION));
430                 }
431 #endif
432                 /* Ack request */
433                 InterruptProxy_intSend(hostProcId, NULL,
434                                        (UInt)RP_MSG_HIBERNATION_ACK);
435                 IpcPower_suspend();
436                 return;
437 #endif
438             default:
439 #if defined(M3_ONLY) && !defined(SMP)
440                 /* Check and process any Inter-M3 Offload messages */
441                 if (OffloadM3_processSysM3Tasks(msg))
442                     return;
443 #endif
445                 /*
446                  *  If the message isn't one of the above, it's either part of the
447                  *  2-message synchronization sequence or it a virtqueue message
448                  */
449                 break;
450         }
451 #ifndef SMP
452     }
453     else if (msg & 0xFFFF0000) {
454 #ifndef DSP
455         if (msg == (UInt)RP_MSG_HIBERNATION) {
456             IpcPower_suspend();
457         }
458 #endif
459         return;
460     }
462     if (MultiProc_self() == sysm3ProcId && (msg == ID_A9_TO_APPM3 || msg == ID_APPM3_TO_A9)) {
463         InterruptProxy_intSend(appm3ProcId, NULL, (UInt)msg);
464     }
465     else {
466 #endif
467         /* Don't let unknown messages to pass as a virtqueue index */
468         if (msg >= NUM_QUEUES) {
469             /* Adding print here deliberately, we should never see this */
470             System_printf("VirtQueue_isr: Invalid mailbox message 0x%x "
471                           "received\n", msg);
472             return;
473         }
475         vq = queueRegistry[msg];
476         if (vq) {
477             vq->callback(vq);
478         }
479 #ifndef SMP
480     }
481 #endif
485 /*!
486  * ======== VirtQueue_create ========
487  */
488 VirtQueue_Handle VirtQueue_create(UInt16 remoteProcId, VirtQueue_Params *params,
489                                   Error_Block *eb)
491     VirtQueue_Object *vq;
492     Void *vringAddr;
494     vq = Memory_alloc(NULL, sizeof(VirtQueue_Object), 0, eb);
495     if (NULL == vq) {
496         return (NULL);
497     }
499     /* Create the thread protection gate */
500     vq->gateH = GateAll_create(NULL, eb);
501     if (Error_check(eb)) {
502         Log_error0("VirtQueue_create: could not create gate object");
503         Memory_free(NULL, vq, sizeof(VirtQueue_Object));
504         return (NULL);
505     }
507     vq->callback = params->callback;
508     vq->id = params->vqId;
509     vq->procId = remoteProcId;
510     vq->last_avail_idx = 0;
512 #ifndef SMP
513     if (MultiProc_self() == appm3ProcId) {
514         /* vqindices that belong to AppM3 should be big so they don't
515          * collide with SysM3's virtqueues */
516          vq->id += 2;
517     }
518 #endif
520     switch (vq->id) {
521         /* IPC transport vrings */
522         case ID_SELF_TO_A9:
523             /* IPU/DSP -> A9 */
524             vringAddr = (struct vring *) IPC_MEM_VRING0;
525             break;
526         case ID_A9_TO_SELF:
527             /* A9 -> IPU/DSP */
528             vringAddr = (struct vring *) IPC_MEM_VRING1;
529             break;
530 #ifndef SMP
531         case ID_APPM3_TO_A9:
532             /* APPM3 -> A9 */
533             vringAddr = (struct vring *) IPC_MEM_VRING2;
534             break;
535         case ID_A9_TO_APPM3:
536             /* A9 -> APPM3 */
537             vringAddr = (struct vring *) IPC_MEM_VRING3;
538             break;
539 #endif
540         default:
541             GateAll_delete(&vq->gateH);
542             Memory_free(NULL, vq, sizeof(VirtQueue_Object));
543             return (NULL);
544     }
546     Log_print3(Diags_USER1,
547             "vring: %d 0x%x (0x%x)\n", vq->id, (IArg)vringAddr,
548             RP_MSG_RING_SIZE);
550     /* See coverity related comment in vring_init() */
551     // coverity[overrun-call]
552     vring_init(&(vq->vring), RP_MSG_NUM_BUFS, vringAddr, RP_MSG_VRING_ALIGN);
554     /*
555      *  Don't trigger a mailbox message every time MPU makes another buffer
556      *  available
557      */
558     if (vq->procId == hostProcId) {
559         vq->vring.used->flags |= VRING_USED_F_NO_NOTIFY;
560     }
562     queueRegistry[vq->id] = vq;
564     return (vq);
567 /*!
568  * ======== VirtQueue_startup ========
569  */
570 Void VirtQueue_startup()
572     hostProcId      = MultiProc_getId("HOST");
573 #ifndef SMP
574     dsp1ProcId       = MultiProc_getId("DSP1");
575     sysm3ProcId     = MultiProc_getId("CORE0");
576     appm3ProcId     = MultiProc_getId("CORE1");
577 #endif
579 #ifdef DSP
580     intInfo.intVectorId = DSPEVENTID;
581 #else
582     /* Initilize the IpcPower module */
583     IpcPower_init();
584 #endif
586     InterruptProxy_intRegister(hostProcId, &intInfo, (Fxn)VirtQueue_isr, NULL);
589 /*!
590  * ======== VirtQueue_postCrashToMailbox ========
591  */
592 Void VirtQueue_postCrashToMailbox(Void)
594     InterruptProxy_intSend(0, NULL, (UInt)RP_MSG_MBOX_CRASH);
597 #define CACHE_WB_TICK_PERIOD    5
599 /*!
600  * ======== VirtQueue_cacheWb ========
601  *
602  * Used for flushing SysMin trace buffer.
603  */
604 Void VirtQueue_cacheWb()
606     static UInt32 oldticks = 0;
607     UInt32 newticks;
609     newticks = Clock_getTicks();
610     if (newticks - oldticks < (UInt32)CACHE_WB_TICK_PERIOD) {
611         /* Don't keep flushing cache */
612         return;
613     }
615     oldticks = newticks;
617     /* Flush the cache */
618     Cache_wbAll();