packages/ti/sdo/ipc/family/Settings.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  *  ======== Settings.xdc ========
  34  *
  35  */
  36
  37 /*!
  38  *  @_nodoc
  39  *  Family setting module
  40  */
  41 metaonly module Settings
  42 {
  43     /*! returns the family specific Interrupt module delegate */
  44     String getDefaultInterruptDelegate();
  45
  46     /*! returns the device specific GateSpinLock settings */
  47     Any getGateHWSpinlockSettings();
  48
  49     /*! returns the device specific GateHWSem settings */
  50     Any getGateHWSemSettings();
  51
  52     /*! returns the module name of the HW Gate that the device supports */
  53     String getHWGate();
  54
  55     /*! returns true when the host needs to program the mmu for the slave */
  56     Bool getIpcSR0Setup();
  57
  58     /*! returns the MultiProc.id of the HOST if configured in MultiProc */
  59     UInt16 getHostProcId();
  60
  61     /*! returns whether the processor is in the build device */
  62     Bool procInDevice(String procName);
  63
  64     /*! returns array of names of processors on the build device */
  65     Any getDeviceProcNames();
  66
  67     /*! returns the device specific NameServer Remote delegate */
  68     String getNameServerRemoteDelegate();
  69
  70     /*! returns the device specific NotifySetup delegate */
  71     String getNotifySetupDelegate();
  72
  73     /*! returns the MessageQ transport setup delegate */
  74     String getMessageQSetupDelegate();
  75
  76     /*! returns whether to generate slave data for the host */
  77     Bool generateSlaveDataForHost();
  78 }