packages/ti/sdo/ce/ipc/package.xs

   1 /*
   2  * Copyright (c) 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
  34 /*
  35  *  ======== Package.close ========
  36  *  Close this package; optionally (re)set other config parameters in the
  37  *  model
  38  */
  39 function close()
  40 {
  41     trace(this.$name + ".close() ...");
  42     var settings = this.Settings;
  43     var prog = Program;
  44
  45     /* if undefined, take profile from the Settings module */
  46     if (this.profile == undefined) {
  47         this.profile = xdc.useModule('ti.sdo.ce.global.Settings').profile;
  48     }
  49
  50     var global = xdc.useModule('ti.sdo.ce.osal.Global');
  51
  52     //  If ipc is not configured in the .cfg file, attempt to do it
  53     //  based on ti.sdo.ce.osal.Global.runtimeEnv.
  54     if (settings.ipc == undefined) {
  55         if (global.runtimeEnv == global.DSPLINK_LINUX) {
  56             settings.ipc = xdc.useModule('ti.sdo.ce.ipc.dsplink.Ipc');
  57         }
  58         else if (global.runtimeEnv == global.DSPLINK_BIOS) {
  59             // Set the ipc to bios.
  60             settings.ipc = xdc.useModule('ti.sdo.ce.ipc.bios.Ipc');
  61
  62             // Bring in this module for DSPLink
  63             xdc.useModule('ti.sdo.ce.ipc.dsplink.dsp.Settings');
  64         }
  65         else if (osalGlobal.runtimeEnv == osalGlobal.DSPBIOS) {
  66             // Set the ipc to bios.
  67             settings.ipc = xdc.useModule('ti.sdo.ce.ipc.bios.Ipc');
  68         }
  69         else if (osalGlobal.runtimeEnv == osalGlobal.LINUX) {
  70             // Set the ipc to linux.
  71             settings.ipc = xdc.useModule('ti.sdo.ce.ipc.linux.Ipc');
  72         }
  73         else {
  74             throw (this.$name + ".close(): Error: ipc undefined");
  75         }
  76     }
  77
  78     trace(this.$name + ".close() done!");
  79 }
  80
  81 /*
  82  *  ======== Package.validate ========
  83  *  Verify the config params for this package; called after close()
  84  */
  85 function validate()
  86 {
  87     trace(this.$name + ".validate() ...");
  88
  89 }
  90
  91 /*
  92  *  ======== getLibs ========
  93  */
  94 function getLibs(prog)
  95 {
  96     return (null);
  97 }
  98
  99
 100 /*
 101  *  ======== warn ========
 102  *  For warnings that we may not really want to print.
 103  */
 104 function warn(msg)
 105 {
 106     //print("WARN:  " + msg);
 107 }
 108
 109 /*
 110  *  ======== trace ========
 111  */
 112 function trace(msg)
 113 {
 114     //print("TRACE:  " + msg);
 115 }