linux/include/TransportRpmsg.h

   1 /*
   2  * Copyright (c) 2014, 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  *  ======== TransportRpmsg.h ========
  34  */
  35
  36 /**
  37  *  @file       TransportRpmsg.h
  38  *
  39  *  @brief      Rpmsg transports implemenation
  40  *
  41  *              The transports can be register with MessageQ. This is done
  42  *              via the MessageQ_registerTransport function.
  43  */
  44
  45 #ifndef _TransportRpmsg_
  46 #define _TransportRpmsg_
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 #include <ti/ipc/Std.h>
  53 #include <IMessageQTransport.h>
  54
  55 struct TransportRpmsg_Params {
  56     UInt16 rprocId;
  57 };
  58 typedef struct TransportRpmsg_Params TransportRpmsg_Params;
  59
  60 typedef IMessageQTransport_Handle TransportRpmsg_Handle;
  61
  62 TransportRpmsg_Handle TransportRpmsg_create(TransportRpmsg_Params *param,
  63                                             Int *attachStatus);
  64 Void TransportRpmsg_delete(TransportRpmsg_Handle *hp);
  65
  66 IMessageQTransport_Handle TransportRpmsg_upCast(TransportRpmsg_Handle handle);
  67 TransportRpmsg_Handle TransportRpmsg_downCast(IMessageQTransport_Handle base);
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 #endif