packages/ti/ipc/transports/TransportVirtio.xdc

   1 /*
   2  * Copyright (c) 2012, 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  *  ======== TransportVirtio.xdc ================
  34  */
  35
  36 import ti.sysbios.knl.Swi;
  37 import ti.sysbios.gates.GateSwi;
  38
  39 /*!
  40  *  ======== TransportVirtio ========
  41  *  Transport for MessageQ that uses vring structures.
  42  *
  43  *  This is a {@link ti.sdo.ipc.MessageQ} transport that utilizes
  44  *  a pair of vrings (see Linux virtio) to communicate with a remote processor.
  45  *
  46  */
  47
  48 @InstanceFinalize
  49 @InstanceInitError
  50
  51
  52 module TransportVirtio inherits ti.sdo.ipc.interfaces.IMessageQTransport
  53 {
  54
  55 instance:
  56
  57     /*!
  58      *  ======== sharedAddr ========
  59      *  Address in shared memory where this instance will be placed
  60      *
  61      */
  62     config Ptr sharedAddr = null;
  63
  64     /*!
  65      *  ======== intVectorId ========
  66      *  Interrupt vector ID to be used by the driver.
  67      *
  68      *  This parameter is only used by C64x+ targets
  69      */
  70     config UInt intVectorId = ~1u;
  71
  72 internal:
  73
  74     /*!
  75      *  ======== swiFxn ========
  76      */
  77     Void swiFxn(UArg arg0, UArg arg1);
  78
  79     struct Module_State
  80     {
  81         GateSwi.Handle gateSwiHandle;
  82     }
  83
  84     /*! Instance state structure */
  85     struct Instance_State {
  86         UInt16       priority;           /* priority to register             */
  87         UInt16       remoteProcId;       /* dst proc id                      */
  88         Bool         isHost;             /* self proc id acts as a host.     */
  89         Swi.Object   swiObj;             /* Each instance has a swi          */
  90         Ptr          vq_slave;           /* Slave's VirtQueue Handle         */
  91         Ptr          vq_host;            /* Host's VirtQueue Handle          */
  92         Ptr          sbufs;              /* Buffers for sending              */
  93         UInt16       last_sbuf;          /* Index of last send buffer used   */
  94     }
  95 }