# rm_osal.h File Reference

This is the sample OS Adaptation layer which is used by the RM low level driver. The OSAL layer can be ported in either of the following manners to a native OS: More...

`#include <string.h>`

## Defines

#define | Rm_osalMalloc Osal_rmMalloc
| The macro is used by the RM LLD to allocate memory of specified size.
#define | Rm_osalFree Osal_rmFree
| The macro is used by the RM LLD to free a allocated block of memory.
#define | Rm_osalCsEnter Osal_rmCsEnter
| The macro is used by the RM LLD to provide critical sections to protect global and shared variables from.
#define | Rm_osalCsExit Osal_rmCsExit
| The macro is used by the RM LLD to exit a critical section protected using Osal_rmCsEnter() API.
#define | Rm_osalMtCsEnter Osal_rmMtCsEnter
| The macro is used by the RM LLD to provide critical sections to protect global and shared variables from.
#define | Rm_osalMtCsExit Osal_rmMtCsExit
| The macro is used by the RM LLD to exit a critical section protected using Osal_rmMtCsEnter() API.
#define | Rm_osalLog Osal_rmLog
| The macro is used by the RM LLD to log various messages.
#define | Rm_osalBeginMemAccess Osal_rmBeginMemAccess
| The macro is used by the RM LLD to indicate that a block of memory is about to be accessed. If the memory block is cached then this indicates that the application would need to ensure that the cache is updated with the data from the actual memory.
#define | Rm_osalEndMemAccess Osal_rmEndMemAccess
| The macro is used by the RM LLD to indicate that the block of memory has finished being accessed. If the memory block is cached then the application would need to ensure that the contents of the cache are updated immediately to the actual memory.

## Detailed Description

This is the sample OS Adaptation layer which is used by the RM low level driver. The OSAL layer can be ported in either of the following manners to a native OS:

Approach 1:
Use Prebuilt Libraries

- Ensure that the provide an implementation of all Osal_XXX API for their native OS.
- Link the prebuilt libraries with their application.
- Refer to the "example" directory for an example of this
  Pros:
- Customers can reuse prebuilt TI provided libraries
  Cons:
- Level of indirection in the API to get to the actual OS call

Approach 2:
Rebuilt Library

- Create a copy of this file and modify it to directly inline the native OS calls
- Rebuild the RM low level drivver library; ensure that the Include path points to the directory where the copy of this file has been provided.
- Please refer to the "test" directory for an example of this
  Pros:
- Optimizations can be done to remove the level of indirection
  Cons:
- RM LLD Libraries need to be rebuilt by the customer.

  NOTE: (C) Copyright 2012 Texas Instruments, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright 2012, Texas Instruments Incorporated