9561425fd3870b66c7cdf0fbde8792f97a7f1b65
[keystone-rtos/rm-lld.git] / rm_services.h
1 /**
2  *   @file  rmservices.h
3  *
4  *   @brief   
5  *      This is the RM include file for services provided to components that 
6  *      register a RM instance
7  *
8  *  \par
9  *  ============================================================================
10  *  @n   (C) Copyright 2012, Texas Instruments, Inc.
11  * 
12  *  Redistribution and use in source and binary forms, with or without 
13  *  modification, are permitted provided that the following conditions 
14  *  are met:
15  *
16  *    Redistributions of source code must retain the above copyright 
17  *    notice, this list of conditions and the following disclaimer.
18  *
19  *    Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the 
21  *    documentation and/or other materials provided with the   
22  *    distribution.
23  *
24  *    Neither the name of Texas Instruments Incorporated nor the names of
25  *    its contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
29  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
30  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
32  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
33  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
34  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
37  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
38  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  *
40  *  \par
41 */
43 #ifndef RMSERVICES_H_
44 #define RMSERVICES_H_
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
50 /* RM includes */
51 #include <ti/drv/rm/rm.h>
53 /**
54 @addtogroup RMSERVICES_API
55 @{
56 */
58 /** RM Service Request (serviceResult) Action Codes and Errors */
59 /** RM Service Request Action Code Base */
60 #define RM_SERVICE_ACTION_BASE (0)
61 /** RM internal action okay - This value is for internal use by RM.  It should never be
62  *  seen as a return value during normal operation */
63 #define RM_SERVICE_ACTION_OKAY (RM_SERVICE_ACTION_BASE)
64 /** RM service was approved.  The resource data in the response is valid if
65  *  the service has been approved. */
66 #define RM_SERVICE_APPROVED (RM_SERVICE_ACTION_BASE+1)
67 /** Beginning of resource denied reasons */
68 #define RM_SERVICE_DENIED_BEGIN (RM_SERVICE_ACTION_BASE+2)
69 /** End of resource denied reasons */
70 #define RM_SERVICE_DENIED_END (RM_SERVICE_ACTION_BASE+2)
71 /** RM service is being processed.  Typically this means the service is
72  *  being sent to a higher level RM agent for processing */
73 #define RM_SERVICE_PROCESSING (RM_SERVICE_ACTION_BASE+3)
75 /** RM Service Request Error Code Base */
76 #define RM_SERVICE_ERROR_BASE (-64)
77 /** RM service request type not recognized */
78 #define RM_SERVICE_ERROR_INVALID_SERVICE_TYPE (RM_SERVICE_ERROR_BASE)
79 /** RM Service request was not provided a component callback
80  *  function.  Service requests may result in blocking operations.  A callback
81  *  function must always be provided with a service request since
82  *  blocked or non-blocked operations cannot be promised.  */
83 #define RM_SERVICE_ERROR_CALLBACK_NOT_PROVIDED (RM_SERVICE_ERROR_BASE-1)
84 /** RM service request needs to be forwarded to another RM agent but no transports
85  *  have been registered */
86 #define RM_SERVICE_ERROR_NO_TRANSPORT_REGISTERED (RM_SERVICE_ERROR_BASE-2)
87 /** RM service request needs to be forwarded but no client delegate or server has 
88  *  been registered with the RM instance */
89 #define RM_SERVICE_ERROR_NOT_REGISTERED_WITH_DEL_OR_SERVER (RM_SERVICE_ERROR_BASE-3)
90 /** RM service request needs to be forwarded but the transport packet alloc API
91  *  has not been provided */
92 #define RM_SERVICE_ERROR_TRANSPORT_PKT_ALLOC_API_NULL (RM_SERVICE_ERROR_BASE-4)
93 /** A failure occurred within a registered transport's packet alloc API */
94 #define RM_SERVICE_ERROR_TRANSPORT_ALLOC_PKT_ERROR (RM_SERVICE_ERROR_BASE-5)
95 /** RM service request needs to be forwarded but the buffer allocated by transport
96  *  is not large enough to fit the RM transport packet */
97 #define RM_SERVICE_ERROR_TRANSPORT_PKT_BUF_TOO_SMALL (RM_SERVICE_ERROR_BASE-6)
98 /** RM service request needs to be forwarded but the transport returned an error
99  *  when trying to send the RM packet to the higher level agent */
100 #define RM_SERVICE_ERROR_TRANPSPORT_SEND_ERROR (RM_SERVICE_ERROR_BASE-7)
101 /** RM service response from higher level agent did not match any requests made
102  *  by the provided RM instance */
103 #define RM_SERVICE_ERROR_TRANSACTION_DOES_NOT_EXST_FOR_THIS_RM_INSTANCE (RM_SERVICE_ERROR_BASE-8)
104 /** RM failed to allocate memory for new service transaction */
105 #define RM_SERVICE_ERROR_TRANSACTION_FAILED_TO_ALLOCATE (RM_SERVICE_ERROR_BASE-9)
106 /** RM found no service transactions queued when trying to delete a received service
107  *  transaction */
108 #define RM_SERVICE_ERROR_NO_TRANSACTIONS_IN_QUEUE (RM_SERVICE_ERROR_BASE-10)
109 /** RM could not find the service transaction in the RM instance's transaction queue */
110 #define RM_SERVICE_ERROR_SERVICE_TRANSACTION_DOES_NOT_EXIST (RM_SERVICE_ERROR_BASE-11)
111 /** RM received a response transaction and found a request transaction awaiting a response.
112  *  However, the request transaction was not in the "awaiting response" state */
113 #define RM_SERVICE_ERROR_INVALID_REQUEST_TRANSACTION_STATE_UPON_RESPONSE (RM_SERVICE_ERROR_BASE-12)
114 /** RM Client instance received a service transaction response that did not have a
115  *  matching service request that originated on the Client instance */
116 #define RM_SERVICE_ERROR_INVALID_TRANSACTION_RECEIVED_ON_CLIENT (RM_SERVICE_ERROR_BASE-13)
117 /** A failure occurred within a registered transport's packet free API */
118 #define RM_SERVICE_ERROR_TRANSPORT_FREE_PKT_ERROR (RM_SERVICE_ERROR_BASE-14)
119 /** Invalid NameServer object create on non-Server instance */
120 #define RM_SERVICE_ERROR_NAMESERVER_OBJECT_CREATE_ON_INVALID_INSTANCE (RM_SERVICE_ERROR_BASE-15)
121 /** Invalid NameServer object delete on non-Server instance */
122 #define RM_SERVICE_ERROR_NAMESERVER_OBJECT_DELETE_ON_INVALID_INSTANCE (RM_SERVICE_ERROR_BASE-16)
124 /**
125  * @brief Maximum number of characters in the resource names
126  */
127 #define RM_RESOURCE_NAME_MAX_CHARS (24) 
129 /** 
130  * @brief RM service types
131  */
132 typedef enum {
133     /** First service type.  Used by RM for bounds checking.  Should
134      *  not be used by component. */
135     Rm_service_FIRST = 0,
136     /** RM resource allocate service */
137     Rm_service_RESOURCE_ALLOCATE = 0,
138     /** RM resource block allocate service */
139     Rm_service_RESOURCE_BLOCK_ALLOCATE = 1,
140     /** RM resource allocate by name service */
141     Rm_service_RESOURCE_ALLOCATE_BY_NAME = 2,    
142     /** RM resource free service */
143     Rm_service_RESOURCE_FREE = 3,
144     /** RM resource block free service */
145     Rm_service_RESOURCE_BLOCK_FREE = 4,
146     /** RM resource free by name service */
147     Rm_service_RESOURCE_FREE_BY_NAME = 5,
148     /** RM resource mapping to name service */
149     Rm_service_RESOURCE_MAP_TO_NAME = 6,
150     /** RM resource name unmapping service */
151     Rm_service_RESOURCE_UNMAP_NAME = 7,
152     /** Last service type.  Used by RM for bounds checking.  Should
153      *  not be used by component. */
154     Rm_service_LAST = 7
155 } Rm_ServiceType;
157 /** 
158  * @brief RM pre-main allocation request information provided by the pre-main 
159  *        startup function requesting the resource */
160 typedef struct {
161     /** Pointer to the requested pre-main allocation resource name.  The 
162      *  name provided by the component must match the resource names
163      *  provided in the global resource table and allocation policies */
164     char *resourceName;
165     /** The pre-main allocation request resource base value.  For example, 
166      *  queue number or semaphore number */
167     uint32_t resourceBase;
168     /** Range of resource starting at resourceBase */
169     uint32_t resourceRange;
170 } Rm_PreMainAllocInfo;
172 /** 
173  * @brief RM service response information provided by RM back to the 
174  *        requesting component
175  */
176 typedef struct {
177     /** Result of the service request
178      *  Non-negative result: RM has taken an action based on the request
179      *  Negative result: RM has encountered an error handling the request */
180     int32_t serviceResult;
181     /** A request ID will be returned to the component if the requested service cannot
182      *  be completed immediately.  The request ID can be used by the component to identify
183      *  service responses received via the component callback function.  A request ID will not
184      *  be returned if the service request is satisfied immediately */
185     uint32_t requestId;
186     /** The base value of the returned resource.  In the case of a block resource allocation 
187      *  response this field will contain the base value of the block. */
188     int32_t resourceBase;
189     /** The range of resources starting from resourceBase allocated in block requests */
190     uint32_t resourceRange;
191 } Rm_ServiceRespInfo;
193 typedef struct {
194     /** Component callback function.  RM will call this function when the 
195      *  resource service request is completed. The callback function supplied
196      *  for this parameter must match this function pointer prototype. */
197     void (*serviceCallback) (Rm_ServiceRespInfo *serviceResponse);
198 } Rm_ServiceCallback;
200 /** 
201  * @brief RM service request information provided by the requesting component
202  */
203 typedef struct {
204     /** The type of RM service requested */
205     Rm_ServiceType type;
206     /** Pointer to the name of the resource requested.  The 
207      *  name provided by the component must match the resource node names
208      *  provided in the global resource table and allocation policies */
209     char *resourceName;
210 /** An allocate service can be requested with an unspecified resource base. 
211  *  If this occurs the RM Client Delegate or Server will assign the next available
212  *  resource or set of resources based on the allocation type. */
213 #define RM_RESOURCE_BASE_UNSPECIFIED (-1)  
214     /** The resource base value. */
215     int32_t resourceBase;
216     /** The range of the specified resource to be allocated starting from 
217      *  resourceBase.  Will be greater than one only for block allocate
218      *  and free service requests. */
219     uint32_t resourceRange;
220 /** An allocate service can be requested with an unspecified resource alignment.
221  *  WARNING: Only applicapable if resourceBase is unspecified
222  *
223  *  If the alignment is unspecified the RM Client Delegate or Server will allocate
224  *  the resources from a default alignment as specified in the global policy. */
225 #define RM_RESOURCE_ALIGNMENT_UNSPECIFIED (-1)      
226     /** Resource alignment in block allocation requests */
227     int32_t resourceAlignment;
228     /** The name server name associated with the resource.  Used only for 
229      *  allocate and free by name service requests */
230     char *resourceNsName;
231     /** Component specified callback function used by RM to inform components
232      *  of service requst results */
233     Rm_ServiceCallback callback;
234 } Rm_ServiceReqInfo;
236 /** 
237  * @brief RM Service Port provided to software components and applications that 
238  *        request RM services for the resources they wish to use
239  */
240 typedef struct {
241     /** RM instance handle for which the service handle was registered */
242     void *rmHandle;
243     /**
244      *  @b Description
245      *  @n  
246      *      Callout function used by components to request a resource service 
247      *      from a RM instance
248      *
249      *   @param[in] rmHandle
250      *      RM instance handle specifying the RM instance that should handle the
251      *      service request
252      *  
253      *  @param[in]  serviceRequest
254      *      Service request structure that provides details of the service requested from
255      *      the RM instance tied to this component
256      *
257      *  @param[in]  serviceResponse
258      *      Service response structure that provides details of RM's response to the
259      *      service request
260      */
261     void (*rmService)(void *rmHandle, Rm_ServiceReqInfo *serviceRequest,
262                       Rm_ServiceRespInfo *serviceResponse);
263 } Rm_ServicesPort;
265 /**
266  *  @b Description
267  *  @n  
268  *      Non-blocking function used by RTSC pre-main startup functions to
269  *      allocate RM resources for usage.  Pre-main allocated resources will be 
270  *      validated by RM against a memory-mapped startup resource policy.
271  *      Pre-main allocation of unauthorized resources will result in a system
272  *      exception.
273  *
274  *      Note: Resource pre-main allocations can only occur on a core that is 
275  *            running a RM Server or Client Delegate that has a startup policy
276  *            allowing the allocation of pre-main resources
277  *
278  *  @param[in]  preMainAllocInfo
279  *      Resource pre-main allocation structure that provides details of the 
280  *      resource requested from RM for preallocation
281  *
282  *  @param[out] serviceResponse
283  *      Contains the result information regarding the pre-main allocation request
284  *
285  *  @retval
286  *      Success - 0 - Resource pre-main allocation request okay.
287  *  @retval
288  *      Failure - non-zero - Resource pre-main allocation request error.
289  */
290 void Rm_preMainAllocService (Rm_PreMainAllocInfo *preMainAllocInfo,
291                              Rm_ServiceRespInfo *serviceResponse);
293 /**
294  *  @b Description
295  *  @n  
296  *      This function returns a RM service port to the application to 
297  *      provide to software components (LLDs, BIOS, etc) that want to use RM
298  *      for resource management.
299  *
300  *  @param[in]  rmHandle
301  *      RM instance handle.  Used to return a Rm_ServicesPort from an RM
302  *      instance.
303  *
304  *  @retval
305  *      Success - RM Service Port.  Used by an application or component to
306  *                request a service from RM.
307  *  @retval
308  *      Failure - NULL
309  */
310 Rm_ServicesPort *Rm_getServicePort(Rm_Handle rmHandle);
312 /** 
313 @} 
314 */
316 #ifdef __cplusplus
318 #endif
320 #endif /* RMSERVICES_H_ */