Added pre-main capabilities, cleaned up services and NameServer modules
[keystone-rtos/rm-lld.git] / 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, 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 */
40 #ifndef RM_NAMESERVERLOC_H_
41 #define RM_NAMESERVERLOC_H_
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
47 /* RM external includes */
48 #include <ti/drv/rm/rm.h>
49 #include <ti/drv/rm/rm_services.h>
51 /* AVL BBST includes */
52 #include <ti/drv/rm/include/tree.h>
54 typedef struct {
55     char     *objName;
56     char     *resourceName;
57     uint32_t  resourceBase;
58     uint32_t  resourceLength;
59 } Rm_NameServerNodeCfg;
61 /**********************************************************************
62  ******************** NameServer Tree Definitions *********************
63  **********************************************************************/
65 /* Declare the tree structure nodes */
66 typedef struct _Rm_NameServerNode {
67     RB_ENTRY(_Rm_NameServerNode) linkage;
68     char objName[RM_RESOURCE_NAME_MAX_CHARS];
69     char resourceName[RM_RESOURCE_NAME_MAX_CHARS];
70     uint32_t resourceBase;
71     uint32_t resourceLength;
72 } Rm_NameServerNode;
74 /* Declare the tree head structure. */
75 typedef RB_HEAD(_Rm_NameServerTree, _Rm_NameServerNode) Rm_NameServerTree;
77 Rm_NameServerNode *Rm_nameServerNewNode(Rm_NameServerNodeCfg *nodeCfg);
78 void Rm_nameServerFreeNode(Rm_NameServerNode *node);
79 /* Prototype for NameServer node comparison function
80  * element1 < element2 --> return < 0
81  * element1 = element2 --> return 0
82  * element1 > element2 --> return > 0 */
83 int Rm_nameServerNodeCompare(Rm_NameServerNode *node1, Rm_NameServerNode *node2); 
85 /* Generate the tree prototypes */
86 RB_PROTOTYPE(_Rm_NameServerTree, _Rm_NameServerNode, linkage, Rm_nameServerNodeCompare);
88 /**********************************************************************
89  ********************* Internal NameServer APIs ***********************
90  **********************************************************************/
92 typedef struct {
93     Rm_NameServerTree *nameServerTree;
94     Rm_NameServerNodeCfg nodeCfg;
95 } Rm_NameServerObjCfg;
97 int32_t Rm_nameServerAddObject(Rm_NameServerObjCfg *objCfg);
98 int32_t Rm_nameServerFindObject(Rm_NameServerObjCfg *objCfg);
99 int32_t Rm_nameServerDeleteObject(Rm_NameServerObjCfg *objCfg);
100 void Rm_nameServerPrintObjects(Rm_NameServerTree *nameServerTree);
101 Rm_NameServerTree *Rm_nameServerInit(void);
103 #ifdef __cplusplus
105 #endif
107 #endif /* RM_NAMESERVERLOC_H_ */