Adding policy checking feature on RM Server
[keystone-rtos/rm-lld.git] / include / rm_loc.h
1 /*
2  *  file  rm_loc.h
3  *
4  *  General private data structures of Resource Manager.
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 RMLOC_H_
41 #define RMLOC_H_
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
47 /* RM external includes */
48 #include <ti/drv/rm/rm_services.h>
49 #include <ti/drv/rm/rm_transport.h>
51 /* AVL BBST includes */
52 #include <ti/drv/rm/include/tree.h>
54 /** String stored for resource elements that are not currently allocated to anyone.  If the
55  *  resource is allocated the allocatedTo field will be populated with the RM instance
56  *  name it was allocated to. */
57 #define RM_NOT_ALLOCATED_STRING "\0"
58 /** String stored for resource elements that are reserved by the Linux kernel.  These
59  *  resources will be in use for the lifetime of the system */
60 #define RM_ALLOCATED_TO_LINUX "Linux-Kernel"
62 /** Maximum size of a transmittable RM policy in bytes */
63 #define RM_MAX_POLICY_SIZE_BYTES (64)  // Placeholder: This will change 
64                                        // during development
66 /** Pointer to RM instance's transport routing map */
67 typedef void *Rm_TransportRouteMap;
69 /** Pointer to RM instance's transaction queue */
70 typedef void *Rm_TransactionQueue;
72 /** Pointer to the RM instance's allocators */
73 typedef void *Rm_Allocators;
75 /** Pointer to the RM instance's NameServer (Valid only on Server) */
76 typedef void *Rm_NameServer;
78 /** Pointer to the RM instance's policy information */
79 typedef void *Rm_Policy;
81 /**
82  * @brief RM protocol packet resource information
83  */
84 typedef struct {
85     /** Resource name of resource affected by command */
86     char name[RM_RESOURCE_NAME_MAX_CHARS];
87     /** If applicable, start of resource range affected by command.  If
88      *  RM_RESOURCE_UNSPECIFIED is assigned the higher level RM agent*/
89     int32_t base;
90     /** If applicable, number of specified resource, starting from base, affected by command */
91     uint32_t length;
92     /** If applicable, the alignment of the resource affected by the command */
93     int32_t alignment;
94     /** If applicable, the NameServer name assigned to the specified
95      *  resource.  Used for commands centering on RM NameServer actions */
96     char nsName[RM_RESOURCE_NAME_MAX_CHARS];
97 } Rm_ResourceInfo;
99 /**
100  * @brief RM transactions are the internalized version of service requests received 
101  *        from components and RM commands received from other RM instances.
102  *        Transactions that cannot immediately be serviced are placed in the RM
103  *        instance's transaction queue.  The transactions track all service
104  *        requests within the RM infrastructure.
105  */
106 typedef struct {
107     /** Transaction service type */
108     Rm_ServiceType type;
109     /** Local ID of the transaction. */
110     uint32_t localId;
111     /** ID of transaction in RM instance that generated the
112      *  packet that resulted in the creation of the transaction.  The
113      *  originating ID will be placed in the transaction's response packet
114      *  to the lower level RM instance.  The lower level RM instance will 
115      *  match the response packet with the originating request using the ID */
116     uint32_t remoteOriginatingId;
117     /** Name of the RM instance the RM packet, that spawned the transaction,
118      *  originated from */
119     char pktSrcInstName[RM_INSTANCE_NAME_MAX_CHARS];
120     /** Transaction's associated callback function */
121     Rm_ServiceCallback callback;
122     /** Transaction state.  The codes are externally visible and tracked
123      *  in rmservices.h */
124     int32_t state;
125     /** Name of the RM instance the service originated from */
126     char serviceSrcInstName[RM_INSTANCE_NAME_MAX_CHARS];    
127     /** Resource information */
128     Rm_ResourceInfo resourceInfo;
129     /** Link to the next transaction in the queue */
130     void *nextTransaction;    
131 } Rm_Transaction;
133 typedef struct {
134     const void *rangeData;
135     int32_t rangeLen;
136     const void *nsAssignData;
137     int32_t nsAssignLen;
138     const void *linuxAliasData;
139     int32_t linuxAliasLen;
140 } Rm_ResourceProperties;
142 typedef enum {
143     Rm_allocatorOp_ALLOCATE = 0,
144     Rm_allocatorOp_FREE = 1,
145     Rm_allocatorOp_PRE_ALLOCATE = 2,
146 } Rm_AllocatorOp;
148 typedef struct {
149     char *serviceSrcInstName;
150     Rm_AllocatorOp operation;
151     /* Will contain the actual allocation/free values */
152     Rm_ResourceInfo *resourceInfo;
153 } Rm_AllocatorOpInfo;
155 typedef struct {
156     char resourceName[RM_RESOURCE_NAME_MAX_CHARS];
157     /** Pointer to the first resource entry in the allocator */
158     void *allocatorRootEntry;
159     /** Pointer to next resource allocator */
160     void *nextAllocator;
161 } Rm_Allocator;
163 typedef struct {
164     char name[RM_INSTANCE_NAME_MAX_CHARS];
165     Rm_InstType instType;
166     bool registeredWithDelegateOrServer;
167     Rm_Policy policyData;
168     Rm_Allocators allocators;
169     Rm_NameServer nameServer;
170     /* RM instance transport parameters */
171     Rm_TransportRouteMap routeMap;
172     /* RM Transaction sequence number counter */
173     uint32_t transactionSeqNum;
174     /* RM transaction queue */
175     Rm_TransactionQueue transactionQueue;
176     /* Transport API function pointers - not global in case application wants to
177       * hook up different transports to RM */
178     Rm_TransportCallouts transport;
179 } Rm_Inst;
181 Rm_Transaction *Rm_transactionQueueAdd(Rm_Inst *rmInst);
182 Rm_Transaction *Rm_transactionQueueFind(Rm_Inst *rmInst, uint32_t transactionId);
183 int32_t Rm_transactionQueueDelete(Rm_Inst *rmInst, uint32_t transactionId);
184 uint32_t Rm_transactionGetSequenceNum(Rm_Inst *rmInst);
186 void Rm_transactionResponder (Rm_Inst *rmInst, Rm_Transaction *transaction);
187 void Rm_transactionForwarder (Rm_Inst *rmInst, Rm_Transaction *transaction);
188 void Rm_transactionProcessor (Rm_Inst *rmInst, Rm_Transaction *transaction);
190 /**********************************************************************
191  ******************* Red-Black Tree BBST Defines **********************
192  **********************************************************************/
194 /* Declare the tree structure nodes */
195 typedef struct _Rm_ResourceNode {
196     RB_ENTRY(_Rm_ResourceNode) linkage;
197     uint32_t base;
198     uint32_t length;
199     char allocatedTo[RM_INSTANCE_NAME_MAX_CHARS];
200 } Rm_ResourceNode;
202 /* Declare the tree head structure.  A structure of type Rm_ResourceTree will need to be
203  * malloc'd for each tree that is to be created. */
204 typedef RB_HEAD(_Rm_ResourceTree, _Rm_ResourceNode) Rm_ResourceTree;
206 Rm_ResourceNode *Rm_newResourceNode(uint32_t resourceBase, uint32_t resourceLength, 
207                                     char *allocatedTo);
208 void Rm_freeResourceNode(Rm_ResourceNode *node);
209 /* Prototype for tree node comparison function
210  * element1 < element2 --> return < 0
211  * element1 = element2 --> return 0
212  * element1 > element2 --> return > 0 */
213 int Rm_ResourceNodeCompare(Rm_ResourceNode *element1, Rm_ResourceNode *element2); 
215 /* Generate the tree prototypes */
216 RB_PROTOTYPE(_Rm_ResourceTree, _Rm_ResourceNode, linkage, Rm_ResourceNodeCompare);
218 #ifdef __cplusplus
220 #endif
222 #endif /* RMLOC_H_ */