1 /*
2 * file rm_allocatorloc.h
3 *
4 * Private data structures and APIS for Resource Manager allocators.
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 */
40 #ifndef RM_ALLOCATORLOC_H_
41 #define RM_ALLOCATORLOC_H_
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
47 /* RM external includes */
48 #include <ti/drv/rm/rm.h>
50 /* RM internal includes */
51 #include <ti/drv/rm/include/rm_internal.h>
52 #include <ti/drv/rm/include/rm_treeloc.h>
54 /* Resource properties extracted from the GRL DTB */
55 typedef struct {
56 /* Pointer to a resource's range data within the GRL DTB */
57 const void *rangeData;
58 /* Length in bytes of a resource's range data in the GRL DTB */
59 int32_t rangeLen;
60 /* Pointer to a resource's NameServer assignment data within the GRL DTB.
61 * Will be NULL if not defined for the resource node. */
62 const void *nsAssignData;
63 /* Length in bytes of a resource's NameServer assignment data in the GRL DTB.
64 * Will be zero if not defined for the resource node. */
65 int32_t nsAssignLen;
66 /* Pointer to a resource's Linux alias data within the GRL DTB. Will be
67 * NULL if not defined for the resource node. */
68 const void *linuxAliasData;
69 /* Length in bytes of a resource's Linux alias data data in the GRL DTB.
70 * Will be zero if not defined for the resource node. */
71 int32_t linuxAliasLen;
72 } Rm_ResourceProperties;
74 /* Resource allocator operations */
75 typedef enum {
76 /* Allocate operation */
77 Rm_allocatorOp_ALLOCATE = 0,
78 /* Free operation */
79 Rm_allocatorOp_FREE,
80 /* Preallocate based on Policy DTB information operation */
81 Rm_allocatorOp_PRE_ALLOCATE
82 } Rm_AllocatorOp;
84 /* Allocator operation configuration structure */
85 typedef struct {
86 /* Pointer to policy used for validation of allocator operation */
87 void *policy;
88 /* RM instance for which the allocator operation is taking place */
89 Rm_PolicyValidInstNode *serviceSrcInstNode;
90 /* Allocator operation type */
91 Rm_AllocatorOp operation;
92 /* Specifies the type of allocation
93 * a) Allocate to initialize
94 * b) Allocate to use */
95 uint32_t allocType;
96 /* Resources for which the allocator operation will affect */
97 Rm_ResourceInfo *resourceInfo;
98 } Rm_AllocatorOpInfo;
100 /* RM allocator linked list node */
101 typedef struct Rm_Allocator_s {
102 /* Resource name for which the allocator was created. The resource name
103 * must match a resource node defined in both the GRL and the Policy */
104 char resourceName[RM_NAME_MAX_CHARS];
105 /* Pointer to the root entry of the allocator resource tree */
106 Rm_ResourceTree *allocatorRootEntry;
107 /* Pointer to next resource allocator node */
108 struct Rm_Allocator_s *nextAllocator;
109 } Rm_Allocator;
111 Rm_Allocator *rmAllocatorFind(Rm_Handle rmHandle, const char *resourceName);
112 int32_t rmAllocatorOperation(Rm_Handle rmHandle, Rm_AllocatorOpInfo *opInfo);
113 int32_t rmAllocatorInitializeResources(Rm_Handle rmHandle, void *globalResourceDtb, void *linuxDtb);
114 void rmAllocatorDeleteResources(Rm_Handle rmHandle);
116 #ifdef __cplusplus
117 }
118 #endif
120 #endif /* RM_ALLOCATORLOC_H_ */