include/rm_allocatorloc.h

   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 */
  39
  40 #ifndef RM_ALLOCATORLOC_H_
  41 #define RM_ALLOCATORLOC_H_
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /* RM external includes */
  48 #include <ti/drv/rm/rm.h>
  49
  50 /* RM internal includes */
  51 #include <ti/drv/rm/include/rm_internal.h>
  52 #include <ti/drv/rm/include/rm_dtb_utilloc.h>
  53 #include <ti/drv/rm/include/rm_treeloc.h>
  54
  55 /* Resource properties extracted from the GRL DTB */
  56 typedef struct {
  57     /* Pointer to a resource's range data within the GRL DTB */
  58     const void *rangeData;
  59     /* Length in bytes of a resource's range data in the GRL DTB */
  60     int32_t     rangeLen;
  61     /* Pointer to a resource's NameServer assignment data within the GRL DTB.
  62      * Will be NULL if not defined for the resource node. */
  63     const void *nsAssignData;
  64     /* Length in bytes of a resource's NameServer assignment data in the GRL DTB.
  65      * Will be zero if not defined for the resource node. */
  66     int32_t     nsAssignLen;
  67     /* Pointer to a resource's Linux alias data within the GRL DTB.  Will be
  68      * NULL if not defined for the resource node. */
  69     const void *linuxAliasData;
  70     /* Length in bytes of a resource's Linux alias data data in the GRL DTB.
  71      * Will be zero if not defined for the resource node. */
  72     int32_t     linuxAliasLen;
  73 } Rm_ResourceProperties;
  74
  75 /* Resource allocator operations */
  76 typedef enum {
  77     /* Allocate init operation */
  78     Rm_allocatorOp_ALLOCATE_INIT = 0,
  79     /* Allocate use operation */
  80     Rm_allocatorOp_ALLOCATE_USE,
  81     /* Get resource status operation */
  82     Rm_allocatorOp_GET_STATUS,
  83     /* Free operation */
  84     Rm_allocatorOp_FREE,
  85     /* Preallocate to use based on Policy DTB information operation */
  86     Rm_allocatorOp_PRE_ALLOCATE_INIT,
  87     /* Preallocate to init based on Policy DTB information operation */
  88     Rm_allocatorOp_PRE_ALLOCATE_USE
  89 } Rm_AllocatorOp;
  90
  91 /* Allocator operation configuration structure */
  92 typedef struct {
  93     /* Pointer to policy used for validation of allocator operation */
  94     void                   *policy;
  95     /* RM instance for which the allocator operation is taking place */
  96     Rm_PolicyValidInstNode *serviceSrcInstNode;
  97     /* Allocator operation type */
  98     Rm_AllocatorOp          operation;
  99     /* Resources for which the allocator operation will affect */
 100     Rm_ResourceInfo        *resourceInfo;
 101 } Rm_AllocatorOpInfo;
 102
 103 /* RM allocator linked list node */
 104 typedef struct Rm_Allocator_s {
 105     /* Resource name for which the allocator was created.  The resource name
 106      * must match a resource node defined in both the GRL and the Policy */
 107     char                   resourceName[RM_NAME_MAX_CHARS];
 108     /* Pointer to the root entry of the allocator resource tree */
 109     Rm_ResourceTree       *allocatorRootEntry;
 110     /* Pointer to next resource allocator node */
 111     struct Rm_Allocator_s *nextAllocator;
 112 } Rm_Allocator;
 113
 114 int32_t rmAllocatorCreate(Rm_Handle rmHandle, const char *resourceName, Rm_ResourceRange *range);
 115 Rm_Allocator *rmAllocatorGetAllocatorList(Rm_Handle rmHandle);
 116 Rm_Allocator *rmAllocatorFind(Rm_Handle rmHandle, const char *resourceName);
 117 int rmAllocatorGetNodeLocalization(Rm_Handle rmHandle, char *resourceName,
 118                                    int32_t *resBase, uint32_t *resLen);
 119 int32_t rmAllocatorOperation(Rm_Handle rmHandle, Rm_AllocatorOpInfo *opInfo);
 120 int32_t rmAllocatorInitializeResources(Rm_Handle rmHandle, void *globalResourceDtb, void *linuxDtb);
 121 void rmAllocatorDeleteNode(Rm_Handle rmHandle, const char *resName, int32_t resBase, uint32_t resLen);
 122 int32_t rmAllocatorDelete(Rm_Handle rmHandle, const char *resourceName);
 123 void rmAllocatorDeleteResources(Rm_Handle rmHandle);
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif
 128
 129 #endif /* RM_ALLOCATORLOC_H_ */
 130