git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/MicroBlaze_Kintex7_EthernetLite/BSP/microblaze_0/libsrc/uartlite_v3_2/src/xuartlite_i.h

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2002 - 2015 Xilinx, Inc.  All rights reserved.
   4 *
   5 * Permission is hereby granted, free of charge, to any person obtaining a copy
   6 * of this software and associated documentation files (the "Software"), to deal
   7 * in the Software without restriction, including without limitation the rights
   8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 * copies of the Software, and to permit persons to whom the Software is
  10 * furnished to do so, subject to the following conditions:
  11 *
  12 * The above copyright notice and this permission notice shall be included in
  13 * all copies or substantial portions of the Software.
  14 *
  15 * Use of the Software is limited solely to applications:
  16 * (a) running on a Xilinx device, or
  17 * (b) that interact with a Xilinx device through a bus or interconnect.
  18 *
  19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  22 * XILINX  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  23 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  24 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25 * SOFTWARE.
  26 *
  27 * Except as contained in this notice, the name of the Xilinx shall not be used
  28 * in advertising or otherwise to promote the sale, use or other dealings in
  29 * this Software without prior written authorization from Xilinx.
  30 *
  31 ******************************************************************************/
  32 /****************************************************************************/
  33 /**
  34 *
  35 * @file xuartlite_i.h
  36 * @addtogroup uartlite_v3_1
  37 * @{
  38 *
  39 * Contains data which is shared between the files of the XUartLite component.
  40 * It is intended for internal use only.
  41 *
  42 * <pre>
  43 * MODIFICATION HISTORY:
  44 *
  45 * Ver   Who  Date     Changes
  46 * ----- ---- -------- -----------------------------------------------
  47 * 1.00a ecm  08/31/01 First release
  48 * 1.00b jhl  02/21/02 Reparitioned the driver for smaller files
  49 * 1.00b rpm  04/24/02 Moved register definitions to xuartlite_l.h and
  50 *                     updated macro naming convention
  51 * 2.00a ktn  10/20/09 The macros have been renamed to remove _m from
  52 *                     the name. XUartLite_mClearStats macro is removed and
  53 *                     XUartLite_ClearStats function should be used in its place.
  54
  55 * </pre>
  56 *
  57 *****************************************************************************/
  58
  59 #ifndef XUARTLITE_I_H /* prevent circular inclusions */
  60 #define XUARTLITE_I_H /* by using protection macros */
  61
  62 #ifdef __cplusplus
  63 extern "C" {
  64 #endif
  65
  66 /***************************** Include Files ********************************/
  67
  68 #include "xuartlite.h"
  69 #include "xuartlite_l.h"
  70
  71 /************************** Constant Definitions ****************************/
  72
  73 /**************************** Type Definitions ******************************/
  74
  75 /***************** Macros (Inline Functions) Definitions ********************/
  76
  77 /****************************************************************************
  78 *
  79 * Update the statistics of the instance.
  80 *
  81 * @param        InstancePtr is a pointer to the XUartLite instance.
  82 * @param        StatusRegister contains the contents of the UART status
  83 *               register to update the statistics with.
  84 *
  85 * @return       None.
  86 *
  87 * @note
  88 *
  89 * Signature: void XUartLite_UpdateStats(XUartLite *InstancePtr,
  90 *                                               u32 StatusRegister)
  91 *
  92 *****************************************************************************/
  93 #define XUartLite_UpdateStats(InstancePtr, StatusRegister)      \
  94 {                                                               \
  95         if ((StatusRegister) & XUL_SR_OVERRUN_ERROR)            \
  96         {                                                       \
  97                 (InstancePtr)->Stats.ReceiveOverrunErrors++;    \
  98         }                                                       \
  99         if ((StatusRegister) & XUL_SR_PARITY_ERROR)             \
 100         {                                                       \
 101                 (InstancePtr)->Stats.ReceiveParityErrors++;     \
 102         }                                                       \
 103         if ((StatusRegister) & XUL_SR_FRAMING_ERROR)            \
 104         {                                                       \
 105                 (InstancePtr)->Stats.ReceiveFramingErrors++;    \
 106         }                                                       \
 107 }
 108
 109 /************************** Variable Definitions ****************************/
 110
 111 /* the configuration table */
 112 extern XUartLite_Config XUartLite_ConfigTable[];
 113
 114 /************************** Function Prototypes *****************************/
 115
 116 unsigned int XUartLite_SendBuffer(XUartLite *InstancePtr);
 117 unsigned int XUartLite_ReceiveBuffer(XUartLite *InstancePtr);
 118
 119 #ifdef __cplusplus
 120 }
 121 #endif
 122
 123 #endif          /* end of protection macro */
 124
 125 /** @} */