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

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