include/rm_nameserverloc.h

   1 /*
   2  *  file  rm_nameserverloc.h
   3  *
   4  *  Prototypes and data structures for the Resource Manager NameServer.
   5  *
   6  *  ============================================================================
   7  *      (C) Copyright 2012-2013, Texas Instruments, Inc.
   8  *
   9  *  Redistribution and use in source and binary forms, with or without
  10  *  modification, are permitted provided that the following conditions
  11  *  are met:
  12  *
  13  *    Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  *    Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  *    Neither the name of Texas Instruments Incorporated nor the names of
  22  *    its contributors may be used to endorse or promote products derived
  23  *    from this software without specific prior written permission.
  24  *
  25  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  *  \par
  38 */
  39
  40 #ifndef RM_NAMESERVERLOC_H_
  41 #define RM_NAMESERVERLOC_H_
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /* RM external API includes */
  48 #include <ti/drv/rm/rm.h>
  49
  50 /* RM internal includes */
  51 #include <ti/drv/rm/include/rm_treeloc.h>
  52
  53 /**********************************************************************
  54  ********************* Internal NameServer APIs ***********************
  55  **********************************************************************/
  56
  57 /* NameServer configuration structure */
  58 typedef struct {
  59     /* Pointer to the root entry of the NameServer tree structure */
  60     Rm_NameServerTree    *nameServerTree;
  61     /* NameServer tree node configuration struction */
  62     Rm_NameServerNodeCfg  nodeCfg;
  63 } Rm_NameServerObjCfg;
  64
  65 int32_t rmNameServerAddObject(Rm_NameServerObjCfg *objCfg);
  66 int32_t rmNameServerFindObject(Rm_NameServerObjCfg *objCfg);
  67 int32_t rmNameServerDeleteObject(Rm_NameServerObjCfg *objCfg);
  68 void rmNameServerPrintObjects(Rm_Handle rmHandle);
  69 void rmNameServerInit(Rm_Handle rmHandle);
  70 void rmNameServerDelete(Rm_Handle rmHandle);
  71
  72 #ifdef __cplusplus
  73 }
  74 #endif
  75
  76 #endif /* RM_NAMESERVERLOC_H_ */
  77