1 /**
2 * @file rm.h
3 *
4 * @brief
5 * This is the Resource Manager include file.
6 *
7 * \par
8 * ============================================================================
9 * @n (C) Copyright 2012-2013, 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 #ifndef RM_H_
43 #define RM_H_
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
49 /* Standard includes */
50 #include <stdint.h>
52 /** @mainpage Resource Manager
53 *
54 * @section intro Introduction
55 *
56 * The Resource Manager (RM) is designed to provide an easy to use, extensible
57 * uinified resource management solution on TI devices. RM can be integrated by
58 * a system application to provide resource management services to the system
59 * temporally (pre-main/post-main) and spatially (system subcomponents, task,
60 * cores).
61 *
62 * The RM architecture is instance based. All RM resource management services
63 * must originate from a RM instance. Resource permissions are assigned by a
64 * system integrator using RM instance names provided during the initialization
65 * of each RM instance in use. There are three types of RM instances, all of
66 * which can be used by the system to request resource management services:
67 * - Server - Manages all resource data structures including the resource
68 * allocators, the permissions policies, and a simple NameServer.
69 * There can only be one Server per RM ecosystem. If two Servers
70 * are initialized within a system they must manage mutually
71 * exclusive sets of device resources. There is no limit to the
72 * number of Client and Client Delegate instances that can connect
73 * to the Server
74 * - Client - Used by system components to request resource services. There is
75 * no limit to the number of Clients a system can have. Client
76 * names must be unique since resource permissions are assigned based
77 * on RM instance names. Clients can connect to at most one Server
78 * or Client Delegate, but not both at the same time.
79 * - Client Delegate (CD) - At the moment the CD is not different from the
80 * Client. However, in the future the CD will be able
81 * to act as a proxy for the Server. The CD will be
82 * able to satisfy some service requests from Clients,
83 * offloading some processing from the Server. This
84 * feature will be helpful in situations where a
85 * slower data path exists between the Server and
86 * CD/Client instances. There is no limit to the number
87 * of Clients that can connect to a CD. The CD can
88 * connect to at most one Server.
89 *
90 * RM instances communicate via a generic transport interface. The RM transport
91 * interface expects the application to configure and manage the transport data paths
92 * between RM instances. This allows RM to easily extend to different device
93 * configurations and different devices entirely.
94 *
95 * RM utilizes the BDS-licensed, open source, Flattened Device Tree format to
96 * specify what resources are managed by RM as well as the RM instance permissions
97 * for managed resources. The Global Resource List or GRL defines all device
98 * resources and their ranges that will be tracked by the RM Server. Addition or
99 * subtraction of resources from RM requires one modify only the GRL. RM source code
100 * changes are not required to add or subtract resources from RM's umbrella of
101 * management. RM Policies specify resource permissions for the RM instances. There
102 * are two types of Policies:
103 * - Global Policy - Provided to the Server at initialization and defines the
104 * resource permissions for all RM instances in the system.
105 * All service requests will be validated against the Global
106 * Policy on the Server. If the RM instance is found to not
107 * hold the privileges for the request a denial of the service
108 * will be issued back to the requesting instance.
109 * - Static Policy - Optionally provided to Client and CD instances at
110 * initialization. Allows these instances to statically
111 * allocate resources. This feature is typically used
112 * for RM instances that must allocate resources prior
113 * to the transport connection to the Server being established.
114 * Resources allocated via any Static Policies will
115 * be validated against the Global Policy once the transport
116 * to the Server has been fully established. If a Static
117 * Policy request fails validation with the Global Policy the
118 * RM instance that issued the static request will be placed
119 * into a locked state. The locked state prevents any further
120 * service requests from the instance.
121 *
122 * Combined, the GRL and Policy Device Tree implementations allow RM to easily extend
123 * to new resources without the need to recompile the RM source code.
124 *
125 * RM instances currently provides the following resource services:
126 * - Allocate (initialize) - Allocate a resource for initialization
127 * - Allocate (usage) - Allocate a resource for use
128 * - Free - Free an allocated resource (The free must originate
129 * from the RM instance that allocated the resource
130 * - Map resource to name - Map a specified resource to a NameServer name
131 * - Unmap named resource - Unmap a resource from an existing NameServer name
132 * - Get resource by name - Returns a resource based on a provided NameServer name
133 */
135 /* Define RM_API as a master group in Doxygen format and add all RM API
136 definitions to this group. */
137 /** @defgroup RM_API Resource Manager API
138 * @{
139 */
140 /** @} */
142 /**
143 @defgroup RM_TRANSPORT_API RM Transport API
144 @ingroup RM_API
145 */
146 /**
147 @defgroup RM_SERVICES_API RM Services API
148 @ingroup RM_API
149 */
150 /**
151 @defgroup RM_OSAL_API RM OS Abstraction Layer API
152 @ingroup RM_API
153 */
155 /**
156 @addtogroup RM_API
157 @{
158 */
160 /* RM return and error codes */
161 /** RM successful return code */
162 #define RM_OK 0
163 /** RM processing requested service */
164 #define RM_SERVICE_PROCESSING 1
165 /** RM has approved requested service */
166 #define RM_SERVICE_APPROVED 2
167 /** RM has approved requested service based on static policy. Request will be validated
168 * against global policy once all transports have been registered */
169 #define RM_SERVICE_APPROVED_STATIC 3
171 /** RM service request denial reasons base */
172 #define RM_SERVICE_DENIED_BASE 64
173 /** Request resource not found in policy or allocators */
174 #define RM_SERVICE_DENIED_RES_DOES_NOT_EXIST RM_SERVICE_DENIED_BASE+1
175 /** Request resource range within not found within resource's allocator */
176 #define RM_SERVICE_DENIED_RES_RANGE_DOES_NOT_EXIST RM_SERVICE_DENIED_BASE+2
177 /** Free request resource range not allocated to service's source inst */
178 #define RM_SERVICE_DENIED_RES_NOT_ALLOCD_TO_INST RM_SERVICE_DENIED_BASE+3
179 /** Free request resource range already free */
180 #define RM_SERVICE_DENIED_RES_ALREADY_FREE RM_SERVICE_DENIED_BASE+4
181 /** Allocate request resource range partially allocated (Handling of partial allocations
182 * not yet implemented) */
183 #define RM_SERVICE_DENIED_PARTIAL_ALLOCATION RM_SERVICE_DENIED_BASE+5
184 /** Free request resource range partially free (Handling of partial frees not yet implemented) */
185 #define RM_SERVICE_DENIED_PARTIAL_FREE RM_SERVICE_DENIED_BASE+6
186 /** Requirements of allocate request could not be satisfied (occurs for UNSPECIFIED base
187 * and/or alignment requests */
188 #define RM_SERVICE_DENIED_RES_ALLOC_REQS_NOT_MET RM_SERVICE_DENIED_BASE+7
189 /** NameServer add request name string already exists in NameServer */
190 #define RM_SERVICE_DENIED_NAME_EXISTS_IN_NS RM_SERVICE_DENIED_BASE+8
191 /** Service request instance not in policy "valid-instances" list */
192 #define RM_SERVICE_DENIED_INST_NAME_NOT_VALID RM_SERVICE_DENIED_BASE+9
193 /** Init allocate request resource range not given init privileges in policy */
194 #define RM_SERVICE_DENIED_INIT_PERM_NOT_GIVEN RM_SERVICE_DENIED_BASE+10
195 /** Use allocate request resource range not given use privileges in policy */
196 #define RM_SERVICE_DENIED_USE_PERM_NOT_GIVEN RM_SERVICE_DENIED_BASE+11
197 /** Allocate request resource range marked as exclusive in policy has already been allocated */
198 #define RM_SERVICE_DENIED_EXCLUSIVE_RES_ALLOCD RM_SERVICE_DENIED_BASE+12
199 /** Allocate request resource range allocated to an instance assigned exclusive privileges in policy */
200 #define RM_SERVICE_DENIED_ALLOCD_TO_EXCLUSIVE_INST RM_SERVICE_DENIED_BASE+13
201 /** Static allocate request was not an allocate-use or allocate-init request */
202 #define RM_SERVICE_DENIED_INVALID_STATIC_REQUEST RM_SERVICE_DENIED_BASE+14
203 /** Static allocate request denied by static policy */
204 #define RM_SERVICE_DENIED_BY_STATIC_POLICY RM_SERVICE_DENIED_BASE+15
205 /** RM instance locked from further services since a static allocation failed validation against
206 * global policy. RM instance cannot be unlocked. Please make sure static policy and global policy
207 * are in sync */
208 #define RM_SERVICE_DENIED_RM_INSTANCE_LOCKED RM_SERVICE_DENIED_BASE+16
209 /** Allocate request denied because the resource is already reserved by Linux and "Shared Linux"
210 * privileges are not assigned to the requesting instance */
211 #define RM_SERVICE_DENIED_RES_NOT_SHARED_LINUX RM_SERVICE_DENIED_BASE+17
213 /** Start of libfdt.h error codes */
214 #define RM_ERROR_LIBFDT_START (-1)
215 /** End of libfdt.h error codes */
216 #define RM_ERROR_LIBFDT_END (-13)
218 /** RM error base */
219 #define RM_ERROR_BASE (-64)
220 /** Instance name provided is NULL or greater than RM_NAME_MAX_CHARS */
221 #define RM_ERROR_INVALID_INST_NAME RM_ERROR_BASE-1
222 /** List of "valid-instances" not found in global or static policy */
223 #define RM_ERROR_NO_VALID_INST_IN_POLICY RM_ERROR_BASE-2
224 /** Instance specified in permissions string does not match any instances specified in the
225 * "valid-instances" list */
226 #define RM_ERROR_PERM_STR_INST_NOT_VALID RM_ERROR_BASE-3
227 /** Resource specified in global policy does not have an allocator */
228 #define RM_ERROR_UNKNOWN_RESOURCE_IN_POLICY RM_ERROR_BASE-4
229 /** Permissions string has more than instance group specified.
230 * Ex: assignments = <12 1>, "iux = (RM_Client_Delegate) iu = (RM_Client)"; */
231 #define RM_ERROR_PERM_STR_TOO_MANY_INST_GROUPS RM_ERROR_BASE-5
232 /** Permissions string has more than assignment.
233 * Ex: assignments = <12 1>, "iux = (RM_Client_Delegate) = i"; */
234 #define RM_ERROR_PERM_STR_TOO_MANY_ASSIGN_CHARS RM_ERROR_BASE-6
235 /** Permissions string contains invalid character */
236 #define RM_ERROR_PERM_STR_INVALID_CHAR RM_ERROR_BASE-7
237 /** Permissions string contains a permission character without the assignment operator
238 * Ex: assignments = <12 1>, "iux (RM_Client_Delegate)"; */
239 #define RM_ERROR_PERM_CHAR_WITHOUT_ASSIGN_CHAR RM_ERROR_BASE-8
240 /** Permissions string contains a permission character on opposite side of already made assignment
241 * Ex: assignments = <12 1>, "iux = (RM_Client_Delegate) x"; */
242 #define RM_ERROR_INVALID_PERMS_CHAR_ON_RIGHT RM_ERROR_BASE-9
243 /** Policy resource node contains an unknown property */
244 #define RM_ERROR_UNKNOWN_POLICY_RESOURCE_PROPERTY RM_ERROR_BASE-10
245 /** Instance name provided in "valid-instances" list is greater than RM_NAME_MAX_CHARS */
246 #define RM_ERROR_VALID_INST_NAME_TOO_LONG RM_ERROR_BASE-11
247 /** Instance name in permissions assignment is greater than RM_NAME_MAX_CHARS */
248 #define RM_ERROR_INST_NAME_IN_ASSIGNMENT_TOO_LONG RM_ERROR_BASE-12
249 /** NameServer name in global resource list nameServer assignment is greater than RM_NAME_MAX_CHARS */
250 #define RM_ERROR_GRL_NS_ASSIGNMENT_NAME_TOO_LONG RM_ERROR_BASE-13
251 /** Linux alias assignment in global resource list is invalid */
252 #define RM_ERROR_GRL_INVALID_LINUX_ALIAS_FORMAT RM_ERROR_BASE-14
253 /** Error allocating memory for the service handle */
254 #define RM_ERROR_SERVICE_HANDLE_MEM_ALLOC_FAILED RM_ERROR_BASE-15
255 /** The RM instance service handle has already been closed */
256 #define RM_ERROR_SERVICE_HANDLE_ALREADY_CLOSED RM_ERROR_BASE-16
257 /** Global Resource List (GRL) resource node contains an unknown property */
258 #define RM_ERROR_GRL_UNKNOWN_RESOURCE_PROPERTY RM_ERROR_BASE-17
259 /** Could not find an allocator for the specified resource */
260 #define RM_ERROR_RES_ALLOCATOR_DOES_NOT_EXIST RM_ERROR_BASE-18
261 /** A resource node is specified more than once in the Global Resource List (GRL) */
262 #define RM_ERROR_GRL_RES_SPECIFIED_MORE_THAN_ONCE RM_ERROR_BASE-19
263 /** No data was found at the GRL resource node's specified Linux alias path */
264 #define RM_ERROR_DATA_NOT_FOUND_AT_LINUX_ALIAS RM_ERROR_BASE-20
265 /** RM server was not provided a Global Resource List (GRL) and global policy at initialization */
266 #define RM_ERROR_INVALID_SERVER_CONFIGURATION RM_ERROR_BASE-21
267 /** Service request type not recognized */
268 #define RM_ERROR_INVALID_SERVICE_TYPE RM_ERROR_BASE-22
269 /** rmAllocPkt transport callout returned NULL for rmPkt */
270 #define RM_ERROR_TRANSPORT_ALLOC_PKT_ERROR RM_ERROR_BASE-23
271 /** rmSendPkt transport callout returned error when attempting to send the rmPkt */
272 #define RM_ERROR_TRANSPORT_SEND_ERROR RM_ERROR_BASE-24
273 /** A RM service transaction could not be created for the service request */
274 #define RM_ERROR_SERVICE_TRANS_NOT_CREATED RM_ERROR_BASE-25
275 /** RM service transaction could not be found in instance's transaction queue */
276 #define RM_ERROR_SERVICE_TRANS_DOES_NOT_EXIST RM_ERROR_BASE-26
277 /** NameServer does not exist in instance, cannot satisfy NameServer service request */
278 #define RM_ERROR_NAMESERVER_DOES_NOT_EXIST RM_ERROR_BASE-27
279 /** Service request to add a name to the NameServer failed */
280 #define RM_ERROR_NAMESERVER_NAME_ADD_FAILED RM_ERROR_BASE-28
281 /** Could not find name specified in service request in NameServer */
282 #define RM_ERROR_NAMESERVER_NAME_DOES_NOT_EXIST RM_ERROR_BASE-29
283 /** Service request made on Client or CD when no transport established and no static policy registered */
284 #define RM_ERROR_REQ_FAILED_NO_STATIC_POLICY RM_ERROR_BASE-30
285 /** RM transport handle has not been registered with the RM instance */
286 #define RM_ERROR_TRANSPORT_HANDLE_DOES_NOT_EXIST RM_ERROR_BASE-31
287 /** RM received a packet with an unknown RM packet type */
288 #define RM_ERROR_RECEIVED_INVALID_PACKET_TYPE RM_ERROR_BASE-32
289 /** RM response packet does not match any requests sent from instance */
290 #define RM_ERROR_PKT_RESP_DOES_NOT_MATCH_ANY_REQ RM_ERROR_BASE-33
291 /** Server attempted to connect to another server or a CD attempted to connect to another CD or
292 * Client attempted to connect to another client */
293 #define RM_ERROR_INVALID_REMOTE_INST_TYPE RM_ERROR_BASE-34
294 /** RM client attempted to register with more than one Server or CD or a CD attempted to register
295 * with more than one Server */
296 #define RM_ERROR_ALREADY_REGD_SERVER_OR_CD RM_ERROR_BASE-35
297 /** Service has both a NameServer name and a base, length, or alignment specified */
298 #define RM_ERROR_NS_NAME_AND_RES_VAL_CONFLICT RM_ERROR_BASE-36
299 /** Instance type not recognized */
300 #define RM_ERROR_INVALID_INST_TYPE RM_ERROR_BASE-37
301 /** RM attempted to allocate a transport packet but the rmAllocPkt callout was not registered */
302 #define RM_ERROR_TRANSPORT_ALLOC_PKT_NOT_REGD RM_ERROR_BASE-38
303 /** RM attempted to send a packet but the rmSendPkt callout was not registered */
304 #define RM_ERROR_TRANSPORT_SEND_NOT_REGD RM_ERROR_BASE-39
305 /** RM attempted to send a response packet but the transport to the remote instance that sent
306 * the request packet is not registered */
307 #define RM_ERROR_TRANSPORT_REMOTE_HNDL_NOT_REGD RM_ERROR_BASE-40
308 /** RM instance cannot be deleted with transports still registered */
309 #define RM_ERROR_CANT_DELETE_WITH_REGD_TRANSPORT RM_ERROR_BASE-41
310 /** RM instance cannot be deleted with open service handle */
311 #define RM_ERROR_CANT_DELETE_WITH_OPEN_SERV_HNDL RM_ERROR_BASE-42
312 /** RM instance cannot be deleted when there are transactions pending and the
313 * ignorePendingServices parameter is set to false */
314 #define RM_ERROR_CANT_DELETE_PENDING_TRANSACTIONS RM_ERROR_BASE-43
315 /** Only the Server instance can be used to return resource status via the
316 * Rm_resourceStatus API */
317 #define RM_ERROR_INVALID_RES_STATUS_INSTANCE RM_ERROR_BASE-44
318 /** RM Shared Server and Client instances should always return a finished request since
319 * the instance has access to the resource structures no matter what core the service
320 * is requested from */
321 #define RM_ERROR_SHARED_INSTANCE_UNFINISHED_REQ RM_ERROR_BASE-45
322 /** RM Shared Server and Client instances cannot register transports */
323 #define RM_ERROR_SHARED_INSTANCE_CANNOT_REG_TRANS RM_ERROR_BASE-46
324 /** RM Shared Client handle was provided an invalid Shared Server handle. The shared
325 * server handle was either NULL or was not an instance of type Rm_instType_SHARED_SERVER */
326 #define RM_ERROR_INVALID_SHARED_SERVER_HANDLE RM_ERROR_BASE-47
328 /**
329 * @brief Maximum number of characters allowed for RM instance, resource, and
330 * NameServer names.
331 */
332 #define RM_NAME_MAX_CHARS (32)
334 /**
335 * @brief RM instance handle. The RM handle is used to register transports
336 * between RM instances and request resource services from the RM
337 * instance.
338 */
339 typedef void *Rm_Handle;
341 /**
342 * @brief RM instance types
343 */
344 typedef enum {
345 /** RM Server */
346 Rm_instType_SERVER = 0,
347 /** RM Client Delegate */
348 Rm_instType_CLIENT_DELEGATE,
349 /** RM Client */
350 Rm_instType_CLIENT,
351 /** RM Shared Server - Server instance stored in shared memory that allows
352 * multiple DSP cores to request services without the need to configure
353 * and register transports. Allows requests to be fulfilled from any DSP
354 * core without blocking */
355 Rm_instType_SHARED_SERVER,
356 /** RM Shared Client - Piggybacks on the Shared Server instance to handle
357 * service requests from resource and policy data structures in shared
358 * memory */
359 Rm_instType_SHARED_CLIENT,
360 /** DO NOT USE: Last type */
361 Rm_instType_LAST
362 } Rm_InstType;
364 /**
365 * @brief RM server (includes shared server) initialization configurations
366 */
367 typedef struct {
368 /** Pointer to the device global resource list (GRL). The GRL contains
369 * all resources on the device that will be managed by RM. The GRL
370 * must be in DTB format. */
371 void *globalResourceList;
372 /** Pointer to the Linux DTB if the RM server is running on ARM Linux.
373 * The Linux DTB will be parsed for all managed resources reserved for use
374 * by Linux. Parsing will be based on "linux-dtb-alias" resource
375 * properties found in the GRL. The Linux DTB must be in DTB format. */
376 void *linuxDtb;
377 /** Pointer to the global policy defining the allocation policies for
378 * RM instances within the system. The global policy must be in DTB
379 * format. */
380 void *globalPolicy;
381 } Rm_ServerCfg;
383 /**
384 * @brief RM client delegate (CD) initialization configurations
385 */
386 typedef struct {
387 /** Pointer to a client delegate policy used by the CD to allocate resources
388 * without contacting the server. The cdPolicy will be used by the CD to
389 * determine whether clients connected to the CD can be allocated resources
390 * provided to the CD by the server.
391 *
392 * The cdPolicy will also act as a static policy until the transport to the
393 * server has been established. Static allocations can occur before the
394 * instance has been attached to a server instance within the RM system.
395 * This is useful for allocating resources prior to main(). Resources allocated
396 * via the static policy will be verified against the global policy once the
397 * CD connects with the server. The static policy must be in DTB format.
398 *
399 * To guarantee proper resource permission synchronization between the CD
400 * and server the cdPolicy must either be an exact copy of the globalPolicy
401 * or a exact replica of a subset of the globalPolicy provided to the server
402 * at initialization. */
403 void *cdPolicy;
404 } Rm_ClientDelegateCfg;
406 /**
407 * @brief RM client initialization configurations
408 */
409 typedef struct {
410 /** Pointer to a static policy used by the client to allocate resources statically.
411 * Static allocations can occur before the instance has been attached to a server
412 * or CD instance within the RM system. This is useful for allocating resources
413 * prior to main(). Resources allocated via the static policy will be verified
414 * against the global policy once the client connects with the server (directly or
415 * indirectly through a CD). The static policy must be in DTB format. */
416 void *staticPolicy;
417 } Rm_ClientCfg;
419 /**
420 * @brief RM shared client initialization configurations
421 */
422 typedef struct {
423 /** RM Shared Server handle. Typically, the Shared Server handle is created on
424 * DSP core designated for system initialization. The application then
425 * the Shared Server handle, located in shared memory, to the other DSP cores.
426 * These DSP cores can then piggyback onto the shared memory data structures in
427 * the Shared Server via the Shared Client */
428 Rm_Handle sharedServerHandle;
429 } Rm_SharedClientCfg;
431 /**
432 * @brief RM instance initialization structure
433 */
434 typedef struct {
435 /** Pointer to a character array containing the instance name. The name of the
436 * RM instance can be no greater than #RM_NAME_MAX_CHARS. The instance name
437 * must match an instance name defined in the "valid-instances" lists contained
438 * in the global and static policy DTS files. Resources and privileges to the
439 * resources will be based on the name assigned to the RM instance*/
440 const char *instName;
441 /** The type of RM instance that will be created. */
442 Rm_InstType instType;
443 /** Instance-type specific configurations */
444 union {
445 /** #Rm_ServerCfg */
446 Rm_ServerCfg serverCfg;
447 /** #Rm_ClientDelegateCfg */
448 Rm_ClientDelegateCfg cdCfg;
449 /** #Rm_ClientCfg */
450 Rm_ClientCfg clientCfg;
451 /** #Rm_SharedClientCfg */
452 Rm_SharedClientCfg sharedClientCfg;
453 } instCfg;
454 } Rm_InitCfg;
456 /**
457 * @b Description
458 * @n
459 * This function prints and returns the status for all resources managed by
460 * the RM instance network. The allocate/free status as well as ownership
461 * status will be printed for every resource. Also, the NameServer name
462 * entries will be displayed.
463 *
464 * This function only prints resources when provided the server handle
465 * since the server stores all the resource and NameServer
466 * data structures.
467 *
468 * @param[in] rmServerHandle
469 * Server instance handle.
470 *
471 * @param]in] printResources
472 * Non-zero - Resource ownership details will be printed for all
473 * tracked resources
474 * 0 - Resource ownership details will not be printed. Only
475 * the number of allocated resource ranges will be
476 * returned.
477 *
478 * @retval
479 * Success - Total number of allocated resource nodes owners. Effectively
480 * returns the number of resource ranges still allocated.
481 * @retval
482 * Failure - #RM_ERROR_INVALID_RES_STATUS_INSTANCE
483 */
484 int32_t Rm_resourceStatus(Rm_Handle rmServerHandle, int printResources);
486 /**
487 * @b Description
488 * @n
489 * This function prints the current status of a RM instance. The
490 * following instance properties will be printed:
491 * a) instance name & type
492 * b) The instance's registered transports
493 * c) All service transactions queued in the instance transaction
494 * queue and their states
495 *
496 * @param[in] rmHandle
497 * Instance handle.
498 */
499 void Rm_instanceStatus(Rm_Handle rmHandle);
501 /**
502 * @b Description
503 * @n
504 * This function initializes a RM instance. There are no restrictions
505 * on the amount of times this function can be called. Each call will
506 * result in a new RM instance. However, a network of RM instances
507 * can have only one RM Server. If an application has multiple RM
508 * Servers the resources managed by each server must be mutually
509 * exclusive. Additionally if an application has multiple RM shared
510 * servers the resources they manage must be mutually exclusive as well
511 *
512 * If any errors are encountered during the initialization process
513 * the Rm_Handle returned will be NULL.
514 *
515 * @param[in] initCfg
516 * Pointer to the instance initialization structure.
517 *
518 * @param[out] result
519 * Pointer to a signed int used to return any errors encountered during
520 * the instance initialization process.
521 *
522 * @retval
523 * Success - Rm_Handle for instance and result = #RM_OK
524 * @retval
525 * Failure - NULL Rm_Handle and result < #RM_OK
526 */
527 Rm_Handle Rm_init(const Rm_InitCfg *initCfg, int32_t *result);
529 /**
530 * @b Description
531 * @n
532 * This function deletes the specified RM instance. All memory
533 * associated with the instance will be freed.
534 *
535 * @param[in] rmHandle
536 * Instance handle.
537 *
538 * @param[in] ignorePendingServices
539 * Non-zero - The instance will be deleted despite any services pending <br>
540 * 0 - The instance will not be deleted due to at least one service
541 * pending.
542 *
543 * @retval
544 * Success - #RM_OK
545 * @retval
546 * Failure - #RM_ERROR_CANT_DELETE_WITH_OPEN_SERV_HNDL
547 * @retval
548 * Failure - #RM_ERROR_CANT_DELETE_WITH_REGD_TRANSPORT
549 * @retval
550 * Failure - #RM_ERROR_CANT_DELETE_PENDING_TRANSACTIONS
551 */
552 int32_t Rm_delete(Rm_Handle rmHandle, int ignorePendingServices);
554 /**
555 * @b Description
556 * @n
557 * The function is used to get the version information of RM.
558 *
559 * @retval
560 * Version Information.
561 */
562 uint32_t Rm_getVersion(void);
564 /**
565 * @b Description
566 * @n
567 * The function is used to get the version string for RM.
568 *
569 * @retval
570 * Version String.
571 */
572 const char* Rm_getVersionStr(void);
574 /**
575 @}
576 */
578 #ifdef __cplusplus
579 }
580 #endif
582 #endif /* RM_H_ */