qmss_osal.h File Reference

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


Defines

#define Qmss_osalMalloc   Osal_qmssMalloc
 The macro is used by the QMSS LLD to allocate memory of specified size.
#define Qmss_osalFree   Osal_qmssFree
 The macro is used by the QMSS LLD to free a allocated block of memory.
#define Qmss_osalAccCsEnter   Osal_qmssAccCsEnter
 The macro is used by the QMSS LLD accumulator functions to provide critical sections to protect global and shared variables from access from multiple cores and access from multiple threads on single core.
#define Qmss_osalAccCsExit   Osal_qmssAccCsExit
 The macro is used by the QMSS LLD accumulator functions to exit a critical section protected using Osal_qmssAccCsEnter() API.
#define Qmss_osalCsEnter   Osal_qmssCsEnter
 The macro is used by the QMSS LLD to provide critical sections to protect global and shared variables from.
#define Qmss_osalCsExit   Osal_qmssCsExit
 The macro is used by the QMSS LLD to exit a critical section protected using Osal_qmssCsEnter() API.
#define Qmss_osalMtCsEnter   Osal_qmssMtCsEnter
 The macro is used by the QMSS LLD to provide critical sections to protect global and shared variables from.
#define Qmss_osalMtCsExit   Osal_qmssMtCsExit
 The macro is used by the QMSS LLD to exit a critical section protected using Osal_qmssMtCsEnter() API.
#define Qmss_osalLog   Osal_qmssLog
 The macro is used by the QMSS LLD to log various messages.
#define Qmss_osalBeginMemAccess   Osal_qmssBeginMemAccess
 The macro is used by the QMSS 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 Qmss_osalEndMemAccess   Osal_qmssEndMemAccess
 The macro is used by the QMSS 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.

Functions

void * Osal_qmssVirtToPhy (void *ptr)
 This function is used to convert virtual addresses to physical addresses for objects other than descriptors, such as linking RAM or descriptor region base addresses.
void * Osal_qmssPhyToVirt (void *ptr)
 This function is used to convert physical addresses to virtual addresses for objects other than descriptors, such as linking RAM or descriptor region base addresses.
void * Osal_qmssConvertDescVirtToPhy (uint32_t QID, void *descAddr)
 This function is used to convert virtual addresses to physical addresses for individual descriptors.
void * Osal_qmssConvertDescPhyToVirt (uint32_t QID, void *descAddr)
 This function is used to convert physical addresses to virtual addresses for individual descriptors.


Detailed Description

This is the sample OS Adaptation layer which is used by the QMSS 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.


Copyright 2014, Texas Instruments Incorporated