edfdd5a8e7b686bf479c44184fa0980dbfbe63f2
[keystone-rtos/rm-lld.git] / src / rm_services.c
1 /**
2  *   @file  rmservices.c
3  *
4  *   @brief   
5  *      This is the Resource Manager services source.
6  *
7  *  \par
8  *  ============================================================================
9  *  @n   (C) Copyright 2012, Texas Instruments, Inc.
10  * 
11  *  Redistribution and use in source and binary forms, with or without 
12  *  modification, are permitted provided that the following conditions 
13  *  are met:
14  *
15  *    Redistributions of source code must retain the above copyright 
16  *    notice, this list of conditions and the following disclaimer.
17  *
18  *    Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the 
20  *    documentation and/or other materials provided with the   
21  *    distribution.
22  *
23  *    Neither the name of Texas Instruments Incorporated nor the names of
24  *    its contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
31  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
32  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
33  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
36  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
37  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38  *
39  *  \par
40 */
42 /* RM Types */
43 #include <ti/drv/rm/rm_types.h>
45 /* RM external API includes */
46 #include <ti/drv/rm/rm_services.h>
48 /* RM internal API includes */
49 #include <ti/drv/rm/include/rm_loc.h>
51 /* RM OSAL layer */
52 #include <rm_osal.h>
54 /**********************************************************************
55  ********************** Internal Functions ****************************
56  **********************************************************************/
58 void Rm_serviceHandler (void *rmHandle, Rm_ServiceReqInfo *serviceRequest,
59                         Rm_ServiceRespInfo *serviceResponse)
60 {
61     Rm_Inst *rmInst = (Rm_Inst *)rmHandle;
62     Rm_Transaction *transaction;
63     void *key;
65     /* Prevent another component using the same instance from wiping out the current
66      * service request */
67     key = Rm_osalCsEnter();
69     /* Make sure serviceType is valid and that a callback function has been provided */
70     if ((serviceRequest->type < Rm_service_FIRST) || 
71         (serviceRequest->type > Rm_service_LAST))
72     {
73         serviceResponse->serviceState = RM_SERVICE_ERROR_INVALID_SERVICE_TYPE;
74         Rm_osalCsExit(key);
75         return;
76     }
77     else if (serviceRequest->callback.serviceCallback == NULL)
78     {
79         /* The RM Client and Client Delegate use blocking transports to consult with a 
80          * high-level RM agent prior to providing a response to the component.  It is 
81          * assumed the component's cannot block.  Therefore, all responses must go
82          * through the callback function provided by the component.  Return an error 
83          * if the component does not provide a callback function. */
84         serviceResponse->serviceState = RM_SERVICE_ERROR_CALLBACK_NOT_PROVIDED;
85         Rm_osalCsExit(key);
86         return;
87     }
88     
89     /* Create a new transaction */
90     transaction = Rm_transactionQueueAdd(rmInst);
92     if (transaction == NULL)
93     {
94         /* Failed to create a new transaction */
95         serviceResponse->serviceState = RM_SERVICE_ERROR_TRANSACTION_FAILED_TO_ALLOCATE;
96     }
97     else
98     {
99         /* Transfer request information into the transaction */
100         transaction->type = serviceRequest->type;
101         strcpy(transaction->sourceInstName, rmInst->name);
102         transaction->callback.serviceCallback = serviceRequest->callback.serviceCallback;
103         transaction->state = RM_SERVICE_PROCESSING;
104         strcpy(&(transaction->resourceInfo.name)[0], serviceRequest->resourceName);
105         transaction->resourceInfo.base = serviceRequest->resourceBase;
106         transaction->resourceInfo.range = serviceRequest->resourceRange;
107         transaction->resourceInfo.alignment = serviceRequest->resourceAlignment;
108         strcpy(&(transaction->resourceInfo.nsName)[0], serviceRequest->resourceNsName);
110         /* Pass the new transaction to the transaction processor */
111         Rm_transactionProcessor (rmInst, transaction);
113         /* Provide response to the component that requested the service */
114         serviceResponse->serviceState = transaction->state;
115         if (serviceResponse->serviceState == RM_SERVICE_PROCESSING)
116         {
117             /* The service is still being processed.  Provide the transaction ID
118              * back to the component so that it can sort service responses received
119              * via the provided callback function */
120             serviceResponse->serviceId = transaction->localId;
121         }
122         else if (serviceResponse->serviceState == RM_SERVICE_APPROVED)
123         {
124             /* Service was approved and service was an allocate request the resource
125              * data is passed back to the component */
126             if ((transaction->type == Rm_service_RESOURCE_ALLOCATE) ||
127                 (transaction->type == Rm_service_RESOURCE_BLOCK_ALLOCATE) ||
128                 (transaction->type == Rm_service_RESOURCE_ALLOCATE_BY_NAME))
129             {
130                 serviceResponse->resourceBase = transaction->resourceInfo.base;
131                 serviceResponse->resourceRange = transaction->resourceInfo.range;
132             }
134             /* Delete the transaction since a response was received immediately */
135             Rm_transactionQueueDelete(rmInst, transaction->id);
136         }
137         else if ((serviceResponse->serviceState >= RM_SERVICE_DENIED_BEGIN) &&
138                  (serviceResponse->serviceState <= RM_SERVICE_DENIED_END))
139         {
140             /* The serviceState field will contain information regarding why the 
141              * service was denied.  Just delete the transaction since a response was
142              * received immediately */
143             Rm_transactionQueueDelete(rmInst, transaction->id);
144         }
145     }
147     Rm_osalCsExit(key); 
148     return;
151 /* This function is executed when a RM instance receives a response to one of its requests
152  * and the information in the request must be provided to the original requesting component */
153 void Rm_serviceResponder (Rm_Inst *rmInst, Rm_Transaction *transaction)
155     Rm_ServiceRespInfo serviceResponse;
157     /* The responseTransaction will contain the resultant state details of
158      * the requestTransaction's service request */
159     serviceResponse.serviceState = transaction->state;
160     /* Pass back the ID that was provided to the component when it requested
161      * the service */
162     serviceResponse.serviceId = transaction->localId;
164     /* Service was approved and service was an allocate request.  The resource
165      * data is passed back to the component */
166     if ((serviceResponse.serviceState == RM_SERVICE_APPROVED) &&
167         ((transaction->type == Rm_service_RESOURCE_ALLOCATE) ||
168          (transaction->type == Rm_service_RESOURCE_BLOCK_ALLOCATE) ||
169          (transaction->type == Rm_service_RESOURCE_ALLOCATE_BY_NAME)))
170     {
171         serviceResponse.resourceBase = transaction->resourceInfo.base;
172         serviceResponse.resourceRange = transaction->resourceInfo.range;
173     }
175     /* Issue the callback to the requesting component with the response information */
176     transaction->callback.serviceCallback(&serviceResponse);
178     /* Delete the transaction from the transaction queue */
179     Rm_transactionQueueDelete(rmInst, transaction->localId);
180     return;
183 /**********************************************************************
184  ********************** Application visible APIs **********************
185  **********************************************************************/
187 void Rm_preMainAllocService(Rm_PreMainAllocInfo *preMainAllocInfo,
188                             Rm_ServiceRespInfo *serviceResponse)
193 Rm_ServicePort *Rm_getServicePort(Rm_Handle rmHandle)
195     Rm_ServicePort *newServicePort = NULL;
196     
197     /* Create a new service handle for the specified RM instance */
198     
199     /* Get memory for a new service port from local memory */
200     newServicePort = Rm_osalMalloc (sizeof(Rm_ServicePort), false);
202     /* Return NULL immediately if malloc returned NULL */
203     if (newServicePort == NULL)
204     {
205         return (newServicePort);
206     }
208     newServicePort->rmHandle = rmHandle;
209     newServicePort->rmService = Rm_serviceHandler;
211     return (newServicePort);
214 /**
215 @}
216 */