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

   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_stats.c
  36 * @addtogroup uartlite_v3_1
  37 * @{
  38 *
  39 * This file contains the statistics functions for the UART Lite component
  40 * (XUartLite).
  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 Repartitioned the driver for smaller files
  49 * 2.00a ktn  10/20/09 Updated to use HAL Processor APIs.
  50 *                     XUartLite_mClearStats macro is removed.
  51 * </pre>
  52 *
  53 *****************************************************************************/
  54
  55 /***************************** Include Files ********************************/
  56
  57 #include "xil_types.h"
  58 #include "xil_assert.h"
  59 #include "xuartlite.h"
  60 #include "xuartlite_i.h"
  61
  62 /************************** Constant Definitions ****************************/
  63
  64
  65 /**************************** Type Definitions ******************************/
  66
  67
  68 /***************** Macros (Inline Functions) Definitions ********************/
  69
  70
  71 /************************** Variable Definitions ****************************/
  72
  73
  74 /************************** Function Prototypes *****************************/
  75
  76
  77 /****************************************************************************/
  78 /**
  79 *
  80 * Returns a snapshot of the current statistics in the structure specified.
  81 *
  82 * @param        InstancePtr is a pointer to the XUartLite instance.
  83 * @param        StatsPtr is a pointer to a XUartLiteStats structure to where the
  84 *               statistics are to be copied.
  85 *
  86 * @return       None.
  87 *
  88 * @note         None.
  89 *
  90 *****************************************************************************/
  91 void XUartLite_GetStats(XUartLite *InstancePtr, XUartLite_Stats *StatsPtr)
  92 {
  93         /*
  94          * Assert validates the input arguments
  95          */
  96         Xil_AssertVoid(InstancePtr != NULL);
  97         Xil_AssertVoid(StatsPtr != NULL);
  98         Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
  99
 100         /* Copy the stats from the instance to the specified stats */
 101
 102         StatsPtr->TransmitInterrupts = InstancePtr->Stats.TransmitInterrupts;
 103         StatsPtr->ReceiveInterrupts = InstancePtr->Stats.ReceiveInterrupts;
 104         StatsPtr->CharactersTransmitted =
 105                         InstancePtr->Stats.CharactersTransmitted;
 106         StatsPtr->CharactersReceived = InstancePtr->Stats.CharactersReceived;
 107         StatsPtr->ReceiveOverrunErrors =
 108                         InstancePtr->Stats.ReceiveOverrunErrors;
 109         StatsPtr->ReceiveFramingErrors =
 110                         InstancePtr->Stats.ReceiveFramingErrors;
 111         StatsPtr->ReceiveParityErrors = InstancePtr->Stats.ReceiveParityErrors;
 112 }
 113
 114 /****************************************************************************/
 115 /**
 116 *
 117 * This function zeros the statistics for the given instance.
 118 *
 119 * @param        InstancePtr is a pointer to the XUartLite instance.
 120 *
 121 * @return       None.
 122 *
 123 * @note         None.
 124 *
 125 *****************************************************************************/
 126 void XUartLite_ClearStats(XUartLite *InstancePtr)
 127 {
 128         /*
 129          * Assert validates the input arguments
 130          */
 131         Xil_AssertVoid(InstancePtr != NULL);
 132         Xil_AssertVoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
 133
 134         InstancePtr->Stats.TransmitInterrupts = 0;
 135         InstancePtr->Stats.ReceiveInterrupts = 0;
 136         InstancePtr->Stats.CharactersTransmitted = 0;
 137         InstancePtr->Stats.CharactersReceived = 0;
 138         InstancePtr->Stats.ReceiveOverrunErrors = 0;
 139         InstancePtr->Stats.ReceiveFramingErrors = 0;
 140         InstancePtr->Stats.ReceiveParityErrors = 0;
 141
 142 }
 143
 144 /** @} */