Added description of RM shared server/client to Doxygen intro
authorJustin Sobota <jsobota@ti.com>
Wed, 10 Apr 2013 18:37:05 +0000 (14:37 -0400)
committerJustin Sobota <jsobota@ti.com>
Wed, 10 Apr 2013 18:37:05 +0000 (14:37 -0400)
rm.h

diff --git a/rm.h b/rm.h
index d8a1972df17e59a0a4c8d2bfbb7d43fb9b07f116..b55332fdd576ed6c2c004865583d2f69138fe3cc 100644 (file)
--- a/rm.h
+++ b/rm.h
@@ -92,6 +92,24 @@ extern "C" {
  *   between RM instances.  This allows RM to easily extend to different device 
  *   configurations and different devices entirely.
  *
+ *   Shared memory versions of the Server and Client are available for configuration
+ *   in cases where the DSP applications cannot tolerate blocking operations or long wait
+ *   times for resources.  The Shared Server - Shared Client model assumes all memory
+ *   allocated via the OSAL layer is within shared memory.  RM service requests
+ *   received from Shared Servers and Shared Clients will be handled via accesses
+ *   to the resource management data structures existing in shared memory.
+ *   - Shared Server - Essentially a Server instance that expects to be allocated
+ *                     from shared memory via the application-supplied OSAL functions.
+ *                     Shared Client instances will piggyback on the Shared Server
+ *                     instance to allocate/free resources without the need to setup
+ *                     transports between the instances.  Access to the resource
+ *                     management data structures is managed through OSAL implemented
+ *                     cache writeback and invalidate operations.
+ *   - Shared Client - Must be provided a Shared Server handle at initialization time.
+ *                     The Shared Client will essentially use the resource management
+ *                     data structures, created in shared memory when the Shared Server
+ *                     was initialized, to handle any server requests.
  *   RM utilizes the BDS-licensed, open source, Flattened Device Tree format to 
  *   specify what resources are managed by RM as well as the RM instance permissions
  *   for managed resources.  The Global Resource List or GRL defines all device