hlos_common/src/utils/MultiProc.c

   1 /*
   2  * Copyright (c) 2013-2015 Texas Instruments Incorporated - http://www.ti.com
   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  *  ======== MultiProc.c ========
  34  *
  35  *  Implementation of functions to access processor IDs configured on BIOS side.
  36  */
  37
  38 #include <ti/ipc/Std.h>
  39
  40 #include <assert.h>
  41 #include <string.h>
  42
  43 #include <ti/ipc/MultiProc.h>
  44 #include <_MultiProc.h>
  45
  46 /*
  47  *  ======== MultiProc_getBaseIdOfCluster ========
  48  */
  49 UInt16 MultiProc_getBaseIdOfCluster()
  50 {
  51     return (_MultiProc_cfg.baseIdOfCluster);
  52 }
  53
  54 /*
  55  *  ======== MultiProc_getId ========
  56  */
  57 UInt16 MultiProc_getId(String name)
  58 {
  59     Int    i;
  60     UInt16 id;
  61
  62     assert(name != NULL);
  63
  64     id = MultiProc_INVALIDID;
  65     for (i = 0; i < _MultiProc_cfg.numProcsInCluster; i++) {
  66         if ((_MultiProc_cfg.nameList[i] != NULL) &&
  67                 (strcmp(name, _MultiProc_cfg.nameList[i]) == 0)) {
  68             id = _MultiProc_cfg.baseIdOfCluster + i;
  69         }
  70     }
  71     return (id);
  72 }
  73
  74 /*
  75  *  ======== MultiProc_getName ========
  76  */
  77 String MultiProc_getName(UInt16 id)
  78 {
  79     assert(id < _MultiProc_cfg.numProcessors);
  80
  81     return (_MultiProc_cfg.nameList[id - _MultiProc_cfg.baseIdOfCluster]);
  82 }
  83
  84 /*
  85  *  ======== MultiProc_getNumProcessors ========
  86  */
  87 UInt16 MultiProc_getNumProcessors()
  88 {
  89     return (_MultiProc_cfg.numProcessors);
  90 }
  91
  92 /*
  93  *  ======== MultiProc_getNumProcsInCluster ========
  94  */
  95 UInt16 MultiProc_getNumProcsInCluster()
  96 {
  97     return (_MultiProc_cfg.numProcsInCluster);
  98 }
  99
 100 /*
 101  *  ======== MultiProc_self ========
 102  */
 103 UInt16 MultiProc_self()
 104 {
 105     return (_MultiProc_cfg.id);
 106 }
 107
 108 /*
 109  *  ======== MultiProc_setLocalId ========
 110  */
 111 Int MultiProc_setLocalId(UInt16 id)
 112 {
 113     /* id must be less than the number of processors */
 114     assert(id < _MultiProc_cfg.numProcessors);
 115
 116     /*
 117      *  Check the following
 118      *  1. Make sure the statically configured constant was invalid.
 119      *     To call setLocalId, the id must have been set to invalid.
 120      *  2. Make sure the call is made before module startup
 121      */
 122     if ((_MultiProc_cfg.id == MultiProc_INVALIDID) /* &&
 123         (Startup_rtsDone() == FALSE) */  )  {
 124         /* It is ok to set the id */
 125         _MultiProc_cfg.id = id;
 126         return (MultiProc_S_SUCCESS);
 127     }
 128
 129     return (MultiProc_E_FAIL);
 130 }