sa_osal.h File Reference

This is the sample OS Adaptation layer which is used by the SA low level driver. More...

Go to the source code of this file.

Defines

#define Sa_osalCsEnter   Osal_saCsEnter
 The macro is used by the SA LLD to provide critical section to protect its shared resources access from multiple threads on a single core. If all the SA LLD APIs are being called from threads then this API could use semaphores. However, if the SA LLD API's are being called from both ISR & Thread context then the critical section here would need to disable/enable interrupts.
#define Sa_osalCsExit   Osal_saCsExit
 The macro is used by the SA LLD to exit a critical section protected using the Osal_saCsEnter() API.
#define Sa_osalMtCsEnter   Osal_saMtCsEnter
 The macro is used by the SA LLD to provide critical section to protect its global and shared resources access from multiple cores. If the SALLD operates in single-core environment then these macros can be defined to be NOP.
#define Sa_osalMtCsExit   Osal_saMtCsExit
 The macro is used by the SA LLD to exit a critical section protected using the Osal_saMtCsEnter() API.
#define Sa_osalLog   Osal_saLog
 The macro is used by the SA LLD to log various messages.
#define Sa_osalBeginMemAccess   Osal_saBeginMemAccess
 The macro is used by the SA 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 Sa_osalEndMemAccess   Osal_saEndMemAccess
 The macro is used by the SA LLD to indicate that the block of memory has finished being updated. 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.
#define Sa_osalBeginScAccess   Osal_saBeginScAccess
 The macro is used by the SA LLD to indicate that the security context byuffer is about to be accessed. If the security context buffer is cacheable then this indicates that the application would need to ensure that the cache is updated with the data from the actual memory since the security context will be updated by SASS Cache engine. If the security context buffers are non-cacheable then these macros can be defined to be NOP.
#define Sa_osalEndScAccess   Osal_saEndScAccess
 The macro is used by the SA LLD to indicate that the security context buffer has finished being updated. If the memory block is cacheable then the application would need to ensure that the contents of the cache are updated immediately to the actual memory. If the security context buffers are non-cacheable then these macros can be defined to be NOP.
#define Sa_osalGetProcId   Osal_saGetProcId
 The macro is used by the SA LLD to get the processor ID(zero based) Prototype: The following is the C prototype for the expected OSAL API.
#define Sa_osalGetSCPhyAddr   Osal_saGetSCPhyAddr
 The macro is used by the SA LLD to get the physical address of the security context buffer or its system instance. Prototype: The following is the C prototype for the expected OSAL API.
#define Sa_osalGetSysEndianMode   Osal_saGetSysEndianMode
 The macro is used by the SA LLD to query the endian mode of the system (SoC).

Enumerations

SALLD System Endian Mode

Definition of System Endian Modes

enum  Sa_sysEndianMode_e { sa_SYS_ENDIAN_MODE_LITTLE = 0, sa_SYS_ENDIAN_MODE_BIG }

Detailed Description

This is the sample OS Adaptation layer which is used by the SA low level driver.

The OSAL layer can be ported in either of the following manners to a native OS:

Approach 1:
Use Prebuilt Libraries

Approach 2:
Rebuilt Library

NOTE: (C) Copyright 2009-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.

Definition in file sa_osal.h.


Copyright 2014, Texas Instruments Incorporated