packages/ti/drv/uart/src/UART_osal.h

   1 /**
   2  *   @file  UART_osal.h
   3  *
   4  *   @brief
   5  *      This is the sample OS Adaptation layer which is used by the UART
   6  *      driver. The OSAL layer can be ported in either of the following
   7  *      manners to a native OS:
   8  *
   9  *      <b> Approach 1: </b>
  10  *      @n  Use Prebuilt Libraries
  11  *           - Ensure that the provide an implementation of all
  12  *             Osal_XXX API for their native OS.
  13  *           - Link the prebuilt libraries with their application.
  14  *           - Refer to the "example" directory for an example of this
  15  *       @n <b> Pros: </b>
  16  *           - Customers can reuse prebuilt TI provided libraries
  17  *       @n <b> Cons: </b>
  18  *           - Level of indirection in the API to get to the actual OS call
  19  *
  20  *      <b> Approach 2: </b>
  21  *      @n  Rebuilt Library
  22  *           - Create a copy of this file and modify it to directly
  23  *             inline the native OS calls
  24  *           - Rebuild the UART Driver library; ensure that the Include
  25  *             path points to the directory where the copy of this file
  26  *             has been provided.
  27  *           - Please refer to the "test" directory for an example of this
  28  *       @n <b> Pros: </b>
  29  *           - Optimizations can be done to remove the level of indirection
  30  *       @n <b> Cons: </b>
  31  *           - UART Libraries need to be rebuilt by the customer.
  32  *
  33  *  \par
  34  *  NOTE:
  35  *      (C) Copyright 2014-2020 Texas Instruments, Inc.
  36  *
  37  *  Redistribution and use in source and binary forms, with or without
  38  *  modification, are permitted provided that the following conditions
  39  *  are met:
  40  *
  41  *    Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  *
  44  *    Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in the
  46  *    documentation and/or other materials provided with the
  47  *    distribution.
  48  *
  49  *    Neither the name of Texas Instruments Incorporated nor the names of
  50  *    its contributors may be used to endorse or promote products derived
  51  *    from this software without specific prior written permission.
  52  *
  53  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  54  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  55  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  56  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  57  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  58  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  59  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  60  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  61  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  62  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  63  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  64  *
  65  *  \par
  66 */
  67 #ifndef UART_OSAL_H
  68 #define UART_OSAL_H
  69
  70 #include <ti/osal/osal.h>
  71
  72 #ifdef __cplusplus
  73 extern "C" {
  74 #endif
  75
  76 #define UART_osalCreateBlockingLock(x,y)        (SemaphoreP_create((x),(y)))
  77
  78
  79 #define UART_osalDeleteBlockingLock(X)       (SemaphoreP_delete(X))
  80
  81
  82 #define UART_osalSemParamsInit(x)  (SemaphoreP_Params_init(x))
  83
  84
  85 #define UART_osalPendLock(X,Y)         (SemaphoreP_pend((X),(Y)))
  86
  87
  88 #define UART_osalPostLock(X)     (SemaphoreP_post(X))
  89
  90 #define UART_osalHardwareIntDisable() (HwiP_disable())
  91
  92
  93 #define UART_osalHardwareIntRestore(X) (HwiP_restore(X))
  94
  95
  96 #define UART_osalHardwareIntDestruct(X,Y)     (Osal_DeleteInterrupt((X),(Y)))
  97
  98 #define UART_osalRegisterInterrupt(X,Y)     (Osal_RegisterInterrupt((X),(Y)))
  99
 100 #define UART_osalHwiParamsInit(X)            (HwiP_Params_init(X))
 101
 102
 103 #define UART_osalHardwareIntrDisable(X,Y)    (Osal_DisableInterrupt((X),(Y)))
 104
 105 #define UART_osalHardwareIntrEnable(X,Y)     (Osal_EnableInterrupt((X),(Y)))
 106
 107 #define UART_osalHardwareIntrClear(X,Y)      (Osal_ClearInterrupt((X),(Y)))
 108
 109
 110 #define UART_osalMuxIntcSetup(X, Y)         (MuxIntcP_create((X), (Y)))
 111
 112
 113 #define UART_osalMuxIntcEnableSysInt(X, Y)  (MuxIntcP_enableInEvent((X), (Y)))
 114
 115
 116 #define UART_osalMuxIntcDisableSysInt(X, Y) (MuxIntcP_disableInEvent((X), (Y)))
 117
 118
 119 #define UART_osalMuxIntcClearSysInt(X, Y)   (MuxIntcP_clearInEvent((X), (Y)))
 120
 121 #define UART_osalGetThreadType()            (Osal_getThreadType())
 122
 123 #define UART_osalDelay(X)                   (Osal_delay(X))
 124
 125 #define UART_osalAssert(expr)               (OSAL_Assert(!(expr)))
 126
 127 #ifdef __cplusplus
 128 }
 129 #endif
 130
 131 #endif /* __UART_OSAL_H__ */
 132
 133