git.sur5r.net Git - freertos/blob

   1 /******************************************************************************
   2 *
   3 * Copyright (C) 2010 - 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 xiicps_intr.c
  36 * @addtogroup iicps_v3_0
  37 * @{
  38 *
  39 * Contains functions of the XIicPs driver for interrupt-driven transfers.
  40 * See xiicps.h for a detailed description of the device and driver.
  41 *
  42 * <pre> MODIFICATION HISTORY:
  43 *
  44 * Ver   Who     Date     Changes
  45 * ----- ------  -------- -----------------------------------------------
  46 * 1.00a drg/jz  01/30/10 First release
  47 * 3.00  sk              01/31/15 Modified the code according to MISRAC 2012 Compliant.
  48 *
  49 * </pre>
  50 *
  51 ******************************************************************************/
  52
  53 /***************************** Include Files *********************************/
  54
  55 #include "xiicps.h"
  56
  57 /************************** Constant Definitions *****************************/
  58
  59 /**************************** Type Definitions *******************************/
  60
  61 /***************** Macros (Inline Functions) Definitions *********************/
  62
  63 /************************** Function Prototypes ******************************/
  64
  65 /************************* Variable Definitions *****************************/
  66
  67 /*****************************************************************************/
  68 /**
  69 *
  70 * This function sets the status callback function, the status handler, which the
  71 * driver calls when it encounters conditions that should be reported to the
  72 * higher layer software. The handler executes in an interrupt context, so
  73 * the amount of processing should be minimized
  74 *
  75 * Refer to the xiicps.h file for a list of the Callback events. The events are
  76 * defined to start with XIICPS_EVENT_*.
  77 *
  78 * @param        InstancePtr is a pointer to the XIicPs instance.
  79 * @param        CallBackRef is the upper layer callback reference passed back
  80 *               when the callback function is invoked.
  81 * @param        FunctionPtr is the pointer to the callback function.
  82 *
  83 * @return       None.
  84 *
  85 * @note
  86 *
  87 * The handler is called within interrupt context, so it should finish its
  88 * work quickly.
  89 *
  90 ******************************************************************************/
  91 void XIicPs_SetStatusHandler(XIicPs *InstancePtr, void *CallBackRef,
  92                                   XIicPs_IntrHandler FunctionPtr)
  93 {
  94         Xil_AssertVoid(InstancePtr != NULL);
  95         Xil_AssertVoid(FunctionPtr != NULL);
  96         Xil_AssertVoid(InstancePtr->IsReady == (u32)XIL_COMPONENT_IS_READY);
  97
  98         InstancePtr->StatusHandler = FunctionPtr;
  99         InstancePtr->CallBackRef = CallBackRef;
 100 }
 101 /** @} */