packages/ti/sdo/utils/INameServerRemote.xdc

   1 /*
   2  * Copyright (c) 2012-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  *  ======== INameServerRemote.xdc ========
  34  *
  35  */
  36
  37 import xdc.runtime.Error;
  38
  39 /*!
  40  *  ======== INameServerRemote ========
  41  *  Interface for remote NameServer accesses
  42  */
  43 interface INameServerRemote {
  44
  45     /*!
  46      *  ======== Status ========
  47      *  Status codes returned by certain calls
  48      */
  49     enum Status {
  50         S_SUCCESS = 0,
  51         E_FAIL = -1,
  52         E_ERROR = -2
  53     };
  54
  55     /*! Function is called by Ipc_attach() through NameServer_SetupProxy */
  56     @DirectCall
  57     Int attach(UInt16 remoteProcId, Ptr sharedAddr);
  58
  59     /*! Function is called by Ipc_detach() through NameServer_SetupProxy */
  60     @DirectCall
  61     Int detach(UInt16 remoteProcId);
  62
  63     /*!
  64      *  ======== sharedMemReq ========
  65      *  Returns the shared memory size requirement for a single instance
  66      *
  67      *  Function is called during Ipc_attach() through NameServer_SetupProxy.
  68      *
  69      *  @param(sharedAddr)   Shared address
  70      *
  71      *  @b(returns)          Number of MAUs needed to create the instance.
  72      */
  73     @DirectCall
  74     SizeT sharedMemReq(Ptr sharedAddr);
  75
  76 instance:
  77
  78     /*!
  79      *  ======== create ========
  80      */
  81     override create(UInt16 procId);
  82
  83     /*!
  84      *  ======== get ========
  85      */
  86     Int get(String instanceName,
  87             String name,
  88             Ptr value,
  89             UInt32 *valueLen,
  90             xdc.runtime.knl.ISync.Handle syncHandle,
  91             Error.Block *eb);
  92 }