SA_LLD_OSAL

Modules

 SALLD System Endian Mode

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).

Define Documentation

#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.

Prototype: The following is the C prototype for the expected OSAL API.

        void Osal_saBeginMemAccess (void* addr, uint32_t sizeWords)
    

Parameters
Address of memory block.
Size of memory block.

Definition at line 212 of file sa_osal.h.

#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.

Prototype: The following is the C prototype for the expected OSAL API.

        void Osal_saBeginScAccess (void* addr, uint32_t sizeWords)
    

Parameters
Address of memory block.
Size of memory block.

Definition at line 256 of file sa_osal.h.

#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.

Prototype: The following is the C prototype for the expected OSAL API.

       void Osal_saCsEnter (uint32_t *key)
    

Parameter
Key may be used to lock the critical section.

Return Value
Not applicable.

Definition at line 111 of file sa_osal.h.

#define Sa_osalCsExit   Osal_saCsExit

The macro is used by the SA LLD to exit a critical section protected using the Osal_saCsEnter() API.

Prototype: The following is the C prototype for the expected OSAL API.

       void Osal_saCsExit (uint32_t key)
    

Parameter
Key may be used to lock the critical section.

Return Value
Not applicable.

Definition at line 130 of file sa_osal.h.

#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.

Prototype: The following is the C prototype for the expected OSAL API.

        void Osal_saEndMemAccess (void* addr, uint32_t sizeWords)
    

Parameters
Address of memory block.
Size of memory block.

Definition at line 233 of file sa_osal.h.

#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.

Prototype: The following is the C prototype for the expected OSAL API.

        void Osal_saEndScAccess (void* addr, uint32_t sizeWords)
    

Parameters
Address of memory block.
Size of memory block.

Definition at line 279 of file sa_osal.h.

#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.

 *      uint32_t Osal_saGetProcId () 
 *   

Return Value Processor ID zero based
Not applicable.

Definition at line 293 of file sa_osal.h.

#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.

 *      void* Osal_saGetSCPhyAddr(void* vaddr) 
 *   

Return Value Physical address of the Security Context buffer or system instance Parameters
Virtual Address of the Security Context buffer.

Definition at line 309 of file sa_osal.h.

#define Sa_osalGetSysEndianMode   Osal_saGetSysEndianMode

The macro is used by the SA LLD to query the endian mode of the system (SoC).

Prototype: The following is the C prototype for the expected OSAL API.

 *      int Osal_saGetSysEndianMode(void) 
 *   

Return Value Endian mode of the system (SoC) Parameters
Endian mode of the system (SoC).

Definition at line 344 of file sa_osal.h.

#define Sa_osalLog   Osal_saLog

The macro is used by the SA LLD to log various messages.

Prototype: The following is the C prototype for the expected OSAL API.

       void Osal_saLog( char* fmt, ... ) 
    

Parameter
printf-style format string

Return Value
Not applicable.

Definition at line 192 of file sa_osal.h.

#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.

Prototype: The following is the C prototype for the expected OSAL API.

       void Osal_saMtCsEnter (uint32_t *key)
    

Parameter
Key may be used to lock the multi-core critical section.

Return Value
Not applicable.

Note:
The multiple-core protection area is usually pretty small. To avoid the scenario that the interrupt occurs after the multi-core lock is achieved, the interrupt may be disabled in this function and re-enabled at the function Osal_saMtCsExit.

Definition at line 155 of file sa_osal.h.

#define Sa_osalMtCsExit   Osal_saMtCsExit

The macro is used by the SA LLD to exit a critical section protected using the Osal_saMtCsEnter() API.

Prototype: The following is the C prototype for the expected OSAL API.

       void Osal_saMtCsExit (uint32_t key)
    

Parameter
Key may be used to lock the multi-core critical section.

Return Value
Not applicable.

Definition at line 174 of file sa_osal.h.


Copyright 2014, Texas Instruments Incorporated